Cronocide/Descent3
1
0
Fork 0
mirror of https://github.com/kevinbentley/Descent3.git synced 2025-01-23 03:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #147 from scivision/doc

Browse Source 
Readme: tell location of new Descent3 exe
This commit is contained in:
Azamat H. Hackimov 2024-04-22 10:45:43 +03:00 committed by GitHub
commit c791e177b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,14 +1,15 @@
# Descent 3 # 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. In order to use this, you must provide your own game files. See the **Usage** section for details.
## Version 1.5 Notes ## 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. The milestone needs testing on all platforms. Please report issues when found.
## Usage ## 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 #### 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. 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 #### Building - Windows
Requires Visual Studio C++ Tools (cmake and nmake) Requires Visual Studio C++ Tools (cmake and nmake)
``` ```sh
cmake --preset win cmake --preset win
cmake --build --preset win --config [Debug/Release] cmake --build --preset win --config [Debug/Release]
``` ```
#### Building - MacOS #### Building - MacOS
``` ```sh
brew bundle install brew bundle install
cmake --preset mac cmake --preset mac
cmake --build --preset mac --config [Debug/Release] cmake --build --preset mac --config [Debug/Release]
``` ```
#### Building - Linux #### Building - Linux
``` ```sh
sudo dpkg --add-architecture i386 sudo dpkg --add-architecture i386
sudo apt update 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 sudo apt install -y --no-install-recommends ninja-build cmake g++ libsdl1.2-dev libsdl-image1.2-dev libncurses-dev libxext6:i386