Installation

Desktop App

The easiest way to get started is with the ctx.gg desktop app.

1. Download the latest release from GitHub Releases
2. Install and launch the app
3. Sign in with GitHub or Discord
4. Browse community maps or open the editor to create your own

Build from Source

Prerequisites

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

Clone and Build

git clone https://github.com/contextgg/mortar.git
cd mortar
cmake --preset default
cmake --build --preset default

The built binary will be in build/default/.

Desktop App (from source)

The desktop app requires Rust and Node.js 20+.

git clone https://github.com/contextgg/mortar-app.git
cd mortar-app
npm install
npm run dev

Map Editor (local)

To run the map editor locally:

git clone https://github.com/contextgg/map-editor.git
cd map-editor
npm install
npm run dev

The editor will be available at http://localhost:5173.

API (local)

git clone https://github.com/contextgg/mortar-api.git
cd mortar-api
npm install
cp .env.example .env  # Configure database connection
npm run dev

The API will be available at http://localhost:3000.