Skip to content
Soulmask

Install a Soulmask server

This guide explains how to install a Soulmask dedicated server: first locally on Windows to test, then on a VPS or dedicated server. System: Linux or Windows. Allow 30 to 60 minutes for a first installation, excluding download time.

Last updated: 10/9/2026

This guide explains how to install a Soulmask dedicated server: first locally on Windows to test, then on a VPS or dedicated server. System: Linux or Windows. Allow 30 to 60 minutes for a first installation, excluding download time.

Step-by-step installation

  1. Check the requirements (CPU, RAM, disk) and choose the host: Windows PC, VPS or dedicated server.

  2. Install SteamCMD and download the server (Steam app 3017300 / 3017310).

  3. On Linux create a non-root user and a dedicated folder; on Windows use a simple folder (e.g. C:\server).

  4. Start the server once to generate its configuration files, then stop it cleanly.

  5. Configure name, password and slot count (see our Soulmask tools to generate the files).

  6. Open ports 8777/UDP, 27015/UDP in the system and provider firewalls; forward them on your router if you host at home.

  7. Test locally (127.0.0.1), then from a connection outside your network.

  8. Create a systemd service (Linux) or a scheduled task (Windows) for automatic startup.

  9. Schedule server backups and updates.

  10. Add your server on game-rank.com/jeux/soulmask to get it known.

Requirements

  • System: Linux or Windows.
  • Hardware (community guidance, not official): RAM 16 GB min.; disk —.
  • Steam account: SteamCMD can download the server with an anonymous login; only players need to own the game.
  • Network: a public IP (or port forwarding) with ports 8777/UDP, 27015/UDP open.
  • Access: SSH (Linux) or Remote Desktop (Windows Server); an SSD is recommended.

Local installation (Windows)

Install SteamCMD (steamcmd.exe) in a dedicated folder, then run the commands below in a command prompt. Then start the server and join it from the game on 127.0.0.1.

steamcmd +force_install_dir C:\soulmask-server +login anonymous +app_update 3017310 validate +quit
cd C:\soulmask-server
REM create StartServer.bat with our Soulmask generator, then run it
StartServer.bat

Installation on a Linux VPS or dedicated server (Ubuntu/Debian)

Create a dedicated user without root rights, install the 32-bit dependencies required by SteamCMD, then download the server. Adapt the user name and folders to your habits.

sudo dpkg --add-architecture i386
sudo apt update && sudo apt install -y curl tar lib32gcc-s1
sudo adduser --disabled-password --gecos "" soulmask
# then, as the soulmask user (sudo -iu soulmask):
mkdir -p ~/steamcmd ~/soulmask-server && cd ~/steamcmd
curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
./steamcmd.sh +force_install_dir ~/soulmask-server +login anonymous +app_update 3017300 validate +quit

Ports to open

Default values; traffic direction is inbound (towards the server).

To change a port, edit it in the server configuration or launch line (-Port, -QueryPort, -EchoPort), then adapt the firewall.

  • 8777/UDP — game traffic
  • 27015/UDP — Steam queries / server list
  • 18888/TCP — telnet console (local only, do not expose)
  • 19000/TCP — RCON (optional, do not expose without a strong password)

Linux firewall (ufw), provider and router

