OrbisProxy

⚠️ Deprecation Notice ⚠️

Better alternative can be found here: OrbisManager - Multi Server Network

OrbisProxy is a lightweight, high-performance proxy written in Go (not Java). It is designed for reliability, scalability with built-in load balancing, player transfers, automatic fallback handling, and plugin support.

Features

• Written in Go for low memory usage and high performance
• Server with load balancing strategies
• Player transfer system
• Automatic fallback handling
• Hostname-based routing to specific backend servers
• Multi-language support with per-player localization (en, de, zh, es, ru)
• Plugin extensibility
• Hot-Reloadable Lua Plugins: Lua Plugin API
• (Planned) Go Plugin API (Linux only) for advanced plugin extensibility

Concepts

Load Balancing

Pools group multiple servers and distribute players automatically using a strategy like round-robin.

Example: If you transfer a player to a pool name, OrbisProxy automatically selects the target server based on the pool strategy.

Fallback

If a backend server crashes or becomes unreachable, all players are automatically moved to the configured fallback server.

Commands

See Commands on Github

Plugin and ClientReferral Transfers

Transfers can also be triggered by other plugins or by using the ClientReferral packet. When using a ClientReferral transfer:

• The host field is interpreted as the target server or pool name
• The port value is ignored
• The host value must be prefixed with: optransfer.<server>

Where <server> is replaced by the server name or pool name defined in the configuration.

Example

By using Hytales build-in /refer command.

To connect to server lobby-1: /refer optransfer.lobby-1 1234
To connect to server lobby-2: /refer optransfer.lobby-2 1234
To connect to pool lobby /refer optransfer.lobby 1234

CLI Parameters

-c "config.yml" Path to configuration file (optional, default: config.yml)

-debug true
Enable debug logging (default: false)

Plugin API

Lua API (Work in Progress)

Quick and easy scripting for lightweight plugins.
See the full Lua API reference here: Lua API Documentation

Go API (Planned)

Advanced plugin development in Go.
Linux only. Windows is not supported.

Backend Server Setup

See Backend Server Setup Guide

Installation (Linux Service)

See Installation (Linux Service) Guide

Installation (Pterodactyl Egg)

See Pterodactyl Egg Guide

Deployment & Support

If you require any specific deployment options or assistance, please feel free to reach out to us on Discord.