Sauer Proxy

This program acts as a generic proxy server for Sauerbraten servers with extra features.

Please note that this program is still experimental and unstable. Use at your own risk.

Features

• Relay all ENet packets at supplied port between clients and a remote host.
• Relay all UDP packets at supplied port +1 for extinfo.
• Optional delay for most packet types in the server->client direction.
• Master server registration.
• Real IP address forwarding (see below).

Building

1. Install Rust, Clang, and CMake (see enet build requirements).
2. Run cargo build or cargo build --release
3. Start the executable as ./target/debug/sauer-proxy or ./target/release/sauer-proxy.

Usage

Usage:
    ./sauer-proxy [OPTIONS] [REMOTE_HOST]

Sauerbraten proxy server.

positional arguments:
  remote_host           IP address of remote server

optional arguments:
  -h,--help             show this help message and exit
  -l,--listen-port LISTEN_PORT
                        port on which to listen (default: 28785)
  -r,--remote-port REMOTE_PORT
                        port of remote server (default: 28785)
  -d,--delay DELAY      delay server->client packets by this many milliseconds
                        (default: 5000)
  -m,--register-master  register this server with the master server (default:
                        false)
  -f,--forward-ips      forward real player IP addresses to server (requires
                        compatible server mod, default: false)

Usage via Docker

1. Build using docker build -t sauer-proxy .
2. Run using docker run -it --rm --network host sauer-proxy (amend the CLI arguments you need)

Real IP Address Forwarding

To enable this feature, you must use a compatible Sauerbraten server such as p1xbraten. This allows display of a player's real country name instead of the proxy's, and prevents banning the proxy server.

See https://github.com/sauerbraten/p1xbraten#proxy_setippatch for information on how to use it.