Guides
Each guide takes one job and shows how a sample in the repository does 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. When a build fails after you
change your game, Read a build error shows how to find the line that matters, and
Edit and debug in Visual Studio does the same work in Visual Studio, with its debugger.
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.
Run the samplesBuild the engine's six samples from a starter project or a clone, start each one, and quit it.
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.
Play a sound in your gameCopy the audio sample's sounds and play them on keys with no tools, then pack a WAV of your own.
Colours, the window and the backgroundThe greeting's colour, size and place, the window's size, full screen and F11, and a colour or picture behind everything.
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.
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 second levelA goal to reach, the next level when the greeting touches it, and levels read from a file you edit.
Add a rule and a testA rule that keeps the greeting in the window, its doctest file, and a passing and a failing run.
Copy the components into your gameThe option row and slider from the components sample, copied, listed and driven from the keyboard.
Put collision in your gameA wall and a box the keys move, with the wall stopping the box, in the starter project.
A camera that follows the playerA world bigger than the window, a camera that keeps the greeting in the middle, and a stop at the world's edge.
Two players in your gameA second greeting on the arrows and the second pad, then the window split between two cameras.
Save settings in your gameWrite a settings file to the player's folder, read it back at start, and report a broken file.
Rename your gameChange MyGame to your game's name in the build, the window, the error box, the web page and the release.
Send your game to a friendBuild the Windows release, zip it, and what your friend sees when they extract and start it, SmartScreen included.
Put your project on GitHubAn account, an empty repository, the push and its browser sign-in, and reading the build GitHub runs.
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.
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.
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.
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.
Update your code for a newer LabradorThe renames and removals a newer release asks of your game, as commands to copy, release by release.
Move a starter project to a newer LabradorTake a newer release into a project made from the starter ZIP, keeping the old project until the new one works.
Put your project in GitMake a starter project a Git repository with the engine as a submodule, ready for GitHub and CI.
Documentation for Labrador v0.3.0. Built from Labrador 0f4f503 of 2026-11-03.