Stationeers Community Wiki - User contributions [en]

Dedicated Server Guide

2020-01-02T23:41:12Z

175.34.221.13: /* ModConfig.xml */ - changed file to modconfig.xml - linux specific issue.

[[Category:Tutorials]]

== Dedicated Server Commands ==
String parameters can take space with double quotes.
{| class="wikitable"
|-
! 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(Space, Mars, Terrain)
|-
|<nowiki>-loadworld</nowiki>
| 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.
|-
|<nowiki>-updateport</nowiki>
|integer
|UDP port for steam query
|-
|<nowiki>-servername</nowiki>
|string
|Server title.
|-
|<nowiki>-basedirectory</nowiki>
|string
|<nowiki>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]</nowiki>
|}
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<br>

<big>'''Linux:'''</big><br>
-loadworld="myworld" will look for a folder named "myworld" in the ''saves'' directory like this:<br>
''BaseDirectory''/saves/myworld/<br>

<big>'''Windows:'''</big><br>
-loadworld="myworld" 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", 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..<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
<br>

===== 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.
<nowiki>Link : http://[dedicated server address]:[GamePort]</nowiki>
[[File:Dediserv1.png|frameless|735x735px]]

== Command Lists ==
{| class="wikitable"
!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.
[[File:Dediserv2.png|frameless|332x332px]]

== Modding on Servers ==
'''Undocumented feature'''

=== ModConfig.xml ===
Place a modconfig.xml in the serverfiles root (next to executable).

<HR><pre>
<?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>
Numbers seem to default to 4 digits for mods when generated by the client,<br>
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 ===
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 <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:
\Steam\steamapps\common\Stationeers\rocketstation_Data\StreamingAssets\
Look for ExampleMod.zip and AttributesExampleMod.zip .

Guide (Modding)

2020-01-02T23:26:26Z

175.34.221.13: /* File Structure */ - GameData not Gamedata - specific to Linux

Stationeers allows players to mod the game in a variety of ways using only a text editor and (semi-optionally) an image editor. Moddable features include starting equipment, world conditions, and item recipes. On this page we will demonstrate how easy it is to make changes to the game.

== File Structure ==
To be recognized as valid, a mod must follow a particular file structure. The game provides an example of this file structure with a helpful readme at <code>[Installation Location]/Stationeers\rocketstation_Data\StreamingAssets\ExampleMod.zip</code>. This reveals the following structure (some text copied from the readme):
* <code>[Mod Name]\</code> — named after the mod, contains all the mod files
** <code>About\</code> — Contains descriptive information about the mod.
*** <code>About.xml</code> — Your mod meta-data used when uploaded to the workshop and when displaying your mod in the workshop menu.
*** <code>Preview.png</code> — Preview image of your mod used in the in-game mod browser.
*** <code>thumb.png</code> — Preview image of your mod used in the Steam Workshop. MUST BE BELOW 1MB OR UPLOAD WILL FAIL.
** <code>GameData/</code> — A directory to contain the files that change the game.
*** <code>Language/</code> — Contains localization files for representing strings in various languages.
**** <code>english.xml</code> — Maps any additional string variables you use into English.
**** <code>[Other Languages].xml</code> — Maps string variables into other languages you might like to support.
*** <code>[Modded Files].xml</code> — Various XML files to overwrite portions of the game's defaults.

Your mods must be placed in Stationeer's mods folder, which on Windows is located at <code>[User directory]\Documents\My Games\Stationeers\mods\</code>. If you find the Stationeers directory but it doesn't contain a mods directory, you must create one. Once there, your mod should appear in the mods section of the Stationeers menu. Ensure that it is listed above the core game in the loading order. To quickly make and test changes to your mod, you needn't restart the game; instead, you can go to the mods section of the main menu and shuffle their order around. This will cause the game to reload all of the mods.

== About Files ==
You must provide three files in the <code>About/</code> directory for your mod to work. The two images are used in the Workshop and in-game mod menu; if you don't want to bother with these, you can just copy the generic images from the example mod. The file <code>About.xml</code> requires slightly more customization. The best way to do this is to copy the example mod file (reproduced below) and edit the fields with a text editor: you will need to set the mod name, author name, version number, and a short description of the mod.

The example mod metadata file "About.xml":<div class="mw-collapsible"><blockquote><pre><?xml version="1.0" encoding="utf-8"?>
<ModMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Name>StationeersExampleMod</Name>
<Author>You!</Author>
<Version>0.123456.78</Version>
<Description>This mod serves to demonstrate the correct format of a custom mod folder for Stationeers.</Description>
</ModMetadata></pre></blockquote></div>

== Game Data Files ==
This is where the real work of the mod takes place. Each xml file in this directory, upon loading, writes (potentially overwriting) the game data. The default data is found in <code>[Installation Location]/Stationeers\rocketstation_Data\StreamingAssets\Data\</code>, and currently contains 27 xml files, each of which may be modded. These are as follows, with files that may be of particular interest to modders in bold.
{| class="wikitable"
|-
! File !! Purpose
|-
| advancedFurnace || Defines the recipes for the [[Kit_(Advanced_Furnace)_Advanced_Furnace|Advanced Furnace]]
|-
| arcfurnace || Defines the time, energy, and products of smelting ingots in the [[Special:MyLanguage/Kit (Arc Furnace) Arc Furnace|Arc Furnace]].
|-
| atmospherepresets || Defines default atmospheric properties for the moon and Mars. Possibly deprecated? For modding, use worldsettings instead.
|-
| '''autolathe''' || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Autolathe) Autolathe|Autolathe]].
|-
| centrifuge || Defines the time required and products of processing ore in the [[Special:MyLanguage/Kit (Centrifuge) Centrifuge|Centrifuge]].
|-
| chemistry || Defines the time required and recipes for items from the [[Special:MyLanguage/Chemistry Station|Chemistry Station]].
|-
| cooking || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Microwave|Microwave]].
|-
| customtraders || Defines new traders for the trading system. This file has no entries by default, but contains a commented-out example for modders.
|-
| DynamicObjectsFabricator || Defines the recipes for dynamic objects, which currently is a very small set.
|-
| '''electronics''' || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Electronics Printer) Electronics Printer|Electronics Printer]].
|-
| '''fabricator''' || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Fabricator) Fabricator|Fabricator]].
|-
| furnace || Defines the required reagents, pressure range, and temperature range for smelting in the [[Special:MyLanguage/Kit (Furnace) Furnace|Furnace]].
|-
| gascanisters || Defines recipes for creating various gas canisters, but it is unclear where these are used. Possibly deprecated?
|-
| ingots || Defines a mapping of resource types to their respective ingots. It isn't clear what happens if this is modded.
|-
| mineables || Defines a list of mineable ores to generate in the world, with their rarity (but larger means more ore), vein sizes, etc. Usually, this is overridden in worldsettings: possibly deprecated?
|-
| organicsprinter || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Organics Printer) Organics Printer|Organics Printer]].
|-
| paintmixer || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Paint Mixer|Paint Mixer]].
|-
| paints || Defines alternative paint recipes in the [[Special:MyLanguage/Kit (Tool Manufactory) Tool Manufactory|Tool Manufactory]]. Presumably this is a placeholder while until the developers are happy with the paintmixer system?
|-
| '''PipeBender''' || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Hydraulic Pipe Bender) Hydraulic Pipe Bender|Hydraulic Pipe Bender]].
|-
| reagentgrinder || Defines the time and recipes for items in the [[Special:MyLanguage/Reagent Processor|Reagent Processor]]
|-
| recycling || While this appears to relate to the [[Special:MyLanguage/Kit (Recycler) Recycler|Recycler]], the file contains no entries. Possibly deprecated?
|-
| security || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Security Printer) Security Printer|Security Printer]]
|-
| '''startconditions''' || Defines the starting equipment at the beginning of the game, separated out by starting race.
|-
| terraingenerationpresets || Defines default terrain features. For modding, probably use worldsettings instead.
|-
| '''toolmanufacturer''' || Defines the time, energy, and recipes for items in the [[Special:MyLanguage/Kit (Tool Manufactory) Tool Manufactory|Tool Manufactory]].
|-
| tradeables || Defines the value of items in the trading system.
|-
| '''worldsettings''' || Defines the atmospheric, terrain, and lighting properties (and much more) of worlds and allows the definition of new worlds.
|}

