Skip to content

Compilation

Jacob Bowen edited this page Mar 8, 2026 · 1 revision

Compilation

The Compilation page lets you trigger an AzerothCore CMake/make build directly from the browser, with live streaming output.


Overview

When new AzerothCore source updates or module changes require recompiling, you can trigger the build from the panel instead of SSH-ing into the server.

The build runs in the background on the host machine. Progress lines are streamed to the browser via Server-Sent Events (SSE).


Starting a Build

  1. Navigate to Compilation in the sidebar.
  2. Optionally adjust:
    • CMake Options — extra flags passed to cmake, e.g. -DCMAKE_BUILD_TYPE=RelWithDebInfo -DTOOLS_BUILD=all
    • CPU Cores — number of parallel make jobs (default: all available cores)
  3. Click Start Build.

The build output will stream in real time in the terminal pane on the page.


Build Status

The status indicator shows the current or last build state:

Status Meaning
idle No build has been run yet
running Build is in progress
success Last build completed successfully
failed Last build failed — check the output for errors

Common CMake Options

Option Description
-DCMAKE_BUILD_TYPE=RelWithDebInfo Build with debug symbols (recommended for development)
-DCMAKE_BUILD_TYPE=Release Optimized release build
-DTOOLS_BUILD=all Build all map/data extraction tools
-DTOOLS_BUILD=map-extractor Build only the map extractor
-DWITH_WARNINGS=1 Enable compiler warnings
-DAC_DASHBOARD_BUILD=ON Include AzerothCore dashboard modules

Example:

-DCMAKE_BUILD_TYPE=RelWithDebInfo -DTOOLS_BUILD=all -DWITH_WARNINGS=1

Prerequisites

Before a build will succeed:

  • AzerothCore source must be present at AC Path (configured in Settings).
  • A CMake build directory must exist or be creatable (<AC_PATH>/build by default).
  • cmake, make (or ninja), and a C++ compiler must be installed on the host.

For AzerothCore the typical dependency installation:

sudo apt update && sudo apt install -y cmake make clang git \
  libmysqlclient-dev openssl libssl-dev libbz2-dev libreadline-dev \
  libncurses-dev libboost-all-dev

API Endpoints

Method Path Description
GET /api/v1/compilation/status Get current / last build status
POST /api/v1/compilation/build Trigger a build (SSE stream)

Example request

POST /api/v1/compilation/build
Authorization: Bearer <token>
Content-Type: application/json

{
  "cmake_options": "-DCMAKE_BUILD_TYPE=RelWithDebInfo",
  "cores": 4
}

The response is a text/event-stream SSE stream of build output lines.


Troubleshooting

Build fails with "cmake: command not found"

  • Install cmake on the host machine.

Build fails immediately with permission errors

  • The backend process must have write access to the build directory.
  • In Docker, the container runs as root so access is typically not an issue.

Build output stream stops but never completes

  • Check the build directory for a CMakeCache.txt — if none exists, the initial cmake configure step may have failed silently.
  • Try running cmake .. manually outside the panel first.

Clone this wiki locally