Building from Source

Prerequisites

C++ compiler — GCC 13+, Clang 16+, or MSVC 2022
CMake 3.26+
Vulkan SDK 1.3+ — Download
Git

Clone

git clone https://github.com/contextgg/mortar.git
cd mortar

Build

Mortar uses CMake presets:

cmake --preset default
cmake --build --preset default

This builds in build/default/. The binary is build/default/mortar.

Platform Notes

Linux

Install Vulkan SDK and development packages:

# Ubuntu/Debian
sudo apt install libvulkan-dev vulkan-tools libx11-dev libxrandr-dev libxi-dev

# Fedora
sudo dnf install vulkan-loader-devel vulkan-tools libX11-devel libXrandr-devel libXi-devel

macOS

Install the Vulkan SDK from LunarG. MoltenVK is used for Vulkan-on-Metal translation.

Windows

Install the Vulkan SDK. Visual Studio 2022 with C++ workload is required.

Open a Developer Command Prompt:

cmake --preset default
cmake --build --preset default --config Release

Run

./build/default/mortar --map path/to/map.json

CMake Options

Option	Default	Description
`MORTAR_ENABLE_VALIDATION`	`ON` (Debug)	Enable Vulkan validation layers
`MORTAR_BUILD_TESTS`	`OFF`	Build unit tests

cmake --preset default -DMORTAR_BUILD_TESTS=ON
cmake --build --preset default --target tests