Installation

Install the Aegis loader on Paper, Velocity or a standalone JVM, add your products, choose release channels and update.

Before you start

Java. The loader runs on Java 17 or newer. Many products need a newer version. Aegis checks this when it loads a product and prints, for example, product needs Java 25 but this server runs Java 21. Each product's section lists its Java version.
Folia isn't supported. On Folia, Aegis refuses to start any products and keeps logins closed.
Internet access. The server must reach Aegis every time it starts, because products are downloaded fresh on each start.

Download the loader

Open Downloads in your dashboard.

Choose the platform: Spigot / Paper, Velocity, or Standalone JVM (for Saturn and Globe). No product ships a BungeeCord build.
Choose your licence.
Hold the button to generate the loader. Your browser saves it as Aegis.jar.

One loader per platform loads every product on your licence.

Paper and Velocity

Add the loader

Stop the server or proxy and put Aegis.jar in its plugins folder.

Start it once

Aegis verifies your licence and writes config.yml in its own folder: plugins/Aegis/ on Paper, plugins/aegis/ on Velocity. Until you add a product it prints No products are enabled in config.yml, so Aegis has nothing to load.

List your products

Add each product under products, using its name. For example:

plugins/Aegis/config.yml

products:
  Tachyon:
    enabled: true
    release: latest
    channel: stable
    required: true

Restart

Aegis activates the server on first start, downloads each product and starts it. Each product keeps its own config and data in a folder beside the Aegis folder, for example plugins/Tachyon/.

Product settings

A product only needs the settings you want to change. Everything else uses the defaults.

Key	Default	What it does
`enabled`	`true`	Set `false` to keep the entry but not load the product.
`release`	`latest`	`latest` runs the newest release on the channel. A version number, such as `1.4.2`, keeps the server on that release.
`channel`	`stable`	Which release channel to follow. See Release channels.
`required`	`true`	`true`: if the product fails to start, logins stay closed. `false`: the server opens without it.

The generated file starts with a header showing who the loader is licensed to and when it was downloaded. Aegis never rewrites config.yml after creating it.

Standalone (Saturn and Globe)

Saturn and Globe are whole server applications, so the loader runs them directly instead of as a plugin.

Add the loader

Put Aegis.jar in the application's working directory, for example your Saturn server folder.

Generate aegis.yml

Run java -jar Aegis.jar once. Aegis writes aegis.yml and stops, because no product is set yet.

Set the product and start

Set product, then start it again with the application's normal arguments after Aegis.jar.

aegis.yml

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

Key	Default	What it does
`product`	empty	The product this server runs, for example `Saturn` or `Globe`.
`version`	`latest`	`latest` runs the newest release on the channel, or set a version number to stay on it.
`channel`	`stable`	Which release channel to follow.
`debug`	`false`	`true` prints every download and extra startup detail. Leave it off unless support asks.

Aegis keeps its own files in a hidden .aegis folder next to aegis.yml. If the product fails to start, the process exits.

Release channels

stable is the default and the right choice for most servers. Prerelease channels (beta and alpha) only work for a product after staff have enabled them on your licence. If they haven't, the product fails to start with your license does not include it. If a channel has no release for your platform, you'll see no matching release, check its release and channel.

Updates

There is no separate update step. With release: latest (or version: latest on standalone), every restart downloads the newest release on your channel. To stay on one release, set the version number instead. The console shows each product's version as it downloads, followed by (latest on stable) or (pinned).

To update the loader itself, download a new Aegis.jar and replace the old file. Keep the rest of the Aegis folder.

Products that need other products

Some products build on others. Aegis loads a product's dependencies with it and starts them first. In the console they're marked (dependency). Your licence must include them, or the product fails to start with your license does not include it.

If a product needs a normal plugin that isn't a Scala product, Aegis names it, for example needs the packetevents plugin, add it to plugins/ and restart.

While the server starts

On Paper and Velocity, players who join before Aegis is ready are turned away with This server is starting up. Try again in a moment. When everything is running, Aegis prints Aegis is ready, players can now join and a summary:

Launch results: 2 succeeded, 0 failed in 4.1 s

If Aegis can't be reached

At startup: products can't be downloaded, so nothing starts and logins stay closed. Fix the connection and restart.
While running: your products keep running. Aegis keeps retrying in the background and running servers keep going through an outage of up to seven days.
If your licence is revoked or the product is removed from it, the products stop.

When products stop on a plugin server, new logins are refused until you fix the cause and restart. See Troubleshooting for the exact messages.

Moving or rebuilding a server

Each server's activation is stored in installation.json inside the Aegis folder (.aegis/ on standalone). Keep that file when you update or move the server. Without it, Aegis activates the server again as a new installation. In containers and pods, keep the Aegis folder on persistent storage. See Licences and servers.