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.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 Space: [#darkplaces:matrix.org](https://matrix.to/#/#darkplaces:matrix.org)
  17
  18 ## Build instructions (WIP)
  19
  20 You will need the following packages regardless of platform:
  21 * SDL2
  22 * libjpeg
  23 * libpng
  24 * libvorbis
  25 * libogg
  26
  27 ### Windows (MSYS2):
  28
  29 1. Install MSYS2, found [here](https://www.msys2.org/).
  30 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
  31
  32 ```
  33 pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
  34 ```
  35
  36 3. See [Unix instructions](#unix-(general)).
  37
  38 ### macOS
  39 1. Open a terminal and input `xcode-select --install`
  40 2. Install [Homebrew](https://brew.sh)
  41 3. In the same (or a different terminal), input the following command:
  42
  43 ```
  44 brew install sdl2 libjpeg-turbo libpng libvorbis curl
  45 ```
  46
  47 4. See [Unix instructions](#unix-(general)).
  48
  49 ### Unix (General)
  50
  51 From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
  52
  53 Input `make help` for options.
  54
  55 ### Windows (Visual Studio)
  56
  57 Instructions coming soon.
  58
  59 ## Documentation
  60
  61 Doxygen: https://xonotic.org/doxygen/darkplaces