Thanks for visiting our wiki! Click here to order your own game server at SurvivalServers.com

Difference between revisions of "Sons of The Forest Server Settings"

From Survival Servers
Jump to navigation Jump to search
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
To change settings for your server, you will need to access the config file via FTP (File Transfer Protocol) to do so.
+
To change settings for your server, you will need to access the config file via [[FTP Access|FTP]] or by using your control panel.
−
To edit/upload/save/delete files via FTP, use the following method:
+
===FTP===
−
 
 
 
#Stop your server from the panel.
 
#Stop your server from the panel.
−
#Log in to FTP using WinSCP (a free FTP software) using the connection details found in the "FTP Details" section of the game server control panel. Download link for WinSCP here: http://winscp.net/eng/download.php
+
#Log in to [[FTP Access|FTP]].
−
#Navigate to the directory you wish to upload or edit a file.<br>You want to edit the Server.cfg file.
+
#Navigate to the directory you wish to upload or edit a file.<br>You want to edit the '''dedicatedserver.cfg''' file.
 
#Open up the file using a text editor like Notepad or Notepad++.<br>If you are not familiar with configuration files, any line starting with two slashes is ignored by the program.<br>// This is a comment and will not be read by a file
 
#Open up the file using a text editor like Notepad or Notepad++.<br>If you are not familiar with configuration files, any line starting with two slashes is ignored by the program.<br>// This is a comment and will not be read by a file
  
−
==Settings==
+
===Control panel===
 +
#Click the '''Dedicatedserver.cfg''' button under the '''Advanced Config''' section of your control panel.
 +
#Edit the your desired settings.
 +
 
 +
==Config Settings==
 +
{| class="wikitable"
 +
! style="font-weight: bold;" | Command
 +
! style="font-weight: bold;" | Description
 +
|-
 +
| '''"IpAddress": "0.0.0.0""'''
 +
|Listening interface for the game server, usually 0.0.0.0 if listening on all interfaces.
 +
|-
 +
|'''"GamePort": 8766'''
 +
|UDP port used for gameplay netcode (Bolt).
 +
|-
 +
|'''"QueryPort": 27016"'''
 +
|UDP port used by Steam to list the server and enable the discovery services.
 +
|-
 +
|'''"BlobSyncPort": 9700'''
 +
| BlobSyncPort UDP port used by the BlobSync system to initialize game systems and exchange data.
 +
|-
 +
|'''"ServerName": "Sons Of The Forest Server (dedicated)"'''
 +
|Name of the server visible in the server list, and in the Steam contacts.
 +
|-
 +
|'''"MaxPlayers": 8'''
 +
|The maximum number of players allowed simultaneously on the server.
 +
|-
 +
|'''"Password": ""'''
 +
| Adds a password to make your server “private”. Upon connection, this password will be requested before the client can proceed.
 +
|-
 +
|'''"LanOnly": false'''
 +
| Allows or restricts the server visibility to LAN only.
 +
|-
 +
|'''"SaveSlot": 1'''
 +
|When creating a new save, this number will be the id of the save.
 +
|-
 +
|'''"SaveMode": "Continue"'''
 +
|Game save initialization mode.
 +
• “continue”: will create a new save on SaveSlot if it doesn’t exist, or load it if it exist.
 +
• “new”: will create a new game, with a new game id, and overwrite any game previously saved on the SaveSlot. If the server stops and restarts, the previous save will be overwritten for as long as the mode is set to “new”.
 +
|-
 +
|'''"GameMode": "Normal"'''
 +
| Sets the difficulty game mode when creating a new save. This parameter is ignored if loading a save (save mode set to “continue” with a save that exists on the slot). If the game mode is set to “custom”, then the custom game mode settings will be read from CustomGameModeSettings option, described later.
 +
|-
 +
|'''"SaveInterval": 600'''
 +
|How often the game server automatically saves the game to SaveSlot, in seconds.
 +
|-
 +
|'''"IdleDayCycleSpeed": 0.0'''
 +
|A multiplier to how quickly the time passes compared to normal gameplay when the server is considered idle (no player connected).
 +
|-
 +
|'''"IdleTargetFramerate": 5'''
 +
|Target framerate of the server when it’s considered idle (no player connected).
 +
|-
 +
|'''"ActiveTargetFramerate": 60'''
 +
| Target framerate of the server when it’s NOT considered idle (one or more player connected).
 +
|-
 +
|'''"LogFilesEnabled": false'''
 +
|Defines if the logs will be written to files. The logs will be output in <user data folder>/logs.
 +
|-
 +
|'''"TimestampLogFilenames": true'''
 +
|Enabled log files timestamping.
 +
• “true”: every time the server runs will dump log output to a new file, with filename having the following format: sotf_log_{DateTime:yyyy-MM-dd_HH-mm-ss}.txt
 +
• “false”: the filename will be sotf_log.txt and previous log will be overwritten if it already exists.
 +
|-
 +
|'''"TimestampLogEntries": true'''
 +
|Enables each log entry written to file to be timestamped.
 +
|-
 +
|'''"GameSettings": {}'''
 +
| A key value map of all game settings you can use to tweak your game (in any mode). All parameters will be listed in the table below, along with their possible values. If the value is null, or empty, default settings will be used.
 +
|-
 +
|'''"CustomGameModeSettings": {}'''
 +
| A key value map of all settings available to customize your game in custom mode. All parameters will be listed in the table below, along with their possible values. If the value is null, or empty, default settings will be used. This parameter is ignored if the game mode is not “custom” or if loading a save (save mode set to “continue” with a save that exists on the slot), whether is it “custom” or not.
 +
|-
 +
|}
 +
 
 +
