Skip to content
BRTrainsPublic

About

YAML-to-NML-to-GRF builder for BRTrains projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

BR Build

A newGRF builder for the BRTrains group of OpenTTD newGRFs

Building

Build from this project folder

Run python Run.py to automatically scan ../ for folders containing a BRBuild.yaml file, and attempt to build them

To build a specific project projectname pass it as the first parameter using python Run.py [projectname]

Optionally append --log to write the output to build.log

Full usage: python Run.py [projectname] [--log] [--release] [--reset-graphics | --reset-graphics-only]

Use --reset-graphics to ingest new/ spritesheets first, or restore spritesheets from their original/ backups when no new image is available, then build. Use --reset-graphics-only for the same ingest/restore step without building.

To ingest a new spritesheet, place one PNG in the vehicle's new/ subfolder. On the next build it is moved to original/<Vehicle>.png, copied to the normal spritesheet path, and processed; the new/ folder is then empty.

Use --release to lock vehicle sprite IDs and check savegame-breaking changes. IDs are stored in src/grf/VehicleIDData.yaml in the project, and removed or changed released variants are retained as unavailable (DEPRECATED) items.

Build from target project folder

Copy the build.py.example file to the project folder and rename it build.py, run it as python build.py [--log], no project name is required, --log is optional to generate a build.log file

Creating a project

Copy the BRBuild.yaml.example file to the project folder and edit names, paths, configuration as appropriate

Read the project docs for information on how to structure the project and required files, formats etc

About

YAML-to-NML-to-GRF builder for BRTrains projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages