Soulmask Server Cluster Guide

This article explains how to organize multiple Soulmask game servers into a cluster, enabling players to transfer their characters between them seamlessly.

It is recommended that all servers within a cluster run the same game mode. Mixing different game modes may result in confusing behavior when transferring characters between servers.

You will need to designate one server as the main server for the cluster. In addition to hosting a world, this server will also manage player accounts for the entire cluster. If this server is offline, the client servers will not be able to function.

1. Ensure you already have at least two Soulmask game servers ready.
2. On the main server, open the commandline manager, then go to Custom Commandlines and create a new custom commandline.
3. Add a description, enable the Server ID option, and set its value to 1 to mark it as the main server.
4. Set the map to Cloud Mist Forest, as this is required for the main server. Enable any additional parameters as needed based on your preferences.
5. Save the commandline, then click Select to activate it. The commandline will appear in bold once active.
6. Take note of the mainserverport value from the commandline, as it will be required for the other server.
7. On the second server, create another custom commandline and add a description.
8. Enable the Server ID option again and set its value to 2 to identify it as the second server.
9. Enable the Client Server Connect option and enter the main server’s IP address along with the mainserverport you noted in step 6, using the following format: 123.456.789.0:20000.
10. Set the map to Shifting Sands and enable any other desired options according to your preferences.
11. Save the commandline and select it to activate it.
12. To allow character transfers, enable Cross-server Mode on both servers by editing the GameXishu.json file located in WS/Saved/GameplaySetting. Locate the "KaiQiKuaFu" parameter and set its value to 1. The file contains three sections labeled 0, 1, and 2, each potentially containing the same settings. Section 1 is typically the one to modify, but you may apply the change to all sections if needed.

Note: When shutting down or restarting clustered servers, always start the main server first and shut it down last.

If the main server is shut down while clients are still connected, it may hang. Attempting to shut down client servers afterward may produce errors. If clients server are shut down before the main server, the shutdown process will complete cleanly.

Servers can be started in any order, but client servers will not accept player connections until they have successfully connected to the main server. Starting the main server first is generally recommended.

For players to move between servers in a cluster, they will need to visit the mysterious island in the ocean of either map while controlling a tribesman that is not their initial character.

Interact with the terminal in front of the portal to open a menu where you can select a server to transfer to. Once you confirm, you should get a loading screen and then appear in the other server at the mysterious island portal.