Scripting guides#
Courage Reborn mods run in the embedded Luau VM.
Available modules#
| Module | Description |
|---|---|
| Script entry point | mod() class, init / tick / shutdown |
| Petrichor.Standard | Globals newclass(), mod(), log(), Levels |
| Augment.Hook | before/after/replace hooks |
| Augment.Mixin | symbols, direct calls, memory read/write |
| Petrichor.Log | logging |
| Petrichor.Events | pub/sub between mods |
| Petrichor.Task | async/await on the main thread |
| Petrichor.Timer | timers in seconds and frames |
| Petrichor.Net | TCP and UDP |
| Petrichor.Json | JSON |
| Petrichor.Random | PRNG helpers |
| Petrichor.Hash | MD5 / SHA-256 |
| Petrichor.Bits | compact bit packing |
| Petrichor.Storage | per-mod JSON save data |
| Petrichor.Math | vectors and math helpers |
| Courage.Shaders | custom HLSL |
| Courage.Assets | assets/ path helpers |
| Courage.World | stage and warp |
| Courage.Player | player stats and position |
| Courage.Hooks | reusable hook recipes |
| Courage.Settings | settings schema helpers |
| Courage.UI | CReact panels and popups |
| Courage.Layout | BLO screens as CReact textures |
Guides#
- Luau, hooks, struct views,
require - TypeScript, ts-luau and crxts-types
- Hooks reference,
HookCtx, overloads, phases - Debugging, console output, hook traces, Game Hooks lookup
- Working with events, cross-mod messaging
CReact overlay panels: Guides for CReact.
Shader mods are covered under Shader guides.
Vanilla reference data: TP Ultimate Spreadsheet.