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 These names are for Debian, you may need to find equivalents for your platform.
  23
  24 ##### Client
  25 Build (mandatory): `build-essential` `libjpeg-dev` `libsdl2-dev`
  26 Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`
  27
  28 ##### Dedicated Server
  29 Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`
  30 Runtime (optional): `libcurl` `libpng`
  31
  32 ### Windows (MSYS2):
  33
  34 1. Install MSYS2, found [here](https://www.msys2.org/).
  35 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
  36
  37 ```
  38 pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
  39 ```
  40
  41 3. See [Unix instructions](#unix-(general)).
  42
  43 ### macOS
  44 1. Open a terminal and input `xcode-select --install`
  45 2. Install [Homebrew](https://brew.sh)
  46 3. In the same (or a different terminal), input the following command:
  47
  48 ```
  49 brew install sdl2 libjpeg-turbo libpng libvorbis curl
  50 ```
  51
  52 4. See [Unix instructions](#unix-(general)).
  53
  54 ### Unix (General)
  55
  56 From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
  57
  58 Input `make help` for options.
  59
  60 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.
  61
  62
  63 ### Windows (Visual Studio)
  64
  65 Instructions coming soon.
  66
  67 ## Contributing
  68
  69 [DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
  70
  71 ## Documentation
  72
  73 Doxygen: https://xonotic.org/doxygen/darkplaces