Descent3/README.md

![d3 (1)](https://github.com/DescentDevelopers/Descent3/assets/47716344/82ba0911-ee32-4565-84ee-b432c215ab95)

This is the Descent 3 open source engine, licensed under [GPL-3.0](https://github.com/DescentDevelopers/Descent3?tab=GPL-3.0-1-ov-file). It includes the '1.5' patch written by Kevin Bentley and Jeff Slutter several years ago and brought to a stable condition by the Descent community.

In order to use this, you must provide your own game files. See the **Usage** section for details.

## Version 1.5 Notes
There is no "release" yet. The current milestone is "1.5 Stable", which is meant to more or less be Descent 3 as it might have been if the 1.5 patch had made it to retail years ago. Artifacts can be downloaded from the [Actions](https://github.com/DescentDevelopers/Descent3/actions) tab.
The milestone needs testing on all platforms. Please report issues when found.

## Usage
1. Make sure that you have a copy of Descent 3. You can purchase a copy of Descent 3 from [GOG](https://www.gog.com/game/descent_3_expansion) or [Steam](https://store.steampowered.com/app/273590/Descent_3/).
2. Install Descent 3.

    - **Note for Steam users:** If you own Descent 3 on Steam, then it’s recommended that you install the Windows version of the game even if you’re running macOS or Linux, otherwise movies will not work due to [current lack of Ogv support](https://github.com/DescentDevelopers/Descent3/issues/240). You can use either [Steam Play](https://help.steampowered.com/en/faqs/view/08F7-5D56-9654-39AF) or [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD#Cross-Platform_Installation) to install the Windows version of the game on macOS or Linux.

    - **Note for non-Windows users:** If you have the Windows version of the game on CDs but you don’t want to use Windows to install them, then you can follow these instructions:

        <details>
        <summary>How to install the Windows Dual-Jewel version of Descent 3 in Wine</summary>

        <ol type="1">
            <li>Make sure that you have <a href="https://www.winehq.org">Wine</a> installed.</li>
            <li><i>(Recommended)</i> Run <code>winecfg</code> and make sure that “Emulate a virtual desktop” is enabled.</li>
            <li>
                <p><i>(Optional)</i> Determine if you’re going to be affected by a bug with Descent 3’s installer, and potentially apply a workaround:</p>
                <ol type="a">
                    <li>Download <a href="https://codeberg.org/JasonYundt/environment-size-checker">Environment Size Checker</a>.</li>
                    <li>Run <code>wine environment-size-checker.exe</code>.</li>
                    <li>If that program tells you that your environment is more than 32,724 bytes large, then you’ll need to unset or shorten environment variables before running Descent 3’s installer. If you don’t, then the installer will page fault.</li>
                </ol>
            </li>
            <li>
                <p>Install Descent 3:</p>
                <ol type="a">
                    <li>Insert disc 1.</li>
                    <li>Make sure that disc 1 is mounted.</li>
                    <li>Determine which drive letter Wine is using for your CD drive. (Hint: try running <code>wine explorer</code>).</li>
                    <li>Run <code>wine '&lt;drive-letter&gt;:\Setup.exe'</code>.</li>
                    <li>Follow the installation wizard’s instructions until it asks you to choose a “Setup Type”.</li>
                    <li>Select the “Full” Setup Type, then click “Next”.
                    <li>Continue following the installation wizard’s instructions until it asks you to insert disc 2.</li>
                    <li>
                        <p>Switch to disc 2:</p>
                        <!-- This really should be an <ol>, but I couldn’t get the numbering/lettering to work right: <https://github.com/orgs/community/discussions/124850> -->
                        <ul>
                            <li>Run <code>wine eject &lt;drive-letter&gt;:</code>.</li>
                            <li>Make sure that the disc was unmounted and ejected.</li>
                            <li>Insert disc 2.</li>
                            <li>Mount disc 2.</li>
                        </ul>
                    </li>
                    <li>Continue following the installation wizard’s instructions until it asks you to insert disc 1 again.</li>
                    <li>Switch back to disc 1. Follow a similar procedure to the one that you used to switch to disc 2.</li>
                    <li>Finish the going through the installation wizard.</li>
                    <li>When the installation wizard finishes, it will open an explorer window. Close out of that window.</li>
                    <li>Unmount the disc.</li>
                    <li>Eject the disc.</li>
                </ol>
            <li>
                <p>Install Descent 3: Mercenary:</p>
                <ol type="a">
                    <li>Insert disc 3.</li>
                    <li>Make sure that disc 3 is mounted.</li>
                    <li>Run <code>wine start /d &lt;drive-letter&gt;: setup.exe -autorun</code>.</li>
                    <li>Follow the instructions in the installation wizard.</li>
                </ol>
            </li>
        </ol>

        </details>

3. If your version of Descent 3 is older than v1.4, then [update it to v1.4](http://descent3.com/downloads.php).
4. Create a new folder named `D3-open-source`.
5. Copy the following files from your installation of Descent 3 to `D3-open-source`:
    - All `.hog` files, except for `d3-linux.hog`
    - The `missions` folder
    - _(Optional)_ All `.pld` files
    - _(Optional)_ The `demo` folder
    - _(Optional)_ The `movies` folder
6. Create the following folders in `D3-open-source`:
    - `cache/`
    - `custom/`
    - `custom/cache/`
7. Obtain new Descent 3 engine files:
    - If you want to use pre-built binaries, then download one of the artifacts from our latest CI run. You can find a list of CI runs [here](https://github.com/DescentDevelopers/Descent3/actions/workflows/build.yml?query=branch%3Amain).
    - If you want to build the engine files yourself, the follow [these instructions](#building). Once you build the engine files, they’ll be put in `builds/<platform>/Descent3/<build-type>/`. For example, if you’re using Linux and you create a “Release” build, then the files will be located at `builds/linux/Descent3/Release`.
8. Copy all of the new engine files into `D3-open-source`.
9. Run the game:
    - On Windows, run `D3-open-source\Descent3.exe`.
    - On other platforms, run `D3-open-source/Descent3`.

## Building
Build steps below assume you have already cloned the repository and entered it locally.

#### Building - Windows
Requires Visual Studio 2022 and C++ Tools (cmake and vcpkg)

Install and configure vcpkg:
```sh
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && bootstrap-vcpkg.bat
setx VCPKG_ROOT="C:\path\to\vcpkg"
setx PATH=%VCPKG_ROOT%;%PATH%
```

Build Descent 3:
```sh
cmake --preset win -D ENABLE_LOGGER=[ON|OFF]
cmake --build --preset win --config [Debug|Release]
```

#### Building - MacOS
```sh
brew bundle install
cmake --preset mac -D ENABLE_LOGGER=[ON|OFF]
cmake --build --preset mac --config [Debug|Release]
```

#### Building - Linux (Ubuntu)
```sh
sudo apt update
sudo apt install -y --no-install-recommends ninja-build cmake g++ libsdl2-dev libncurses-dev zlib1g-dev
cmake --preset linux -D ENABLE_LOGGER=[ON|OFF]
cmake --build --preset linux --config [Debug|Release]
```

#### Building - Linux (Fedora)
```sh
sudo dnf update --refresh
sudo dnf install -y ninja-build cmake gcc-c++ SDL2-devel ncurses-devel zlib-devel
cmake --preset linux -D ENABLE_LOGGER=[ON|OFF]
cmake --build --preset linux --config [Debug|Release]
```

## 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.