README.md

   1 # DarkPlaces Engine
   2
   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.
   7
   8 Developed by LadyHavoc. See [CREDITS](CREDITS.md) for a list of contributors.
   9
  10 ## Help/support
  11
  12 ### IRC
  13 #darkplaces on irc.anynet.org
  14
  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)
  17
  18 ## Build instructions (WIP)
  19
  20 ### Required packages
  21
  22 The minimum SDL version is 2.0.18 for Linux and 2.24.0 for Windows.
  23 The following package names are for Debian, see below for Windows and Mac.
  24
  25 ##### Client
  26 Build (mandatory): `build-essential` `libjpeg-dev` `libsdl2-dev`
  27 Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`
  28
  29 ##### Dedicated Server
  30 Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`
  31 Runtime (optional): `libcurl` `libpng`
  32
  33 ### Windows (MSYS2):
  34
  35 1. Install MSYS2, found [here](https://www.msys2.org/).
  36 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
  37
  38 ```
  39 pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
  40 ```
  41
  42 3. See [Unix instructions](#unix-(general)).
  43
  44 ### macOS
  45 1. Open a terminal and input `xcode-select --install`
  46 2. Install [Homebrew](https://brew.sh)
  47 3. In the same (or a different terminal), input the following command:
  48
  49 ```
  50 brew install sdl2 libjpeg-turbo libpng libvorbis curl
  51 ```
  52
  53 4. See [Unix instructions](#unix-(general)).
  54
  55 ### Unix (General)
  56
  57 From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
  58
  59 Input `make help` for options.
  60
  61 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.
  62
  63
  64 ### Windows (Visual Studio)
  65
  66 Instructions TODO.
  67
  68 ## Contributing
  69
  70 [DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
  71
  72 ## Documentation
  73
  74 Doxygen: https://xonotic.org/doxygen/darkplaces