mirror of
https://github.com/alterware/master-server.git
synced 2025-04-22 12:55:43 +00:00
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
[](https://github.com/alterware/master-server/actions)
|
|
|
|
|
|
# AlterWare: Master Server
|
|
This is the master server our clients use. It is based on the DP Master Server (ID Tech) protocol
|
|
|
|
## Usage
|
|
Run using [Docker][docker-link]
|
|
|
|
```
|
|
docker run -p 20810:20810/udp -e AW_STATS_LOCATION=<UTF-8 C-string> alterware/master-server:latest
|
|
```
|
|
|
|
or run as a systemd service
|
|
|
|
```
|
|
[Unit]
|
|
Description=AlterWare Master Server
|
|
After=network.target
|
|
|
|
[Service]
|
|
Type=simple
|
|
ExecStart=<working dir>/alterware-master
|
|
WorkingDirectory=<working dir>
|
|
Environment="AW_STATS_LOCATION=/var/www/<domain name>/html/stats.json"
|
|
StandardOutput=null
|
|
Restart=on-failure
|
|
RestartSec=10
|
|
KillMode=process
|
|
User=<username>
|
|
Group=<group name>
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
```
|
|
|
|
## Build
|
|
- Install [Premake5][premake5-link] and add it to your system PATH
|
|
- Clone this repository using [Git][git-link]
|
|
- Update the submodules using ``git submodule update --init --recursive``
|
|
- Run Premake with either of these two options ``premake5 vs2022`` (Windows) or ``premake5 gmake2`` (Linux/macOS)
|
|
|
|
**IMPORTANT**
|
|
Requirements for Unix systems:
|
|
- Compilation: Please use Clang as the preferred compiler
|
|
- Dependencies: Ensure the LLVM C++ Standard library is installed
|
|
- Alternative compilers: If you opt for a different compiler such as GCC, use the [Mold][mold-link] linker
|
|
- Customization: Modifications to the Premake5.lua script may be required
|
|
- Platform support: Details regarding supported platforms are available in [build.yml](.github/workflows/build.yml). Linux ARM64 should be supported out of the box even if it's not present in the CI scripts
|
|
|
|
[docker-link]: https://www.docker.com
|
|
[premake5-link]: https://premake.github.io
|
|
[git-link]: https://git-scm.com
|
|
[mold-link]: https://github.com/rui314/mold
|