Serversettings.xml: Difference between revisions
Line 83: | Line 83: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Sets if the server should generate a new seed each round. | |Sets if the server should generate a new seed each round. | ||
*True - Server randomizes seed when starting a new round. | *'''True''' - Server randomizes seed when starting a new round. | ||
*False - Server doesn't randomize seed, uses the same seed set in the lobby. | *'''False''' - Server doesn't randomize seed, uses the same seed set in the lobby. | ||
|- | |- | ||
|userespawnshuttle | |userespawnshuttle | ||
Line 91: | Line 91: | ||
|Allows or disallows the use of a respawn shuttle for respawning. | |Allows or disallows the use of a respawn shuttle for respawning. | ||
'''Only works if respawning is allowed.''' | '''Only works if respawning is allowed.''' | ||
*True - Uses respawn shuttle, respawning players spawn in a shuttle a distance from the main submarine and must dock or otherwise merge with the crew. | *'''True''' - Uses respawn shuttle, respawning players spawn in a shuttle a distance from the main submarine and must dock or otherwise merge with the crew. | ||
*False - Doesn't use respawn shuttle, players are spawned in the submarine on certain job spawnpoints, depending on their job. | *'''False''' - Doesn't use respawn shuttle, players are spawned in the submarine on certain job spawnpoints, depending on their job. | ||
|- | |- | ||
|respawninterval | |respawninterval | ||
Line 121: | Line 121: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows the server to automatically start a round if enough players are ready. | |Allows or disallows the server to automatically start a round if enough players are ready. | ||
*True - Starts automatically if the set client ratio is met. | *'''True''' - Starts automatically if the set client ratio is met. | ||
*False - Ignores ready clients, must be manually started. | *'''False''' - Ignores ready clients, must be manually started. | ||
|- | |- | ||
|startwhenclientsreadyratio | |startwhenclientsreadyratio | ||
Line 134: | Line 134: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows players from spectating. | |Allows or disallows players from spectating. | ||
*True - Dead players can spectate. | *'''True''' - Dead players can spectate. | ||
*False - Dead players cannot spectate and are sent into the lobby. | *'''False''' - Dead players cannot spectate and are sent into the lobby. | ||
|- | |- | ||
|endroundatlevelend | |endroundatlevelend | ||
Line 141: | Line 141: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Sets if the round should be ended once the submarine reaches the end of the level. (Doesn't dock) | |Sets if the round should be ended once the submarine reaches the end of the level. (Doesn't dock) | ||
*True - Once the submarine docks, or is close to the last outpost and a player entered the outpost the round is automatically ended. | *'''True''' - Once the submarine docks, or is close to the last outpost and a player entered the outpost the round is automatically ended. | ||
*False - Players must vote to end or an admin must use the endround command to manually end the round. | *'''False''' - Players must vote to end or an admin must use the endround command to manually end the round. | ||
|- | |- | ||
|saveserverlogs | |saveserverlogs | ||
Line 148: | Line 148: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Sets if server logs should be saved once the server is turned off. | |Sets if server logs should be saved once the server is turned off. | ||
*True - Server logs are saved in the ServerLogs folder upon server shutdown. | *'''True''' - Server logs are saved in the ServerLogs folder upon server shutdown. | ||
*False - Server logs aren't saved. | *'''False''' - Server logs aren't saved. | ||
|- | |- | ||
|allowragdollbutton | |allowragdollbutton | ||
Line 155: | Line 155: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows the use of the ragdoll button. (Exact key is dependant on keybind configuration) | |Allows or disallows the use of the ragdoll button. (Exact key is dependant on keybind configuration) | ||
*True - Players can ragdoll on their own if they hold the button down. | *'''True''' - Players can ragdoll on their own if they hold the button down. | ||
*False - Players cannot ragdoll on their own, players must be stunned (or be dead) to ragdoll. | *'''False''' - Players cannot ragdoll on their own, players must be stunned (or be dead) to ragdoll. | ||
|- | |- | ||
|allowfiletransfers | |allowfiletransfers | ||
Line 163: | Line 163: | ||
|Allows or disallows file transfers for server files to clients. | |Allows or disallows file transfers for server files to clients. | ||
'''Note: currently only .sub files can be transfered, if a client is missing a content package they won't be able to connect at all.''' | '''Note: currently only .sub files can be transfered, if a client is missing a content package they won't be able to connect at all.''' | ||
*True - Server will send missing files to clients. | *'''True''' - Server will send missing files to clients. | ||
*False - Server won't send missing files to clients, if a client is missing the required files they will not be able to spawn and will be kicked back into the lobby. | *'''False''' - Server won't send missing files to clients, if a client is missing the required files they will not be able to spawn and will be kicked back into the lobby. | ||
|- | |- | ||
|voicechatenabled | |voicechatenabled | ||
Line 170: | Line 170: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows the use of voicechat. | |Allows or disallows the use of voicechat. | ||
*True - Players can use voicechat. | *'''True''' - Players can use voicechat. | ||
*False - Players cannot use voicechat. | *'''False''' - Players cannot use voicechat. | ||
|- | |- | ||
|playstyle | |playstyle | ||
Line 177: | Line 177: | ||
|Serious/Casual/Roleplay/Rampage/SomethingDifferent (String) | |Serious/Casual/Roleplay/Rampage/SomethingDifferent (String) | ||
|Sets server playstyle displayed in the server browser and lobby. | |Sets server playstyle displayed in the server browser and lobby. | ||
*Serious - "The crew should focus on working together efficiently and completing their objective. No unnecessary messing around." | *'''Serious''' - "The crew should focus on working together efficiently and completing their objective. No unnecessary messing around." | ||
*Casual - "Having fun is more important than completing the objective. A good choice for new players." | *'''Casual''' - "Having fun is more important than completing the objective. A good choice for new players." | ||
*Roleplay - "The crew should aim to act like a real submarine crew. Chain of command is important, as is taking care of your responsibilities and following orders. Speaking out-of-character should be avoided when a round is running." | *'''Roleplay''' - "The crew should aim to act like a real submarine crew. Chain of command is important, as is taking care of your responsibilities and following orders. Speaking out-of-character should be avoided when a round is running." | ||
*Rampage - "Get ready to fight for your life! A server heavily geared toward combat. This can mean player-versus-player combat, PvE or both—the server description should include guidelines as to what kind of violence is allowed on the server." | *'''Rampage''' - "Get ready to fight for your life! A server heavily geared toward combat. This can mean player-versus-player combat, PvE or both—the server description should include guidelines as to what kind of violence is allowed on the server." | ||
*SomethingDifferent - "Gameplay differs significantly from the usual Barotrauma gameplay. Modded servers, very unconventional subs, battle royale rounds, shuttle racing, deathrun maps... Anything goes!" | *'''SomethingDifferent''' - "Gameplay differs significantly from the usual Barotrauma gameplay. Modded servers, very unconventional subs, battle royale rounds, shuttle racing, deathrun maps... Anything goes!" | ||
|- | |- | ||
|allowvotekick | |allowvotekick | ||
Line 187: | Line 187: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows players from voting to kick other players. | |Allows or disallows players from voting to kick other players. | ||
*True - Players can vote to kick. | *'''True''' - Players can vote to kick. | ||
*False - Players cannot vote to kick. | *'''False''' - Players cannot vote to kick. | ||
|- | |- | ||
|allowendvoting | |allowendvoting | ||
Line 194: | Line 194: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows players from voting to end the round. | |Allows or disallows players from voting to end the round. | ||
*True - Players can vote to end the round. | *'''True''' - Players can vote to end the round. | ||
*False - Players cannot vote to end the round, the tickbox also doesn't appear at all. | *'''False''' - Players cannot vote to end the round, the tickbox also doesn't appear at all. | ||
|- | |- | ||
|allowrespawn | |allowrespawn | ||
Line 201: | Line 201: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows respawning. | |Allows or disallows respawning. | ||
*True - Players can respawn once dead. | *'''True''' - Players can respawn once dead. | ||
*False - Players cannot respawn and will have to spectate until the round ends. | *'''False''' - Players cannot respawn and will have to spectate until the round ends. | ||
|- | |- | ||
|botcount | |botcount | ||
Line 218: | Line 218: | ||
|Normal/Fill (String) | |Normal/Fill (String) | ||
|Sets how bots should be spawned. | |Sets how bots should be spawned. | ||
*Normal - Bots fill the amount of slots set in botcount. | *'''Normal''' - Bots fill the amount of slots set in botcount. | ||
*Fill - Bots skip the botcount value and fully fill the rest of the player slots. | *'''Fill''' - Bots skip the botcount value and fully fill the rest of the player slots. | ||
|- | |- | ||
|allowdisguises | |allowdisguises | ||
Line 225: | Line 225: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows players to disguise themselves. | |Allows or disallows players to disguise themselves. | ||
*True - Players can disguise themselves by using another player's id card. | *'''True''' - Players can disguise themselves by using another player's id card. | ||
*False - Players cannot disguise themselves and will always have their names above them even when covering their face. | *'''False''' - Players cannot disguise themselves and will always have their names above them even when covering their face. | ||
|- | |- | ||
|allowrewiring | |allowrewiring | ||
Line 232: | Line 232: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows players from rewiring anything. | |Allows or disallows players from rewiring anything. | ||
*True - Players can rewire anything except if it has been set otherwise in the submarine. | *'''True''' - Players can rewire anything except if it has been set otherwise in the submarine. | ||
*False - Players cannot rewire anything in a submarine. | *'''False''' - Players cannot rewire anything in a submarine. | ||
|- | |- | ||
|allowfriendlyfire | |allowfriendlyfire | ||
Line 239: | Line 239: | ||
|True/False (Bool) | |True/False (Bool) | ||
|Allows or disallows friendly fire between players. | |Allows or disallows friendly fire between players. | ||
*True - Players can deal damage to eachother. | *'''True''' - Players can deal damage to eachother. | ||
*False - Players don't deal damage to eachother. | *'''False''' - Players don't deal damage to eachother. | ||
|- | |- | ||
|selectedsubmarine | |selectedsubmarine | ||
Line 256: | Line 256: | ||
|Yes/No/Maybe (String) | |Yes/No/Maybe (String) | ||
|Sets the chance of traitors appearing in a round. | |Sets the chance of traitors appearing in a round. | ||
*Yes - Traitors definitely appear in a round. | *'''Yes''' - Traitors definitely appear in a round. | ||
*No - Traitors do not appear in a round. | *'''No''' - Traitors do not appear in a round. | ||
*Maybe - Traitors have a 50/50 chance of appearing a round. | *'''Maybe''' - Traitors have a 50/50 chance of appearing a round. | ||
|- | |- | ||
|traitorsminplayercount | |traitorsminplayercount |
Revision as of 23:12, 4 January 2020
serversettings.xml is a file that stores all the settings for the Barotrauma dedicated and client-hosted server.
It is located in the Barotrauma root directory (same place as the Barotrauma.exe).
Default
Default settings for new game installs.
<?xml version="1.0" encoding="utf-8"?> <serversettings tickrate="20" randomizeseed="True" userespawnshuttle="True" respawninterval="300" maxtransporttime="180" minrespawnratio="0.2" autorestartinterval="60" startwhenclientsready="False" startwhenclientsreadyratio="0.8" allowspectating="True" endroundatlevelend="True" saveserverlogs="True" allowragdollbutton="True" allowfiletransfers="True" voicechatenabled="True" playstyle="Serious" allowvotekick="True" allowendvoting="True" allowrespawn="True" botcount="0" maxbotcount="16" botspawnmode="Normal" allowdisguises="True" allowrewiring="True" allowfriendlyfire="True" selectedsubmarine="" selectedshuttle="" traitorsenabled="No" traitorsminplayercount="1" traitorsminstartdelay="90" traitorsmaxstartdelay="180" traitorsminrestartdelay="30" traitorsmaxrestartdelay="90" subselectionmode="Manual" modeselectionmode="Manual" endvoterequiredratio="0.6" kickvoterequiredratio="0.6" killdisconnectedtime="30" kickafktime="120" karmaenabled="False" karmapreset="default" gamemodeidentifier="sandbox" missiontype="All" autobantime="3600" maxautobantime="86400" name="Server" public="false" port="27015" queryport="27016" maxplayers="10" enableupnp="false" autorestart="false" LevelDifficulty="20" AllowedRandomMissionTypes="Salvage,Monster,Cargo,Combat" AllowedClientNameChars="32-33,38-46,48-57,65-90,91-91,93-93,95-122,192-255,384-591,1024-1279,19968-40959,13312-19903,131072-15043983,15043985-173791,173824-178207,178208-183983,63744-64255,194560-195103" ServerMessage="" />
Configuration Fields
Config Field | Default Value | Allowed Values | Description |
---|---|---|---|
tickrate | 20 | 0< (Int) | Sets the server's tickrate. |
randomizeseed | True | True/False (Bool) | Sets if the server should generate a new seed each round.
|
userespawnshuttle | True | True/False (Bool) | Allows or disallows the use of a respawn shuttle for respawning.
Only works if respawning is allowed.
|
respawninterval | 300 | 0< (Int) | Sets time inbetween each respawn wave, in seconds. |
maxtransporttime | 180 | 0< (Int) | Sets maximum time the respawn shuttle has to dock to the submarine, in seconds.
If time runs out before the shuttle docks it will automatically return to the first outpost. |
minrespawnratio | 0.2 | 0.0-1.0 (Float) | Sets minimum percentage of dead players required for the respawn timer to start. |
autorestartinterval | 60 | 0< (Float) | Sets time for automatic starting of a round, in seconds.
Only works if "autorestart" is set to True. |
startwhenclientsready | False | True/False (Bool) | Allows or disallows the server to automatically start a round if enough players are ready.
|
startwhenclientsreadyratio | 0.8 | 0.0-1.0 (Float) | Sets minimum ratio of players required to be ready for a round to be automatically started.
Only works if "startwhenclientsready" is set to True. |
allowspectating | True | True/False (Bool) | Allows or disallows players from spectating.
|
endroundatlevelend | True | True/False (Bool) | Sets if the round should be ended once the submarine reaches the end of the level. (Doesn't dock)
|
saveserverlogs | True | True/False (Bool) | Sets if server logs should be saved once the server is turned off.
|
allowragdollbutton | True | True/False (Bool) | Allows or disallows the use of the ragdoll button. (Exact key is dependant on keybind configuration)
|
allowfiletransfers | True | True/False (Bool) | Allows or disallows file transfers for server files to clients.
Note: currently only .sub files can be transfered, if a client is missing a content package they won't be able to connect at all.
|
voicechatenabled | True | True/False (Bool) | Allows or disallows the use of voicechat.
|
playstyle | Serious | Serious/Casual/Roleplay/Rampage/SomethingDifferent (String) | Sets server playstyle displayed in the server browser and lobby.
|
allowvotekick | True | True/False (Bool) | Allows or disallows players from voting to kick other players.
|
allowendvoting | True | True/False (Bool) | Allows or disallows players from voting to end the round.
|
allowrespawn | True | True/False (Bool) | Allows or disallows respawning.
|
botcount | 0 | 0-maxbotcount (Int) | Sets number of bots that should be spawned in a round. |
maxbotcount | 16 | 0-16 (Int) | Sets maximum allowed bots in a round. |
botspawnmode | Normal | Normal/Fill (String) | Sets how bots should be spawned.
|
allowdisguises | True | True/False (Bool) | Allows or disallows players to disguise themselves.
|
allowrewiring | True | True/False (Bool) | Allows or disallows players from rewiring anything.
|
allowfriendlyfire | True | True/False (Bool) | Allows or disallows friendly fire between players.
|
selectedsubmarine | N/A (Alphabetically picks first submarine) | String | Sets submarine that will be used in a round. |
selectedshuttle | N/A (Alphabetically picks first shuttle) | String | Sets respawn shuttle that will be used in a round. |
traitorsenabled | No | Yes/No/Maybe (String) | Sets the chance of traitors appearing in a round.
|
traitorsminplayercount | 1 | 0< (Int) | Sets minimum number of players required for a traitor to be picked. |
traitorsminstartdelay | 90 | 0< (Float) | Sets minimum amount of time that must pass before a traitor is selected, in seconds. |
traitorsmaxstartdelay | 180 | 0< (Float) | Sets maximum amount of time that must pass before a traitor is selected, in seconds. |
traitorsminrestartdelay | 30 | 0< (Float) | Sets minimum amount of time that must pass before another traitor is selected, in seconds. |
traitorsmaxrestartdelay | 90 | 0< (Float) | Sets maximum amount of time that must pass before another traitor is selected, in seconds. |
subselectionmode | Manual | Manual/Random/Vote (String) | Sets how the next submarine should be picked.
|
modeselectionmode | Manual | Manual/Random/Vote (String) | Sets how a gamemode should be chosen.
|
endvoterequiredratio | 0.6 | 0.0-1.0 (Float) | Sets amount of endround votes required to end the round.
Only works if "allowendvoting" is set to True. |
kickvoterequiredratio | 0.6 | 0.0-1.0 (Float) | Sets amount of votekick votes required to kick a player.
Only works if "allowvotekick" is set to True. |
killdisconnectedtime | 30 | 0< (Float) | Sets amount of time a player must be disconnected from their body for the character to be killed. |
kickafktime | 120 | 0< (Float) | Sets amount of time a player must be AFK to be auto-kicked. |
karmaenabled | False | True/False (Bool) | Enables or disables the Karma system. |
karmapreset | default | default/strict/custom (String) | Sets the karma rules preset that should be used.
Only works if "karmaenabled" is set to True. |
gamemodeidentifier | sandbox | Sandbox/Mission/Campaign (String) | Sets gamemode |
missiontype | All | Salvage/Monster/Cargo/Combat/All (String) | Sets mission types that the server should run, if multiple are selected the server randomly chooses one. All includes all. |
autobantime | 3600 | 0< (Float) | Sets ban length for players who are votekicked, in seconds. |
maxautobantime | 86400 | 0< (Float) | Sets maximum autoban length that can be set in the lobby host UI. |
name | Server | String | Sets server name. |
public | false | True/False (Bool) | Sets if the server should be shown in the server browser.
Note: Even if the server isn't public any player can still connect to it unless it has a whitelist or password. |
port | 27015 | Valid port (Int) | Sets server's port for player connections.
Port must be port-forwarded for the server to be connectable and visible in the server browser. |
queryport | 27016 | Valid port (Int) | Sets server's port for querying with steam for connections.
Port must be port-forwarded for the server to be connectable and visible in the server browser. |
maxplayers | 10 | 1-16 (Int) | Sets max players. |
enableupnp | false | True/False (Bool) | Sets if the server should attempt to use UPnP to allow players to connect (instead of port-forwarding).
Note: Not all routers support UPnP This is also unnecessary if hosting from a client (not dedicated server), as client-hosting uses Steam P2P for connections. |
autorestart | false | True/False (Bool) | Allows or disallows the server from autostarting rounds in the lobby.
Uses time set in autorestartinterval. |
LevelDifficulty | 20 | 0-100 (Int) | Sets level difficulty. |
AllowedRandomMissionTypes | Salvage,Monster,Cargo,Combat,All | Deprecated, missiontype is able to randomize now. | N/A |
AllowedClientNameChars | 32-33,38-46,48-57,65-90,91-91,93-93,95-122,192-255,384-591,1024-1279,19968-40959,13312-19903, 131072-15043983,15043985-173791,173824-178207,178208-183983,63744-64255,194560-195103 |
UTF-16 character code ranges (Int) | Sets characters that are allowed in player's names. |
ServerMessage | String | Sets the text displayed in the server's info box. | |
Password | By default doesn't appear in the config file. | String | Sets password required to enter the server. |