Skip to content

getting-started.md

Latest commit

 

History

History
81 lines (55 loc) · 1.97 KB

getting-started.md

File metadata and controls

81 lines (55 loc) · 1.97 KB
Raw

Getting started

Download a native build

The public rolling development release contains separate client and server archives for:

  • Linux x64 and ARM64
  • Windows x64
  • macOS Intel and Apple Silicon

Extract the matching archive and keep the executable beside its included XML file. Server archives also include scripts/.

# Linux or macOS client
./raksamp-client --config RakSAMPClient.xml --check-config

# Linux or macOS server
./raksamp-server --config RakSAMPServer.xml --check-config

On Windows, use raksamp-client.exe or raksamp-server.exe. The macOS archives are unsigned development builds and may be quarantined by Gatekeeper.

Requirements

  • CMake 3.24+
  • A C++17 compiler
  • Git and network access during the first configure (CMake downloads pinned Lua 5.4.8)

Build

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --parallel
ctest --test-dir build --output-on-failure

Disable a product when iterating:

cmake -S . -B build-client -DRAKSAMP_BUILD_SERVER=OFF
cmake -S . -B build-server -DRAKSAMP_BUILD_CLIENT=OFF

Executables are written to build/bin.

Client

./build/bin/raksamp-client \
  --config client/bin/RakSAMPClient.xml \
  --check-config

./build/bin/raksamp-client \
  --config client/bin/RakSAMPClient.xml

Commands are read from stdin. This works interactively and through pipes used by CI harnesses.

Server

Keep the XML and scripts/ directory together:

./build/bin/raksamp-server \
  --config server/bin/RakSAMPServer.xml \
  --check-config

./build/bin/raksamp-server \
  --config server/bin/RakSAMPServer.xml

Stop with Ctrl+C or SIGTERM.

Containers

docker build --target client -t raksamp-client .
docker build --target server -t raksamp-server .

The runtime user is UID/GID 10001. Ensure mounted files are readable and mounted directories are writable when logs or server state must persist.