Console Commands: Difference between revisions
Jade Harley (talk | contribs) mNo edit summary |
mNo edit summary |
||
(11 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Version|0.18.12.0|Messed up while figuring out cheat commands. Will need to fix.}} | {{Version|0.18.12.0|Messed up while figuring out cheat commands. Will need to fix.|nosearch=y}} | ||
{{See_also|Permissions}} | {{See_also|Permissions}} | ||
''This page is about the debugging tool; for the in-game installation, see "[[Terminal]]"'' | ''This page is about the debugging tool; for the in-game installation, see "[[Terminal]]"'' | ||
Line 17: | Line 17: | ||
#* This is only required for cheat commands, marked with a green checkmark in the table below. | #* This is only required for cheat commands, marked with a green checkmark in the table below. | ||
# '''Press {{key|TAB}} to autofill and cycle through identifiers''' | # '''Press {{key|TAB}} to autofill and cycle through identifiers''' | ||
#*For a list of Item Identifiers, see [[Item IDs]]. | |||
Examples: | Examples: | ||
Line 38: | Line 38: | ||
! style="width:25%" class=unsortable | Notes | ! style="width:25%" class=unsortable | Notes | ||
|- {{Command|copyitemnames|source = Client}} | |- {{Command|copyitemnames|source = Client}} | ||
|- {{Command|autohull|| | |- {{Command|autohull||Generates Hulls in the Submarine Editor.}} | ||
|- {{Command|startlidgrenclient [ip address]||Argument 1 is required.}} | |- {{Command|startlidgrenclient [ip address]||Argument 1 is required.}} | ||
|- {{Command|startsteamp2pclient}} | |- {{Command|startsteamp2pclient}} | ||
Line 50: | Line 50: | ||
|- {{Command|editevents/eventeditor|Switch to the Event Editor to edit scripted events.}} | |- {{Command|editevents/eventeditor|Switch to the Event Editor to edit scripted events.}} | ||
|- {{Command|editcharacters/charactereditor|Switch to the Character Editor to edit/create the ragdolls and animations of characters.|Switching between the character editor and the game view may cause odd behaviour or bugs.}} | |- {{Command|editcharacters/charactereditor|Switch to the Character Editor to edit/create the ragdolls and animations of characters.|Switching between the character editor and the game view may cause odd behaviour or bugs.}} | ||
|- {{Command|quickstart [sub name] [difficulty] [level gen parameters identifier]|Can only be executed from the main menu. | |- {{Command|quickstart [sub name] [difficulty] [level gen parameters identifier]|Starts a singleplayer sandbox|Can only be executed from the main menu.<br>Argument 1 is required.}} | ||
|- {{Command|steamnetdebug|Toggles Steamworks networking debug logging.}} | |- {{Command|steamnetdebug|Toggles Steamworks networking debug logging.}} | ||
|- {{Command|readycheck|Commence a ready check in multiplayer.}} | |- {{Command|readycheck|Commence a ready check in multiplayer.}} | ||
Line 79: | Line 79: | ||
|- {{Command|money [amount] [character name]|Gives the specified amount of money to the crew when a campaign is active.|Can only be executed in Campaign mode.|Argument 1 is required and accepts negative values.|cheat = yes}} | |- {{Command|money [amount] [character name]|Gives the specified amount of money to the crew when a campaign is active.|Can only be executed in Campaign mode.|Argument 1 is required and accepts negative values.|cheat = yes}} | ||
|- {{Command|showmoney|Shows the amount of money in everyones wallet.|cheat = yes}} | |- {{Command|showmoney|Shows the amount of money in everyones wallet.|cheat = yes}} | ||
|- {{Command|setskill [all/ | |- {{Command|setskill [all/identifier] [max/level] [character name]|Set your skill level.|Arguments 1 and 2 are required.|cheat = yes}} | ||
|- {{Command|givetalent [talent name/id] [character name]|give the talent to the specified character. If the character argument is omitted, the talent is given to the controlled character.|Argument 1 is required.|cheat = yes}} | |- {{Command|givetalent [talent name/id] [character name]|give the talent to the specified character. If the character argument is omitted, the talent is given to the controlled character.|Argument 1 is required.|cheat = yes}} | ||
|- {{Command|unlocktalents [all/job name] [character]|give the specified character all the talents of the specified class|Argument 1 is required.|cheat = yes}} | |- {{Command|unlocktalents [all/job name] [character]|give the specified character all the talents of the specified class|Argument 1 is required.|cheat = yes}} | ||
Line 102: | Line 102: | ||
|- {{Command|messagebox/guimessagebox [header] [msg] [default/ingame]|Creates a message box.}} | |- {{Command|messagebox/guimessagebox [header] [msg] [default/ingame]|Creates a message box.}} | ||
|- {{Command|debugdraw [true/false]|Toggle the debug drawing mode on/off (client-only).|cheat = yes}} | |- {{Command|debugdraw [true/false]|Toggle the debug drawing mode on/off (client-only).|cheat = yes}} | ||
|- {{Command|debugwiring [true/false]|Toggle the wiring debug mode on/off (client-only).|cheat = yes}} | |||
|- {{Command|debugdrawlocalization [true/false]|Toggle the localization debug drawing mode on/off (client-only). Colors all text that hasn't been fetched from a localization file magenta, making it easier to spot hard-coded or missing texts.}} | |||
|- {{Command|debugdrawlos [true/false]|Toggle the los debug drawing mode on/off (client-only).|cheat = yes}} | |||
|- {{Command|togglevoicechatfilters [true/false]|Toggle the radio/muffle filters in the voice chat (client-only).}} | |- {{Command|togglevoicechatfilters [true/false]|Toggle the radio/muffle filters in the voice chat (client-only).}} | ||
|- {{Command|fpscounter|Toggle the FPS counter.}} | |- {{Command|fpscounter|Toggle the FPS counter.}} | ||
Line 115: | Line 118: | ||
|- {{Command|toggleaitargets|Toggle the visibility of AI targets (= targets that enemies can detect and attack/escape from) (client-only).|cheat = yes}} | |- {{Command|toggleaitargets|Toggle the visibility of AI targets (= targets that enemies can detect and attack/escape from) (client-only).|cheat = yes}} | ||
|- {{Command|debugai|Toggle the ai debug mode on/off (works properly only in single player).|cheat = yes}} | |- {{Command|debugai|Toggle the ai debug mode on/off (works properly only in single player).|cheat = yes}} | ||
|- {{Command|devmode|Toggle the dev mode on/off (client-only).|cheat = yes}} | |||
|- {{Command|showmonsters|Permanently unlocks all the monsters in the character editor. Use "hidemonsters" to undo.|cheat = yes}} | |||
|- {{Command|hidemonsters|Permanently hides in the character editor all the monsters that haven't been encountered in the game. Use "showmonsters" to undo.|cheat = yes}} | |||
|- {{Command|water/editwater|Toggle water editing. Allows adding water into rooms by holding the left mouse button and removing it by holding the right mouse button.|cheat = yes}} | |- {{Command|water/editwater|Toggle water editing. Allows adding water into rooms by holding the left mouse button and removing it by holding the right mouse button.|cheat = yes}} | ||
|- {{Command|fire/editfire|Allows putting up fires by left clicking.|cheat = yes}} | |- {{Command|fire/editfire|Allows putting up fires by left clicking.|cheat = yes}} | ||
Line 126: | Line 132: | ||
|- {{Command|setentityproperties [property] [value]|Sets the value of some property on all selected items/structures in the sub editor.|Arguments 1 and 2 are required.}} | |- {{Command|setentityproperties [property] [value]|Sets the value of some property on all selected items/structures in the sub editor.|Arguments 1 and 2 are required.}} | ||
|- {{Command|checkmissingloca}} | |- {{Command|checkmissingloca}} | ||
|- {{Command|checkduplicateloca}} | |||
|- {{Command|comparelocafiles [file 1] [file 2]}} | |- {{Command|comparelocafiles [file 1] [file 2]}} | ||
|- {{Command|eventstats [0-7] [true/false]||Argument 2 determines if the entire log will be displayed instead of a summary.}} | |- {{Command|eventstats [0-7] [true/false]||Argument 2 determines if the entire log will be displayed instead of a summary.}} | ||
|- {{Command|setfreecamspeed [speed]|Set the camera movement speed when not controlling a character. Defaults to 1.|Argument 1 is required.}} | |- {{Command|setfreecamspeed [speed]|Set the camera movement speed when not controlling a character. Defaults to 1.|Argument 1 is required.}} | ||
|- {{Command|converttowreck||Replaces items and walls with wrecked variants.<br>Can only be executed from the Submarine Editor.}} | |||
|- {{Command|dumptexts [destination path]|Extracts all the texts from the given text xml and writes them into a file (using the same filename, but with the .txt extension). If the filepath is omitted, the EnglishVanilla.xml file is used.}} | |- {{Command|dumptexts [destination path]|Extracts all the texts from the given text xml and writes them into a file (using the same filename, but with the .txt extension). If the filepath is omitted, the EnglishVanilla.xml file is used.}} | ||
|- {{Command|loadtexts [source path] [destination path]|Loads all lines of text from a given .txt file and inserts them sequientially into the elements of an xml file. If the file paths are omitted, EnglishVanilla.txt and EnglishVanilla.xml are used.}} | |- {{Command|loadtexts [source path] [destination path]|Loads all lines of text from a given .txt file and inserts them sequientially into the elements of an xml file. If the file paths are omitted, EnglishVanilla.txt and EnglishVanilla.xml are used.}} | ||
Line 214: | Line 222: | ||
|- {{Command|locky|Lock vertical movement of the main submarine.}} | |- {{Command|locky|Lock vertical movement of the main submarine.}} | ||
|- {{Command|triggerevent [event id]|Created a new event.|Argument 1 is required.|cheat = yes}} | |- {{Command|triggerevent [event id]|Created a new event.|Argument 1 is required.|cheat = yes}} | ||
|- {{Command|unlockmission [identifier/tag]|Unlocks a mission in a random adjacent level.|Argument 1 is required.<br>Can only be executed in Campaign mode.|cheat = yes}} | |||
|- {{Command|setcampaignmetadata [identifier] [value]|Sets the specified campaign metadata value.|Arguments 1 and 2 are required.<br>Can only be executed in Campaign mode.|cheat = yes}} | |||
|- {{Command|showreputation|List the current reputation values.|Can only be executed in Campaign mode.}} | |||
|- {{Command|setlocationreputation [value]|Set the reputation in the current location to the specified value.|Argument 1 is required.<br>Can only be executed in Campaign mode.|cheat = yes}} | |- {{Command|setlocationreputation [value]|Set the reputation in the current location to the specified value.|Argument 1 is required.<br>Can only be executed in Campaign mode.|cheat = yes}} | ||
|- {{Command|setreputation [faction] [value]|Set the reputation of a | |- {{Command|setreputation [faction] [value]|Set the reputation of a location to the specified value.|Arguments 1 and 2 are required.<br>Can only be executed in Campaign mode.|cheat = yes}} | ||
|- {{Command|fixitems|Repairs all items and restores them to full condition.|cheat = yes}} | |- {{Command|fixitems|Repairs all items and restores them to full condition.|cheat = yes}} | ||
|- {{Command|fixhulls/fixwalls|Fixes all walls.|cheat = yes}} | |- {{Command|fixhulls/fixwalls|Fixes all walls.|cheat = yes}} | ||
Line 229: | Line 240: | ||
|- {{Command|autoitemplacerdebug/outfitdebug|Toggle automatic item placer debug info on/off. The automatically placed items are listed in the debug console at the start of a round.}} | |- {{Command|autoitemplacerdebug/outfitdebug|Toggle automatic item placer debug info on/off. The automatically placed items are listed in the debug console at the start of a round.}} | ||
|- {{Command|listtasks|Lists all asynchronous tasks currently in the task pool.}} | |- {{Command|listtasks|Lists all asynchronous tasks currently in the task pool.}} | ||
|- {{Command|listcoroutines|Lists all coroutines currently running.}} | |||
|- {{Command|calculatehashes [content package]|Show the MD5 hashes of the files in the selected content package. If the name parameter is omitted, the first content package is selected.}} | |- {{Command|calculatehashes [content package]|Show the MD5 hashes of the files in the selected content package. If the name parameter is omitted, the first content package is selected.}} | ||
|- {{Command|simulatedlatency [min latency] [random latency]|applies a simulated latency to network messages. Useful for simulating real network conditions when testing the multiplayer locally.|Arguments 1 and 2 are required.<br>Can only be executed in Multiplayer.}} | |- {{Command|simulatedlatency [min latency] [random latency]|applies a simulated latency to network messages. Useful for simulating real network conditions when testing the multiplayer locally.|Arguments 1 and 2 are required.<br>Can only be executed in Multiplayer.}} | ||
Line 237: | Line 249: | ||
== Debug Version Commands == | == Debug Version Commands == | ||
The debug version of ''Barotrauma'' can only be accessed by downloading and compiling the game's [https://github.com/Regalis11/Barotrauma source code], then navigating to one of the "Debug[Windows/Mac/Linux]" folders and launching the ''Barotrauma'' game executable. | |||
{| class="sortable" style="width:100%" | {| class="sortable" style="width:100%" | ||
! style="width:1%" | <span class="explain" title="Requires cheats to be enabled">Cheat</span> | ! style="width:1%" | <span class="explain" title="Requires cheats to be enabled">Cheat</span> | ||
Line 245: | Line 258: | ||
|- {{Command|showballastflorasprite}} | |- {{Command|showballastflorasprite}} | ||
|- {{Command|simulatedlongloadingtime [min time]|forces loading a round to take at least the specified amount of seconds.|Argument 1 is required.<br>Can only be executed in Multiplayer.}} | |- {{Command|simulatedlongloadingtime [min time]|forces loading a round to take at least the specified amount of seconds.|Argument 1 is required.<br>Can only be executed in Multiplayer.}} | ||
|- {{Command|resetcharacternetstate [character name]|A debug-only command that resets a character's network state, intended for diagnosing character syncing issues.}} | |||
|- {{Command|storeinfo}} | |- {{Command|storeinfo}} | ||
|- {{Command|setplanthealth [health]|Sets the health of the selected plant in sub editor.}} | |- {{Command|setplanthealth [health]|Sets the health of the selected plant in sub editor.}} | ||
Line 250: | Line 264: | ||
|- {{Command|spamchatmessages [msg count] [msg length]}} | |- {{Command|spamchatmessages [msg count] [msg length]}} | ||
|- {{Command|getprefabinfo [prefab id]|Argument 1 is required.}} | |- {{Command|getprefabinfo [prefab id]|Argument 1 is required.}} | ||
|- {{Command|copycharacterinfotoclipboard}} | |||
|- {{Command|spawnallitems}} | |||
|- {{Command|camerasettings [default zoom] [zoom smoothness] [move smoothness] [min zoom] [max zoom]|debug command for testing camera settings. The values default to 1.1, 8.0, 8.0, 0.1 and 2.0.}} | |- {{Command|camerasettings [default zoom] [zoom smoothness] [move smoothness] [min zoom] [max zoom]|debug command for testing camera settings. The values default to 1.1, 8.0, 8.0, 0.1 and 2.0.}} | ||
|- {{Command|waterparams [distortion scale X] [distortion scale Y] [distortion strength X] [distortion strength Y] [blur]|default 0.5 0.5 0.5 0.5 1}} | |- {{Command|waterparams [distortion scale X] [distortion scale Y] [distortion strength X] [distortion strength Y] [blur]|default 0.5 0.5 0.5 0.5 1}} | ||
Line 265: | Line 281: | ||
|- {{Command|getproperties|Goes through the MapEntity prefabs and checks their serializable properties for localization issues.}} | |- {{Command|getproperties|Goes through the MapEntity prefabs and checks their serializable properties for localization issues.}} | ||
|- {{Command|setcurrentlocationtype [type]|Change the type of the current location.|Can only be executed in Campaign mode.<br>Argument 1 is required.}} | |- {{Command|setcurrentlocationtype [type]|Change the type of the current location.|Can only be executed in Campaign mode.<br>Argument 1 is required.}} | ||
|- {{Command|forcelocationtypechange [locationname] [locationtype]}} | |||
|- {{Command|printsendertransfers}} | |- {{Command|printsendertransfers}} | ||
|- {{Command|eventdata [latest/event id]||Argument 1 is required.}} | |- {{Command|eventdata [latest/event id]||Argument 1 is required.}} | ||
Line 283: | Line 300: | ||
=Media= | =Media= | ||
[[File:Console.png|left|frame|The console showing ping info on startup]] | [[File:Console.png|left|frame|The console showing ping info on startup]] | ||
{{Guides nav}} |
Latest revision as of 14:28, 28 April 2024
Data is potentially outdated | |
Last updated for version 0.18.12.0 The current game version is 1.4.6.0 Notes: Messed up while figuring out cheat commands. Will need to fix. |
- See also: Permissions
This page is about the debugging tool; for the in-game installation, see "Terminal"
The console is a debugging tool that can be used to view errors and change certain settings and content while the game is opened.
Its main function is debugging, but it can also be used to spawn items and creatures, modify their attributes and afflictions, or use moderation commands.
In multiplayer, players that have the "ConsoleCommands" permission can use certain specific commands under the "Permitted console commands" part of the permissions menu. Players can input commands in a text input field at the bottom of the console window.
The source code related to console commands is available at Github. [1] [2] [3]
Usage
- Press to toggle the console (for Mac, press and).
- Enter
enablecheats
to enable cheats and disable achievements for the game session- This is only required for cheat commands, marked with a green checkmark in the table below.
- Press to autofill and cycle through identifiers
- For a list of Item Identifiers, see Item IDs.
Examples:
spawnitem weld
setskill mech
In-game help with commands can be accessed with the help
command. Enter help
before a command for help with a specific command (i.e. help spawnitem
), or by itself for a list of all commands.
Commands
Arguments are typed without brackets, and with quotation marks around multi-word inputs.
Examples: handcuffs
and "handheld sonar"
Debug Version Commands
The debug version of Barotrauma can only be accessed by downloading and compiling the game's source code, then navigating to one of the "Debug[Windows/Mac/Linux]" folders and launching the Barotrauma game executable.
Permissions
Permissions are sets of rights to administrate a server. They are used to create ranks or can be attributed individually.
Permission | Description |
---|---|
ManageRound | Allows players to start and end rounds. |
Kick | Allows players to kick other players. |
Ban | Allows players to ban other players. |
Unban | Allows players to unban other players. |
SelectSub | Allows players to select the sub when the selection mode is on "Manual". |
SelectMode | Allows players to select the gamemode. |
ManageCampaign | Same as giving ManageMoney, SellInventoryItems, SellSubItems, ManageMap, and ManageHires permissions. |
ConsoleCommands | Allows players to use Console Commands. Permissions for individual console commands are also required. |
ServerLog | Allows players to read the server logs. |
ManageSettings | Allows players to change the server's settings. |
ManagePermissions | Allows players to change the permissions of other clients. Plays can only grant permissions that they already have. |
KarmaImmunity | Immunizes players against the effects of Karma. |
ManageMoney | Allows players to take money from the bank without needing a vote, set salaries, and take money from other player's wallets. |
SellInventoryItems | Allows players to sell items to shops from their inventories. |
SellSubItems | Allows players to sell items to shops directly from the submarine. |
ManageMap | Allows players to select missions and destinations on the campaign map. |
ManageHires | Allows players to hire and fire NPC crewmates. |
ManageBotTalents | Allows players to select talents for NPC crewmates. |
All | Grants players all permissions. |
References
- ↑ https://github.com/Regalis11/Barotrauma/blob/master/Barotrauma/BarotraumaClient/ClientSource/DebugConsole.cs
- ↑ https://github.com/Regalis11/Barotrauma/blob/master/Barotrauma/BarotraumaServer/ServerSource/DebugConsole.cs
- ↑ https://github.com/Regalis11/Barotrauma/blob/master/Barotrauma/BarotraumaShared/SharedSource/DebugConsole.cs
Media
Guides | |||||
---|---|---|---|---|---|
Gameplay | |||||
Hosting | |||||
In-Game | Dedicated Servers | ||||
Tools & Modding | |||||
Editors | XML | Other | |||
XML and how Barotrauma uses it |