Install the plugin

The plugin runs on Spigot, Paper and Folia, from Minecraft 1.8 through the current release, on Java 8 or newer.

Running Minestom? See install on Minestom.

1. Choose a plan

A new network has no plan until it goes through checkout under Billing in the dashboard, the Free plan included. Until then no server can be added and no backend can connect. See plans and billing.

2. Add the server

In the dashboard, open Networks & servers, pick the network, and choose Add server on the Servers tab. The name you give it is the server-name the plugin uses below.

3. Download the jar

Download the latest release from GitHub releases and drop it in your server’s plugins/ folder.

On Pterodactyl or Pelican

Already on the Paper egg? Upload the jar to plugins/ with the file manager and carry on below.

New server? Import the Paper + Thorium egg (Admin > Nests > Import Egg), create the server with it, and fill in Thorium network token and Thorium server name from Set up plugin. The panel writes them into plugins/Thorium/config.yml on every start, so you can skip step 4.

4. Configure it

Start the server once to generate plugins/Thorium/config.yml, or create it yourself. Set up plugin next to the server in the dashboard shows this snippet already filled in with your network token and this server’s name:

gateway-url: "https://gateway.thorium.ac"
server-token: "your-network-token"
server-name: "Survival"
enforce: true

Key	Meaning
gateway-url	Where the plugin connects. Leave as the default unless you have been given a different endpoint.
server-token	Your network token, shown on the Servers tab of the network. Every backend uses the same one. Treat it like a password: anyone holding it can report telemetry as your network.
server-name	Which server this backend is. Must match a server’s name in the dashboard; backends of the same server share it.
enforce	When true, configured punishments are applied. Set false to observe detections without acting on them.

Caution

Do not commit config.yml to a public repository. Rotate a leaked token from the Network token card on the Servers tab, then give every backend the new value.

5. Restart

Restart the server. On startup the plugin connects to the gateway and logs the result.

6. Add your public address

On the Free plan, setup asks for the address players join on when you add your server, and the finished setup page shows the code to put in your MOTD. See plans and billing for why.

7. Confirm

Run /thorium status in game or from console. See verify it is working for what a healthy result looks like and what to do when it is not.