Changes

copyedit a bit, reorganize intro sections
Line 3: Line 3:  
<div style="border: 1px solid red; background: #FCC; padding: 1em;">'''Warning: These commands are intended for testing and troubleshooting rather than general playing. Some have permanent side effects and may cause crashes or other problems.'''</div>
 
<div style="border: 1px solid red; background: #FCC; padding: 1em;">'''Warning: These commands are intended for testing and troubleshooting rather than general playing. Some have permanent side effects and may cause crashes or other problems.'''</div>
    +
Stardew Valley has hundreds of hidden debug commands which the developers use to test the game, documented on this page.
   −
== Introduction ==
+
==Entering debug commands==
Stardew Valley's developers added hundreds of hidden debug commands to test the game; this page documents them. To use them, SMAPI (and its bundled Console Commands mod) must be installed. Trying to use them through the chat box (unless the [https://www.nexusmods.com/stardewvalley/mods/2092 Chat Commands] mod is also installed) will either silently fail or just cause the game to respond with the message ''ConcernedApe: Nice try...''
+
===Individual commands===
== Entering debug commands ==
+
To enter debug commands, you must install SMAPI (and not delete its bundled Console Commands mod). You can also install the {{nexus mod|2092|Chat Commands}} mod to use debug commands through the in-game chat (trying without it will either silently fail, or show the response ''ConcernedApe: Nice try...'').
=== Individual commands ===
+
 
Once you have SMAPI and Console Commands installed, these commands can be typed directly into the SMAPI console window. All of them should be prefaced with <code>debug </code>&nbsp;such as in the example below:
+
Once that's done, you can type commands directly into the SMAPI console window (or chat if using Chat Commands). All of them should be prefaced with <code>debug </code> like this:
 
<pre>
 
<pre>
 
debug where Robin
 
debug where Robin
 
> Robin is at Farm, 21,4
 
> Robin is at Farm, 21,4
 
</pre>
 
</pre>
While the example above did return output from the game, many of these commands do not and instead will display the message ''Sent debug command to the game, but there was no output.''
+
 
