Skip to content

Commit

Permalink
Revamp usage instructions
Browse files Browse the repository at this point in the history
This commit revamps the usage instructions in order to accomplish two
goals:

1. Make the instructions easier to follow by turning them into a
   numbered list.
2. Make sure that macOS and Linux users install all of the built
   libraries for their platforms.
  • Loading branch information
Jayman2000 committed May 6, 2024
1 parent cb6e410 commit 305500b
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,29 @@ There is no "release" yet. The current milestone is "1.5 Stable", which is meant
The milestone needs testing on all platforms. Please report issues when found.

## Usage
Purchase Descent 3 from a reputable source, such as [GOG](https://www.gog.com/game/descent_3_expansion) or [Steam](https://store.steampowered.com/app/273590/Descent_3/), and install it, then replace the main binary with the newly built `Descent3` binary under `${CMAKE_BINARY_DIR}/Descent3/*/Descent3[.exe]`.
See your platform below:
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 v1.4.

#### Windows
If still using the Descent 3 launcher, copy your `Descent3.exe` binary to your install folder and rename it `main.exe` (back up your old one). Otherwise, drop in `Descent3.exe` and play!
- **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. [If you do not do this, then cutscenes will not work.](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.

#### MacOS
Right-click Descent3.app, click Show Package Contents. Back up your `Descent3` binary and drop your built `Descent3` binary into the install (Contents/MacOS) folder.
- **Note for non-Windows users:** If you have the Windows version of the game on CDs but you don’t want to use Windows, then check out [this guide](https://github.com/DescentDevelopers/Descent3/discussions/273#discussioncomment-9300692).

#### Linux
Back up your `Descent3` binary and drop your built `Descent3` binary into the install folder.
3. Copy your Descent 3 installation into a new folder. You can call the folder whatever you want, but this guide will call it `D3-open-source`.
4. Delete these files if they exist:
- `D3-open-source/MAIN.EXE`
- `D3-open-source/Descent3`
- `D3-open-source/d3-linux.hog`
5. Delete these folders if they exist, **unless you’re running Windows**. If you’re running Windows, then skip this step.
- `D3-open-source/netgames`
- `D3-open-source/online`
6. 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`.
7. Copy all of the new engine files into `D3-open-source`.
8. If you’re using Windows, rename `Descent3.exe` to `MAIN.EXE`. **Note:** Make sure that you rename `Descent3.exe` (no spaces). Leave `Descent 3.exe` (with a space) alone.
9. Run the game:
- On Windows, run `D3-open-source\Descent 3.exe` or `D3-open-source\MAIN.EXE`.
- On other platforms, run `D3-open-source\Descent3`.

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

0 comments on commit 305500b

Please sign in to comment.