This repo provides interfaces for reading and writing Brickadia's World files, which are stored in the .brdb and .brz formats.
It also contains code for assisting with parsing msgpack-schema files as defined in Zeblote's Brickadia msgpac-schema Gist. Some undocumented changes to this format are required to fully read/write .brdb files.
The .brz format is described in Zeblote's Brickadia brz Gist.
- Rust brdb
- JS/TS: TODO
- TODO: describe file tree structure
- TODO: describe differences between
.brdband.brz - TODO: describe revision mechanism and dates
- TODO: describe blobs, compression, and hashing
- TODO: describe msgpack-schema format
- TODO: describe SoA (Structure of Arrays) format
- TODO: describe flat arrays and limitations
- TODO: describe shared schemas
- TODO: describe entity/component
.mpsfiles and the data that comes after the SoAs
Use these libraries on your saves at your own risk:
- This library may generate invalid
.brdbfiles, which may cause the game (or your computer) to crash or behave unexpectedly. Report these bugs to the Brickadia team. - This library may modify the contents of your
.brdbfiles in ways that are not easily recoverable. Make backups of worlds you plan to modify with this library.