=== Macros for multiple commands ===
+
The example above returned output, but many commands don't. If there's no output, SMAPI will say ''Sent debug command to the game, but there was no output''.
Multiple commands can be executed at once by saving them to a text file and then using the <tt>[[#runmacro|runmacro]]</tt> command.
+
 
# Start by creating a text file in the [[Modding:Player_Guide/Getting_Started#Find_your_game_folder|game directory]]. This file should be named with a <tt>.txt</tt> extension.
+
===Macros===
# Type commands in this file, one line at a time. Each command should start with a slash character (<tt>/</tt>) but should not include <code>debug </code>.
+
Multiple commands can be executed at once using the <tt>[[#runmacro|runmacro]]</tt> command:
# To run the macro, type <code>debug runmacro <filename></code> in the SMAPI console, replacing <tt><filename></tt> with the name of your command file without the <tt>.txt</tt> extension.
+
# Create a text file in the [[Modding:Player Guide/Getting Started#Find your game folder|game folder]] (with a <tt>.txt</tt> extension).
''Example:'' Assume that the following commands are saved in the file <code>quickstart.txt</code> in the game directory.
+
# Type commands in this file, one command per line. Each command should start with a slash character (<tt>/</tt>), but should not include <code>debug </code>.
 +
# To run the macro, type <code>debug runmacro &lt;filename&gt;</code> in the SMAPI console, replacing <tt>&lt;filename&gt;</tt> with the name of your command file without the <tt>.txt</tt> extension.
 +
 
 +
For example, let's say you have a <code>quickstart.txt</code> file with these commands:
 
<pre>
 
<pre>
 
/backpack 12
 
/backpack 12
Line 26: Line 30:  
/weapon 5
 
/weapon 5
 
</pre>
 
</pre>
Entering <code>debug runmacro quickstart</code> in the SMAPI console will then execute all the commands resulting in a backpack upgrade, money set to 10000g, farming skill set to level 1, and a [[Bone Sword]] added to the player's inventory. Note: <tt>Money</tt> is capitalized in this example because if it is all lowercase it triggers a [[Secrets#Chat|special chat response]] instead of executing the command.
  −
== Commands ==
     −
All known commands are listed below. Required parameters are listed in angle brackets and optional parameters are listed in square brackets. For example, the speed command is listed as <code>speed</code> {{t|I:value}} {{o|I:duration}} which means the command requires an integer value parameter and optionally has another integer duration parameter. Details such as default values should be listed in the description.
+
Entering <code>debug runmacro quickstart</code> in the SMAPI console will execute all the commands, resulting in a backpack upgrade, money set to 10000g, farming skill set to level 1, and a [[Bone Sword]] added to the player's inventory. (Note: <tt>Money</tt> is capitalized in this example because if it is all lowercase it triggers a [[Secrets#Chat|special chat response]] instead of executing the command.)
 +
 
 +
==Commands==
 +
All known commands are listed below. Required parameters are listed in angle brackets and optional parameters are listed in square brackets. For example, the speed command is listed as <code>speed</code> {{t|I:value}} {{o|I:duration}}, which means the command requires an integer value parameter and optionally has another integer duration parameter. Details such as default values should be listed in the description.
    
The commands themselves are case-insensitive, but parameters may still be case-sensitive. If the description mentions that a parameter uses a "fuzzy" match, that means that it can match on a case-insensitive partial name. For example, any of the following 3 commands will set the player's [[friendship]] with [[Abigail]] to 500 points (2 hearts):
 
The commands themselves are case-insensitive, but parameters may still be case-sensitive. If the description mentions that a parameter uses a "fuzzy" match, that means that it can match on a case-insensitive partial name. For example, any of the following 3 commands will set the player's [[friendship]] with [[Abigail]] to 500 points (2 hearts):
*<code>friend Abigail 500</code>
+
* <code>friend Abigail 500</code>
*<code>friend abi 500</code>
+
* <code>friend abi 500</code>
*<code>friend gail 500</code>
+
* <code>friend gail 500</code>
 +
 
 
Many of the commands which accept an NPC name can also accept <tt>farmer</tt> to reference the player instead.
 
Many of the commands which accept an NPC name can also accept <tt>farmer</tt> to reference the player instead.
   −
=== Items and Inventory ===
+
===Items and inventory===
==== General Item Searching and Spawning ====
+
====General item search and spawning====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 113: Line 121:  
|}
 
|}
   −
==== Backpack / Inventory ====
+
====Backpack and inventory====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 147: Line 157:  
|}
 
|}
   −
==== Clothing and Tailoring ====
+
====Clothing and tailoring====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 208: Line 220:  
|}
 
|}
   −
==== Tools and Weapons ====
+
====Tools and weapons====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 273: Line 287:  
|}
 
|}
   −
==== Wallet Items ====
+
====Wallet items====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 301: Line 317:  
|}
 
|}
   −
==== Miscellaneous Items ====
+
====Miscellaneous items====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 325: Line 343:  
|}
 
|}
   −
=== Player Information ===
+
===Player===
==== Appearance ====
+
====Appearance====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 362: Line 382:  
|}
 
|}
   −
==== Health, Stamina, Buffs, and Money ====
+
====Health, stamina, buffs, and money====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 415: Line 437:  
|}
 
|}
   −
==== Movement and Warping ====
+
====Movement and warping====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 464: Line 488:  
|}
 
|}
   −
==== Skills and Experience ====
+
====Skills and XP====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 503: Line 529:  
|}
 
|}
   −
==== Statistics and Achievements ====
+
====Statistics and achievements====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 571: Line 599:  
|}
 
|}
   −
=== Collections and Quests ===
+
===Collections and quests===
==== Cooking and Crafting ====
+
====Cooking and crafting====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 607: Line 637:  
|}
 
|}
   −
==== Fishing, Museum, and Secret Notes ====
+
====Fishing, museum, and secret notes====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 644: Line 676:  
|}
 