==== Examples ====
===== World Conditions =====
Suppose you wish to make Mars more friendly to humans, by adding more oxygen and increasing the temperature. To do this, you can copy the example mod, change the name and description in <code>About.xml</code>, and delete the example entries in the GameData directory. Next, copy over the default worldsettings file into your mod and delete all of the planets except Mars (the planet we intend to modify). To change the atmosphere composition, locate the <code><AtmosphereComposition></code> tags, and increasing the <code><Quantity></code> of Oxygen to say, 20. If you want, you could also eliminate pollutants by deleting that entire <code><SpawnGas></code> section. To increase the temperature, find the <code><Kelvin></code> tags and adjust the <code><value></code> entries upward. Note that atmospheric temperature is defined by a set of fixed points to interpolate between; time is measured from 0 (dawn) to 1 (immediately before the subsequent dawn), with noon at 0.25 and midnight at 0.75.
The relevant sections of the code are as follows (click expand on the right):<div class="mw-collapsible mw-collapsed"><blockquote><pre>
<AtmosphereComposition>
<SpawnGas>
<Type>CarbonDioxide</Type>
<Quantity>8.656</Quantity>
<Name>CarbonDioxide</Name>
</SpawnGas>
<SpawnGas>
<Type>Nitrogen</Type>
<Quantity>0.27</Quantity>
<Name>Nitrogen</Name>
</SpawnGas>
<SpawnGas>
<Type>Oxygen</Type>
<Quantity>20</Quantity>
<Name>Oxygen</Name>
</SpawnGas>
<SpawnGas>
<Type>Pollutant</Type>
<Quantity>0.05839586</Quantity>
<Name>Pollutant</Name>
</SpawnGas>
</AtmosphereComposition>

