Skip to content

Guides

There are two kinds of guide. The first kind changes the project you made in Get started, one job at a time, with every command to copy. The second kind explains a part of the engine by quoting how one of its samples does it. If you have just made a first change, start with the first kind, from the top.

When a build fails after you change your game, Read a build error shows how to find the line that matters.

These pages are in a suggested order, and each one says at its top how long it takes and which pages it needs done first. Put a picture, Animate a sprite sheet, Fonts and text and the second part of Play a sound need Install the content tools first. Write a post-processing shader explains the extra tools its browser build uses; the other pages need no tools beyond the ones you already installed.

Sending the game to a friend, keeping its history in Git and on GitHub, putting it on the web, and saying which Labrador you have when you ask for help.

When a newer release comes out: one page for a project made from the starter ZIP, one for a project that has Labrador as a Git submodule, and the code changes a release asks for.

Each of these takes one part of the engine and shows how a sample in the repository uses it, quoting the sample’s code as it is at the revision this site was built from. Where the samples do not cover part of a job, the guide says so. The quoted code is in the engine’s samples folder, not in your game. In a starter project that is C:\dev\mygame\external\labrador\samples, and Run the samples builds and starts them from there. They assume the model described in Concepts. Several share a subject with a step-by-step page above, such as Audio and Play a sound in your game: the step-by-step page changes your game, and the one here explains the parts behind it.

Development documentation (unreleased). Built from Labrador aceb130 of 2026-11-20.

All documentation versions