3 DarkPlaces is a game engine based on the Quake 1 engine by id Software. It
4 improves and builds upon the original 1996 engine by adding modern rendering
5 features, and expanding upon the engine's native game code language QuakeC, as
6 well as supporting additional map and model formats.
8 Developed by LadyHavoc. See [CREDITS](CREDITS.md) for a list of contributors.
13 #darkplaces on irc.anynet.org
15 ### [Matrix](https://matrix.org/docs/guides/introduction)
16 [![#darkplaces:matrix.org](https://img.shields.io/matrix/darkplaces:matrix.org?color=660000&label=%23darkplaces%3Amatrix.org)](https://matrix.to/#/#darkplaces:matrix.org)
18 ## Build instructions (WIP)
20 These instructions are adequate for Quake, but for Xonotic please refer to [its wiki](https://gitlab.com/xonotic/xonotic/-/wikis/Compiling).
24 The minimum SDL version is 2.0.18 for Linux and 2.24.0 for Windows.
25 The following package names are for Debian, see below for Windows and Mac.
28 Build (mandatory): `build-essential` `libjpeg-dev` `libsdl2-dev`
29 Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`
31 ##### Dedicated Server
32 Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`
33 Runtime (optional): `libcurl` `libpng`
37 1. Install MSYS2, found [here](https://www.msys2.org/).
38 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
41 pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
44 3. See [Unix instructions](#unix-(general)).
47 1. Open a terminal and input `xcode-select --install`
48 2. Install [Homebrew](https://brew.sh)
49 3. In the same (or a different terminal), input the following command:
52 brew install sdl2 libjpeg-turbo libpng libvorbis curl
55 4. See [Unix instructions](#unix-(general)).
59 From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
61 Input `make help` for options.
63 If you get errors (that don't seem to be about missing dependencies) try `make clean` before compiling, especially if you updated your system since the last time you compiled.
66 ### Windows (Visual Studio)
68 May work but not recommended due to lack of support for C standards, and lack of maintenance.
73 [DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
77 Doxygen: https://xonotic.org/doxygen/darkplaces