Skip to content

Documentation scripts#

Run these from the repository root unless noted.

regen_json.py#

Regenerates all Game Hooks JSON under docs-cr/data/. Run from docs-cr/:

cd docs-cr
python3 regen_json.py ../pc/build/augment.manifest.json

gen_reference.py#

Lower-level generator used by regen_json.py.

python3 docs-cr/scripts/gen_reference.py --from-manifest pc/build/augment.manifest.json

See Regenerating the hook reference.

Common da*_c hook blurbs are auto-generated by auto_descriptions.py (templates for Execute, Draw, action_*, etc.). Edit cr_descriptions.yaml only to override or add non-actor hooks.

add_script_labels.py#

One-time maintenance: inserts **Luau code** / **TypeScript code** labels before adjacent fenced blocks in modding markdown. Skips luau.md and typescript.md (those pages use front-matter script_lang).

python3 docs-cr/scripts/add_script_labels.py

Labels are stripped on the built site by docs-cr/javascripts/script-toggle.js, which syncs language choice across === "Luau" / === "TypeScript" tabbed fences.