Getting Started#

This guide walks you through:

• Installing the required tools.
• Structuring a mod directory.
• Writing a "Hello World" hook that runs before a game function.
• Writing shader mods for visual effects.
• (Optional) Writing mods in TypeScript.
• (Optional) Building CReact overlay panels with Bun.

Prerequisites#

Build the game and set up optional TypeScript tooling.

Choose your mod type#

Pick shaders, assets, hooks, or CReact before you start building.

Create your first mod#

Build a minimal mod that logs a message when a game function is called.

Shader mod#

Ship HLSL visual effects with a minimal Luau entry (or use global mods/shaders/).