==Game Settings==
 +
{| class="wikitable"
 +
! style="font-weight: bold;" | Command
 +
! style="font-weight: bold;" | Description
 +
|-
 +
| '''"Gameplay.TreeRegrowth": true'''
 +
|Enable automatic tree regrowth, triggered when sleeping. Values: true, false
 +
|-
 +
| '''"Structure.Damage": true'''
 +
|Allow buildings to be damaged. Values: true, false
 +
|-
 +
|}
  
−
// Server IP address - Note: If you have a router, this address is the internal address, and you need to configure ports forwarding<br>
+
==Custom Game Mode Settings==
−
serverIP 45.34.121.143<br>
+
{| class="wikitable"
−
// Steam Communication Port - Note: If you have a router you will need to open this port.<br>
+
! style="font-weight: bold;" | Command
−
serverSteamPort 10417<br>
+
! style="font-weight: bold;" | Description
−
// Game Communication Port - Note: If you have a router you will need to open this port.<br>
+
|-
−
serverGamePort 10415<br>
+
| '''"GameSetting.Vail.EnemySpawn": true'''
−
// Query Communication Port - Note: If you have a router you will need to open this port.<br>
+
|Enable enemies spawning. Values: true, false
−
serverQueryPort 10416<br>
+
|-
−
// Server display name<br>
+
| '''"GameSetting.Vail.EnemyHealth": "Normal"'''
−
serverName Dev Test by SurvivalServers.com<br>
+
|Adjust enemy starting health. Values: low, normal, high
−
// Maximum number of players<br>
+
|-
−
serverPlayers 20<br>
+
| '''"GameSetting.Vail.EnemyDamage": "Normal"'''
−
// Enable VAC (Valve Anti-cheat System at the server. Must be set off or on<br>
+
|Adjust damage enemies can do. Values: low, normal, high
−
enableVAC on<br>
+
|-
−
// Server password. blank means no password<br>
+
| '''"GameSetting.Vail.EnemyArmour": "Normal"'''
−
serverPassword <br>
+
|Adjust enemies armor strength. Values: low, normal, high
−
// Server administration password. blank means no password<br>
+
|-
−
serverPasswordAdmin changeme<br>
+
| '''"GameSetting.Vail.EnemyAggression": "Normal"'''
−
// Your Steam account name. blank means anonymous<br>
+
|Adjust enemy aggression level. Values: low, normal, high
−
serverSteamAccount<br>
+
|-
−
// Time between server auto saves in minutes - The minumum time is 15 minutes, the default time is 30<br>
+
| '''"GameSetting.Vail.AnimalSpawnRate": "Normal"'''
−
serverAutoSaveInterval 15<br>
+
| Adjust animal spawn rate. Values: low, normal, high
−
// Game difficulty mode. Must be set to Peaceful Normal or Hard<br>
+
|-
−
difficulty Normal<br>
+
| '''"GameSetting.Environment.StartingSeason": "Summer"'''
−
// New or continue a game. Must be set to New or Continue<br>
+
|Set environmental starting season. Values: spring, summer, autumn, winter
−
initType Continue<br>
+
|-
−
// Slot to save the game. Must be set 1 2 3 4 or 5<br>
+
| '''"GameSetting.Environment.SeasonLength": "Default"'''
−
slot 1<br>
+
|Adjust season length. Values: short, default, long, realistic
−
// Show event log. Must be set off or on<br>
+
|-
−
showLogs on<br>
+
| '''"Structure.Damage": "true"'''
−
// Contact email for server admin<br>
+
|Allow buildings to be damaged. Values: true, false
−
serverContact email@gmail.com<br>
+
|-
−
// No enemies<br>
+
| '''"GameSetting.Environment.DayLength": "Default"'''
−
veganMode off<br>
+
|Adjust day length. Values: short, default, long, realistic
−
// No enemies during day time<br>
+
|-
−
vegetarianMode off<br>
+
| '''"GameSetting.Environment.PrecipitationFrequency": "Default"'''
−
// Reset all structure holes when loading a save<br>
+
|Adjust the frequency of rain and snow. Values: low, default, high
−
resetHolesMode off<br>
+
|-
−
// Regrow 10% of cut down trees when sleeping<br>
+
| '''"GameSetting.Survival.ConsumableEffects": "Normal"'''
−
treeRegrowMode off<br>
+
|Enable damage taken when low hydration and low fullness. Values: normal, hard
−
// Allow building destruction<br>
+
|-
−
allowBuildingDestruction on<br>
+
| '''"GameSetting.Survival.PlayerStatsDamage": "Off"'''
−
// Allow enemies in creative games<br>
+
|Enable damage from each bad or rotten food and drink. Values: off, normal, hard
−
allowEnemiesCreativeMode off
+
|-
 +
| '''"GameSetting.Survival.ColdPenalties": "Off"'''
 +
|Adjusts the severity that cold will affect health and stamina regeneration. Values: off, normal, hard
 +
|-
 +
| '''"GameSetting.Survival.ReducedFoodInContainers": false'''
 +
|Reduces the amount of food found in containers. Values: true, false
 +
|-
 +
| '''"GameSetting.Survival.SingleUseContainers": false'''
 +
|Containers can only be opened once. Values: true, false
 +
|-
 +
|}

