master-server/README.md

[![build](https://github.com/alterware/master-server/workflows/Build/badge.svg)](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

## Build
- Install [*Premake5*](https://premake.github.io) and add it to your system PATH
- Clone this repository
- 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**
For Unix systems, you must use Clang to compile this project. You will also be required to install the LLVM C++ Standard library to run this program.
If you need to use another compiler, like GCC, you must use the [Mold](https://github.com/rui314/mold) linker. Additionally, you may have to tweak the Premake5.lua script.
I only support a few platforms, for more details see [build.yml](https://github.com/alterware/master-server/blob/master/.github/workflows/build.yml)
init 2023-05-26 10:09:29 -04:00			`[![build](https://github.com/alterware/master-server/workflows/Build/badge.svg)](https://github.com/alterware/master-server/actions)`


			`# AlterWare: Master Server`
maint: Add some useful information to the README 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`

			`## Build`
fix: Update the README 2023-12-01 10:14:51 -05:00			`- Install [Premake5](https://premake.github.io) and add it to your system PATH`
maint: Add some useful information to the README 2023-12-01 10:14:13 -05:00			`- Clone this repository`
			- 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)

fix: Update the README 2023-12-01 10:14:51 -05:00			`IMPORTANT`
			`For Unix systems, you must use Clang to compile this project. You will also be required to install the LLVM C++ Standard library to run this program.`
build(premake): do not hardcode Premake5.lua to use clang (#53) 2023-12-08 10:07:01 -05:00			`If you need to use another compiler, like GCC, you must use the [Mold](https://github.com/rui314/mold) linker. Additionally, you may have to tweak the Premake5.lua script.`
			`I only support a few platforms, for more details see [build.yml](https://github.com/alterware/master-server/blob/master/.github/workflows/build.yml)`