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.
Edit and debug in Visual StudioOpen your project in Visual Studio, build and read the Error List, stop at a breakpoint, step, and find the line behind an error box or a crash.
Install the content toolsDownload texconv, MakeSpriteFont and xwbtool, which turn pictures, fonts and sounds into files the engine loads.
Put a picture in your gameConvert a PNG, list it, copy it beside the game and draw it in the starter project, step by step.
Animate a sprite sheetSeveral pictures in one file, described in JSON, played as an animation in the starter project.
Fonts and text in your gameInstall a font, make a title atlas, add letters such as é, and read text from a file.
Colours, the window and the backgroundThe greeting's colour, size and place, the window's size, full screen and F11, a colour or picture behind everything, and smooth movement on a fast display.
Write a post-processing shaderOne HLSL pixel function, compiled for your renderer, that gives the starter game's frame a warm tint.
Change a control in your gameMove with other keys, and ask to quit with Q on both of the starter's screens, with the lines that tell the player.
Add a screen to your gameA title screen as a new state, listed in both build lists, that starts the starter's screen with Enter.
Add a second levelA goal to reach, the next level when the greeting touches it, and levels read from a file you edit.
Make a title menuStart and Quit rows on the title screen, moved with the keys or a pad and chosen with Enter or A.
Add a rule and a testA rule that keeps the greeting in the window, its doctest file, and a passing and a failing run.
Roll a die in your gameKeep seeded randomness in the state and hand its roll to a rule tested with chosen values.
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.
Send your game to a friendBuild the Windows release, zip it, and what your friend sees when they extract and start it, SmartScreen included.
Save and undo changes with GitSee what changed, record it, read the history, undo a broken edit, take back a commit and get an old version of a file.
Put your project on GitHubAn account, an empty repository, the push and its browser sign-in, and reading the build GitHub runs.
Put your project in GitMake a starter project a Git repository with the engine as a submodule, ready for GitHub and CI.
Build for the browserInstall Emscripten without Git, build your game as a page, serve it, and change, rebuild and refresh it.
Put your game on the webPublish the browser build free with GitHub Pages, so a friend plays it from a link.
Which Labrador you haveYour engine's version and commit, the one a page describes, and whether your engine has a name a page uses.
Ask for helpWhat to gather, the log, your engine's commit and your tools, and which GitHub form to open.
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.
Move your engine pinTake a newer Labrador release: read CHANGES.md, compare the manifest, build, test and commit, and run the engine's own tests at your pin.
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.
Run the samplesBuild the engine's six samples from a starter project or a clone, start each one, and quit it.
Sprites and textTextures, fonts and sprite sheets; the engine's drawables; drawing a solid rectangle.
InputChanging a key in the starter project, then keyboard, gamepads, vibration and mouse; held versus pressed; deadzones; typed text.
MenusWidgets, a focus group, directional navigation with repeat, and a menu that returns a choice.
Settings and savesPer-user Windows settings, browser IDBFS storage, and an awaited save that survives a reload.
Content and the manifestAdding files, the formats the engine reads, JSON it checks, and your own kinds of asset.
CollisionLayers and masks, contact normals, wall resolution and a trigger in a playable arena.
AudioA playable wave bank, named sounds, one-shot effects and a controllable loop.
Local multiplayerTwo players in one world, independent input, following cameras and a HUD in each view.
Test your gameA rules library tested with no window, a start-up check, and adding tests of your own.
Check your game in CIA GitHub Actions workflow to copy, which builds your project and runs its tests on every push.
Ship a Windows releaseThe folder a player gets, built by cmake --install: DLLs, the MSVC runtime, notices, which renderer, and what players need.
Put your game on a web hostThe files to upload and what the server must send: the wasm MIME type, a CSP, compression and caching.
Development documentation (unreleased). Built from Labrador aceb130 of 2026-11-20.