Skip to content

Server Config & Launch Parameters

beau-rocketwerks edited this page Jun 18, 2024 · 9 revisions

The dedicated server config file is found in Saved\Config\WindowsServer\ServerSettings.ini

This saved folder is by default found in %localappdata%\Icarus\ but can be changed using the -UserDir= command line.


ServerSettings.ini

SessionName

Sets the session name in the server browser.

NOTE: This setting currently does nothing, use the -SteamServerName commandline

JoinPassword

Password required to join the server. Leave empty to not use a password.


MaxPlayers

Max Players that can be on the server at once. Minimum 1, Maximum 8


AdminPassword

Password required for using admin RCON commands.

NOTE: If left empty just using the RCON /AdminLogin will give admin privilege's to a player (effectively an empty password)


ResumeProspect (true/false)

If true, automatically resume the last prospect on startup. True by default.

(See Prospect Setup and Load section for more info)


LastProspectName

The last prospect that was run on the server. Used by ResumeProspect.


LoadProspect

Prospect name to load on startup

(See Prospect Setup and Load section for more info)


CreateProspect

Create and launch a prospect on start up

(See Prospect Setup and Load section for more info)


ShutdownIfNotJoinedFor (seconds)

When the server starts up, if no players join within this time, the server will shutdown and return to lobby. During this window the game will be paused.

Values of < 0 will cause the server to run indefinitely.

A value of 0 will cause the server to shutdown as soon as possible.

Values of > 0 will wait that time in seconds.

Default value is 300 seconds (5 minutes).

NOTE: Only use low values if you want to use the lobby to start prospects each time.


ShutdownIfEmptyFor (seconds)

When the server becomes empty the server will shutdown and return to lobby after this time (in seconds). During this window the game will be paused.

Values of < 0 will cause the server to run indefinitely.

A value of 0 will cause the server to shutdown as soon as possible.

Values of > 0 will wait that time in seconds.

Default value is 300 seconds (5 minutes).


AllowNonAdminsToLaunchProspects (true/false)

If true anyone who joins the lobby can create a new prospect or load an existing one.

If false players will be required to login as admin in order to create or load a prospect.

Default value is true (anyone can create/load a prospect).


AllowNonAdminsToDeleteProspects (true/false)

If true anyone who joins the lobby can delete prospects from the server.

If false players will be required to login as admin in order to delete a prospect.

Default value is false (requires admin login).




Prospect Setup and Load

There are 3 main commands that can be used. These can be used from either command line, config file, or using the command window (RCON) when connecting to the server before it has loaded a prospect.

NOTE: If none of these commands are executed from command line or config on start up, the server will enter a waiting state that can be connected to. This allows executing RCON commands to start prospects as well as providing access to the UI flows for easier access.

These commands are (in the order that the server processes them on start up):


LoadProspect

Attempts to load a prospect by name from the Saved/PlayerData/DedicatedServer/Prospects/ folder.


Command line -LoadProspect=[ProspectSaveName]

Config LoadProspect=[ProspectSaveName]

RCON LoadProspect [ProspectSaveName]


ResumeProspect

Resumes the last prospect from the config file (LastProspectName=[ProspectSaveName])

NOTE: By default the server will do this unless changing the config value to false


Command line -ResumeProspect

Config ResumeProspect=True

RCON ResumeProspect


CreateProspect

Creates and launches a new prospect.


Command line -CreateProspect=”[ProspectType] [Difficulty] [Hardcore?] [SaveName]”

Config CreateProspect=[ProspectType] [Difficulty] [Hardcore?] [SaveName]

RCON CreateProspect [ProspectType] [Difficulty] [Hardcore?] [SaveName]


ProspectType - The internal name of the prospect to launch

Difficulty - A value of 1 to 4 for the difficulty (1 = easy, 4 = extreme)

Hardcore? - True or False value for if respawns are disabled

SaveName - The save name to use for this prospect. Must be included for outposts, if not included with regular prospects this will generate a random name.


Example: -CreateProspect="Tier1_Forest_Recon_0 3 false TestProspect01" Will create a prospect on the tutorial prospect on hard difficulty and save it as TestProspect01




Command Line Args

-SteamServerName=

Sets the session name in the server browser, limited to 64 characters

eg. -SteamServerName="This is the name of my server"


-UserDir=

Allows changing the base directory that Saved/ and other files are created in.

Path can be relative or absolute.


-saveddirsuffix=

Appends the Saved/ directory (where the logs/crash logs/saved player data/map data is stored) with the provided suffix. E.g. -saveddirsuffix=player2 would use the folder Saved_player2/


-LOG=

Log path relative to the Saved/Logs/ folder

e.g. -Log=../MyLog.log to move the log up to the Saved folder and call it MyLog


-ABSLOG=

Absolute log path

May require elevated permissions depending on path

e.g. -ABS=C:\MyLog.log


-PORT=

Set the port to use


-QueryPort=

Set the port to use for Steam server queries


-MULTIHOME=

Sets the multi-home IP to use


-ResumeProspect

Automatically try to resume the last prospect on start up

(See Prospect Setup and Load section for more info)


-LoadProspect=[ProspectName]

Loads the prospect by name from Saved/PlayerData/DedicatedServer/Prospects/ on start up.

(See Prospect Setup and Load section for more info)


-CreateProspect=”[ProspectType] [Difficulty] [Hardcore?] [SaveName]”

Creates and launches a prospect on start up using the passed in parameters.

(See Prospect Setup and Load section for more info)




Console/RCON Commands

RCON command, type / or \ then the command into the in game chat.

E.g. /AdminLogin password12345

NOTE: While not in a prospect you don’t need to include the slash before the command



Dedicated Server Lobby Commands

LoadProspect [ProspectName]

Loads a prospect from the Saved/PlayerData/DedicatedServer/Prospects/ folder. (See Prospect Setup and Load section for more info)


CreateProspect [ProspectType] [Difficulty] [Hardcore] [SaveName]

Starts a new prospect.

ProspectType- the internal name for the prospect to run.

Difficulty - from 1 (easy) to 4 (extreme)

Hardcore - True or False for if the prospect should allow respawning

SaveName - The name of the file to save

(See Prospect Setup and Load section for more info)


ResumeProspect

Resumes the last run prospect or outpost. (See Prospect Setup and Load section for more info)