List of Config Files/serversettings.xml: Difference between revisions
From Official Barotrauma Wiki
(finished creation to the best of my knowledge, depending on the relevance of this side, may require further information) |
(cleaned uncertain information, added some characters) |
||
Line 1: | Line 1: | ||
{{Version|stub= | {{Version|stub=true}}{{Main|List of Config Files}} | ||
"serversettings.xml" is the config file for hosting a server, everything form server name to auto ban time is stored in this file. | "serversettings.xml" is the config file for hosting a server, everything form server name to auto ban time is stored in this file. | ||
Line 7: | Line 7: | ||
== serversettings == | == serversettings == | ||
(?) notation means that information may be incomplete, needs confirming or may be | <!--(?) notation means that information may be incomplete, needs confirming or may be entirely false--> | ||
name="example" | name="example" | ||
* name of the server | * name of the server | ||
Line 23: | Line 23: | ||
* sets server difficulty | * sets server difficulty | ||
ServerMessage="" | ServerMessage="" | ||
* sets message shown in serverbrowser | * sets message shown in serverbrowser | ||
HiddenSubs="" | HiddenSubs="" | ||
* hides submarines in lobby(?) | * <!--hides submarines in lobby(?)--> | ||
AllowedRandomMissionTypes="Salvage,Monster,Cargo,Beacon,Nest,Mineral,Combat,AbandonedOutpost,Escort,Pirate,ScanAlienRuins,ClearAlienRuins,All" | AllowedRandomMissionTypes="Salvage,Monster,Cargo,Beacon,Nest,Mineral,Combat,AbandonedOutpost,Escort,Pirate,ScanAlienRuins,ClearAlienRuins,All" | ||
* sets missions you can get while talking to station captain(?) | * <!--sets missions you can get while talking to station captain(?)--> | ||
AllowedClientNameChars="32-33,38-46,48-57,65-90,91-91,93-93,95-122,192-255,384-591,1024-1279,19968-21327,21329-40959,13312-19903,131072-173791,173824-178207,178208-183983,63744-64255,194560-195103" | AllowedClientNameChars="32-33,38-46,48-57,65-90,91-91,93-93,95-122,192-255,384-591,1024-1279,19968-21327,21329-40959,13312-19903,131072-173791,173824-178207,178208-183983,63744-64255,194560-195103" | ||
* allows characters people are allowed to use in their names in unicode | * allows characters people are allowed to use in their names in unicode(space and !(32,33),&-.(38-46),0-9(48-57),A-Z(65-90),[(91),](93),_-z(95-122),Á-ÿ(192--255),ƀ-ɏ(384-591),Ѐ-ӿ(1024-1279),⼀-协(19968-21327),卑-鿿(21329-40959),㐀-䶿(13312-19903),𠀀-𪛟(131072-173791),𪜀-𫠠(173824-178207),𫠠-𬺰(178208-183983),豈-ff(63744-64255),?(chinese question mark)-𰀀(194560-195103)) As browsers <!--tested firefox and edge-->have problems displaying higher unicode characters this list may differ form characters used in your lobbies | ||
IsPublic="True" | IsPublic="True" | ||
* | * True makes server visible in server browser | ||
TickRate="20" | TickRate="20" | ||
* updates per second on server, all other than 20 makes game run on different speed(?) | * updates per second on server<!--, all other than 20 makes game run on different speed(?)--> | ||
RandomizeSeed="True" | RandomizeSeed="True" | ||
* generates a new seed for every "new" route taken in campaign | * generates a new seed for every "new" route taken in campaign | ||
UseRespawnShuttle="True" | UseRespawnShuttle="True" | ||
* true enables the respawn shuttle, false would spawn players on the submarine | * true enables the respawn shuttle, false would spawn players on the submarine | ||
RespawnInterval="300" | RespawnInterval="300" | ||
* time it takes for respawns to happen once the respawn threshold is met | * time it takes for respawns to happen once the respawn threshold is met | ||
MaxTransportTime="180" | MaxTransportTime="180" | ||
* time which is allowed for the shuttle to reach the submarine, if | * <!--time which is allowed for the shuttle to reach the submarine, if you dont reach the submarine in time the shuttle will despawn along with the players and try a later respawn(?)--> | ||
MinRespawnRatio="0.2" | MinRespawnRatio="0.2" | ||
* 0.2 means 20% of all players need to be waiting for a respawn for one to happen | * 0.2 means 20% of all players need to be waiting for a respawn for one to happen | ||
AutoRestartInterval="60" | AutoRestartInterval="60" | ||
* time after which server restart is attempted once down(?) | * <!--time after which server restart is attempted once down(?)--> | ||
StartWhenClientsReady="False" | StartWhenClientsReady="False" | ||
* starts the round if all lobby members are ready | * starts the round if all lobby members are ready | ||
Line 55: | Line 55: | ||
* saves server logs when True ... | * saves server logs when True ... | ||
AllowModDownloads="True" | AllowModDownloads="True" | ||
* allows clients to download mods from server(?) | * <!--allows clients to download mods from server(?)--> | ||
AllowRagdollButton="True" | AllowRagdollButton="True" | ||
* allows players to ragdoll if True | * allows players to ragdoll if True | ||
AllowFileTransfers="True" | AllowFileTransfers="True" | ||
* (?) | * <!--(?)--> | ||
VoiceChatEnabled="True" | VoiceChatEnabled="True" | ||
* enables players to use voice chat if True | * enables players to use voice chat if True | ||
Line 65: | Line 65: | ||
* sets play style | * sets play style | ||
LosMode="Transparent" | LosMode="Transparent" | ||
* (?) | * <!--(?)--> | ||
ShowEnemyHealthBars="ShowAll" | ShowEnemyHealthBars="ShowAll" | ||
* shows enemy health bars when "ShowAll" other option are "HideAll" and "OnlyBoss(Healthbars)"(?), can be changed in lobby in gameplay | * shows enemy health bars when "ShowAll"<!-- other option are "HideAll" and "OnlyBoss(Healthbars)"(?)-->, can be changed in lobby in gameplay | ||
LinesPerLogFile="800" | LinesPerLogFile="800" | ||
* maximum length of logfile, starts overwriting once maximum is reached(?) | * maximum length of logfile<!--, starts overwriting once maximum is reached(?)--> | ||
AllowVoteKick="True" | AllowVoteKick="True" | ||
* allows players to votekick if True | * allows players to votekick if True | ||
AllowEndVoting="True" | AllowEndVoting="True" | ||
* (?) | * <!--(?)--> | ||
AllowRespawn="True" | AllowRespawn="True" | ||
* allows respanwn of players | * allows respanwn of players if True | ||
BotCount="0" | BotCount="0" | ||
* sets the amount of bots that will spawn on the submarine | * sets the amount of bots that will spawn on the submarine | ||
MaxBotCount="16" | MaxBotCount="16" | ||
* sets the maximum amount of bots that might be "owned" | * sets the maximum amount of bots that might be "owned" | ||
BotSpawnMode="Normal" | BotSpawnMode="Normal" | ||
* (?) | * <!--(?)--> | ||
DisableBotConversations="False" | DisableBotConversations="False" | ||
* when True bots will no longer spam chat with feeling lonely | * when True bots will no longer spam chat with feeling lonely | ||
Line 91: | Line 91: | ||
* locks all default connections on a submarine if True | * locks all default connections on a submarine if True | ||
AllowLinkingWifiToChat="False" | AllowLinkingWifiToChat="False" | ||
* allows linking wifi signals to chat if True | * allows linking wifi signals to chat if True<!--needs further elaboration, or a link to wifi modules explaining this--> | ||
AllowFriendlyFire="True" | AllowFriendlyFire="True" | ||
* enables friendly fire if True | * enables friendly fire if True | ||
DestructibleOutposts="False" | DestructibleOutposts="False" | ||
* (?) | * <!--(?)--> | ||
KillableNPCs="True" | KillableNPCs="True" | ||
* makes NPCs killable if True | * makes NPCs killable if True | ||
Line 103: | Line 103: | ||
* sets the number of tries griefers have to guess your password, only works if option above is True | * sets the number of tries griefers have to guess your password, only works if option above is True | ||
EnableDoSProtection="True" | EnableDoSProtection="True" | ||
* enables DoS protection | * enables DoS protection, this will kick players who send more packets than specified in MaxPacketAmount | ||
MaxPacketAmount="3000" | MaxPacketAmount="3000" | ||
* sets the maximum amount of packets a player(client) might send before they are regarded as spamming/DoS | * sets the maximum amount of packets a player(client) might send before they are regarded as spamming/DoS attempt, you might want to increase this amount when playing with many mods, increasing may cause networking issues | ||
SelectedSubmarine="Azimuth" | SelectedSubmarine="Azimuth" | ||
* sets selected submarine for playing(?) | * <!--sets selected submarine for playing(?)--> | ||
SelectedShuttle="Hemulen" | SelectedShuttle="Hemulen" | ||
* sets the respawn shuttle that will always be there for you | * sets the respawn shuttle that will always be there for you | ||
TraitorsEnabled="No" | TraitorsEnabled="No" | ||
* enables traitors when Yes(?), can be changed in settings | * enables traitors<!-- when Yes(?)-->, can be changed in lobby settings | ||
TraitorsMinPlayerCount="1" | TraitorsMinPlayerCount="1" | ||
* number of players needed for traitors to appear | * number of players needed for traitors to appear | ||
Line 123: | Line 123: | ||
* maximum delay after which a traitor will get their first mission | * maximum delay after which a traitor will get their first mission | ||
Language="English" | Language="English" | ||
* language of the game and bots(?) | * language of the game<!-- and bots(?)--> | ||
SubSelectionMode="Manual" | SubSelectionMode="Manual" | ||
* determines how a submarine shall be selected, mostly usefull when setting up servers that the host does not (always) play on | * determines how a submarine shall be selected, mostly usefull when setting up servers that the host does not (always) play on | ||
Line 129: | Line 129: | ||
* determines how a mode shall be selected, mostly usefull when setting up servers that the host does not (always) play on | * determines how a mode shall be selected, mostly usefull when setting up servers that the host does not (always) play on | ||
EndVoteRequiredRatio="0.6" | EndVoteRequiredRatio="0.6" | ||
* (?) | * <!--(?)--> | ||
VoteRequiredRatio="0.6" | VoteRequiredRatio="0.6" | ||
* 0.6=60% percentage of people it takes to complete a vote(?) | * <!--0.6=60% percentage of people it takes to complete a vote(?)--> | ||
VoteTimeout="30" | VoteTimeout="30" | ||
* time to vote before it runs out | * time to vote before it runs out | ||
Line 141: | Line 141: | ||
* time after disconnecting in which the players character stays alive if no harm comes his way, after this time runs out the character will die of brain damage | * time after disconnecting in which the players character stays alive if no harm comes his way, after this time runs out the character will die of brain damage | ||
KickAFKTime="600" | KickAFKTime="600" | ||
* time it takes for AFK players to be kicked, sleeping in bunks does not count as beeing AFK(?) | * time it takes for AFK players to be kicked<!--, sleeping in bunks does not count as beeing AFK(?)--> | ||
KarmaEnabled="True" | KarmaEnabled="True" | ||
* enables karma on server if True | * enables karma on server if True | ||
Line 147: | Line 147: | ||
* sets the preset for karma, can be customised in the lobby settings | * sets the preset for karma, can be customised in the lobby settings | ||
GameModeIdentifier="multiplayercampaign" | GameModeIdentifier="multiplayercampaign" | ||
* (?) | * <!--(?)--> | ||
MissionType="All" | MissionType="All" | ||
* may set the mission if you just play a mission as opposed to an entire campaign(i dont know the difference between this and AllowedRandomMissionTypes?) | * may set the mission if you just play a mission as opposed to an entire campaign(i dont know the difference between this and AllowedRandomMissionTypes?) | ||
Line 155: | Line 155: | ||
* the time people get banned for entering the password poorly | * the time people get banned for entering the password poorly | ||
MaxAutoBanTime="86400" | MaxAutoBanTime="86400" | ||
* (?) | * <!--(?)--> | ||
LootedMoneyDestination="Bank" | LootedMoneyDestination="Bank" | ||
* decides wether looted money goes to bank or the player's wallet | * decides wether looted money goes to bank or the player's wallet | ||
Line 163: | Line 163: | ||
from here on out campaign settings start | from here on out campaign settings start | ||
PresetName="" | PresetName="" | ||
* (?) | * <!--(?)--> | ||
TutorialEnabled="False" | TutorialEnabled="False" | ||
* (?) | * <!--(?)--> | ||
RadiationEnabled="False" | RadiationEnabled="False" | ||
* enables radiation in campaign | * enables radiation in campaign | ||
MaxMissionCount="2" | MaxMissionCount="2" | ||
* limits the number of missions one may take for a route between two stations, becons are not counted, NPC missions are not counted(?) | * limits the number of missions one may take for a route between two stations, becons are not counted<!--, NPC missions are not counted(?)--> | ||
StartingBalanceAmount="Medium" | StartingBalanceAmount="Medium" | ||
* a starting money setting for the start of your campaign, possible options are "Low","Medium" and "High"(?) | * a starting money setting for the start of your campaign<!--, possible options are "Low","Medium" and "High"(?)--> | ||
Difficulty="Medium" | Difficulty="Medium" | ||
* a difficulty setting for your campaign, possible options are "Low","Medium" and "High"(?) | * a difficulty setting for your campaign<!--, possible options are "Low","Medium" and "High"(?)--> | ||
StartItemSet="normal" | StartItemSet="normal" | ||
* selects the amount of starting items, additional items may be added to your start in the lobby settings | * selects the amount of starting items, additional items may be added to your start in the lobby settings |
Revision as of 14:11, 12 August 2023
Data is potentially outdated | |
Last updated for an unknown version The current game version is 1.4.6.0 |
Main article: List of Config Files
"serversettings.xml" is the config file for hosting a server, everything form server name to auto ban time is stored in this file.
Most notable settings that might be relevant for hosting (private) games that cannot be changed in the lobby are:
- KickAFKTime (time after which an incative player is kicked from the server)
- KillDisconnectedTime (time after which a disconnected player's character dies ingame, increase this value if your crew has troubble reconnecting fast enough)
serversettings
name="example"
- name of the server
port="12345"
- port of the server
queryport="54321"
- queryport of the server
password="totalLysavePaSsword2!"
- password of the server
enableupnp="false"
- enables universal plug and play
autorestart="false"
- enables automatic restart of the server in case of chrash
LevelDifficulty="20"
- sets server difficulty
ServerMessage=""
- sets message shown in serverbrowser
HiddenSubs=""
AllowedRandomMissionTypes="Salvage,Monster,Cargo,Beacon,Nest,Mineral,Combat,AbandonedOutpost,Escort,Pirate,ScanAlienRuins,ClearAlienRuins,All"
AllowedClientNameChars="32-33,38-46,48-57,65-90,91-91,93-93,95-122,192-255,384-591,1024-1279,19968-21327,21329-40959,13312-19903,131072-173791,173824-178207,178208-183983,63744-64255,194560-195103"
- allows characters people are allowed to use in their names in unicode(space and !(32,33),&-.(38-46),0-9(48-57),A-Z(65-90),[(91),](93),_-z(95-122),Á-ÿ(192--255),ƀ-ɏ(384-591),Ѐ-ӿ(1024-1279),⼀-协(19968-21327),卑-鿿(21329-40959),㐀-䶿(13312-19903),𠀀-𪛟(131072-173791),𪜀-𫠠(173824-178207),𫠠-𬺰(178208-183983),豈-ff(63744-64255),?(chinese question mark)-𰀀(194560-195103)) As browsers have problems displaying higher unicode characters this list may differ form characters used in your lobbies
IsPublic="True"
- True makes server visible in server browser
TickRate="20"
- updates per second on server
RandomizeSeed="True"
- generates a new seed for every "new" route taken in campaign
UseRespawnShuttle="True"
- true enables the respawn shuttle, false would spawn players on the submarine
RespawnInterval="300"
- time it takes for respawns to happen once the respawn threshold is met
MaxTransportTime="180"
MinRespawnRatio="0.2"
- 0.2 means 20% of all players need to be waiting for a respawn for one to happen
AutoRestartInterval="60"
StartWhenClientsReady="False"
- starts the round if all lobby members are ready
StartWhenClientsReadyRatio="0.8"
- starts the round when 0.8 = 80% of players are ready
AllowSpectating="True"
- allows spectating when True
SaveServerLogs="True"
- saves server logs when True ...
AllowModDownloads="True"
AllowRagdollButton="True"
- allows players to ragdoll if True
AllowFileTransfers="True"
VoiceChatEnabled="True"
- enables players to use voice chat if True
PlayStyle="Casual"
- sets play style
LosMode="Transparent"
ShowEnemyHealthBars="ShowAll"
- shows enemy health bars when "ShowAll", can be changed in lobby in gameplay
LinesPerLogFile="800"
- maximum length of logfile
AllowVoteKick="True"
- allows players to votekick if True
AllowEndVoting="True"
AllowRespawn="True"
- allows respanwn of players if True
BotCount="0"
- sets the amount of bots that will spawn on the submarine
MaxBotCount="16"
- sets the maximum amount of bots that might be "owned"
BotSpawnMode="Normal"
DisableBotConversations="False"
- when True bots will no longer spam chat with feeling lonely
AllowDisguises="True"
- allows crew to take identities form ID cards if True
AllowRewiring="True"
- allows crew to rewire the submarine if True
LockAllDefaultWires="False"
- locks all default connections on a submarine if True
AllowLinkingWifiToChat="False"
- allows linking wifi signals to chat if True
AllowFriendlyFire="True"
- enables friendly fire if True
DestructibleOutposts="False"
KillableNPCs="True"
- makes NPCs killable if True
BanAfterWrongPassword="False"
- bans a player for a set amount of time if "MaxPasswordRetriesBeforeBan" is exceeded if True
MaxPasswordRetriesBeforeBan="3"
- sets the number of tries griefers have to guess your password, only works if option above is True
EnableDoSProtection="True"
- enables DoS protection, this will kick players who send more packets than specified in MaxPacketAmount
MaxPacketAmount="3000"
- sets the maximum amount of packets a player(client) might send before they are regarded as spamming/DoS attempt, you might want to increase this amount when playing with many mods, increasing may cause networking issues
SelectedSubmarine="Azimuth"
SelectedShuttle="Hemulen"
- sets the respawn shuttle that will always be there for you
TraitorsEnabled="No"
- enables traitors, can be changed in lobby settings
TraitorsMinPlayerCount="1"
- number of players needed for traitors to appear
TraitorsMinStartDelay="90"
- minimum delay after round start until the traitors get their first mission
TraitorsMaxStartDelay="180"
- maximum delay after round start after which traitors will definetly get their mission
TraitorsMinRestartDelay="30"
- minimum delay after traitor death when a new traitor may get their first mission
TraitorsMaxRestartDelay="90"
- maximum delay after which a traitor will get their first mission
Language="English"
- language of the game
SubSelectionMode="Manual"
- determines how a submarine shall be selected, mostly usefull when setting up servers that the host does not (always) play on
ModeSelectionMode="Manual"
- determines how a mode shall be selected, mostly usefull when setting up servers that the host does not (always) play on
EndVoteRequiredRatio="0.6"
VoteRequiredRatio="0.6"
VoteTimeout="30"
- time to vote before it runs out
KickVoteRequiredRatio="0.6"
- 0.6=60% percentage of people it takes to kick someone)
DisallowKickVoteTime="120"
- time it takes for the same person to be vote kicked again
KillDisconnectedTime="300"
- time after disconnecting in which the players character stays alive if no harm comes his way, after this time runs out the character will die of brain damage
KickAFKTime="600"
- time it takes for AFK players to be kicked
KarmaEnabled="True"
- enables karma on server if True
KarmaPreset="default"
- sets the preset for karma, can be customised in the lobby settings
GameModeIdentifier="multiplayercampaign"
MissionType="All"
- may set the mission if you just play a mission as opposed to an entire campaign(i dont know the difference between this and AllowedRandomMissionTypes?)
MaxPlayers="8"
- sets the maximum amount of people who can join the server
AutoBanTime="3600"
- the time people get banned for entering the password poorly
MaxAutoBanTime="86400"
LootedMoneyDestination="Bank"
- decides wether looted money goes to bank or the player's wallet
MaximumMoneyTransferRequest="999999">
- sets the maximum amount of money that may be transfered at once
<campaignsettings
from here on out campaign settings start
PresetName=""
TutorialEnabled="False"
RadiationEnabled="False"
- enables radiation in campaign
MaxMissionCount="2"
- limits the number of missions one may take for a route between two stations, becons are not counted
StartingBalanceAmount="Medium"
- a starting money setting for the start of your campaign
Difficulty="Medium"
- a difficulty setting for your campaign
StartItemSet="normal"
- selects the amount of starting items, additional items may be added to your start in the lobby settings