Installation

Run Globe with the Standalone Aegis loader, move an existing Velocity proxy over, and pass start options to the proxy.

Before you start

Use Java 21 or newer.
Allow outbound internet access. On first start Globe downloads its libraries and keeps them in the loader's .aegis folder.
If you are replacing Velocity, back up the proxy folder.

Globe is delivered through your personal Aegis loader. Getting started explains the loader, and Installation covers downloading it.

Install

Download the Standalone loader

Download the Standalone loader from the Downloads page of your dashboard. The file is always named Aegis.jar. Put it in the proxy's folder.

Run the loader once

Start it from the proxy's folder. The first run creates aegis.yml next to the jar.

java -Xms1G -Xmx1G -jar Aegis.jar

Put JVM options such as -Xmx before -jar. Anything after Aegis.jar is passed to the proxy, the same as arguments to a Velocity jar.

Choose Globe

Set the product in aegis.yml:

aegis.yml

product: Globe
version: latest
channel: stable
debug: false

Start again

Run the same command. The loader starts Globe. On a new proxy, Globe creates velocity.toml in the proxy's folder, as Velocity does. Configure your servers and forwarding there.

Moving from Velocity

Globe reads the same files as Velocity:

Stop the proxy and take a backup.
Put Aegis.jar in the proxy's folder and follow the steps above.
Start the loader instead of your Velocity jar. Keep velocity.toml, forwarding.secret and plugins/ where they are.

Your existing velocity.toml does not contain Globe's option, and Globe treats it as off. To turn it on, see Seamless server switches.