How to Set Up a Soulmask Dedicated Server

Option 1: by hand with SteamCMD

The Linux dedicated server is a free, anonymous download from Steam (application 3017300, "Soulmask Dedicated Server For Linux"), about 2.2 GB. The Windows server is a separate application.

1. Install SteamCMD, then run: +force_install_dir ./soulmask +login anonymous +app_update 3017300 validate +quit
2. Start it as a normal user, not root: ./WSServer.sh Level01_Main -server -log -UTF8Output -forcepassthrough -MULTIHOME=0.0.0.0 -Port=8777 -QueryPort=27015 -EchoPort=18888 -SteamServerName="My Server" -MaxPlayers=20 -pve -adminpsw=<password>
3. Use DLC_Level01_Main instead of Level01_Main for the Shifting Sands map, -pvp instead of -pve for PvP, and -PSW=<password> for a join password.
4. Open UDP 8777 (game) and UDP 27015 (Steam query) in your firewall and forward them on your router. The echo port, 18888, is only bound on the machine itself.
5. After the first run, edit WS/Saved/GameplaySettings/GameXishu.json for rates and rules, with the server stopped.

Option 2: Docker

runonflux/soulmask-server-flux, our image (source on GitHub, RunOnFlux/soulmask-server-flux), installs and updates the server on every start and builds the command line from environment variables: SM_SERVER_NAME, SM_MAP, SM_MODE, SM_MAX_PLAYERS, SM_PASSWORD, SM_ADMIN_PASSWORD, SM_MODS, SM_RESTART_TIME, SM_SAVE_MINUTES, GAME_PORT and QUERY_PORT.

• Mount /mnt/soulmask/server on a volume for the 2.2 GB install, and /mnt/soulmask/data on one for the game's Saved folder (worlds, GameXishu.json, ban list) and the image's own settings and backups.
• It runs the server as an unprivileged user, saves the world on the game's console before every stop, restarts a crashed server in place and follows new Steam builds.
• flux-soulmask, inside the container, drives the game's maintenance console (help, lp, say, sav 1, usp, sc), applies presets and makes or restores backups.

Option 3: managed on Flux

Deploy a Soulmask server on the Flux decentralized cloud, on that same image, with the settings as forms, the ports opened and routed for you, DDoS protection included, and a dashboard with the game's own console, about 80 gameplay settings with presets, bans, Workshop mods, a file browser and backups. Plans start at $9.49 a month.

1. Pick the 10, 20 or 40-player plan.
2. Choose a region close to your players.
3. Name the server, pick the map and PvE or PvP, and deploy. The first start downloads about 2.2 GB and builds the world in a few minutes.
4. Players join with the invite code from the dashboard, or by address.