mirror of
https://github.com/kevinbentley/Descent3.git
synced 2025-01-22 19:55:23 +00:00
Merge pull request #147 from scivision/doc
Readme: tell location of new Descent3 exe
This commit is contained in:
commit
c791e177b1
13
README.md
13
README.md
@ -1,14 +1,15 @@
|
||||
# Descent 3
|
||||
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.
|
||||
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.
|
||||
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
|
||||
Purchase Descent 3 from a reputable source and install it, then replace the main binary with your build. See your platform below:
|
||||
Purchase Descent 3 from a reputable source and install it, then replace the main binary with the newly build Descent3 binary under "${CMAKE_BINARY_DIR}/Descent3/*/Descent3[.exe]".
|
||||
See your platform below:
|
||||
|
||||
#### Windows
|
||||
In the install folder, rename `main.exe` to `main.old` and take your built `Descent3.exe`, name it `main.exe`, and add it to the install folder.
|
||||
@ -24,20 +25,20 @@ Build steps below assume you have already cloned the repository and entered it l
|
||||
|
||||
#### Building - Windows
|
||||
Requires Visual Studio C++ Tools (cmake and nmake)
|
||||
```
|
||||
```sh
|
||||
cmake --preset win
|
||||
cmake --build --preset win --config [Debug/Release]
|
||||
```
|
||||
|
||||
#### Building - MacOS
|
||||
```
|
||||
```sh
|
||||
brew bundle install
|
||||
cmake --preset mac
|
||||
cmake --build --preset mac --config [Debug/Release]
|
||||
```
|
||||
|
||||
#### Building - Linux
|
||||
```
|
||||
```sh
|
||||
sudo dpkg --add-architecture i386
|
||||
sudo apt update
|
||||
sudo apt install -y --no-install-recommends ninja-build cmake g++ libsdl1.2-dev libsdl-image1.2-dev libncurses-dev libxext6:i386
|
||||
|
Loading…
Reference in New Issue
Block a user