Latest revision as of 08:57, 24 June 2023

To change settings for your server, you will need to access the config file via FTP or by using your control panel.

FTP

  1. Stop your server from the panel.
  2. Log in to FTP.
  3. Navigate to the directory you wish to upload or edit a file.
    You want to edit the dedicatedserver.cfg file.
  4. Open up the file using a text editor like Notepad or Notepad++.
    If you are not familiar with configuration files, any line starting with two slashes is ignored by the program.
    // This is a comment and will not be read by a file

Control panel

  1. Click the Dedicatedserver.cfg button under the Advanced Config section of your control panel.
  2. Edit the your desired settings.

Config Settings

Command Description
"IpAddress": "0.0.0.0"" Listening interface for the game server, usually 0.0.0.0 if listening on all interfaces.
"GamePort": 8766 UDP port used for gameplay netcode (Bolt).
"QueryPort": 27016" UDP port used by Steam to list the server and enable the discovery services.
"BlobSyncPort": 9700 BlobSyncPort UDP port used by the BlobSync system to initialize game systems and exchange data.
"ServerName": "Sons Of The Forest Server (dedicated)" Name of the server visible in the server list, and in the Steam contacts.
"MaxPlayers": 8 The maximum number of players allowed simultaneously on the server.
"Password": "" Adds a password to make your server “private”. Upon connection, this password will be requested before the client can proceed.
"LanOnly": false Allows or restricts the server visibility to LAN only.
"SaveSlot": 1 When creating a new save, this number will be the id of the save.
"SaveMode": "Continue" Game save initialization mode.

