Installation

Desktop App

The desktop app is all you need to start playing. It handles downloading and updating the Mortar engine automatically.

1. Download the latest release for your platform from GitHub Releases
2. Install and launch the app
3. On first launch, the app downloads the latest Mortar engine — this only takes a moment
4. Sign in with GitHub or Discord
5. Browse community maps or open the editor to create your own

Engine Updates

Each time you open the desktop app, it checks whether you have the latest version of the Mortar engine installed. If an update is available, it downloads automatically before you can play. You can see the currently installed engine version in Settings.

Build from Source

If you’d rather build the components yourself, see below. Most users should use the desktop app instead.

Engine

See Building from Source for full instructions on building the Mortar engine.

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

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

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

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.