Soulmask Server Setup Guide: Difference between revisions
(Updated for Soulmask 1.0 launch: updated server requirements, added game modes, launch parameters, maps, cross-map linking, GameXishu.json, file locations) |
|||
| Line 1: | Line 1: | ||
Creating a Soulmask game server is an easy process that can be done from either a dedicated server or your home computer. Alternatively, you can choose a Soulmask server that will fit your needs. | Creating a Soulmask game server is an easy process that can be done from either a dedicated server or your home computer. Alternatively, you can choose a [https://www.survivalservers.com/game-servers/soulmask/ Soulmask server] that will fit your needs. | ||
'''Note:''' Soulmask 1.0 launched on April 10, 2026, bringing the game out of Early Access. This guide has been updated for the 1.0 release. | |||
== Option #1: Renting a Soulmask server (see example control panel below!) == | == Option #1: Renting a Soulmask server (see example control panel below!) == | ||
| Line 6: | Line 8: | ||
== Option #2: Creating a Soulmask Server From Your Home Computer or Dedicated Server == | == Option #2: Creating a Soulmask Server From Your Home Computer or Dedicated Server == | ||
== Server Requirements == | == Server Requirements == | ||
Windows | * Windows 10 64-bit or Windows Server 2019 (minimum) | ||
* Quad Core processor recommended (minimum Dual Core) | |||
* '''12GB RAM minimum''' (16GB recommended) | |||
* 30GB free disk space (more if running both maps) | |||
* Ports: UDP 8777 (game), UDP 27015 (query), TCP 18888 (telnet console), TCP 19000 (RCON) | |||
== Game Modes == | |||
Soulmask 1.0 introduces '''three distinct game modes''': | |||
* '''Survival Mode''' — The classic experience with rebalanced mid-to-late game progression. This is the default mode from Early Access, now refined for 1.0. | |||
* '''Tribe Mode''' — Focuses on tribesman management, automation, and civilization building. Includes a Tribe Upgrade System, a unique Tech Tree tied to Tribe Level, random merchant events, a reputation system, and more aggressive invasions with Invasion Totems. | |||
* '''Warrior Mode''' — A combat-heavy speedrun mode. Near-death state, building decay, invasions, and inventory drops on death are disabled. You start with a blank character (Common quality, no talents) plus a starter gear kit. Features more enemies, smarter AI, nerfed dodge i-frames, and accelerated progression. | |||
All modes remain fully customizable through the GameXishu.json configuration system (see below). | |||
== Setting up a Soulmask Dedicated Server == | == Setting up a Soulmask Dedicated Server == | ||
== Step 1: Fetching Game Server files == | === Step 1: Fetching Game Server Files === | ||
# Create a folder where you wish to store your Soulmask game server hosting files (e.g., <code>C:\SoulmaskServer</code>). | |||
# Download [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD] and extract it into your server folder. | |||
# Create a batch file named '''UpdateSoulmask.bat''' with the following content: | |||
<pre> | |||
@echo off | |||
steamcmd.exe +login anonymous +force_install_dir C:\SoulmaskServer +app_update 3017310 validate +quit | |||
</pre> | |||
# Right-click '''UpdateSoulmask.bat''' and Run as Administrator. | |||
# Wait for the download to complete. The server files will be in your install directory. | |||
=== Step 2: Setting up the Dedicated Server === | |||
Create a batch file named '''StartServer.bat''' in your server folder with the following content: | |||
<pre> | |||
WSServer-Win64-Shipping.exe Level01_Main -server -log -UTF8Output -forcepassthrough -MULTIHOME=0.0.0.0 -Port=8777 -QueryPort=27015 -EchoPort=18888 -SteamServerName="My Soulmask Server" -MaxPlayers=50 -PSW="joinpassword" -adminpsw="adminpassword" -pve -saving=300 -backup=900 -online=Steam -rconpsw="rconpassword" -rconaddr=0.0.0.0 -rconport=19000 | |||
</pre> | |||
'''Important:''' Replace the passwords and server name with your own values. Remove <code>-PSW="joinpassword"</code> if you don't want a join password. | |||
=== Step 3: Port Forwarding === | |||
Forward the following ports on your router: | |||
{| class="wikitable" | |||
|- | |||
! Port !! Protocol !! Purpose | |||
|- | |||
| 8777 || UDP || Game connections | |||
|- | |||
| 27015 || UDP || Steam server browser / query | |||
|- | |||
| 18888 || TCP || Telnet admin console (optional, local only recommended) | |||
|- | |||
| 19000 || TCP || RCON remote console (optional) | |||
|} | |||
== Server Launch Parameters == | |||
{| class="wikitable" | |||
|- | |||
! Parameter !! Default !! Description | |||
|- | |||
| <code>-server</code> || — || Required. Launches in dedicated server mode. | |||
|- | |||
| <code>-log</code> || — || Enables console logging. | |||
|- | |||
| <code>-UTF8Output</code> || — || Enables Unicode/non-Latin character support. | |||
|- | |||
| <code>-forcepassthrough</code> || — || Required parameter. | |||
|- | |||
| <code>-MULTIHOME=IP</code> || 0.0.0.0 || Bind to a specific network interface. | |||
|- | |||
| <code>-Port=PORT</code> || 8777 || UDP game port for player connections. | |||
|- | |||
| <code>-QueryPort=PORT</code> || 27015 || UDP Steam query port for server browser. | |||
|- | |||
| <code>-EchoPort=PORT</code> || 18888 || TCP telnet console port. | |||
|- | |||
| <code>-SteamServerName="NAME"</code> || — || Server name shown in server browser. | |||
|- | |||
| <code>-MaxPlayers=N</code> || 60 || Maximum concurrent players (up to 70). | |||
|- | |||
| <code>-PSW="PASSWORD"</code> || — || Password required to join the server. | |||
|- | |||
| <code>-adminpsw="PASSWORD"</code> || — || GM/admin password for in-game admin panel. | |||
|- | |||
| <code>-pve</code> || — || Enables PvE mode. | |||
|- | |||
| <code>-pvp</code> || — || Enables PvP mode. | |||
|- | |||
| <code>-saving=SECONDS</code> || 300 || Memory save interval in seconds. | |||
|- | |||
| <code>-backup=SECONDS</code> || 900 || Disk backup interval in seconds. | |||
|- | |||
| <code>-initbackup</code> || — || Create a backup on server startup. | |||
|- | |||
| <code>-rconpsw="PASSWORD"</code> || — || RCON password for remote console access. | |||
|- | |||
| <code>-rconaddr=IP</code> || 0.0.0.0 || RCON bind address. | |||
|- | |||
| <code>-rconport=PORT</code> || 19000 || RCON TCP port. | |||
|- | |||
| <code>-GongHuiMaxMember=N</code> || 20 || Maximum tribe member count. | |||
|- | |||
| <code>-online=Steam</code> || Steam || Online subsystem (use Steam for public servers). | |||
|} | |||
== Maps == | |||
Soulmask supports two maps: | |||
* '''Cloud Mist Forest''' (default) — The original map. Use <code>Level01_Main</code> as the map parameter. | |||
* '''Shifting Sands''' (DLC) — An Egypt-themed expansion map. Use <code>DLC_Level01_Main</code> as the map parameter. Requires the Shifting Sands DLC. | |||
To run the Shifting Sands map, change the map name in your launch command: | |||
<pre> | |||
WSServer-Win64-Shipping.exe DLC_Level01_Main -server -log ... | |||
</pre> | |||
=== Cross-Map Server Linking === | |||
To allow players to travel between Cloud Mist Forest and Shifting Sands, you need to run '''two servers''' and link them together: | |||
'''Main Server''' (Cloud Mist Forest): | |||
<pre> | |||
WSServer-Win64-Shipping.exe Level01_Main -server -serverid=1 -mainserverport=8781 ... | |||
</pre> | |||
'''Child Server''' (Shifting Sands): | |||
<pre> | |||
WSServer-Win64-Shipping.exe DLC_Level01_Main -server -serverid=2 -clientserverconnect=MAIN_IP:8781 ... | |||
</pre> | |||
'''Requirements:''' | |||
* Both servers must have the same join password (<code>-PSW</code>). | |||
* Server IDs must be unique (e.g., 1 and 2). | |||
* The child server connects to the main server's broadcast port (<code>-mainserverport</code>). | |||
* Players can transfer between maps via an ocean portal. Character data (level, mask, tech tree, tribesmen) transfers, but buildings and resources do not. | |||
== GameXishu.json (Gameplay Settings) == | |||
Soulmask stores its gameplay configuration in <code>GameXishu.json</code>, located at: | |||
<pre> | |||
WS\Saved\GameplaySettings\GameXishu.json | |||
</pre> | |||
This file controls experience rates, resource gathering rates, combat damage, crafting speeds, invasion difficulty, tribe limits, building decay, and many other server settings. If you're renting from Survival Servers, these settings are available through the '''Modify Server Config''' button in the control panel. | |||
Key setting categories include: | |||
* '''Experience & Progression''' — XP multipliers for awareness, character, mask, proficiency, gathering, crafting, and combat. | |||
* '''Resources & Crafting''' — Drop rates for gathering, mining, logging, slaughtering, and crafting speed. | |||
* '''Survival''' — Food/water/durability consumption rates, item decay timers, carry weight, inventory size. | |||
* '''Combat''' — PvE and PvP damage ratios, dodge i-frame duration, structure damage. | |||
* '''Tribe & Taming''' — Recruitment limits, taming speed, animal limits, hibernation settings. | |||
* '''Building''' — Decay rate, repair speed, construction limits, portal settings. | |||
* '''Invasions''' — Heat accumulation, invasion scale/strength, enemy count, cooldown timers, attack windows. | |||
== File Locations == | |||
{| class="wikitable" | |||
|- | |||
! File !! Path | |||
|- | |||
| Server executable || <code>WS\Binaries\Win64\WSServer-Win64-Shipping.exe</code> | |||
|- | |||
| World save || <code>WS\Saved\Worlds\Dedicated\Level01_Main\world.db</code> | |||
|- | |||
| Server config || <code>WS\Saved\Config\WindowsServer\</code> (Engine.ini, Game.ini, GameUserSettings.ini) | |||
|- | |||
| Gameplay settings || <code>WS\Saved\GameplaySettings\GameXishu.json</code> | |||
|- | |||
| Server logs || <code>WS\Saved\Logs\WS.log</code> | |||
|} | |||
== | == SteamCMD App IDs == | ||
{| class="wikitable" | |||
|- | |||
! Platform !! App ID | |||
|- | |||
| Windows Dedicated Server || 3017310 | |||
|- | |||
| Linux Dedicated Server || 3017300 | |||
|} | |||
Revision as of 18:43, 9 April 2026
Creating a Soulmask game server is an easy process that can be done from either a dedicated server or your home computer. Alternatively, you can choose a Soulmask server that will fit your needs.
Note: Soulmask 1.0 launched on April 10, 2026, bringing the game out of Early Access. This guide has been updated for the 1.0 release.
Option #1: Renting a Soulmask server (see example control panel below!)
Option #2: Creating a Soulmask Server From Your Home Computer or Dedicated Server
Server Requirements
- Windows 10 64-bit or Windows Server 2019 (minimum)
- Quad Core processor recommended (minimum Dual Core)
- 12GB RAM minimum (16GB recommended)
- 30GB free disk space (more if running both maps)
- Ports: UDP 8777 (game), UDP 27015 (query), TCP 18888 (telnet console), TCP 19000 (RCON)
Game Modes
Soulmask 1.0 introduces three distinct game modes:
- Survival Mode — The classic experience with rebalanced mid-to-late game progression. This is the default mode from Early Access, now refined for 1.0.
- Tribe Mode — Focuses on tribesman management, automation, and civilization building. Includes a Tribe Upgrade System, a unique Tech Tree tied to Tribe Level, random merchant events, a reputation system, and more aggressive invasions with Invasion Totems.
- Warrior Mode — A combat-heavy speedrun mode. Near-death state, building decay, invasions, and inventory drops on death are disabled. You start with a blank character (Common quality, no talents) plus a starter gear kit. Features more enemies, smarter AI, nerfed dodge i-frames, and accelerated progression.
All modes remain fully customizable through the GameXishu.json configuration system (see below).
Setting up a Soulmask Dedicated Server
Step 1: Fetching Game Server Files
- Create a folder where you wish to store your Soulmask game server hosting files (e.g.,
C:\SoulmaskServer). - Download SteamCMD and extract it into your server folder.
- Create a batch file named UpdateSoulmask.bat with the following content:
@echo off steamcmd.exe +login anonymous +force_install_dir C:\SoulmaskServer +app_update 3017310 validate +quit
- Right-click UpdateSoulmask.bat and Run as Administrator.
- Wait for the download to complete. The server files will be in your install directory.
Step 2: Setting up the Dedicated Server
Create a batch file named StartServer.bat in your server folder with the following content:
WSServer-Win64-Shipping.exe Level01_Main -server -log -UTF8Output -forcepassthrough -MULTIHOME=0.0.0.0 -Port=8777 -QueryPort=27015 -EchoPort=18888 -SteamServerName="My Soulmask Server" -MaxPlayers=50 -PSW="joinpassword" -adminpsw="adminpassword" -pve -saving=300 -backup=900 -online=Steam -rconpsw="rconpassword" -rconaddr=0.0.0.0 -rconport=19000
Important: Replace the passwords and server name with your own values. Remove -PSW="joinpassword" if you don't want a join password.
Step 3: Port Forwarding
Forward the following ports on your router:
| Port | Protocol | Purpose |
|---|---|---|
| 8777 | UDP | Game connections |
| 27015 | UDP | Steam server browser / query |
| 18888 | TCP | Telnet admin console (optional, local only recommended) |
| 19000 | TCP | RCON remote console (optional) |
Server Launch Parameters
| Parameter | Default | Description |
|---|---|---|
-server |
— | Required. Launches in dedicated server mode. |
-log |
— | Enables console logging. |
-UTF8Output |
— | Enables Unicode/non-Latin character support. |
-forcepassthrough |
— | Required parameter. |
-MULTIHOME=IP |
0.0.0.0 | Bind to a specific network interface. |
-Port=PORT |
8777 | UDP game port for player connections. |
-QueryPort=PORT |
27015 | UDP Steam query port for server browser. |
-EchoPort=PORT |
18888 | TCP telnet console port. |
-SteamServerName="NAME" |
— | Server name shown in server browser. |
-MaxPlayers=N |
60 | Maximum concurrent players (up to 70). |
-PSW="PASSWORD" |
— | Password required to join the server. |
-adminpsw="PASSWORD" |
— | GM/admin password for in-game admin panel. |
-pve |
— | Enables PvE mode. |
-pvp |
— | Enables PvP mode. |
-saving=SECONDS |
300 | Memory save interval in seconds. |
-backup=SECONDS |
900 | Disk backup interval in seconds. |
-initbackup |
— | Create a backup on server startup. |
-rconpsw="PASSWORD" |
— | RCON password for remote console access. |
-rconaddr=IP |
0.0.0.0 | RCON bind address. |
-rconport=PORT |
19000 | RCON TCP port. |
-GongHuiMaxMember=N |
20 | Maximum tribe member count. |
-online=Steam |
Steam | Online subsystem (use Steam for public servers). |
Maps
Soulmask supports two maps:
- Cloud Mist Forest (default) — The original map. Use
Level01_Mainas the map parameter. - Shifting Sands (DLC) — An Egypt-themed expansion map. Use
DLC_Level01_Mainas the map parameter. Requires the Shifting Sands DLC.
To run the Shifting Sands map, change the map name in your launch command:
WSServer-Win64-Shipping.exe DLC_Level01_Main -server -log ...
Cross-Map Server Linking
To allow players to travel between Cloud Mist Forest and Shifting Sands, you need to run two servers and link them together:
Main Server (Cloud Mist Forest):
WSServer-Win64-Shipping.exe Level01_Main -server -serverid=1 -mainserverport=8781 ...
Child Server (Shifting Sands):
WSServer-Win64-Shipping.exe DLC_Level01_Main -server -serverid=2 -clientserverconnect=MAIN_IP:8781 ...
Requirements:
- Both servers must have the same join password (
-PSW). - Server IDs must be unique (e.g., 1 and 2).
- The child server connects to the main server's broadcast port (
-mainserverport). - Players can transfer between maps via an ocean portal. Character data (level, mask, tech tree, tribesmen) transfers, but buildings and resources do not.
GameXishu.json (Gameplay Settings)
Soulmask stores its gameplay configuration in GameXishu.json, located at:
WS\Saved\GameplaySettings\GameXishu.json
This file controls experience rates, resource gathering rates, combat damage, crafting speeds, invasion difficulty, tribe limits, building decay, and many other server settings. If you're renting from Survival Servers, these settings are available through the Modify Server Config button in the control panel.
Key setting categories include:
- Experience & Progression — XP multipliers for awareness, character, mask, proficiency, gathering, crafting, and combat.
- Resources & Crafting — Drop rates for gathering, mining, logging, slaughtering, and crafting speed.
- Survival — Food/water/durability consumption rates, item decay timers, carry weight, inventory size.
- Combat — PvE and PvP damage ratios, dodge i-frame duration, structure damage.
- Tribe & Taming — Recruitment limits, taming speed, animal limits, hibernation settings.
- Building — Decay rate, repair speed, construction limits, portal settings.
- Invasions — Heat accumulation, invasion scale/strength, enemy count, cooldown timers, attack windows.
File Locations
| File | Path |
|---|---|
| Server executable | WS\Binaries\Win64\WSServer-Win64-Shipping.exe
|
| World save | WS\Saved\Worlds\Dedicated\Level01_Main\world.db
|
| Server config | WS\Saved\Config\WindowsServer\ (Engine.ini, Game.ini, GameUserSettings.ini)
|
| Gameplay settings | WS\Saved\GameplaySettings\GameXishu.json
|
| Server logs | WS\Saved\Logs\WS.log
|
SteamCMD App IDs
| Platform | App ID |
|---|---|
| Windows Dedicated Server | 3017310 |
| Linux Dedicated Server | 3017300 |