|}
   −
==== Mail ====
+
====Mail====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 684: Line 718:  
|}
 
|}
   −
==== Quests ====
+
====Quests====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 730: Line 766:  
|}
 
|}
   −
=== Characters / NPCs ===
+
===NPCs===
==== Children ====
+
====Children====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 754: Line 792:  
|}
 
|}
   −
==== NPC Spawning and Removal ====
+
====Spawning and removal====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 793: Line 833:  
|}
 
|}
   −
==== NPC Relationships (Friendship, Dating, Marriage) ====
+
====Relationships====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 847: Line 889:  
|}
 
|}
   −
==== NPC Dialogue ====
+
====Dialogue====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 886: Line 930:  
|}
 
|}
   −
==== NPC Movement and Warping ====
+
====Movement and warping====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 930: Line 976:  
|}
 
|}
   −
==== Farm Animals / Livestock ====
+
====Farm animals====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 981: Line 1,029:  
|}
 
|}
   −
==== Pets, Horses and Monsters ====
+
====Pets, horses, and monsters====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,028: Line 1,078:  
|}
 
|}
   −
=== Festivals and Events ===
+
===Festivals and events===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,087: Line 1,139:  
|}
 
|}
   −
=== Minigames and Cutscenes ===
+
===Minigames and cutscenes===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,132: Line 1,186:  
|}
 
|}
   −
=== Locations ===
+
===Locations===
==== Terrain, Trees, and Crops ====
+
====Terrain, trees, and crops====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,232: Line 1,288:  
|}
 
|}
   −
==== Objects and Lights ====
+
====Objects and lights====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,276: Line 1,334:  
|}
 
|}
   −
==== Farm Buildings ====
+
====Farm buildings====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,308: Line 1,368:  
|}
 
|}
   −
==== Farmhouse ====
+
====Farmhouse====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,336: Line 1,398:  
|}
 
|}
   −
==== Special Farm Setups ====
+
====Special farm setups====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,370: Line 1,434:  
|}
 
|}
   −
==== Community Center and Bundles ====
+
====Community center and bundles====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,437: Line 1,503:  
|}
 
|}
   −
==== Other Location-Specific Functions ====
+
====Other location-specific functions====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,475: Line 1,543:  
|}
 
|}
   −
=== World ===
+
===World===
==== Date and Time ====
+
====Date and time====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,520: Line 1,590:  
|}
 
|}
   −
==== Weather and World State ====
+
====Weather and world state====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,544: Line 1,616:  
|}
 
|}
   −
=== Game Settings and Meta Information ===
+
===Game settings and meta info===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
| conventionMode || Toggles Game1.conventionMode
+
| conventionMode
 +
| Toggles Game1.conventionMode
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,596: Line 1,671:  
}}
 
}}
   −
=== Multiplayer ===
+
===Multiplayer===
==== General Multiplayer ====
+
====General multiplayer====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,615: Line 1,692:  
}}
 
}}
   −
==== Logging ====
+
====Logging====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,638: Line 1,717:  
|}
 
|}
   −
==== Player Relationships ====
+
====Player relationships====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,657: Line 1,738:  
|}
 
|}
   −
==== Shared and Split Money ====
+
====Shared/split money====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,676: Line 1,759:  
|}
 
|}
   −
=== Audio and Visual Effects ===
+
===Audio and visual effects===
==== Animations ====
+
====Animations====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,722: Line 1,807:  
|}
 
|}
   −
==== Camera, Lighting, and Effects ====
+
====Camera, lighting, and effects====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,767: Line 1,854:  
|}
 
|}
   −
==== Music and Sounds ====
+
====Audio====
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
Line 1,786: Line 1,875:  
|}
 
|}
   −
=== Outdated, Unimplemented, or Unknown ===
+
===Outdated, unimplemented, or unknown===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! command !! description !! &nbsp;
+
! command
 +
! description
 +
! &nbsp;
 
|-
 
|-
 
{{/cmd
 
{{/cmd
translators
8,438

edits