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. Three steps led by a starter ZIP that needs no Git, with a Git route of three pages beside it. The Git route was followed by hand on Windows 11 from a public clone with nothing cached; the starter project was built from a ZIP of the development tree with vcpkg’s caches empty, before any release carried one. The page says what each was checked against. |
| 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: run the samples; put pictures, fonts and sounds in your game; add screens, a menu, levels, rules and tests; change its controls; share it as a ZIP, on GitHub or as a web page; Git; sprites and text, input, collision, audio, assets, menus, local multiplayer, testing, CI and releases | Written. Thirty-five guides. The step-by-step ones give every command and edit, such as Put a picture in your game, Build for the browser and Move a starter project to a newer Labrador; each was run as worded, most in a fresh starter project, and its What was checked says how. The others, such as Sprites and text, Audio and Local multiplayer, read a sample’s code and assume you can edit C++. |
| 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.
Documentation for Labrador v0.3.0. Built from Labrador 0f4f503 of 2026-11-03.