Documentation

The documentation is split by what you are trying to do: build something, understand the engine’s model, finish a task, look up an exact contract, or understand why the engine is the way it is. Parts of it are written and parts are not, and this page says which.

Section	When you want to	Status
Get Started	Build something that runs, then a project of your own	Written. Five steps, each checked on a real machine.
Concepts	Understand the model: ownership, objects, states, update and draw, scenes, views, resources	Written. Five pages, each tied to code in the samples.
Guides	Do a particular job: sprites and text, input, collision, audio, assets, menus, local multiplayer	Seven guides, each backed by runnable sample code.
API Reference	Find the exact contract of a type or function	Written. Every public header in all ten modules, generated from the source.
Design	Understand the reasons behind the engine	Written. The three design documents, read from the repository.
Troubleshooting	Recover from a problem	Started. The failures met so far, by message. It grows from reports.

Every page says at the bottom which revision of Labrador it was built from. Pages that quote the engine’s source, its headers or its design documents read them from that revision, so what they show is what that commit contains.

Get startedFrom an empty Windows machine to a project of your own that builds against Labrador.