<Kelvin>
<keys>
<Keyframe>
<time>0</time>
<value>288.15</value>
<inTangent>60</inTangent>
<outTangent>60</outTangent>
<tangentMode>34</tangentMode>
</Keyframe>
<Keyframe>
<time>0.25</time>
<value>293.15</value>
<inTangent>-10</inTangent>
<outTangent>-10</outTangent>
<tangentMode>34</tangentMode>
</Keyframe>
<Keyframe>
<time>0.5</time>
<value>288.15</value>
<inTangent>-192</inTangent>
<outTangent>-192</outTangent>
<tangentMode>34</tangentMode>
</Keyframe>
<Keyframe>
<time>0.75</time>
<value>278.15</value>
<inTangent>10</inTangent>
<outTangent>10</outTangent>
<tangentMode>34</tangentMode>
</Keyframe>
<Keyframe>
<time>1</time>
<value>288.15</value>
<inTangent>324</inTangent>
<outTangent>324</outTangent>
<tangentMode>34</tangentMode>
</Keyframe>
</keys>
<preWrapMode>ClampForever</preWrapMode>
<postWrapMode>ClampForever</postWrapMode>
</Kelvin>
</pre></blockquote></div>
<br>

===== Item Costs =====
For a second example, suppose you really like the [[Stationary_Battery|Stationary Battery]], but you hate having to make steel before you can produce them. You wish for them to cost no steel, but for balance you want them to cost more copper instead. To do this, copy the <code>electronics.xml</code> file into your mod <code>Gamedata</code> directory, and delete all the <code>RecipeData</code> entries except for <code>ItemKitBattery</code> (the recipe we want to modify). Then, adjust the cost entries directly.
The entire resulting file then looks like this (click expand on the right):<div class="mw-collapsible mw-collapsed"><blockquote><pre><?xml version="1.0" encoding="utf-8"?>
<GameData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ElectronicsPrinterRecipes>
<RecipeData>
<PrefabName>ItemKitBattery</PrefabName>
<Recipe>
<Time>5</Time>
<Energy>100</Energy>
<Iron>0</Iron>
<Gold>20</Gold>
<Carbon>0</Carbon>
<Copper>40</Copper>
<Steel>0</Steel>
<Uranium>0</Uranium>
<Hydrocarbon>0</Hydrocarbon>
</Recipe>
</RecipeData>
</ElectronicsPrinterRecipes>
</GameData></pre></blockquote></div>

== Localization Files ==
These are a large list of "Key" and "Value" entries for translating internal strings to the appropriate language. In modding, you will only need to localize strings that you define yourself; this comes up most often in creating new planets, as the "Name" and "Description" fields both define such strings. You only need to do this for languages you intend to support. To generate this file for a mod, it is probably easiest to copy the existing default localization file, delete all the entries, and then add back in entries for your new string. To understand how localization works, here are examples for the constructed Arc Furnace (internal name "StructureArcFurnace") in two languages:
English:<div class="mw-collapsible"><blockquote><pre><Record>
<Key>StructureArcFurnace</Key>
<Value>Arc Furnace</Value>
</Record></pre></blockquote></div>
French:<div class="mw-collapsible"><blockquote><pre><Record>
<Key>StructureArcFurnace</Key>
<Value>Four à Arc</Value>
</Record></pre></blockquote></div>