Use vcpkg for all platform presets

DescentDevelopers · Jul 12, 2024 · ab9e0b1 · ab9e0b1
1 parent 87f6ef0
commit ab9e0b1
Show file tree

Hide file tree

Showing 6 changed files with 153 additions and 43 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -66,22 +66,25 @@ jobs:
         run: |
           sudo apt update
           sudo apt install -y --no-install-recommends \
-            ninja-build cmake g++ libgtest-dev libsdl2-dev zlib1g-dev libspdlog-dev
+            ninja-build cmake g++
 
       - name: Install Windows dependencies
         if: ${{ matrix.os.runner == 'windows-latest' }}
         run: choco install ninja
-      
+
       - uses: ilammy/msvc-dev-cmd@v1
         if: ${{ matrix.os.runner == 'windows-latest' }}
         with:
            arch: win64
 
+      - uses: lukka/run-vcpkg@v11
+        with:
+          vcpkgJsonGlob: vcpkg.json
+
       - name: Configure CMake
         env:
           CC: ${{ matrix.os.cc }}
           CXX: ${{ matrix.os.cxx }}
-          VCPKG_ROOT: C:/vcpkg
         run: cmake --preset ${{ matrix.os.preset }} -DBUILD_TESTING=ON -DENABLE_LOGGER=ON -DFORCE_PORTABLE_INSTALL=ON -DBUILD_EDITOR=ON
 
       - name: Build ${{ matrix.build_type }}

diff --git a/Brewfile b/Brewfile
@@ -1,11 +1,4 @@
 # Homebrew dependencies to build Descent3
 
-# SDL
-brew "sdl2"
-
 brew "cmake"
-brew "googletest"
 brew "ninja"
-
-# zlib
-brew "zlib"
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,23 @@
 cmake_minimum_required(VERSION 3.20)  # For using CMAKE_<LANG>_BYTE_ORDER
 
