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 ## Build instructions (WIP)
  16
  17 You will need the following packages regardless of platform:
  18 * SDL2
  19 * libjpeg
  20 * libpng
  21 * libvorbis
  22 * libogg
  23
  24 ### Windows (MSYS2):
  25
  26 1. Install MSYS2, found [here](https://www.msys2.org/).
  27 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
  28
  29 ```
  30 pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
  31 ```
  32
  33 3. See [Unix instructions](#unix-(general)).
  34
  35 ### Unix (General)
  36
  37 In the engine's root directory, run `make`. See `make help` for options.
  38
  39 ### Windows (Visual Studio)
  40
  41 Instructions coming soon.
  42
  43 ## Documentation
  44
  45 Doxygen: https://xonotic.org/doxygen/darkplaces
  46