2023-05-26 10:09:29 -04:00
|
|
|
[](https://github.com/alterware/master-server/actions)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# AlterWare: Master Server
|
2023-12-01 10:14:13 -05:00
|
|
|
This is the master server our clients use. It is based on the DP Master Server (ID Tech) protocol
|
|
|
|
|
|
2024-03-22 11:13:30 -04:00
|
|
|
## Usage
|
|
|
|
|
Run using [Docker][docker-link]
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
docker run -p 20810:20810/udp alterware/master-server:latest
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-01 10:14:13 -05:00
|
|
|
## Build
|
2024-01-15 06:16:25 -05:00
|
|
|
- Install [Premake5][premake5-link] and add it to your system PATH
|
2023-12-14 11:23:26 -05:00
|
|
|
- Clone this repository using [Git][git-link]
|
2023-12-01 10:14:13 -05:00
|
|
|
- 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)
|
|
|
|
|
|
2023-12-01 10:14:51 -05:00
|
|
|
**IMPORTANT**
|
2023-12-14 11:23:26 -05:00
|
|
|
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][build-link]
|
|
|
|
|
|
2024-03-22 11:13:30 -04:00
|
|
|
[docker-link]: https://www.docker.com
|
2023-12-14 11:23:26 -05:00
|
|
|
[premake5-link]: https://premake.github.io
|
2024-01-15 06:16:25 -05:00
|
|
|
[git-link]: https://git-scm.com
|
2023-12-14 11:23:26 -05:00
|
|
|
[mold-link]: https://github.com/rui314/mold
|
|
|
|
|
[build-link]: https://github.com/alterware/master-server/blob/master/.github/workflows/build.yml
|
