Globed Game Server

Running

The simplest way to get the server running is GitHub Actions - click the latest workflow and download the game-server-build artifact, which will contain three executables for different platforms. Extract the one that matches your platform into a dedicated folder somewhere and run it.

There are currently prebuilts for three platforms, for others you need to build manually or use Docker:

• game-server-x64 - Linux x64 build, requires glibc 2.30+ (e.g. Ubuntu 20.04 or later)
• game-server-arm64 - Linux ARM64 build, requires glibc 2.30+
• game-server.exe - Windows x64 build

Alternate ways of running the server include:

• Building yourself
• Docker

Configuring

Check the Server Hosting page for a proper configuration guide

Building

Nightly rust is required. If you have never used Rust, install rustup from https://rustup.rs/ and then ensure you have the latest version by running

rustup toolchain install nightly

While in the server folder, add an override to tell cargo to always use nightly Rust for building the server:

rustup override set nightly

Cap 'n Proto is recommended but not required. If you have troubles installing it, or are getting error: Import failed: /capnp/c++.capnp errors during the server build, you can set the SERVER_SHARED_PREBUILT_DATA=1 environment variable to remove the need for capnp. This is only recommended to do if you aren't planning on changing the schemas!

To build in default configuration, with base features:

cargo build # add --release for release builds

To build with extra features, --features can be passed:

cargo build --features scripting,mimalloc

Possible feature flags:

• all - includes all functional features, does not include stat-tracking and mimalloc
• scripting - enables the Lua scripting module. this feature currently requires closed-source code, and will NOT build!
• stat-tracking - for debugging only tracks every packet of every connection. on Linux, completed connections can be dumped by sending SIGUSR1
• mimalloc - replaces the allocator with MiMalloc

Docker builds

Prebuilt images are available on the GitHub Container Registry, making it very simple to spin up a server like so:

docker run --rm -it  \
    -v ./:/data \
    -p 4349:4349/tcp -p 4349:4349/udp \
    ghcr.io/globedgd/game-server:latest

The container will attempt to create a file at path /data/config.toml if one does not exist. The command above mounts /data to your current directory, making it so that the file appears there. Once you have the file generated, it may be more convenient and secure to change that mount to -v ./config.toml:/data/config.toml.

You can also avoid using the config file altogether by using environment variables for config:

docker run --rm -it \
    -e GLOBED_GS_CENTRAL_URL="qunet://globed.dev" \
    -p 4349:4349/tcp -p 4349:4349/udp \
    ghcr.io/globedgd/game-server:latest

If you want to build the images yourself, docker buildx can be used:

docker buildx build --target <target> --platform <platform> -t game-server:latest .
# to save the image
docker save -o image.tar game-server:latest

<target> must be either runtime-alpine (static linked musl binary, small alpine image) or runtime-debian (glibc linked binary, debian-slim runtime)

<platform> must be either linux/amd64 (x86_64) or linux/arm64

Debian builds include no features, alpine builds include mimalloc. The Github Actions builds are made with buildx and are identical to the builds produced in the runtime-debian image.

The scripting feature cannot be used in musl builds.