Unvanquished - User contributions [en-gb]

Native Client

2026-06-22T03:02:05Z

Illwieckz:

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualising the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

==About Native Client==

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

{{NativeClientIsDying}}

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet. The {{engine}} received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

==Rebuild effort==

The Unvanquished team is working on rebuilding the Native Client ecosystem to benefit from the updates implemented by Google over the years. Especially, this will enable newer C and C++ versions, thanks to the Saigo compiler being based on Clang 21.

The project for rebuilding the Native Client loader can be found there:

* https://github.com/DaemonEngine/native_client

The official releases for Unvanquished are already using a rebuilt NaCl loader on Linux for the {{code|amd64}} architecture.

The project for rebuilding the Saigo Native Client compiler can be found there:

* https://github.com/DaemonEngine/saigo-release-scripts

It's already possible to build Unvanquished with a Saigo compiler rebuilt this way.

==Interactive Debugging==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

==Postmortem Debugging==

See [[Breakpad]].

WebAssembly

2026-06-22T02:59:17Z

Illwieckz:

Template:NativeClientIsDying

2026-06-22T02:58:37Z

Illwieckz: init

{{note|Thanks to the [[Native Client#Rebuild effort|Rebuild effort]] for both the NaCl loader and the Saigo NaCl compiler, and the fact the Saigo compiler has been maintained by Google up to 2025, bringing Clang 21 and C++23, the NaCl technology may be relevant for another decade and this allows the Unvanquished team to focus resources on other things.

But [[Native Client]] will die one day, and we are slowly preparing the future, and [[WebAssembly]] is the best candidate for a Native Client successor.

It's possible that the actual NaCl death will not come from Google but from Apple when they will deprecate the Rosetta 2 translation layer. If that prevents to run the amd64 loader on Apple Silicon, then Native Client will be dead for macOS and would not be a viable multi-platform sandboxing solution anymore.}}

WebAssembly

2026-06-22T02:50:17Z

Illwieckz: Created page with "'''WebAssembly''' or '''Wasm''' is the best candidate for a future technology used for securely virtualising the game code in the {{engine}}. It may replace Native Client..."

'''WebAssembly''' or '''Wasm''' is the best candidate for a future technology used for securely virtualising the game code in the {{engine}}.

It may replace [[Native Client]] in the engine in the future.

Some work has been started some years ago but for now that effort is stalled.

Thanks to the rebuild effort for both the NaCl loader and the Saigo NaCl compiler, and the fact the Saigo compiler has been maintained by Google up to 2025, bringing Clang 21 and C++23, the NaCl technology may be relevant for another decade and this allows the Unvanquished team to focus resources on other things.

But Native Client will die one day, and we are slowly preparing the future, and WebAssembly is the best candidate for such future.

Native Client

2026-06-22T02:46:45Z

Illwieckz: wording

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualising the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet. The {{engine}} received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

== Rebuilding effort ==

The Unvanquished team is working on rebuilding the Native Client ecosystem to benefit from the updates implemented by Google over the years. Especially, this will enable newer C and C++ versions, thanks to the Saigo compiler being based on Clang 21.

The project for rebuilding the Native Client loader can be found there:

* https://github.com/DaemonEngine/native_client

The official releases for Unvanquished are already using a rebuilt NaCl loader on Linux for the {{code|amd64}} architecture.

The project for rebuilding the Saigo Native Client compiler can be found there:

* https://github.com/DaemonEngine/saigo-release-scripts

It's already possible to build Unvanquished with a Saigo compiler rebuilt this way.

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Native Client

2026-06-22T02:45:33Z

Illwieckz: typo

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualising the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet. The {{engine}} received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

== Rebuilding effort ==

The Unvanquished team is working on rebuilding the Native Client ecosystem to benefit from the updates implemented by Google over the years. Especially, this will enable newer C and C++ versions, thanks to the Saigo compiler being based on Clang 21.

The project for rebuilding the Native Client loader can be found there:

* https://github.com/DaemonEngine/native_client

The official releases for Unvanquished are already using a rebuilt NaCl loader on Linux for the {{code|amd64}} architecture.

The project for rebuilding the Saigo Native Client compilers can be found there:

* https://github.com/DaemonEngine/saigo-release-scripts

It's already possible to build Unvanquished with a Saigo compiler rebuilt this way.

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Native Client

2026-06-22T02:42:54Z

Illwieckz: Notes on the rebuilding effort

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualizing the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet. The {{engine}} received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

== Rebuilding effort ==

The Unvanquished team is working on rebuilding the Native Client ecosystem to benefit from the updates implemented by Google over the years. Especially, this will enable newer C and C++ versions, thanks to the Saigo compiler being based on Clang 21.

The project for rebuilding the Native Client loader can be found there:

* https://github.com/DaemonEngine/native_client

The official releases for Unvanquished are already using a rebuilt NaCl loader on Linux for the {{code|amd64}} architecture.

The project for rebuilding the Saigo Native Client compilers can be found there:

* https://github.com/DaemonEngine/saigo-release-scripts

It's already possible to build Unvanquished with a Saigo compiler rebuilt this way.

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Native Client

2026-06-22T02:38:04Z

Illwieckz: formatting

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualizing the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet. The {{engine}} received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

The workspace for our attempt to rebuild and repackage Saigo is there:

* https://github.com/DaemonEngine/DaemonSaigoNativeClientToolkit

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Native Client

2026-06-22T02:37:27Z

Illwieckz: fix markup

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualizing the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{code|amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet.

The Dæmon engine received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

The workspace for our attempt to rebuild and repackage Saigo is there:

* https://github.com/DaemonEngine/DaemonSaigoNativeClientToolkit

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Native Client

2026-06-22T02:36:57Z

Illwieckz: box64 mention

'''Native Client''' or '''NaCl''' is the current technology used for securely virtualizing the game code in the {{engine}}.

It replaced the Q3VM (Quake3 Virtual Machine) in the engine.

Unlike Q3VM for which the {{code|.qvm}} binaries were limited to be produced with the old C supported by the proprietary LCC compiler, the {{code|.nexe}} NaCl binaries can be compiled with Clang-based open source compilers supporting modern-enough C++ versions and allowing to reuse off-the-shelf C++ libraries that may even be shared between the engine and the game source code.

Unlike QVMs, NaCl gamelogic runs in a secure sandbox. Native Client lets you run mods downloaded from the internet without giving them free reign on your computer. QVM was equivalent to running a DLL with no protection.

The Native Client documentation can be found on [https://chrome.jscn.org/docs/native-client/welcome-to-native-client/ chrome.jscn.org/docs/native-client/welcome-to-native-client/].

==Platforms==

{| style="margin:auto"
|+ Platform NaCl compatibility
|-
! colspan="4" | Linux !! colspan="2" | Windows !! colspan="2" | macOS !! FreeBSD
|-
! amd64 || i686 || arm64 || armhf || amd64 || i686 || amd64 || arm64 || amd64
|-
| ✅️ native || ✅️ native || ☑️ through armhf compatibility || ✅️ native || ✅️ native || ✅️ native || ✅️ native || ☑️ through amd64 compatibility || ☑️ through Linux compatibility
|}

It has been verified that Linux on {{code|ppc64el}} and {{code|riscv64}} can run the {{amd64}} loader on [https://box86.org box64], though on {{code|riscv64}}. The '''box64''' translation layer can also run on {{code|loong64}} but this has not been tested yet.

The Dæmon engine received patches to run box64, but the users have to build the engine themselves and provide box64.

The NaCl loader (the virtual machine running the virtualised code) is available for three systems: Linux, Windows and macOS. The supported architectures differs per system:

* Linux: amd64, i686, armhf;
* Windows: amd64, i686;
* macOS: amd64.

It is possible to run native engines with other platforms when there is a compatibility layer to run the NaCl loader:

* Linux, arm64: running the armhf NaCl loader through built-in Linux 32-bit compatibility;
* macOS, arm64: running the amd64 NaCl loader through Rosetta2 compatibility;
* FreeBSD, amd64: running the Linux NaCl loader through built-in Linuxulator compatibility.

The Linux armhf NaCl loader requires a 4k PageSize kernel:

* https://github.com/Unvanquished/Unvanquished/issues/3286

The Linux i686 and armhf NaCl loaders may run on FreeBSD using Linuxulator but it is not tested.

NaCl also supports 32-bit MIPS on Linux but this architecture is not supported by the {{engine}} and the {{game}} project.

NaCl upstream development has slowed down since the competing solution [[WebAssembly]] became the industry standard, so it is very unlikely support for new systems and architecture would be added. To overcome this problem, we would have to switch to WebAssembly (that unfortunately may only support using a slow interpreter for some platforms NaCl supports, like i686 or armhf), but more importantly may still lack support for exceptions or {{code|setjmp/longjmp}} and then not be complete enough for our needs yet.

==Compilers==

===PNaCl Clang===

PNaCl Clang is the current NaCl compiler we use to build the nexe game binaries. It is based on an old Clang 3.6 and does not support C++ above C++14. To overcome some of the related limitations we may switch to Saigo.

The PNaCl compilation workflow is to build a single {{code|.pexe}} then to translate them to per-architecture {{code|.nexe}} (amd64, i686, armhf) using a specific translator tool.

The PNaCl SDK consists on Python-based wrappers around Clang internals. It was initially using now-obsolete and hard-to-find Python2 but we ported it to Python3 to extend its lifespan.

The provided PNaCl SDK runs on Linux, Windows and macOS systems, on amd64 architectures.

While the {{code|.pexe}} compiler itself runs on FreeBSD with the Linuxulator, the translator does not, meaning it's not possible to build {{code|.nexe}} binaries on FreeBSD.

PNaCl supports C++ exception. There exist newer PNaCl SDKs (from chromium canary releases) that do not support exceptions and may not provide more what we already have with latest stable PNaCl.

===Saigo===

Saigo is a new NaCl compiler based on latest Clang and supporting latest C++ standards. It compiles directly to {{code|.nexe}}.

The Unvanquished game code is now buildable with Saigo.

Saigo may not support C++ exceptions as far as we know but supports {{code|setjmp/longjmp}}.

Unlike PNaCl, Saigo do not provide released binaries, meaning a switch to Saigo requires a convenient way to provide it to contributors. Google provides some nightly Linux amd64 Saigo toolchain snapshots that aren't easy to get without some Google scripts. The Saigo compiler itself isn't hard to build (same as Clang itself), the binutils are a bit more ticky but not that hard (10 years-old configure build). What is tricky to rebuild is the libc that requires some very old NaCl GCC. Fortunately there exists libc and libc++ snapshots provided by Google that can be reused with a self-built toolchain.

The Saigo compiler and NaCl binutils should build everywhere their upstream build, but they will always target the usual platforms as the NaCl loader is still the same: a more recent NaCl loader is also buildable but doesn't bring any new platform support.

Moving to Saigo is considered as a migration step that can be achievable before migrating to [[WebAssembly]], as it allows us to migrate to a new C++ standard and update libraries we use without waiting for the migration to WebAssembly.

Some redesign of our CMake configuration for Saigo may help later when migrating to WebAssembly as it makes it more generic for different VM toolchains.

Here is a GitHub issue about the ongoing efforts for migrating to Saigo:

* https://github.com/Unvanquished/Unvanquished/issues/3197

The workspace for our attempt to rebuild and repackage Saigo is there:

* https://github.com/DaemonEngine/DaemonSaigoNativeClientToolkit

== Interactive Debugging ==

Most of the time it is easiest to debug with a native DLL. But if you have a problem that cannot be reproduced outside of NaCl, you may be forced to resort to the following tutorial.

These steps for attaching the NaCl debugger<ref>https://web.archive.org/web/20250909075554/https://www.chromium.org/nativeclient/how-tos/debugging-documentation/debugging-with-debug-stub-recommended/getting-started-with-debug-stub/</ref> have been tested on Windows with a PNaCl toolchain. They should also work on binaries built with Saigo, using the old PNaCl GDB. On Linux or Mac you may experience more difficulties due to the lack of support for old binaries (meaning nacl-gdb). illwieckz reports that on amd64 Linux in 2025, using the old GDB which is a 32-bit binary, debugging an amd64 nexe does not work (despite the documentation's claims of debugger platform independence), but debugging an i686 nexe does.

# Build the NaCl gamelogic with debugging symbols (build type Debug or RelWithDebInfo).
# Launch Daemon configured for NaCl debugging. For example, <code>./daemonded -set vm.sgame.type 1 -set vm.sgame.debug 1 +map chasm</code> When the relevant gamelogic starts, the engine should pause and emit the message <code>Waiting for GDB connection on localhost:4014</code>.
# Start NaCl GDB, e.g. <code>daemon\external_deps\windows-amd64-mingw_10\nacl-gdb.exe</code> This works better out of a command prompt rather than an MSYS window.
# Use the "file" command to tell the debugger where the binary with symbols is. For example, <code>file sgame-amd64.nexe</code>
# OPTIONAL, probably a waste of time: load the IRT (Integrated Runtime) symbols: <code>nacl-irt irt_core-amd64.nexe</code>
# Connect to the NaCl program with the command <code>target remote :4014</code>
# You should see a message like <code>0x000000000ffc00a0 in ?? ()</code> (or <code>0x000000000ffc00a0 in __pnacl_start ()</code> if you did step 5). This means the program is paused at the beginning.
# Set some breakpoints, e.g. <code>b G_RunFrame</code>. Alternatively, just wait for the debugger to break when the game crashes.
# Start the program by continuing (<code>c</code>).

== Postmortem Debugging ==

See [[Breakpad]].

Daemon based games

2026-06-02T11:47:37Z

Illwieckz: /* KingpinQ3 */

'''[[Engine|Dæmon]]''' is the game engine powering Unvanquished. The {{engine}} is a fork of the '''XreaL engine''' through the '''ET:XreaL''' variant which derivates from both '''Quake 3 engine''' and '''Wolfenstein: Enemy Territory engine'''.

While it is technically possible to use DaemonEngine to write or maintain a different game, based or not on Unvanquished, it is recommended to the candidate to read (and think over) how the [[Compatibility]] in engine and libengine API/ABI is kept.

* {{engine|link=no}} repository: https://github.com/DaemonEngine/Daemon

{{NoteOpenWolf}}

== Released games ==

=== Unvanquished ===

'''Type:''' port. 
'''Status:''' active, released (beta builds).

'''[[Game|Unvanquished]]''' is the game maintaining the {{engine}}, first release happened on February 29, 2012 and is still releasing new versions 10 years later. Unvanquished derivates from the Tremulous game that was initially released as a standalone game on an engine derivated from ioquake3 in 2006, after having been a Quake 3 total conversion mod for some time.

* Website: https://unvanquished.net
* Game code repositories: https://github.com/Unvanquished
* Game data repositories: https://github.com/UnvanquishedAssets

== Unreleased projects ==

=== FreeFort ===

'''Type:''' remake. 
'''Status:''' stalled.

* Website: https://freefortgame.net
* Repositories: https://git.freefortgame.net/FreeFort

'''FreeFort''' is the most recent attempt to make a game based on the {{engine}} and the Unvanquished game code. The project is to remake a Team Fortress 2-like game as a fully free and libre open source game. The project is in it's very early state and nothing is released yet.

The project is currently stopped.

=== Unnamed project ===

'''Type:''' new game. 
'''Status:''' unknown.

There is also another project whose name wan't known to make a new game from scratch based on the {{engine}} (without reusing the Unvanquished game code) which is more about being an infantry war game. Few information had been know about it. While doing this effort, [[Special:Contributions/The_White_Lion|The White Lion]] produced a lot of very useful documentation in the [[Technical Documentation]] page, especially the ''Program Ignition and Initialization'' part and many other parts like ''Source Code Filesystem Tree Structure'' or ''System Architecture''.

The project is probably inactive and very few information has been known about it.

=== UnrealArena ===

'''Type:''' new game. 
'''Status:''' stalled, unreleased (as a playable game).

* Website: http://www.unrealarena.net
* Repositories: https://github.com/unrealarena

{{Note|content=The project demonstrated the ability to follow the {{engine}} upstream and Unvanquished upstream as a basis for a game, merging improvements from upstream while the project lived its own life from writing source, creating levels and producing binaries.}}

The project is currently stalled if the project managed to produce multiple build, there is nothing playable.

'''Unreal Arena''' is a brand new game project (not a port) based on Dæmon and Unvanquished code. The purpose is to provide the user two different teams, one using Quake III Arena movements and weapons, another one using Unreal Tournament movements and weapons, and let people frag together.

The project managed to recreate a Quake 3 map (untextured) from scratch and publish some alpha build just making possible for a tester to load a map, join and navigate.

=== Smokin' Guns ===

'''Type:''' port. 
'''Status:''' dormant, unreleased (on {{engine}}).

* Website: https://www.smokin-guns.org
* Repositories: https://github.com/smokin-guns

{{Note|content=The project demonstrated the ability to improve the {{engine}} by testing assets from more than one game, debugging and implementing fixes. It also helped to design some good practices in the way game assets can be built, as tools like [[Tools/Urcheon|Urcheon]] are thoughts to be reusable for more projects.}}

The project is currently dormant as most people involved are very busy on other projects and other things in their life. Players should use the ioquake3-based game for now.

This is a project to port the '''Smokin' Guns game''' to the {{engine|link=no}}. The Smokin' Guns game already exist as a released standalone game running on ioquake3 engine, it derivates from the Western Quake 3 total conversion mod.

The project is to use the upstream {{engine|link=no}} (or to upstream the changes) and to rebase the specific Smokin' Guns game mechanics on the Unvanquished game to be able to merge improvements from Unvanquished as time passes.

Some fixes for Smokin' Guns assets were upstreamed to the {{engine|link=no}}, and a some testing assets were produced to load Smokin' Guns maps with the Unvanquished game and the {{engine|link=no}} for testing purpose and to fix related issues.

A video demonstrating the Smokin' Guns game code running on Dæmon engine has been shown by slipher in 2026:

* https://forums.unvanquished.net/viewtopic.php?t=2618

=== Xonotic ===

'''Type:''' port. 
'''Status:''' stalled, unreleased (on {{engine}}).

* Website: https://xonotic.org
* Repositories: https://gitlab.com/xonotic
* Repository for the Q1VM glue: https://gitlab.com/xonotic/daemon-glue/

{{Note|content=The project demonstrated the ability to have multiple teams from different games working on the same game engine and contributing heavily to its development, to stimulate cross-projects contribution, to make Free Software development community a better place with projects living together and helping each others, and to make the {{engine}} better.}}

The project is currently stalled as all people involved in those various attempts became busy with other things in their life. Players should use the DarkPlaces-based game for now.

There was multiple attempts to port the '''Xonotic game''' on the {{engine}}. Historically, Xonotic is running on the DarkPlaces engine. Xonotic as a released standalone game running on the DarkPlaces engine exists since September 8 2011 and is a fork (and continuation) of the defunct Nexuiz game initially released on May 31, 2005.

The Darkplaces engine development was stalled and it was considered difficult to improve it for non-technical reasons because the DarkPlaces engine tries to keep compatibility with original Quake game and some improvements wanted for the need of Xonotic may break compatibility.

On the other hand the {{engine}} can break things for the best (like fixing design issues) and was seen as a live project. Multiple people from Team Xonotic expressed the will to port their game on the {{engine|link=no}}.

The project was to port the Xonotic game code on the {{engine|link=no}} (not rebasing on Unvanquished game code).

Such effort is not a an easy task because the {{engine|link=no}} is an engine derivating from Quake 3 engine while DarkPlaces engine derivates from Quake (the first) engine. Anyway, DarkPlaces already supports Quake 3 bsp files (map format) and most of Quake 3 shaders (material format) which are the ones natively supported by the {{engine|link=no}}, and Xonotic already uses those Quake 3 formats.

The difficulty is that the Xonotic game code is written in QuakeC and is expected to run on a Q1VM, while Dæmon executes native code (currently sandboxed in NativeClient) compiled from generic languages like C or C++. There was multiple attempts to achieve the port, some people worked on source transpilers to convert the QuakeC code base to less exotic languages like C++ or Rust, others worked on writing a Q1VM expected to run on the Dæmon virtual machine.

There was interesting progresses achieved by those various attempts, the team managed to produce a minimalistic Q1VM running some minimal QuakeC code base allowing to start the {{engine|link=no}}, load a map and walk around.

Xonotic developers helped to split the {{engine|link=no}} and the Unvanquished game, developped some code to make the engine more standalone.

Lots of features were implemented in the Dæmon renderer using Xonotic data files (maps, materials, textures…), for example the relief mapping feature was debugged and fixed using Xonotic maps and materials, or the ability to support both lose normal maps and normal maps embedded in height maps was implemented. Also a lot of rewrite was done to make the {{engine|link=no}} better and even helped Dæmon team to better understand some things to make the engine better, for example the multitextured material blending feature is a direct consequences from that, or the ability to support multiple formats of normal maps.

The {{engine}} now provides some cvars to enable compatibility code to better support medias purposed for the DarkPlaces engine.

This project also helped the Dæmon game engine to support both the newer DPK format and the legacy PK3 format at the same time, because Xonotic through Nexuiz has more than 15 years of history and there are thousands of maps out there so porting maps was not really an option.

Xonotic data files (maps, materials, textures…) are still used today as test bed for the {{engine|link=no}} to test for regressions and to implement new features: Xonotic assets makes use of more rendering features than Unvanquished! For example the Xonotic assets may be used to test the sRGB lightmap technology we still need to implement.

The Xonotic and Unvanquished teams became very close, and multiple Xonotic contributors also became Dæmon and/or Unvanquished contributors (TimePath, Mario, Melanosuchus, EACFreddy…), making the engine better, implementing features, etc. Some Unvanquished contibutors also started to help Xonotic as we still have common interests. For example Unvanquished contributors help Team Xonotic to maintain the [[Tools/NetRadiant|NetRadiant]] level editor which is also the recommended level editor for Unvanquished.

== Special mentions ==

Those are not Dæmon-based but very close.

=== KingpinQ3 ===

'''Type:''' remake (on a custom XreaL port). 
'''Status:''' active, released (beta builds).

This project is ''not'' running on the {{engine|link=no}} but on another fork of '''XreaL''' (like Dæmon), so technically both engines are very close and we share common interests. For example hypov8 from KingpinQ3 converted our new lasgun first person model to a usable third person model in Unvanquished!

'''KingpinQ3''' is a remake of Xatrix Entertainment's '''Kingpin - Life of Crime game''' on an engine derivated from Quake 3 through the '''XreaL''' lineage like us!

* Website: https://www.kingpinq3.com
* Downloads: https://www.kingpin.info/download/index.php?dir=kpq3/

Daemon based games

2026-06-02T11:45:50Z

Illwieckz: /* Special mentions (not Dæmon-based but very close) */

Daemon based games

2026-06-02T11:44:46Z

Illwieckz: /* Smokin' Guns */

'''[[Engine|Dæmon]]''' is the game engine powering Unvanquished. The {{engine}} is a fork of the '''XreaL engine''' through the '''ET:XreaL''' variant which derivates from both '''Quake 3 engine''' and '''Wolfenstein: Enemy Territory engine'''.

While it is technically possible to use DaemonEngine to write or maintain a different game, based or not on Unvanquished, it is recommended to the candidate to read (and think over) how the [[Compatibility]] in engine and libengine API/ABI is kept.

* {{engine|link=no}} repository: https://github.com/DaemonEngine/Daemon

{{NoteOpenWolf}}

== Released games ==

=== Unvanquished ===

'''Type:''' port. 
'''Status:''' active, released (beta builds).

'''[[Game|Unvanquished]]''' is the game maintaining the {{engine}}, first release happened on February 29, 2012 and is still releasing new versions 10 years later. Unvanquished derivates from the Tremulous game that was initially released as a standalone game on an engine derivated from ioquake3 in 2006, after having been a Quake 3 total conversion mod for some time.

* Website: https://unvanquished.net
* Game code repositories: https://github.com/Unvanquished
* Game data repositories: https://github.com/UnvanquishedAssets

== Unreleased projects ==

=== FreeFort ===

'''Type:''' remake. 
'''Status:''' stalled.

* Website: https://freefortgame.net
* Repositories: https://git.freefortgame.net/FreeFort

'''FreeFort''' is the most recent attempt to make a game based on the {{engine}} and the Unvanquished game code. The project is to remake a Team Fortress 2-like game as a fully free and libre open source game. The project is in it's very early state and nothing is released yet.

The project is currently stopped.

=== Unnamed project ===

'''Type:''' new game. 
'''Status:''' unknown.

There is also another project whose name wan't known to make a new game from scratch based on the {{engine}} (without reusing the Unvanquished game code) which is more about being an infantry war game. Few information had been know about it. While doing this effort, [[Special:Contributions/The_White_Lion|The White Lion]] produced a lot of very useful documentation in the [[Technical Documentation]] page, especially the ''Program Ignition and Initialization'' part and many other parts like ''Source Code Filesystem Tree Structure'' or ''System Architecture''.

The project is probably inactive and very few information has been known about it.

=== UnrealArena ===

'''Type:''' new game. 
'''Status:''' stalled, unreleased (as a playable game).

* Website: http://www.unrealarena.net
* Repositories: https://github.com/unrealarena

{{Note|content=The project demonstrated the ability to follow the {{engine}} upstream and Unvanquished upstream as a basis for a game, merging improvements from upstream while the project lived its own life from writing source, creating levels and producing binaries.}}

The project is currently stalled if the project managed to produce multiple build, there is nothing playable.

'''Unreal Arena''' is a brand new game project (not a port) based on Dæmon and Unvanquished code. The purpose is to provide the user two different teams, one using Quake III Arena movements and weapons, another one using Unreal Tournament movements and weapons, and let people frag together.

The project managed to recreate a Quake 3 map (untextured) from scratch and publish some alpha build just making possible for a tester to load a map, join and navigate.

=== Smokin' Guns ===

'''Type:''' port. 
'''Status:''' dormant, unreleased (on {{engine}}).

* Website: https://www.smokin-guns.org
* Repositories: https://github.com/smokin-guns

{{Note|content=The project demonstrated the ability to improve the {{engine}} by testing assets from more than one game, debugging and implementing fixes. It also helped to design some good practices in the way game assets can be built, as tools like [[Tools/Urcheon|Urcheon]] are thoughts to be reusable for more projects.}}

The project is currently dormant as most people involved are very busy on other projects and other things in their life. Players should use the ioquake3-based game for now.

This is a project to port the '''Smokin' Guns game''' to the {{engine|link=no}}. The Smokin' Guns game already exist as a released standalone game running on ioquake3 engine, it derivates from the Western Quake 3 total conversion mod.

The project is to use the upstream {{engine|link=no}} (or to upstream the changes) and to rebase the specific Smokin' Guns game mechanics on the Unvanquished game to be able to merge improvements from Unvanquished as time passes.

Some fixes for Smokin' Guns assets were upstreamed to the {{engine|link=no}}, and a some testing assets were produced to load Smokin' Guns maps with the Unvanquished game and the {{engine|link=no}} for testing purpose and to fix related issues.

A video demonstrating the Smokin' Guns game code running on Dæmon engine has been shown by slipher in 2026:

* https://forums.unvanquished.net/viewtopic.php?t=2618

=== Xonotic ===

'''Type:''' port. 
'''Status:''' stalled, unreleased (on {{engine}}).

* Website: https://xonotic.org
* Repositories: https://gitlab.com/xonotic
* Repository for the Q1VM glue: https://gitlab.com/xonotic/daemon-glue/

{{Note|content=The project demonstrated the ability to have multiple teams from different games working on the same game engine and contributing heavily to its development, to stimulate cross-projects contribution, to make Free Software development community a better place with projects living together and helping each others, and to make the {{engine}} better.}}

The project is currently stalled as all people involved in those various attempts became busy with other things in their life. Players should use the DarkPlaces-based game for now.

There was multiple attempts to port the '''Xonotic game''' on the {{engine}}. Historically, Xonotic is running on the DarkPlaces engine. Xonotic as a released standalone game running on the DarkPlaces engine exists since September 8 2011 and is a fork (and continuation) of the defunct Nexuiz game initially released on May 31, 2005.

The Darkplaces engine development was stalled and it was considered difficult to improve it for non-technical reasons because the DarkPlaces engine tries to keep compatibility with original Quake game and some improvements wanted for the need of Xonotic may break compatibility.

On the other hand the {{engine}} can break things for the best (like fixing design issues) and was seen as a live project. Multiple people from Team Xonotic expressed the will to port their game on the {{engine|link=no}}.

The project was to port the Xonotic game code on the {{engine|link=no}} (not rebasing on Unvanquished game code).

Such effort is not a an easy task because the {{engine|link=no}} is an engine derivating from Quake 3 engine while DarkPlaces engine derivates from Quake (the first) engine. Anyway, DarkPlaces already supports Quake 3 bsp files (map format) and most of Quake 3 shaders (material format) which are the ones natively supported by the {{engine|link=no}}, and Xonotic already uses those Quake 3 formats.

The difficulty is that the Xonotic game code is written in QuakeC and is expected to run on a Q1VM, while Dæmon executes native code (currently sandboxed in NativeClient) compiled from generic languages like C or C++. There was multiple attempts to achieve the port, some people worked on source transpilers to convert the QuakeC code base to less exotic languages like C++ or Rust, others worked on writing a Q1VM expected to run on the Dæmon virtual machine.

There was interesting progresses achieved by those various attempts, the team managed to produce a minimalistic Q1VM running some minimal QuakeC code base allowing to start the {{engine|link=no}}, load a map and walk around.

Xonotic developers helped to split the {{engine|link=no}} and the Unvanquished game, developped some code to make the engine more standalone.

Lots of features were implemented in the Dæmon renderer using Xonotic data files (maps, materials, textures…), for example the relief mapping feature was debugged and fixed using Xonotic maps and materials, or the ability to support both lose normal maps and normal maps embedded in height maps was implemented. Also a lot of rewrite was done to make the {{engine|link=no}} better and even helped Dæmon team to better understand some things to make the engine better, for example the multitextured material blending feature is a direct consequences from that, or the ability to support multiple formats of normal maps.

The {{engine}} now provides some cvars to enable compatibility code to better support medias purposed for the DarkPlaces engine.

This project also helped the Dæmon game engine to support both the newer DPK format and the legacy PK3 format at the same time, because Xonotic through Nexuiz has more than 15 years of history and there are thousands of maps out there so porting maps was not really an option.

Xonotic data files (maps, materials, textures…) are still used today as test bed for the {{engine|link=no}} to test for regressions and to implement new features: Xonotic assets makes use of more rendering features than Unvanquished! For example the Xonotic assets may be used to test the sRGB lightmap technology we still need to implement.

The Xonotic and Unvanquished teams became very close, and multiple Xonotic contributors also became Dæmon and/or Unvanquished contributors (TimePath, Mario, Melanosuchus, EACFreddy…), making the engine better, implementing features, etc. Some Unvanquished contibutors also started to help Xonotic as we still have common interests. For example Unvanquished contributors help Team Xonotic to maintain the [[Tools/NetRadiant|NetRadiant]] level editor which is also the recommended level editor for Unvanquished.

== Special mentions (not Dæmon-based but very close) ==

=== KingpinQ3 ===

'''Type:''' remake (on a custom XreaL port). 
'''Status:''' active, released (beta builds).

This project is ''not'' running on the {{engine|link=no}} but on another fork of '''XreaL''' (like Dæmon), so technically both engines are very close and we share common interests. For example hypov8 from KingpinQ3 converted our new lasgun first person model to a usable third person model in Unvanquished!

'''KingpinQ3''' is a remake of Xatrix Entertainment's '''Kingpin - Life of Crime game''' on an engine derivated from Quake 3 through the '''XreaL''' lineage like us!

* Website: https://www.kingpinq3.com
* Downloads: https://www.kingpin.info/download/index.php?dir=other/standalonegames/KingpinQ3/

Daemon based games

2026-06-02T11:42:55Z

Illwieckz: /* Unnamed project */

'''[[Engine|Dæmon]]''' is the game engine powering Unvanquished. The {{engine}} is a fork of the '''XreaL engine''' through the '''ET:XreaL''' variant which derivates from both '''Quake 3 engine''' and '''Wolfenstein: Enemy Territory engine'''.

While it is technically possible to use DaemonEngine to write or maintain a different game, based or not on Unvanquished, it is recommended to the candidate to read (and think over) how the [[Compatibility]] in engine and libengine API/ABI is kept.

* {{engine|link=no}} repository: https://github.com/DaemonEngine/Daemon

{{NoteOpenWolf}}

== Released games ==

=== Unvanquished ===

'''Type:''' port. 
'''Status:''' active, released (beta builds).

'''[[Game|Unvanquished]]''' is the game maintaining the {{engine}}, first release happened on February 29, 2012 and is still releasing new versions 10 years later. Unvanquished derivates from the Tremulous game that was initially released as a standalone game on an engine derivated from ioquake3 in 2006, after having been a Quake 3 total conversion mod for some time.

* Website: https://unvanquished.net
* Game code repositories: https://github.com/Unvanquished
* Game data repositories: https://github.com/UnvanquishedAssets

== Unreleased projects ==

=== FreeFort ===

'''Type:''' remake. 
'''Status:''' stalled.

* Website: https://freefortgame.net
* Repositories: https://git.freefortgame.net/FreeFort

'''FreeFort''' is the most recent attempt to make a game based on the {{engine}} and the Unvanquished game code. The project is to remake a Team Fortress 2-like game as a fully free and libre open source game. The project is in it's very early state and nothing is released yet.

The project is currently stopped.

=== Unnamed project ===

'''Type:''' new game. 
'''Status:''' unknown.

There is also another project whose name wan't known to make a new game from scratch based on the {{engine}} (without reusing the Unvanquished game code) which is more about being an infantry war game. Few information had been know about it. While doing this effort, [[Special:Contributions/The_White_Lion|The White Lion]] produced a lot of very useful documentation in the [[Technical Documentation]] page, especially the ''Program Ignition and Initialization'' part and many other parts like ''Source Code Filesystem Tree Structure'' or ''System Architecture''.

The project is probably inactive and very few information has been known about it.

=== UnrealArena ===

'''Type:''' new game. 
'''Status:''' stalled, unreleased (as a playable game).

* Website: http://www.unrealarena.net
* Repositories: https://github.com/unrealarena

{{Note|content=The project demonstrated the ability to follow the {{engine}} upstream and Unvanquished upstream as a basis for a game, merging improvements from upstream while the project lived its own life from writing source, creating levels and producing binaries.}}

The project is currently stalled if the project managed to produce multiple build, there is nothing playable.

'''Unreal Arena''' is a brand new game project (not a port) based on Dæmon and Unvanquished code. The purpose is to provide the user two different teams, one using Quake III Arena movements and weapons, another one using Unreal Tournament movements and weapons, and let people frag together.

The project managed to recreate a Quake 3 map (untextured) from scratch and publish some alpha build just making possible for a tester to load a map, join and navigate.

=== Smokin' Guns ===

'''Type:''' port. 
'''Status:''' dormant, unreleased (on {{engine}}).

* Website: https://www.smokin-guns.org
* Repositories: https://github.com/smokin-guns

{{Note|content=The project demonstrated the ability to improve the {{engine}} by testing assets from more than one game, debugging and implementing fixes. It also helped to design some good practices in the way game assets can be built, as tools like [[Tools/Urcheon|Urcheon]] are thoughts to be reusable for more projects.}}

The project is currently dormant as most people involved are very busy on other projects and other things in their life. Players should use the ioquake3-based game for now.

This is a project to port the '''Smokin' Guns game''' to the {{engine|link=no}}. The Smokin' Guns game already exist as a released standalone game running on ioquake3 engine, it derivates from the Western Quake 3 total conversion mod.

The project is to use the upstream {{engine|link=no}} (or to upstream the changes) and to rebase the specific Smokin' Guns game mechanics on the Unvanquished game to be able to merge improvements from Unvanquished as time passes.

Some fixes for Smokin' Guns assets were upstreamed to the {{engine|link=no}}, and a some testing assets were produced to load Smokin' Guns maps with the Unvanquished game and the {{engine|link=no}} for testing purpose and to fix related issues.

=== Xonotic ===

'''Type:''' port. 
'''Status:''' stalled, unreleased (on {{engine}}).

* Website: https://xonotic.org
* Repositories: https://gitlab.com/xonotic
* Repository for the Q1VM glue: https://gitlab.com/xonotic/daemon-glue/

{{Note|content=The project demonstrated the ability to have multiple teams from different games working on the same game engine and contributing heavily to its development, to stimulate cross-projects contribution, to make Free Software development community a better place with projects living together and helping each others, and to make the {{engine}} better.}}

The project is currently stalled as all people involved in those various attempts became busy with other things in their life. Players should use the DarkPlaces-based game for now.

There was multiple attempts to port the '''Xonotic game''' on the {{engine}}. Historically, Xonotic is running on the DarkPlaces engine. Xonotic as a released standalone game running on the DarkPlaces engine exists since September 8 2011 and is a fork (and continuation) of the defunct Nexuiz game initially released on May 31, 2005.

The Darkplaces engine development was stalled and it was considered difficult to improve it for non-technical reasons because the DarkPlaces engine tries to keep compatibility with original Quake game and some improvements wanted for the need of Xonotic may break compatibility.

On the other hand the {{engine}} can break things for the best (like fixing design issues) and was seen as a live project. Multiple people from Team Xonotic expressed the will to port their game on the {{engine|link=no}}.

The project was to port the Xonotic game code on the {{engine|link=no}} (not rebasing on Unvanquished game code).

Such effort is not a an easy task because the {{engine|link=no}} is an engine derivating from Quake 3 engine while DarkPlaces engine derivates from Quake (the first) engine. Anyway, DarkPlaces already supports Quake 3 bsp files (map format) and most of Quake 3 shaders (material format) which are the ones natively supported by the {{engine|link=no}}, and Xonotic already uses those Quake 3 formats.

The difficulty is that the Xonotic game code is written in QuakeC and is expected to run on a Q1VM, while Dæmon executes native code (currently sandboxed in NativeClient) compiled from generic languages like C or C++. There was multiple attempts to achieve the port, some people worked on source transpilers to convert the QuakeC code base to less exotic languages like C++ or Rust, others worked on writing a Q1VM expected to run on the Dæmon virtual machine.

There was interesting progresses achieved by those various attempts, the team managed to produce a minimalistic Q1VM running some minimal QuakeC code base allowing to start the {{engine|link=no}}, load a map and walk around.

Xonotic developers helped to split the {{engine|link=no}} and the Unvanquished game, developped some code to make the engine more standalone.

Lots of features were implemented in the Dæmon renderer using Xonotic data files (maps, materials, textures…), for example the relief mapping feature was debugged and fixed using Xonotic maps and materials, or the ability to support both lose normal maps and normal maps embedded in height maps was implemented. Also a lot of rewrite was done to make the {{engine|link=no}} better and even helped Dæmon team to better understand some things to make the engine better, for example the multitextured material blending feature is a direct consequences from that, or the ability to support multiple formats of normal maps.

The {{engine}} now provides some cvars to enable compatibility code to better support medias purposed for the DarkPlaces engine.

This project also helped the Dæmon game engine to support both the newer DPK format and the legacy PK3 format at the same time, because Xonotic through Nexuiz has more than 15 years of history and there are thousands of maps out there so porting maps was not really an option.

Xonotic data files (maps, materials, textures…) are still used today as test bed for the {{engine|link=no}} to test for regressions and to implement new features: Xonotic assets makes use of more rendering features than Unvanquished! For example the Xonotic assets may be used to test the sRGB lightmap technology we still need to implement.

The Xonotic and Unvanquished teams became very close, and multiple Xonotic contributors also became Dæmon and/or Unvanquished contributors (TimePath, Mario, Melanosuchus, EACFreddy…), making the engine better, implementing features, etc. Some Unvanquished contibutors also started to help Xonotic as we still have common interests. For example Unvanquished contributors help Team Xonotic to maintain the [[Tools/NetRadiant|NetRadiant]] level editor which is also the recommended level editor for Unvanquished.

== Special mentions (not Dæmon-based but very close) ==

=== KingpinQ3 ===

'''Type:''' remake (on a custom XreaL port). 
'''Status:''' active, released (beta builds).

This project is ''not'' running on the {{engine|link=no}} but on another fork of '''XreaL''' (like Dæmon), so technically both engines are very close and we share common interests. For example hypov8 from KingpinQ3 converted our new lasgun first person model to a usable third person model in Unvanquished!

'''KingpinQ3''' is a remake of Xatrix Entertainment's '''Kingpin - Life of Crime game''' on an engine derivated from Quake 3 through the '''XreaL''' lineage like us!

* Website: https://www.kingpinq3.com
* Downloads: https://www.kingpin.info/download/index.php?dir=other/standalonegames/KingpinQ3/

Source repositories

2026-06-02T11:36:10Z

Illwieckz: Game link

==Game==

* [[Game|Unvanquished]], game: [https://github.com/Unvanquished/Unvanquished source], [https://github.com/Unvanquished/Unvanquished/issues bug tracker]

This includes the [[unvanquished_src.dpkdir]] main package: [https://github.com/Unvanquished/Unvanquished/tree/master/pkg/unvanquished_src.dpkdir source].

==Engine==

* [[Engine|Dæmon]], engine: [https://github.com/DaemonEngine/Daemon source], [https://github.com/DaemonEngine/Daemon/issues bug tracker]
* CBSE-Toolchain, code generator for component-based gamelogic: [https://github.com/DaemonEngine/CBSE-Toolchain source], [https://github.com/DaemonEngine/CBSE-Toolchain/issues bug tracker]

==Data==

* UnvanquishedAssets, asset repository registry: [https://github.com/UnvanquishedAssets source registry]
* UnvanquishedTestAssets, test asset repository: [https://github.com/UnvanquishedAssets/UnvanquishedTestAssets source]
* UnvanquishedBranding, icons, banners, and more: [https://github.com/Unvanquished/UnvanquishedBranding source]

==Sub-projects==

* Updater/launcher: [https://github.com/Unvanquished/updater source], [https://github.com/Unvanquished/updater/issues bug tracker]
* Master server: [https://github.com/Unvanquished/unvanquished-master source], [https://github.com/Unvanquished/unvanquished-master/issues bug tracker]

==Data authoring tools==

* {{Tools|DaemonMediaAuthoringKit}}: [https://github.com/DaemonEngine/DaemonMediaAuthoringKit source], [https://github.com/DaemonEngine/DaemonMediaAuthoringKit/issues bug tracker]
** NetRadiant gamepack: [https://github.com/Unvanquished/unvanquished-mapeditor-support source], [https://github.com/Unvanquished/unvanquished-mapeditor-support/issues bug tracker]
** {{Tools|NetRadiant}} & {{Tools|Q3map2}}, level editor and compiler: [https://gitlab.com/xonotic/netradiant source], [https://gitlab.com/xonotic/netradiant/issues bug tracker] (hosted at Xonotic)
** {{Tools|Chameleon}}, level retexturing tool: [https://github.com/DaemonEngine/Chameleon source], [https://github.com/DaemonEngine/Chameleon/issues bug tracker]
** {{Tools|Sloth}}, material generator: [https://github.com/DaemonEngine/Sloth source], [https://github.com/DaemonEngine/Sloth/issues bug tracker]
** {{Tools|Urcheon}}, asset builder and packager: [https://github.com/DaemonEngine/Urcheon source], [https://github.com/DaemonEngine/Urcheon/issues bug tracker]
** {{Tools|Crunch}}, texture compressor: [https://github.com/DaemonEngine/crunch source], [https://github.com/DaemonEngine/crunch/issues bug tracker] (following Unity upstream)
** {{Tools|Iqmtool}}, model compiler: [https://github.com/fte-team/fteqw/tree/master/iqm source], [https://github.com/fte-team/fteqw/issues bug tracker] (FTE QuakeWorld's fork of iqm).

==Obsolete projects==

* {{Tools|DaemonMap}}, navmesh generator: [https://github.com/DaemonEngine/daemonmap source], [https://github.com/DaemonEngine/daemonmap, bug tracker] (replaced by an in-game navmesh generator)
* {{Tools|Osavul}}, server browser: [https://github.com/Unvanquished/Osavul source], [https://github.com/Unvanquished/Osavul/issues bug tracker] (dormant project)
* {{Tools|Archipelago}}, remapper (dead project)

Source repositories

2026-06-02T11:34:50Z

Illwieckz: /* Data authoring tools */

==Game==

* [[Main_Page|Unvanquished]], game: [https://github.com/Unvanquished/Unvanquished source], [https://github.com/Unvanquished/Unvanquished/issues bug tracker]

This includes the [[unvanquished_src.dpkdir]] main package: [https://github.com/Unvanquished/Unvanquished/tree/master/pkg/unvanquished_src.dpkdir source].

==Engine==

* [[Engine|Dæmon]], engine: [https://github.com/DaemonEngine/Daemon source], [https://github.com/DaemonEngine/Daemon/issues bug tracker]
* CBSE-Toolchain, code generator for component-based gamelogic: [https://github.com/DaemonEngine/CBSE-Toolchain source], [https://github.com/DaemonEngine/CBSE-Toolchain/issues bug tracker]

==Data==

* UnvanquishedAssets, asset repository registry: [https://github.com/UnvanquishedAssets source registry]
* UnvanquishedTestAssets, test asset repository: [https://github.com/UnvanquishedAssets/UnvanquishedTestAssets source]
* UnvanquishedBranding, icons, banners, and more: [https://github.com/Unvanquished/UnvanquishedBranding source]

==Sub-projects==

* Updater/launcher: [https://github.com/Unvanquished/updater source], [https://github.com/Unvanquished/updater/issues bug tracker]
* Master server: [https://github.com/Unvanquished/unvanquished-master source], [https://github.com/Unvanquished/unvanquished-master/issues bug tracker]

==Data authoring tools==

* {{Tools|DaemonMediaAuthoringKit}}: [https://github.com/DaemonEngine/DaemonMediaAuthoringKit source], [https://github.com/DaemonEngine/DaemonMediaAuthoringKit/issues bug tracker]
** NetRadiant gamepack: [https://github.com/Unvanquished/unvanquished-mapeditor-support source], [https://github.com/Unvanquished/unvanquished-mapeditor-support/issues bug tracker]
** {{Tools|NetRadiant}} & {{Tools|Q3map2}}, level editor and compiler: [https://gitlab.com/xonotic/netradiant source], [https://gitlab.com/xonotic/netradiant/issues bug tracker] (hosted at Xonotic)
** {{Tools|Chameleon}}, level retexturing tool: [https://github.com/DaemonEngine/Chameleon source], [https://github.com/DaemonEngine/Chameleon/issues bug tracker]
** {{Tools|Sloth}}, material generator: [https://github.com/DaemonEngine/Sloth source], [https://github.com/DaemonEngine/Sloth/issues bug tracker]
** {{Tools|Urcheon}}, asset builder and packager: [https://github.com/DaemonEngine/Urcheon source], [https://github.com/DaemonEngine/Urcheon/issues bug tracker]
** {{Tools|Crunch}}, texture compressor: [https://github.com/DaemonEngine/crunch source], [https://github.com/DaemonEngine/crunch/issues bug tracker] (following Unity upstream)
** {{Tools|Iqmtool}}, model compiler: [https://github.com/fte-team/fteqw/tree/master/iqm source], [https://github.com/fte-team/fteqw/issues bug tracker] (FTE QuakeWorld's fork of iqm).

==Obsolete projects==

* {{Tools|DaemonMap}}, navmesh generator: [https://github.com/DaemonEngine/daemonmap source], [https://github.com/DaemonEngine/daemonmap, bug tracker] (replaced by an in-game navmesh generator)
* {{Tools|Osavul}}, server browser: [https://github.com/Unvanquished/Osavul source], [https://github.com/Unvanquished/Osavul/issues bug tracker] (dormant project)
* {{Tools|Archipelago}}, remapper (dead project)

Source repositories

2026-06-02T11:34:28Z

Illwieckz: /* Data authoring tools */ fteqw iqmtool source

==Game==

* [[Main_Page|Unvanquished]], game: [https://github.com/Unvanquished/Unvanquished source], [https://github.com/Unvanquished/Unvanquished/issues bug tracker]

This includes the [[unvanquished_src.dpkdir]] main package: [https://github.com/Unvanquished/Unvanquished/tree/master/pkg/unvanquished_src.dpkdir source].

==Engine==

* [[Engine|Dæmon]], engine: [https://github.com/DaemonEngine/Daemon source], [https://github.com/DaemonEngine/Daemon/issues bug tracker]
* CBSE-Toolchain, code generator for component-based gamelogic: [https://github.com/DaemonEngine/CBSE-Toolchain source], [https://github.com/DaemonEngine/CBSE-Toolchain/issues bug tracker]

==Data==

* UnvanquishedAssets, asset repository registry: [https://github.com/UnvanquishedAssets source registry]
* UnvanquishedTestAssets, test asset repository: [https://github.com/UnvanquishedAssets/UnvanquishedTestAssets source]
* UnvanquishedBranding, icons, banners, and more: [https://github.com/Unvanquished/UnvanquishedBranding source]

==Sub-projects==

* Updater/launcher: [https://github.com/Unvanquished/updater source], [https://github.com/Unvanquished/updater/issues bug tracker]
* Master server: [https://github.com/Unvanquished/unvanquished-master source], [https://github.com/Unvanquished/unvanquished-master/issues bug tracker]

==Data authoring tools==

* {{Tools|DaemonMediaAuthoringKit}}: [https://github.com/DaemonEngine/DaemonMediaAuthoringKit source], [https://github.com/DaemonEngine/DaemonMediaAuthoringKit/issues bug tracker]
** NetRadiant gamepack: [https://github.com/Unvanquished/unvanquished-mapeditor-support source], [https://github.com/Unvanquished/unvanquished-mapeditor-support/issues bug tracker]
** {{Tools|NetRadiant}} & {{Tools|Q3map2}}, level editor and compiler: [https://gitlab.com/xonotic/netradiant source], [https://gitlab.com/xonotic/netradiant/issues bug tracker] (hosted at Xonotic)
** {{Tools|Chameleon}}, level retexturing tool: [https://github.com/DaemonEngine/Chameleon source], [https://github.com/DaemonEngine/Chameleon/issues bug tracker]
** {{Tools|Sloth}}, material generator: [https://github.com/DaemonEngine/Sloth source], [https://github.com/DaemonEngine/Sloth/issues bug tracker]
** {{Tools|Urcheon}}, asset builder and packager: [https://github.com/DaemonEngine/Urcheon source], [https://github.com/DaemonEngine/Urcheon/issues bug tracker]
** {{Tools|Crunch}}, texture compressor: [https://github.com/DaemonEngine/crunch source], [https://github.com/DaemonEngine/crunch/issues bug tracker] (following Unity upstream)
** {{Tools|Iqmtool}}, model compiler: [https://github.com/fte-team/fteqw/tree/master/iqm source], [https://github.com/fte-team/fteqw/issues issues] (FTE QuakeWorld's fork of iqm).

==Obsolete projects==

* {{Tools|DaemonMap}}, navmesh generator: [https://github.com/DaemonEngine/daemonmap source], [https://github.com/DaemonEngine/daemonmap, bug tracker] (replaced by an in-game navmesh generator)
* {{Tools|Osavul}}, server browser: [https://github.com/Unvanquished/Osavul source], [https://github.com/Unvanquished/Osavul/issues bug tracker] (dormant project)
* {{Tools|Archipelago}}, remapper (dead project)

Source repositories

2026-06-02T11:32:33Z

Illwieckz: dpkdir

==Game==

* [[Main_Page|Unvanquished]], game: [https://github.com/Unvanquished/Unvanquished source], [https://github.com/Unvanquished/Unvanquished/issues bug tracker]

This includes the [[unvanquished_src.dpkdir]] main package: [https://github.com/Unvanquished/Unvanquished/tree/master/pkg/unvanquished_src.dpkdir source].

==Engine==

* [[Engine|Dæmon]], engine: [https://github.com/DaemonEngine/Daemon source], [https://github.com/DaemonEngine/Daemon/issues bug tracker]
* CBSE-Toolchain, code generator for component-based gamelogic: [https://github.com/DaemonEngine/CBSE-Toolchain source], [https://github.com/DaemonEngine/CBSE-Toolchain/issues bug tracker]

==Data==

* UnvanquishedAssets, asset repository registry: [https://github.com/UnvanquishedAssets source registry]
* UnvanquishedTestAssets, test asset repository: [https://github.com/UnvanquishedAssets/UnvanquishedTestAssets source]
* UnvanquishedBranding, icons, banners, and more: [https://github.com/Unvanquished/UnvanquishedBranding source]

==Sub-projects==

* Updater/launcher: [https://github.com/Unvanquished/updater source], [https://github.com/Unvanquished/updater/issues bug tracker]
* Master server: [https://github.com/Unvanquished/unvanquished-master source], [https://github.com/Unvanquished/unvanquished-master/issues bug tracker]

==Data authoring tools==

* {{Tools|DaemonMediaAuthoringKit}}: [https://github.com/DaemonEngine/DaemonMediaAuthoringKit source], [https://github.com/DaemonEngine/DaemonMediaAuthoringKit/issues bug tracker]
** NetRadiant gamepack: [https://github.com/Unvanquished/unvanquished-mapeditor-support source], [https://github.com/Unvanquished/unvanquished-mapeditor-support/issues bug tracker]
** {{Tools|NetRadiant}} & {{Tools|Q3map2}}, level editor and compiler: [https://gitlab.com/xonotic/netradiant source], [https://gitlab.com/xonotic/netradiant/issues bug tracker] (hosted at Xonotic)
** {{Tools|Chameleon}}, level retexturing tool: [https://github.com/DaemonEngine/Chameleon source], [https://github.com/DaemonEngine/Chameleon/issues bug tracker]
** {{Tools|Sloth}}, material generator: [https://github.com/DaemonEngine/Sloth source], [https://github.com/DaemonEngine/Sloth/issues bug tracker]
** {{Tools|Urcheon}}, asset builder and packager: [https://github.com/DaemonEngine/Urcheon source], [https://github.com/DaemonEngine/Urcheon/issues bug tracker]
** {{Tools|Crunch}}, texture compressor: [https://github.com/DaemonEngine/crunch source], [https://github.com/DaemonEngine/crunch/issues bug tracker] (following Unity upstream)
** {{Tools|Iqmtool}}, model compiler: [https://sourceforge.net/p/fteqw/code/HEAD/tree/trunk/iqm/ source] (FTE QuakeWorld's fork of iqm).

==Obsolete projects==

* {{Tools|DaemonMap}}, navmesh generator: [https://github.com/DaemonEngine/daemonmap source], [https://github.com/DaemonEngine/daemonmap, bug tracker] (replaced by an in-game navmesh generator)
* {{Tools|Osavul}}, server browser: [https://github.com/Unvanquished/Osavul source], [https://github.com/Unvanquished/Osavul/issues bug tracker] (dormant project)
* {{Tools|Archipelago}}, remapper (dead project)

Source repositories

2026-06-02T11:31:37Z

Illwieckz: The unvanquished dpkdir is now in main repo

==Game==

* [[Main_Page|Unvanquished]], game: [https://github.com/Unvanquished/Unvanquished source], [https://github.com/Unvanquished/Unvanquished/issues bug tracker]
* [[unvanquished_src.dpkdir]], main package: [https://github.com/Unvanquished/Unvanquished/tree/master/pkg/unvanquished_src.dpkdir source], [https://github.com/UnvanquishedAssets/unvanquished_src.dpkdir/issues bug tracker]

==Engine==

* [[Engine|Dæmon]], engine: [https://github.com/DaemonEngine/Daemon source], [https://github.com/DaemonEngine/Daemon/issues bug tracker]
* CBSE-Toolchain, code generator for component-based gamelogic: [https://github.com/DaemonEngine/CBSE-Toolchain source], [https://github.com/DaemonEngine/CBSE-Toolchain/issues bug tracker]

==Data==

* UnvanquishedAssets, asset repository registry: [https://github.com/UnvanquishedAssets source registry]
* UnvanquishedTestAssets, test asset repository: [https://github.com/UnvanquishedAssets/UnvanquishedTestAssets source]
* UnvanquishedBranding, icons, banners, and more: [https://github.com/Unvanquished/UnvanquishedBranding source]

==Sub-projects==

* Updater/launcher: [https://github.com/Unvanquished/updater source], [https://github.com/Unvanquished/updater/issues bug tracker]
* Master server: [https://github.com/Unvanquished/unvanquished-master source], [https://github.com/Unvanquished/unvanquished-master/issues bug tracker]

==Data authoring tools==

* {{Tools|DaemonMediaAuthoringKit}}: [https://github.com/DaemonEngine/DaemonMediaAuthoringKit source], [https://github.com/DaemonEngine/DaemonMediaAuthoringKit/issues bug tracker]
** NetRadiant gamepack: [https://github.com/Unvanquished/unvanquished-mapeditor-support source], [https://github.com/Unvanquished/unvanquished-mapeditor-support/issues bug tracker]
** {{Tools|NetRadiant}} & {{Tools|Q3map2}}, level editor and compiler: [https://gitlab.com/xonotic/netradiant source], [https://gitlab.com/xonotic/netradiant/issues bug tracker] (hosted at Xonotic)
** {{Tools|Chameleon}}, level retexturing tool: [https://github.com/DaemonEngine/Chameleon source], [https://github.com/DaemonEngine/Chameleon/issues bug tracker]
** {{Tools|Sloth}}, material generator: [https://github.com/DaemonEngine/Sloth source], [https://github.com/DaemonEngine/Sloth/issues bug tracker]
** {{Tools|Urcheon}}, asset builder and packager: [https://github.com/DaemonEngine/Urcheon source], [https://github.com/DaemonEngine/Urcheon/issues bug tracker]
** {{Tools|Crunch}}, texture compressor: [https://github.com/DaemonEngine/crunch source], [https://github.com/DaemonEngine/crunch/issues bug tracker] (following Unity upstream)
** {{Tools|Iqmtool}}, model compiler: [https://sourceforge.net/p/fteqw/code/HEAD/tree/trunk/iqm/ source] (FTE QuakeWorld's fork of iqm).

==Obsolete projects==

* {{Tools|DaemonMap}}, navmesh generator: [https://github.com/DaemonEngine/daemonmap source], [https://github.com/DaemonEngine/daemonmap, bug tracker] (replaced by an in-game navmesh generator)
* {{Tools|Osavul}}, server browser: [https://github.com/Unvanquished/Osavul source], [https://github.com/Unvanquished/Osavul/issues bug tracker] (dormant project)
* {{Tools|Archipelago}}, remapper (dead project)

Contributing/Media

2026-06-02T11:28:18Z

Illwieckz: /* Marking your Work */

[[Category:Contributing]]
This page outlines information about the project as a whole so that you can get involved more quickly.

==Before you begin==

Before following these guidelines, please read the [[Contributing|main article on contributing]]. It contains useful information about how the project is structured as a whole and what our philosophies are towards development.

==Trying Out the Game==

{{Note|content=Please be aware that this information applies to '''all''' members of the team. You are expected to try the game at some point if you intend on contributing content to it. This is only fair to everyone else who has contributed content in the past, and ensures consistency with existing content.}}

Basic download instructions are available from [http://www.unvanquished.net/download our homepage]. If you use an unsupported operating system, please read the instructions on [[Getting the source|acquiring]] and [[Compiling the source|compiling]] the source code.

Although there currently are very few players on servers at any point in time, you still have a couple of options to play the game to try it out:
* '''Play against bots.''' — There are currently a number of servers with enough bots that the game is playable even without any human opponents. The training server typically always has bots, and even has a few special game modes. Alternatively you can use console commands to [[LocalGames|add them to your own local games]]
* '''Wait for a scheduled development game.''' — For the past several weeks, we have been scheduling games on the weekends to ensure an adequate number of players for testing. You can get information about scheduled games on the [[chat]].
* '''Test offline.''' — You can always start a [[Testing#Starting_a_testing_session|testing session]] and [[Testing#Testing_with_gameplay_code|use some cheats]] to test all the different weapons and character classes.

Of course, you can always check who's playing online at any given moment via the [https://www.unvanquished.net/?page_id=340 master server status page].

==Licensing==

===Recommended licenses===

Please understand that you will be expected to license your work. You are also expected to have some basic understanding of copyright law. '''It is extremely important that you license your work correctly and that you understand the implications of what you are doing!''' Also note that assets that are of questionable origin will not be included in the game.

{{Note|For historical reasons and until we state otherwise, the default contribution license is CC BY SA 3.0, which is the license we unified a lot of our assets with. Unless you specify another license from one listed below, by contributing to Unvanquished you are placing your work under CC By SA 3.0 licence. You must have right to.

We do recommend the CC By 4.0 licence for new contributions.}}

You are expected to use one of the CC By SA 3.0 or later compatible licenses:

{| class="progress wikitable"
! colspan="2" | Name
! colspan="4" | Features
! colspan="2" | Text
|-
! Full
! Abbreviated
! Requires attribution?
! Allows modification?
! Allows commercial use?
! Allows relicensing?
! Human-readable
! Legal Code
|-
| Creative Commons Zero (Public Domain Dedication) 1.0
| CC0 1.0
| class="done" style="text-align:center;" | No
| class="none" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [https://creativecommons.org/publicdomain/zero/1.0/ License Deed]
| [https://creativecommons.org/publicdomain/zero/1.0/legalcode Legal Code]
|-
| Creative Commons Attribution 4.0 Unported
| CC BY 4.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [http://creativecommons.org/licenses/by-sa/4.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/4.0/legalcode Legal Code]
|-
| Creative Commons Attribution 3.0 Unported
| CC BY 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [http://creativecommons.org/licenses/by-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-ShareAlike 4.0 Unported
| CC BY-SA 4.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-sa/4.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/4.0/legalcode Legal Code]
|-
| Creative Commons Attribution-ShareAlike 3.0 Unported
| CC BY-SA 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/3.0/legalcode Legal Code]
|}

All of these licenses allow redistributing your work, to be maintained by Unvanquished contributor, and mixed in Unvanquished work. Please note that we would much prefer if you would use one of those licenses. Not using one of those licenses in certain situations might prevent your work from being included.

If you disagree with all of the above licenses, please contact any of the project leads with your concerns. If you have another license in mind, please inform us. Be prepared to defend your criticisms of the Creative Commons licenses (i.e., provide a compelling argument) and your choice for another license. Be aware that more restrictive licenses are not likely to be accepted by the project heads.

===Licenses to avoid===

{{Note|content=Assets using these problematic licenses were relicensed under a CC By SA 3.0 licence or similarly open by people having right to, or were replaced by compatible ones.}}

Some assets used some problematic licenses which are discouraged since they prevents the game to be distributed or referenced by some platforms. They also prevent some work to be done. For example rendering lightmaps using “lightfilter” or “alphashadow” techniques is a derivated work and may requires asset license compatibility according to how you interpret this to be original or how your local legislation is written. Creating a machinima is creating a derivated work from all assets visible and heard and therefore require license compatibility. Those problematic licenses are CC By SA 3.0 incompatibles and mixing assets covered by incompatible licenses is a copyright infringement and therefore illegal, for that reason these problematic licenses must be avoided in game core assets (the ones that makes you unable to play if they are missing) and must not be used for newer contributions:

{| class="progress wikitable"
! colspan="2" | Name
! colspan="4" | Features
! colspan="2" | Text
|-
! Full
! Abbreviated
! Requires attribution?
! Allows modification?
! Allows commercial use?
! Allows relicensing?
! Human-readable
! Legal Code
|-
| Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
| CC BY-NC-SA 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nc-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nc-sa/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-NoDerivs 3.0 Unported
| CC BY-ND 3.0
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nd/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nd/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
| CC BY-NC-ND 3.0
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nc-nd/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nc-nd/3.0/legalcode Legal Code]
|-
|}

===Marking your Work===

If you are working in Blender, please add a license to your work visible in the default screen layout visible in a text editor view. '''Please note that you should not do this if you are not the original creator of the work.''' For example, if you are animating a model that was created by someone else, ask '''them''' to add a notice themselves.

You are advised to use the following template:

Copyright {{CURRENTYEAR}} <var>your real name</var>.

This work is licensed under a Creative Commons Attribution 4.0 Unported License.
http://creativecommons.org/licenses/by/4.0/

Of course, you should modify this template to match whichever license your are using.

===Mappers===

In creating a map, you likely will end up using textures from a variety of sources. You '''must''' include copies of licenses and notices of attribution for any and all textures that you use not created by yourself. Those textures which you have created yourself should be licensed as outlined above, and a notice included. It is recommended to include a file named <code><var>mapname</var>.txt</code>, <code>map-<var>mapname</var>.txt</code> or <code>map-<var>mapname</var>-<var>version</var>.txt</code> inside a directory named <code>about</code> in your <code>[[Packaging_game_data|.dpk]]</code>.

==Introducing Yourself==

Once you have access to the developer subforums, please create a post on the [http://unvanquished.net/forum/forumdisplay.php/36-Assets-amp-Artwork Assets & Artwork] subforum telling us a little about yourself.

At the end of your introduction, please add the following information using this template:

[LIST]
[*] [B]Skillset[/B]: <var>List your skills here</var>
[*] [B]Software[/B]: <var>List software you know well here</var>
[*] [B]E-mail[/B]: <var>Please place an e-mail address that you would like to be contacted at here</var>
[*] [B]Preferred means of contact[/B]: <var>How would you like to be contacted?</var>
[*] [B]Primary operating system[/B]: <var>Which operating system (and version) do you use the most often? (E.g., Mac OS X 10.6)</var>
[*] [B]Portfolio[/B]: <var>Add links to any work that you have done that is visible on the internet</var>
[/LIST]

If you do not have a portfolio and you are a 2d or 3d artist, please upload a gallery of images of your work to imgur or other reliable image sharing site. Similarly, if you are an audio engineer or musician, upload your work to some audio sharing site.

You may wish to include other information, such as:

* Alternate means of contact (e.g., Skype);
* Your time zone, so that we know when we can contact you.

Continue reading for more specific instructions.

==Animators==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What software do you use?
* How familiar are you with your preferred software? I.e., what features of your animation package do you utilize? For example, if you use Blender, do you know how to use actions and constraints?

We currently use the {{Formats|IQM}} format for animations. Please familiarize yourself with the following documentation before beginning to animate anything:

* Read the [[Modeling#Workflow_overview|workflow overview]]. This explains the workflow shared by our artists for bringing a concept into reality. You are expected to understand this. If you have any questions, do not hesitate to ask.
* From the model exporting guide, please read the [[Exporting_Models#Overview|overview]] and the [[Exporting_Models#What_is_MD5.3F|What is MD5?]] section. {{TODO|inline=true|Rewrite for IQM.}} You will need to understand these in order to be able to create an animation that can successfully be exported from your animation package of choice and loaded into the game.

In particular, you are expected to know the limitations of the {{Formats|IQM}} format. '''If you do not respect these limitations, you are guaranteed to have a great deal if difficulty when attempting to export your model.''' While the art lead is more than willing to provide help to get your asset in-game, you would be wasting his/her time by not reading the documentation beforehand; it is only respectful to do so.

==Audio Engineers & Musicians==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What hardware and instruments do you have access to?
* If you are a musician, what instruments do you play? If you don't play an instrument, what do you compose music with?
* If you are a musician, what sort of music do you like to compose?
* If you are an audio engineer, what is your particular skillset?

You are expected to familiarize yourself with the following:

* Please read the [[Music_and_sounds|documentation]] on music and sounds. Be aware that at the time of writing (19 March 2013), this information is rather inadequate, but it will at least answer some questions.
* Please take a look at the [[Sound_Progress|sound progress]] page for an idea of what sounds there are that need replacement.

In addition, you should be aware that many sounds present in Unvanquished are inherited from Tremulous and '''must''' be replaced. '''Note that this is non-negotiable''': the sounds from Tremulous failed to prove having trustable sources and we prefer to replace them entirely to not take any risk of copyright infrigement accusation even if no one never claimed that since Tremulous was released in 2006.

==Concept Artists==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What is your preferred medium? E.g., do you draw with a tablet in Photoshop, or do you use pencil and paper? Be specific.
* What is your greatest strength with respect to drawing? I.e., what is the one thing that you think you are the best at drawing?
* How long do you expect it to take to create a concept? We're not [http://clientsfromhell.net/ clients from hell], so we're not going to pressure you to do things quickly, but we'd just like to know in advance if it might take a week or whatever so that know you haven't just died on us if we don't hear from you for a while!

Please be aware:

* If you are unsure of what you would like to work on, please familiarize yourself with both the [[Aliens|alien]] and [[Humans|human]] teams.
* Be aware that you are expected to [[#Trying_Out_the_Game|try the game]] at some point!
* If you would like to know what character and weapon models have not been completed that are therefore available to create a concept for, take a look at the [[modeling progress]] page. Anything that is not being worked on is fair game, even if other concepts have been made before.
* There is not currently a listing of all the concepts made for the game, so you will have to browse the [http://unvanquished.net/forum/forumdisplay.php/36-Assets-amp-Artwork Assets & Artwork subforum] for now.

==Mappers==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What maps have you released to the public in the past, and for what games?
* What experience do you have with mapping software? Include any and all software that you have used, even if it was not for a Quake-derived game, and some indication of your skill with that software.

You are expected to familiarize yourself with the following:

* Please read the [[Mapping|mapping guide]] all the way through. You do not necessarily need to know how to use every feature of the tools right away, but you should understand the basics.
* [[Packaging_game_data|How to get data in the game]]. This is less important when you begin mapping, but you must understand this when you approach time to release or upload your map online for testing. Ideally, you would not be creating a final release of your map without at least one beta test version.

==Modelers==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What software do you '''prefer''' to use?
* What is your personal workflow? Do you begin with a high poly model and retopo that? Or do you begin and end with the geometry that will end up in the final game?
* Are you capable of completing a modeling assignment, or will you need assistance? If you will need assistance (e.g., with retopoing, unwrapping, texturing, rigging, or animation), please inform us. Be specific.
* Are you familiar with modern techniques? Specifically, we'd like to know if you know what the following are and how to use them:
** Normal maps;
** Bump maps;
** Specular maps;
** Physical maps (PBR);
** Glow maps;
** Height maps;
** Smoothing groups;
* Are you familiar with the idea of not storing lighting information in your diffuse texture? '''If you do not understand what this means, please ask.''' A guide will eventually be written on this.
* Is hardware an issue? E.g., if you are going to be editing a very high poly model, do you have a video card that can handle that?

You are expected to familiarize yourself with the following:

* Read the [[Modeling#Workflow_overview|workflow overview]]. This explains the workflow shared by our artists for bringing a concept into reality. You are expected to understand this. If you have any questions, do not hesitate to ask.
* From the model exporting guide, please read the [[Exporting_Models#Overview|overview]]. If you are not going to animate your model yourself, this is less important, but it is good to know anyway.

==Texture Artists==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* Are you familiar with the idea of not storing lighting information in your diffuse texture? '''If you do not understand what this means, please ask.''' A guide will eventually be written on this.

You are expected to familiarize yourself with the following:

* Please read the [[texture creation]] guide. This contains important information about what formats the engine supports and where you can obtain special tools that you may need to create content specifically for our engine.

==Screenshot and movie==

Before take screenshot or make a movie, please set high preset graphic, or better.

You may want to disable all 2D draw (name, minimap, ping...) by command {{code|/cg_draw2D 0}} (change the '''0''' by '''1''' to enable again).

Then if you use SHIFT with the screenshot hotkey (F11 by default), the screenshot will be done with PNG format.

====For movies====

With Linux, you can try [https://www.maartenbaert.be/simplescreenrecorder/ SimpleScreenRecorder].

Or maybe [https://www.gamingonlinux.com/2021/07/open-source-instant-replay-software-replaysorcery-adds-an-experimental-kms-service ReplaySorcery].

Contributing/Media

2026-06-02T10:39:40Z

Illwieckz: /* Recommended licenses */ rewording

[[Category:Contributing]]
This page outlines information about the project as a whole so that you can get involved more quickly.

==Before you begin==

Before following these guidelines, please read the [[Contributing|main article on contributing]]. It contains useful information about how the project is structured as a whole and what our philosophies are towards development.

==Trying Out the Game==

{{Note|content=Please be aware that this information applies to '''all''' members of the team. You are expected to try the game at some point if you intend on contributing content to it. This is only fair to everyone else who has contributed content in the past, and ensures consistency with existing content.}}

Basic download instructions are available from [http://www.unvanquished.net/download our homepage]. If you use an unsupported operating system, please read the instructions on [[Getting the source|acquiring]] and [[Compiling the source|compiling]] the source code.

Although there currently are very few players on servers at any point in time, you still have a couple of options to play the game to try it out:
* '''Play against bots.''' — There are currently a number of servers with enough bots that the game is playable even without any human opponents. The training server typically always has bots, and even has a few special game modes. Alternatively you can use console commands to [[LocalGames|add them to your own local games]]
* '''Wait for a scheduled development game.''' — For the past several weeks, we have been scheduling games on the weekends to ensure an adequate number of players for testing. You can get information about scheduled games on the [[chat]].
* '''Test offline.''' — You can always start a [[Testing#Starting_a_testing_session|testing session]] and [[Testing#Testing_with_gameplay_code|use some cheats]] to test all the different weapons and character classes.

Of course, you can always check who's playing online at any given moment via the [https://www.unvanquished.net/?page_id=340 master server status page].

==Licensing==

===Recommended licenses===

Please understand that you will be expected to license your work. You are also expected to have some basic understanding of copyright law. '''It is extremely important that you license your work correctly and that you understand the implications of what you are doing!''' Also note that assets that are of questionable origin will not be included in the game.

{{Note|For historical reasons and until we state otherwise, the default contribution license is CC BY SA 3.0, which is the license we unified a lot of our assets with. Unless you specify another license from one listed below, by contributing to Unvanquished you are placing your work under CC By SA 3.0 licence. You must have right to.

We do recommend the CC By 4.0 licence for new contributions.}}

You are expected to use one of the CC By SA 3.0 or later compatible licenses:

{| class="progress wikitable"
! colspan="2" | Name
! colspan="4" | Features
! colspan="2" | Text
|-
! Full
! Abbreviated
! Requires attribution?
! Allows modification?
! Allows commercial use?
! Allows relicensing?
! Human-readable
! Legal Code
|-
| Creative Commons Zero (Public Domain Dedication) 1.0
| CC0 1.0
| class="done" style="text-align:center;" | No
| class="none" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [https://creativecommons.org/publicdomain/zero/1.0/ License Deed]
| [https://creativecommons.org/publicdomain/zero/1.0/legalcode Legal Code]
|-
| Creative Commons Attribution 4.0 Unported
| CC BY 4.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [http://creativecommons.org/licenses/by-sa/4.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/4.0/legalcode Legal Code]
|-
| Creative Commons Attribution 3.0 Unported
| CC BY 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | Yes
| [http://creativecommons.org/licenses/by-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-ShareAlike 4.0 Unported
| CC BY-SA 4.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-sa/4.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/4.0/legalcode Legal Code]
|-
| Creative Commons Attribution-ShareAlike 3.0 Unported
| CC BY-SA 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-sa/3.0/legalcode Legal Code]
|}

All of these licenses allow redistributing your work, to be maintained by Unvanquished contributor, and mixed in Unvanquished work. Please note that we would much prefer if you would use one of those licenses. Not using one of those licenses in certain situations might prevent your work from being included.

If you disagree with all of the above licenses, please contact any of the project leads with your concerns. If you have another license in mind, please inform us. Be prepared to defend your criticisms of the Creative Commons licenses (i.e., provide a compelling argument) and your choice for another license. Be aware that more restrictive licenses are not likely to be accepted by the project heads.

===Licenses to avoid===

{{Note|content=Assets using these problematic licenses were relicensed under a CC By SA 3.0 licence or similarly open by people having right to, or were replaced by compatible ones.}}

Some assets used some problematic licenses which are discouraged since they prevents the game to be distributed or referenced by some platforms. They also prevent some work to be done. For example rendering lightmaps using “lightfilter” or “alphashadow” techniques is a derivated work and may requires asset license compatibility according to how you interpret this to be original or how your local legislation is written. Creating a machinima is creating a derivated work from all assets visible and heard and therefore require license compatibility. Those problematic licenses are CC By SA 3.0 incompatibles and mixing assets covered by incompatible licenses is a copyright infringement and therefore illegal, for that reason these problematic licenses must be avoided in game core assets (the ones that makes you unable to play if they are missing) and must not be used for newer contributions:

{| class="progress wikitable"
! colspan="2" | Name
! colspan="4" | Features
! colspan="2" | Text
|-
! Full
! Abbreviated
! Requires attribution?
! Allows modification?
! Allows commercial use?
! Allows relicensing?
! Human-readable
! Legal Code
|-
| Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
| CC BY-NC-SA 3.0
| class="done" style="text-align:center;" | Yes
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nc-sa/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nc-sa/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-NoDerivs 3.0 Unported
| CC BY-ND 3.0
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nd/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nd/3.0/legalcode Legal Code]
|-
| Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
| CC BY-NC-ND 3.0
| class="done" style="text-align:center;" | Yes
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| class="none" style="text-align:center;" | No
| [http://creativecommons.org/licenses/by-nc-nd/3.0/ License Deed]
| [http://creativecommons.org/licenses/by-nc-nd/3.0/legalcode Legal Code]
|-
|}

===Marking your Work===

If you are working in Blender, please add a license to your work visible in the default screen layout visible in a text editor view. '''Please note that you should not do this if you are not the original creator of the work.''' For example, if you are animating a model that was created by someone else, ask '''them''' to add a notice themselves.

You are advised to use the following template:

Copyright {{CURRENTYEAR}} <var>your real name</var>.

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
http://creativecommons.org/licenses/by-sa/3.0/

Of course, you should modify this template to match whichever license your are using.

===Mappers===

In creating a map, you likely will end up using textures from a variety of sources. You '''must''' include copies of licenses and notices of attribution for any and all textures that you use not created by yourself. Those textures which you have created yourself should be licensed as outlined above, and a notice included. It is recommended to include a file named <code><var>mapname</var>.txt</code>, <code>map-<var>mapname</var>.txt</code> or <code>map-<var>mapname</var>-<var>version</var>.txt</code> inside a directory named <code>about</code> in your <code>[[Packaging_game_data|.dpk]]</code>.

==Introducing Yourself==

Once you have access to the developer subforums, please create a post on the [http://unvanquished.net/forum/forumdisplay.php/36-Assets-amp-Artwork Assets & Artwork] subforum telling us a little about yourself.

At the end of your introduction, please add the following information using this template:

[LIST]
[*] [B]Skillset[/B]: <var>List your skills here</var>
[*] [B]Software[/B]: <var>List software you know well here</var>
[*] [B]E-mail[/B]: <var>Please place an e-mail address that you would like to be contacted at here</var>
[*] [B]Preferred means of contact[/B]: <var>How would you like to be contacted?</var>
[*] [B]Primary operating system[/B]: <var>Which operating system (and version) do you use the most often? (E.g., Mac OS X 10.6)</var>
[*] [B]Portfolio[/B]: <var>Add links to any work that you have done that is visible on the internet</var>
[/LIST]

If you do not have a portfolio and you are a 2d or 3d artist, please upload a gallery of images of your work to imgur or other reliable image sharing site. Similarly, if you are an audio engineer or musician, upload your work to some audio sharing site.

You may wish to include other information, such as:

* Alternate means of contact (e.g., Skype);
* Your time zone, so that we know when we can contact you.

Continue reading for more specific instructions.

==Animators==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What software do you use?
* How familiar are you with your preferred software? I.e., what features of your animation package do you utilize? For example, if you use Blender, do you know how to use actions and constraints?

We currently use the {{Formats|IQM}} format for animations. Please familiarize yourself with the following documentation before beginning to animate anything:

* Read the [[Modeling#Workflow_overview|workflow overview]]. This explains the workflow shared by our artists for bringing a concept into reality. You are expected to understand this. If you have any questions, do not hesitate to ask.
* From the model exporting guide, please read the [[Exporting_Models#Overview|overview]] and the [[Exporting_Models#What_is_MD5.3F|What is MD5?]] section. {{TODO|inline=true|Rewrite for IQM.}} You will need to understand these in order to be able to create an animation that can successfully be exported from your animation package of choice and loaded into the game.

In particular, you are expected to know the limitations of the {{Formats|IQM}} format. '''If you do not respect these limitations, you are guaranteed to have a great deal if difficulty when attempting to export your model.''' While the art lead is more than willing to provide help to get your asset in-game, you would be wasting his/her time by not reading the documentation beforehand; it is only respectful to do so.

==Audio Engineers & Musicians==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What hardware and instruments do you have access to?
* If you are a musician, what instruments do you play? If you don't play an instrument, what do you compose music with?
* If you are a musician, what sort of music do you like to compose?
* If you are an audio engineer, what is your particular skillset?

You are expected to familiarize yourself with the following:

* Please read the [[Music_and_sounds|documentation]] on music and sounds. Be aware that at the time of writing (19 March 2013), this information is rather inadequate, but it will at least answer some questions.
* Please take a look at the [[Sound_Progress|sound progress]] page for an idea of what sounds there are that need replacement.

In addition, you should be aware that many sounds present in Unvanquished are inherited from Tremulous and '''must''' be replaced. '''Note that this is non-negotiable''': the sounds from Tremulous failed to prove having trustable sources and we prefer to replace them entirely to not take any risk of copyright infrigement accusation even if no one never claimed that since Tremulous was released in 2006.

==Concept Artists==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What is your preferred medium? E.g., do you draw with a tablet in Photoshop, or do you use pencil and paper? Be specific.
* What is your greatest strength with respect to drawing? I.e., what is the one thing that you think you are the best at drawing?
* How long do you expect it to take to create a concept? We're not [http://clientsfromhell.net/ clients from hell], so we're not going to pressure you to do things quickly, but we'd just like to know in advance if it might take a week or whatever so that know you haven't just died on us if we don't hear from you for a while!

Please be aware:

* If you are unsure of what you would like to work on, please familiarize yourself with both the [[Aliens|alien]] and [[Humans|human]] teams.
* Be aware that you are expected to [[#Trying_Out_the_Game|try the game]] at some point!
* If you would like to know what character and weapon models have not been completed that are therefore available to create a concept for, take a look at the [[modeling progress]] page. Anything that is not being worked on is fair game, even if other concepts have been made before.
* There is not currently a listing of all the concepts made for the game, so you will have to browse the [http://unvanquished.net/forum/forumdisplay.php/36-Assets-amp-Artwork Assets & Artwork subforum] for now.

==Mappers==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What maps have you released to the public in the past, and for what games?
* What experience do you have with mapping software? Include any and all software that you have used, even if it was not for a Quake-derived game, and some indication of your skill with that software.

You are expected to familiarize yourself with the following:

* Please read the [[Mapping|mapping guide]] all the way through. You do not necessarily need to know how to use every feature of the tools right away, but you should understand the basics.
* [[Packaging_game_data|How to get data in the game]]. This is less important when you begin mapping, but you must understand this when you approach time to release or upload your map online for testing. Ideally, you would not be creating a final release of your map without at least one beta test version.

==Modelers==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* What software do you '''prefer''' to use?
* What is your personal workflow? Do you begin with a high poly model and retopo that? Or do you begin and end with the geometry that will end up in the final game?
* Are you capable of completing a modeling assignment, or will you need assistance? If you will need assistance (e.g., with retopoing, unwrapping, texturing, rigging, or animation), please inform us. Be specific.
* Are you familiar with modern techniques? Specifically, we'd like to know if you know what the following are and how to use them:
** Normal maps;
** Bump maps;
** Specular maps;
** Physical maps (PBR);
** Glow maps;
** Height maps;
** Smoothing groups;
* Are you familiar with the idea of not storing lighting information in your diffuse texture? '''If you do not understand what this means, please ask.''' A guide will eventually be written on this.
* Is hardware an issue? E.g., if you are going to be editing a very high poly model, do you have a video card that can handle that?

You are expected to familiarize yourself with the following:

* Read the [[Modeling#Workflow_overview|workflow overview]]. This explains the workflow shared by our artists for bringing a concept into reality. You are expected to understand this. If you have any questions, do not hesitate to ask.
* From the model exporting guide, please read the [[Exporting_Models#Overview|overview]]. If you are not going to animate your model yourself, this is less important, but it is good to know anyway.

==Texture Artists==

In addition to the [[#Introducing_Yourself|above information]], we'd like to know the following about you:

* Are you familiar with the idea of not storing lighting information in your diffuse texture? '''If you do not understand what this means, please ask.''' A guide will eventually be written on this.

You are expected to familiarize yourself with the following:

* Please read the [[texture creation]] guide. This contains important information about what formats the engine supports and where you can obtain special tools that you may need to create content specifically for our engine.

==Screenshot and movie==

Before take screenshot or make a movie, please set high preset graphic, or better.

You may want to disable all 2D draw (name, minimap, ping...) by command {{code|/cg_draw2D 0}} (change the '''0''' by '''1''' to enable again).

Then if you use SHIFT with the screenshot hotkey (F11 by default), the screenshot will be done with PNG format.

====For movies====

With Linux, you can try [https://www.maartenbaert.be/simplescreenrecorder/ SimpleScreenRecorder].

Or maybe [https://www.gamingonlinux.com/2021/07/open-source-instant-replay-software-replaysorcery-adds-an-experimental-kms-service ReplaySorcery].

Contributing/Code

2026-06-02T10:25:08Z

Illwieckz: /* GitHub etiquette */ merge and review details

[[Category:Contributing]]
As we use GitHub for hosting, you may very easily [https://help.github.com/articles/fork-a-repo fork] our [https://github.com/Unvanquished/Unvanquished project] (or any sub-project, such as the [https://github.com/DaemonEngine Dæmon] engine or [https://github.com/DaemonEngine/Urcheon Urcheon]). From there, you may [https://help.github.com/articles/using-pull-requests open a pull request].

== Before you start coding ==

If your intended change may be controversial, or you're not sure how to implement it, it would be wise to discuss your intentions with other developers via [[chat]], the {{forums}}, or a GitHub issue. In the case of a gameplay change, it should be discussed on the [https://github.com/Unvanquished/gameplay gameplay tracker].

== Correct and readable code ==

* Follow established [[Coding_convention|coding conventions]].
* Test your commit before opening a pull request or pushing.
* Verify that your code passes the [[Continuous integration|automated builds]]. After you open a pull request in GitHub, you will see messages about "checks passing" or "checks failing", which indicate their status. To catch more warnings before you push, consider enabling the {{code|USE_WERROR}} CMake option.

== Proper Git usage ==
* Write [http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html good commit messages].
* Each individual commit should successfully compile and ideally be otherwise free of regressions. Correspondingly, when revising a pull request under review, rebase and modify earlier buggy commits rather than adding "fix" commits at the end.
* Avoid submitting a large number of commits in one pull request.

== GitHub etiquette ==

* People with commit access should always merge their own pull requests. Don't merge another contributor's code as they may have good reasons to hold back that aren't obvious. See [[Contributing/Merge]] for details.
* Get the approval of another team member before merging. See [[Contributing/Review]] for details.
* Do not merge pull requests that have been open for less than 24 hours. Mistakes are likely if people don't get a chance to review.

Contributing/Code

2026-06-02T10:21:53Z

Illwieckz: markup

[[Category:Contributing]]
As we use GitHub for hosting, you may very easily [https://help.github.com/articles/fork-a-repo fork] our [https://github.com/Unvanquished/Unvanquished project] (or any sub-project, such as the [https://github.com/DaemonEngine Dæmon] engine or [https://github.com/DaemonEngine/Urcheon Urcheon]). From there, you may [https://help.github.com/articles/using-pull-requests open a pull request].

== Before you start coding ==

If your intended change may be controversial, or you're not sure how to implement it, it would be wise to discuss your intentions with other developers via [[chat]], the {{forums}}, or a GitHub issue. In the case of a gameplay change, it should be discussed on the [https://github.com/Unvanquished/gameplay gameplay tracker].

== Correct and readable code ==

* Follow established [[Coding_convention|coding conventions]].
* Test your commit before opening a pull request or pushing.
* Verify that your code passes the [[Continuous integration|automated builds]]. After you open a pull request in GitHub, you will see messages about "checks passing" or "checks failing", which indicate their status. To catch more warnings before you push, consider enabling the {{code|USE_WERROR}} CMake option.

== Proper Git usage ==
* Write [http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html good commit messages].
* Each individual commit should successfully compile and ideally be otherwise free of regressions. Correspondingly, when revising a pull request under review, rebase and modify earlier buggy commits rather than adding "fix" commits at the end.
* Avoid submitting a large number of commits in one pull request.

== GitHub etiquette ==

* People with commit access should always merge their own pull requests. Don't merge another contributor's code as they may have good reasons to hold back that aren't obvious.
* Get the approval of another team member before merging.
* Do not merge pull requests that have been open for less than 24 hours. Mistakes are likely if people don't get a chance to review.

Infrastructure/Servers

2026-06-02T10:17:44Z

Illwieckz: /* Dedicated server hosted by illwieckz */

[[Category:Infrastructure]]
== Dedicated server hosted by `Ishq ==

99% Unvanquished stuff, `Ishq hosts some personal services.

Administration is shared among some team members.

=== System ===

* System: Debian
* Web server: Nginx
* PHP application server: PHP-FPM
* Database: MariaDB/MySQL
* SSL certificates: Let's Encrypt

=== Hosted web services ===

* https://unvanquished.net blog
** Software: Wordpress
* https://unvanquished.net/activity Pluto rss/atom planet for development activity
** Software: Pluto, https://github.com/feedreader/pluto
** Configuration: https://github.com/Unvanquished/pluto-devfeeds
* https://unvanquished.net/servers Wordpress plugin for server listing
** Software: XonPress, https://github.com/DaemonEngine/XonPress ([https://gitlab.com/mattia.basaglia/Xonpress originally written] by Melanosuchus)
* https://forums.unvanquished.net forums
** Software: phpBB
* https://wiki.unvanquished.net wiki
** Software: MediaWiki
* https://login.unvanquished.net shared authentication system
** Software: SimpleSAMLphp
* https://dl.unvanquished.net primary download server (releases, build dependencies, ingame download as HTTP)
** Software: raw Nginx
* https://cdn.unvanquished.net primary CDN server
** Software: raw Nginx
* https://play.unvanquished.net game protocol redirector
** Software: raw Nginx with SSI

=== Hosted game services ===

* <code>master.unvanquished.net</code> primary master server (unvanquished-master)
* <code>unvanquished.net:27960</code> official US game server

=== Hosted chat services ===

* Overmind IRC bot: autovoice webchat users, welcome messages, antispam features
** Software: PyTIBot, https://github.com/DefaultUser/PyTIBot
* Unvanquished IRC bot: announce game and events
** Software: Mantis, https://gitlab.com/Viech/Mantis/
* Granger bot: keeps note for users, do some fun stuff as well (markov chains)
** Software: ruby-rbot, https://github.com/ruby-rbot/rbot
* Dretch bridge (DiscordFlips): bridge IRC, Matrix and Discord
** Software: matterbridge, https://github.com/42wim/matterbridge

See [[Chat#Bots]] for details about what those chat bots do.

== Dedicated server hosted by illwieckz ==

99% personal stuff, some Unvanquished services among others.

Is used as a landing page when `Ishq dedicated server is offline.

Administration is not shared. It may be possible to share administration permissions on the game-related virtual machine or to redesign things to make it possible.

=== System ===

* System (hypervisor): Debian Xen
* Web front: Nginx
* SSL certificates: Let's Encrypt
* System (web front virtual machine): Debian
* Web: Nginx
* System (gaming virtual machine): Ubuntu
* Web: Nginx

=== Hosted web services ===

* https://cdn.illwieckz.net/unvanquished CDN mirror
* https://dl.illwieckz.net/share/unvanquished/release release mirror, build dependencies mirror
* https://gg.illwieckz.net/dl/unvanquished/pkg in-game download as HTTP

=== Hosted game services ===

* <code>master2.unvanquished.net</code> secondary master server (unvanquished-master)
* <code>gg.illwieckz.net:27960</code> official EU game server

Infrastructure/Servers

2026-06-02T10:17:23Z

Illwieckz: /* Hosted web services */

[[Category:Infrastructure]]
== Dedicated server hosted by `Ishq ==

99% Unvanquished stuff, `Ishq hosts some personal services.

Administration is shared among some team members.

=== System ===

* System: Debian
* Web server: Nginx
* PHP application server: PHP-FPM
* Database: MariaDB/MySQL
* SSL certificates: Let's Encrypt

=== Hosted web services ===

* https://unvanquished.net blog
** Software: Wordpress
* https://unvanquished.net/activity Pluto rss/atom planet for development activity
** Software: Pluto, https://github.com/feedreader/pluto
** Configuration: https://github.com/Unvanquished/pluto-devfeeds
* https://unvanquished.net/servers Wordpress plugin for server listing
** Software: XonPress, https://github.com/DaemonEngine/XonPress ([https://gitlab.com/mattia.basaglia/Xonpress originally written] by Melanosuchus)
* https://forums.unvanquished.net forums
** Software: phpBB
* https://wiki.unvanquished.net wiki
** Software: MediaWiki
* https://login.unvanquished.net shared authentication system
** Software: SimpleSAMLphp
* https://dl.unvanquished.net primary download server (releases, build dependencies, ingame download as HTTP)
** Software: raw Nginx
* https://cdn.unvanquished.net primary CDN server
** Software: raw Nginx
* https://play.unvanquished.net game protocol redirector
** Software: raw Nginx with SSI

=== Hosted game services ===

* <code>master.unvanquished.net</code> primary master server (unvanquished-master)
* <code>unvanquished.net:27960</code> official US game server

=== Hosted chat services ===

* Overmind IRC bot: autovoice webchat users, welcome messages, antispam features
** Software: PyTIBot, https://github.com/DefaultUser/PyTIBot
* Unvanquished IRC bot: announce game and events
** Software: Mantis, https://gitlab.com/Viech/Mantis/
* Granger bot: keeps note for users, do some fun stuff as well (markov chains)
** Software: ruby-rbot, https://github.com/ruby-rbot/rbot
* Dretch bridge (DiscordFlips): bridge IRC, Matrix and Discord
** Software: matterbridge, https://github.com/42wim/matterbridge

See [[Chat#Bots]] for details about what those chat bots do.

== Dedicated server hosted by illwieckz ==

99% personal stuff, some Unvanquished services among others.

Is used as a landing page when `Ishq dedicated server was offline.

Administration is not shared. It may be possible to share administration permissions on the game-related virtual machine or to redesign things to make it possible.

=== System ===

* System (hypervisor): Debian Xen
* Web front: Nginx
* SSL certificates: Let's Encrypt
* System (web front virtual machine): Debian
* Web: Nginx
* System (gaming virtual machine): Ubuntu
* Web: Nginx

=== Hosted web services ===

* https://cdn.illwieckz.net/unvanquished CDN mirror
* https://dl.illwieckz.net/share/unvanquished/release release mirror, build dependencies mirror
* https://gg.illwieckz.net/dl/unvanquished/pkg in-game download as HTTP

=== Hosted game services ===

* <code>master2.unvanquished.net</code> secondary master server (unvanquished-master)
* <code>gg.illwieckz.net:27960</code> official EU game server

Infrastructure/Servers

2026-06-02T10:16:57Z

Illwieckz: chat bots link

[[Category:Infrastructure]]
== Dedicated server hosted by `Ishq ==

99% Unvanquished stuff, `Ishq hosts some personal services.

Administration is shared among some team members.

=== System ===

* System: Debian
* Web server: Nginx
* PHP application server: PHP-FPM
* Database: MariaDB/MySQL
* SSL certificates: Let's Encrypt

=== Hosted web services ===

* https://unvanquished.net blog
** Software: Wordpress
* https://unvanquished.net/activity Pluto rss/atom planet for development activity
** Software: Pluto, https://github.com/feedreader/pluto
** Configuration: https://github.com/Unvanquished/pluto-devfeeds
* https://unvanquished.net/servers Wordpress plugin for server listing
** Software: XonPress, https://github.com/DaemonEngine/XonPress ([https://gitlab.com/mattia.basaglia/Xonpress originally written] by Melanosuchus)
* https://forums.unvanquished.net forums
** Software: phpBB
* https://wiki.unvanquished.net wiki
** Software: MediaWiki
* https://login.unvanquished.net shared authentication system
** Software: SimpleSAMLphp
* https://dl.unvanquished.net primary download server (releases, build dependencies, ingame download as HTTP)
** Software: raw Nginx
* https://cdn.unvanquished.net primary CDN server
** Software: raw Nginx
* https://play.unvanquished.net game protocol redirector
** Software: raw Nginx with SSI

=== Hosted game services ===

* <code>master.unvanquished.net</code> primary master server (unvanquished-master)
* <code>unvanquished.net:27960</code> official US game server

=== Hosted chat services ===

* Overmind IRC bot: autovoice webchat users, welcome messages, antispam features
** Software: PyTIBot, https://github.com/DefaultUser/PyTIBot
* Unvanquished IRC bot: announce game and events
** Software: Mantis, https://gitlab.com/Viech/Mantis/
* Granger bot: keeps note for users, do some fun stuff as well (markov chains)
** Software: ruby-rbot, https://github.com/ruby-rbot/rbot
* Dretch bridge (DiscordFlips): bridge IRC, Matrix and Discord
** Software: matterbridge, https://github.com/42wim/matterbridge

See [[Chat#Bots]] for details about what those chat bots do.

== Dedicated server hosted by illwieckz ==

99% personal stuff, some Unvanquished services among others.

Is used as a landing page when `Ishq dedicated server was offline.

Administration is not shared. It may be possible to share administration permissions on the game-related virtual machine or to redesign things to make it possible.

=== System ===

* System (hypervisor): Debian Xen
* Web front: Nginx
* SSL certificates: Let's Encrypt
* System (web front virtual machine): Debian
* Web: Nginx
* System (gaming virtual machine): Ubuntu
* Web: Nginx

=== Hosted web services ===

* https://cdn.illwieckz.net/unvanquished CDN mirror
* https://dl.illwieckz.net/share/unvanquished/release (release mirror, build dependencies mirror)
* https://gg.illwieckz.net/dl/unvanquished/pkg in-game download as HTTP

=== Hosted game services ===

* <code>master2.unvanquished.net</code> secondary master server (unvanquished-master)
* <code>gg.illwieckz.net:27960</code> official EU game server

Infrastructure/Servers

2026-06-02T10:16:20Z

Illwieckz: updates

[[Category:Infrastructure]]
== Dedicated server hosted by `Ishq ==

99% Unvanquished stuff, `Ishq hosts some personal services.

Administration is shared among some team members.

=== System ===

* System: Debian
* Web server: Nginx
* PHP application server: PHP-FPM
* Database: MariaDB/MySQL
* SSL certificates: Let's Encrypt

=== Hosted web services ===

* https://unvanquished.net blog
** Software: Wordpress
* https://unvanquished.net/activity Pluto rss/atom planet for development activity
** Software: Pluto, https://github.com/feedreader/pluto
** Configuration: https://github.com/Unvanquished/pluto-devfeeds
* https://unvanquished.net/servers Wordpress plugin for server listing
** Software: XonPress, https://github.com/DaemonEngine/XonPress ([https://gitlab.com/mattia.basaglia/Xonpress originally written] by Melanosuchus)
* https://forums.unvanquished.net forums
** Software: phpBB
* https://wiki.unvanquished.net wiki
** Software: MediaWiki
* https://login.unvanquished.net shared authentication system
** Software: SimpleSAMLphp
* https://dl.unvanquished.net primary download server (releases, build dependencies, ingame download as HTTP)
** Software: raw Nginx
* https://cdn.unvanquished.net primary CDN server
** Software: raw Nginx
* https://play.unvanquished.net game protocol redirector
** Software: raw Nginx with SSI

=== Hosted game services ===

* <code>master.unvanquished.net</code> primary master server (unvanquished-master)
* <code>unvanquished.net:27960</code> official US game server

=== Hosted chat services ===

* Overmind IRC bot: autovoice webchat users, welcome messages, antispam features
** Software: PyTIBot, https://github.com/DefaultUser/PyTIBot
* Unvanquished IRC bot: announce game and events
** Software: Mantis, https://gitlab.com/Viech/Mantis/
* Granger bot: keeps note for users, do some fun stuff as well (markov chains)
** Software: ruby-rbot, https://github.com/ruby-rbot/rbot
* Dretch bridge (DiscordFlips): bridge IRC, Matrix and Discord
** Software: matterbridge, https://github.com/42wim/matterbridge

See [[Chat#Chat bots]] for details about what those chat bots do.

== Dedicated server hosted by illwieckz ==

99% personal stuff, some Unvanquished services among others.

Is used as a landing page when `Ishq dedicated server was offline.

Administration is not shared. It may be possible to share administration permissions on the game-related virtual machine or to redesign things to make it possible.

=== System ===

* System (hypervisor): Debian Xen
* Web front: Nginx
* SSL certificates: Let's Encrypt
* System (web front virtual machine): Debian
* Web: Nginx
* System (gaming virtual machine): Ubuntu
* Web: Nginx

=== Hosted web services ===

* https://cdn.illwieckz.net/unvanquished CDN mirror
* https://dl.illwieckz.net/share/unvanquished/release (release mirror, build dependencies mirror)
* https://gg.illwieckz.net/dl/unvanquished/pkg in-game download as HTTP

=== Hosted game services ===

* <code>master2.unvanquished.net</code> secondary master server (unvanquished-master)
* <code>gg.illwieckz.net:27960</code> official EU game server

Contributing/Review

2026-06-02T10:07:15Z

Illwieckz: /* Suggesting a change */ better wording in example

[[Category:Contributing]]
{{Note|header=Proposal|content=This is a proposal, things may be discussed and changed.

See the forum thread: https://forums.unvanquished.net/viewtopic.php?t=2426}}

{{NoteMergeReview}}

__TOC__

== Reviewing artistic data ==

Reviewing images, materials, sound effects or map changes from [https://github.com/UnvanquishedAssets/UnvanquishedAssets UnvanquishedAssets] is a bit different than code, as there are some art direction involved.

A data PR modifying how a the game world is experienced, for example how a map looks, is expected to get approved by an artistic advisor before merging. Common artistic reviewers are currently: '''Viech''', '''illwieckz''', '''Sweet'''.

An artistic data author is also a reviewer for his own map / texture / other artistic data package, for example the author of a map is considered an artistic reviewer for the map, same for texture packages if the author is part of the Unvanquished team (a texture package specially created for Unvanquished) and same for sound. For model repositories like weapons, buildables and players, the author of a model is considered an artistic reviewer for the things related to the model.

Artistic reviewers can say a change literally looks good to them and is OK for merging for the matter of the way it looks.

Artistic reviewers can auto-approve their change for the matter of the way it looks.

Then comes some generic implementation review, basically things like if the syntax of files is correct, or used file format is good or not.

Let's give some use case as an example:

# '''Someone contributes a force field effect modification by adding a heat haze map.'''
#* It is required to get an artistic review. Artistic reviewers can auto-approve themselves.
#* Usual reviewers of the team (same as code) can review the implementation, for example suggesting to compress the image better or writing the {{code|.shader}} file in a better way.
# '''Someone edits some brushwork in a map without any impact in the perceived geometry.''' For example to caulk some surface to optimise the rendering, or to reduce the light map size.
#* This doesn't require an artistic review, so any usual reviewers of the team can review that.
#* The PR submitter should say it doesn't require artistic review and why.

Like code, we better wait for at least one complete day before merging a PR to make possible to gather some comments.

Something specific to data contribution is the file size, because most data formats (image, sound files) are not diffable, we better make sure a file is in its optimal compressed format prior to pushing it into a repository, this is a technical review, not an artistic review.

Any pull request should be reviewed, even if a formality, just to make sure at least another eye seen it before merging. The idea about authors auto-approving themselves only counts for the artistic side of things. The idea is that if the change got reviewed, but no one said anything about the artistic side of things, a map author can consider it's fine to merge without artistic comment. This is to solve the problem of no one having any opinion on the artistic side of the given change, but everyone being able to say the change is technically ready to merge.

== Reviewing code ==

Reviewing code doesn't require an artistic review. All members of the team are reviewers. The review focus on the contribution being bug-free, maintainable, things like that.

== Requesting a review ==

When submitting a pull-request, it is useful to explain not only what the code is meant to do and why, but also express the state of the work you submit and the kind of review you are looking for, in hope this helps to reduce the pull request being trapped in situations that were not intended that would slow down the review process.

Here are some questions you are invited to answer when submitting your work:

'''Those changes are implementing:'''

* ☐ A fix.
* ☐ A new feature.
* ☐ A rewrite of something that already exists.
* ☐ A clean-up to drop legacy or unused stuff.

'''Those changes are:'''

* ☐ Made by me.
* ☐ Made by someon else:

'''What the changes are for and what are they trying to accomplish:'''

<code style="padding-left: 15em; padding-right: 15em;"></code>

'''The existing issues related to those changes:'''

<code style="padding-left: 15em; padding-right: 15em;"></code>

'''My own personnal perceived status of the changes being submitted:'''

<code style="padding-left: 15em; padding-right: 15em;"></code>

* ☐ I believe it is ready to merge as is unless proven wrong.
* ☐ I believe it is ready to use but I'm requesting for comments so it can be refined.
* ☐ That's a work-in-progress, being made public to get early comments and make sure other peoples working on other branches know this is being worked on.

'''I'm looking for this kind of review:'''

* ☐ Generic proof-reading for mistakes.
* ☐ Comments about the the design itself, looking for better ways to do things.
* ☐ Opinion on what is expected to be brought or removed, is this wanted to begin with? if yes are there better ideas?
* ☐ Opinion on the way it's done or what it plans to achieves.
* ☐ Testing to be sure it works as expected or not regress.

'''What I already tested and assume is already verified:'''

<code style="padding-left: 15em; padding-right: 15em;"></code>

'''I request testing:'''

* ☐ On a specific operating system, hardware brand or model, driver version:
* ☐ Of specific game options, configurations, in-game actions:

'''My changes are expected to integrate this way in the target branch:'''

* ☐ As a preparation for future changes that would be submitted in another pull request.
* ☐ As a single commit despite this being submitted as separate commits.
* ☐ As separate commits because I believe it's better for this change to do things step by step and I don't want to lose the ability to bisect those steps.

== Reviewing a contribution ==

When clicking the “Approve” button, please add a comment, a {{Code|LGTM}} (''Looks Good To Me'') mention is enough.

A {{code|LGTM}} message without any other comment is considered as an approval, better click Approve anyway.
A {{code|LGTM}} message with a comment for a better implementation (not a bug fix) is considered as an approval, better click Approve anyway.

=== If the code looks to have no bug from you point of view ===

please write LGTM in all cases.

==== If you agree with the purpose of the change ====

Please write LGTM and Approve.

==== If you disagree with the purpose of the change ====

Please write LGTM but add a comment explaining why you don't approve.

This way, if the code has no bug, we can solve the politics separately and if we decide to agree with the purpose of the change, we can merge it without having to look back at the code, and to not block the merge because we don't know if code is reviewed yet.

==== If you have a suggestion for a better implementation ====

Please write LGTM and approve and add a comment with your suggestion, saying it is a suggestion.

This way, the submitter can decide to follow you or not.

If the submitter merged without following your recommendation, you are free to implement your recommendation.

=== If the code has a bug from your point of view ===

==== If you know the fix and this is obvious to do ====

Please state what you believe is a bug and suggest what you believe would fix the bug.

You can write “LGTM if you do <suggestion>” and then write your suggestion.

You can consider obvious a fix you believe there is no need to verify the implementation of your recommendation.

Once the submitter implements your suggested fix the change will be considered fully approved without needing any new comment.

==== If you don't know the fix or this is not obvious to do ====

Please explain why you believe is a bug, and if you an idea to fix it, please share it.

=== If you have any remark but it is not blocking ===

Please write LGTM, approve, and write your remark.

== Suggesting a change ==

Prefer to point out something that could be better, or suggest a change, than give a direct order, because nobody is paid for that work and then everything already done is already a gift that we not deserve.

For example instead of something like:

<blockquote>Remove leading spaces.</blockquote>

Prefer something like:

<blockquote>That leading space will be included in the translation string and this is unwanted.</blockquote>

Basically, instead of saying what should be done, say why something can be done.

== Approving the change ==

When you believe the submitted contribution of someone else is ready to merge, you can approve it.

By approving someone else contribution, you help a lot this project! Every merger is an approver.

Contributing/Merge

2026-06-02T10:06:47Z

Illwieckz: /* Super merger */

[[Category:Contributing]]
{{Note|header=Proposal|content=This is a proposal, things may be discussed and changed.

See the forum thread: https://forums.unvanquished.net/viewtopic.php?t=2426}}

{{NoteMergeReview}}

== Common merge rules ==

As a start, some things copy pasted from [[Contributing/Code]]:

* People with commit access should always merge their own pull requests. Don't merge another contributor's code as they may have good reasons to hold back that aren't obvious.
* Get the approval of another team member before merging.
* Do not merge pull requests that have been open for less than 24 hours. Mistakes are likely if people don't get a chance to review.

== Merge role hierarchy ==

I suggest to formally define three roles (this may not translate into GitHub user interface):

=== Super merger ===

The purpose of super merger role is to be able to take some decisions to unstuck situations.

The super merger can, as an exception, merge someone else's pull request, if needed for example when the pull request looks ready but is sleeping for too long and the submitter is not answering, or to merge some things that looks ready for a release and delaying a release is not wanted.

In all cases, those are exceptions and when going the exception way it's recommended to first write a motivated comment and to wait a delay of one day between the motivated comment and the merge.

{{Note|Suggested super mergers: project heads, perturbed.}}

=== Merger ===

Everyone with commit access is a merger, so basically the team members.

A merger can also merge a pull request from a contributor who doesn't have commit permission, or for any reason explaining why the author will not do it, the merger is then considered the reviewer and the approver.

Merging someone else's code and being the approver requires the merged code to have been written against Unvanquished source, porting a code from another software (for example porting from ioquake3 engine to Dæmon engine) requires the porting effort to be reviewed by someone else than the merger.

Any merger is an approver to someone else.

=== Contributors ===

External contributors without commit permission, but submitting pull requests.

== Closing an unmerged pull request from someone else ==

=== Superseded ===

If you believe an original pull request that is not yours is superseded by another one that you believe does the same and that was merged, and if you believe there is nothing more to merge in the original one, don't close it immediately but:

<blockquote>
* Ask the original author (mention him in your GitHub comment) if he believes there is nothing left to merge in the original pull request,
* Express your intention to close the pull request.

If the original author agrees with the closing, you can close the pull request without waiting more. 
If there is no answer after one month has passed, you can close the pull request. 
Add a comment saying you're closing the PR at the moment you can close the pull request.
</blockquote>

=== Stalled ===

A pull request is considered stalled if it had no activity in one year.

We don't have dozens of thousands pull request so we have no urge to clean-up them. Our team is small and the work is sometime done in very slow pace, so we better not close all stalled PR just for purity.

If you believe a stalled a change from a stalled pull request is wanted but the pull request can't be merged without being reworked, don't close it. It will be closed the day a reworked pull request will be merged instead and after we have followed the “Superseded” pull request closing rule.

If a pull request that is not yours is stalled and you believe it has no hope to get merged, you can follow similar rules in order to close it:

<blockquote>
* Ask the original author (mention him in your GitHub comment) if he plans to resume on it,
* Express your intention to close the pull request.

If the original author agrees with the closing, you can close the pull request without waiting more. 
If there is no answer after one month has passed, you can close the pull request. 
Add a comment saying you're closing the PR at the moment you can close the pull request.

If the original author has deleted his GitHub account, express your intention to close the pull request and also wait for a month, to leave time to other people of the team to react.
</blockquote>

It means a stalled pull request may be closed after one year of stalling plus one month of lack of response from the original author.
It doesn't mean a stalled pull request should be closed, whatever the time spent in stalling.

Chat

2026-06-02T09:57:07Z

Illwieckz: Minor rewording of sections (shorter links…) and markup

[[Category:Infrastructure]]
==Platforms==

Our main chat platform is '''Libera.Chat''' IRC but there are also Matrix and Discord rooms that are bridged together. Every people from IRC, Matrix or Discord can chat together, read what others write and respond to each others.

The chat is tantamount to a multiplayer version of Notepad; where ideas are exchanged fast and furiously, words are taken out of context, people misinterpret them, and feelings get hurt. In most cases, we trust people to be kind, helpful, responsible and mature individuals. For everyone else, we have these rules. Remember that access to our channel(s) is a privilege that we provide, not a right. We reserve the right to revoke your privileges.

===IRC===

We use IRC ([https://en.wikipedia.org/wiki/IRC Internet Relay Chat]) channels and our {{forums}} to discuss work on the game and help people. Many of the developers, artists and players remain permanently connected in IRC whilst others drop in and out when they can.

If you're asking for help please remember that everyone lives in different time-zones and can't always be at their computer. You need to stay logged into the channel for generally a few hours until you get a reply. If this does not suit you, our {{forums}} might be better.

Our IRC channels are:

* [irc://libera.chat/#unvanquished #unvanquished] ([https://web.libera.chat/?channel=#unvanquished web interface]): the general channel. Often used to get help.
* [irc://libera.chat/#unvanquished-dev #unvanquished-dev] ([https://web.libera.chat/?channel=#unvanquished-dev web interface]): the development channel. Open to everyone.
* [irc://libera.chat/#unvanquished-play #unvanquished-play] ([https://web.libera.chat/?channel=#unvanquished-play web interface]): a channel with a bot announcing games being played. Read-only.
* [irc://libera.chat/#unvanquished-fr #unvanquished-fr] ([https://web.libera.chat/?channel=#unvanquished-fr web interface]): a French channel. Un canal en français.

If these channels are even down we have a backup on QuakeNet:

* [irc://quakenet.org/#unvanquished #unvanquished@quakenet.org] ([https://webchat.quakenet.org/?channels=unvanquished web interface])

See our [https://unvanquished.net/chat/ chat page] for details.

===Matrix===

* [https://matrix.to/#/#unvanquished-space:matrix.org Matrix space]

The Matrix room is bridged with IRC and Discord.

===Discord===

* [https://discord.gg/usuDT9Pyna Discord space]

The Discord room is bridged with IRC and Matrix.

==Rules==

By joining the chat you agree to the Unvanquished channel rules:

===Global rules===

* '''Irony or mocking towards and from anyone is not allowed, insults are not allowed'''. If this happens, both parties will be asked to avoid talking to and about each other for a given time, to both protect each others and prevent the feeding of the drama.
* '''It is not allowed to threaten someone to death neither to encourage someone to suicide, neither to express hope someone will die in any way.''' This is a bannable offense and action will be taken on sight, no question asked.
* '''Do not post links to illegal material or pornography'''. No exceptions. This is a bannable offense.
* '''Do not spam the channel. This means repeatedly posting meaningless material, or the same thing several times in a row.
* '''Do not abuse bots. Bot spam is not entertaining to anyone that isn’t the direct participant'''. If you have to spam bot commands, use them via <code>/msg</code> to keep them to yourself.
* '''Do not flame each other. Keep it to private messages'''. If it gets out of hand, both sides of the conflict will take a short break.

===Development rules===

* Stay on-topic! Try to keep discussions going about coding or assets. Offering constructive feedback whenever possible is encouraging and speeds up production.
* NO personal attacks are allowed (flaming someone beyond what would potentially be considered "tongue-in-cheek" criticism). We have NO TOLERANCE for this and you WILL be banned!
* Contact a developer if there’s a problem in the channel.

These rules will be enforced after either a private or public warning to the offender to give them a chance to stop, followed by a quiet (+q) in the channel, which will be removed when we feel you are ready to participate in the conversation again.

Enforcing rules isn't doing a personal attack against people neither is the expression of hate towards people, but a tool to restore peace and welcomeness in the channels, to help all the people from the channels return to healthier conversations and give time to do so.

===Platform rules===

Extra rules may apply that are specific to the chat platform you connect to, like the [https://libera.chat/guidelines/ Libera.Chat channel guidelines], the [https://matrix.org/legal/code-of-conduct Matrix code of conduct] or the [https://discord.com/terms Discord terms of service].

==Operators==

If you have an issue that cannot be resolved by a channel operator, please contact Ishq, illwieckz or Viech directly (project direction).

{|
! Operators !! Libera !! Discord !! Matrix
|-
| Illwieckz || ✅️ || ✅️ || ✅️
|-
| Ishq || ✅️ || ✅️ || ✅️
|-
| Viech || || ✅️ || ✅️
|-
| cu-kai || ✅️ || ✅️ ||
|-
| Gireen || ✅️ || || ✅️
|-
| perturbed || ✅️ || ||
|}

==Bots==

Unvanquished operates various chat bots:

* {{code|Unvanquished}}: an IRC bot (sometime referred to as {{code|Mantis}} because of the name of the software running it).ℹ️ The Unvanquished bot commands work from IRC, Matrix and Discord.
** Automatically announce games in the {{code|play}} channel when people are playing, telling the map, the server, the amount of players per team…
** Can be queried with the command {{code|!list}} in most channels.
* {{code|overmind}}: an IRC bot.
** User permission,
** Spam detection,
** Notifications from git repositories, wiki and forums.
* {{code|granger}}: an IRC bot.ℹ️ The granger bot commands only work from IRC.
** Commands like {{code|!note <user> <message>}} makes possible to leave a message for someone else (will be printed the next time the user talks).
** Fun behaviors, the bot reads what everything says and sometime decides to participate to conversations by trying to make up phrases all by itself (it's usually ''wrong''), one can request the granger to chat on a topic with the command {{code|!chat about <word1> [word2]}}.
* {{code|dretch}}: the IRC/Matrix/Discord bridge.
** Message forwarding from and to each chat networks.

See [[Infrastructure/Servers#Hosted chat services]] for details about the various pieces of software running those chat bots.

Infrastructure/CDN

2026-05-20T16:28:14Z

Illwieckz: /* BitTorrent seeds */

The '''Unvanquished CDN''' is a network of servers providing seeds for the Unvanquished torrent. The {{launcher}} relies on BitTorrent to download the game.

BitTorrent is a communication protocol for peer-to-peer file sharing (P2P), which enables us to distribute updates over the Internet in a decentralized manner.

= Torrent =

Latest torrent url (same content as the [[Universal zip]]):

* {{code|https://unvanquished.net/download/torrent}} (redirect to latest torrent file)
* {{code|https://cdn.unvanquished.net/current.torrent}} (stable url without redirect)

Direct torrent url and mirrors:

{{WebSeedList|torrent=true}}

Upcoming torrent url:

* {{code|https://cdn.unvanquished.net/upcoming.torrent}} (updated in the days before a new release happens)

= Trackers =

Unvanquished relies on [https://fosstorrents.com FOSS Torrents] as primary BitTorrent tracker and a bunch of other trackers as a fallback.

* {{code|http://fosstorrents.com:6969/announce}}

Here is our page on FOSS Torrents website: https://fosstorrents.com/games/unvanquished/

Since Unvanquished {{code|0.53.2}}, those maintained lists of trackers are used when creating new torrents:

* https://raw.githubusercontent.com/ngosang/trackerslist/master/trackers_all.txt
* https://newtrackon.com/api/stable

Those lists are meant to be up-to-date and to only contain working trackers.

= Seeds =

It is possible to contribute to the CDN in two ways:

* by downloading the files and seed them with a BitTorrent software,
* by providing web seeds.

It happens that downloading files with BitTorrent software using a Torrent RSS is the best way to keep a web seed up to date.

== BitTorrent seeds ==

Any user can contribute this way without having to get in touch with us.

One can simply download the bitTorrent file, add it to a BitTorrent software and make sure the torrent gets configured to not get paused once completed. A good idea is to enable the Super Seeding option for the torrent if the software provides it.

See [[#Torrent RSS|Torrent RSS]] below for details for a way to automatically fetch and seed the files when we distribute a new release.

BitTorrent seeds can contribute to any already published release.

== Web seeds ==

Those are web servers used as BitTorrent seeds, they provides reliable seeding, especially when no one downloaded the game over BitTorrent yet. Bittorrent clients including the {{launcher}} download game files from there in addition to BitTorrent seeds.

Here are the current Unvanquished web seed servers, with location and owner:

{{WebSeedList}}

If you own a web server and want to add it to the list of web seeds, tell us on [https://forums.unvanquished.net/viewtopic.php?p=18849#p18849 forums], as this will need some configuration from us to add your server to the seeds.

Web seeds can only be added to new torrent files. So when contributing a new web seed, only the following releases will benefit from them.

= Torrent RSS =

We provide an RSS feed for the latest torrent file:

* {{code|https://cdn.unvanquished.net/current-torrent.rss}}

This feed always provide the link for the latest torrent for the latest game version. Some BitTorrent software has features to automatically download and seed new torrents listed in such feed.

You may use instead this alternate RSS feed making possible to download and seed the next version of the game. It is usually updated in the days preceding the release, to make possible for seeds to be up-to-date at release time.

* {{code|https://cdn.unvanquished.net/upcoming-torrent.rss}}

See [[Tutorials/RSS BitTorrent seeding]] for instructions to configure some BitTorrent software with RSS automatic download and seeding.

Infrastructure/CDN

2026-05-20T16:27:08Z

Illwieckz: /* Web seeds */

The '''Unvanquished CDN''' is a network of servers providing seeds for the Unvanquished torrent. The {{launcher}} relies on BitTorrent to download the game.

BitTorrent is a communication protocol for peer-to-peer file sharing (P2P), which enables us to distribute updates over the Internet in a decentralized manner.

= Torrent =

Latest torrent url (same content as the [[Universal zip]]):

* {{code|https://unvanquished.net/download/torrent}} (redirect to latest torrent file)
* {{code|https://cdn.unvanquished.net/current.torrent}} (stable url without redirect)

Direct torrent url and mirrors:

{{WebSeedList|torrent=true}}

Upcoming torrent url:

* {{code|https://cdn.unvanquished.net/upcoming.torrent}} (updated in the days before a new release happens)

= Trackers =

Unvanquished relies on [https://fosstorrents.com FOSS Torrents] as primary BitTorrent tracker and a bunch of other trackers as a fallback.

* {{code|http://fosstorrents.com:6969/announce}}

Here is our page on FOSS Torrents website: https://fosstorrents.com/games/unvanquished/

Since Unvanquished {{code|0.53.2}}, those maintained lists of trackers are used when creating new torrents:

* https://raw.githubusercontent.com/ngosang/trackerslist/master/trackers_all.txt
* https://newtrackon.com/api/stable

Those lists are meant to be up-to-date and to only contain working trackers.

= Seeds =

It is possible to contribute to the CDN in two ways:

* by downloading the files and seed them with a BitTorrent software,
* by providing web seeds.

It happens that downloading files with BitTorrent software using a Torrent RSS is the best way to keep a web seed up to date.

== BitTorrent seeds ==

Any user can contribute this way without having to get in touch with us.

One can simply download the bitTorrent file, add it to a BitTorrent software and make sure the torrent gets configured to not get paused once completed. A good idea is to enable the Super Seeding option for the torrent if the software provides it.

See [[#Torrent RSS|Torrent RSS]] below for details for a way to automatically fetch and seed the files when we distribute a new release.

== Web seeds ==

Those are web servers used as BitTorrent seeds, they provides reliable seeding, especially when no one downloaded the game over BitTorrent yet. Bittorrent clients including the {{launcher}} download game files from there in addition to BitTorrent seeds.

Here are the current Unvanquished web seed servers, with location and owner:

{{WebSeedList}}

If you own a web server and want to add it to the list of web seeds, tell us on [https://forums.unvanquished.net/viewtopic.php?p=18849#p18849 forums], as this will need some configuration from us to add your server to the seeds.

Web seeds can only be added to new torrent files. So when contributing a new web seed, only the following releases will benefit from them.

= Torrent RSS =

We provide an RSS feed for the latest torrent file:

* {{code|https://cdn.unvanquished.net/current-torrent.rss}}

This feed always provide the link for the latest torrent for the latest game version. Some BitTorrent software has features to automatically download and seed new torrents listed in such feed.

You may use instead this alternate RSS feed making possible to download and seed the next version of the game. It is usually updated in the days preceding the release, to make possible for seeds to be up-to-date at release time.

* {{code|https://cdn.unvanquished.net/upcoming-torrent.rss}}

See [[Tutorials/RSS BitTorrent seeding]] for instructions to configure some BitTorrent software with RSS automatic download and seeding.

Infrastructure/CDN

2026-05-20T16:26:07Z

Illwieckz: /* Seeds */ wording

The '''Unvanquished CDN''' is a network of servers providing seeds for the Unvanquished torrent. The {{launcher}} relies on BitTorrent to download the game.

BitTorrent is a communication protocol for peer-to-peer file sharing (P2P), which enables us to distribute updates over the Internet in a decentralized manner.

= Torrent =

Latest torrent url (same content as the [[Universal zip]]):

* {{code|https://unvanquished.net/download/torrent}} (redirect to latest torrent file)
* {{code|https://cdn.unvanquished.net/current.torrent}} (stable url without redirect)

Direct torrent url and mirrors:

{{WebSeedList|torrent=true}}

Upcoming torrent url:

* {{code|https://cdn.unvanquished.net/upcoming.torrent}} (updated in the days before a new release happens)

= Trackers =

Unvanquished relies on [https://fosstorrents.com FOSS Torrents] as primary BitTorrent tracker and a bunch of other trackers as a fallback.

* {{code|http://fosstorrents.com:6969/announce}}

Here is our page on FOSS Torrents website: https://fosstorrents.com/games/unvanquished/

Since Unvanquished {{code|0.53.2}}, those maintained lists of trackers are used when creating new torrents:

* https://raw.githubusercontent.com/ngosang/trackerslist/master/trackers_all.txt
* https://newtrackon.com/api/stable

Those lists are meant to be up-to-date and to only contain working trackers.

= Seeds =

It is possible to contribute to the CDN in two ways:

* by downloading the files and seed them with a BitTorrent software,
* by providing web seeds.

It happens that downloading files with BitTorrent software using a Torrent RSS is the best way to keep a web seed up to date.

== BitTorrent seeds ==

Any user can contribute this way without having to get in touch with us.

One can simply download the bitTorrent file, add it to a BitTorrent software and make sure the torrent gets configured to not get paused once completed. A good idea is to enable the Super Seeding option for the torrent if the software provides it.

See [[#Torrent RSS|Torrent RSS]] below for details for a way to automatically fetch and seed the files when we distribute a new release.

== Web seeds ==

Those are web servers used as BitTorrent seeds, they provides reliable seeding, especially when no one downloaded the game over BitTorrent yet. Bittorrent clients including the {{launcher}} download game files from there in addition to BitTorrent seeds.

Here are the current Unvanquished web seed servers, with location and owner:

{{WebSeedList}}

If you own a web server and want to add it to the list of web seeds, tell us on [https://forums.unvanquished.net/viewtopic.php?p=18849#p18849 forums], as this will need some configuration from us to add your server to the seeds.

= Torrent RSS =

We provide an RSS feed for the latest torrent file:

* {{code|https://cdn.unvanquished.net/current-torrent.rss}}

This feed always provide the link for the latest torrent for the latest game version. Some BitTorrent software has features to automatically download and seed new torrents listed in such feed.

You may use instead this alternate RSS feed making possible to download and seed the next version of the game. It is usually updated in the days preceding the release, to make possible for seeds to be up-to-date at release time.

* {{code|https://cdn.unvanquished.net/upcoming-torrent.rss}}

See [[Tutorials/RSS BitTorrent seeding]] for instructions to configure some BitTorrent software with RSS automatic download and seeding.

Infrastructure/Distribution

2026-05-20T16:22:31Z

Illwieckz: wording

[[Category:Infrastructure]]
{{InfoDownloadLauncher}}

Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be manually downloaded but requires some manipulations.

Downloading the torrent manually (not using the launcher) requires the same manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux:
** Shortcut: https://unvanquished.net/download/linux (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows:
** Shortcut: https://unvanquished.net/download/windows (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS:
** Shortcut: https://unvanquished.net/download/macos (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* Shortcut: https://unvanquished.net/download/zip (redirection to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* Shortcut: https://unvanquished.net/download/torrent (redirection to the following CDN link)
* CDN: https://cdn.unvanquished.net/{{Current|GameTorrent}}
* CDN: https://cdn.unvanquished.net/current.torrent (stable url without redirection)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:22:04Z

Illwieckz: info launcher

[[Category:Infrastructure]]
{{InfoDownloadLauncher}}

Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

Downloading the torrent manually (not using the launcher) requires the same manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux:
** Shortcut: https://unvanquished.net/download/linux (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows:
** Shortcut: https://unvanquished.net/download/windows (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS:
** Shortcut: https://unvanquished.net/download/macos (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* Shortcut: https://unvanquished.net/download/zip (redirection to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* Shortcut: https://unvanquished.net/download/torrent (redirection to the following CDN link)
* CDN: https://cdn.unvanquished.net/{{Current|GameTorrent}}
* CDN: https://cdn.unvanquished.net/current.torrent (stable url without redirection)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:21:28Z

Illwieckz: wording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

Downloading the torrent manually (not using the launcher) requires the same manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux:
** Shortcut: https://unvanquished.net/download/linux (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows:
** Shortcut: https://unvanquished.net/download/windows (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS:
** Shortcut: https://unvanquished.net/download/macos (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* Shortcut: https://unvanquished.net/download/zip (redirection to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* Shortcut: https://unvanquished.net/download/torrent (redirection to the following CDN link)
* CDN: https://cdn.unvanquished.net/{{Current|GameTorrent}}
* CDN: https://cdn.unvanquished.net/current.torrent (stable url without redirection)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:19:06Z

Illwieckz: wording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux:
** Shortcut: https://unvanquished.net/download/linux (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows:
** Shortcut: https://unvanquished.net/download/windows (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS:
** Shortcut: https://unvanquished.net/download/macos (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* Shortcut: https://unvanquished.net/download/zip (redirection to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* Shortcut: https://unvanquished.net/download/torrent (redirection to the following CDN link)
* CDN: https://cdn.unvanquished.net/{{Current|GameTorrent}}
* CDN: https://cdn.unvanquished.net/current.torrent (stable url without redirection)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:12:39Z

Illwieckz: wording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux: https://unvanquished.net/download/linux (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows: https://unvanquished.net/download/windows (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS: https://unvanquished.net/download/macos (redirection to the following GitHub link)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* https://unvanquished.net/download/zip (redirection to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* https://unvanquished.net/download/torrent (redirection to the latest torrent file)
* https://cdn.unvanquished.net/current.torrent (stable url without redirect)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:09:34Z

Illwieckz: wording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux: https://unvanquished.net/download/linux (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows: https://unvanquished.net/download/windows (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS: https://unvanquished.net/download/macos (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases
* SourceForge mirror: https://sourceforge.net/projects/unvanquished/files/Updaters/

=== Universal zip download ===

Latest universal zip download:

* https://unvanquished.net/download/zip (redirect to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz
* SourceForge download index: https://sourceforge.net/projects/unvanquished/files/

=== BitTorrent download ===

Latest torrent url (zip content):

* https://unvanquished.net/download/torrent (redirect to latest torrent file)
* https://cdn.unvanquished.net/current.torrent (stable url without redirect)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:07:58Z

Illwieckz: wording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An [[Universal zip]] archive can also be downloaded but requires some manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux: https://unvanquished.net/download/linux (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows: https://unvanquished.net/download/windows (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS: https://unvanquished.net/download/macos (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases

=== Universal zip download ===

Latest universal zip download:

* https://unvanquished.net/download/zip (redirect to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz

=== BitTorrent download ===

Latest torrent url (zip content):

* https://unvanquished.net/download/torrent (redirect to latest torrent file)
* https://cdn.unvanquished.net/current.torrent (stable url without redirect)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* SourceForge launcher and zip download index: https://sourceforge.net/projects/unvanquished/files/
* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Infrastructure/Distribution

2026-05-20T16:07:17Z

Illwieckz: rewording

[[Category:Infrastructure]]
Unvanquished is primarily distributed using the {{launcher}} which is an installer, an updater and a launcher.

Users are invited and encouraged to download and run the launcher.

The launcher relies on BitTorrent with web seeds from the [[Infrastructure/CDN|Unvanquished CDN]].

An universal zip archive can also be downloaded but requires some manipulations.

== Downloads ==

=== Download page ===

Download page: https://unvanquished.net/download/

=== Launcher download ===

Latest launcher download:

* Linux: https://unvanquished.net/download/linux (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterLinux.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterLinux.zip
* Windows: https://unvanquished.net/download/windows (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterWin.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterWin.zip
* macOS: https://unvanquished.net/download/macos (redirect)
** GitHub mirror: https://github.com/Unvanquished/updater/releases/download/{{Current|LauncherTag}}/UnvUpdaterOSX.zip
** SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/Updaters/{{Current|LauncherVersion}}/UnvUpdaterOSX.zip

Launcher download index:

* GitHub mirror: https://github.com/Unvanquished/updater/releases

=== Universal zip download ===

Latest universal zip download:

* https://unvanquished.net/download/zip (redirect to the following GitHub link)
* GitHub mirror: https://github.com/Unvanquished/Unvanquished/releases/download/{{Current|GameTag}}/{{Current|GameZip}}
* SourceForge mirror: https://downloads.sourceforge.net/project/unvanquished/{{Current|GameTag}}/{{Current|GameZip}}
* North America/USA/Missouri: https://dl.unvanquished.net/release/{{Current|GameZip}} — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/{{Current|GameZip}} — illwieckz

Latest universal zip download pages:

* GitHub Mirror: https://github.com/Unvanquished/Unvanquished/releases/tag/{{Current|GameTag}}
* SourceForge Mirror: https://sourceforge.net/projects/unvanquished/files/{{Current|GameTag}}/{{Current|GameZip}}/download

Universal zip download index:

* North America/USA/Missouri: https://dl.unvanquished.net/release/ — Ishq
* Western Europe/France: https://dl.illwieckz.net/share/unvanquished/release/ — illwieckz

=== BitTorrent download ===

Latest torrent url (zip content):

* https://unvanquished.net/download/torrent (redirect to latest torrent file)
* https://cdn.unvanquished.net/current.torrent (stable url without redirect)

See details on [[Infrastructure/CDN]] page.

== Stores ==

=== FlatHub ===

* Unvanquished flatpak: https://flathub.org/apps/details/net.unvanquished.Unvanquished

=== Lutris ===

* Builtin installer: https://lutris.net/games/unvanquished/

== Other file hosting services ==

* SourceForge launcher and zip download index: https://sourceforge.net/projects/unvanquished/files/
* IndieDB launcher and zip download index: https://www.indiedb.com/games/unvanquished/downloads

Universal zip

2026-05-20T15:53:49Z

Illwieckz: wording

The Unvanquished universal zip contains the Daemon engine binaries for all supported platforms, plus the DPK packages, for an Unvanquished release. "Universal" refers to the fact that it includes software for multiple operating systems and architectures. It is a reference archive primarily intended for archival. It is not recommended for users to run the game from the universal zip as it may lack convenient integration or may even not run if the operating system does not allow programs to run from random places.

The current universal zip is {{code|{{Current|GameZip}}}}, it distributes Unvanquished {{code|{{Current|GameVersion}}}}.

The current universal zip url is https://dl.unvanquished.net/release/{{Current|GameZip}}.

{{InfoDownloadLauncher}}

However, the launcher may be unsupported for second-tier platforms such as 32-bit x86 Linux or ARM Linux, leaving the universal zip as the only option to acquire official binaries.

* This link should always redirect to the download of the latest universal zip: https://unvanquished.net/download/zip.
* Universal zips starting from Unvanquished version 0.17 can be found at https://dl.unvanquished.net/release/.
* Universal zips for more recent releases can also be found [https://github.com/Unvanquished/Unvanquished/releases on GitHub].
* See [[Infrastructure/Distribution#Universal zip download]] for more mirrors.

The universal zip is produced using scripts from the [https://github.com/Unvanquished/release-scripts release-scripts] repository.

As one of the installation steps, the {{launcher}} downloads the same set of files which are present in the universal zip to the installation directory. However, the source is a [https://en.wikipedia.org/wiki/BitTorrent torrent] rather than a zip file.

Universal zip

2026-05-20T15:53:04Z

Illwieckz: wording

The Unvanquished universal zip contains the Daemon engine binaries for all supported platforms, plus the DPK packages, for an Unvanquished release. "Universal" refers to the fact that it includes software for multiple operating systems and architectures. It is a reference archive primarily intended for archival. It is not recommended for users to run the game from the universal zip as it may lack convenient integration or may even not run if the operating system does not allow programs to run from random places.

The current universal zip is {{code|{{Current|GameZip}}}}, it distributes Unvanquished {{code|{{Current|GameVersion}}}}.

{{InfoDownloadLauncher}}

However, the launcher may be unsupported for second-tier platforms such as 32-bit x86 Linux or ARM Linux, leaving the universal zip as the only option to acquire official binaries.

* This link should always redirect to the download of the latest universal zip: https://unvanquished.net/download/zip.
* The the latest universal zip link is https://dl.unvanquished.net/release/{{Current|GameZip}}.
* Universal zips starting from Unvanquished version 0.17 can be found at https://dl.unvanquished.net/release/.
* Universal zips for more recent releases can also be found [https://github.com/Unvanquished/Unvanquished/releases on GitHub].
* See [[Infrastructure/Distribution#Universal zip download]] for more mirrors.

The universal zip is produced using scripts from the [https://github.com/Unvanquished/release-scripts release-scripts] repository.

As one of the installation steps, the {{launcher}} downloads the same set of files which are present in the universal zip to the installation directory. However, the source is a [https://en.wikipedia.org/wiki/BitTorrent torrent] rather than a zip file.

Linux packages

2026-05-20T14:31:43Z

Illwieckz: wording

Besides the launcher and universal zip, Unvanquished distributions can also be found in some Linux package managers. These are not officially supported by the Unvanquished project.

== Unvanquished update policy ==

The Unvanquished norm is that all players and server owners need to update at the same time when a new major version comes out (e.g. {{code|0.54.x}} → {{code|0.55.0}}). Differing major versions are incompatible. So when using one of the packages below, you should double-check that it is up to date with the official release distributed by the {{launcher}} or the [[Universal zip]].

The current Unvanquished version is {{code|{{Current|GameVersion}}}}.

== Packages ==

The “''Team''” packages are maintained by Unvanquished developers, other packages are maintained by people outside the project and may not be verified.

{| class="wikitable"
|-
! Team !! System !! Package Name !! Package Manager !! Script !! Maintainer
|-
| ✅️ || Flatpak || <code>net.unvanquished.Unvanquished</code> || [https://flathub.org/en/apps/net.unvanquished.Unvanquished Flathub] || [https://github.com/flathub/net.unvanquished.Unvanquished/blob/master/net.unvanquished.Unvanquished.yml source] || afontain, illwieckz
|-
| ✅️ || Arch Linux || <code>unvanquished</code> || [https://aur.archlinux.org/packages/unvanquished AUR] || [https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=unvanquished source] || Viech
|-
| ✅️ || NixOS || <code>unvanquished</code> || [https://mynixos.com/nixpkgs/package/unvanquished Nix] || [https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/un/unvanquished/package.nix source] || afontain
|-
| || Alt Linux || <code>unvanquished</code> || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/ Sysiphus] || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/specfiles/ source] || shad
|}

== Packaging tips ==
* Due to the update policy, Unvanquished may not be suitable for package ecosystems such as Debian's where version stability is expected.
* Any {{code|.dpk}} file must be copied from the official release rather than built, because its hash must match when playing online.
* If you look at the universal zip, <code>pkg/*.dpk</code> plus the contents of the platform-specific zip, minus possibly <code>crash_server</code>, is the bare minimum for a usable install.
* All the {{code|.dpk}} files from a single release (the ones shipped in the universal zip) are required, even if some are listed with a same base name but different versions. This is because we use delta packages, with newer packages extending older ones. For example the Unvanquished 0.55.3 release required both {{code|res-weapons_0.55.3.dpk}} and {{code|res-weapons_0.55.dpk}}, the older one wasn't a leftover.
* Other nice-to-have bits are a desktop file, and server scripts from [https://github.com/Unvanquished/Unvanquished/tree/master/dist <code>dist/</code>].
* Supported architectures for Unvanquished are <code>amd64</code> (x86-64), <code>i686</code> (x86), <code>armhf</code> (32-bit ARM with hard float), and <code>arm64</code>.
* If downloads are discouraged/forbidden by the package system, you will need to bundle the NaCl runtime dependencies in the package.
* Besides the NaCl runtime and Unvanquished gamelogic, you probably want to avoid using pre-built binaries. Pass <code>-DUSE_EXTERNAL_DEPS_LIBS=OFF</code> to CMake to avoid this.

Linux packages

2026-05-20T14:30:22Z

Illwieckz:

Besides the launcher and universal zip, Unvanquished distributions can also be found in some Linux package managers. These are not officially supported by the Unvanquished project.

== Unvanquished update policy ==

The Unvanquished norm is that all players and server owners need to update at the same time when a new major version comes out (e.g. {{code|0.54.x}} → {{code|0.55.0}}). Differing major versions are incompatible. So when using one of the packages below, you should double-check that it is up to date with the official release distributed by the {{launcher}} or the [[Universal zip]].

The current Unvanquished version is {{code|{{Current|GameVersion}}}}.

== Packages ==

The “''Team''” packages are maintained by Unvanquished developers, other packages are maintained by people outside the project and may not be verified.

{| class="wikitable"
|-
! Team !! System !! Package Name !! Package Manager !! Script !! Maintainer
|-
| ✅️ || Flatpak || <code>net.unvanquished.Unvanquished</code> || [https://flathub.org/en/apps/net.unvanquished.Unvanquished Flathub] || [https://github.com/flathub/net.unvanquished.Unvanquished/blob/master/net.unvanquished.Unvanquished.yml source] || afontain, illwieckz
|-
| ✅️ || Arch Linux || <code>unvanquished</code> || [https://aur.archlinux.org/packages/unvanquished AUR] || [https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=unvanquished source] || Viech
|-
| ✅️ || NixOS || <code>unvanquished</code> || [https://mynixos.com/nixpkgs/package/unvanquished Nix] || [https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/un/unvanquished/package.nix source] || afontain
|-
| || Alt Linux || <code>unvanquished</code> || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/ Sysiphus] || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/specfiles/ source] || shad
|}

== Packaging tips ==
* Due to the update policy, Unvanquished may not be suitable for package ecosystems such as Debian's where version stability is expected.
* Any {{code|.dpk}} file must be copied from the official release rather than built, because its hash must match when playing online.
* If you look at the universal zip, <code>pkg/*.dpk</code> plus the contents of the platform-specific zip, minus possibly <code>crash_server</code>, is the bare minimum for a usable install.
* All the {{code|.dpk}} files from a single release (the ones shipped in the universal zip) are required, even if some are listed with same base name but different versions. This is because we use delta packages, with newer packages extending older ones. For example the Unvanquished 0.55.3 release required both {{code|res-weapons_0.55.3.dpk}} and {{code|res-weapons_0.55.dpk}}, the older one wasn't a leftover.
* Other nice-to-have bits are a desktop file, and server scripts from [https://github.com/Unvanquished/Unvanquished/tree/master/dist <code>dist/</code>].
* Supported architectures for Unvanquished are <code>amd64</code> (x86-64), <code>i686</code> (x86), <code>armhf</code> (32-bit ARM with hard float), and <code>arm64</code>.
* If downloads are discouraged/forbidden by the package system, you will need to bundle the NaCl runtime dependencies in the package.
* Besides the NaCl runtime and Unvanquished gamelogic, you probably want to avoid using pre-built binaries. Pass <code>-DUSE_EXTERNAL_DEPS_LIBS=OFF</code> to CMake to avoid this.

Linux packages

2026-05-20T14:27:30Z

Illwieckz: Reword packages, add Alt Linux package, tell those that are maintained by the team and then verified

Besides the launcher and universal zip, Unvanquished distributions can also be found in some Linux package managers. These are not officially supported by the Unvanquished project.

== Unvanquished update policy ==

The Unvanquished norm is that all players and server owners need to update at the same time when a new major version comes out (e.g. {{code|0.54.x}} → {{code|0.55.0}}). Differing major versions are incompatible. So when using one of the packages below, you should double-check that it is up to date with the official release distributed by the {{launcher}} or the [[Universal zip]].

The current Unvanquished version is {{code|{{Current|GameVersion}}}}.

== Packages ==

The “''Team''” packages are maintained by Unvanquished developers, other packages are maintained by people outside the project and may not be verified.

{| class="wikitable"
|-
! Team !! System !! Package Name !! Package Manager !! Script !! Maintainer
|-
| ✅️ || Flatpak || <code>net.unvanquished.Unvanquished</code> || [https://flathub.org/en/apps/net.unvanquished.Unvanquished Flathub] || [https://github.com/flathub/net.unvanquished.Unvanquished/blob/master/net.unvanquished.Unvanquished.yml source] || afontain, illwieckz
|-
| ✅️ || Arch Linux || <code>unvanquished</code> || [https://aur.archlinux.org/packages/unvanquished AUR] || [https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=unvanquished source] || Viech
|-
| ✅️ || NixOS || <code>unvanquished</code> || [https://mynixos.com/nixpkgs/package/unvanquished Nix] || [https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/un/unvanquished/package.nix source] || afontain
|-
| || Alt Linux || <code>unvanquished</code> || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/rpms/ Sysiphus] || [https://packages.altlinux.org/en/sisyphus/srpms/unvanquished/specfiles/ source] || shad
|}

== Packaging tips ==
* Due to the update policy, Unvanquished may not be suitable for package ecosystems such as Debian's where version stability is expected.
* Any {{code|.dpk}} file must be copied from the official release rather than built, because its hash must match when playing online.
* If you look at the universal zip, <code>pkg/*.dpk</code> plus the contents of the platform-specific zip, minus possibly <code>crash_server</code>, is the bare minimum for a usable install.
* All the {{code|.dpk}} files from a single release (the ones shipped in the universal zip) are required, even if some are listed with same base name but different versions. This is because we use delta packages, with newer packages extending older ones. For example the Unvanquished 0.55.3 release required both {{code|res-weapons_0.55.3.dpk}} and {{code|res-weapons_0.55.dpk}}, the older one wasn't a leftover.
* Other nice-to-have bits are a desktop file, and server scripts from [https://github.com/Unvanquished/Unvanquished/tree/master/dist <code>dist/</code>].
* Supported architectures for Unvanquished are <code>amd64</code> (x86-64), <code>i686</code> (x86), <code>armhf</code> (32-bit ARM with hard float), and <code>arm64</code>.
* If downloads are discouraged/forbidden by the package system, you will need to bundle the NaCl runtime dependencies in the package.
* Besides the NaCl runtime and Unvanquished gamelogic, you probably want to avoid using pre-built binaries. Pass <code>-DUSE_EXTERNAL_DEPS_LIBS=OFF</code> to CMake to avoid this.

Tools/Crunch

2026-05-20T13:32:29Z

Illwieckz: Update features list

[[Category:Tools]]
[https://github.com/DaemonEngine/crunch Crunch] is a texture compressor producing formats optimized for both GPU processing and distribution.

Unvanquished recommends the [https://github.com/DaemonEngine/crunch Dæmon Crunch] which is maintained by ourselves and is based on the Unity version.

The {{code|crunch}} tool was initially written by BinomialLLC then improved by Unity. Neither BinomialLLC neither Unity have merged our fixes and do not seem to have any interest in merging fixes provided by others, so we not only maintained our own fork to host our own fixes, but also started to also merge fixes from others. [https://github.com/DaemonEngine/crunch Dæmon Crunch] is then the most maintained and up-to-date Crunch available.

==Sources==

The Dæmon Crunch source repository is: [https://github.com/DaemonEngine/crunch github.com/DaemonEngine/crunch].

The repository provides the '''crunch''' tool, the '''crnlib''' library to provide full compression/decompression support to third-party applications, and the {{code|crn_decomp.h}} header-only library which is enough to transcode the Crunch CRN data for GPU upload and is perfect for lightweight integration in renderers. Some examples implementing various kinds of integrations are provided.

==Portability==

We take care of cross-platform compatibility and we make sure the tool is buildable with CMake.

The [https://github.com/DaemonEngine/crunch Dæmon Crunch source repository] is known to build with various compilers, and the Dæmon {{code|crunch}} tool is known to run on Linux, Windows, macOS and FreeBSD systems on various hardware architectures.

==Quality==

A continuous integration pipeline is configured to test the building of the tool and the library themselves and to run some tests. The code is frequently submitted to CodeQL static analysis.

==Formats==

Crunch can produce compressed images optimized for performance and game rendering in various formats like DDS, KTX and CRN.

All those three formats are containers for DXT-compressed bitmaps. This DXT-compressed data can be uploaded directly to the GPU memory without decompression, and the GPU can process DXT-compressed data without decompression.

Crunch writes DXT-compressed data in a way an additional compression performs better on them, especially LZMA. For example, produced DDS images are expected to compress well if repackaged in an LZMA-based archive.

The CRN format does all of this in one go: it stores the DXT-compressed data into a custom LZMA container.

The game engine or any other application processing CRN files just have to unpack the LZMA container using provided functions and to upload the DXT-compressed data to the GPU.

The Dæmon crunch sets the {{code|m_userdata0}} header field to {{code|1}} to make it compatible with Unity.

==Performance==

The Dæmon Crunch runs multiple times faster than the original Crunch, thanks to the work done by Unity. Unity people claimed the tool runs 2.5 time faster, and we measured the tool running 4.3 time faster on the Unvanquished corpus. Unity people claimed the tool compresses about 10% better, we measured more than 11% on the Unvanquished corpus. This performance bump comes with a compatibility-breaking change introduced in the Unity branch.

The files produced by the Dæmon Crunch are then readable by both the Unity Crunch and the Dæmon Crunch but not by the original Binomial Crunch, while the files produced by the original Binomial Crunch are not readable by the Unity Crunch and the Dæmon Crunch. The Binomial Crunch isn't maintained anymore.

==Features==

The Dæmon Crunch provides many improvements over the original crunch:

* ✅️ Unity crunch format (runs many time faster and produces smaller files),
* ✅️ Unity crunch metadata (the header is compatible with Unity),
* ✅️ Improved image compatibility (1-bit PNG and horizontally-flipped TGA images are now supported),
* ✅️ Added features and command line options (top mip renormalization and more),
* ✅️ Network file system compatibility,
* ✅️ Optional header-only checksumming,
* ✅️ Multisystem and multiplatform (runs almost everywhere),
* ✅️ CMake toolchain (with many useful build options).

More details and up-to-date information can be found in the [https://github.com/DaemonEngine/crunch/blob/master/README.md project README].

==Support==

The Dæmon crunch is known to be used by the {{engine}} project itself, the {{game}}, the Xonotic game (as DDS converter) and some other games using the Unity game engine. It is also used in production tools like [[Tools/Urcheon|Urcheon]], [[Tools/NetRadiant|NetRadiant]], and [[Tools/Q3map2|Q3map2]].

==How to use Crunch==

{{TODO|explain {{code|-noNormalDetection}} and {{code|-rtopmip}} options}}

Systems

2026-05-20T13:23:30Z

Illwieckz: rewording, add ppc64le, etc.

We provide the {{launcher}} for:

* Linux amd64,
* Windows i686 (runs the amd64 engine on amd64 Windows),
* macOS amd64 (runs the amd64 engine on arm64 macOS).

We provide the [[Universal zip]] for:

* Linux amd64, i686, arm64, armhd,
* Windows amd64, i686,
* macOS amd64 (runs on arm64 macOS with Rosetta2).

The {{engine}} and the {{game}} are known to build and run on:

* {{Subpage|Linux}}:
** {{code|amd64}},
** {{code|i686}},
** {{code|arm64}} with the {{code|armhf}} compatibility for the [[Native Client|NaCl]] loader,
** {{code|armhf}},
** {{code|ppc64le}} when the user provides [https://github.com/ptitSeb/box64 box64] for the [[Native Client|NaCl]] loader,
* {{Subpage|Windows}}:
** {{code|amd64}},
** {{code|i686}};
* {{Subpage|macOS}}:
** {{code|amd64}},
** {{code|arm64}} with the {{code|amd64}} Rosetta2 compatibility for both the engine and the [[Native Client|NaCl]] loader;
** {{code|arm64}} with the {{code|amd64}} Rosetta2 compatibility for the [[Native Client|NaCl]] loader;
* {{Subpage|FreeBSD}}:
** {{code|amd64}} with the Linuxulator compatibility for the [[Native Client|NaCl]] loader.

Linux packages

2026-05-20T12:53:56Z

Illwieckz:

Besides the launcher and universal zip, Unvanquished distributions can also be found in some Linux package managers. These are not officially supported by the Unvanquished project.

== Unvanquished update policy ==

The Unvanquished norm is that all players and server owners need to update at the same time when a new major version comes out (e.g. {{code|0.54.x}} → {{code|0.55.0}}). Differing major versions are incompatible. So when using one of the packages below, you should double-check that it is up to date with the official release distributed by the {{launcher}} or the [[Universal zip]].

The current Unvanquished version is {{code|{{Current|GameVersion}}}}.

== Packages ==

{| class="wikitable"
|-
! System !! Package Name !! Package Manager !! Script !! Maintainer
|-
| Arch Linux || <code>unvanquished</code> || [https://aur.archlinux.org/packages/unvanquished AUR] || [https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=unvanquished source] || Viech
|-
| Flatpak || <code>net.unvanquished.Unvanquished</code> || [https://flathub.org/en/apps/net.unvanquished.Unvanquished Flathub] || [https://github.com/flathub/net.unvanquished.Unvanquished/blob/master/net.unvanquished.Unvanquished.yml source] || afontain, illwieckz
|-
| NixOS || <code>unvanquished</code> || [https://mynixos.com/nixpkgs/package/unvanquished Nix] || [https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/un/unvanquished/package.nix source] || afontain
|}

== Packaging tips ==
* Due to the update policy, Unvanquished may not be suitable for package ecosystems such as Debian's where version stability is expected.
* Any {{code|.dpk}} file must be copied from the official release rather than built, because its hash must match when playing online.
* If you look at the universal zip, <code>pkg/*.dpk</code> plus the contents of the platform-specific zip, minus possibly <code>crash_server</code>, is the bare minimum for a usable install.
* All the {{code|.dpk}} files from a single release (the ones shipped in the universal zip) are required, even if some are listed with same base name but different versions. This is because we use delta packages, with newer packages extending older ones. For example the Unvanquished 0.55.3 release required both {{code|res-weapons_0.55.3.dpk}} and {{code|res-weapons_0.55.dpk}}, the older one wasn't a leftover.
* Other nice-to-have bits are a desktop file, and server scripts from [https://github.com/Unvanquished/Unvanquished/tree/master/dist <code>dist/</code>].
* Supported architectures for Unvanquished are <code>amd64</code> (x86-64), <code>i686</code> (x86), <code>armhf</code> (32-bit ARM with hard float), and <code>arm64</code>.
* If downloads are discouraged/forbidden by the package system, you will need to bundle the NaCl runtime dependencies in the package.
* Besides the NaCl runtime and Unvanquished gamelogic, you probably want to avoid using pre-built binaries. Pass <code>-DUSE_EXTERNAL_DEPS_LIBS=OFF</code> to CMake to avoid this.

Install and play

2026-05-20T12:52:25Z

Illwieckz: Sourceforge don't use the Universal_Zip folder anymore for new releases

== Get started easy ==

You're in a rush? Follow [[Get started easy|few steps to be ready to play]].

== Getting the game ==

{{InfoDownloadLauncher}}

===Launcher===

Most users will want to download the launcher from the [https://unvanquished.net/download download page] on our website.

===Packages===

Linux users may use some alternative [[Linux packages]], they are usually updated later than the launcher and the universal zip, but may offer an integration with the system similar to the launcher.

===Universal zip===

Using the [[Universal zip]] may require for you to have specific knowledge about your operating system to get the game running. Prefer the launcher when possible. The universal zip may be the only option for some less supported platforms.

You can download the universal zip on:

* [https://github.com/Unvanquished/Unvanquished/releases GitHub release page],
* [https://sourceforge.net/projects/unvanquished/files/ SourceForge.net file browser],
* [https://www.indiedb.com/games/unvanquished/downloads IndieDB download page].

More mirrors can be found on the [[Infrastructure/Distribution]] page.

===Building the game===

See [[Coding]] for tips and guides on compiling.

== Running and configuration ==

* Using the [[console]];
* [[Colours]] in names and chat;
* [[Runtime options]] for example screen resolution, game data location;
* [[Creating custom keybinds]];
* [[Optimisations]];
* [[Keybinds]];
* [[GPU compatibility matrix]].

== Compatibility ==

See the [[Systems]] page.

== Bugs ==

Unvanquished has lots of them. We have an extensive [https://github.com/Unvanquished/Unvanquished/issues bugtracker] that we invite you to add your bugs to.

* Have a read of our [[Bug reporting]] and [[Troubleshooting]] pages for tips on making effective reports;
* Search the bugtracker for bugs similar to yours before adding a new one;
* Some of the tips on the [[Testing]] page may be useful.

== Getting in contact ==

The two best ways to get in contact with other community members are:
* through the {{forums}};
* over [[chat]].

== Running Servers ==

* [[Server/Running|Running a server]];
** [[Server/Map layout|Map layout]] — default building locations;
** [[Server/Map rotation|Map rotation]];
** [[Server/Bot skill|Bot skill]].