Home

PortalDF Wiki

PortalDF is a Go library that connects Dragonfly servers to a Portal proxy over Portal's binary socket protocol — authentication, server registration, transfers, player lookups, latency reporting, and draining, plus a ready-to-use set of Dragonfly commands.

Where to start

If you want to...	Go to
Go from zero to a Dragonfly server registered with Portal	Installation
See every Config field	Configuration
Run this server over NetherNet (or mix it with RakNet backends)	Transport Setup
Use the built-in /transfer, /server, /servers commands	Commands
Call the proxy API directly (transfer, find player, latency, draining, etc.)	API Usage

Features

• Connects to the Portal proxy via TCP socket, with automatic reconnection on disconnect
• Registers this server (address, transport, group, weight) and keeps it in sync
• Transfer players between servers, query player info (XUID, IP), list all servers, find a player anywhere on the network
• Receives player latency updates and stale-session disconnect requests from the proxy
• Mark this server as draining so the proxy stops routing new players to it
• Built-in Dragonfly commands: /transfer, /server, /servers
• Supports both RakNet and NetherNet as the transport the proxy dials this server with

Project links

• Source code
• Releases / tags
• Backing proxy: Portal — see its own Wiki for everything on the proxy side (configuration, socket protocol, NetherNet setup on the proxy's player listener, etc.)