README.md

OpenTTD Map Parser (and Writer)

This library is a map parser and writer for OpenTTD written in Rust with ✨binrw✨.

Examples

Town Renamer

You can use the town renamer CLI to import/export a list of town names specifically for JGR savefiles.

Save to towns.json

cargo run --release --example town-renamer read ./game.sav

towns.json to Save

cargo run --release --example town-renamer write ./game.sav ./towns.json -o new_save.sav

ImHex

In imhex/ottd-savefile.hexpat, you'll find a pattern that you can load into ImHex to visualize an OpenTTD savefile in hex. This will not work if the save file is compressed so you will have to disable compression in OTTD or decompress it with this library.

Wasm

With wasm pack (installed with cargo install wasm-pack)

wasm-pack build --release --target web -- --no-default-features --features lzma-rs

Useful links

• OpenTTD's Savegame Format
• OpenTTD's Savegame Compression
• OpenTTD Source
• JGR Source

Licenses

This software is licensed under GNU General Public License version 2.0.

Data structures derived from https://github.com/OpenTTD/OpenTTD and https://github.com/JGRennison/OpenTTD-patches are also licensed under GPL 2.0.