• “continue”: will create a new save on SaveSlot if it doesn’t exist, or load it if it exist. • “new”: will create a new game, with a new game id, and overwrite any game previously saved on the SaveSlot. If the server stops and restarts, the previous save will be overwritten for as long as the mode is set to “new”.

"GameMode": "Normal" Sets the difficulty game mode when creating a new save. This parameter is ignored if loading a save (save mode set to “continue” with a save that exists on the slot). If the game mode is set to “custom”, then the custom game mode settings will be read from CustomGameModeSettings option, described later.
"SaveInterval": 600 How often the game server automatically saves the game to SaveSlot, in seconds.
"IdleDayCycleSpeed": 0.0 A multiplier to how quickly the time passes compared to normal gameplay when the server is considered idle (no player connected).
"IdleTargetFramerate": 5 Target framerate of the server when it’s considered idle (no player connected).
"ActiveTargetFramerate": 60 Target framerate of the server when it’s NOT considered idle (one or more player connected).
"LogFilesEnabled": false Defines if the logs will be written to files. The logs will be output in <user data folder>/logs.
"TimestampLogFilenames": true Enabled log files timestamping.

• “true”: every time the server runs will dump log output to a new file, with filename having the following format: sotf_log_{DateTime:yyyy-MM-dd_HH-mm-ss}.txt • “false”: the filename will be sotf_log.txt and previous log will be overwritten if it already exists.

"TimestampLogEntries": true Enables each log entry written to file to be timestamped.
"GameSettings": {} A key value map of all game settings you can use to tweak your game (in any mode). All parameters will be listed in the table below, along with their possible values. If the value is null, or empty, default settings will be used.
"CustomGameModeSettings": {} A key value map of all settings available to customize your game in custom mode. All parameters will be listed in the table below, along with their possible values. If the value is null, or empty, default settings will be used. This parameter is ignored if the game mode is not “custom” or if loading a save (save mode set to “continue” with a save that exists on the slot), whether is it “custom” or not.

Game Settings

Command Description
"Gameplay.TreeRegrowth": true Enable automatic tree regrowth, triggered when sleeping. Values: true, false
"Structure.Damage": true Allow buildings to be damaged. Values: true, false

Custom Game Mode Settings

Command Description
"GameSetting.Vail.EnemySpawn": true Enable enemies spawning. Values: true, false
"GameSetting.Vail.EnemyHealth": "Normal" Adjust enemy starting health. Values: low, normal, high
"GameSetting.Vail.EnemyDamage": "Normal" Adjust damage enemies can do. Values: low, normal, high
"GameSetting.Vail.EnemyArmour": "Normal" Adjust enemies armor strength. Values: low, normal, high
"GameSetting.Vail.EnemyAggression": "Normal" Adjust enemy aggression level. Values: low, normal, high
"GameSetting.Vail.AnimalSpawnRate": "Normal" Adjust animal spawn rate. Values: low, normal, high
"GameSetting.Environment.StartingSeason": "Summer" Set environmental starting season. Values: spring, summer, autumn, winter
"GameSetting.Environment.SeasonLength": "Default" Adjust season length. Values: short, default, long, realistic
"Structure.Damage": "true" Allow buildings to be damaged. Values: true, false
"GameSetting.Environment.DayLength": "Default" Adjust day length. Values: short, default, long, realistic
"GameSetting.Environment.PrecipitationFrequency": "Default" Adjust the frequency of rain and snow. Values: low, default, high
"GameSetting.Survival.ConsumableEffects": "Normal" Enable damage taken when low hydration and low fullness. Values: normal, hard
"GameSetting.Survival.PlayerStatsDamage": "Off" Enable damage from each bad or rotten food and drink. Values: off, normal, hard
"GameSetting.Survival.ColdPenalties": "Off" Adjusts the severity that cold will affect health and stamina regeneration. Values: off, normal, hard
"GameSetting.Survival.ReducedFoodInContainers": false Reduces the amount of food found in containers. Values: true, false
"GameSetting.Survival.SingleUseContainers": false Containers can only be opened once. Values: true, false
Retrieved from "https://survivalservers.com/wiki/index.php?title=Sons_of_The_Forest_Server_Settings&oldid=2989"

Share your opinion