Actions

Difference between revisions of "Dedicated Server Guide"

From Unofficial Stationeers Wiki

m (Brogan: Don't use =)
(misspelt english month of october)
 
(49 intermediate revisions by 15 users not shown)
Line 1: Line 1:
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
  
== Requirements ==
+
== General Requirements ==
* Linux or Windows system, either physical or virtualised,
+
* Linux or Windows system, either physical or virtualized
** must NOT be being used to run a Stationeers client (the game will not permit this).
+
* It is NOT recommended also running a Stationeers client, so '''hosting the server on your PC while playing at the same time might lead to issues'''. (there will be issues with router NAT-loopback).
** if running on Windows you must have the Microsoft Visual C++ 2015 runtime installed, [https://www.microsoft.com/en-us/download/details.aspx?id=52685 click here to download it].
+
* 16 or more Gigabytes of RAM. The server will load with less, but will run out of RAM quickly, potentially leading to instability or crashes.
* ~16GB RAM (Tested and confirmed on Linux). 8GB or less and the server won't load.  
 
  
== Getting the server files ==
+
== Quickstarts & Panels ==
SteamCmd on Windows and Linux<br>
 
https://developer.valvesoftware.com/wiki/SteamCMD
 
  
''This is a command line tool''
+
=== StationeersServerUI ===
 +
 
 +
''Docker + Native Linux & Windows''
 +
 
 +
[https://github.com/SteamServerUI/StationeersServerUI StationeersServerUI] offers an intuitive webUI, easy configuration, smart backups, full steamcmd handling with auto-updates, <br>
 +
a discord integration for your community to interact with the server, tons of other helpful features like a remote console '''and works straight out of the box'''. <br>
 +
Created in 2024 with love and attention to detail, updated regularly by [https://github.com/JacksonTheMaster JacksonTheMaster] & the [https://github.com/orgs/SteamServerUI/people StationeersServerUI Team]
 +
 
 +
=== Pterodactyl ===
 +
[https://github.com/BadDucky52 BadDucky52] has updated the [https://github.com/HaseoTM/parkervcp-eggs/blob/master/game_eggs/steamcmd_servers/stationeers/stationeers_vanilla/egg-stationeers.json older] pterodactyl egg for the current Dedicated Server:<br>
 +
[https://github.com/BadDucky52/PterodactylGameEggs/blob/main/egg-stationeers.json Current Pterodactyl Egg by BadDucky52] <br>
 +
 
 +
== DIY Solutions ==
 +
 
 +
=== Requirements ===
 +
** '''Linux: Glibc 2.38''' (Ubuntu '''24'''.04 LTS, Debian '''Bookworm''' (12), Debian '''Trixie''' (13))
 +
** '''Windows: Microsoft Visual C++ 2015, 2017 and 2019 runtime''' [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 click here to download it].
 +
 
 +
It is, of course, possible to run the server without external images or tools simply by downloading it from SteamCMD and executing it. Everything you ''should'' need is Documented below.
 +
 
 +
=== Getting the server files ===
 +
SteamCmd installed on the operating system you are running the server with. See [https://developer.valvesoftware.com/wiki/SteamCMD The SteamCMD Documentation]
 +
''(This is a command line tool)''
  
 
For the stable branch:
 
For the stable branch:
 +
''(The "stable" branch is what you Download by default when you select Stationeers in your Steam Library)''
  
 
<code>steamcmd +login anonymous +app_update 600760 validate +quit</code>
 
<code>steamcmd +login anonymous +app_update 600760 validate +quit</code>
 
  
 
For the beta branch:
 
For the beta branch:
Line 22: Line 41:
 
<code>steamcmd +login anonymous +app_update 600760 -beta beta validate +quit</code>
 
<code>steamcmd +login anonymous +app_update 600760 -beta beta validate +quit</code>
  
== Default ports ==
+
''For getting back from beta to public use -beta public, SteamCMD has trouble with caching sometimes''
27516: Game port (UDP).<br>
+
 
27015: Steam update port (UDP).
+
=== Default ports ===
 +
27016: Game port (UDP).
 +
27015: Steam update port. (UDP).
 +
 
 +
=== Server Startup Arguments (Post September 2025)===
 +
 
 +
With the release of the [https://store.steampowered.com/news/app/544550/view/533235259603419415 terrain update], the flags the Dedicated Server accepts where changed. <br>
 +
''If you are running an older version (such as the prerocket or preterrain branch, ask on the Stationeers Discord server in either #modding or #dedicated-server''''
  
== Legacy Server Startup Arguments ==
 
 
String parameters can take space with double quotes.
 
String parameters can take space with double quotes.
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! parameter !! value !! etc
+
! Flag !! Value !! Description
|-
 
| -NEW
 
| rowspan=2 | Worldname (string)
 
| rowspan=2 | Starts a new game at specific world automatically from launch. Must provide world name as argument
 
|-
 
| -NEWGAME
 
|-
 
| -LOAD
 
| rowspan=2 | savefolder (string)
 
| rowspan=2 | Loads a saved world file
 
|-
 
| -LOADGAME
 
|-
 
| -JOIN
 
| rowspan=2 | [address]:[port]
 
| rowspan=2 | Joins a client to the server
 
 
|-
 
|-
| -JOINGAME
+
| <code>-file start</code>
 +
| <code><stationname> [worldid] [difficulty] [startcondition] [startlocation]</code>
 +
| Tries to load the latest save for the specified station. If not found, starts a new world with the given parameters and saves it.<br>
 +
- <code>stationname</code>: Required. This is the name of your save.<br>
 +
- <code>worldid</code>: Optional, but required to start a new game if no existing station is found.<br>
 +
- <code>difficulty</code>: Optional, defaults to "Normal" if not provided.<br>
 +
- <code>startcondition</code>: Optional, defaults to the default start condition for the world setting if not provided.<br>
 +
- <code>startlocation</code>: Optional, defaults to "DefaultStartLocation" if not provided.<br>
 +
- '''When you add optional arguments, you cannot leave one out.''' <br> For example, <stationname> [worldid] [startlocation] '''would not work''', <br> you would need to add [difficulty] and [startcondition] too.
 
|-
 
|-
| -SETTINGSPATH
+
| <code>-logFile</code>
| "path"
+
| <code>"path"</code>
| Absolute base directory for custom profile Ex)<br> -basedirectory C:\Profile\Player1 <br> Config Path : default.ini <code>C:\Profile\Player1\</code> <br> Save Path : <code>C:\Profile\Player1\saves\[worldname]</code>
+
| Specifies a custom log file path if <code>output_log.txt</code> is not used. Example:<br>
 +
<code>-logFile "server.log"</code>
 
|-
 
|-
| -logfile|| "path" || If no output_log.txt use this parameter. Check examples below for syntax
+
| <code>-settings</code>
 +
| see below
 +
| Changes the default settings to desired values e.g -settings ServerName "MyNewStationeersServer". '''For a full list and examples, see below.'''
 
|-
 
|-
 
|}
 
|}
batchmode, nographics and logfile are Unity3D commands.
 
 
https://docs.unity3d.com/Manual/CommandLineArguments.html
 
 
== Examples ==
 
 
<span style="font-size: 120%;"> Dedicated server starts new Mars world. </span><br>
 
<code>rocketstation_DedicatedServer.exe -NEW Mars -SETTINGSPATH "C:\Server\User1"</code>
 
 
 
<span style="font-size: 120%;"> Load Mothership file.<br>
 
<code>rocketstation_DedicatedServer.exe -LOAD Mothership</code>
 
 
 
<span style="font-size: 120%;"> Load Mothership file. C:\Profile\Player1\saves\Mothership C:\Profile\Player1\saves\map1 </span><br>
 
<code>rocketstation_DedicatedServer.exe -LOAD Mothership -SETTINGSPATH "C:\Profile\Player1"</code>
 
 
 
<span style="font-size: 120%;"> Example <code>-logfile</code> syntax </span><br>
 
<code>-logFile "C:\Server_Path\rocketstation_DedicatedServer_Data\output_log.txt"</code>
 
 
 
<span style="font-size: 120%;"> Example <code>-LOAD "myworld"</code> directory structure. </span><br>
 
'''Note:''' ''BaseDirectory'' is by default in SteamApps/common/Stationeers Dedicated Server/''<Contents of BaseDirectory>'' if installed with SteamCMD<br>
 
 
 
<big>'''Linux:'''</big><br>
 
<code>-LOAD "myworld"</code> will look for a folder named "myworld" in the ''saves'' directory like this:<br>
 
''BaseDirectory''/saves/myworld/<br>
 
 
 
<big>'''Windows:'''</big><br>
 
<code>-LOAD "myworld"</code> will look for a folder named "myworld" in the ''saves'' directory like this:<br>
 
''BaseDirectory''\saves\myworld\
 
 
 
<big>'''Details:'''</big><br>
 
In the world directory named "myworld", these files must be present:
 
* world.bin
 
* world.xml
 
* world_meta.xml
 
'''Note:''' The names of these files ''do not'' correspond to your custom world name. These will always be called world.bin etc..<br>
 
The server will automatically generate these upon first start. If you are importing another world, make sure these are in place in the correct directory for the server to load them.<br>
 
There is also one more file that will be created:
 
* worldsettings.xml
 
 
===== Configuration from setting.xml =====
 
setting.xml will be created once you start it up for the first time. <u>Command parameters override setting.xml</u>
 
<hr>''The server is mostly a stripped down client as such it inherits certain features''
 
<hr>
 
Example Setting.xml
 
<pre>
 
  <?xml version="1.0" encoding="utf-8"?>
 
  <SettingData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
 
  <AutoSave>true</AutoSave>
 
  <SaveInterval>300</SaveInterval>
 
  <SavePath />
 
 
  <StartingConditions>Default</StartingConditions>
 
  <RespawnCondition>Easy</RespawnCondition>
 
  <HungerRate>0.5</HungerRate>
 
  <SunOrbitPeriod>1</SunOrbitPeriod>
 
 
  <ResearchPoolKey>ResearchOff</ResearchPoolKey>
 
 
  <RoomControlTickSpeed>1</RoomControlTickSpeed>
 
  <WorldOrigin>false</WorldOrigin>
 
 
<ServerName>Stationeers</ServerName>
 
  <StartLocalHost>true</StartLocalHost>
 
  <ServerVisible>true</ServerVisible>
 
  <ServerPassword />
 
  <AdminPassword>randomstringhere</AdminPassword>
 
  <ServerMaxPlayers>10</ServerMaxPlayers>
 
  <UpdatePort>27015</UpdatePort>
 
  <GamePort>27016</GamePort>
 
  <UPNPEnabled>true</UPNPEnabled>
 
  <DisconnectTimeout>10000</DisconnectTimeout>
 
  <NetworkDebugFrequency>500</NetworkDebugFrequency>
 
</pre><hr>
 
  
 +
=== World types (October 2025) ===
 +
''Note:'' RoundRobin StartLocations and Community StartConditions are only available on BETA at the moment.
  
 
{| class="wikitable"
 
{| class="wikitable"
! XML Attribute
 
! Parameter<br>''Case Sensitive''
 
! Details
 
 
|-
 
|-
| <RespawnCondition>
+
! World Name !! WorldID !! Difficulty IDs !! StartCondition IDs !! StartLocation IDs
| Easy, Normal, Stationeer
 
| Or a custom key from a mod.<br>''Seems to be used as spawn conditions instead for new players''
 
 
|-
 
|-
| <StartingConditions>
+
| Lunar (The Moon)
| Default, Minimal, Vulcan, Venus, BareBones
+
| <code> Lunar </code>
| Or a custom key from a mod.<br>''Server ignores this, define custom worldtype''
+
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>DefaultStart, DefaultStartCommunity, Brutal, BrutalCommunity</code>
 +
| <code>LunarSpawnCraterVesper, LunarSpawnMontesUmbrarum, LunarSpawnCraterNox, LunarSpawnMonsArcanus, LunarSpawnRoundRobin</code>
 
|-
 
|-
| <ResearchPoolKey>
 
| ResearchOff, ResearchOn
 
| Or a custom key from a mod.<br>''Server ignores this''
 
 
|-
 
|-
| <SunOrbitPeriod>
+
| Mars
| default=1
+
| <code> Mars2 </code>
| Multiplier on the time it takes for the sun to orbit, default is 20 minutes, 10 minute day 10 night.
+
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>DefaultStart, DefaultStartCommunity, Brutal, BrutalCommunity</code>
 +
| <code>MarsSpawnCanyonOverlook, MarsSpawnButchersFlat, MarsSpawnFindersCanyon, MarsSpawnHellasCrags, MarsSpawnDonutFlats, MarsSpawnRoundRobin</code>
 
|-
 
|-
! colspan=3 | Undocumented
 
 
|-
 
|-
| <UseCustomWorkThreadsCount>false</UseCustomWorkThreadsCount>
+
| Europa
| true, false
+
| <code> Europa3</code>
|
+
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>EuropaDefault, EuropaDefaultCommunity, EuropaBrutal, EuropaBrutalCommunity</code>
 +
| <code>EuropaSpawnIcyBasin, EuropaSpawnGlacialChannel, EuropaSpawnBalgatanPass, EuropaSpawnFrigidHighlands, EuropaSpawnTyreValley, EuropaSpawnRoundRobin</code>
 
|-
 
|-
| <MinWorkerThreads>
 
| number
 
| default=8
 
 
|-
 
|-
| <MinCompletionPortThreads>
+
| Mimas
| number
+
| <code> MimasHerschel</code>
| default=8
+
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>MimasDefault, MimasDefaultCommunity, MimasBrutal, MimasBrutalCommunity</code>
 +
| <code>MimasSpawnCentralMesa, MimasSpawnHarrietCrater, MimasSpawnCraterField, MimasSpawnDustBowl, MimasSpawnRoundRobin</code>
 
|-
 
|-
| <MaxWorkerThreads>100</MaxWorkerThreads>
 
| number
 
| default=100
 
 
|-
 
|-
| <MaxCompletionPortThreads>50</MaxCompletionPortThreads>
+
| Vulcan
| number
+
| <code> Vulcan </code>
| default=50
+
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>VulcanDefault, VulcanDefaultCommunity, VulcanBrutal, VulcanBrutalCommunity</code>
 +
| <code>VulcanSpawnVestaValley, VulcanSpawnEtnasFury, VulcanSpawnIxionsDemise, VulcanSpawnTitusReach, VulcanSpawnRoundRobin</code>
 +
|-
 +
|-
 +
| Venus
 +
| <code> Venus </code>
 +
| <code>Creative, Easy, Normal, Stationeer</code>
 +
| <code>VenusDefault, VenusDefaultCommunity, VulcanBrutal, VulcanBrutalCommunity</code><br>Note: Yes, Venus is using '''Vulcan'''Brutal & '''Vulcan'''BrutalCommunity
 +
| <code>VenusSpawnGaiaValley, VenusSpawnDaisyValley, VenusSpawnFaithValley, VenusSpawnDuskValley, VenusSpawnRoundRobin</code>
 
|-
 
|-
| <CoroutineTimeBudget>1</CoroutineTimeBudget>
 
| number
 
| default=1
 
 
|-
 
|-
 
|}
 
|}
 +
When selecting a start location you can pick ''<WorldID>Random'' to have each new player spawn in a randomly selected location on the map. This is designed to be used with the <WorldID>BrutalCommunity StartCondition which spawns each new player with a brutal start crate.
  
== Savegames ==
+
Tutorial Maps
=== Configuration from worldsettings.xml ===
 
'''Undocumented feature'''
 
 
 
''The server is mostly a stripped down client as such it inherits certain features''
 
 
 
 
{| class="wikitable"
 
{| class="wikitable"
! XML Attribute
 
! Parameter
 
! Details
 
 
|-
 
|-
| <GameMode>
+
! World Name !! WorldID
| Creative, Survival
 
|
 
 
|-
 
|-
| <HungerRate>
 
| default=0.25
 
| Multiplier on the amount of hunger generated per game tick.
 
 
|-
 
|-
| <StartingCondition>
+
| Inventory Tutorial
| N/A
+
| <code> Tutorial1 </code>
| Can only be defined in custom world before generation
 
 
|-
 
|-
|}
+
| Connection Tutorial
 
+
| <code> Tutorial2 </code>
=== Configuration from world.xml ===
 
 
 
{| class="wikitable"
 
! XML Attribute
 
! Parameter
 
! Details
 
 
|-
 
|-
| <ResearchKey>
 
| ResearchOff, ResearchOn
 
| Or a custom key from a mod.
 
 
|-
 
|-
| <RespawnCondition>
+
| Atmospherics Tutorial
| Easy, Normal, Stationeer
+
| <code> Tutorial3 </code>
| Or a custom key from a mod.<br>''Seems to be used as spawn conditions instead for new players''
 
|-
 
|}
 
 
 
 
 
== Server Administrator ==
 
 
 
===In Game Admin===
 
ADMINPASSWORD parameter must be added to setting.xml and set a password.
 
 
 
All commands are typed in the chat (enter) by default, starting with /login
 
 
 
=== Server Program Console===
 
You can type commands in the running application which acts like a console
 
 
 
=== Command Lists ===
 
{| class="wikitable"
 
!Command
 
!Details
 
!Parameter
 
 
|-
 
|-
| HELP
 
| Displays helpful stuff
 
| Arguments:
 
* commands
 
* list (l)
 
* <key>
 
* tofile: prints the help output to file
 
 
|-
 
|-
| CLEAR
+
| Airlocks Tutorial
| Clears all console text ||
+
| <code> Airlock </code>
 
|-
 
|-
| QUIT
 
| immediately quits the game without any prompts
 
|
 
 
|-
 
|-
| EXIT
+
| Furnace Tutorial
| rowspan=2 | Leaves a game session and goes back to 'StartMenu'
+
| <code> FurnaceBasics </code>
| rowspan=2 |
 
 
|-
 
|-
| LEAVE
 
 
|-
 
|-
| NEW
+
| Manufacturing Tutorial
| rowspan=2 | Starts a new game at specific world automatically from launch.Must provide world name as argument
+
| <code> Manufacturing </code>
| rowspan=2 | worldName
 
 
|-
 
|-
| NEWGAME
 
 
|-
 
|-
| LOAD
+
|}
| rowspan=2 | Loads a saved world file
+
 
| rowspan=2 | <foldername>
+
===== Configuration =====
 +
In your server directory, a file called setting.xml will be created once you start it up for the first time. <br>
 +
While you can ''technically'' edit that, '''this approach is not guaranteed to work (bugged for a while)'''. <br>
 +
'''It is recommended to use the -setting flag instead.'''
 +
 
 +
{| class="wikitable"
 
|-
 
|-
| LOADGAME
+
! Setting !! Value !! Description
 
|-
 
|-
| JOIN
+
| ServerVisible
| rowspan=2 | Joins a client to the server
+
| true / false
| rowspan=2 | [address]:[port]
+
| Shows / hides the server in the ingame server list
 
|-
 
|-
| JOINGAME
 
 
|-
 
|-
| STEAM
+
| GamePort
| Commands to test Facepunch API. Just checks if steam is initialised and if DLC is purchased
+
| 27016 / any port
|
+
| The port that players connect to
 
|-
 
|-
| LISTNETWORKDEVICES
 
| No help text :(
 
| id
 
 
|-
 
|-
| TESTBYTEARRAY
+
| UpdatePort
| Tests every item in world to check its network read/write functions are parallel. Only enabled in Editor.
+
| 27015 / any port
Supply a reference Id to check ONLY that item
+
| Steam update port. ''Unclear if this is actually used by the game at the moment.''
|
 
 
|-
 
|-
| ROCKETBINARY
 
| Starts logging the size of each section of a delta update.
 
| Arguments:
 
* toggleloglength
 
* togglelogbps
 
 
|-
 
|-
| IMGUI
+
| UPNPEnabled
| No help text :(
+
| true / false
|  
+
| Enable or disable UniversalPlugAndPlay (Auto port forwarding, your router must support)
 
|-
 
|-
| ATMOS
 
| Enables atmosphere debugging
 
| Arguments:
 
* pipe
 
* world
 
* room
 
* global
 
* thing
 
 
|-
 
|-
| THING
+
| ServerName
| Thing related commands
+
| "My Game Server" / your desired server name
| Arguments:
+
| Description
* No args returns total thing count
 
* find
 
* delete
 
* spawn
 
 
|-
 
|-
| KEYBINDINGS
 
| Displays all the keybindings bound to LocalHuman
 
| Arguments:
 
* reset (Resets the keybindings stack. Can help solve input issues)
 
 
|-
 
|-
| RESET
+
| ServerPassword
| Restarts the application
+
| "MySuperSecurePassword" /  your desired server password
|  
+
| Description
 
|-
 
|-
| VERSION
 
| Returns the game version
 
|
 
 
|-
 
|-
| LOGTOCLIPBOARD
+
| ServerAuthSecret
| Copies the content of the console buffer to the system clipboard buffer
+
| "MySuperSecureSecret" /  your desired admin secret
|  
+
| Description
 
|-
 
|-
| KICK
 
| Kick clients from server commands
 
| clientId - disconnects the client from the game
 
 
|-
 
|-
| BAN
+
| ServerMaxPlayers
| Bans a client from the server (server only command)
+
| 1-20
| clientId
+
| The number of available player slots. Shouln't exceed 20.
 
|-
 
|-
| UPNP
 
| returns universal plug and play (upnp) state
 
|
 
 
|-
 
|-
| NETWORK
+
| AutoSave
| returns the current network status
+
| true / false
|  
+
| Enable or disable autosaves
 
|-
 
|-
 
| PAUSE
 
| will pause/unpause the game (including for clients)
 
| Arguments:
 
* true
 
* false
 
 
|-
 
|-
| SAY
+
| SaveInterval
| sends a message to all connected players
+
| 300
|  
+
| Time in seconds between each autosave. Shouldn't be below 60 sec.
 
|-
 
|-
| SAVE
 
| Saves the current game to specified path
 
| Arguments:
 
* <foldername>
 
* delete <foldername>
 
* list
 
 
|-
 
|-
| LOG
+
| AutoPauseServer
| Dumps all the logs to a file
+
| true / false
| Arguments:
+
| Weather the server should auto pause or not if no players are connected
<logname> (optional)
 
clear
 
 
|-
 
|-
| DISCORD
 
| Interaction with the Discord SDK
 
|
 
 
|-
 
|-
| SETTINGS
+
| UseSteamP2P
| Change the settings.xml. e.g settings servermaxplayers 5
+
| true / false
| Arguments:
+
| Weather the server should allow SteamP2P connections. Keep this disabled.
* list
 
* print
 
<PropertyName> <Value>
 
 
|-
 
|-
| NETCONFIG
 
| Change the NetConfig.xml. e.g netconfig ip 127.0.0.1
 
| Arguments:
 
* list
 
* print
 
* <PropertyName> <Value>
 
 
|-
 
|-
| SETTINGSPATH
+
| StartLocalHost
| Sets the default settings path to a new location. Launch command only. If none found default is used.
+
| true / false
| <full-directory-path>
+
| Do not change this, this is required to be able to connect.
 
|-
 
|-
| TEST
+
 
| No help text :(
 
|
 
 
|}
 
|}
  
== Modding on Servers ==
+
=== Command Examples ===
'''Undocumented feature'''<br>
+
 
Mods are supported on Dedicated servers, however it requires additional manual configuration - Necessitating direct file access and editing on the dedicated server. To install mods, you'll need to manually obtain the mod data first - Either from the Steam Workshop, or built yourself. Upload/Store the mods in a specific folder on the server - You will also likely want to edit default.ini on the server to point to a particular server folder rather then the default directory, defined below. Then manually add ModConfig.xml in the root directory of the server executible files, and manually edit the file to add each individual mod.<br>
+
==== '''Linux''' ====
 +
Note: Logging to console on Linux is slightly broken - we recommend to log to a log file instead and <code> tail -f </code> that
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> saved to <code> saves/MyLunarMap </code> , advertises itself with 6 player slots in the server list as <code> MyLunarServer </code> on port </code> 27016 </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log</code>
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> with Difficulty <code>Easy</code>, Startcondition <code>DefaultStart</code> and StartLocation <code>LunarSpawnCraterVesper</code>, saved to <code> saves/MyLunarMap </code> , advertises itself with 6 player slots in the server list as <code> MyLunarServer </code> on port </code> 27016 </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar Easy DefaultStart LunarSpawnCraterVesper -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log</code>
 +
 
 +
Explanation: ''Server starts a new Map on <code> Mars2 </code> saved to <code> saves/MyLunarMap </code> , advertises itself in the server with 6 player slots in the server list as <code> MyLunarServer </code> on port </code> 27016 </code> '''without''' password and saves every 5 minutes.<br>''
 +
 
 +
<code>./rocketstation_DedicatedServer.x86_64 -file start MyMarsMap Mars2 -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log</code>
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> saved to <code> saves/MyLunarMap </code>, '''does not advertise itself in the server list''' but is available for 6 players to direct connection via <code> <serverIP>:27016 </code> </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar -logFile "./server.log" -settings StartLocalHost true ServerVisible false GamePort 27016 UPNPEnabled false ServerName "MyHiddenLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log</code>
 +
 
 +
===== Additional info about the Linux commands =====
 +
* LocalIpAddress 0.0.0.0 is required to allow the server to bind to all network interfaces on your Linux Server. On some distros, you might wanna specify the actual interface IP instead.
 +
* The server starts with the specified values, but technically in the background (& sign at the end of the command). You can foreground it again by using <code fg </fg>
 +
* tail -f debug.log runs in the foreground, showing the log output in your current attached terminal.
 +
* When you now Ctrl+C, '''the server will not stop''' - instead it will remain in the '''background as long as your session is open''' If you, for example, disconnect your SSH connection the server will stop because an ending SSH connection typically sends a SIGHUP (hangup signal) to all processes in the session, including background processes,. You might wanna look into using [https://youtu.be/UxbiDtEXuxg?si=_j3MumpVcCCk4xGQ tmux].
 +
 
 +
==== '''Windows''' ====
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> saved to <code> saves/MyLunarMap </code> , advertises itself with 6 player slots in the server list as <code> MyLunarServer </code> on port <code> 27016 </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false</code>
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> with Difficulty <code>Easy</code>, Startcondition <code> DefaultStart </code> and StartLocation <code> LunarSpawnCraterVesper </code>, saved to <code> saves/MyLunarMap </code> , advertises itself with 6 player slots in the server list as <code> MyLunarServer </code> on port <code> 27016 </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar Easy DefaultStart LunarSpawnCraterVesper -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false</code>
 +
 
 +
 
 +
Explanation: ''Server starts a new Map on <code> Lunar </code> saved to <code> saves/MyLunarMap </code>, does NOT advertise itself in the server list but is available for 6 players to direct connect via <code> <serverIP>:27016 </code> </code> with password <code> MySuperSecurePassword </code> and saves every 5 minutes.<br>''
 +
 
 +
<code>.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar -settings StartLocalHost true ServerVisible false GamePort 27016 UPNPEnabled false ServerName "MyHiddenLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false</code>
 +
 
 +
===== Additional info about the commands =====
 +
The server will stay running until you close the terminal. When you close (don't logoff) a RDP session, the server does not stop.
 +
 
 +
== Administrator: run a command on the server ==
 +
 
 +
The same <code> ServerAuthSecret </code> parameter must be added to the -setting flag (see above) and inside the clients setting.xml ''("client"=your local PC, '''not''' the server)''
  
=== modconfig.xml ===
+
All commands are typed in the client console (F3) and prefixed by a <code> serverrun </code> like so:
Place a modconfig.xml in the serverfiles root (next to executable).  Filename case is significant on Linux.
 
  
<HR><pre>
+
<code> serverrun say Hello World </code>
<?xml version="1.0" encoding="utf-8"?>
 
<ModConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 
  <Mods>
 
    <unsignedLong>1</unsignedLong>
 
    <unsignedLong>1001</unsignedLong>
 
    <unsignedLong>1002</unsignedLong>
 
  </Mods>
 
  <DisabledMods>
 
  </DisabledMods>
 
  <LocalMods>
 
    <LocalMod>
 
      <folder>YourFirstModFolderHere</folder>
 
      <modID>1001</modID>
 
    </LocalMod>
 
    <LocalMod>
 
      <folder>YourSecondModFolderHere</folder>
 
      <modID>1002</modID>
 
    </LocalMod>
 
  </LocalMods>
 
</ModConfig>
 
</pre><HR>
 
  
Assign a number to each entry you want to add.<br>
+
=== Server Terminal Console===
Numbers seem to default to 4 digits for mods when generated by the client,<br>
+
When running the server from windows, you can type commands in the terminal application which acts like a console
so try and keep the same structure in the server to prevent complications.<br>
 
''1 is core file and always need to be enabled''
 
  
=== Storing Mods ===
+
=== Command Lists ===
WIN: C:\Users\'''USERNAME_HERE'''\Documents\My Games\Stationeers\mods\
+
{| class="wikitable"
LIN: /home/'''USERNAME_HERE'''/My Games/Stationeers/mods/
+
!Command
OSX: /Users/'''USERNAME_HERE'''/My Games/Stationeers/mods/
+
!Details
 +
!Parameter
 +
|-
 +
| HELP
 +
| Displays the list of commands.
 +
| Arguments:
 +
* commands
 +
* list (l)
 +
* <key>
 +
* tofile: prints the help output to file
 +
|}
  
 +
== Modding on Servers ==
 +
''removed very outdated information here - please ask on the Stationeers Discord server in either #modding or #dedicated-server''
  
\Modname or workshopid\About\
 
(file containing description about mod and thumbnail)
 
\Modname or workshopid\GameData\
 
(files you want to <u>append</u> to the core gamedata)
 
  
It's recommended to only put entries in the mod files you want to add or replace,<br>
 
do not try and replace the whole file for compatibility issues and errors.
 
  
 
There are some examples of how to make your own mods in:
 
There are some examples of how to make your own mods in:
 
  \Steam\steamapps\common\Stationeers\rocketstation_Data\StreamingAssets\
 
  \Steam\steamapps\common\Stationeers\rocketstation_Data\StreamingAssets\
 
Look for ExampleMod.zip and AttributesExampleMod.zip .
 
Look for ExampleMod.zip and AttributesExampleMod.zip .
 +
 +
 +
[https://github.com/rocket2guns/StationeersDedicatedServerGuide/blob/main/README.md%20Official%20Server%20Guide VERY Outdated official guide]

Latest revision as of 10:23, 11 November 2025


General Requirements[edit]

  • Linux or Windows system, either physical or virtualized
  • It is NOT recommended also running a Stationeers client, so hosting the server on your PC while playing at the same time might lead to issues. (there will be issues with router NAT-loopback).
  • 16 or more Gigabytes of RAM. The server will load with less, but will run out of RAM quickly, potentially leading to instability or crashes.

Quickstarts & Panels[edit]

StationeersServerUI[edit]

Docker + Native Linux & Windows

StationeersServerUI offers an intuitive webUI, easy configuration, smart backups, full steamcmd handling with auto-updates,
a discord integration for your community to interact with the server, tons of other helpful features like a remote console and works straight out of the box.
Created in 2024 with love and attention to detail, updated regularly by JacksonTheMaster & the StationeersServerUI Team

Pterodactyl[edit]

BadDucky52 has updated the older pterodactyl egg for the current Dedicated Server:
Current Pterodactyl Egg by BadDucky52

DIY Solutions[edit]

Requirements[edit]

    • Linux: Glibc 2.38 (Ubuntu 24.04 LTS, Debian Bookworm (12), Debian Trixie (13))
    • Windows: Microsoft Visual C++ 2015, 2017 and 2019 runtime click here to download it.

It is, of course, possible to run the server without external images or tools simply by downloading it from SteamCMD and executing it. Everything you should need is Documented below.

Getting the server files[edit]

SteamCmd installed on the operating system you are running the server with. See The SteamCMD Documentation (This is a command line tool)

For the stable branch: (The "stable" branch is what you Download by default when you select Stationeers in your Steam Library)

steamcmd +login anonymous +app_update 600760 validate +quit

For the beta branch:

steamcmd +login anonymous +app_update 600760 -beta beta validate +quit

For getting back from beta to public use -beta public, SteamCMD has trouble with caching sometimes

Default ports[edit]

27016: Game port (UDP). 27015: Steam update port. (UDP).

Server Startup Arguments (Post September 2025)[edit]

With the release of the terrain update, the flags the Dedicated Server accepts where changed.
If you are running an older version (such as the prerocket or preterrain branch, ask on the Stationeers Discord server in either #modding or #dedicated-server''

String parameters can take space with double quotes.

Flag Value Description
-file start <stationname> [worldid] [difficulty] [startcondition] [startlocation] Tries to load the latest save for the specified station. If not found, starts a new world with the given parameters and saves it.

- stationname: Required. This is the name of your save.
- worldid: Optional, but required to start a new game if no existing station is found.
- difficulty: Optional, defaults to "Normal" if not provided.
- startcondition: Optional, defaults to the default start condition for the world setting if not provided.
- startlocation: Optional, defaults to "DefaultStartLocation" if not provided.
- When you add optional arguments, you cannot leave one out.
For example, <stationname> [worldid] [startlocation] would not work,
you would need to add [difficulty] and [startcondition] too.

-logFile "path" Specifies a custom log file path if output_log.txt is not used. Example:

-logFile "server.log"

-settings see below Changes the default settings to desired values e.g -settings ServerName "MyNewStationeersServer". For a full list and examples, see below.

World types (October 2025)[edit]

Note: RoundRobin StartLocations and Community StartConditions are only available on BETA at the moment.

World Name WorldID Difficulty IDs StartCondition IDs StartLocation IDs
Lunar (The Moon) Lunar Creative, Easy, Normal, Stationeer DefaultStart, DefaultStartCommunity, Brutal, BrutalCommunity LunarSpawnCraterVesper, LunarSpawnMontesUmbrarum, LunarSpawnCraterNox, LunarSpawnMonsArcanus, LunarSpawnRoundRobin
Mars Mars2 Creative, Easy, Normal, Stationeer DefaultStart, DefaultStartCommunity, Brutal, BrutalCommunity MarsSpawnCanyonOverlook, MarsSpawnButchersFlat, MarsSpawnFindersCanyon, MarsSpawnHellasCrags, MarsSpawnDonutFlats, MarsSpawnRoundRobin
Europa Europa3 Creative, Easy, Normal, Stationeer EuropaDefault, EuropaDefaultCommunity, EuropaBrutal, EuropaBrutalCommunity EuropaSpawnIcyBasin, EuropaSpawnGlacialChannel, EuropaSpawnBalgatanPass, EuropaSpawnFrigidHighlands, EuropaSpawnTyreValley, EuropaSpawnRoundRobin
Mimas MimasHerschel Creative, Easy, Normal, Stationeer MimasDefault, MimasDefaultCommunity, MimasBrutal, MimasBrutalCommunity MimasSpawnCentralMesa, MimasSpawnHarrietCrater, MimasSpawnCraterField, MimasSpawnDustBowl, MimasSpawnRoundRobin
Vulcan Vulcan Creative, Easy, Normal, Stationeer VulcanDefault, VulcanDefaultCommunity, VulcanBrutal, VulcanBrutalCommunity VulcanSpawnVestaValley, VulcanSpawnEtnasFury, VulcanSpawnIxionsDemise, VulcanSpawnTitusReach, VulcanSpawnRoundRobin
Venus Venus Creative, Easy, Normal, Stationeer VenusDefault, VenusDefaultCommunity, VulcanBrutal, VulcanBrutalCommunity
Note: Yes, Venus is using VulcanBrutal & VulcanBrutalCommunity
VenusSpawnGaiaValley, VenusSpawnDaisyValley, VenusSpawnFaithValley, VenusSpawnDuskValley, VenusSpawnRoundRobin

When selecting a start location you can pick <WorldID>Random to have each new player spawn in a randomly selected location on the map. This is designed to be used with the <WorldID>BrutalCommunity StartCondition which spawns each new player with a brutal start crate.

Tutorial Maps

World Name WorldID
Inventory Tutorial Tutorial1
Connection Tutorial Tutorial2
Atmospherics Tutorial Tutorial3
Airlocks Tutorial Airlock
Furnace Tutorial FurnaceBasics
Manufacturing Tutorial Manufacturing
Configuration[edit]

In your server directory, a file called setting.xml will be created once you start it up for the first time.
While you can technically edit that, this approach is not guaranteed to work (bugged for a while).
It is recommended to use the -setting flag instead.

Setting Value Description
ServerVisible true / false Shows / hides the server in the ingame server list
GamePort 27016 / any port The port that players connect to
UpdatePort 27015 / any port Steam update port. Unclear if this is actually used by the game at the moment.
UPNPEnabled true / false Enable or disable UniversalPlugAndPlay (Auto port forwarding, your router must support)
ServerName "My Game Server" / your desired server name Description
ServerPassword "MySuperSecurePassword" / your desired server password Description
ServerAuthSecret "MySuperSecureSecret" / your desired admin secret Description
ServerMaxPlayers 1-20 The number of available player slots. Shouln't exceed 20.
AutoSave true / false Enable or disable autosaves
SaveInterval 300 Time in seconds between each autosave. Shouldn't be below 60 sec.
AutoPauseServer true / false Weather the server should auto pause or not if no players are connected
UseSteamP2P true / false Weather the server should allow SteamP2P connections. Keep this disabled.
StartLocalHost true / false Do not change this, this is required to be able to connect.

Command Examples[edit]

Linux[edit]

Note: Logging to console on Linux is slightly broken - we recommend to log to a log file instead and tail -f that

Explanation: Server starts a new Map on Lunar saved to saves/MyLunarMap , advertises itself with 6 player slots in the server list as MyLunarServer on port </code> 27016 </code> with password MySuperSecurePassword and saves every 5 minutes.

./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log

Explanation: Server starts a new Map on Lunar with Difficulty Easy, Startcondition DefaultStart and StartLocation LunarSpawnCraterVesper, saved to saves/MyLunarMap , advertises itself with 6 player slots in the server list as MyLunarServer on port </code> 27016 </code> with password MySuperSecurePassword and saves every 5 minutes.

./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar Easy DefaultStart LunarSpawnCraterVesper -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log

Explanation: Server starts a new Map on Mars2 saved to saves/MyLunarMap , advertises itself in the server with 6 player slots in the server list as MyLunarServer on port </code> 27016 </code> without password and saves every 5 minutes.

./rocketstation_DedicatedServer.x86_64 -file start MyMarsMap Mars2 -logFile "./server.log" -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log

Explanation: Server starts a new Map on Lunar saved to saves/MyLunarMap , does not advertise itself in the server list but is available for 6 players to direct connection via <serverIP>:27016 </code> with password MySuperSecurePassword and saves every 5 minutes.

./rocketstation_DedicatedServer.x86_64 -file start MyLunarMap Lunar -logFile "./server.log" -settings StartLocalHost true ServerVisible false GamePort 27016 UPNPEnabled false ServerName "MyHiddenLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false LocalIpAddress 0.0.0.0 & tail -f server.log

Additional info about the Linux commands[edit]
  • LocalIpAddress 0.0.0.0 is required to allow the server to bind to all network interfaces on your Linux Server. On some distros, you might wanna specify the actual interface IP instead.
  • The server starts with the specified values, but technically in the background (& sign at the end of the command). You can foreground it again by using <code fg </fg>
  • tail -f debug.log runs in the foreground, showing the log output in your current attached terminal.
  • When you now Ctrl+C, the server will not stop - instead it will remain in the background as long as your session is open If you, for example, disconnect your SSH connection the server will stop because an ending SSH connection typically sends a SIGHUP (hangup signal) to all processes in the session, including background processes,. You might wanna look into using tmux.

Windows[edit]

Explanation: Server starts a new Map on Lunar saved to saves/MyLunarMap , advertises itself with 6 player slots in the server list as MyLunarServer on port 27016 with password MySuperSecurePassword and saves every 5 minutes.

.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false

Explanation: Server starts a new Map on Lunar with Difficulty Easy, Startcondition DefaultStart and StartLocation LunarSpawnCraterVesper , saved to saves/MyLunarMap , advertises itself with 6 player slots in the server list as MyLunarServer on port 27016 with password MySuperSecurePassword and saves every 5 minutes.

.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar Easy DefaultStart LunarSpawnCraterVesper -settings StartLocalHost true ServerVisible true GamePort 27016 UPNPEnabled false ServerName "MyLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false


Explanation: Server starts a new Map on Lunar saved to saves/MyLunarMap , does NOT advertise itself in the server list but is available for 6 players to direct connect via <serverIP>:27016 </code> with password MySuperSecurePassword and saves every 5 minutes.

.\rocketstation_DedicatedServer.exe -file start MyLunarMap Lunar -settings StartLocalHost true ServerVisible false GamePort 27016 UPNPEnabled false ServerName "MyHiddenLunarServer" ServerPassword "MySuperSecurePassword" ServerMaxPlayers 6 AutoSave true SaveInterval 300 ServerAuthSecret "MySuperSecureSecret" UpdatePort 27015 AutoPauseServer true UseSteamP2P false

Additional info about the commands[edit]

The server will stay running until you close the terminal. When you close (don't logoff) a RDP session, the server does not stop.

Administrator: run a command on the server[edit]

The same ServerAuthSecret parameter must be added to the -setting flag (see above) and inside the clients setting.xml ("client"=your local PC, not the server)

All commands are typed in the client console (F3) and prefixed by a serverrun like so:

serverrun say Hello World

Server Terminal Console[edit]

When running the server from windows, you can type commands in the terminal application which acts like a console

Command Lists[edit]

Command Details Parameter
HELP Displays the list of commands. Arguments:
  • commands
  • list (l)
  • <key>
  • tofile: prints the help output to file

Modding on Servers[edit]

removed very outdated information here - please ask on the Stationeers Discord server in either #modding or #dedicated-server


There are some examples of how to make your own mods in:

\Steam\steamapps\common\Stationeers\rocketstation_Data\StreamingAssets\

Look for ExampleMod.zip and AttributesExampleMod.zip .


VERY Outdated official guide