Difference between revisions of "Dedicated Server Guide"
From Unofficial Stationeers Wiki
(→Dedicated server starts new Mars world. Autosave every 5 mins to Mars1.) |
(→Configuration from setting.xml) |
||
Line 201: | Line 201: | ||
| <RespawnCondition> | | <RespawnCondition> | ||
| easy, normal, stationeer | | easy, normal, stationeer | ||
− | | Or a custom key from a mod. | + | | Or a custom key from a mod. |
|- | |- | ||
| <StartingConditions> | | <StartingConditions> |
Revision as of 16:38, 7 August 2020
Contents
- 1 Getting the server files
- 2 Dedicated Server Commands
- 3 Examples
- 3.1 Dedicated server starts new Mars world. Autosave every 5 mins to Mars1.
- 3.2 Load Mothership file. Autosave every 5 mins.
- 3.3 Load . Autosave every 5 mins. C:\Profile\Player1\saves\Mothership C:\Profile\Player1\saves\map1
- 3.4 Example -logfile syntax
- 3.5 Example -loadworld="myworld" directory structure.
- 3.6 Configuration from default.ini
- 4 Remote Administrator
- 5 Command Lists
- 6 Configuration from setting.xml
- 7 Configuration from worldsettings.xml in the savegame
- 8 Modding on Servers
- 9 Linux Server with LinuxGSM
Getting the server files
SteamCmd on Windows and Linux
https://developer.valvesoftware.com/wiki/SteamCMD
This is a command line tool
steamcmd +login anonymous +app_update 600760 validate +quit
Dedicated Server Commands
String parameters can take space with double quotes.
parameter | value | etc |
---|---|---|
-batchmode | Dedicated server runs without UI and start to listen port. | |
-nographics | When running in batch mode, do not initialize graphics device at all. | |
-logfile | "path" | If no output_log.txt use this parameter. Check examples below for syntax |
-autostart | Dedicated server start to listen port without player input. It's always enabled on Linux dedicated server | |
-autosaveinterval | integer | Save world in every interval. |
-creator | int64 | Set creator's steam id as gamedata and key-value. This is for future integration of server instancing. |
-worldname | string | Load and save game data automatically from existing file. |
-worldtype | string | Worldtype(Moon, Mars, Europa2, Mimas, Vulcan2, Space, Loulan) |
-loadworld | string | Load world from saved file. If loadworld is enabled, worldname command is ignored. |
-gameport | integer | UDP port for game. Avoid to set 27015-27020. It's steam's local server query ports. |
-updateport | integer | UDP port for steam query |
-servername | string | Server title. |
-basedirectory | string | Absolute base directory for custom profile Ex) -basedirectory C:\Profile\Player1 Config Path : default.ini C:\Profile\Player1\ Save Path : C:\Profile\Player1\saves\[worldname]
|
-password | string | set server password |
-maxplayer | integer | set maxplayer of dedicated server |
-clearallinterval | integer | set the interval to run clearall command. Default and minimum value is 60 seconds. |
-bindip | string | Bind specific IP address on dedicated server when it has multiple IP addresses. |
batchmode, nographics and logfile are Unity3D commands.
https://docs.unity3d.com/Manual/CommandLineArguments.html
Examples
Dedicated server starts new Mars world. Autosave every 5 mins to Mars1.
rocketstation_DedicatedServer.exe -batchmode -nographics -autostart -autosaveinterval=300 -worldtype=Mars -worldname=Mars1 -basedirectory="C:\Server\User1"
Load Mothership file. Autosave every 5 mins.
rocketstation_DedicatedServer.exe -batchmode -nographics -autostart -gameport=27200 -updateport=27016 -autosaveinterval=300 -loadworld=Mothership -servername="Official Dedicated Server"
Load . Autosave every 5 mins. C:\Profile\Player1\saves\Mothership C:\Profile\Player1\saves\map1
rocketstation_DedicatedServer.exe -batchmode -nographics -autostart -autosaveinterval=300 -gameport=27200 -updateport=27016 -loadwo rld=Mothership -worldname=map1 -basedirectory="C:\Profile\Player1" -servername "Official Dedicated Server"
Example -logfile syntax
-logFile "C:\Server_Path\rocketstation_DedicatedServer_Data\output_log.txt"
Example -loadworld="myworld" directory structure.
Note: BaseDirectory is by default in SteamApps/common/Stationeers Dedicated Server/<Contents of BaseDirectory> if installed with SteamCMD
Linux:
-loadworld="myworld" will look for a folder named "myworld" in the saves directory like this:
BaseDirectory/saves/myworld/
Windows:
-loadworld="myworld" will look for a folder named "myworld" in the saves directory like this:
BaseDirectory\saves\myworld\
Details:
In the world directory named "myworld", there must be a few files:
- 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..
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.
There is also one more file that will be created:
- worldsettings.xml
Configuration from default.ini
default.ini will be created once you start game. Command parameters override defaut.ini
[SERVER] SERVERNAME=Stationeers GAMEPORT=27500 UPDATERPORT=27015 PASSWORD= MAPNAME=BASE DESCRIPTION=Stationeers MAXPLAYER=30 [RCON] RCONPASSWORD=stationeers
Remote Administrator
You can send commands on web browser.
Link : http://[dedicated server address]:[GamePort]
Command Lists
Command | Parameter | Details |
---|---|---|
login | password | RCONPASSWORD is defined in default.ini. Default rcon password is stationeers. |
save | worldname | Save world to basedirectory
When basedirectory is "C:\Profile\Player1", >> save "Moon 2" Save world to "C:\Profile\Player1\Moon 2" >> save Moon Save world to "C:\Profile\Player1\Moon" |
shutdown | [-m message] [-t timeout in seconds] | Shutdown dedicated server. If you run this command without any parameters, dedicated server will shutdown immediately. Countdown starts from 10 seconds. >> shutdown -m "Server will shutdown in 30 seconds" -t 30 |
notice | message | Notice to all players. >> notice "Welcome to Stationeers!" |
status | Display game state and player lists. | |
ban | steamId timeout | Ban player for specific time. Timeout is double in hour. 0.5 is 30 minutes. 0 is infinite. >> ban 76561198299941358 0.5 |
unban | steamId | Remove player from the ban lists. |
kick | steamId | Kick player from the current server. |
clearall | Delete disconnected players | |
hungerRate | hunger rate | Set hunger rate of server. 0 to disable hunger, higher numbers to make hunger drop more quickly. |
Game client displays messages in the system message window at this moment.
Configuration from setting.xml
Undocumented feature
The server is mostly a stripped down client as such it inherits certain features
XML Attribute | Parameter | Details |
---|---|---|
<RespawnCondition> | easy, normal, stationeer | Or a custom key from a mod. |
<StartingConditions> | Default, Minimal, Vulcan, BareBones | Or a custom key from a mod. Only applies to new worlds. |
<HungerRate> | 0 is off, 1 is default | Don't go too crazy on the multiplier. Only applies to new worlds. |
<ResearchPoolKey> | ResearchOff, ResearchOn | Or a custom key from a mod. Only applies to new worlds. |
<SunOrbitPeriod> | default=1 | Multiplier on the time it takes for the sun to orbit, default is 20 minutes, 10 minute day 10 night. Only applies to new worlds. |
Undocumented | ||
<UseCustomWorkThreadsCount>false</UseCustomWorkThreadsCount> | true, false | |
<MinWorkerThreads> | number | default=8 |
<MinCompletionPortThreads> | number | default=8 |
<MaxWorkerThreads>100</MaxWorkerThreads> | number | default=100 |
<MaxCompletionPortThreads>50</MaxCompletionPortThreads> | number | default=50 |
<CoroutineTimeBudget>1</CoroutineTimeBudget> | number | default=1 |
Example Setting.xml
<?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"> <RespawnCondition>Stationeer</RespawnCondition> <StartingConditions>Mimimal</StartingConditions> <ResearchPoolKey>ResearchOff</ResearchPoolKey> <HungerRate>1</HungerRate> <SunOrbitPeriod>1</SunOrbitPeriod> </SettingData>
Configuration from worldsettings.xml in the savegame
Undocumented feature
The server is mostly a stripped down client as such it inherits certain features
XML Attribute | Parameter | Details |
---|---|---|
<GameMode> | Creative, Survival | |
<StartingCondition> | Default, Minimal, Vulcan, BareBones | Or a custom key from a mod |
Modding on Servers
Undocumented feature
ModConfig.xml
Place a modconfig.xml in the serverfiles root (next to executable).
<?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>
Assign a number to each entry you want to add.
Numbers seem to default to 4 digits for mods when generated by the client,
so try and keep the same structure in the server to prevent complications.
1 is core file and always need to be enabled
Storing Mods
WIN: C:\Users\USERNAME_HERE\Documents\My Games\Stationeers\mods\ LIN: /home/USERNAME_HERE/My Games/Stationeers/mods/ OSX: /Users/USERNAME_HERE/My Games/Stationeers/mods/
\Modname or workshopid\About\
(file containing description about mod and thumbnail)
\Modname or workshopid\GameData\
(files you want to append to the core gamedata)
It's recommended to only put entries in the mod files you want to add or replace,
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:
\Steam\steamapps\common\Stationeers\rocketstation_Data\StreamingAssets\
Look for ExampleMod.zip and AttributesExampleMod.zip .
Linux Server with LinuxGSM
You could run a Linux Dedicated Server on these Distros:
- Ubuntu 16.04/18.04 LTS
- Debian 8
- CentOS 7
Installation on a Ubuntu 18.04 LTS Server
It's possible to download the iso-file for installation from here:
https://ubuntu.com/download/server
This should not be a tutorial how to set up a VM and install Ubuntu. There are many of them already out there.
First it#s necessary to install all the dependencies for LinuxGSM:
sudo dpkg --add-architecture i386; sudo apt update; sudo apt install mailutils postfix curl wget file tar bzip2 gzip unzip bsdmainutils python util-linux ca-certificates binutils bc jq tmux lib32gcc1 libstdc++6 lib32stdc++6 steamcmd zlib1g
To not having the server running whit root privilges it is recomend to setup a new user for the gameserver.
To create a new user in linux use:
adduser stserver
For security best practice, ensure you set a strong password!
After installing the dependencies and creating a user its time to switch to that user and do the rest of the job.
su - stserver
Download linuxgsm.sh whit wget.
wget -O linuxgsm.sh https://linuxgsm.sh
Make the script executeable.
chmod +x linuxgsm.sh
Setup the Stationeers Server instance.
bash linuxgsm.sh stserver
Run the installer following the on-screen instructions.
./stserver install
The script now download the server binarys and default configuration.
Start and Stop the Server
To start the server use this command.
./stserver start
In Default the server will start a Moon map. To join the server use the local IP whit the Port 27500.
To join the server from a different lokation, it's necessary to forward the port 27500/tcp and 27015/tcp to the local server.
If its not possible to connect make sure the Ubuntu Firewall is of or configured to let this ports open. To check this run this as root user.
ufw status
or to disable it
ufw disable
To see the details
./stserver details
To stop the server use
./stserver stop
This command shows all atributes
./stserver help
To show the live console of the server use:
./stserver console
To exit the console pres CTRL+b and then "d"
Edit configuration
The Configuration is stored under the folder lgsm/config-gsm/stserver. There are three files:
- _default.cfg (contains the whole configuration with the default values Do not edit this file)
- common.cfg (the settings for this server)
- stserver.cfg (the settings for this instance)
If there is only one instance/server running and there will not be any other server it doesn't matter if you change the settings in common.cfg or stserver.cfg. If you planing to run more than on server or instance on the same VM you have to consider if the setting should apply server wide (all instances), or just for a specific Stationeers instance.
Example: Change map to Mars
Use your favorite texteditor (ex. vi or nano) and open the _default.cfg (remember not to do any changes here) search for the setting you want to change and copy the text. In our example it is this:
worldtype="Moon" worldname="moon_save"
Now open the file you want to configure. If you want any instance to run a Mars map use common.cfg or if only one instance should run this map use stserver.cfg (or stserver-2.cfg for the next instance). Paste the text at the end of the file and change "Moon" to "Mars"
worldtype="Mars" worldname="mars_save"
Now restart your server with ./stserver restart
Make sure you also change the worldname (this is the folder where the savegame is) if the savegame-file is for a different world than the config is set to the server will not start.