forked from mirrors/principia
66923575b4
Originally a C program (previously Python script) at https://github.com/principia-game/featured-list-creator for creating fl.cache files for the community site, merge into the main repository so it is with all the other util programs.
16 lines
1.1 KiB
Markdown
16 lines
1.1 KiB
Markdown
# `utils`
|
|
This directory contains utility scripts and programs used for Principia development or for working with file formats.
|
|
|
|
## Scripts
|
|
- `prepare_release_builds.sh`: Download and prepare release builds when making a release
|
|
- `set_version.lua`: Update the version number across the codebase when preparing a release (See [Making a Release](https://principia-web.se/wiki/Making_a_Release#incrementing-version-tagging)).
|
|
- `update-sandbox-menu.sh`: Update the pre-rendered sandbox and item menu
|
|
|
|
## Programs
|
|
Most of these programs rely on source files from the main Principia codebase and need to be compiled to run. Likely only works on Linux. You can use the `Makefile` in each directory or run `make` in the `utils` directory to build all of them.
|
|
|
|
- `featured-list-creator`: Generate a `fl.cache` file for use on the Principia community site
|
|
- `lvl-icon-extractor`: Extract the embedded level icon in a Principia level file
|
|
- `lvlbuf-decompressor`: Decompress the level buffer of a Principia level file
|
|
- `lvledit`: Edit metadata of Principia level files
|
|
- `progress-get`: Get leaderboard score for a given level from a data.bin file
|