Changes

Jump to navigation Jump to search
→‎Debug commands: add info about improved existing debug commands from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by BarleyZP, Atravita)
Line 384: Line 384:  
   |command = itemnamed,in
 
   |command = itemnamed,in
 
   |params  = {{t|S:itemName}},{{o|I:amount}},{{o|I:quality}}
 
   |params  = {{t|S:itemName}},{{o|I:amount}},{{o|I:quality}}
   |desc    = Adds the specified object to your inventory. Accepts only object names; this is not a fuzzy match but is case-insensitive. Punctuation should be included, but all spaces should be removed from the name (see examples below). If the requested name is not unique, all matching objects will be added. The optional parameters are for stack amount (default is 1) and quality (default is 0.)
+
   |desc    = Adds the specified object to your inventory. Accepts only object names; this is not a fuzzy match but is case-insensitive. Punctuation should be included, and arguments with spaces should be quoted. If the requested name is not unique, all matching objects will be added. The optional parameters are for stack amount (default is 1) and quality (default is 0.)
   |example = <code>debug itemnamed miner'streat</code> would give you [[Miner's Treat]].;<code>debug in strangedoll 3</code> would give you 3 of each of the Strange Doll [[artifacts]].
+
   |example = <code>debug itemnamed "miner's treat"</code> would give you [[Miner's Treat]].;<code>debug in "strange doll" 3</code> would give you 3 of each of the Strange Doll [[artifacts]].
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 630: Line 630:  
{{/cmd
 
{{/cmd
 
   |command = skullgear
 
   |command = skullgear
   |desc    = Sets your current backpack size to 32 slots, equips a Savage Ring and Iridium Band, equips Space Boots, and clears inventory except for an Iridium Pickaxe, a Galaxy Sword, a stack of 20 Spicy Eels, and a stack of 20 Mega Bombs. Also sets your maximum health to 75 and gives you the Fighter profession. Any previously equipped boots and rings and all previous inventory items are lost.
+
   |desc    = Sets your current backpack size to 36 slots, equips a Savage Ring and Iridium Band, equips Space Boots, and clears inventory except for an Iridium Pickaxe, a Galaxy Sword, a stack of 20 Spicy Eels, and a stack of 20 Mega Bombs. Also sets your maximum health to 75 and gives you the Fighter profession. Any previously equipped boots and rings and all previous inventory items are lost.
 
}}
 
}}
 
|}
 
|}
Line 798: Line 798:  
   |command = warptoplayer,wtp
 
   |command = warptoplayer,wtp
 
   |params  = {{t|S:playerName}}
 
   |params  = {{t|S:playerName}}
   |desc    = Warps you to the specified player, wherever they are. The match is case-insensitive and any spaces should be removed from the name.
+
   |desc    = Warps you to the specified player, wherever they are. The match is case-insensitive and names with spaces should be surrounded by double quotes.
 
}}
 
}}
 
|}
 
|}
Line 894: Line 894:  
   |command = killmonsterstat,kms
 
   |command = killmonsterstat,kms
 
   |params  = {{t|S:monsterName}},{{t|I:value}}
 
   |params  = {{t|S:monsterName}},{{t|I:value}}
   |desc    = Sets the kill stats for the specified monster to the specified value. The monster name should be the same as the keys in <samp>Data/Monsters</samp> but with spaces replaced with zeros; it is case-sensitive. The command will output a buggy response to the console due to referencing the wrong string key, but the stats are correctly set.
+
   |desc    = Sets the kill stats for the specified monster to the specified value. The monster name should be the same as the keys in <samp>Data/Monsters</samp> and names with spaces should be in double quotes; it is case-sensitive. The command will output a buggy response to the console due to referencing the wrong string key, but the stats are correctly set.
   |example = <code>debug kms Dust0Spirit 499</code> will set the monster kill stats for [[Dust Sprite|Dust Sprites]] to 499 and output ''Drink Dust Spirit?''
