https://github.com/memo33/scdbpf
a simple Scala-DBPF library
https://github.com/memo33/scdbpf
dbpf simcity4
Last synced: 3 months ago
JSON representation
a simple Scala-DBPF library
- Host: GitHub
- URL: https://github.com/memo33/scdbpf
- Owner: memo33
- License: mit
- Created: 2014-04-23T20:01:56.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-09-15T18:51:11.000Z (9 months ago)
- Last Synced: 2025-09-15T20:35:11.502Z (9 months ago)
- Topics: dbpf, simcity4
- Language: Scala
- Homepage:
- Size: 1.36 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
scdbpf
========
This is a DBPF library written in Scala, which runs on the JVM. Its most
important features are immutability, which makes the library thread-safe,
as well as a simple API, which also makes it particularly suitable for
scripting.
Currently, only DBPF format version 1.0 is supported, which is used by
SimCity 4. The most common DBPF types are supported, such as Exemplar,
Cohort, SC4Paths, S3D, FSH, LText.
This library has evolved from the
[jDBPFX](https://github.com/memo33/jdbpfx) library; yet, almost everything
has been rewritten entirely.
Installation
--------------
Add the following to your `build.sbt` file:
libraryDependencies += "io.github.memo33" %% "scdbpf" % "0.2.1"
The latest version is available on [Maven Central](https://mvnrepository.com/artifact/io.github.memo33/scdbpf).
Documentation
---------------
See here for the current
[documentation](https://memo33.github.io/scdbpf/io/github/memo33/scdbpf/).
It can also be generated via `sbt doc`. The main page contains
some examples to get started. For example, the task of sorting the
entries of a DBPF file by TGI would be achieved via `sbt console` like
this:
val dbpf = DbpfFile.read(new File("foobar.dat"))
dbpf.write(dbpf.entries.sortBy(_.tgi))
Contact and Support
---------------------
Support is provided at
[SC4Devotion.com](http://sc4devotion.com/forums/index.php?topic=16491).
The source files can be found at
[GitHub.com](https://github.com/memo33/scdbpf).
License
---------
This library is released under the MIT license (see included license file).