|
3 | 3 | Dæmon is the standalone game engine that powers the multiplayer first person shooter [Unvanquished](https://unvanquished.net). |
4 | 4 |
|
5 | 5 | [](https://github.com/DaemonEngine/Daemon/tags) |
6 | | -[](https://forums.unvanquished.net) |
| 6 | +[](https://unvanquished.net) |
7 | 7 | [](https://forums.unvanquished.net) |
8 | 8 | [](https://wiki.unvanquished.net/wiki/Daemon) |
9 | 9 | [](https://wiki.unvanquished.net/wiki/Chat#Rules) |
10 | 10 | [](https://unvanquished.net/chat/) |
11 | 11 | [](https://matrix.to/#/!WnuetRiQZJNBTKwMrF:matrix.org?via=matrix.org) |
12 | 12 | [](https://discord.gg/usuDT9Pyna) |
13 | 13 |
|
| 14 | +## Validation |
| 15 | + |
| 16 | +Target & compiler|Build status|Target & compiler|Build status |
| 17 | +-|-|-|- |
| 18 | +<sub>Linux amd64 GCC</sub>|[](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>Windows amd64 MSVC</sub>|[](https://ci.appveyor.com/project/DolceTriade/Daemon/history) |
| 19 | +<sub>Linux amd64 Clang</sub>|[](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>Windows amd64 MinGW</sub>|[](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster) |
| 20 | +<sub>macOS amd64 AppleClang</sub>|[](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>CodeQL C++ static analysis</sub>|[](https://github.com/DaemonEngine/Daemon/actions/workflows/codeql.yml?query=branch%3Amaster) |
| 21 | + |
| 22 | +## Onboarding |
| 23 | + |
14 | 24 | ℹ️ We provide ready-to-use downloads for the Unvanquished game on the [Unvanquished download page](https://unvanquished.net/download/), builds of the Dæmon engine are included. |
15 | 25 |
|
16 | 26 | ℹ️ The Unvanquished game logic source code can be found there: [github.com/Unvanquished/Unvanquished](https://github.com/Unvanquished/Unvanquished). |
17 | 27 |
|
| 28 | +💡️ Building this engine is enough to play the game and join servers once you [download the game's assets](https://github.com/Unvanquished/Unvanquished#downloading-the-games-assets). |
| 29 | + |
| 30 | +💡️ You need to build this repository if you want to contribute to the engine code (not the game logic). |
| 31 | + |
| 32 | +See below for [build](#building-the-engine-binaries) and [launch](#running-a-game) instructions. |
| 33 | + |
| 34 | +If you are interested in creating or using Unvanquished packages for package managers, see |
| 35 | +[wiki:Linux packages](https://wiki.unvanquished.net/wiki/Linux_packages). |
| 36 | + |
18 | 37 | ## Workspace requirements |
19 | 38 |
|
20 | 39 | To fetch and build Dæmon, you'll need: |
@@ -73,7 +92,7 @@ git submodule update --init --recursive |
73 | 92 |
|
74 | 93 | ℹ️ If cmake complains about missing files in `libs/crunch/` folder or similar issue then you have skipped this step. |
75 | 94 |
|
76 | | -## Build Instructions |
| 95 | +## Building the engine binaries |
77 | 96 |
|
78 | 97 | 💡️ Instead of `-j4` you can use `-jN` where `N` is your number of CPU cores to distribute compilation on them. Linux systems usually provide a handy `nproc` tool that tells the number of CPU core so you can just do `-j$(nproc)` to use all available cores. |
79 | 98 |
|
|
0 commit comments