Skip to content

Game Reference

Zreezy edited this page Nov 1, 2026 · 2 revisions

Coromon game reference

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.

Versions

Adding a new game version

  1. Copy Resources/resource.car and build-metadata.json from the game folder somewhere outside the repo. Do not commit resource.car; it is the game's code.
  2. Generate the docs (Python 3.9+, no dependencies):
    python tools/gamedocs/gamedocs.py generate path/to/resource.car --metadata path/to/build-metadata.json
    
  3. Document what changed since the previous version:
    python tools/gamedocs/gamedocs.py diff <old version> <new version>
    
  4. Check which mods reference things that no longer exist:
    python tools/gamedocs/gamedocs.py check scripts/coromon --version <new version>
    
  5. 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
    

Clone this wiki locally