Add a proper README with build instructions and links to the available chats. To...
[xonotic/darkplaces.git] / README
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 ### Discord:
16 https://discord.gg/ZHT9QeW
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 ### Unix (General)
39
40 In the engine's root directory, run `make`. See `make help` for options.
41
42 ### Windows (Visual Studio)
43
44 Instructions coming soon.