Documentation hub

Documentation should reduce uncertainty, not merely prove that docs exist.

Use this page as the starting map into tutorials, architecture notes, API reference, release planning, and repository-level onboarding.

Getting started

Quick start guide, Hello World component example, and module overview.

Tutorials

Hands-on guides for physics, audio, UI, coroutines, rendering, and game building.

API reference

Class-by-class scripting reference for runtime objects, editor-facing APIs, math helpers, and rendering modules.

Repository README

Project overview, quick start, current scope, build instructions, and contributor-facing orientation.

Roadmap view

A version-oriented planning page that explains what is finished, what is next, and what still blocks a fuller release path.

Issue tracker

Use the issue tracker when the docs stop being enough and the actual engineering state needs to be inspected or discussed.

Discussions

Broader design questions, contribution ideas, and architecture conversations that do not fit into a bug report.

Reading model

How to navigate the project without wasting time.

Different readers need different entry points. This page separates onboarding, deep reference, and planning so the documentation is useful to both users and contributors.

If you want to use the engine

Start with the tutorial docs and README. They cover setup, build flow, project layout, and the scripting surface that matters first.

If you want to modify the engine

Move from README into the architecture docs and then inspect the code. The design intent is visible, but the source remains the authority.

If you want to judge project maturity

Read the roadmap together with the README. One tells you what exists today, the other tells you what the next constraints are.