features, and expanding upon the engine's native game code language QuakeC, as
well as supporting additional map and model formats.
-Developed by LadyHavoc. See CREDITS.md for a list of contributors.
+Developed by LadyHavoc. See [CREDITS](CREDITS.md) for a list of contributors.
## Help/support
-### IRC:
+### IRC
#darkplaces on irc.anynet.org
-### Discord:
-https://discord.gg/ZHT9QeW
+### [Matrix](https://matrix.org/docs/guides/introduction)
+[![#darkplaces:matrix.org](https://img.shields.io/matrix/darkplaces:matrix.org?color=660000&label=%23darkplaces%3Amatrix.org)](https://matrix.to/#/#darkplaces:matrix.org)
## Build instructions (WIP)
-You will need the following packages regardless of platform:
-* SDL2
-* libjpeg
-* libpng
-* libvorbis
-* libogg
+These instructions are adequate for Quake, but for Xonotic please refer to [its wiki](https://gitlab.com/xonotic/xonotic/-/wikis/Compiling).
+
+### Required packages
+
+The minimum SDL version is 2.0.18 for Linux and 2.24.0 for Windows.
+The following package names are for Debian, see below for Windows and Mac.
+
+##### Client
+Build (mandatory): `build-essential` `libjpeg-dev` `libsdl2-dev`
+Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`
+
+##### Dedicated Server
+Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`
+Runtime (optional): `libcurl` `libpng`
### Windows (MSYS2):
3. See [Unix instructions](#unix-(general)).
+### macOS
+1. Open a terminal and input `xcode-select --install`
+2. Install [Homebrew](https://brew.sh)
+3. In the same (or a different terminal), input the following command:
+
+```
+brew install sdl2 libjpeg-turbo libpng libvorbis curl
+```
+
+4. See [Unix instructions](#unix-(general)).
+
### Unix (General)
-In the engine's root directory, run `make`. See `make help` for options.
+From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
+
+Input `make help` for options.
+
+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.
+
### Windows (Visual Studio)
-Instructions coming soon.
+May work but not recommended due to lack of support for C standards, and lack of maintenance.
+Instructions TODO.
+
+## Contributing
+
+[DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
## Documentation
Doxygen: https://xonotic.org/doxygen/darkplaces
-