Guides
On this page
Everything here is also on the website, rendered from these same files.
Playing
| Guide | What it covers |
|---|---|
| Installing the engine | Verifying downloads, macOS setup, where mods go, settings, troubleshooting |
| Profiles and your save | Modded saves kept apart from your own; profile and character commands |
| Playing co-op | Sessions, mods in co-op, fixes |
| Connecting for co-op: LAN or VPN | ZeroTier, Tailscale and the firewall |
| Finding stutters | Tracing what makes frames slow, and reading the report |
Writing mods
| Guide | What it covers |
|---|---|
| Writing mods in Lua | Every SDK module, the sandbox, mod perf, mod bake |
| Shipping a mod as a regulation.bin | Baking a modded regulation.bin and loading it |
| Starting classes | The ten starting classes' stats and gear, for class mods |
| Command reference | Every command and flag |
| Architecture | How it fits together |
The worked examples are in examples/.
Releases
Changelog: what changed in each engine release, newest first.