Skip to content

Multiserver Architecture

Hytale has native support for routing players between servers. No reverse proxy like BungeeCord is required.

Built-in mechanisms for server networks:

FeatureDescriptionStatus
Player ReferralTransfer connected playersAvailable
Connection RedirectRedirect during handshakeAvailable
Disconnect FallbackAuto-reconnect to fallback serverComing Soon

Transfers a connected player to another server.

PlayerRef.referToServer(@Nonnull final String host, final int port, @Nullable byte[] data)

How it works:

  1. Server sends referral packet with target host, port, and optional payload (up to 4KB)
  2. Client opens new connection to target
  3. Client presents payload during handshake

Use cases:

  • Transferring between game servers
  • Passing session context
  • Gating access behind matchmaking

Coming soon: Array of targets tried in sequence for fallback connections.

Redirect players during the connection handshake before they fully join.

PlayerSetupConnectEvent.referToServer(@Nonnull final String host, final int port, @Nullable byte[] data)

Use cases:

  • Load balancing
  • Regional server routing
  • Enforcing lobby-first connections

The client automatically connects to the redirected address.

When a player unexpectedly disconnects (server crash, network interruption), they automatically reconnect to a pre-configured fallback server instead of returning to the main menu.

Use cases:

  • Returning players to lobby after game server crash
  • Maintaining engagement during server restarts

For advanced network setups, build custom proxy servers using:

  • Netty QUIC
  • Packet definitions from com.hypixel.hytale.protocol.packets

This allows you to:

  • Decode and inspect traffic
  • Modify packets
  • Forward between clients and backend servers
[Players] → [Lobby Server] → [Game Servers]

Use player referral to move between servers.

[Players] → [Entry Server] → [Game Servers (pool)]
(Connection Redirect)

Entry server redirects to least-loaded game server.

[Players] → [Game Server]
↓ (crash)
[Fallback Lobby]

Players return to lobby automatically on crash.