From 1548f8d0fd6b0f6bf6a3041b7f487c200c374562 Mon Sep 17 00:00:00 2001 From: Flareguy Date: Wed, 22 Jul 2026 16:30:14 -0500 Subject: [PATCH 1/5] documents a bunch of commands --- src/SUMMARY.md | 4 +++ src/development/commands.md | 65 +++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 src/development/commands.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 58ea9e2..7e223d8 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -11,6 +11,10 @@ - [Conventions](coding/code-conventions.md) - [Masquerade Implementation](coding/masquerade-implementation.md) +## Development +--- +- [Console Commands](development/commands.md) + # Guidelines --- - [Mapping](guidelines/mapping.md) diff --git a/src/development/commands.md b/src/development/commands.md new file mode 100644 index 0000000..fdddf1b --- /dev/null +++ b/src/development/commands.md @@ -0,0 +1,65 @@ +# Console Commands +```admonish warning "Here Lies Unfinished Documentation" +For a few things here, it's much easier to use the admin right click menu options. Additionally, this list does not include cvars, many of which are important to testing. +Hopefully, in the future, both of these things will be documented seperately, and a quickstart guide can be made. +``` +This is a non-comprehensive list of console commands useful for development / usage on live servers. + + +## General Use + +``restartroundnow``: Restarts the round immediately. +``golobby``: Restarts the round and enables the lobby, if it was disabled. +``toast``: Forces the map to toast instead of devmap and immediately restarts the round. +``lobby:toggleclosed``: Toggles whether the lobby is currently open or closed. +``electrocute [entity ID] [seconds] [damage]``: Electrocutes the given entity. +``faxui``: Opens the admin fax UI, allowing faxes to be sent to any fax machine. + +## Feature Testing +``showatmos``: Toggles the atmos debug overlay, showing most atmos-related values wherever the mouse is. +``pauseatmos [grid ID]``: Pauses atmos for the given grid. +``substepatmos``: Steps atmos one tick forward per usage of the command. Implicitly pauses atmos. +``showradiation`` Displays radiation rays coming from rad sources & the blocking power of all radiation blocking objects. +``showfluids``: Toggles the puddle debug overlay, showing the location of all puddles, along with how many units of reagent are in a given puddle. +``explosion [total intensity] [intensity slope] [max intensity] [x] [y] [map ID] [explosion type]``: Spawns an explosion. Only the total intensity is required for this command to work. If no coordinates are set, the player's current position will be used. +``explosionui``: Opens a UI that allows for the input explosion values. Also has a nifty preview option. +``showmeleespread``: Toggles showing the current melee weapon's range and arc. +``showgunspread``: Toggles showing the current ranged weapon's default spread. Currently does not account for ammo-specific spread modifiers, like buckshot. +``showhtn``: Toggles showing an overlay that displays the current HTN status of NPCs. +``showaudio``: Toggles showing an overlay that displays all audio sources (and related info) on the screen. +``showambient``: Toggles showing an overlay that displays all ambient sound sources on the screen. +``showaccessreaders``: Toggles showing an overlay that displays all access reader sources on the screen. +``dumpreagentguidetext [reagent]`` Dumps the guidebook text for a given reagent to console. + +## Game Manipulation +Most of these are useful in live servers, too! + +``addgamerule [game rule]``: Triggers the specified game rule (usually station events or variation passes). +``endgamerule [ID of gamerule]``: Ends the specified gamerule. +``cleargamerules``: Clears all active gamerules. +``mq:force [masquerade name]``: Forces the specified masquerade to be selected next round. +``mq:unforce:`` Unsets the forced masquerade, if there is one. +``cinematic:playAll [cinematic type]``: Plays a cinematic for all players. +``rerollhostname``: Rerolls the server's roleplay level. + +## Information +``admins:active`` Returns a list of all active admins. +``admins:all`` Returns a list of ALL admins, included de-adminned ones. +``listgamerules``: Lists all previously added game rules. +``esvote:ls``: Lists all current active stagehand votes. +``esvote:options [id]`` Lists all options for the specified vote. +``esvote:tally [id]`` Returns the current vote tally for all options on the specified vote. +``showvalues [category]``: Shows the values for every item of the given category in the game in a list UI. You may have to increase the size of the UI opened to see all listed values. Valid categories are ``melee``, ``itemsize``, and ``drawrate``. + +## Mapping +``mapping [map ID]``: Creates a new map with the specified map ID. Must be a unique ID. +``savemap [map ID]``: Saves the specified map. By default, saved maps can be found in ``bin/Content.Server/data``. +``savegrid [grid ID]``: Saves the specified grid. You need to use this for shuttles and other extraneous things, usually. By default, saved maps can be found in ``bin/Content.Server/data``. +``lsgrid``: Lists all current grid and map IDs. +``fixgridatmos [grid ID]`` Makes every tile on the grid have a roundstart gas mix. When updating maps, sure to run this after adding new rooms or changing map geometry. +``colornetwork [entity ID] Pipe [color]``: Colors all pipes in the network of the specified pipe to the specified color. All default pipe colors can be found in ``Resources/Prototypes/Entities/Objects/Tools/spray_painter.yml``, but blue ``#0055CC`` for distro and crimson ``#990000`` for waste are probably the ones you are going to want to use most. +``toggledecals``: Toggles decal visibility. + +## Randomness Simulation +``cast:generateNames [count]``: Generates random names. +``mq:sim [masquerade name] [playercount] [iterations]``: Simulates the secret identity composition of a masquerade for the given number of players and iterations. From 9032cd4b9bde02f0593a5f06a16cbd56d42e9bc9 Mon Sep 17 00:00:00 2001 From: Flareguy Date: Wed, 22 Jul 2026 16:33:48 -0500 Subject: [PATCH 2/5] i fuckt up --- src/development/commands.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/development/commands.md b/src/development/commands.md index fdddf1b..96996b4 100644 --- a/src/development/commands.md +++ b/src/development/commands.md @@ -9,57 +9,93 @@ This is a non-comprehensive list of console commands useful for development / us ## General Use ``restartroundnow``: Restarts the round immediately. + ``golobby``: Restarts the round and enables the lobby, if it was disabled. + ``toast``: Forces the map to toast instead of devmap and immediately restarts the round. + ``lobby:toggleclosed``: Toggles whether the lobby is currently open or closed. + ``electrocute [entity ID] [seconds] [damage]``: Electrocutes the given entity. + ``faxui``: Opens the admin fax UI, allowing faxes to be sent to any fax machine. ## Feature Testing ``showatmos``: Toggles the atmos debug overlay, showing most atmos-related values wherever the mouse is. + ``pauseatmos [grid ID]``: Pauses atmos for the given grid. + ``substepatmos``: Steps atmos one tick forward per usage of the command. Implicitly pauses atmos. + ``showradiation`` Displays radiation rays coming from rad sources & the blocking power of all radiation blocking objects. + ``showfluids``: Toggles the puddle debug overlay, showing the location of all puddles, along with how many units of reagent are in a given puddle. + ``explosion [total intensity] [intensity slope] [max intensity] [x] [y] [map ID] [explosion type]``: Spawns an explosion. Only the total intensity is required for this command to work. If no coordinates are set, the player's current position will be used. + ``explosionui``: Opens a UI that allows for the input explosion values. Also has a nifty preview option. + ``showmeleespread``: Toggles showing the current melee weapon's range and arc. + ``showgunspread``: Toggles showing the current ranged weapon's default spread. Currently does not account for ammo-specific spread modifiers, like buckshot. + ``showhtn``: Toggles showing an overlay that displays the current HTN status of NPCs. + ``showaudio``: Toggles showing an overlay that displays all audio sources (and related info) on the screen. + ``showambient``: Toggles showing an overlay that displays all ambient sound sources on the screen. + ``showaccessreaders``: Toggles showing an overlay that displays all access reader sources on the screen. + ``dumpreagentguidetext [reagent]`` Dumps the guidebook text for a given reagent to console. ## Game Manipulation Most of these are useful in live servers, too! ``addgamerule [game rule]``: Triggers the specified game rule (usually station events or variation passes). + ``endgamerule [ID of gamerule]``: Ends the specified gamerule. + ``cleargamerules``: Clears all active gamerules. + ``mq:force [masquerade name]``: Forces the specified masquerade to be selected next round. + ``mq:unforce:`` Unsets the forced masquerade, if there is one. + ``cinematic:playAll [cinematic type]``: Plays a cinematic for all players. + ``rerollhostname``: Rerolls the server's roleplay level. ## Information ``admins:active`` Returns a list of all active admins. + ``admins:all`` Returns a list of ALL admins, included de-adminned ones. + ``listgamerules``: Lists all previously added game rules. + ``esvote:ls``: Lists all current active stagehand votes. + ``esvote:options [id]`` Lists all options for the specified vote. + ``esvote:tally [id]`` Returns the current vote tally for all options on the specified vote. + ``showvalues [category]``: Shows the values for every item of the given category in the game in a list UI. You may have to increase the size of the UI opened to see all listed values. Valid categories are ``melee``, ``itemsize``, and ``drawrate``. ## Mapping ``mapping [map ID]``: Creates a new map with the specified map ID. Must be a unique ID. + ``savemap [map ID]``: Saves the specified map. By default, saved maps can be found in ``bin/Content.Server/data``. + ``savegrid [grid ID]``: Saves the specified grid. You need to use this for shuttles and other extraneous things, usually. By default, saved maps can be found in ``bin/Content.Server/data``. ``lsgrid``: Lists all current grid and map IDs. + ``fixgridatmos [grid ID]`` Makes every tile on the grid have a roundstart gas mix. When updating maps, sure to run this after adding new rooms or changing map geometry. + ``colornetwork [entity ID] Pipe [color]``: Colors all pipes in the network of the specified pipe to the specified color. All default pipe colors can be found in ``Resources/Prototypes/Entities/Objects/Tools/spray_painter.yml``, but blue ``#0055CC`` for distro and crimson ``#990000`` for waste are probably the ones you are going to want to use most. + ``toggledecals``: Toggles decal visibility. ## Randomness Simulation ``cast:generateNames [count]``: Generates random names. + ``mq:sim [masquerade name] [playercount] [iterations]``: Simulates the secret identity composition of a masquerade for the given number of players and iterations. From 7f4dd567d03ac48c55716fc868aed992d7c0a582 Mon Sep 17 00:00:00 2001 From: Flareguy Date: Wed, 22 Jul 2026 18:15:21 -0500 Subject: [PATCH 3/5] text colors for pipes --- src/development/commands.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/development/commands.md b/src/development/commands.md index 96996b4..f569d5b 100644 --- a/src/development/commands.md +++ b/src/development/commands.md @@ -91,7 +91,8 @@ Most of these are useful in live servers, too! ``fixgridatmos [grid ID]`` Makes every tile on the grid have a roundstart gas mix. When updating maps, sure to run this after adding new rooms or changing map geometry. -``colornetwork [entity ID] Pipe [color]``: Colors all pipes in the network of the specified pipe to the specified color. All default pipe colors can be found in ``Resources/Prototypes/Entities/Objects/Tools/spray_painter.yml``, but blue ``#0055CC`` for distro and crimson ``#990000`` for waste are probably the ones you are going to want to use most. +``colornetwork [entity ID] Pipe [color]``: Colors all pipes in the network of the specified pipe to the specified color. Any color is accepted, but the default pipe colors (i.e the ones in the spraypainter) are as follows: +red ``#FF1212``, yellow ``#B3A234``, brown ``#947507``, green ``#3AB334``, cyan ``#03fCD3``, blue ``#0055CC``, black ``#333333``, and crimson ``#990000``. ``toggledecals``: Toggles decal visibility. From 87943dde7c4b71233903794420e53a9f66a20087 Mon Sep 17 00:00:00 2001 From: Flareguy Date: Wed, 22 Jul 2026 18:17:12 -0500 Subject: [PATCH 4/5] lsgrid fix --- src/development/commands.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/development/commands.md b/src/development/commands.md index f569d5b..fa1fdd1 100644 --- a/src/development/commands.md +++ b/src/development/commands.md @@ -87,6 +87,7 @@ Most of these are useful in live servers, too! ``savemap [map ID]``: Saves the specified map. By default, saved maps can be found in ``bin/Content.Server/data``. ``savegrid [grid ID]``: Saves the specified grid. You need to use this for shuttles and other extraneous things, usually. By default, saved maps can be found in ``bin/Content.Server/data``. + ``lsgrid``: Lists all current grid and map IDs. ``fixgridatmos [grid ID]`` Makes every tile on the grid have a roundstart gas mix. When updating maps, sure to run this after adding new rooms or changing map geometry. From 28c2bb9c712da9c0e872ba1817cb54ed7e6f4449 Mon Sep 17 00:00:00 2001 From: mirrorcult <19853115+mirrorcult@users.noreply.github.com> Date: Thu, 23 Jul 2026 09:45:17 +0000 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: mirrorcult <19853115+mirrorcult@users.noreply.github.com> --- src/development/commands.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/development/commands.md b/src/development/commands.md index fa1fdd1..233c77e 100644 --- a/src/development/commands.md +++ b/src/development/commands.md @@ -18,8 +18,6 @@ This is a non-comprehensive list of console commands useful for development / us ``electrocute [entity ID] [seconds] [damage]``: Electrocutes the given entity. -``faxui``: Opens the admin fax UI, allowing faxes to be sent to any fax machine. - ## Feature Testing ``showatmos``: Toggles the atmos debug overlay, showing most atmos-related values wherever the mouse is. @@ -60,7 +58,7 @@ Most of these are useful in live servers, too! ``mq:force [masquerade name]``: Forces the specified masquerade to be selected next round. -``mq:unforce:`` Unsets the forced masquerade, if there is one. +``mq:unforce`` Unsets the forced masquerade, if there is one. ``cinematic:playAll [cinematic type]``: Plays a cinematic for all players.