Documentation menu

Documentation

Set up Link on your network.

Link moves players between your Hytale servers with a signed pass, and picks the best server for /play. These pages cover installing it, every setting, and the Java API for your own plugins.

  1. 1 Put the jar in the mods folder of every server and start each one once.
  2. 2 Choose how your servers find each other: a shared file, Redis or Cloudflare.
  3. 3 Type /servers in game, then /play <group> to move.
Start installing Download the jar

Getting started

Installation Put Link on every server, let it write its settings file, and join your servers into one network. Configuration Every key in link.json, its default, and the environment variable that overrides it. Commands The commands Link adds, who can use them, and what they print.

Registries

Choosing a registry How your servers find each other, and which of the three options fits your network. Shared file The default registry. List every server in link.json and put the same file on each one. Redis Servers add themselves to a Redis you run and report their player counts every few seconds. Cloudflare A free registry that runs on your own Cloudflare account. Deploy it in one click, nothing to run yourself.

Guides

Matchmaking How /play picks a server, and when to use fill or spread. Lobby-only game servers Turn on requireTicket so players can only reach a game server through your lobby.

Developers

Java API Move players, find them, and read the network from your own Hytale plugins. Registry protocol The small HTTP protocol behind the http backend, for writing your own registry.

Reference

Security model What a transfer ticket proves, what Link protects against, and what it doesn't. Troubleshooting What Link's log messages mean and how to fix the common problems.