Parallax Documentation

Welcome to the Parallax docs portal. This site is split into a fast reference tree on the left and deep API pages on the right.

Developer Portal

Reference-first docs for framework and module development

Jump into the API tree, search symbols instantly, and navigate framework libraries without losing context.

API Overview

Start from the generated index and drill down into all documented files.

Framework Libraries

Core systems: schema, modules, networking, data, command, and utility APIs.

Meta Extensions

Player/entity extensions and behavior hooks surfaced by the framework.

Module APIs

Feature modules like zones, mapscene, currencies, chatbox, and more.

Quick Navigation

• Browse the left sidebar tree for instant switching between libraries.
• Use search (/) to jump directly to symbols and files.
• Open API -> Framework -> Libraries for core framework internals.
• Open API -> Modules for optional feature modules.

Notes

• API pages are generated from Lua doc annotations.
• Regenerate docs with python tools/generate_docs.py --clean.