Skip to content

Get started

This path takes you from a Windows machine with nothing installed to a project of your own that builds against Labrador, runs, and shows a change you made. It has three steps, and each page ends where the next begins. You do not need Git: the project comes as a ZIP file.

Labrador builds on Windows, and the game it builds runs on Windows and in a desktop browser through WebGL2. This path builds for Windows; Build for the browser adds the browser build to the project it ends with, and Running them on the Examples page says how a sample becomes a page instead.

There is no editor to install. A game is C++ you write in your own IDE, its content is JSON in a text editor, and the tools that convert images and fonts run from the command line; if you were looking for an editor, read what Labrador is not before installing anything.

The starter project is the same project the Git route builds by hand. If you already use Git, or want to see each step, take this route in place of step 2. It clones Labrador and builds it on its own first, then makes your project as a repository with Labrador as a submodule. Both routes end at Make a first change, and a starter project can be put in Git at any time.

Very little. These pages are written so that someone who has hardly programmed can follow them to a game of their own that runs, and then play around with it. Every command is in a box with a copy button, nothing has to be worked out, and each step says what you should see and what to do when you see something else. Typing the commands says how to run them. If you already use Visual Studio, Git and a command prompt, skim the explanations and run the boxes.

Going further than the first change means writing C++, and these pages do not teach the language. Reading the C++ in minimal explains what the copied sample uses. To learn C++ itself, use a language introduction alongside your project. Practise with a small console program: use variables, a loop, a function and a class, then change and rebuild it. Learn what pointers and references refer to and when an object is destroyed. If you have not programmed before, choose an introduction that teaches programming fundamentals too. The companion introduction’s status is below.

The companion C++ introduction is in pre-production, with its storyboard, demo code and shooting plans prepared; rehearsal and recording remain. It covers memory, pointers, lifetime and ownership for people who already program, and is not yet available to watch. The design philosophy describes the engine API’s teaching goals.

The Git route’s pages were followed by hand on Windows 11 with Visual Studio’s x64 Native Tools Command Prompt on 4 October 2026, a run recorded in Labrador’s commit 68b392d: every command was run, and the project of Start your own project was built from the public repository as its page then described, with four include edits where it now lists eight. Some steps have changed since, and the folder advice in Install the tools, its subst drive included, and the build on Build Labrador were checked by hand again on 13 October. The revision at the bottom of each page is the one the page was built from, which can be later than any of these.

On 25 October 2026 the Git route was followed again, to the first change, on a fast desktop that already had Visual Studio 2026 and Git, from a fresh clone of the public repository and with vcpkg’s caches empty, with Labrador built at commit 6be26c9 and the project at the v0.1.0 tag: every command worked as written and no package failed to build. The first configure took 2 minutes 17 seconds, most of it vcpkg building seven packages, and downloaded about 330 MB; the build took 21 seconds and the tests 24. Labrador’s build folder was 1.3 GB afterwards. Your own project’s first configure reused vcpkg’s work and took 13 seconds. From the clone to the project’s own window took about six minutes, not counting installing Visual Studio and Git, which was not timed. The walkthrough’s record has every figure. The template’s tests came after that run.

On 30 October 2026 the pages gained the detail a reader new to the command prompt needs: what each step prints, the messages of the usual mistakes, and commands for what earlier versions left to the reader. The new folder, Visual Studio lookup and include-rewrite commands, and the messages quoted for the wrong prompt, a 32-bit prompt, a missing Git identity, a detached engine checkout and an empty engine folder, were run in a command prompt on Visual Studio 2026 that day. The setx line, the Notepad steps, devenv . and the submodule repair were not run that day, and no one new to the command prompt has yet followed the pages through. devenv . was run on 31 October 2026: Edit and debug in Visual Studio records it.

The starter ZIP came the same day. One made from the development tree was extracted, configured, built and tested with Git hidden from vcpkg and vcpkg’s caches empty: vcpkg downloaded a copy of Git for itself, the configure took 2 minutes 8 seconds and downloaded about 400 MB, and both of the game’s tests passed. Get the starter project says what else was and was not checked. No release had carried a starter ZIP then; v0.3.0 is the first that does.

The full CI sweep checks part of this path on every change. It makes a starter ZIP from the change itself, extracts it with Windows’ tar, builds the project in it, checks that its ctest holds the game’s two tests and none of the engine’s, and runs them, the start-up check included. It does not download anything from a release, use Git, or do Install the tools and the first change.

If a step does not do what the page says, that is a bug in the page: report it. Ask for help says what to include and which form to choose.

Documentation for Labrador v0.3.0. Built from Labrador 0f4f503 of 2026-11-03.

All documentation versions