Getting started

Introduction

The source guide to the internal client, local Lua runtime and development tools.

Know what you are working with

The internal project combines a C++ application, a separate DirectX 11 overlay, a local Lua editor and game integration. These docs describe the current source tree, including the distinction between implemented code, visual previews and unverified runtime behavior.

Coming from Lua?

A Lua-facing function is not necessarily implemented in Lua. Start with Lua and C++, then read about the runtime and its limits.

Your first pass through the project

01 · Understand the boundary →Follow an API entry to the code that owns its behavior.02 · Find the source →Nine areas with an explicit build list.03 · Validate a change →Syntax checks, compilation and output paths.04 · Work with assets →Avatar conversion, generated headers and diagnostics.

Documentation scope

This edition follows the November 1, 2026 source reorganization. File moves did not rewrite feature behavior. A passing syntax check is not an in-game test; see project status for the boundaries.

Local and web editions

The internal edition opens directly from index.html. The web edition lives under /docs/. Both include local assets and a searchable index, without third-party font or script requests. Source-file links are available only in the local edition.