How to set up a Soulmask server cluster

A cluster links two or more of your Soulmask servers, for example one on Cloud Mist Forest and one on Shifting Sands, so players can take their character from one server to another. Each server keeps its own world: buildings, tribesmen and stored items stay on the server they're on.

What you need

• Two or more Soulmask servers with us. One is the main server; the others connect to it.
• The same Join password on every server of the cluster, or no password on any of them.
• Every server on the same game version: update them together.
• Players who go to a Shifting Sands server need the Shifting Sands DLC.

The main server

1. Sign in to the control panel at panel.chicagoservers.co and open your main Soulmask server.
2. Open the Startup tab and scroll down to Network. Under Extra ports, reserve a port with Protocol TCP + UDP and note it. The other servers connect to it; players never use it. See How to reserve extra ports for a plugin or second service.
3. Set Server ID in the cluster to 1 and Cluster port (main server only) to the port you reserved. Leave Main server address (other servers only) empty.
4. Click Save startup, then Restart at the top of the page.

Each other server

1. Open your other Soulmask server and its Startup tab.
2. Set Server ID in the cluster to a number of its own: 2, then 3 for a third server, and so on.
3. Set Main server address (other servers only) to the main server's IP and its cluster port, for example 203.0.113.25:8790. The IP is in the main server's address at the top of its page (without the port after the colon). Leave Cluster port (main server only) empty.
4. Click Save startup, then Restart at the top of the page.

Turn on travel between servers

Travel between servers is off until you turn it on, on each server players travel from. Either:

• In the game, log in as GM with gm key YourPassword (see How to use admin commands on your Soulmask server) and switch on Cross-server Mode in the GM panel, or
• Click Stop, open the Configs tab, choose Gameplay settings (GameXishu.json), set KaiQiKuaFu to 1 in group 1, click Save and Start the server. If it's back to 0 after a restart, use the GM panel instead.

Players then travel with the cross-server terminal they build in the game.

Good to know

• Set the server IDs before players make characters, and don't change them afterwards: players would lose access to their characters.
• Adding a server that players already have characters on to a cluster takes extra steps. Open a support ticket first and we'll help.
• Mods: give every server of the cluster the same Workshop mods. See How to add Workshop mods to your Soulmask server.

Need help? Open a support ticket and we'll take a look.