Build Labrador
This page, Run the minimal sample and Start your own project are the route for people who use Git. If you have the starter project, you already have everything they make and can go straight to Make a first change.
On this route you build Labrador on its own first. That proves the tools work before your own project adds anything, and it builds the samples you will look at next. It needs Git, from step 2 of Install the tools.
Every command on this page runs in the x64 Native Tools Command Prompt from Install the tools, one box at a time, in order.
-
Clone the repository into your projects folder. This downloads Labrador into a new folder,
C:\dev\Labrador, and moves the prompt into it:Terminal window cd /d C:\devgit clone https://github.com/matt439/Labrador.gitcd LabradorGit prints a few lines counting objects and ends with
Resolving deltas: 100%anddone.; the prompt then endsC:\dev\Labrador>. If Git saysdestination path 'Labrador' already exists and is not an empty directory, you have cloned it before: run only the last line,cd Labrador, and carry on. -
Configure the build:
Terminal window cmake --preset x64-debugA preset is a named configuration in the repository’s
CMakePresets.json.x64-debugis a 64-bit debug build using the Direct3D 11 renderer, with its output inout\build\x64-debug.The first time you run this, vcpkg downloads and builds Labrador’s dependencies: DirectX Tool Kit and the DirectXMath library it uses, the XAudio2 redistributable, the doctest test framework and the lodepng image library. It may also download a CMake and a PowerShell of its own if it finds Visual Studio’s unsuitable. With nothing cached, the first configure downloads about 330 MB in all. On a fast desktop with an empty cache that configure took 2 minutes 17 seconds, 1.2 minutes of it vcpkg building seven packages, and vcpkg keeps the results, so later configures are quick. A slower machine can take much longer; leave the window alone until the prompt comes back. The whole build folder,
out, comes to about 1.3 GB once the next two steps have run.It has worked when the last lines are these, with your own folder in the last one:
Output -- Configuring done-- Generating done-- Build files have been written to: C:/dev/Labrador/out/build/x64-debugCMake also prints a time in brackets after each
done. If it ends withConfiguring incomplete, errors occurred!instead, find the first line that saysErrorand look it up under If something fails below. -
Build it:
Terminal window cmake --build --preset x64-debugThis builds the engine, all six samples, the tests and the benchmarks, which took 21 seconds on the same desktop. Ninja numbers each step as it goes, such as
[57/326], and a build that worked stops at the last number with no line sayingFAILED; your total may differ. Warnings are errors in every Labrador build, so a successful build has none. -
Run the tests:
Terminal window ctest --preset x64-debugEighteen test programs, the minimal sample’s start-up check and the benchmarks run, and ctest should report
100% tests passed, 0 tests failed out of 20. One of them,RenderPixelTests, draws real frames through Direct3D and compares them with reference images, so a pass also tells you the renderer works on your machine.
Coming back later
Section titled “Coming back later”A new command prompt starts in its own folder, not in Labrador. Each time you open the x64
Native Tools Command Prompt to carry on, go back to the folder first:
cd /d C:\dev\LabradorThen run the step you want. The build only recompiles what changed, so running the build and test lines again is always safe.
Starting the build again from nothing
Section titled “Starting the build again from nothing”The build folder remembers how it was configured. After a configure failed, or after you change
something it depends on, such as VCPKG_ROOT, the folder the project is in, or which prompt you
use, delete the build folder and configure again. From the Labrador folder:
rmdir /s /q out\build\x64-debugcmake --preset x64-debugcmake --build --preset x64-debugrmdir /s /q deletes the folder and everything in it without asking, so check that the prompt
ends Labrador> before you run it. It deletes only what the build made; vcpkg keeps what it
downloaded elsewhere, so the configure after it is quicker than the first one was. For another
preset, put its name in place of x64-debug in all three lines.
Other configurations
Section titled “Other configurations”The x64-* presets are available only when CMake runs on Windows. The wasm-*
presets have no host restriction, but building them on Linux or macOS is unverified.
They still require the browser toolchain. There is no native
Linux or macOS window implementation; Platform support
states the supported targets and the port plans.
The repository has a debug and a release preset for each renderer. Swap the preset name in all three commands to use one:
| Preset | Renderer |
|---|---|
x64-debug, x64-release |
Direct3D 11 |
x64-debug-d3d12, x64-release-d3d12 |
Direct3D 12 |
x64-debug-gl, x64-release-gl |
OpenGL 3.3 |
x64-debug-vulkan, x64-release-vulkan |
Vulkan, which needs the Vulkan SDK |
x64-debug-null, x64-release-null |
None: records what it was asked to draw, for testing on machines without a graphics card |
The renderer is chosen when you configure rather than when the game starts. Asking for one that was not built is a link error, not a crash on the first frame. A game you ship is built with one renderer too: Which renderer to ship recommends Direct3D 11 and says what a machine that refuses it shows.
If something fails
Section titled “If something fails”Troubleshooting has more messages, each with what it means and how to get past it.
Documentation for Labrador v0.3.0. Built from Labrador 0f4f503 of 2026-11-03.