Files
Dreierpack-Manager/docs/BUILDING.md
T

4.2 KiB

Building OpenBMH

Requirements: a C++20 compiler, CMake 3.24 or newer, Git and a supported build tool such as Ninja. The CMake project fetches pinned SDL2, miniz, 7-Zip C decoder and nativefiledialog-extended sources. Network access is needed on the first configure unless these dependencies are supplied locally. Nuked OPL3 is included in the source tree.

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build
ctest --test-dir build --output-on-failure

The public checkout does not include game data. Tests that require a game installation are conditional; configure with -DBMH_DATA="path/to/game" to make locally available data eligible. Private saved-game fixtures are not supplied by the project. Read the test output to distinguish executed and skipped checks.

Main programs are OpenBMH (graphical game) and openbmh_cli (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the .exe suffix.

Windows

Use an MSVC environment with C++20 support and its Windows SDK, or another toolchain explicitly supported by the project's build configuration. From a Developer PowerShell with CMake and Ninja available:

cmake -S . -B build-windows -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build-windows
ctest --test-dir build-windows --output-on-failure

With a Visual Studio generator, choose one actually provided by your installed CMake and add --config Release / -C Release to build and test commands. Native file dialogs and runtime-library deployment require the platform SDK and package-specific checks.

Linux

Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the dialog backend. The default Linux dialog backend uses GTK3. For example, Debian-family development packages include build-essential, cmake, ninja-build, git, pkg-config and libgtk-3-dev; SDL2's selected video/audio backends may need additional development libraries.

The common commands above build the bundled SDL2. To use an installed SDL2 CMake package instead, configure with -DBMH_USE_SYSTEM_SDL2=ON. Its version and backend configuration then come from the installed package.

macOS

Apple's Command Line Tools are sufficient for the compiler and SDK; the full Xcode application is not a prerequisite for a command-line build. Install the tools with xcode-select --install, and install CMake and Ninja separately. On an Apple Silicon machine:

cmake -S . -B build-macos -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=arm64
cmake --build build-macos
ctest --test-dir build-macos --output-on-failure

Use native toolchain/dependency architectures consistently. A terminal executable and a Finder-launchable, signed .app package are different deliverables. The commands describe the build procedure, not a claim that a particular Windows or macOS binary has passed native acceptance.

Run with your data

build/OpenBMH --data "path/to/game" --save-directory "path/to/saves"
build/openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --seed 1

For redistribution, include LICENSE, THIRD_PARTY_NOTICES.md, the full texts in licenses/, and the corresponding source and build information required by the applicable licenses. Inspect the actual libraries in each platform package; static SDL2 alone does not establish that every dependency is static.

Build the data-free CI subset

cmake --build build compiles every development helper and test. With no private integration data configured, CI builds both products and every executable actually referenced by CTest instead:

python3 tools/ci/build_runnable_tests.py --build build --config Release --parallel 2
ctest --test-dir build -C Release --output-on-failure

Tests whose inputs are unavailable still report a skip through the normal optional-data helper; they are not counted as passes. Supplying integration data during configuration causes their real programs to enter this build subset automatically. Source-export and build-discovery checks run separately in CI.