+if(NOT DEFINED USE_VCPKG OR USE_VCPKG)
+  if(DEFINED ENV{VCPKG_ROOT})
+    if (CMAKE_TOOLCHAIN_FILE)
+      cmake_path(ABSOLUTE_PATH CMAKE_TOOLCHAIN_FILE NORMALIZE OUTPUT_VARIABLE VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
+    endif()
+
+    set(VCPKG_TOOLCHAIN_FILE "scripts/buildsystems/vcpkg.cmake")
+    cmake_path(ABSOLUTE_PATH VCPKG_TOOLCHAIN_FILE BASE_DIRECTORY $ENV{VCPKG_ROOT} NORMALIZE OUTPUT_VARIABLE CMAKE_TOOLCHAIN_FILE)
+
+    if(CMAKE_TOOLCHAIN_FILE STREQUAL VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
+      # prevent endless recursion
+      unset(VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
+    endif()
+  elseif(USE_VCPKG)
+    message(WARNING "USE_VCPKG=${USE_VCPKG} but ENV{VCPKG_ROOT} not set; will use system-provided libraries. Did you forget to set VCPKG_ROOT in your environment?")
+  endif()
+endif()
+
 # set default cmake build type to Debug (None Debug Release RelWithDebInfo MinSizeRel)
 if(NOT CMAKE_BUILD_TYPE AND NOT DEFINED ENV{CMAKE_BUILD_TYPE})
   set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "default build type")
@@ -10,7 +28,7 @@ project(Descent3
   VERSION 1.5.0
 )
 
-option(FORCE_COLORED_OUTPUT "Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with ninja)." OFF)
+option(FORCE_COLORED_OUTPUT "Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with Ninja)." OFF)
 option(FORCE_PORTABLE_INSTALL "Install all files into local directory defined by CMAKE_INSTALL_PREFIX" ON)
 option(ENABLE_LOGGER "Enable logging to the terminal" OFF)
 option(ENABLE_MEM_RTL "Enable Real-time library memory management functions (disable to verbose memory allocations)" ON)

diff --git a/CMakePresets.json b/CMakePresets.json
@@ -21,8 +21,7 @@
 			"architecture": {
 				"strategy": "external",
 				"value": "x64"
-			},
-			"toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+			}
 		},
 		{
 			"name": "mac",

diff --git a/README.md b/README.md
@@ -92,17 +92,24 @@ The milestone needs testing on all platforms. Please report issues when found.
     - D3 Open Source compiles level scripts in their own hogfiles. Make sure you copy and overwrite `d3-{platform}.hog`.
 
 ## Building
-#### Building - Windows
-1. 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:
+### Dependencies
+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) 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.
 
+### Installing and using vcpkg
+* When building for Windows, vcpkg is already installed and configured when using the Developer Tools Command Prompt.
+* 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.
+
+### Building - Windows
+1. **Install the prerequisite build tools.**
+
+    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:
     <!--
     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.
 
     [1]: <https://learn.microsoft.com/en-us/visualstudio/install/use-command-line-parameters-to-install-visual-studio?view=vs-2022>
     [2]: <https://github.com/microsoft/vswhere/wiki#installing>
     [3]: <https://learn.microsoft.com/en-us/answers/questions/1689898/does-visual-studio-build-tools-2022-support-32-bit>
     -->
-
     ```batch
     winget install Git.Git Microsoft.VisualStudio.2022.Community
 
@@ -114,61 +121,144 @@ The milestone needs testing on all platforms. Please report issues when found.
         --add Microsoft.VisualStudio.Component.VC.ATLMFC
     ```
 
-2. Open a “x64 Native Tools Command Prompt” and run:
+    **NOTE:**
+    Builds _must_ be performed in the “x64 Native Tools Command Prompt” (or PowerShell) provided by Visual Studio, _not_ a standard Command Prompt (or PowerShell). The Native Tools CLIs will already have vcpkg installed and configured for use, so no dependency management is needed.
+
+2. **Clone the Descent3 source code.**
 
+    Open a “x64 Native Tools Command Prompt” and run:
     ```batch
     git clone https://github.com/DescentDevelopers/Descent3
+    ```
+
+4. **Build Descent3.**
+
+    ```batch
     cd Descent3
-    cmake --preset win -D ENABLE_LOGGER=[ON|OFF] -D BUILD_EDITOR=[ON|OFF]
+    cmake --preset win
     cmake --build --preset win --config [Debug|Release]
     ```
+    See [Build Options](#build-options) below for more information on `Debug` vs `Release`.
 
 Once CMake finishes, the built files will be put in `builds\win\Descent3\Debug` or `builds\win\Descent3\Release`.
 
-#### Building - macOS
-1. Make sure that [Xcode](https://developer.apple.com/xcode) is installed.
+### Building - macOS
+1. **Install the prerequisite build tools.**
 
-2. Make sure that [Homebrew](https://brew.sh) is installed.
+    * Make sure that [Xcode](https://developer.apple.com/xcode) is installed.
+    * Make sure that [Homebrew](https://brew.sh) is installed.
 
-3. Run these commands:
+2. **Acquire the library dependencies.**
+
+    * If you would like to use vcpkg:
+        ```sh
+        git clone https://github.com/microsoft/vcpkg
+        export VCPKG_ROOT="$PWD/vcpkg"
+        ```
+        **NOTE:**
+        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.
+    * If you would like to manage the code dependencies yourself:
+        ```sh
+        brew install sdl2 zlib googletest
+        ```
+
+3. **Clone the Descent3 source code.**
 
     ```sh
     git clone https://github.com/DescentDevelopers/Descent3
+    ```
+
+4. **Build Descent3.**
+
+    ```sh
     cd Descent3
     brew bundle install
-    cmake --preset mac -D ENABLE_LOGGER=[ON|OFF]
+    cmake --preset mac
     cmake --build --preset mac --config [Debug|Release]
     ```
+    See [Build Options](#build-options) below for more information on `Debug` vs `Release`.
 
 Once CMake finishes, the built files will be put in `builds/mac/Descent3/Debug` or `builds/mac/Descent3/Release`.
 
-#### Building - Linux (Ubuntu)
-Run these commands:
+### Building - Linux
+1. **Install the prerequisite build tools.**
 
-```sh
-sudo apt update
-sudo apt install -y --no-install-recommends git ninja-build cmake g++ libsdl2-dev zlib1g-dev
-git clone https://github.com/DescentDevelopers/Descent3
-cd Descent3
-cmake --preset linux -D ENABLE_LOGGER=[ON|OFF]
-cmake --build --preset linux --config [Debug|Release]
-```
+    * APT users (Debian, Ubuntu)
+        ```sh
+        sudo apt update
+        sudo apt install -y --no-install-recommends git ninja-build cmake g++ libncurses-dev
+        ```
+    * DNF users (Red Hat, Fedora)
+        ```sh
+        sudo dnf update --refresh
+        sudo dnf install -y git ninja-build cmake gcc-c++ ncurses-devel
+        ```
+
+2. **Acquire the library dependencies.**
+
+    * If you would like to use vcpkg:
+        1. Clone vcpkg
+            ```sh
+            git clone https://github.com/microsoft/vcpkg
+            export VCPKG_ROOT="$PWD/vcpkg"
+            ```
+            **NOTE:**
+            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.
+        2. Install vcpkg-needed build tools and dependencies:
+            * APT users
+                ```sh
+                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
+                ```
+            * DNF users
+                ```sh
+                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
+                ```
+    * If you would like to manage the code dependencies yourself:
+        * APT users
+            ```sh
+            sudo apt install -y --no-install-recommends libsdl2-dev zlib1g-dev libgtest-dev
+            ```
+        * DNF users
+            ```sh
+            sudo dnf install -y SDL2-devel zlib-devel gtest
+            ```
+
+3. **Clone the Descent3 source code.**
+
+    ```sh
+    git clone https://github.com/DescentDevelopers/Descent3
+    ```
+
+4. **Build Descent3.**
+
+    ```sh
+    cd Descent3
+    cmake --preset linux
+    cmake --build --preset linux --config [Debug|Release]
+    ```
+    See [Build Options](#build-options) below for more information on `Debug` vs `Release`.
 
 Once CMake finishes, the built files will be put in `builds/linux/Descent3/Debug` or `builds/linux/Descent3/Release`.
 
-#### Building - Linux (Fedora)
-Run these commands:
+### Build Options
 
+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:
 ```sh
-sudo dnf update --refresh
-sudo dnf install -y git ninja-build cmake gcc-c++ SDL2-devel zlib-devel
-git clone https://github.com/DescentDevelopers/Descent3
-cd Descent3
-cmake --preset linux -D ENABLE_LOGGER=[ON|OFF]
-cmake --build --preset linux --config [Debug|Release]
+cmake --preset linux -DENABLE_LOGGER=ON
 ```
 
-Once CMake finishes, the built files will be put in `builds/linux/Descent3/Debug` or `builds/linux/Descent3/Release`.
+**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.
+
+| Option | Description | Default |
+| ------ | ----------- | ------- |
+| `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` |
+| `BUILD_EDITOR` | _(Windows-only)_ Build internal editor. | `OFF` |
+| `BUILD_TESTING` | Enable testing. Requires GTest. | `OFF` |
+| `ENABLE_LOGGER` | Enable logging to the terminal. | `OFF` |
+| `ENABLE_MEM_RTL` | Enable Real-time library memory management functions (disable to verbose memory allocations). | `ON` |
+| `FORCE_COLORED_OUTPUT` | Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with Ninja). | `OFF` |
+| `FORCE_PORTABLE_INSTALL` | Install all files into local directory defined by `CMAKE_INSTALL_PREFIX`. | `ON` |
+| `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. |
 
 ## Contributing
 Anyone can contribute! We have an active Discord presence at [Descent Developer Network](https://discord.gg/GNy5CUQ). If you are interested in maintaining the project on a regular basis, please contact Kevin Bentley.
diff --git a/vcpkg.json b/vcpkg.json
@@ -5,7 +5,14 @@
     "zlib",
     {
       "name": "sdl2",
-      "version>=": "2.30.3"
+      "version>=": "2.30.3",
+      "features": ["x11","wayland"],
+      "platform": "linux"
+    },
+    {
+      "name": "sdl2",
+      "version>=": "2.30.3",
+      "platform": "!linux"
     }
   ],
   "overrides": [