# Installing D1X-Rebirth and D2X-Rebirth
## Building

D1X-Rebirth and D2X-Rebirth (generically DXX-Rebirth) are built by an SConstruct script.  DXX-Rebirth runs on Windows (XP and later), Linux (x86 and amd64), recent Mac OS X, and Raspberry Pi.  Other targets may also work, but are not tracked by the core team.  If you maintain a working target not listed here, please file an issue to have it included in this list.

The DXX-Rebirth maintainers have no control over the sites linked below.  The maintainers are not responsible for the safety or correct operation of the prerequisites listed below.  Unless specified otherwise, the maintainers of DXX-Rebirth have not verified that the links are current, safe, or produce a working environment.

### Prerequisites

* [Python 3.x](https://www.python.org/) to run [scons](https://www.scons.org/), the processor for SConstruct scripts.
[Python 3.11](https://www.python.org/downloads/release/python-3117/) is recommended.
* C++ compiler with support for selected C++20 features.  One of:
    * [gcc](https://gcc.gnu.org/) 12, 13, or 14
    * [clang](https://clang.llvm.org/) 15.0 or later
    * Microsoft Visual Studio is **not** supported at this time.
	  Visual Studio 2022 release notes indicate it has sufficient C++ support
	  that it should be able to compile Rebirth.  However, due to limitations
	  of the Visual Studio installation environment, the core team does not
	  use, test, or support Visual Studio.
* [SDL 1.2](https://www.libsdl.org/).
SDL 2 is also supported, and will become the default soon.
* [PhysicsFS](https://icculus.org/physfs/).
PhysFS 3.x or later is required.

Optional, but recommended:

* [SDL\_image 1.2](https://www.libsdl.org/projects/SDL_image/).
* [SDL\_mixer 1.2](https://www.libsdl.org/projects/SDL_mixer/).
* [libpng](http://www.libpng.org/).

Unless otherwise noted, using the newest release available is recommended.  For example, prefer gcc-13 to gcc-12, even though both should work.

DXX-Rebirth can be built on one system to run on a different system, such as using Linux to build for Windows (a "cross-compiled build").  The sections below specify where to get prerequisites for a build meant to run on the system where it is built (a "native build").

For each prerequisite, its development headers (files ending in **.h**) and its libraries (ending in **.so** for Linux, **.dylib** for Mac OS X, and **.dll** for Windows) must be found by the compiler.  You can do this by placing these files in an existing directory which the compiler will search, or by placing these files in a directory which you instruct the compiler to search.

In general, avoid installing prerequisites to paths which contain embedded spaces.  Although Rebirth quotes paths to handle this, some prerequisites may use `pkg-config` files that do not handle embedded spaces well.

#### Placing files in a directory which you instruct the compiler to search (preferred)

If you choose to install the headers and/or libraries in a new path, you must instruct the build system to search that path.  To do this for development headers, add to the scons command line **"CPPFLAGS=-isystem** _/absolute/path/to/header/directory_**"**.  To do this for libraries, add to the scons command line **"LINKFLAGS=-L** _/absolute/path/to/library/directory_**"**.

#### Adding files to an existing directory which the compiler will search

To find these paths for gcc:
* Get the compiler's header search path by running **gcc -Wp,-v -S -x c++ /dev/null** and looking at the lines under the label **#include <...> search starts here:**.  Any of these lines will work.  The paths _without_ a compiler version number in them are preferable.  Windows users may need to write **gcc -Wp,-v -S -x c++ nul** instead, due to Windows using a different name for the null device.
* Get the compiler's library search path by running **gcc -print-search-dirs** and looking at the line labeled **libraries:**.  This line is a list of directories that will be searched.  Any of the directories will work.  Again, prefer directories that are do not have a compile version number in them.

#### Windows
Where possible, Windows users should try to obtain a compiled package, rather than locally compiling from source.  To build from source, read on.

If you are not sure whether your system is Windows x86 or Windows x64, use the packages for Windows x86.  Systems running Windows x64 support running Windows x86 programs, but Windows x86 systems do not run Windows x64 programs.

* [Python x86 installer](https://www.python.org/ftp/python/3.11.7/python-3.11.7.exe) |
[Python x64 installer](https://www.python.org/ftp/python/3.11.7/python-3.11.7-amd64.exe)
* [SCons](http://prdownloads.sourceforge.net/scons/scons-4.2.0.zip)
* C++ compiler
    * mingw-gcc: [Getting Started](http://www.mingw.org/wiki/Getting_Started) |
	[Direct download](https://sourceforge.net/projects/mingw/files/latest/download)
* [SDL 1.2 x86 zip](https://www.libsdl.org/release/SDL-1.2.15-win32.zip) |
[SDL 1.2 x64 zip](https://www.libsdl.org/release/SDL-1.2.15-win32-x64.zip)
* No published PhysFS package for Windows is known.
You must [build it](https://hg.icculus.org/icculus/physfs/raw-file/bf155bd2127b/INSTALL.txt)
from [source](https://icculus.org/physfs/downloads/physfs-3.0.2.tar.bz2).
You may be able avoid building from source by copying PhysFS DLLs from a
previous Rebirth release and installing current PhysFS headers.
However, building from source is recommended to ensure a consistent
environment.

#### MSYS2/mingw-w64 (Windows alternate method)
* `pacman -S git ${MINGW_PACKAGE_PREFIX}-{gcc,pkgconf,scons,SDL,SDL_image,SDL_mixer,libpng,physfs}`

#### Linux
Install the listed prerequisites through your system package manager.
* Arch PKGBUILD files are in `contrib/arch/`
* An RPM spec file is in `contrib/rpm/`
* Gentoo ebuild files are in `contrib/gentoo/`

##### Arch
* **pacman -S
 base-devel
 scons
 sdl
 sdl\_image
 sdl\_mixer
 physfs**

##### Fedora
* **yum install
 gcc-c++
 scons
 SDL-devel
 SDL\_image-devel
 SDL\_mixer-devel
 physfs-devel**

##### Gentoo
* **emerge --ask --verbose --noreplace
 dev-util/scons
 media-libs/libsdl
 media-libs/sdl-image
 media-libs/sdl-mixer
 dev-games/physfs**

##### Ubuntu
* **apt-get install
 build-essential
 scons
 libsdl1.2-dev
 libsdl-image1.2-dev
 libsdl-mixer1.2-dev
 libphysfs-dev**

#### Mac OS X
Where possible, Mac users should try to obtain a compiled package, rather than locally compiling from source.  To build from source, read on.

Install the listed prerequisites through your preferred package manager.

PhysicsFS must be installed as a separate dynamic library.  It is not supported as an OS X Framework.  The required files will be installed into the correct locations by the PhysicsFS installer; refer to the relevant instructions.

The Mac OS X Command Line Tools are required.  Install them by running

    xcode-select --install

from the Terminal.  This may need to be done after each major OS upgrade as well.

DXX-Rebirth can be built from the Terminal (via SCons) without Xcode; to build using Xcode requires Xcode to be installed.

When building for Mac OS X, only SDL 2 is currently supported, as SDL 1.2 has long-standing issues with modern versions of the operating system.  Terminal builds for Mac OS X default to SDL 2, which is equivalent to passing **sdl2=True** as a parameter to the SCons command.

**Note:** If intending to cross-compile from Linux to macOS, information about this process can be found at [macOS_Cross_Compilation.markdown](macOS_Cross_Compilation.markdown).

##### [Homebrew](https://github.com/Homebrew/homebrew/)
The project includes a Brewfile for installing all required dependencies, if you use Homebrew.  You can install them with:

* **brew bundle**

**Note:** Because Homebrew only installs libraries and not frameworks, when building for Mac OS X with Homebrew-provided dependencies, you must provide **macos_add_frameworks=False** as a SCons command parameter in order for the build system to look for libraries rather than frameworks.

### Building
Once prerequisites are installed, run **scons** *options* to build.  By default, both D1X-Rebirth and D2X-Rebirth are built.  To build only D1X-Rebirth, run **scons d1x=1**.  To build only D2X-Rebirth, run **scons d2x=1**.

If unspecified, **SConstruct** uses $CXX for the compiler, $CPPFLAGS for preprocessor options, $CXXFLAGS for C++ compiler options, and $LDFLAGS for linker options.  You may override any or all of these choices by setting options of the corresponding name: **scons CXX=/opt/my/c++ 'CXXFLAGS=-O0 -ggdb'**.  **SConstruct** supports numerous options for adjusting build details.  Run **scons -h** to see them.  Option names are case sensitive.  Commonly used options include:

* **CXX=**_path_ - path to C++ compiler
* **CPPFLAGS='**_flags_**'** - flags for C preprocessor
* **CXXFLAGS='**_flags_**'** - flags for C++ compiler
* **LDFLAGS='**_flags_**'** - flags for linker
* **lto=1** - enable Link Time Optimization
* **sdlmixer=1** - enable support for SDL\_mixer
* **builddir=**_path_ - set directory for build outputs; defaults to "."
* **builddir\_prefix=**_path_ - Developer option; set builddir to builddir\_prefix plus a path derived from build options.
Use this to build multiple targets without picking specific paths for each one.
The generated path is stable across multiple runs with the same options.
Packaging scripts should use **builddir** with manually chosen directories.
* **verbosebuild=1** - show commands executed instead of short descriptions of the commands
* **prefix=**_path_ - (Linux only); equivalent to **--prefix** in Autoconf
* **sharepath=**_path_ - (Linux only); sets system directory to search for game data

The build system supports building multiple targets in parallel.  This is primarily useful for developers, but can also be used by packagers to create secondary builds with different features enabled.  To use it, run **scons** *game*=*profile[,profile...]*.  **SConstruct** will search each profile for the known options.  The first match wins.  For example:

        scons dxx=gcc13,e, d2x=gcc12,sdl2, \
            gcc13_CXX=/path/to/gcc-13 \
            gcc12_CXX=/path/to/gcc-12 \
            e_editor=1 sdl2_sdl2=1

This tells **SConstruct** to build both games (**dxx**) with the profiles **gcc13**, **e**, *empty* and also to build D2X-Rebirth (**d2x**) with the profiles **gcc12**, **sdl2**, *empty*.  Profiles **gcc13** and **gcc12** define private values for **CXX**, so the default value of **CXX** is ignored.  Profile **e** enables the **editor** option, which builds features used by players who want to create their own levels.  Profile **sdl2** sets the **sdl2** option to true, which produces a build that uses libSDL2 instead of libSDL.  Profile *empty* is the default namespace, so CPPFLAGS, CXXFLAGS, etc. are found when it is searched.  Since these values were not assigned, they are drawn from the corresponding environment variables.

The build system supports specifying a group of closely related targets.  This is mostly redundant on shells with brace expansion support, but can be easier to type.  For example:

        scons builddir_prefix=build/ \
			dxx=gcc12+gcc13,prof1,prof2,prof3,

This is equivalent to the shell brace expansion:

        scons builddir_prefix=build/ \
			dxx={gcc12,gcc13},prof1,prof2,prof3,

or

        scons builddir_prefix=build/ \
			dxx=gcc12,prof1,prof2,prof3, \
			dxx=gcc13,prof1,prof2,prof3,

Profile addition can be stacked: **scons dxx=a+b,c+d,e+f** is equivalent to **scons dxx=a,c,e dxx=a,d,e dxx=b,c,e dxx=b,d,e dxx=a,c,f dxx=a,d,f dxx=b,c,f dxx=b,d,f**.

#### Configuration
**SConstruct** runs tests to check for common problems and available functionality.  **SConstruct** will automatically enable available compiler features.  **SConstruct** will not automatically enable optional features which require an external library.  If the feature is enabled, either by default or by the provided options, and the library is present, it will be used.  If the feature is enabled, and the library is absent, the build fails.  If the feature is disabled, either by default or by the provided options, the library check is skipped and the feature is not used.

If required functionality is missing, **SConstruct** will stop the build and print a diagnostic message.  A stop at this stage indicates an environment problem.  If any target fails to configure, no target will be built.

Before reporting an issue, clear any applicable caches (**ccache -C**; **rm .sconsign.dblite**) and reproduce the failure.  The DXX-Rebirth maintainers may be able to help you resolve environment problems if you cannot solve them on your own.  If you need help, please post the full output of running **scons** and the contents of **sconf.log** from your build directory.

#### Compiling
After **SConstruct** finishes the configure tests, **scons** will compile and link the program.  Failures at this stage may indicate a bug that should be reported.  Broken environments are usually caught by **SConstruct** checks before the build began.  If the compilation succeeds, the output files will be found in game-specific directories.  If the profile specified editor features, then **-editor** is appended to the filename.

The output path can be overridden with the **SConstruct** option **program\_name**.  If **program\_name** is set, it overrides the game directory prefix and the optional **-editor** modification.  It does not override the output suffix (**.exe** for Windows, *empty* for Linux).

Windows output with **program\_name** unset:

* *build-directory*/d1x-rebirth/d1x-rebirth*[-editor]*.exe
* *build-directory*/d2x-rebirth/d2x-rebirth*[-editor]*.exe

Windows output with **d1x=1 program\_name**=**d1x-local**:

* *build-directory*/d1x-local.exe

Linux output with **program\_name** unset:

* *build-directory*/d1x-rebirth/d1x-rebirth*[-editor]*
* *build-directory*/d2x-rebirth/d2x-rebirth*[-editor]*

##### Compiling with MSYS2
MSYS2 offers its users three terminal environments: msys2, for building with POSIX compatibility (linking to runtime `/usr/bin/msys-2.0.dll`); and mingw32 and mingw64, for building portable native Windows apps (linking to `C:\WINDOWS\System32\msvcrt.dll`), on i686 and x86_64 respectively.
* Install [MSYS2](https://www.msys2.org), following the directions on the main page.
* In either a mingw32 or mingw64 (not msys2) terminal:

      pacman -Syuu  # update MSYS2, as needed
      pacman -S --needed git ${MINGW_PACKAGE_PREFIX}-{gcc,pkgconf,scons,SDL,SDL_image,SDL_mixer,libpng,physfs}
        #  ^ substitute SDL2 for SDL if desired
      git clone https://github.com/dxx-rebirth/dxx-rebirth.git
      cd dxx-rebirth
      scons
        # Or (for example) to build d1x only, with SDL 2, with lower process priority, on all cores:
      time nice scons -j$(nproc) sdl2=1 d1x=1

* A locally built executable will run anywhere if it's invoked from inside the appropriate mingw32 or mingw64 terminal. To run it instead directly in Windows, either:
    1. The linked mingw-w64 libraries will need to be added to PATH (See [contrib/msys2](contrib/msys2) for working example batch files); or
    2. Dependency DLLs from MSYS2 will need to be copied to the same directory as the executable.

#### Installing
For Windows and Linux, DXX-Rebirth installs only the main game binary.  The binary can be run from anywhere and can be installed by copying the game binary.  The game does not inspect the name of its binary.  You may rename the output after compilation without affecting the game.

As a convenience, if **register\_install\_target=True**, **SConstruct** registers a pseudo-target named **install** which copies the compiled files to *DESTDIR*__/__*BINDIR*.  By default, **register\_install\_target=True**, *DESTDIR* is *empty*, and *BINDIR* is *PREFIX*__/bin__, which expands to **/usr/local/bin**.

DXX-Rebirth [requires game data](https://www.dxx-rebirth.com/game-content/) to play.  The build system has no support for interacting with game data.  You can get [Descent 1 PC shareware data](https://www.dxx-rebirth.com/download/dxx/content/descent-pc-shareware.zip) and [Descent 2 PC demo data](https://www.dxx-rebirth.com/download/dxx/content/descent2-pc-demo.zip) from the DXX-Rebirth website.  Full game data is supported (and recommended), but is not freely available.  You can [buy full Descent 1 game data](https://www.gog.com/game/descent) and/or [buy full Descent 2 game data](https://www.gog.com/game/descent_2) from GOG.com.  Historically, both Descent 1 and Descent 2 were sold as a single unit.  After a nearly two-year hiatus from sale, the games returned to GOG.com in November 2017 as separate units.  DXX-Rebirth contains engines for both games.  Each engine works for its respective game without the data from the other, so players who wish to purchase only one game may do so.
