Repository navigation
Game Reference
Zreezy edited this page Nov 1, 2026
·
2 revisions
Generated reference of the game's Lua modules for each game version, for writing and updating mods. It lists module names, functions with parameter names, fields with default values and globals. It does not contain game code.
- Copy
Resources/resource.carandbuild-metadata.jsonfrom the game folder somewhere outside the repo. Do not commitresource.car; it is the game's code. - Generate the docs (Python 3.9+, no dependencies):
python tools/gamedocs/gamedocs.py generate path/to/resource.car --metadata path/to/build-metadata.json - Document what changed since the previous version:
python tools/gamedocs/gamedocs.py diff <old version> <new version> - Check which mods reference things that no longer exist:
python tools/gamedocs/gamedocs.py check scripts/coromon --version <new version> - Update the GitHub wiki (README, docs guides and this reference) from a clone of the wiki repository:
git clone https://github.com/<owner>/<repo>.wiki.git ../wiki python tools/gamedocs/gamedocs.py wiki ../wiki cd ../wiki && git add -A && git commit -m "Update wiki" && git push
Generated from zreezy/chalchiu-coromon (main) by tools/gamedocs. Edit the repository, not the wiki: pages are regenerated.
chalchiu for Coromon
Game Reference