Skip to main content

Getting Started with OrbisRouter

OrbisRouter is a binary you run on your server. It listens on port 5520 via QUIC and routes incoming player connections to the right game server based on your routing rules in OrbisManager.

How it works​

How OrbisRouter routes players
  1. A player connects to your domain on port 5520.
  2. OrbisRouter reads the SNI from the QUIC handshake.
  3. Routing rules are evaluated top to bottom.
  4. The player receives a ClientReferral and connects directly to the matching server.
Direct Connect condition required

Every routing rule evaluated by OrbisRouter must include at least one Direct Connect or SNI / Hostname condition. OrbisRouter identifies connections solely by hostname; without this condition, the rule has no way to match an incoming connection and will never fire.

Prerequisites​

  • A server with a public IP address (Linux recommended)
  • A domain managed via DNS (Cloudflare, etc.)
  • An OrbisManager account with an active project
  • At least one server registered in your project

Step 1: Create a Router in OrbisManager​

  1. Open your project in OrbisManager.
  2. Navigate to Router.
  3. Click + Add Router, enter a name, and confirm.
  4. Download the generated config.json.

Step 2: Install OrbisRouter​

Download the latest binary for your platform:

# Linux x64
curl -Lo orbisrouter https://orbismanager.storage.ricosw.de/releases/latest/linux-x64/orbisrouter
chmod +x orbisrouter

Place config.json in the same directory as the binary:

/opt/orbisrouter/
├── orbisrouter
└── config.json

Step 3: Set up DNS​

Create an A record for your player-facing domain pointing to this server's public IP.

Hytale does not support SRV records

You must use a plain A record. SRV records are not supported by the Hytale client.

play.example.com.  IN  A  203.0.113.42

See DNS Setup for a detailed walkthrough.

Step 4: Start OrbisRouter​

./orbisrouter

The router connects to OrbisManager and appears as online in the dashboard within a few seconds.

To run it as a systemd service, see Configuration.

Verifying it works​

Once the router is online:

  • Check the Router page in OrbisManager. The status dot should turn green.
  • Try connecting to play.example.com from Hytale.
  • Player connections will appear in your routing logs.