+
   |example = <code>debug kms "Dust Spirit" 499</code> will set the monster kill stats for [[Dust Sprite|Dust Sprites]] to 499 and output ''Drink Dust Spirit?''
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,030: Line 1,030:  
{{/cmd
 
{{/cmd
 
   |command = seenmail
 
   |command = seenmail
   |params  = {{t|S:mailID}}
+
   |params  = {{t|S:mailID}},{{t|B:addOrRemove}}
   |desc    = Marks specified mail as already received. The ID is case-sensitive; see <samp>Data/mail</samp> for valid IDs in the base game.
+
   |desc    = Marks specified mail as already received. The ID is case-sensitive; see <samp>Data/mail</samp> for valid IDs in the base game. You can remove a mail received (instead of adding it) by setting the second argument to false, like <samp>seenMail <code><id></code> false</samp>.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,159: Line 1,159:  
   |command = killall
 
   |command = killall
 
   |params  = {{t|S:npcName}}
 
   |params  = {{t|S:npcName}}
   |desc    = Removes all NPCs except for the specified character. Name is an exact match, and they are only spared from removal if they are in the current location.
+
   |desc    = Removes all NPCs except for the specified character. Name is an exact match, and they are only spared from removal if they are in the current location. Will also remove NPCs inside constructed buildings.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
 
   |command = killnpc
 
   |command = killnpc
 
   |params  = {{t|S:npcName}}
 
   |params  = {{t|S:npcName}}
   |desc    = Removes specified NPC from the game, checking all game locations. Name is an exact match.
+
   |desc    = Removes specified NPC from the game, checking all game locations (including constructed buildings). Name is an exact match.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,252: Line 1,252:  
   |command = dialogue
 
   |command = dialogue
 
   |params  = {{t|S:npcName}},{{t|S:dialogueString}}
 
   |params  = {{t|S:npcName}},{{t|S:dialogueString}}
   |desc    = Sets the dialogue for the specified character to the specified string. Name is a fuzzy match. The dialogue string should start with a zero and everything after will be parsed. It can include tokens such as <samp>@</samp> for the farmer name and portrait commands; see [[Modding:Dialogue#Format|Dialogue]] for format specifics.
+
   |desc    = Sets the dialogue for the specified character to the specified string. Name is a fuzzy match, and NPC names containing spaces should be quoted (e.g. <code>debug dialogue "Some NPC" Some dialgoue text$h</code>. The dialogue string should start with a zero and everything after will be parsed. It can include tokens such as <samp>@</samp> for the farmer name and portrait commands; see [[Modding:Dialogue#Format|Dialogue]] for format specifics.
 
   |example = <code>debug dialogue Abi 0Hi @! Modding is fun!$h</code> would set [[Abigail|Abigail's]] next dialogue to be ''Hi (FarmerName)! Modding is fun!'' with her happy portrait.
 
   |example = <code>debug dialogue Abi 0Hi @! Modding is fun!$h</code> would set [[Abigail|Abigail's]] next dialogue to be ''Hi (FarmerName)! Modding is fun!'' with her happy portrait.
 
}}
 
}}
Line 1,266: Line 1,266:  
{{/cmd
 
{{/cmd
 
   |command = question
 
   |command = question
   |params  = {{t|I:questionID}}
+
   |params  = {{t|I:questionID}},{{t|B:answerOrForget}}
   |desc    = Marks the specified dialogue question as answered.
+
   |desc    = Marks the specified dialogue question as answered. You can forget a selected answer (instead of adding it) by setting the second argument to false, like <samp>question <code><id></code> false</samp>.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,277: Line 1,277:  
   |command = speech
 
   |command = speech
 
   |params  = {{t|S:npcName}},{{t|S:dialogueKey}}
 
   |params  = {{t|S:npcName}},{{t|S:dialogueKey}}
   |desc    = Displays a dialogue box for the specified character saying the specified string. Name is a fuzzy match. The dialogue string should start with a zero and everything after will be parsed. It can include tokens such as <samp>@</samp> for the farmer name and portrait commands; see [[Modding:Dialogue#Format|Dialogue]] for format specifics. Useful for testing dialogue changes.
+
   |desc    = Displays a dialogue box for the specified character saying the specified string. Name is a fuzzy match and names with spaces should be in double quotes. The dialogue string should start with a zero and everything after will be parsed. It can include tokens such as <samp>@</samp> for the farmer name and portrait commands; see [[Modding:Dialogue#Format|Dialogue]] for format specifics. Useful for testing dialogue changes.
 
   |example = <code>debug speech Abi 0Hi @! Modding is fun!$h</code> would open a dialogue box of [[Abigail]] saying ''Hi (FarmerName)! Modding is fun!'' with her happy portrait.
 
   |example = <code>debug speech Abi 0Hi @! Modding is fun!$h</code> would open a dialogue box of [[Abigail]] saying ''Hi (FarmerName)! Modding is fun!'' with her happy portrait.
 
}}
 
}}
Line 1,333: Line 1,333:  
   |command = whereis,where
 
   |command = whereis,where
 
   |params  = {{t|S:npcName}}
 
   |params  = {{t|S:npcName}}
   |desc    = Outputs the location and coordinates of the specified character to the SMAPI console. Name is a fuzzy match.
+
   |desc    = Outputs the location and coordinates of the specified character to the SMAPI console. Name is a fuzzy match, so the command will return all matching NPCs.
 
}}
 
}}
 
|}
 
|}
Line 1,375: Line 1,375:  
{{/cmd
 
{{/cmd
 
   |command = growanimals
 
   |command = growanimals
   |desc    = Sets all animals who live in the current building to day 1 of adulthood. Must be done in a building such as a Barn or Coop. May cause each of them to eat hay.
+
   |desc    = Sets all animals who live in the current location to day 1 of adulthood, unless they are already adults. May cause each of them to eat hay.  
}}
  −
{{/cmd
  −
  |command = growanimalsfarm
  −
  |desc    = Sets all animals who live in the current location to day 1 of adulthood. Must be done on the Farm; this would apply to animals that no longer have homes due to building destruction such as after using [[#removebuildings|removebuildings]].
   
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,473: Line 1,469:  
{{/cmd
 
{{/cmd
 
   |command = eventseen, seenevent
 
   |command = eventseen, seenevent
   |params  = {{t|I:eventID}}
+
   |params  = {{t|I:eventID}},{{t|B:seeOrForget}}
   |desc    = Marks specifid event as seen by your farmer. Useful for enabling access to event-dependent areas or events.
+
   |desc    = Marks specifid event as seen by your farmer. Useful for enabling access to event-dependent areas or events. You can forget an event (instead of adding it) by setting the second argument to false, like <samp>seenEvent <code><id></code> false</samp>.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,589: Line 1,585:  
{{/cmd
 
{{/cmd
 
   |command = grass
 
   |command = grass
   |desc    = Spawns long grass on all available tiles on the farm.
+
   |desc    = Spawns long grass on all available tiles in the current location.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,640: Line 1,636:  
{{/cmd
 
{{/cmd
 
   |command = spreaddirt
 
   |command = spreaddirt
   |desc    = Tills all unoccupied diggable tiles on the farm.
+
   |desc    = Tills all unoccupied diggable tiles in the current location.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
 
   |command = spreadseeds
 
   |command = spreadseeds
 
   |params  = {{t|I:seedID}}
 
   |params  = {{t|I:seedID}}
   |desc    = Plants specified seed in all tilled dirt on the farm. The argument is the [[Modding:Items|object ID]] for the seed item. Out of season crops can be planted this way but will not survive outside of the greenhouse.<br />'''Warning: this will replace any currently-planted crops (including fully-grown ones) with the new seeds.'''
+
   |desc    = Plants specified seed in all tilled dirt in the current location. The argument is the [[Modding:Items|object ID]] for the seed item. Out of season crops can be planted this way but will not survive outside of the greenhouse.<br />'''Warning: this will replace any currently-planted crops (including fully-grown ones) with the new seeds.'''
 
   |example = <code>debug spreadseeds 472</code> would plant [[Parsnip|parsnips]] on all hoed dirt tiles.
 
   |example = <code>debug spreadseeds 472</code> would plant [[Parsnip|parsnips]] on all hoed dirt tiles.
 
}}
 
}}
Line 1,672: Line 1,668:  
{{/cmd
 
{{/cmd
 
   |command = clearfurniture
 
   |command = clearfurniture
   |desc    = Removes all furniture from the current location. Must be in a farmhouse/cabin. Use [[#removefurniture|removefurniture]] instead for other locations such as sheds.
+
   |desc    = Removes all furniture from the current location. Can be used in a farmhouse/cabin, or outside the farmhouse as well.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,723: Line 1,719:  
   |command = build
 
   |command = build
 
   |params  = {{t|S:Name}},{{o|I:X}},{{o|I:Y}}
 
   |params  = {{t|S:Name}},{{o|I:X}},{{o|I:Y}}
   |desc    = Builds the specified building at the given coordinates. Names are exact but spaces should be replaced with "<samp>9</samp>". If the coordinates are not specified, it will build just to the right of your farmer. While higher-level farm buildings such as Deluxe Barns can be immediately built this way, the incubator will be missing from Big or Deluxe Coops.
+
   |desc    = Builds the specified building at the given coordinates. Names are exact. If the name includes spaces, quote them (e.g. <samp>"Junimo Hut"</samp>). If the coordinates are not specified, it will build just to the right of your farmer. While higher-level farm buildings such as Deluxe Barns can be immediately built this way, the incubator will be missing from Big or Deluxe Coops.
   |example = <code>debug build Stone9Cabin</code> would build a new Stone Cabin next to the player.
+
   |example = <code>debug build "Stone Cabin"</code> would build a new Stone Cabin next to the player.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,734: Line 1,730:  
   |command = movebuilding
 
   |command = movebuilding
 
   |params  = {{t|I:sourceX}},{{t|I:sourceY}},{{t|I:destX}},{{t|I:destY}}
 
   |params  = {{t|I:sourceX}},{{t|I:sourceY}},{{t|I:destX}},{{t|I:destY}}
   |desc    = Moves building from specified source coordinates to specified destination coordinates. The coordinates are the upper-left corner of the building's footprint. The [https://www.nexusmods.com/stardewvalley/mods/541 Lookup Anything] mod is one of the easier ways to get the source coordinates of a building; they are listed under <samp>tileX</samp> and <samp>tileY</samp> in the debug info (needs <samp>ShowDataMiningFields</samp> enabled.)
+
   |desc    = Moves building in the current location from specified source coordinates to specified destination coordinates. The coordinates are the upper-left corner of the building's footprint. The [https://www.nexusmods.com/stardewvalley/mods/541 Lookup Anything] mod is one of the easier ways to get the source coordinates of a building; they are listed under <samp>tileX</samp> and <samp>tileY</samp> in the debug info (needs <samp>ShowDataMiningFields</samp> enabled.)
 +
}}
 +
{{/cmd
 +
  |command = paintBuilding,bpm
 +
  |desc    = Gets the building the player is standing in front of and opens a paint menu for that building if it can be painted. If the player is not standing in front of a building, defaults to the main farmhouse.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
 
   |command = removebuildings
 
   |command = removebuildings
 
   |desc    = Destroys all farm buildings. Animals within any of the buildings will also be removed, but animals which are outside will not be.
 
   |desc    = Destroys all farm buildings. Animals within any of the buildings will also be removed, but animals which are outside will not be.
 +
}}
 +
{{/cmd
 +
  |command = skinbuilding,bsm
 +
  |desc    = Opens a menu to reskin the building the player is standing in front of, if it can be skinned.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,773: Line 1,777:  
   |command = renovate
 
   |command = renovate
 
   |desc    = Opens the [[Carpenter's Shop#House Renovations|farmhouse renovation]] menu.
 
   |desc    = Opens the [[Carpenter's Shop#House Renovations|farmhouse renovation]] menu.
 +
}}
 +
{{/cmd
 +
  |command = thishouseupgrade,thishouse,thu
 +
  |params  = {{t|I:upgradeLevel}}
 +
  |desc    = Sets upgrade level of the farmhouse/cabin the player is standing in front of or within to the specified value. Valid values are <samp>0 - 3</samp>. Furniture and placed items will not be automatically moved and may wind up out of bounds. If done while the player is inside the house, warp points may not immediately update.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 1,918: Line 1,927:  
{{/cmd
 
{{/cmd
 
   |command = movie
 
   |command = movie
   |params  = {{o|S:npcNameOrMovieID}},{{o|S:movieID}}
+
   |params  = {{o|S:movieID}},{{o|S:inviteNpcName}}
   |desc    = Starts a movie; this command is a bit complex with its parameter handling so be sure to check the examples. Note that this command can create a group with up to 3 guests instead of just the single guest allowed in normal play. Valid movie IDs are listed after the parameter explanation.
+
   |desc    = Starts a movie. The movie ID defaults to today's movie, and the NPC name can be omitted to watch the movie without an invitee. Specifying <samp>current</samp> as the movie defaults to today's movie. Note that this command can create a group with up to 3 guests instead of just the single guest allowed in normal play. Valid movie IDs are listed below.
<ul><li>If both parameters are given, it will start the specified movie (second parameter) with the specified NPC (fuzzy match on first parameter) as a guest.</li>
  −
<li>If just one parameter is given, it is interpreted as the movie ID and the NPC guest(s) will be chosen randomly.</li>
  −
<li>If no parameters are given, the movie will default to <samp>fall_movie_1</samp> (''It Howls in the Rain'') and the NPC guest(s) will be chosen randomly.</li></ul>
   
<table class="wikitable"><tr><td><samp>spring_movie_0</samp> - ''The Brave Little Sapling''</td><td><samp>spring_movie_1</samp> - ''Natural Wonders''</td></tr>
 
<table class="wikitable"><tr><td><samp>spring_movie_0</samp> - ''The Brave Little Sapling''</td><td><samp>spring_movie_1</samp> - ''Natural Wonders''</td></tr>
 
<tr><td><samp>summer_movie_0</samp> - ''Journey of the Prairie King''</td><td><samp>summer_movie_1</samp> - ''Wumbus''</td></tr>
 
<tr><td><samp>summer_movie_0</samp> - ''Journey of the Prairie King''</td><td><samp>summer_movie_1</samp> - ''Wumbus''</td></tr>
Line 1,928: Line 1,934:  
<tr><td><samp>winter_movie_0</samp> - ''Miracle at Coldstar Ranch''</td><td><samp>winter_movie_1</samp> - ''The Zuzu City Express''</td></tr></table>
 
<tr><td><samp>winter_movie_0</samp> - ''Miracle at Coldstar Ranch''</td><td><samp>winter_movie_1</samp> - ''The Zuzu City Express''</td></tr></table>
 
'''Warning: This command also increases the save's <samp>uniqueID</samp> by 1 each time it is used, which will cause the save filename to change and impact some random events.'''
 
'''Warning: This command also increases the save's <samp>uniqueID</samp> by 1 each time it is used, which will cause the save filename to change and impact some random events.'''
   |example = <code>debug movie</code> would show ''It Howls in the Rain'' with random NPC guests.;<code>debug movie spring_movie_1</code> would show ''Natural Wonders'' with random NPC guests.;<code>debug movie Abi summer_movie_0</code> would show ''Journey of the Prairie King'' with Abigail and possibly 1 or 2 additional random NPC guests.
+
   |example = <code>debug movie</code> would show ''It Howls in the Rain'' with random NPC guests.;<code>debug movie spring_movie_1</code> would show ''Natural Wonders'' with random NPC guests.;<code>debug movie summer_movie_0 Abi</code> would show ''Journey of the Prairie King'' with Abigail and possibly 1 or 2 additional random NPC guests.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 2,213: Line 2,219:  
   |command = frameoffset, fo
 
   |command = frameoffset, fo
 
   |params  = {{t|I:frameID}},{{t|S:X}},{{t|S:Y}},{{t|S:??}}
 
   |params  = {{t|I:frameID}},{{t|S:X}},{{t|S:Y}},{{t|S:??}}
   |desc    = Sets frame offset for specified frame and specified X & Y values. The X and Y can be prefaced with <samp>s</samp> to flip the direction. Details unknown; reference <samp>FarmerRenderer.featureXOffsetPerFrame()</samp> and <samp>FarmerRenderer.featureYOffsetPerFrame()</samp>.
+
   |desc    = Sets frame offset for specified frame and specified X & Y values. The X and Y can be made negative to flip the direction. Details unknown; reference <samp>FarmerRenderer.featureXOffsetPerFrame()</samp> and <samp>FarmerRenderer.featureYOffsetPerFrame()</samp>.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 2,262: Line 2,268:  
{{/cmd
 
{{/cmd
 
   |command = panmode, pm
 
   |command = panmode, pm
   |desc    = Turns on panmode. During panmode the screen can be panned with movement keys or mouse movements and <samp>debug panmode</samp> or <samp>debug exit</samp> will turn panmode off.
+
   |desc    = Turns on panmode. During panmode the screen can be panned with movement keys or mouse movements and <samp>debug panmode</samp> or <samp>debug exit</samp> will turn panmode off. You can also clear with <sampe>debug panMode clear</samp> or set a time with <samp>debug panMode {time}</samp>.
 
}}
 
}}
 
{{/cmd
 
{{/cmd
Line 2,302: Line 2,308:  
{{/cmd
 
{{/cmd
 
   |command = playsound, ps
 
   |command = playsound, ps
   |params  = {{t|s:cueID}}
+
   |params  = {{t|s:cueID}},{{t|I:pitch}}
   |desc    = Playes the specified sound effect. See the [https://docs.google.com/spreadsheets/d/1CpDrw23peQiq-C7F2FjYOMePaYe0Rc9BwQsj3h6sjyo/ modder's resource spreadsheet] (Sound Bank IDs tab) for a list of valid cue IDs.
+
   |desc    = Playes the specified sound effect. The pitch argument is optional and can take values from 1 (low pitch) to 2400 (high pitch) inclusively. See the [https://docs.google.com/spreadsheets/d/1CpDrw23peQiq-C7F2FjYOMePaYe0Rc9BwQsj3h6sjyo/ modder's resource spreadsheet] (Sound Bank IDs tab) for a list of valid cue IDs.
 
   |example = <code>debug ps purchase</code> would make the coin clink sound heard when buying and selling items.  
 
   |example = <code>debug ps purchase</code> would make the coin clink sound heard when buying and selling items.  
 
}}
 
}}
138

edits

Navigation menu