|
| 1 | + |
| 2 | +# Building Descent 3 Open Source |
| 3 | + |
| 4 | +## Dependencies |
| 5 | +The build process uses [**CMake**](https://cmake.org/) and, by default, [**Ninja**](https://ninja-build.org/). You must install these; the project cannot locate them for you. The source code depends on [**SDL2**](https://github.com/libsdl-org/SDL/tree/SDL2) and [**zlib**](https://github.com/madler/zlib). You can supply these dependencies yourself via your system's library management tools, or the build system can locate the dependencies for you using [vcpkg](https://github.com/microsoft/vcpkg), a cross-platform dependency-management system developed by Microsoft. The official builds source their dependencies from vcpkg. |
| 6 | + |
| 7 | +## Installing and using vcpkg |
| 8 | +* When building for Windows, vcpkg is already installed and configured when using any of the Visual Studio command prompts (either actual Command Prompt, or PowerShell). |
| 9 | +* For Android, Linux or Mac (or non-standard-Windows) configurations, you will need to install vcpkg locally by cloning https://github.com/microsoft/vcpkg and setting your `VCPKG_ROOT` env var to the repository location. With this environment variable set, the build will automatically locate its dependencies. |
| 10 | + |
| 11 | +## Building - Windows |
| 12 | +1. **Install the prerequisite build tools.** |
| 13 | + |
| 14 | + Make sure that you have Git and Visual Studio 2022 with the “Desktop development with C++” workload and the “C++ MFC for latest v143 build tools (x86 & x64)” component. If you don’t already have those installed or you aren’t sure, then open an elevated Command Prompt and run: |
| 15 | + <!-- |
| 16 | + The following code block specifies the full path to the Visual Studio Installer because the Visual Studio Installer doesn’t add itself to the user’s Path. The installer is guaranteed to be in a specific location on 64-bit systems [1]. The installer will be in a different location on 32-bit systems [2], but Visual Studio 2022 doesn’t support 32-bit systems [3] so we can ignore that detail. |
| 17 | +
|
| 18 | + [1]: <https://learn.microsoft.com/en-us/visualstudio/install/use-command-line-parameters-to-install-visual-studio?view=vs-2022> |
| 19 | + [2]: <https://github.com/microsoft/vswhere/wiki#installing> |
| 20 | + [3]: <https://learn.microsoft.com/en-us/answers/questions/1689898/does-visual-studio-build-tools-2022-support-32-bit> |
| 21 | + --> |
| 22 | + ```batch |
| 23 | + winget install Git.Git Microsoft.VisualStudio.2022.Community |
| 24 | +
|
| 25 | + "%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\setup.exe" modify^ |
| 26 | + --passive^ |
| 27 | + --channelId VisualStudio.17.Release^ |
| 28 | + --productId Microsoft.VisualStudio.Product.Community^ |
| 29 | + --add Microsoft.VisualStudio.Workload.NativeDesktop;includeRecommended^ |
| 30 | + --add Microsoft.VisualStudio.Component.VC.ATLMFC |
| 31 | + ``` |
| 32 | +
|
| 33 | + **NOTE:** |
| 34 | + Builds _must_ be performed in one of the Visual Studio-provided **x64 Native Tools** command prompts ("x64 Native Tools Command Prompt" or "x64 Native Tools PowerShell"), _not_ a standard Command Prompt or PowerShell. The VS prompts will already have vcpkg installed and configured for use, so no dependency management is needed. |
| 35 | +
|
| 36 | +2. **Clone the Descent3 source code.** |
| 37 | +
|
| 38 | + Open a "x64 Native Tools Command Prompt" or "x64 Native Tools PowerShell" and run: |
| 39 | + ```batch |
| 40 | + git clone https://github.com/DescentDevelopers/Descent3 |
| 41 | + ``` |
| 42 | +
|
| 43 | +4. **Build Descent3.** |
| 44 | +
|
| 45 | + ```batch |
| 46 | + cd Descent3 |
| 47 | + cmake --preset win |
| 48 | + cmake --build --preset win --config [Debug|Release] |
| 49 | + ``` |
| 50 | + See [Build Options](#build-options) below for more information on `Debug` vs `Release`. |
| 51 | +
|
| 52 | +Once CMake finishes, the built files will be put in `builds\win\Descent3\Debug` or `builds\win\Descent3\Release`. |
| 53 | +
|
| 54 | +## Building - macOS |
| 55 | +1. **Install the prerequisite build tools.** |
| 56 | +
|
| 57 | + * Make sure that [Xcode](https://developer.apple.com/xcode) is installed. |
| 58 | + * Make sure that [Homebrew](https://brew.sh) is installed. |
| 59 | +
|
| 60 | +2. **Acquire the library dependencies.** |
| 61 | +
|
| 62 | + * If you would like to use vcpkg: |
| 63 | + ```sh |
| 64 | + git clone https://github.com/microsoft/vcpkg |
| 65 | + export VCPKG_ROOT="$PWD/vcpkg" |
| 66 | + ``` |
| 67 | + **NOTE:** |
| 68 | + You will need `$VCPKG_ROOT` defined in the environment for all build runs. It is a good idea to set this in your `.bashrc` or equivalent. |
| 69 | + * If you would like to manage the code dependencies yourself: |
| 70 | + ```sh |
| 71 | + brew install sdl2 zlib googletest |
| 72 | + ``` |
| 73 | +
|
| 74 | +3. **Clone the Descent3 source code.** |
| 75 | +
|
| 76 | + ```sh |
| 77 | + git clone https://github.com/DescentDevelopers/Descent3 |
| 78 | + ``` |
| 79 | +
|
| 80 | +4. **Build Descent3.** |
| 81 | +
|
| 82 | + ```sh |
| 83 | + cd Descent3 |
| 84 | + brew bundle install |
| 85 | + cmake --preset mac |
| 86 | + cmake --build --preset mac --config [Debug|Release] |
| 87 | + ``` |
| 88 | + See [Build Options](#build-options) below for more information on `Debug` vs `Release`. |
| 89 | +
|
| 90 | +Once CMake finishes, the built files will be put in `builds/mac/Descent3/Debug` or `builds/mac/Descent3/Release`. |
| 91 | +
|
| 92 | +## Building - Linux |
| 93 | +1. **Install the prerequisite build tools.** |
| 94 | +
|
| 95 | + * APT users (Debian, Ubuntu) |
| 96 | + ```sh |
| 97 | + sudo apt update |
| 98 | + sudo apt install -y --no-install-recommends git ninja-build cmake g++ |
| 99 | + ``` |
| 100 | + * DNF users (Red Hat, Fedora) |
| 101 | + ```sh |
| 102 | + sudo dnf update --refresh |
| 103 | + sudo dnf install -y git ninja-build cmake gcc-c++ |
| 104 | + ``` |
| 105 | +
|
| 106 | +2. **Acquire the library dependencies.** |
| 107 | +
|
| 108 | + * If you would like to use vcpkg: |
| 109 | + 1. Clone vcpkg: |
| 110 | + ```sh |
| 111 | + git clone https://github.com/microsoft/vcpkg |
| 112 | + export VCPKG_ROOT="$PWD/vcpkg" |
| 113 | + ``` |
| 114 | + **NOTE:** |
| 115 | + You will need `$VCPKG_ROOT` defined in the environment for all build runs. It is a good idea to set this in your `.bashrc` or equivalent. |
| 116 | + 2. Install vcpkg-needed build tools and dependencies: |
| 117 | + * APT users |
| 118 | + ```sh |
| 119 | + sudo apt install -y --no-install-recommends curl pkg-config autoconf automake libtool libltdl-dev make python3-jinja2 libx11-dev libxft-dev libxext-dev libwayland-dev libxkbcommon-dev libegl1-mesa-dev libibus-1.0-dev libasound2-dev libpulse-dev libaudio-dev libjack-dev libsndio-dev |
| 120 | + ``` |
| 121 | + * DNF users |
| 122 | + ```sh |
| 123 | + sudo dnf install -y autoconf automake libtool perl-open perl-FindBin python-jinja2 libX11-devel libXft-devel libXext-devel wayland-devel libxkbcommon-devel mesa-libEGL-devel ibus-devel alsa-lib-devel pulseaudio-libs-devel |
| 124 | + ``` |
| 125 | + * If you would like to manage the code dependencies yourself: |
| 126 | + * APT users |
| 127 | + ```sh |
| 128 | + sudo apt install -y --no-install-recommends libsdl2-dev zlib1g-dev libgtest-dev |
| 129 | + ``` |
| 130 | + * DNF users |
| 131 | + ```sh |
| 132 | + sudo dnf install -y SDL2-devel zlib-devel gtest |
| 133 | + ``` |
| 134 | +
|
| 135 | +3. **Clone the Descent3 source code.** |
| 136 | +
|
| 137 | + ```sh |
| 138 | + git clone https://github.com/DescentDevelopers/Descent3 |
| 139 | + ``` |
| 140 | +
|
| 141 | +4. **Build Descent3.** |
| 142 | +
|
| 143 | + ```sh |
| 144 | + cd Descent3 |
| 145 | + cmake --preset linux |
| 146 | + cmake --build --preset linux --config [Debug|Release] |
| 147 | + ``` |
| 148 | + See [Build Options](#build-options) below for more information on `Debug` vs `Release`. |
| 149 | +
|
| 150 | +Once CMake finishes, the built files will be put in `builds/linux/Descent3/Debug` or `builds/linux/Descent3/Release`. |
| 151 | +
|
| 152 | +## Build Options |
| 153 | +
|
| 154 | +The Descent3 build can be customized by [setting CMake variables on the command line](https://cmake.org/cmake/help/latest/manual/cmake.1.html#cmdoption-cmake-D) during its "Configuration" phase (the command without the `--build` option). To set a variable, you prepend the variable name with `-D` and then append the value, all as one single parameter. For example: |
| 155 | +```sh |
| 156 | +cmake --preset linux -DENABLE_LOGGER=ON |
| 157 | +``` |
| 158 | + |
| 159 | +**NOTE:** CMake variables, or more technically _CMake cache entries_, will persist in their values until they are explicitly cleared. So, if you set a variable and then run another CMake command _without_ that variable specified, the variable will still be set. Variables must be explicitly unset, or the `builds/` directory cleaned, in order to be cleared. |
| 160 | + |
| 161 | +| Option | Description | Default | |
| 162 | +| ------ | ----------- | ------- | |
| 163 | +| `CMAKE_BUILD_TYPE`<br/>(or just [`--config`](https://cmake.org/cmake/help/latest/manual/cmake.1.html#cmdoption-cmake-build-config), without the `-D` syntax) | <p>`Debug` builds are generally larger, slower and contain extra correctness checks that will validate game data and interrupt gameplay when problems are detected.</p><p>`Release` builds are optimized for size and speed and do not include debugging information, which makes it harder to find problems.</p> | `Debug` | |
| 164 | +| `BUILD_EDITOR` | _(Windows-only)_ Build internal editor. | `OFF` | |
| 165 | +| `BUILD_TESTING` | Enable testing. Requires GTest. | `OFF` | |
| 166 | +| `ENABLE_LOGGER` | Enable logging to the terminal. | `OFF` | |
| 167 | +| `ENABLE_MEM_RTL` | Enable Real-time library memory management functions (disable to verbose memory allocations). | `ON` | |
| 168 | +| `FORCE_COLORED_OUTPUT` | Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with Ninja). | `OFF` | |
| 169 | +| `FORCE_PORTABLE_INSTALL` | Install all files into local directory defined by `CMAKE_INSTALL_PREFIX`. | `ON` | |
| 170 | +| `USE_VCPKG` | Explicitly control whether or not to use vcpkg for dependency resolution. `ON` requires the environment variable `VCPKG_ROOT` to be set. | Determined by the existence of `VCPKG_ROOT` in the environment: If it exists, vcpkg is used. | |
0 commit comments