Allow SSH first so you do not lock yourself out, then the game ports. Ports are only reachable if they are also open in the provider firewall (OVH, Hetzner, Scaleway…: "security group" or the panel's network rules).

Hosting at home: create a port forward (NAT) on your router to the server's fixed local IP, for the same ports and protocols. If your ISP uses CGNAT (no public IPv4), forwarding is impossible: ask for a public IP or rent a VPS.

Testing: UDP cannot be tested with a simple web port checker; verify by joining from the game on an outside network (a mobile hotspot, for example) and check the server logs.

sudo ufw allow 22/tcp
sudo ufw allow 8777/udp
sudo ufw allow 27015/udp
sudo ufw enable
sudo ufw status verbose

Windows firewall (netsh)

Run these commands in a command prompt started as administrator. When hosting at home, also add the port forward on your router.

netsh advfirewall firewall add rule name="Soulmask 8777 UDP" dir=in action=allow protocol=UDP localport=8777
netsh advfirewall firewall add rule name="Soulmask 27015 UDP" dir=in action=allow protocol=UDP localport=27015

Automatic start on Linux (systemd)

The service restarts the server after a crash and when the machine boots. Enable it with the commands shown in the block.

[Unit]
Description=Soulmask dedicated server
After=network-online.target
Wants=network-online.target

[Service]
User=soulmask
WorkingDirectory=/home/soulmask/soulmask-server
ExecStart=/home/soulmask/soulmask-server/StartServer.sh
Restart=on-failure
RestartSec=10
KillSignal=SIGINT
TimeoutStopSec=90

[Install]
WantedBy=multi-user.target

# sudo nano /etc/systemd/system/soulmask.service
# sudo systemctl daemon-reload && sudo systemctl enable --now soulmask
# journalctl -u soulmask -f

Automatic start on Windows (scheduled task)

Create a task that runs the start script when Windows boots, under a dedicated account if possible. Adapt the script path.

schtasks /Create /TN "Soulmask Server" /TR "C:\soulmask-server\StartServer.bat" /SC ONSTART /RU SYSTEM /RL HIGHEST
schtasks /Run /TN "Soulmask Server"
schtasks /End /TN "Soulmask Server"

Updates, backups and restarts

Stop the server before any update, back up the data, then restart. Schedule backups with cron (Linux) or Task Scheduler (Windows), and a daily restart if the game leaks memory.

sudo systemctl stop soulmask
/home/soulmask/steamcmd/steamcmd.sh +force_install_dir /home/soulmask/soulmask-server +login anonymous +app_update 3017300 validate +quit
sudo systemctl start soulmask
# Windows uses app 3017310: steamcmd +force_install_dir C:\soulmask-server +login anonymous +app_update 3017310 validate +quit

mkdir -p ~/backups
tar czf ~/backups/soulmask-$(date +%F).tar.gz -C ~/soulmask-server/WS Saved
find ~/backups -name 'soulmask-*.tar.gz' -mtime +14 -delete
# crontab -e   ->   30 4 * * * <the two lines above, as a script>

Listing and finding your server

Once the server is stable, add it on game-rank.com/jeux/soulmask (the website of the owner of these tools) with its connection address, slots, language and version. Direct connection address to share: <IP>:8777 (depending on the game version). Never publish an admin password.

Troubleshooting

  • The server does not appear in the list — cause: query ports closed or server not listed. Fix: open 8777/UDP, 27015/UDP, check name/password and wait a few minutes; join directly by IP to test.
  • Cannot connect from the Internet but fine locally — cause: system/provider firewall, missing port forward or CGNAT. Fix: check all three levels (ufw/Windows, provider, router) and the protocol (UDP/TCP).
  • The server exits at startup or runs out of memory — cause: not enough RAM, missing libraries or wrong working directory. Fix: run it in the foreground, read the logs, add RAM or swap.
  • Players see an incompatible version after a game update — cause: server not updated. Fix: stop it, update it (see the Updates section), then restart.
  • Configuration changes are ignored or overwritten — cause: file edited while the server runs, wrong folder or syntax error. Fix: stop the server, edit the right file, validate the syntax (JSON/XML) and restart.

Frequently asked questions

What machine do I need for a Soulmask server?
Hardware (community guidance, not official): RAM 16 GB min.; disk —.
Which ports should I open?
Open 8777/UDP, 27015/UDP inbound, in the system firewall, at the provider and on your router if needed. These are the default values and can be changed in the server configuration.
Do I need to own the game to host?
The dedicated server is downloaded for free with SteamCMD (anonymous login); only players need to own the game.
How do I update the server?
Stop the server, re-run the SteamCMD command +app_update 3017300 (Linux) / 3017310 (Windows) validate (see the Updates section), then restart. For a beta branch, add -beta <name>.
Can I host at home?
Yes, if your connection has a public IP and you can forward ports on your router. With CGNAT or a weak upload, prefer a VPS or dedicated server.

Tools for your Soulmask server

Soulmask
SoulmaskOpen access
Generate the launch script (StartServer.sh / StartServer.bat) for your Soulmask server: -SteamServerName, -MaxPlayers, -PSW, -adminpsw, -pvp/-pve, -Port, -QueryPort, -EchoPort, -saving, -backup. Free, in your browser.
LaunchConfigurationOpen
Documentation
Soulmask
SoulmaskSign-in required
Import, edit and download the GameXishu.json of your Soulmask server: ExpRatio, CaiJiDiaoLuoRatio…. Free, in your browser.
EditingConfigurationOpen
Documentation