138
edits
Changes
→Tile property changes: migrated by someone else; mark as such
{{Modder compatibility header}}
{{Modder compatibility header}}
This page explains how to update your mods for compatibility with the next major game version (tentatively {{version|1.6.0|Stardew Valley 1.6.0}}), and documents some of the changes and new functionality. See also [[Modding:Migrate to SMAPI 4.0|''Migrate to SMAPI 4.0'']].
This page explains how to update your mods for compatibility with {{version|1.6|Stardew Valley 1.6}}, and documents some of the changes and new functionality. See also [[Modding:Migrate to SMAPI 4.0|''Migrate to SMAPI 4.0'']].
{{TOC|limit=3}}
{{TOC|limit=3}}
===How to update your mod===
===How to update your mod===
# Update your mod code and assets for the changes listed below (particularly [[#Breaking changes for C# mods|''Breaking changes for C# mods'']] and [[#Breaking changes for content packs|''Breaking changes for content packs'']]).
The rest of this page may seem overwhelming, but fortunately most of it probably doesn't apply to your specific mods. Here's a suggested 'quick start' guide to update a mod for Stardew Valley 1.6.
# If SMAPI still says your mod is incompatible, check the <samp>TRACE</samp> messages in the log file for the reason why.<br />If the logs say "''marked 'assume broken' in SMAPI's internal compatibility list''", you can increase the <samp>Version</samp> in your content pack's <samp>manifest.json</samp> file to bypass it.
# Test the mod in-game and make any other changes needed.
; For C# mods:
:# Update the [https://www.nuget.org/packages/Pathoschild.Stardew.ModBuildConfig mod build config NuGet package] to the latest version.
:# In each <samp>.csproj</samp> project file, change <code><TargetFramework>net5.0</TargetFramework></code> to <code><TargetFramework>net6.0</TargetFramework></code>.<br /><small>(Tip: if the second line looks like <code><Project ToolsVersion=...</code> instead of <code><Project Sdk="Microsoft.NET.Sdk"></code>, you'll need to [[Modding:Migrate to Stardew Valley 1.5.5|migrate it to Stardew Valley 1.5.5]] first.)</small>
:# Rebuild the solution.
:# Fix any build errors. You can search this page for relevant info as needed.
:# Review all build warnings (particularly obsolete-code warnings), which may indicate code that broke in 1.6.
:# Increment your mod version in <samp>manifest.json</samp>.<br /><small>(Some mods may be added to SMAPI's compatibility blacklist due to runtime errors. Incrementing the mod version will fix that if so.)</small>
:# Test to make sure the mod works.
:# Skim through [[#Breaking changes for C# mods|''breaking changes for C# mods'']] and the table of contents, and check any section that might be relevant to the mod.
; For [[Modding:Content Patcher|Content Patcher]] packs:
:# Follow the [https://smapi.io/cp-migrate Content Patcher migration guide] until your content pack has <code>"Format": "2.0.0"</code>.<br /><small>'''Do not skip this step!''' Content Patcher will assume your content pack is pre-1.6 if you don't, which can cause confusing errors if you already updated it.</small>
:# Review [[#Breaking changes for content packs|''breaking changes for content packs'']] and update the content pack as needed.
; For content packs which use another framework:
: See the documentation for the framework mod. Often you won't need to update the content pack if the framework mod itself was updated.
==What's new architecturally?==
==What's new architecturally?==
For C# mod authors, Stardew Valley 1.6 updates from .NET 5 to .NET 6. See [https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6 ''What's new in .NET 6''] and [https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10 ''What's new in C# 10''] for more info, but some highlights include...
For C# mod authors, Stardew Valley 1.6 updates from .NET 5 to .NET 6. See [https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6 ''What's new in .NET 6''] and [https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10 ''What's new in C# 10''] for more info, but some highlights include...
* improved performance;
* [https://devblogs.microsoft.com/dotnet/performance-improvements-in-net-6/ improved performance];
* [https://devblogs.microsoft.com/dotnet/update-on-net-hot-reload-progress-and-visual-studio-2022-highlights/ improved hot reload];
* [https://devblogs.microsoft.com/dotnet/update-on-net-hot-reload-progress-and-visual-studio-2022-highlights/ improved hot reload];
* [https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6#new-linq-apis new LINQ methods];
* [https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6#new-linq-apis new LINQ methods];
* and support for ARM64 on macOS.
* and support for ARM64 on macOS.
==What's new for items==
===Trigger actions===
{{/doc status|[[Modding:Trigger actions]]|done=true}}
Trigger actions are a new feature which lets content packs perform an action when something happens, with support for a wide range of actions (like sending mail, changing friendship, starting a quest, etc).
For example, it lets you have logic like "''When the player arrives in the Farm location, if Leo has moved to the valley, then send a letter and start a conversation topic''":
<syntaxhighlight lang="js">
{
"Trigger": "LocationChanged",
"Location": "Farm",
"Condition": "PLAYER_HAS_FLAG Host leoMoved",
"Actions": [
"AddMail Current Abigail_LeoMoved Today",
"AddConversationTopic LeoMoved 5"
]
}
</syntaxhighlight>
===Hash set fields===
For C# mod authors, the game now uses [https://www.bytehide.com/blog/hashset-csharp hash sets] for many list fields which expect unique values. That allows much more efficient O(1) read/write, prevents duplicate values, and simplifies common logic.
This affects:
{| class="wikitable"
{| class="wikitable"
|-
|-
! type
! type
! description
! fields
|-
|-
| <samp>ItemId</samp>
| <samp>Farmer</samp>
| <samp>string</samp>
| <samp>achievements</samp><br /><samp>dialogueQuestionsAnswered</samp><br /><samp>eventsSeen</samp><br /><samp>mailForTomorrow</samp><br /><samp>mailReceived</samp><br /><samp>professions</samp><br /><samp>secretNotesSeen</samp><br /><samp>songsHeard</samp>
|-
|-
| <samp>QualifiedItemId</samp>
| <samp>FarmerTeam</samp>
| <samp>string</samp>
| <samp>acceptedSpecialOrderTypes</samp><br /><samp>broadcastedMail</samp><br /><samp>completedSpecialOrders</samp><br /><samp>collectedNutTracker</samp>
|-
|-
| <samp>ParentSheetIndex</samp>
| <samp>Game1</samp>
| <samp>int</samp>
| <samp>worldStateIDs</samp>
|-
|-
| <samp>TypeDefinitionId</samp>
| <samp>NetWorldState</samp>
| <samp>string</samp>
| <samp>ActivePassiveFestivals</samp><br /><samp>CheckedGarbage</samp><br /><samp>FoundBuriedNuts</samp><br /><samp>IslandVisitors</samp><br /><samp>LocationsWithBuildings</samp>
<syntaxhighlight lang="c#">
</syntaxhighlight>
|}
|}
Usage is very similar, and many list methods like <samp>Contains</samp> work the same way with hash sets. Here are the main differences:
<ul>
<syntaxhighlight lang="json">
<li>Hash sets aren't ordered. For example, there's no guarantee that the first value when you enumerate it was the earliest one added.</li>
<li><p>Hash sets can't be indexed. For example, you can no longer use <code>list[0]</code> to get the first value. You can still enumerate them or use LINQ methods like <samp>set.First()</samp>, but in most cases you should use the set methods like <samp>Add</samp> or <samp>Contains</samp> instead.</p>
</syntaxhighlight>
To remove multiple matching values from the set, you can use <samp>RemoveWhere</samp> instead:
<syntaxhighlight lang="c#">
// old code
for (int i = Game1.player.mailReceived.Count - 1; i >= 0; i--)
{
if (Game1.player.mailReceived[i].StartsWith("Example.ModId_"))
Game1.player.mailReceived.RemoveAt(i);
}
// new code
Game1.player.mailReceived.RemoveWhere(id => id.StartsWith("Example.ModId_"));
</syntaxhighlight>
</li>
<li>You no longer need to check before adding a value, since the hash set will ignore duplicates.</li>
<li>The <samp>Add</samp>/<samp>Remove</samp>/<samp>RemoveWhere</samp> methods return whether a value was added/removed, which lets you check at the same time. For example:
<syntaxhighlight lang="c#">
if (Game1.player.mailReceived.Add("BackpackTip")) // returns true if it wasn't in the set yet
Game1.addMailForTomorrow("pierreBackpack");
</syntaxhighlight>
</li>
</ul>
===DataLoader===
<samp>DataLoader</samp> is a new C# utility which provides strongly-typed methods to load the game's data assets.
This solves an issue where we often needed fragile code like <code>Game1.content.Load<Dictionary<string, PassiveFestivalData>>("Data\\PassiveFestivals")</code>. With that code, it's easy to accidentally misspell the asset name, use different capitalization (which would break on Linux/macOS), or use the wrong return type. If you did, you likely wouldn't notice until the code actually executed at runtime and threw an exception.
In Stardew Valley 1.6, you can now rewrite that code like <code>DataLoader.PassiveFestivals(Game1.content)</code>. That's simpler, you can't use the wrong asset name or type, and it's more future-proof in case the game changes them.
===Unique string IDs===
{{/doc status|[[Modding:Common data field types#Unique string ID]]|done=true}}
Stardew Valley now uses ''unique string IDs'' throughout the code to identify data (like events, locations, items, NPCs, etc). For example, <code>Town</code> is the unique ID for the [[Pelican Town]] location; no other location can use that ID. The IDs are used for a wide range of purposes, from internal game logic to [[Modding:Content Patcher|content pack edits]].
For mods, it's '''strongly recommended''' to...
* Use namespaced IDs prefixed with your [[Modding:Modder Guide/APIs/Manifest#Basic fields|mod's unique ID]] for all new content. For example, if your mod ID is <code>Example.PufferchickMod</code> and you're adding a pufferchick plushy, your item ID would look like <code>Example.PufferchickMod_PufferchickPlushy</code>. In a [[Modding:Content Patcher|Content Patcher pack]], you can use <code><nowiki>{{ModId}}_PufferchickPlushy</nowiki></code> to insert your mod ID automatically. This eliminates ID conflicts between mods, and makes it easy (for both troubleshooters and mod code) to identify which mod added a particular content. See [[Modding:Common data field types#Unique string ID|the new format docs]] for the recommended format.
* Only use alphanumeric (a–z, A–Z, 0–9), underscore (<code>_</code>), and dot (<code>.</code>) characters in string IDs. This is important because they're often used in places where some characters have special meaning (like file names or [[#Game state queries|game state queries]]).
You can optionally migrate pre-1.6 content to use unique string IDs too, without breaking existing players' saves. This is recommended to reduce mod conflicts and simplify troubleshooting going forward. Here's how to migrate for each data type:
{{collapse|migration steps for pre-1.6 content|content= 
{{{!}} class="wikitable"
{{!}}-
! content type
! how to change IDs
{{!}}-
{{!}} [[Modding:Event data|event IDs]]<br />[[Modding:Items|item IDs]]<br />[[Modding:Mail data|mail IDs]]<br />[[Modding:Recipe data|recipe IDs]]<br />[[#Custom jukebox tracks|song IDs for jukebox]]
{{!}} [[Modding:Content Patcher|Content Patcher]] adds a custom [[Modding:Trigger actions|trigger action]] which can migrate IDs everywhere in the save data.
For example, this migrates two crafting recipe IDs:
<syntaxhighlight lang="js">
{
"Action": "EditData",
"Target": "Data/TriggerActions",
"Entries": {
"{{ModId}}_MigrateToUniqueIds": {
"Id": "{{ModId}}_MigrateToUniqueIds",
"Trigger": "DayStarted",
"Actions": [
// Note: use double-quotes around an argument if it contains spaces. This example has single-quotes for
// the action itself, so we don't need to escape the double-quotes inside it.
'Pathoschild.ContentPatcher_MigrateIds CraftingRecipes "Puffer Plush" {{ModId}}_PufferPlush "Puffer Sofa" {{ModId}}_PufferSofa'
],
"HostOnly": true
}
}
}
</syntaxhighlight>
See the [https://github.com/Pathoschild/StardewMods/blob/develop/ContentPatcher/docs/author-guide/trigger-actions.md Content Patcher docs] for more info about using the trigger action, including restrictions and valid ID types.
{{!}}-
{{!}} [[Modding:Location data|location IDs]]
{{!}} Add the old name to the location's <samp>FormerLocationNames</samp> field in <samp>Data/Locations</samp>.
{{!}}-
{{!}} [[Modding:NPC data|NPC internal names]]
{{!}} Add the old name to the NPC's <samp>FormerCharacterNames</samp> field in <samp>Data/Characters</samp>.
{{!}}-
{{!}} [[Modding:Quest data|quest]] and [[Modding:Special orders|special order]] IDs
{{!}} Currently there's no safe way to migrate quest and special order IDs, since removing and readding them will reset any progress the player has made on them.
{{!}}}
}}
==What's new for items==
===Custom items===
{{/doc status|[[Modding:Items]]|done=true}}
====Overview====
Stardew Valley 1.6 makes three major changes to how items work in the game:
# Each item now has a string ID (<samp>ItemId</samp>) and a globally unique string ID (<samp>QualifiedItemId</samp>). The <samp>QualifiedItemId</samp> is auto-generated by prefixing the <samp>ItemId</samp> with the item type identifier.<p>For legacy reasons, the <samp>ItemId</samp> for vanilla items may not be globally unique. For example, Pufferfish (object 128) and Mushroom Box (bigcraftable 128) both have <samp>ItemId: 128</samp>. They can be distinguished by their <samp>QualifiedItemId</samp>, which are <samp>(O)128</samp> and <samp>(BC)128</samp> respectively.
# Each item type now has an ''item data definition'' in the game code which tells the game how to handle it. [[#For C# mods|C# mods can add or edit definitions]]. Each definition has a unique prefix which is used in the qualified item IDs. The vanilla types are bigcraftables (<samp>(BC)</samp>), boots (<samp>(B)</samp>), farmhouse flooring (<samp>(FL)</samp>), furniture (<samp>(F)</samp>), hats (<samp>(H)</samp>), objects (<samp>(O)</samp>), pants (<samp>(P)</samp>), shirts (<samp>(S)</samp>), tools (<samp>(T)</samp>), wallpaper (<samp>(WP)</samp>), and weapons (<samp>(W)</samp>).</li>
# Custom items can now provide their own item texture, specified in a new field in the item data assets (see below). The item's <samp>ParentSheetIndex</samp> field is the index within that texture.
In other words, the four important fields for items are:
{| class="wikitable"
{| class="wikitable"
|-
|-
! data asset
! name
! item ID format
! type
! description
|-
| <samp>ItemId</samp>
| <samp>string</samp>
| A [[Modding:Common data field types#Unique string ID|unique string ID]] for this item which should be globally unique (but may not be for existing vanilla items for backwards compatibility). For example, <samp>128</samp> (vanilla item) or <samp>Example.ModId_Watermelon</samp> (custom item).
|-
| <samp>QualifiedItemId</samp>
| <samp>string</samp>
| A globally unique item key, like <samp>(O)128</samp> for a vanilla item or <samp>(O)Example.ModId_Watermelon</samp> for a custom one. This is auto-generated from the <samp>TypeDefinitionId</samp> and <samp>ItemId</samp> fields.
|-
| <samp>ParentSheetIndex</samp>
| <samp>int</samp>
| The item's sprite index within its spritesheet.
|-
| <samp>TypeDefinitionId</samp>
| <samp>string</samp>
| The ID for the data definition which defines the item, like <samp>(O)</samp> for an object. You can use <samp>ItemRegistry.type_*</samp> constants with this field:
<syntaxhighlight lang="c#">
if (item.TypeDefinitionId == ItemRegistry.type_object)
...
</syntaxhighlight>
|}
====Item references====
Item references throughout the game code now use the <samp>ItemId</samp> instead of the <samp>ParentSheetIndex</samp>. Since the <samp>ItemId</samp> is identical to the index for existing vanilla items, most data assets are unaffected by this change. For example, here's from <samp>Data/NPCGiftTastes</samp> with one custom item:
<syntaxhighlight lang="json">
"Universal_Like": "-2 -7 -26 -75 -80 72 395 613 634 635 636 637 638 724 459 Example.ModID_watermelon"
</syntaxhighlight>
Unless otherwise noted, unqualified item IDs will produce [[Modding:Items|objects]]. Some assets let you override that by specifying a <samp>QualifiedItemId</samp> value instead. For example, you can add <code>(O)128</code> to the gift taste list to explicitly add for an object. Here's a partial list of data assets and their supported item ID formats:
{| class="wikitable"
|-
! data asset
! item ID format
|-
|-
| [[Modding:Recipe data|<samp>Data/CraftingRecipes</samp><br /><samp>Data/CookingRecipes</samp>]]
| [[Modding:Recipe data|<samp>Data/CraftingRecipes</samp><br /><samp>Data/CookingRecipes</samp>]]
|  
|  
* Ingredients: both supported.
* Ingredients: both supported.
* Output: set field 2 to the unqualified item ID, and field 3 to one of <samp>true</samp> (bigcraftable) or <samp>false</samp> (object) or an item type identifier like <samp>BC</samp>.
* Output: set field 2 to the unqualified item ID, and field 3 to one of <samp>true</samp> (bigcraftable) or <samp>false</samp> (object).
|-
|-
| [[#Custom fruit trees|<samp>Data/fruitTrees</samp>]]
| [[#Custom fruit trees|<samp>Data/fruitTrees</samp>]]
| [[Modding:Items|big craftables]]
| [[Modding:Items|big craftables]]
| <samp>(BC)</samp>
| <samp>(BC)</samp>
| <samp>Data/BigCraftablesInformation</samp><br /><small>Each item can set a custom texture name in field 11, and sprite index in field 10. The default texture is <samp>TileSheets/Craftables</samp>.</small>
| <samp>Data/BigCraftables</samp><br /><small>Each item can set a custom texture name in the <samp>Texture</samp> field, and sprite index in the <samp>SpriteIndex</samp> field. The default texture is <samp>TileSheets/Craftables</samp>.</small>
|-
|-
| boots
| boots
| [[Modding:Crop data|crops]]
| [[Modding:Crop data|crops]]
| <small>''not technically an item type''</small>
| <small>''not technically an item type''</small>
| <samp>Data/Crops</samp><br /><small>Each crop can set a custom texture name in field 9, and sprite index in field 2. The default texture is <samp>TileSheets/crops</samp>.</small>
| <samp>Data/Crops</samp><br /><small>Each crop can set a custom texture name and sprite index. The default texture is <samp>TileSheets/crops</samp>.</small>
|-
|-
| [[Modding:Fish data|fish (in fish tanks)]]
| [[Modding:Fish data|fish (in fish tanks)]]
| fruit trees
| fruit trees
| <small>''not technically an item type''</small>
| <small>''not technically an item type''</small>
| <samp>Data/FruitTrees</samp><br /><small>Each fruit tree can set a custom texture name in field 4, and sprite index in field 0. The default texture is <samp>TileSheets/fruitTrees</samp>.</small>
| <samp>Data/FruitTrees</samp><br /><small>Each fruit tree can set a custom texture name and sprite index. The default texture is <samp>TileSheets/fruitTrees</samp>.</small>
|-
|-
| [[Modding:Items|hats]]
| [[Modding:Items|hats]]
| [[Modding:Items|objects]]
| [[Modding:Items|objects]]
| <samp>(O)</samp>
| <samp>(O)</samp>
| <samp>Data/ObjectInformation</samp><br /><small>Each item can set a custom texture name in field 10, and sprite index in field 9. The default texture is <samp>Maps/springobjects</samp>.</small>
| <samp>Data/Objects</samp><br /><small>Each item can set a custom texture name in the <samp>Texture</samp> field, and sprite index in the <samp>SpriteIndex</samp> field. The default texture is <samp>Maps/springobjects</samp>.</small>
|-
|-
| pants & shirts
| [[#Custom pants|pants]]
| <samp>(P)</samp> and <samp>(S)</samp>
| <samp>(P)</samp>
| <samp>Data/ClothingInformation</samp><br /><small>Each item can set a custom texture name in field 10, and sprite index in fields 3 (male) and 4 (female). If field 4 is <samp>-1</samp>, it'll use the same value as the male index. The default texture is <samp>Characters/Farmer/pants</samp> and <samp>Characters/Farmer/shirts</samp>.</small>
| <samp>Data/pantsData</samp><br /><small>Each item can set a custom texture name in the <samp>Texture</samp> field, and sprite index in the <samp>SpriteIndex</samp> field. The default texture is <samp>Characters/Farmer/pants</samp>.</small>
|-
| [[#Custom shirts|shirts]]
| <samp>(S)</samp>
| <samp>Data/shirtData</samp><br /><small>Each item can set a custom texture name in the <samp>Texture</samp> field, and sprite index in the <samp>SpriteIndex</samp> field. The default texture is <samp>Characters/Farmer/shirts</samp>.</small>
<small>Shirt textures must be exactly 256 pixels wide, divided into two halves: the left half for the shirt sprites, and the right half for any dye masks. The remaining space can be left blank if needed.</small>
<pre>
sprites dye masks
/-----------\ /-----------\
┌────────────────────────────────┐
│ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │
│ │ 0 ││ 1 ││ 2 ││ a ││ b ││ c │ │
│ └───┘└───┘└───┘└───┘└───┘└───┘ │
│ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │
│ │ 3 ││ 4 ││ 5 ││ d ││ e ││ f │ │
│ └───┘└───┘└───┘└───┘└───┘└───┘ │
└────────────────────────────────┘
</pre>
|-
|-
| [[#Custom tools|tools]]
| [[#Custom tools|tools]]
| [[Modding:Items|weapons]]
| [[Modding:Items|weapons]]
| <samp>(W)</samp>
| <samp>(W)</samp>
| <samp>Data/Weapons</samp><br /><small>Each item can set a custom texture name in field 16, and sprite index in field 15. The default texture is <samp>TileSheets/weapons</samp>.</small>
| <samp>Data/Weapons</samp><br /><small>[[#Custom melee weapons|Completely overhauled]] into a data model.</small>
|}
|}
You can define custom items for most vanilla item types using only [[Modding:Content Patcher|Content Patcher]] or [[Modding:Modder Guide/APIs/Content|SMAPI's content API]].
You can define custom items for most vanilla item types using only [[Modding:Content Patcher|Content Patcher]] or [[Modding:Modder Guide/APIs/Content|SMAPI's content API]].
Most item data assets work just like <samp>Data/Objects</samp>. See also specific info for [[#Custom fruit trees|custom fruit trees]], [[#Custom tools|custom tools]], and [[#Custom melee weapon data|melee weapons]].
====Error items====
In-game items with no underlying data (e.g. because you removed the mod which adds them) would previously cause issues like invisible items, errors, and crashes. This was partly mitigated by the bundled Error Handler mod.
{{#tag:syntaxhighlight|<nowiki>
Stardew Valley 1.6 adds comprehensive handling for such items. They'll be shown with a <samp>🛇</samp> sprite in inventory UIs and in-game, the name Error Item, and a description which indicates the missing item ID for troubleshooting.
====For C# mods====
Stardew Valley 1.6 added new ways to compare/construct items, define custom item types, and work with item metadata. Please see [[Modding:Items]] for the migrated docs.
===Custom big craftables===
{{/doc status|[[Modding:Items#Big craftables]]|done=true}}
You can now create/edit [[Modding:Items#Big craftables|big craftables]] by editing the new <samp>Data/BigCraftables</samp> asset, which replaces the previous slash-delimited <samp>Data/BigCraftablesInformation</samp>.
Besides the format change, this adds...
* context tags (moved from the former <samp>Data/ObjectContextTags</samp> asset);
* [[#Custom data fields|custom fields]] to let framework mods support additional features.
===Custom crops===
{{/doc status|[[Modding:Crop data]]|done=true}}
[[Modding:Crop data|Crops]] are still stored in <samp>Data/Crops</samp>, but that asset has been overhauled in Stardew Valley 1.6. The slash-delimited entries are now models to simplify edits and enable new features.
===Custom fences===
{{/doc status|[[Modding:Fences]]|done=true}}
You can now add or customize [[Crafting#Fences|fences]] by editing the <samp>Data/Fences</samp> asset.
===Custom floors (craftable) & paths===
{{/doc status|[[Modding:Floors and Paths]]|done=true}}
You can now add or customize [[Crafting#Decor|craftable floors & paths]] by editing the <samp>Data/FloorsAndPaths</samp> asset. See the new doc page for formatting information.
===Custom machines===
{{/doc status|[[Modding:Machines]]|done=true}}
You can now add/edit machine logic by editing the <samp>Data/Machines</samp> asset. This supports the full range of vanilla functionality, including calling custom code define in C# mods.
For C# mods, 1.6 also adds a new <samp>MachineDataUtility</samp> class and various <samp>Object</samp> to simplify working with machines in code. These are used by the game code itself to implement the base machine logic.
====Error items====
===Custom melee weapons===
{{/doc status|[[Modding:Items#Weapons]]|done=true}}
Stardew Valley 1.6 adds comprehensive handling for such items. They'll be shown with a <samp>🛇</samp> sprite in inventory UIs and in-game, the name Error Item, and a description which indicates the missing item ID for troubleshooting.
[[Modding:Items#Weapons|Melee weapons]] are still stored in <samp>Data/Weapons</samp>, but that asset has been overhauled in Stardew Valley 1.6. The slash-delimited entries are now models to simplify edits and enable new features (like the new <samp>Projectiles</samp> feature).
====For C# mods====
===Custom movie concessions===
{{/doc status|[[Modding:Movie theater data]]|done=true}}
: ''See also: [[#Custom movies|custom movies]].''
You could already [[Modding:Movie theater data#Concession data|add/edit concessions]] sold in the [[Movie Theater|movie theater]], but conflicts were likely since each concession had an incrementing numeric ID which matched its position in the vanilla tilesheet.
Stardew Valley 1.6 addresses that with two changes:
<ul>
<li>The <samp>Id</samp> field is now a [[Modding:Common data field types#Unique string ID|unique string ID]].</li>
<li>You can now use a different texture with two new required fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! old code
! field
! new code
! effect
|-
|-
| <samp>Texture</samp>
| The asset name for the texture containing the concession's sprite.
|-
|-
| <samp>item.ParentSheetIndex == 128</samp>
| <samp>SpriteIndex</samp>
| <samp>item.QualifiedItemId == "(O)128"</samp>
| The index within the <samp>Texture</samp> for the concession sprite, where 0 is the top-left sprite.
|}
|}
</li>
</ul>
===Custom museum donations & rewards===
{{/doc status|[[Modding:Museum]]|done=true}}
You can now add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.
The ''A Complete Collection'' [[Achievements|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).
===Custom fruit trees===
{{/doc status|[[Modding:Fruit trees]]|done=true}}
You can use a new utility method to construct items from their <samp>QualifiedItemId</samp>:
You can now add custom [[Fruit Trees|fruit trees]] by editing the revamped <samp>Data/FruitTrees</samp> asset.
<syntaxhighlight lang="c#">
For C# mods, the <samp>fruitsOnTree</samp> field (number of fruit on the tree) has been replaced by <samp>fruit</samp> (list of fruit items).
</syntaxhighlight>
</dd>
Custom trees can be added to the game in two ways:
* Spawn them on [[Modding:Maps|map tiles]] when the location is created, using the new <samp>SpawnTree: fruit {{t|tree ID}} {{o|growth stage on location created}} {{o|growth stage on day-update regrowth}}</samp> tile property. This must be added on the <samp>Paths</samp> layer, which must also have tile index 34 from the <samp>paths</samp> tilesheet.
* Or give the player a seed item in the usual ways (e.g. from [[#Custom shops|a shop]], [[Modding:Mail data|mail letter]], etc).
===Custom objects===
{{/doc status|[[Modding:Items#Objects]]|done=true}}
You can now create/edit objects (the main item type) by editing the new <samp>Data/Objects</samp> asset, which replaces the previous slash-delimited <samp>Data/objectInformation</samp>.
<dt>Work with item metadata</dt>
Besides the format change, this adds...
<dd>
* support for custom textures;
* revamped geode drops with support for conditions, probabilities, and item queries;
* expanded food/drink buffs (e.g. set a custom buff ID, add a custom buff icon, etc);
* context tags (moved from the former <samp>Data/ObjectContextTags</samp> asset);
* [[#Custom data fields|custom fields]] to let framework mods support additional features.
===Custom pants===
{{/doc status|[[Modding:Items#Pants]]|done=true}}
You can now create/edit [[Tailoring#Pants|pants]] by editing the new <samp>Data/Pants</samp> asset, which replaces <samp>Data/clothingInformation</samp>.
===Custom shirts===
{{/doc status|[[Modding:Items#Shirts]]|done=true}}
You can now create/edit [[Tailoring#Shirts|shirts]] by editing the new <samp>Data/Shirts</samp> asset, which replaces <samp>Data/clothingInformation</samp>.
===Custom tools===
{{/doc status|[[Modding:Items#Tools]]|done=true}}
You can now create/edit [[tools]] by editing the new <samp>Data/Tools</samp> asset. Note that drawing the tool correctly in the world (ie, while the player is trying to use it) probably still needs custom code.
===Custom wild trees===
{{/doc status|[[Modding:Wild trees]]|done=true}}
| Create an item from its item ID (qualified or unqualified). If the ID doesn't match a real item, the optional <samp>allowNull</samp> parameter indicates whether to return null or an Error Item. For example:
You can also get a specific value type instead of <samp>Item</samp> if needed. This will throw a descriptive exception if the type isn't compatible (e.g. you try to convert furniture to boots).
You can now create/edit [[Trees|wild trees]] by editing the <samp>Data/WildTrees</samp> asset.
|-
Custom trees can be added to the game in two ways:
* Spawn them on [[Modding:Maps|map tiles]] when the location is created, using the new <samp>SpawnTree: wild {{t|tree ID}} {{o|growth stage on location created}} {{o|growth stage on day-update regrowth}}</samp> tile property. This must be added on the <samp>Paths</samp> layer, which must also have tile index 34 from the <samp>paths</samp> tilesheet.
* Or give the player a seed item in the usual ways (e.g. from [[#Custom shops|a shop]], [[Modding:Mail data|mail letter]], etc).
// does the item exist in the data files?
===Default recipes===
{{/doc status|[[Modding:Recipe data]]|done=true}}
You can now have [[Modding:Recipe data|crafting and cooking recipes]] that are learned automatically by setting the condition field to <samp>default</samp>. Any missing default recipes will be learned on day start.
<syntaxhighlight lang="c#">
// get parsed info
// draw an item sprite
For example, here's the chest entry from <samp>Data/CraftingRecipes</samp>:
<syntaxhighlight lang="js">
"Chest": "388 50/Home/130/true/default/"
</syntaxhighlight>
</syntaxhighlight>
===Global inventories===
<syntaxhighlight lang="c#">
C# mods can now set a <samp>chest.GlobalInventoryId</samp> field to make it share a global inventory with every other chest having the same ID. This replaces the equivalent hardcoded logic for [[Junimo Chest|Junimo chests]], which now just default to a <samp>"JunimoChests"</samp> global inventory ID. For example, this can be used to have multiple Junimo chest networks or make other containers share inventory.
</syntaxhighlight>
C# mods can also use this to store items for other mod purposes, by using <samp>Game1.player.team.globalInventories</samp> or <samp>Game1.player.team.GetOrCreateGlobalInventory(id)</samp> directly.
===Hats on aquarium fish===
{{/doc status|[[Modding:Fish data]]|done=true}}
|-
|}
Custom [[Modding:Fish data|fish in aquariums]] can now wear [[hats]], just like vanilla [[Sea Urchin|sea urchins]]. This can be enabled by specifying a new field in <samp>Data/AquariumFish</samp>:
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! purpose
|-
| 7
| hat position
| The pixel position of the hat on the sprite, specified as an object with <samp>X</samp> and <samp>Y</samp> values.
|}
===Context tag changes===
{{/doc status|[[Modding:Items#Context tags]]|done=true}}
====New context tags====
1.6 adds several new [[Modding:Items#Context tags|item context tags]]:
{| class="wikitable"
|-
! context tag
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>campfire_item</samp>
| A key which uniquely identifies this fence. The ID should only contain alphanumeric/underscore/dot characters. For custom fences, this should be prefixed with your mod ID like <samp>Example.ModId_FenceName</samp>.
| Marks the item as a [[campfire]]. If the item also has the <samp>torch_item</samp> context tag, when it's placed in the world and turned on...
* campfire flames are drawn over it;
* if the item is [[Modding:Items#Big craftables|big craftable]], light is emitted from its center instead of the top.
|-
|-
| <samp>ItemId</samp>
| <samp>fish_pond_ignore</samp>
| The unqualified [[#Custom items|item ID]] for the corresponding object-type item.
| Prevents players from adding this fish to [[Fish Pond|fish ponds]], even if it would otherwise match an entry in <samp>Data/FishPondData</samp>.
|-
|-
| <samp>Health</samp>
| <samp>geode_crusher_ignored</samp>
| The health points for a fence when it's first placed, which affects how quickly it degrades. A fence loses <sup>1</sup>/<sub>1440</sub> points per in-game minute (roughly 0.04 points per hour or 0.5 points for a 12-hour day).
| Prevents breaking this item open in a [[Geode Crusher|geode crusher]], even if the item has geode fields in [[#Custom objects|<samp>Data/Objects</samp>]].
|-
|-
| <samp>Texture</samp>
| <samp>item_type_{{t|type}}</samp>
| The asset name for the texture (under the game's <samp>Content</samp> folder) when the fence is placed. Use <samp>\</samp> (or <samp>\\</samp> in JSON) to separate name segments if needed. For example, the vanilla fences use individual tilesheets like <samp>LooseSprites\Fence1</samp> (wood fence).
| For an [[Modding:Items#Objects|object-type item]], the type value from the 'type and category' field. (Non-object items always have the exact tag <samp>item_type_</samp> with nothing after the last underscore.) This is automatic and shouldn't be set manually. The tag is checked in a few places (''e.g.'' the [[museum]] to check if an item is an artifact or mineral), but most of the game won't be affected.
|-
|-
| <samp>RemovalTool</samp>
| <samp>museum_donatable</samp><br /><samp>not_museum_donatable</samp>
| Set whether the item can be donated to the [[museum]], overriding the vanilla logic.
|-
|-
| <samp>PlacementSound</samp>
| <samp>not_giftable</samp>
| The [[#Custom audio|audio cue ID]] played when the fence is placed or repaired (e.g. <samp>axe</samp> used by [[Wood Fence]]).
| Prevents players from gifting this item to NPCs, who'll ignore the item entirely (e.g. as if you were holding a tool).
This only affects gift-giving, it doesn't affect non-gift logic like quest goals or special order objectives. If the NPC also has a <samp>reject_*</samp> dialogue for the item, the dialogue takes priority.
|-
|-
| <samp>RemovalSound</samp>
| <samp>not_placeable</samp><br /><samp>placeable</samp>
| Sets whether the item can be placed on the ground.
|-
|-
| <samp>RemovalDebrisType</samp>
| <samp>prevent_loss_on_death</samp>
| ''(Optional)'' The type of cosmetic debris particles to 'splash' from the tile when the fence is broken with a tool. The defined values are 0 (copper), 2 (iron), 4 (coal), 6 (gold), 8 (coins), 10 (iridium), 12 (wood), 14 (stone), 32 (big stone), and 34 (big wood). Default 14 (stone).
| Indicates the item can't be [[Adventurer's Guild#Item Recovery Service|lost when the player dies]].
|-
|-
| <samp>RepairHealthAdjustmentMinimum</samp><br /><samp>RepairHealthAdjustmentMaximum</samp>
| <samp>sign_item</samp>
| ''(Optional)'' A random amount added to the <samp>Health</samp> when a fence is repaired by a player. See the <samp>Health</samp> field description. Both default to 0.
| Marks the item as a [[Crafting#Signs|sign]], which lets player display items on it or place it on a [[Fish Pond|fish pond]] to show the fish count.
|-
|-
| <samp>HeldObjectDrawOffset</samp>
| <samp>torch_item</samp>
| ''(Optional)'' When an item like a [[torch]] is placed on the fence, the pixel offset to apply to its draw position. Specified as a string in the form <samp>"{{t|x}}, {{t|y}}"</samp>. Defaults to <samp>"0, -20"</samp> if omitted.
| Marks the item as a [[torch]], which lets the player turn it on/off to emit light.
See also <samp>campfire_item</samp>.
|}
|}
Context tags which affect [[#Custom machines|machine processing]]:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! context tag
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>crystalarium_banned</samp>
| A key which uniquely identifies this floor/path. The ID should only contain alphanumeric/underscore/dot characters. For vanilla floors & paths, this matches the spritesheet index in the <samp>TerrainFeatures/Flooring</samp> spritesheet; for custom floors & paths, this should be prefixed with your mod ID like <samp>Example.ModId_FloorName</samp>.
| When applied to a gem or mineral item, prevents players from placing it in a [[crystalarium]].
|-
|-
| <samp>ItemId</samp>
| <samp>keg_juice</samp><br /><samp>keg_wine</samp>
| The unqualified [[#Custom items|item ID]] for the corresponding object-type item.
| Allows processing the item in a [[keg]] to produce a juice or wine variant.
|-
|-
| <samp>Texture</samp>
| <samp>preserves_jelly</samp><br /><samp>preserves_pickle</samp>
| Allows processing the item in a [[Preserves Jar|preserves jar]] to produce a jelly or pickled variant.
|-
|-
| <samp>Corner</samp>
| <samp>seedmaker_banned</samp>
| The top-left pixel position for the sprite within the <samp>Texture</samp> spritesheet, specified as a model with <samp>X</samp> and <samp>Y</samp> fields.
| When applied to a seed item, prevents players from placing it in a [[Seed Maker|seed maker]].
|-
|-
| <samp>PlacementSound</samp>
| <samp>tapper_item</samp>
| The [[#Custom audio|audio cue ID]] played when the item is applied/placed (e.g. <samp>axchop</samp> used by [[Wood Floor]]).
| Marks the item as a [[tapper]] or [[Heavy Tapper|heavy tapper]].
|-
|-
| <samp>FootstepSound</samp>
| <samp>tapper_multiplier_{{t|multiplier}}</samp>
| The [[#Custom audio|audio cue ID]] played when the player steps on the tile (e.g. <samp>woodyStep</samp> used by [[Wood Floor]]).
| The multiplier applied to the tapper production speed. For example, <samp>2</samp> will make items take half their base time (''i.e.'' each item will finish in <sup>base time</sup>/<sub>speed multiplier</sub>). Defaults to 1 if omitted.
|}
And informational tags which have no effect on the game logic:
{| class="wikitable"
{| class="wikitable"
|-
|-
! value
! context tag
! usage
! effect
|-
|-
| <samp>Default</samp>
| <samp>fish_legendary</samp><br /><samp>fish_legendary_family</samp>
| For normal floors, intended to cover large square areas. This uses some logic to draw inner corners.
| Marks the fish as a [[Fish#Legendary Fish|legendary fish]] or [[Quests#Extended Family|legendary fish family]]. These are purely informational; the legendary fish behavior is determined by data fields like <samp>CatchLimit</samp> or <samp>IsBossFish</samp> in [[#Custom locations|<samp>Data/Locations</samp>]].
|-
|-
| <samp>Path</samp>
| <samp>geode</samp>
| For floors intended to be drawn as narrow paths. These are drawn without any consideration for inner corners.
| ''(Added automatically)'' Marks the item as a [[Minerals#Geodes|geode]] item, which can be broken open at [[Blacksmith|Clint's blacksmith shop]] or using a [[Geode Crusher|geode crusher]]. This is added automatically if the geode fields are present in [[#Custom objects|<samp>Data/Objects</samp>]].
|-
|-
| <samp>CornerDecorated</samp>
| <samp>id_{{t|item id}}</samp>
| For floors that have a decorative corner. Use <samp>CornerSize</samp> to change the size of this corner.
| ''(Added automatically)'' The [[#Custom items|qualified item ID]], like <samp>id_(o)128</samp>. This can be used to match or exclude an item by ID using context tags. Any spaces in the ID are replaced with underscores, and single quotes are removed.
|-
|-
| <samp>Random</samp>
| <samp>is_machine</samp>
| For floors that don't connect. When placed, one of the tiles is randomly selected.
| ''(Added automatically)'' Indicates the item has [[#Custom machines|machine logic]]. This is added automatically based on <samp>Data/Machines</samp>.
|-
|-
| <samp>CornerSize</samp>
| <samp>machine_input</samp>
| ''(Optional)'' The pixel size of the decorative border when the <samp>ConnectType</samp> field is set to <samp>CornerDecorated</samp> or <samp>Default</samp>.
| ''(Added automatically)'' Whether the item is a machine which accepts items from the player. This is added automatically based on the machine's fields in <samp>Data/Machines</samp>:
* if <samp>HasInput</samp> is true;
* ''or'' if any output rules have an <samp>ItemPlacedInMachine</samp> trigger.
|-
|-
| <samp>FarmSpeedBuff</samp>
| <samp>machine_output</samp>
| ''(Optional)'' The speed boost applied to the player, on the [[farm]] only, when they're walking on paths of this type. Negative values are ignored. Default 0.1.
| ''(Added automatically)'' Whether the item is a machine which produces items for the player to collect. This is added automatically based on the machine's fields in <samp>Data/Machines</samp>:
* if <samp>HasOutput</samp> is true;
* ''or'' if it has any output rules.
|}
|}
===Custom machines===
====ItemContextTagManager class====
For C# mods, 1.6 adds a new <samp>ItemContextTagManager</samp> class which simplifies working with [[Modding:Items#Context tags|item context tags]] and reduces repeated code.
This consists of a string → model lookup, where...
This provides a few utility methods:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! method
! effect
! effect
|-
|-
| <samp>OutputRules</samp>
| <code>GetBaseContextTags(id)</code>
| Get the base context tags for an item based on its raw data in <samp>Data/Objects</samp> or <samp>Data/BigCraftables</samp>. This doesn't include dynamic tags added that are based on instance info (like quality), which you can get using <code>item.GetContextTags()</code>.
|-
|-
| <code>DoesTagQueryMatch(query, tags)</code>
! effect
| Get whether a context tag query matches the given tags. For example, <code>ItemContextTagManager.DoesTagQueryMatch("bone_item, !fossil_item", item.GetContextTags())</code> returns true if the item is a bone item but not a fossil (like the [[Bone Flute]]).
|-
|-
| <samp>Id</samp>
| <code>DoAllTagsMatch(requiredTags, actualTags)</code><br /><code>DoAnyTagsMatch(requiredTags, actualTags)</code>
| A key which uniquely identifies this rule for the current machine (it doesn't need to be unique between machines). The ID should only contain alphanumeric/underscore/dot characters. For custom rules, this should be prefixed with your mod ID like <samp>Example.ModId_RuleId</samp>.
| Get whether every (<samp>DoAllTagsMatch</samp>) or at least one (<samp>DoAnyTagsMatch</samp) required tag matches the actual item tags. This supports negated required tags like <samp>"!fossil_item"</samp> too.
|-
|-
| <samp>Triggers</samp>
| <code>DoesTagMatch(requiredTag, actualTags)</code>
| When to apply this output rule. This can list any number of triggers; the output will apply if any of them match.
| Get whether a single tag matches the actual item tags. This supports negated required tags like <samp>"!fossil_item"</samp> too.
This consists of a list of models with these fields:
|-
|-
| <code>SanitizeContextTag(tag)</code>
| ''(Specialized)'' Replace characters that may appear in item names so they're valid in context tags. For example, <code>SanitizeContextTag("Sam's Boombox")</code> returns <samp>sams_boombox</samp>.
| <samp>Trigger</samp>
| ''(Optional)'' The qualified or unqualified item ID for the item to match, if the trigger is <samp>ItemPlacedInMachine</samp> or <samp>OutputCollected</samp>. Defaults to allowing any item ID.
|}
|}
====Other context tag changes====
* Context tags are now case-insensitive.
===Inventory class===
For C# mods, 1.6 adds a new <samp>Inventory</samp> class to manage a list of items. This is used for the <samp>Farmer.items</samp> and <samp>Chest.items</samp> fields. It implements <samp>IList<Item></samp>, so most existing code should still work fine.
This has three main benefits:
<ul>
<ul>
<li>If set to an [[#Item queries|item query]] which returns multiple items, one of them will be selected at random.</li>
<li>It has methods to simplify many common operations. For example:
{| class="wikitable"
{| class="wikitable"
|-
|-
! token
! method
! replaced with
! effect
|-
|-
| <samp>DROP_IN_ID</samp>
| <code>HasAny()</code>
| The qualified item ID for the item placed in the machine.
| Get whether the inventory contains any items (ignoring empty slots).
|-
|-
| <samp>DROP_IN_PRESERVE</samp>
| <code>CountItemStacks()</code>
| If the item placed into the machine is a flavored item like Apple Juice or Tuna Roe, the ''unqualified'' item ID for the flavor item (e.g. the apple in Apple Wine). Otherwise <samp>0</samp>.
| Get the number of item stacks in the inventory (ignoring empty slots).
|-
|-
| <samp>NEARBY_FLOWER_ID</samp>
| <code>ContainsId(id)</code>
| Get whether the inventory contains any item with the given qualified or unqualified item ID.
|}
|-
|-
| <samp>PreserveType</samp>
| <code>ContainsId(id, minCount)</code>
| ''(Optional)'' The produced item's preserved item type, if applicable. This sets the equivalent flag on the output item. The valid values are <samp>Jelly</samp>, <samp>Juice</samp>, <samp>Pickle</samp>, <samp>Roe</samp> or <samp>AgedRoe</samp>, and <samp>Wine</samp>. Defaults to none.
| Get whether the inventory contains items with the given qualified or unqualified item ID, and their combined stack size is at least <samp>minCount</samp>.
|-
|-
| <samp>PreserveId</samp>
| <code>CountId(id)</code>
| ''(Optional)'' The produced item's preserved unqualified item ID, if applicable. For example, [[Wine|blueberry wine]] has its preserved item ID set to the [[blueberry]] ID. This can be set to <samp>DROP_IN</samp> to use the input item's ID. Default none.
| Get the combined stack size of all items with the given qualified or unqualified item ID.
|-
|-
| <samp>ModifyName</samp>
| <code>GetById(id)</code>
| ''(Optional)'' The internal name (not translated display name) to set for the output item, with <samp>{0}</samp> replaced with the input item's internal name. This is used to prevent flavored items from stacking (''e.g.'' apple [[wine]] and blueberry wine). If omitted, the output item's normal internal name is used.
| Get a list of items in the inventory with the given qualified or unqualified item ID.
|-
| <code>ReduceId(id, count)</code>
| Remove the given number of items matching the given qualified or unqualified item ID. This reduces the stack size for matching items until a total of <samp>count</samp> have been removed, and clears any slots which reach a stack size of zero.
|}</li>
<li>Many common operations have been unified, so previously player-only methods can now be used with chests too.</li>
<li>It has an internal index by item ID, so operations like <code>items.ContainsId("(O)128")</code> are much more efficient since they no longer iterate the list.</li>
</ul>
This replaces some previous methods:
{| class="wikitable"
|-
|-
! game class
! old code
! migration
|-
|-
| <samp>IncrementMachineParentSheetIndex</samp>
|rowspan="6"| <samp>Farmer</samp>
| ''(Optional)'' Whether to increment the machine's spritesheet index by one while it's processing this output. This stacks with the <samp>ShowNextIndexWhenLoaded</samp> field (''i.e.'' setting both to true will increment the index by two). Default false.
| <code>getItemCount(id)</code><br /><code>GetTallyOfObject(id)</code><br /><code>GetTallyOfObject(id, isBigCraftable)</code><br /><code>hasItemInInventory(id, count)</code><br /><code>hasItemInList(list, id, count)</code>
|  
* To check an item ID, use <code>items.CountId(id)</code> or <code>Items.ContainsId(id, count)</code>.
* To check Golden Walnuts or Qi Gems, use the <samp>Game1.netWorldState.Value.GoldenWalnuts</samp> and <samp>Farmer.QiGems</samp> fields.
* To check category matches or <samp>-777</samp> (seasonal wild seeds), the <samp>getItemCount</samp> and <samp>getItemCountInList</samp> still exist.
|-
|-
| <samp>OutputMethod</samp>
| <code>hasItemInInventoryNamed(name)</code><br /><code>hasItemWithNameThatContains(name)</code>
| In most cases, you should match items by ID instead (see the previous row).
If you really need to match items by name, you can replace it like this:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
/// <summary>Get the output item to produce.</summary>
// exact name
bool hasMatch = Game1.player.Items.Any(item => item?.Name == name);
// name contains
bool hasMatch = Game1.player.Items.Any(item => item?.Name?.Contains(name) is true);
/// <param name="probe">Whether the machine is only checking whether the input is valid. If so, the input/machine shouldn't be changed and no animations/sounds should play.</param>
</syntaxhighlight>
</syntaxhighlight>
|-
|-
| <samp>UseFirstValidOutput</samp>
| <code>areAllItemsNull()</code>
| ''(Optional)'' If multiple <samp>OutputItem</samp> entries match, whether to use the first match instead of choosing one randomly. Default false.
| Use <code>!items.HasAny()</code>.
|-
| <code>numberOfItemsInInventory()</code>
| Use <code>items.CountItemStacks()</code> to count all items, or <code>Items.Count(p => p is Object)</code> to match this method's actual behavior.
|-
|-
| <samp>MinutesUntilReady</samp><br /><samp>DaysUntilReady</samp>
| <code>consumeObject(id, count)</code>
| Use <code>items.ReduceId(id, count)</code>.
|-
|-
| <samp>InvalidCountMessage</samp>
| <code>removeItemsFromInventory(id, count)</code>
| ''(Optional)'' If set, overrides the machine's main <samp>InvalidCountMessage</samp> field.
|  
* To remove an item by ID, use <code>items.ReduceId(id, count)</code>.
* To deduct Golden Walnuts or Qi Gems, change the <samp>Game1.netWorldState.Value.GoldenWalnuts</samp> and <samp>Farmer.QiGems</samp> fields.
|-
|-
| <samp>RecalculateOnCollect</samp>
|rowspan="2"| <samp>Object</samp>
| ''(Optional)'' Whether to regenerate the output right before the player collects it, similar to [[Bee House|bee houses]]. If the new item is null, the original output is returned instead.
| <code>ConsumeInventoryItem(player, id, count)</code>
| This was somewhat specialized and shouldn't be called by mod code, but the equivalent would be <code>(Object.autoLoadChest ?? player.items).ReduceId(id, count)</code>. See also notes for <samp>Farmer.removeItemsFromInventory</samp>.
|-
| <code>GetTallyOfObject(player, id)</code>
| This was somewhat specialized and shouldn't be called by mod code, but the equivalent would be <code>(Object.autoLoadChest ?? player.items).CountId(id)</code>. See also notes for <samp>Farmer.getTallyOfObject</samp>.
|}
|}
It implements a new <samp>IInventory</samp> interface, which lets mods pass their own implementations to code which works on inventories.
===Furniture changes===
{{/doc status|[[Modding:Items#Furniture]]|done=true}}
<ul>
<li>[[Modding:Items#Furniture|<samp>Data/furniture</samp>]] no longer has language variants. Translations were moved into <samp>Strings/Furniture</samp>.</li>
<li>
There are a few changes in [[Modding:Items#Furniture|<samp>Data/furniture</samp>]]:
<ul>
<li>Field index 6 is now placement restrictions and field index 7 is now display name. The display name field is no longer omitted in English.</li>
<li>Field index 7 (display name) now allows [[Modding:Tokenizable strings|tokenizable strings]].</li>
<li>Added new fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! effect
|-
|-
| <samp>ItemId</samp>
| 8
| The [[#Custom items|qualified or unqualified item ID]] for the required item.
| sprite index
| The sprite index within the spritesheet texture to draw.
|-
|-
| <samp>RequiredCount</samp>
| 9
| ''(Optional)'' The required stack size for the item matching <samp>ItemId</samp>. Default 1.
| texture
| ''(Optional)'' The asset name of the texture to draw. Defaults to <samp>TileSheets/furniture</samp>.
|-
|-
| <samp>InvalidCountMessage</samp>
| 10
| ''(Optional)'' If set, overrides the machine's main <samp>InvalidCountMessage</samp> field.
| off limits for random sale
| ''(Optional)'' Whether to prevent this furniture from appearing in randomly generated shop stocks and the furniture catalogue. Default false.
|-
|-
| <samp>ReadyTimeModifiers</samp>
| 11
| ''(Optional)'' [[#Quantity modifiers|Quantity modifiers]] applied to the produced item's processing time. The modifier conditions can use item-only tokens, which will check the ''input'' (not output) item.
| context tags
| ''(Optional)'' A space-delimited list of [[Modding:Items#Context tags|context tags]] which apply to this furniture. Default none.
|}</li>
</ul>
|}
</li>
</ul>
===Other item changes for C# mods===
* Placed object changes:
** Every placed object now has a <samp>Location</samp> property set to the location which contains it. This removes location parameters from many object methods.
** Setting an object's tile position through <samp>obj.TileLocation</samp> now recalculcates its collision box automatically. (Setting it through the <samp>tileLocation</samp> net field directly won't though.)
** The <samp>obj.IsScarecrow()</samp> and <samp>GetScarecrowRadius()</samp> methods now work for non-bigcraftable objects too.
* Clothing changes:
** <samp>Clothes.clothesType</samp> is now an enum field.
** Clothing is no longer gender-specific. This renames <samp>indexInTileSheetMale</samp> to <samp>indexInTileSheet</samp>, obsoletes <samp>indexInTileSheetFemale</samp>, and converts gender-variant clothing into regular items.
** Removed unused <samp>ClothesType.ACCESSORY</samp> value.
** <samp>Farmer.pants</samp> and <samp>Farmer.shirt</samp> now store the item ID instead of the sprite index.
** In <samp>Data/TailoringRecipes</samp>, added a <samp>CraftingIdFeminine</samp> field which overrides <samp>CraftingId</samp> for female characters.
* Crop changes:
** Added <samp>Game1.cropData</samp> to read crop info without constantly reloading the <samp>Data/Crops</samp> asset.
** Removed most crop fields which only mirror the data (like <samp>harvestMethod</samp> or <samp>seasonsToGrowIn</samp>). Mods can get the info through <samp>crop.GetData()</samp> instead.
** Partly de-hardcoded fertilizer logic. Almost all fertilizer logic is now centralized into a new patchable set of <samp>HoeDirt</samp> methods (see list below). The only fertilizer logic that's still embedded elsewhere is the interaction errors in <samp>Utility.tryToPlaceItem</samp>.
** HoeDirt.fertilizer.Value is now set to <samp>null</samp> when there is no fertilizer. Both qualified and unqualified IDs should be expected.
** Removed <samp>crop.InferSeedIndex()</samp>. This was used to support old crops, which are now fixed by a save migration instead.
* Tool changes:
** Fixed various logic not handling custom tool upgrade levels.
<ul>
<li>Other item logic:<ul>
<li>Simplified the constructors for many item types, particularly <samp>Object</samp>.</li>
<li>[[Honey]] items now have their <samp>preserve</samp> field set to a new <samp>Honey</samp> type (instead of null).</li>
<li>The <samp>Object.performObjectDropInAction</samp> method now applies the <samp>probe</samp> argument much more consistently. This only affects method calls with <samp>probe: true</samp>.</li>
<li>The <samp>Item.salePrice()</samp> method now has option to get the price without [[Multiplayer#Profit margins|profit margins]].</li>
<li>Added new fields & methods:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! type
! field/method
! effect
! effect
|-
|-
| <samp>PreventTimePass</samp>
| <samp>Chest</samp>
| ''(Optional)'' A list of cases when the machine should be paused, so the timer on any item being produced doesn't decrement. Possible values:
| <samp>GetItemsForPlayer()</samp>
| Shortcut for <samp>chest.GetItemsForPlayer(Game1.player.UniqueMultiplayerID)</samp>.
|-
| rowspan="2"| <samp>Crop</samp>
| <samp>GetHarvestMethod()</samp>
| Get the method used to harvest the crop (one of <samp>HarvestMethod.Grab</samp> or <samp>HarvestMethod.Scythe</samp>).
|-
|-
| <samp>IsInSeason(location)</samp>
| Whether the crop can grow in the location's current season (or true if crops ignore seasons in the location, like the [[greenhouse]]).
|-
|-
| <samp>Outside</samp><br /><samp>Inside</samp>
| rowspan="8"| <samp>HoeDirt</samp>
| Pause when placed in an outside or inside location. For example, [[Bee House|bee houses]] don't work inside.
| <samp>HasFertilizer()</samp>
| Get whether the dirt has any fertilizer applied.
|-
|-
| <samp>Spring</samp><br /><samp>Summer</samp><br /><samp>Fall</samp><br /><samp>Winter</samp>
| <samp>CanApplyFertilizer(itemId)</samp>
| Pause in the given season. For example, [[Bee House|bee houses]] don't work in winter.
| Get whether a player can apply the given fertilizer to this dirt.
|-
|-
| <samp>CheckApplyFertilizerRules(itemId)</samp>
| Get whether a player can apply the given fertilizer to this dirt, and the reason they can't if applicable.
|-
|-
| <samp>Sun</samp><br /><samp>Rain</samp>
| <samp>GetFertilizerSpeedBoost()</samp>
| Pause on days with the given weather.
| Get the crop growth speed boost from fertilizers applied to this dirt.
|-
|-
| <samp>Always</samp>
| <samp>GetFertilizerWaterRetentionChance()</samp>
| Always pause the machine. This is used in specialized cases where the timer is handled by [[#Advanced logic|advanced machine logic]].
| Get the water retention chance from fertilizers applied to this dirt, as a value between 0 (no change) and 1 (100% chance of staying watered).
|-
|-
| <samp>AllowLoadWhenFull</samp>
| <samp>GetFertilizerQualityBoostLevel()</samp>
| ''(Optional)'' Whether the player can drop a new item into the machine before it's done processing the last one (like the [[crystalarium]]). The previous item will be lost. Default false.
| Get the quality boost level from fertilizers applied to this dirt, which influences the chance of producing a higher-quality crop.
|-
|-
| <samp>ClearContentsOvernightCondition</samp>
| <samp>GetFertilizerSourceRect()</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether the machine should be emptied overnight, so any current output will be lost. Defaults to always false.
| Get the pixel area within the dirt spritesheet to draw for any fertilizer applied to this dirt.
(This method existed before, but no longer requires the fertilizer ID argument.)
|-
|-
| <samp>isWatered()</samp>
| Get whether the dirt is currently watered.
|-
|-
| <samp>LoadEffects</samp><br /><samp>WorkingEffects</samp>
|rowspan="5"| <samp>Item</samp>
| <samp>IsRecipe</samp><br /><samp>Quality</samp><br /><samp>Stack</samp></samp><br /><samp>sellToStorePrice(…)</samp>
| Equivalent to the previous <samp>Object</samp> fields/methods, to simplify common code and avoid needing to special-case <samp>Object</samp> items.
|-
|-
| <samp>appliesProfitMargins()</samp>
| Get whether this item should apply [[Multiplayer#Profit margins|profit margins]] to shop prices.
|-
|-
| <samp>RequiredItemId</samp>
| <samp>CanBeLostOnDeath()</samp>
| ''(Optional)'' If set, only apply this effect if the main input item has this qualified or unqualified item ID.
| Get whether this item can be lost when the player dies, so it can be recovered from the [[Adventurer's Guild#Item Recovery Service|item recovery service]].
|-
|-
| <samp>RequiredTags</samp>
| <samp>HasTypeId(id)</samp><br /><samp>HasTypeObject()</samp><br /><samp>HasTypeBigCraftable()</samp>
| ''(Optional)'' If set, only apply this effect if the main input item has ''all'' of these [[Modding:Context tags|context tags]]. You can negate a tag with <samp>!</samp> (like <code>"RequiredTags": [ "bone_item", "!fossil_item" ]</code> for bone items that aren't fossils).
| Get whether the item has the given [[#Custom items|type definition ID]]. These are null-safe and double as a null check:
<syntaxhighlight lang="c#">
if (item.HasTypeId(ItemRegistry.type_object))
{
// item is non-null and has type (O)
}
</syntaxhighlight>
<samp>HasTypeObject()</samp> and <samp>HasTypeBigCraftable()</samp> are shortcuts for passing <samp>ItemRegistry.type_object</samp> and <samp>ItemRegistry.type_bigCraftable</samp> respectively.
|-
|-
| <samp>Sound</samp>
| <samp>TryGetTempData</samp><br /><samp>SetTempData</samp>
| ''(Optional)'' An [[#Custom audio|audio cue ID]] to play. Defaults to no sound.
| Get or set temporary item info that's not synchronized in multiplayer or written to the save file.
For example, the game uses this to pass spawn options to the fishing minigame:
<syntaxhighlight lang="c#">
if (spawn.IsBossFish)
fish.SetTempData(nameof(spawn.IsBossFish), true);
...
fish.TryGetTempData(nameof(SpawnFishData.IsBossFish), out bool bossFish);
</syntaxhighlight>
|-
|-
| <samp>DelayedSounds</samp>
| <samp>FishingRod</samp>
| ''(Optional)'' The audio to play after a short delay. This consists of a list of models with these fields:
| <samp>CanUseBait()</samp><br /><samp>CanUseTackle()</samp><br /><samp>GetBait()</samp><br /><samp>GetTackle()</samp><br /><samp>HasMagicBait()</samp><br /><samp>HasCuriosityLure()</samp>
| Simplifies working with the fishing rod's [[bait]] and [[tackle]].
|-
|-
|rowspan="2"| <samp>Furniture</samp>
| <samp>SetPlacement</samp><br /><samp>SetHeldObject</samp>
| Set the furniture's position and rotation (<samp>SetPlacement</samp>) or held object (<samp>SetHeldObject</samp>). The latter will initialize the held object's tile position to match the furniture instance.
These are used by the game to initialize furniture in one go. For example:
<syntaxhighlight lang="c#">
// oak table holding decorative bowl
Furniture table = ItemRegistry
.Create<Furniture>("(F)1120")
.SetPlacement(5, 4, 0)
.SetHeldObject(ItemRegistry.Create<Furniture>("(F)1364"));
</syntaxhighlight>
|-
|-
| <samp>Sound</samp>
| <samp>IsTable()</samp>
| The [[#Custom audio|audio cue ID]] to play.
| Get whether this furniture is a table.
|-
|-
| <samp>Delay</samp>
|rowspan="2"| <samp>FruitTree</samp>
| The number of milliseconds until the sound should play.
| <samp>GetQuality()</samp>
| Get the quality of fruit currently being produced by the fruit tree.
|-
|-
| <samp>ShakeDuration</samp>
| <samp>TryAddFruit()</samp>
| ''(Optional)'' A duration in milliseconds during which the machine sprite should shake. Default none.
| Add a fruit item to the tree based on [[#Custom fruit trees|its data]].
|-
|-
| <samp>Frames</samp>
| <samp>IndoorPot</samp>
| ''(Optional)'' The animation to apply to the machine sprite, specified as a list of offsets relative to the base sprite index. Default none.
| <samp>Water()</samp>
| Simplifies watering dirt in the [[Garden Pot|garden pot]].
|-
|-
| <samp>Interval</samp>
| <samp>Object</samp>
| ''(Optional)'' The number of milliseconds for which each frame in <samp>Frames</samp> is kept on-screen. Default 100.
| <samp>GetBoundingBox()</samp><br /><samp>GetBoundingBoxAt(x, y)</samp>
| Get the pixel collision area for the item placed in the world. These replace the former <samp>getBoundingBox(position)</samp> method.
|-
|-
| <samp>TemporarySprites</samp>
| <samp>Tool</samp>
| ''(Optional)'' The temporary animated sprites to show. This consists of a list of models with these fields:
| <samp>isScythe()</samp>
| Equivalent to the previous <samp>MeleeWeapon</samp> method, to simplify common code and avoid needing to special-case <samp>MeleeWeapon</samp> items.
| The pixel area for the first animated frame within the <samp>Texture</samp>, specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields.
|-
|-
| <samp>PositionOffset</samp>
|rowspan="3"| <samp>Tree</samp>
| ''(Optional)'' A pixel offset applied to the sprite, relative to the top-left corner of the machine's collision box, specified as an object with <samp>X</samp> and <samp>Y</samp> fields. Defaults to (0, 0).
| <samp>CheckForNewTexture()</samp>
| Reset the tree's texture if it would change based on [[#Custom wild trees|its data]].
|-
|-
| <samp>Color</samp>
| <samp>GetMaxSizeHere</samp>
| ''(Optional)'' A tint color to apply to the sprite. This can be any of the [https://docs.microsoft.com/en-us/previous-versions/windows/xna/ff433752(v=xnagamestudio.42) <samp>Color</samp> field names], like <samp>ForestGreen</samp>. Default <samp>White</samp> (no tint).
| Get the maximum size the tree can grow in its current position (e.g. accounting for nearby trees blocking growth).
|-
|-
| <samp>AlphaFade</samp><br /><samp>Loops</samp><br /><samp>Rotation</samp><br /><samp>RotationChange</samp><br /><samp>ScaleChange</samp><br /><samp>SortOffset</samp>
| <samp>IsGrowthBlockedByNearbyTree</samp>
| Get whether growth is blocked because it's too close to another fully-grown tree.
| ''(Optional)'' See equivalent fields in the [[#Other changes|<samp>temporaryAnimatedSprite</samp> event command]]. Default 1.
|}
|}
|}
</li>
|-
<li>Modularized <samp>Object.CheckForAction</samp> to simplify mod patches.</li>
| <samp>WorkingEffectChance</samp>
<li>Reworked <samp>Item.getOne()</samp> implementation to avoid common pitfalls. (This only affects mods with custom item classes, or which patch <samp>Item.getOne</samp> or <samp>Item._GetOneFrom</samp>.)</li>
| ''(Optional)'' The percentage chance to apply <samp>WorkingEffects</samp> each time the day starts or the in-game clock changes, as a value between 0 (never) and 1 (always). Default 0.33.
<li>Fixed fruit trees forgetting the growth stage set in their constructor when they're updated overnight.</li>
</ul>
| <samp>LightWhileWorking</samp>
===Other item changes===
* Added per-object display names (''e.g.'' for custom flavored items). See the <samp>ObjectDisplayName</samp> [[Modding:Item queries#Item spawn fields|item spawn field]], or <samp>object.displayNameFormat</samp> in C#.
* [[Ginger Island#Gem Birds|Item pedestals]] are now normal item, so you can spawn them using a mod like CJB Item Spawner to display items.
* Added optional <samp>Condition</samp> [[Modding:Game state queries|game state query]] field to <samp>Data/SpecialOrders</samp>.
* Item data changes:
** The display name field now exists in English too for <samp>Data/Boots</samp>, <samp>Data/Bundles</samp>, <samp>Data/CookingRecipes</samp>, <samp>Data/CraftingRecipes</samp>, <samp>Data/Furniture</samp>, <samp>Data/Hats</samp>, and <samp>Data/Weapons</samp>.
** The randomly spawned [[The Farm#Stone|stones]], [[The Farm#Wood|twigs]], and [[weeds]] have been formalized into ''litter''. They all now have object type <samp>Litter</samp>, [[Modding:Items#Categories|category]] -999 (<samp>StardewValley.Object.litterCategory</samp>), a relevant display name/description (like ''Gold Stone'' & ''Break apart to obtain gold ore'' instead of ''Stone'' & ''...''), a price of 0 (not sellable), and edibility of -300 (inedible). This also adds all mine ore nodes to <samp>Data/Objects</samp>, so the game no longer creates invalid items to show their sprite. (Doing so in 1.6 will now show an Error Item sprite instead.)
** [[Honey]] items now have the <samp>honey_item</samp> context tag.
** Shirts no longer have a dynamic numeric ID range; every valid shirt is now listed in [[#Custom shirts|<samp>Data/Shirts</samp>]].
** You can now apply a custom buff ID when the item is eaten, via <samp>Data/Objects</samp>'s <samp>Buff</samp> field.
** The type field in <samp>Data/Objects</samp> is no longer checked using substring matching (e.g. the game now uses <code>data.Type == "Fish"</code> instead of <code>typeAndCategory.Contains("Fish")</code>), which may impact mods which depended on that undocumented behavior.
* Crop changes:
** Paddy crops now recheck for nearby water each day, so they'll update if you add/remove a building with water or change the map layout.
** In <samp>Data/Crops</samp>, each harvest option is now self-contained. For example, you can set <samp>HarvestMinStack</samp> without <samp>ExtraHarvestChance</samp>.
* Fish changes:
** <samp>Data/Fish</samp> is no longer translated, so there's only one <samp>Data/Fish.xnb</samp> field. Fish display names are now taken from <samp>Data/Objects</samp>.
** Added a new field (index 13) in <samp>Data/Fish</samp>, which sets whether the fish can be selected for the first-catch tutorial.
* Recipe changes in <samp>Data/CookingRecipes</samp> and <samp>Data/CraftingRecipes</samp>:
** These assets no longer have language variants.
** The display name now supports [[Modding:Tokenizable strings|tokenizable strings]].
** The display name can now be left blank to get it from the first item in the output list.
* Other item logic:
** Missing recipes that should already be unlocked are now added to the player automatically on save load.
** <samp>Data/Bundles</samp> is now loaded later, so content packs can edit it reliably.</samp>
** Chests with <samp>fridge: true</samp> are now treated as mini-fridges for the cooking menu.
** Gift boxes can now contain multiple items.
** Fixed furniture drawn over sitting players if it has no front texture.
** Fixed tool being upgraded by Clint not affected by recursive item search logic.
** Fixed <samp>tool.getOne()</samp> not copying the tool name.
** Fixed cooking menu constantly creating hovered item if the item/recipe names don't match.
==What's new for locations & weather==
===Custom locations===
{{/doc status|[[Modding:Location data]]|done=true}}
You can now add/edit locations by editing the revamped <samp>Data/Locations</samp> asset. This makes nearly everything in the location configurable — display name, default warp arrival tile, how the location is created, artifact spots / fish / forage / weeds, music, etc.
See [[Modding:Location data]] for docs on the new data format.
{| class="wikitable"
===Custom location contexts===
{{/doc status|[[Modding:Location data]] or a new doc page|done=false}}
====Vanilla contexts====
* The game previously had two hardcoded location context enums: <samp>Default</samp> (for the valley) and <samp>Island</samp> (for [[Ginger Island]]). These have been replaced with data models which define the location context settings, loaded from the <samp>Data/LocationContexts</samp> asset.
* [[The Desert|The desert]] is now part of a new <samp>Desert</samp> context (instead of <samp>Default</samp>). Some of the previously hardcoded desert logic (like always sunny weather) is now just part of the context data in <samp>Data/LocationContexts</samp>.
====Format====
Custom contexts can be created by editing the new <samp>Data/LocationContexts</samp> asset, and setting the context name in the location's <samp>LocationContext</samp> [[Modding:Maps|map property]].
The data asset consists of a string → model lookup, where the key matches the <samp>Name</samp> field and the value is a model with these fields:
====Advanced logic====
<dl style="margin-left: 2em;">
<dt>Required fields:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>InteractMethod</samp>
| <samp>Name</samp>
| ''(Optional)'' A C# method invoked when the player interacts with the machine when it doesn't have output ready to harvest.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for the location context.
|}
</dd>
<dt>Player actions:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>StatName</samp>
| <samp>AllowRainTotem</samp>
| The name of the stat counter field on <samp>Game1.stats</samp>.
| ''(Optional)'' Whether a [[Rain Totem|rain totem]] can be used to force rain in this context tomorrow. If false, using a rain totem here will show a "''this item can't be used here''" message instead.
|-
|-
| <samp>RequiredItemId</samp>
| <samp>RainTotemAffectsContext</samp>
| ''(Optional)'' If set, only increment the stat if the main input item has this qualified or unqualified item ID.
| ''(Optional)'' If set, using a rain totem here will change the weather in the given context ID. For example, rain totems in the desert change weather in the valley.
|-
|-
| <samp>RequiredTags</samp>
| <samp>MaxPassOutCost</samp>
| ''(Optional)'' If set, only increment the stat if the main input item has ''all'' of these [[Modding:Context tags|context tags]]. You can negate a tag with <samp>!</samp> (like <code>"RequiredTags": [ "bone_item", "!fossil_item" ]</code> for bone items that aren't fossils).
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context, the maximum amount of [[gold]] lost. If omitted or set to <samp>-1</samp>, uses the same value as the <samp>Default</samp> context ({{price|1000}} by default).
|-
| <samp>PassOutMail</samp>
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context, the possible [[Modding:Mail data|letter IDs]] to add to their mailbox (if they haven't received it before). If multiple letters are valid, one will be chosen randomly (unless one specifies <samp>SkipRandomSelection</samp>).
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>lastOutputRuleId</samp>
| <samp>Id</samp>
| If this is a machine, the output rule ID for the rule being processed by the machine (if any).
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry in the list.
|-
|-
| <samp>lastInputItem</samp>
| <samp>Mail</samp>
| If this is a machine, the item that was dropped into the machine to start the current output (if any).
| The [[Modding:Mail data|letter ID]] to add.
The game will look for an existing letter ID in <samp>Data/mail</samp> in this order (where {{t|billed}} is <samp>Billed</samp> if they lost [[gold]] or <samp>NotBilled</samp> otherwise, and {{t|gender}} is <samp>Female</samp> or <samp>Male</samp>):
{| class="wikitable"
* <samp>{{t|letter id}}_{{t|billed}}_{{t|gender}}</samp>
* <samp>{{t|letter id}}_{{t|billed}}</samp>
* <samp>{{t|letter id}}</samp>
If no match is found in <samp>Data/mail</samp>, the game will send <samp>passedOut2</samp> instead.
If the mail ID starts with <samp>passedOut</samp>, <samp>{0}</samp> in the letter text will be replaced with the gold amount lost, and it won't appear in the [[collections]] page.
|-
|-
| <samp>MaxPassOutCost</samp>
| ''(Optional)'' The maximum amount of [[gold]] lost. This is applied after the context's <samp>MaxPassOutCost</samp> (i.e. the context's value is used to calculate the random amount, then this field caps the result). Defaults to unlimited.
|-
|-
| <samp>IsMachineWorking()</samp>
| <samp>Condition</samp>
| Get whether the machine is currently processing an item.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry is active. Defaults to always true.
|-
|-
| <samp>ShouldTimePassForMachine(location)</samp>
| <samp>SkipRandomSelection</samp>
| Get whether the machine should be updated in the given location. For example, this will return false for [[Solar Panel|solar panels]] placed indoors, or outdoors on a cloudy day.
| ''(Optional)'' If true, send this mail if the <samp>Condition</samp> matches instead of choosing a random valid mail. Default false.
|}
|-
|-
| <samp>GetMachineData()</samp>
| <samp>PassOutLocations</samp>
| Get the underlying machine data from <samp>Data/Machines</samp>.
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context ''and'' they started the day in a different location context, the locations where they'll wake up. (If the player started the day in the same context, they'll wake up in the last bed they slept in instead.)
|-
If the selected location doesn't contain a bed and doesn't have the [[#New map properties|<samp>AllowWakeUpWithoutBed</samp> map property]], the player will wake up in the farmhouse instead.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>SpecialAttack</samp>
| <samp>Id</samp>
| ''(Optional)'' The secondary attack type. This can be one of [[Weapons#Club|<samp>Club</samp>]], [[Weapons#Dagger|<samp>Dagger</samp>]], or [[Weapons#Sword|<samp>Sword</samp>]]. Any other value is ignored.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry in the list.
|-
|-
| <samp>Projectiles</samp>
| <samp>Location</samp>
| ''(Optional)'' The projectiles fired when the weapon is used, which continue along their path until they hit a monster and cause damage. These always cause 10 damage and use a generic glowing-yellow-ball sprite. This consists of a list of models with these fields (one projectile will fire for each entry in the list):
| The internal location name.
|-
|-
| <samp>Position</samp>
| The ''default'' tile position within the location, specified as an object with <samp>X</samp> and <samp>Y</samp> fields. If the location has any bed furniture, they'll be placed in the first bed found instead.
|-
|-
| <samp>MinAngleOffset</samp><br /><samp>MaxAngleOffset</samp>
| <samp>Condition</samp>
| ''(Optional)'' A random offset applied to the direction of the project each time it's fired. Both fields default to 0, in which case it's always shot at the 90° angle matching the player's facing direction.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry is active. Defaults to always applied.
|}
|}
If no locations are specified or none match, the player will wake up in their bed at home.
|}
|-
| <samp>ReviveLocations</samp>
| ''(Optional)'' If the player just got knocked out in combat, the location names where they'll wake up.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>Id</samp>
| A key which uniquely identifies the reward group (i.e. a set of items and the reward once they're all donated). The ID should only contain alphanumeric/underscore/dot characters. For custom entries, this should be prefixed with your mod ID like <samp>Example.ModId_GroupName</samp>.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry in the list.
|-
|-
| <samp>TargetContextTags</samp>
| <samp>Location</samp>
| The items that must be donated to complete this reward group. The player must fulfill every entry in the list to unlock the reward. This consists of a list of models with these fields:
| The internal location name.
|-
|-
| <samp>Position</samp>
| The tile position within the location, specified as an object with <samp>X</samp> and <samp>Y</samp> fields.
|-
|-
| <samp>Tag</samp>
| <samp>Condition</samp>
| The [[Modding:Context tags|context tag]] for the items to require.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry is active. Defaults to always applied.
|}
|}
If the selected location has a standard [[Modding:Event data|event]] with the exact key <samp>PlayerKilled</samp> (with no <samp>/</samp> or preconditions in the key), that event will play when the player wakes up and the game will apply the lost items or [[gold]] logic. The game won't track this event, so it'll repeat each time the player is revived. If there's no such event, the player will wake up without an event, and no items or gold will be lost.
If no locations are specified or none match, the player will wake up at [[Harvey's Clinic|Harvey's clinic]].
|-
|}
</dd>
<dt>Season:</dt>
<dd>
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>RewardItemId</samp>
| <samp>SeasonOverride</samp>
| ''(Optional)'' The [[#Custom items|qualified item ID]] for the item given to the player when they donate all required items for this group. There's no reward item if omitted.
| ''(Optional)'' The season which is always active for locations within this context (one of <samp>spring</samp>, <samp>summer</samp>, <samp>fall</samp>, or <samp>winter</samp>). For example, setting <samp>summer</samp> will make it always [[summer]] there regardless of the calendar season. If not set, the calendar season applies.
|}
|}
</dd>
<dt>Weather:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! field
! effect
! effect
|-
|-
| 0
| <samp>WeatherConditions</samp>
| ''(Optional)'' The weather logic to apply for locations in this context (ignored if <samp>CopyWeatherFromLocation</samp> is set). Defaults to always sunny. If multiple are specified, the first matching weather is applied.
| A key which uniquely identifies this tree. For vanilla trees, this matches the spritesheet index. For custom trees, the ID should only contain alphanumeric/underscore/dot characters.
This consists of a list of models with these fields:
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| 2
| <samp>Id</samp>
| fruit
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry in the list.
| The unqualified object ID for the fruit it produces.
|-
|-
| 3
| <samp>Weather</samp>
| sapling price
| The [[#Custom weather|weather ID]] to set.
| '''Unused.'''
|-
|-
| 4
| <samp>Condition</samp>
| sprite index
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether to apply the weather. Defaults to always applied.
|}
|-
|-
| 5
| <samp>CopyWeatherFromLocation</samp>
| ''(Optional)'' The <samp>Name</samp> (i.e. unique ID) of the location context from which to inherit weather.
|}
|}
If a [[#Custom passive festivals|passive festival]] is active in any location within this context, the weather is sunny for the entire context regardless of these fields.
</dd>
<dt>Music:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! field
! purpose
! effect
|-
|-
| <samp>ClassName</samp>
| <samp>DefaultMusic</samp>
| The name of the C# class to construct within the <code>StardewValley.Tools</code> namespace. The class must be a subclass of <samp>StardewValley.Tool</samp>, and have a constructor with no arguments. For example, given a value of <samp>Axe</samp>, the game will create <code>StardewValley.Tools.Axe</code> instances.
| ''(Optional)'' The [[#Custom audio|cue ID]] for the music to play when the player is in the location, unless overridden by a <samp>Music</samp> map property. Despite the name, this has a higher priority than the seasonal music fields below. Ignored if omitted.
|-
|-
| <samp>Name</samp>
| <samp>DefaultMusicCondition</samp>
| The internal name to set for the tool item.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which returns whether the <samp>DefaultMusic</samp> field should be applied (if more specific music isn't playing). Defaults to always true.
|-
|-
| <samp>DisplayName</samp><br /><samp>Description</samp>
| <samp>DefaultMusicDelayOneScreen</samp>
| A [[#Tokenizable string format|tokenizable string]] for the tool's in-game display name and description.
| ''(Optional)'' When the player warps and the music changes, whether to silence the music and play the ambience (if any) until the next warp (similar to the default valley locations). Default false.
|-
|-
| <samp>Texture</samp>
| <samp>Music</samp>
| ''(Optional)'' A list of [[#Custom audio|cue IDs]] to play before noon in this location unless it's raining, there's a <samp>Music</samp> map property, or the context has a <samp>DefaultMusic</samp> value. If multiple values are specified, the game will play one per day in sequence.
| ''(Optional)'' The tool upgrade level. Default <samp>-1</samp>, which keeps the default value set by the tool class.
| ''(Optional)'' The number of attachment slots to enable on the tool. Note that only <samp>FishingRod</samp> tools have the code to render and use attachment slots. Default <samp>-1</samp>, which keeps the default value set by the tool class.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! upgrade level
! field
! display name format
! effect
|-
|-
| 1
| <samp>Id</samp>
| Copper {{t|display name}}
| ''(Optional)'' A [[Modding:Common data field types#Unique string ID|unique string ID]] which identifies this entry within the list. Defaults to the <samp>Track</samp> value.
|-
|-
| 2
| <samp>Track</samp>
| Steel {{t|display name}}
| The [[Modding:Migrate to Stardew Valley 1.6#Custom audio|audio track ID]] to play.
|-
|-
| 3
| <samp>Condition</samp>
| Gold {{t|display name}}
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry applies. Default true.
|}
|}
|-
|-
| <samp>ModData</samp>
| <samp>DayAmbience</samp><br /><samp>NightAmbience</samp>
| ''(Optional)'' The mod data values to set when the tool is created, accessible in C# code via the <samp>tool.modData</samp> dictionary. For example:
| ''(Optional)'' The [[#Custom audio|cue ID]] for the background ambience to play when there's no music active, depending on the [[Day Cycle|time of day]]. Both default to none.
|-
|-
| <samp>SetProperties</samp>
| <samp>PlayRandomAmbientSounds</samp>
| ''(Optional)'' Set the value of arbitrary properties on the tool class. For example, this would disable the tool animation and require no stamina:
| ''(Optional)'' Whether to play random outdoor ambience sounds depending on factors like the season and time of day (e.g. birds, crickets, and mysterious groan sounds in the rain). This is unrelated to the <samp>DayAmbience</samp> and <samp>NightAmbience</samp> fields. Default true.
<syntaxhighlight lang="js">
|}
</dd>
</syntaxhighlight>
| ''(Optional)'' The requirements to buy this tool from Clint's [[Blacksmith#Upgrade Tools|blacksmith tool upgrade shop]]. If you specify multiple entries, the first one which matches will be applied.
<dt>Advanced:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! field
! purpose
! effect
|-
|-
| <samp>Price</samp>
| <samp>CustomFields</samp>
| ''(Optional)'' The gold price to buy the upgrade. Defaults to 0.
| The [[#Custom data fields|custom fields]] for this entry.
|}
</dd>
</dl>
|-
===Custom garbage cans===
{{/doc status|a new doc page|done=false}}
====Format====
<syntaxhighlight lang="js">
You can now add or edit [[Garbage Can|garbage cans]] on any map by editing the new <samp>Data/GarbageCans</samp> asset (see examples below).
</syntaxhighlight>
The asset consists of a data model with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! upgrade level
! field
! price
! effect
|-
|-
| 1
| <samp>DefaultBaseChance</samp>
| {{price|2000}}
| The probability that an item will be found when searching garbage cans, as a value between 0 (never) and 1 (always). If the probability check fails, only items that set <samp>IgnoreBaseChance</samp> can spawn. This can be overridden by the per-garbage-can <samp>BaseChance</samp> field. Default 0.2.
|-
|-
| 2
| <samp>BeforeAll</samp><br /><samp>AfterAll</samp>
| {{price|5000}}
| The items to prepend (<samp>BeforeAll</samp>) or append (<samp>AfterAll</samp>) to the <samp>GarbageCans</samp> → <samp>Items</samp> field for all garbage cans. These work exactly like the items in that field (e.g. subject to the garbage can's base chance).
|-
|-
| 3
| <samp>GarbageCans</samp>
| The data for individual garbage cans. This consists of a string → model lookup with these fields:
<syntaxhighlight lang="js">
</syntaxhighlight>
|}
{| class="wikitable"
{| class="wikitable"
! effect
! effect
|-
|-
| <samp>TreeType</samp>
| ''entry key''
| The tree ID; this should match the asset key.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this garbage can.
|-
|-
| <samp>Textures</samp>
| <samp>BaseChance</samp>
| The tree textures to show in game. This can be a list containing either a single asset name, or four asset names (for spring, summer, fall, and winter in that order).
| ''(Optional)'' If set, overrides the root <samp>DefaultBaseChance</samp> field for this garbage can. Defaults to <samp>DefaultBaseChance</samp>.
|-
|-
| <samp>SeedItemId</samp>
| <samp>Items</samp>
| ''(Optional)'' The items to try spawning when the player searches the garbage can. The first matching item in <samp>BeforeAll</samp> + <samp>Items</samp> + <samp>AfterAll</samp> will be spawned, and any further items will be ignored. Defaults to none.
This consists of a list of models with these fields:
| ''(Optional)'' The probability each day that the tree will grow to the next stage without [[Tree Fertilizer|tree fertilizer]], as a value from 0 (will never grow) to 1 (will grow every day). Defaults to 0.2 (20% chance).
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>ItemId</samp>
| ''common fields''
| The [[#Custom items|qualified item ID]].
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields supported by garbage cans.
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
|-
|-
| <samp>MinCount</samp><br /><samp>MaxCount</samp>
| <samp>IgnoreBaseChance</samp>
| ''(Optional)'' Whether this item can spawn even if the <samp>BaseChance</samp> probability check didn't pass. Default false.
|-
|-
| <samp>Chance</samp>
| <samp>IsMegaSuccess</samp>
| ''(Optional)'' The probability that the item will drop, as a value between 0 (never drops) and 1 (always drops). This has no effect on other drops (e.g. if there are ten drops with 100% chance, all ten will drop). Default 1 (100% chance).
| ''(Optional)'' Whether to treat this item as a 'mega success' if it's selected, which plays a special <samp>crit</samp> sound and bigger animation. Default false.
|-
|-
| <samp>Condition</samp>
| <samp>IsDoubleMegaSuccess</samp>
| ''(Optional)'' If set, the drop is only available if the given [[#Game state queries|game state query]] is true.
| ''(Optional)'' Whether to treat this item as an 'double mega success' if it's selected, which plays an explosion sound and dramatic animation. Default false.
|-
|-
| <samp>SpringTapItems</samp><br /><samp>SummerTapItems</samp><br /><samp>FallTapItems</samp><br /><samp>WinterTapItems</samp>
| <samp>AddToInventoryDirectly</samp>
| The items produced by [[Tapper|tapping]] the tree in each season, as a list of models with these fields. If multiple items can be produced, the first available one is selected.
| ''(Optional)'' Whether to add the item to the player's inventory directly, opening an item grab menu if they don't have room in their inventory. If false, the item will be dropped on the ground next to the garbage can instead. Default false.
|-
|-
| <samp>CreateMultipleDebris</samp>
| ''(Optional)'' Whether to split the spawned item into multiple stacks which each have a stack size of one. This has no effect if <samp>AddToInventoryDirectly</samp> is enabled. Default false.
|}
|}
If the garbage can being searched doesn't have its own entry under <samp>GarbageCans</samp>, the game will just use the <samp>BeforeAll</samp> and <samp>AfterAll</samp> fields.
|-
|-
| <samp>PossibleItems<samp>
| <samp>CustomFields</samp>
| The [[#Custom data fields|custom fields]] for this entry.
|}
====Example new garbage can====
You can add garbage cans using only [[Modding:Content Patcher|Content Patcher]] or [[Modding:Modder Guide/APIs/Content|SMAPI's content API]]. For example, this content pack adds a new garbage can entry with the ID <samp>Example.ModId_Carpenter</samp>:
{{#tag:syntaxhighlight|<nowiki>
| The [[#Custom items|qualified item ID]].
{
|-
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
| <samp>MinCount</samp><br /><samp>MaxCount</samp>
"Changes": [
{
"Action": "EditData",
| <samp>DaysUntilReady</samp>
"Target": "Data/GarbageCans",
"TargetField": [ "GarbageCans" ],
"Entries": {
"{{ModId}}_Carpenter": {
"Items": [
// 25% chance of pufferfish
{
"ID": "{{ModId}}_Pufferfish",
"Condition": "RANDOM 0.25",
"ItemId": "(O)128"
},
// else guaranteed random House Plant item
{
"ID": "{{ModId}}_RandomHousePlant",
"ItemID": "RANDOM_ITEMS (F) 1376 1390"
}
]
}
}
}
]
}</nowiki>|lang=javascript}}
Then you'd place an <code>Action: Garbage Example.ModId_Carpenter</code> [[Modding:Maps|map tile property]] to mark a tile as a garbage can using this data.
====Example change for existing garbage can====
|-
You can edit an existing garbage cans using only [[Modding:Content Patcher|Content Patcher]] or [[Modding:Modder Guide/APIs/Content|SMAPI's content API]]. For example, this content pack adds pufferfish to the Saloon garbage can, and moves it above the dish of the day.
Note that this uses <samp>TargetField</samp> to 'move into' the item list for the saloon, and then treat those items as the entry list being edited. Specifying an ID which isn't in the list will add a new entry, just like when editing a regular list asset.
|-
{{#tag:syntaxhighlight|<nowiki>
|}
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
{
"Action": "EditData",
"Target": "Data/GarbageCans",
"TargetField": [ "GarbageCans", "Saloon", "Items" ],
"Entries": {
// 25% chance of pufferfish
"{{ModId}}_Pufferfish":{
"ID": "{{ModId}}_Pufferfish",
"Condition": "RANDOM 0.25",
"ItemId": "(O)128"
}
},
"MoveEntries": [
{ "ID": "{{ModId}}_Pufferfish", "BeforeId": "Base_DishOfTheDay" }
]
}
]
}</nowiki>|lang=javascript}}
===New context tags===
====Changes for C# mods====
1.6 adds several new [[Modding:Items#Context tags|item context tags]]:
Previously garbage cans were tracked by <samp>Town.garbageChecked</samp>, an array of boolean fields. That approach doesn't work in Stardew Valley 1.6, since we're no longer limited to a specific set of garbage cans in the town map. This has been replaced by <samp>Game1.netWorldState.Value.CheckedGarbage</samp>, which is a hash set of garbage can IDs.
To migrate code:
{| class="wikitable"
{| class="wikitable"
|-
|-
! context tag
! action
! effect
! code in 1.5.6
! code in 1.6
|-
|-
| <samp>campfire_item</samp>
| check if a garbage can was searched
| <syntaxhighlight lang="js">
Town town = (Town)Game1.getLocationFromName("Town");
if (town.garbageChecked[5])
...
</syntaxhighlight>
| <syntaxhighlight lang="js">
if (Game1.netWorldState.Value.CheckedGarbage.Contains("Saloon"))
...
</syntaxhighlight>
|-
|-
| <samp>fish_legendary</samp>
| mark a garbage can searched
| Marks the fish as a [[Fish#Legendary Fish|legendary fish]]. For example: it can't be caught again, shows an alternate sprite in the fishing minigame and a 'caught legendary fish' message after catching it, can't be added to a [[Fish Pond|fish pond]], etc.
| <syntaxhighlight lang="js">
Town town = (Town)Game1.getLocationFromName("Town");
town.garbageChecked[5] = true;
</syntaxhighlight>
| <syntaxhighlight lang="js">
Game1.netWorldState.Value.CheckedGarbage.Add("Saloon");
</syntaxhighlight>
|}
To migrate former vanilla trash can IDs:
{| class="wikitable"
|-
|-
! position
! ID in 1.5.6
! ID in 1.6
|-
|-
| <samp>geode_special</samp>
| Near [[Jodi]] and [[Kent]]'s house
| <code>0</code>
| <code>JodiAndKent</code>
|-
|-
| <samp>item_type_{{t|type}}</samp>
| Near [[Emily]] and [[Haley]]'s house
| For an [[Modding:Items#Objects|object-type item]], the type value from the 'type and category' field. (Non-object items always have the exact tag <samp>item_type_</samp> with nothing after the last underscore.) This is automatic and shouldn't be set manually. The tag is checked in a few places (''e.g.'' the [[museum]] to check if an item is an artifact or mineral), but most of the game won't be affected.
| <code>1</code>
| <code>EmilyAndHaley</code>
|-
|-
| <samp>museum_donatable</samp><br /><samp>not_museum_donatable</samp>
| Near [[Lewis]]' house
| <code>2</code>
| <code>Mayor</code>
|-
|-
| <samp>not_placeable</samp><br /><samp>placeable</samp>
| Near [[Museum]]
| <code>3</code>
| <code>Museum</code>
|-
|-
| <samp>not_plantable_context_{{t|context ID}}</samp><br /><samp>not_plantable_location_{{t|location name}}</samp><br /><samp>plantable_context_{{t|context ID}}</samp><br /><samp>plantable_greenhouse</samp><br /><samp>plantable_location_{{t|location name}}</samp>
| Near [[Blacksmith|Clint's blacksmith]]
| <code>4</code>
| <code>Blacksmith</code>
|-
|-
| <samp>paddy_crop</samp>
| Near [[The Stardrop Saloon|the Saloon]]
| Marks the item as a paddy [[Crops|crop]] like [[Unmilled Rice|rice]] or [[Taro Root|taro]]. This enables paddy-related logic like needing to be planted near water.
| <code>5</code>
| <code>Saloon</code>
|-
|-
| <samp>sign_item</samp>
| Near [[Evelyn]] and [[George]]'s house
| <code>6</code>
| <code>Evelyn</code>
|-
|-
| <samp>torch_item</samp>
| Near [[JojaMart]]
| Marks the item as a [[torch]], which lets the player turn it on/off to emit light.
| <code>7</code>
| <code>JojaMart</code>
|}
===Custom map actions===
{{/doc status|[[Modding:Maps#Custom_Actions]]|done=true}}
C# mods can now handle custom <samp>Action</samp> & <samp>TouchAction</samp> [[Modding:Maps|map properties]] by calling <samp>GameLocation.RegisterTileAction</samp> & <samp>RegisterTouchAction</samp>, and passing a callback which receives the location, map property arguments, player who activated it, and tile position.
For example, let's say you want a locked gate which needs a custom key item. You can add a regular <code>TouchAction Example.ModId_UnlockGate</code> map property (e.g. by adding it directly in the map file, or using [[Modding:Content Patcher|Content Patcher]]'s <samp>EditMap</samp>, or using the [[Modding:Modder Guide/APIs/Content|content API]]). Then you can just handle the logic from your C# mod. See the updated docs for an example.
As another example, let's say you want the gate to unlock when the player presses the action key. You can add a regular <code>Action Example.ModId_UnlockGate</code> map property (e.g. by adding it directly in the map file, or using [[Modding:Content Patcher|Content Patcher]]'s <samp>EditMap</samp>, or using the [[Modding:Modder Guide/APIs/Content|content API]]). Then you can just handle the logic from your C# mod. See the updated docs for an example.
===Custom map layers===
{{/doc status|[[Modding:Maps]]|done=true}}
You can now add any number of [[Modding:Maps|map layers]] by suffixing a vanilla layer name (i.e. <samp>Back</samp>, <samp>Buildings</samp>, <samp>Front</samp>, or <samp>AlwaysFront</samp>) with an offset. For example, <samp>Back-1</samp> will be drawn before/under <samp>Back</samp>, and <samp>Back2</samp> will be drawn after/over it. You can increment the number to add more layers.
This only affects layer rendering. Tile properties must still be set on the original layers.
===Custom minecarts===
{{/doc status|a new doc page|done=false}}
You can now extend [[minecart]]s by editing the <samp>Data\Minecarts</samp> data asset.
This consists of a string → model lookup, where...
|}
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the minecart network. When you interact with a minecart, the destinations listed for its network are shown.
* The value is a model with the fields listed below.
{| class="wikitable"
{| class="wikitable"
|-
|-
! context tag
! field
! effect
! effect
|-
|-
| <samp>crystalarium_banned</samp>
| <samp>Destinations</samp>
| When applied to a gem or mineral item, prevents players from placing it in a [[crystalarium]].
| The destinations which the player can travel to from minecarts in this network. This consists of a list of model with these fields:
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>is_machine</samp>
| <samp>Id</samp>
| Indicates the item has [[#Custom machines|machine logic]]. This is added automatically based on <samp>Data/Machines</samp> and is informational only (it has no effect on the game logic).
| A [[Modding:Common data field types#Unique string ID|unique string ID]] for this destination within the network.
|-
|-
| <samp>keg_juice</samp><br /><samp>keg_wine</samp>
| <samp>DisplayName</samp>
| A [[Modding:Tokenizable strings|tokenizable string]] for the destination name shown in the minecart menu. You can use the location's display name with the <samp>LocationName</samp> token (like <code>[LocationName Desert]</code> for the [[desert]]).
|-
|-
| <samp>machine_input</samp><br /><samp>machine_output</samp>
| <samp>TargetLocation</samp>
| Whether the item is a machine which accepts items from the player (<samp>machine_input</samp>) and/or which produces items for the player to collect (<samp>machine_output</samp>). If the [[#Custom machines|machine data]] sets the <samp>ConversionMethod</samp> field, both tags are added since there's no way to know what the method does.
| The [[#Custom locations|location ID]] for the destination.
|-
|-
| <samp>preserves_jelly</samp><br /><samp>preserves_pickle</samp>
| <samp>TargetTile</samp>
| The destination tile position within the location, specified as a model with <samp>X</samp> and <samp>Y</samp> fields.
|-
|-
| <samp>seedmaker_banned</samp>
| <samp>TargetDirection</samp>
| When applied to a seed item, prevents players from placing it in a [[Seed Maker|seed maker]].
| The direction the player should face after arrival (one of <samp>down</samp>, <samp>left</samp>, <samp>right</samp>, or <samp>up</samp>).
|-
|-
| <samp>tapper_item</samp>
| <samp>Condition</samp>
| Marks the item as a [[tapper]] or [[Heavy Tapper|heavy tapper]].
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this minecart destination is available. Defaults to always available.
|-
|-
| <samp>tapper_multiplier_{{t|multiplier}}</samp>
| <samp>Price</samp>
| The multiplier applied to the tapper production speed. For example, <samp>2</samp> will make items take half their base time (''i.e.'' each item will finish in <sup>base time</sup>/<sub>speed multiplier</sub>). Defaults to 1 if omitted.
| ''(Optional)'' The gold price that must be paid each time to use this destination. Default none.
|-
|-
| <samp>BuyTicketMessage</samp>
| ''(Optional)'' If the destination costs money to use, a [[Modding:Tokenizable strings|tokenizable string]] for the purchase confirmation message shown. If present, <code>{0}</code> is replaced with the purchase price. Defaults to the network's <samp>BuyTicketMessage</samp> field.
|-
|-
| <code>HasAny()</code>
| <samp>CustomFields</samp>
| Get whether the inventory contains any items (ignoring empty slots).
| ''(Optional)'' The [[#Custom data fields|custom fields]] for this entry.
|}
|-
|-
| <code>CountItemStacks()</code>
| <samp>UnlockCondition</samp>
| Get the number of item stacks in the inventory (ignoring empty slots).
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this minecart network is unlocked. Default always enabled.
|-
|-
| <code>ContainsId(id)</code>
| <samp>LockedMessage</samp>
| Get whether the inventory contains any item with the given qualified or unqualified item ID.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the message shown when interacting with a minecart when the <samp>UnlockCondition</samp> false. Defaults to an "''Out of order''" translation.
|-
|-
| <code>ContainsId(id, minCount)</code>
| <samp>ChooseDestinationMessage</samp>
| Get whether the inventory contains items with the given qualified or unqualified item ID, and their combined stack size is at least <samp>minCount</samp>.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the message shown when listing destinations to choose from. Defaults to a "''Choose destination:''" translation.
|-
|-
| <code>CountId(id)</code>
| <samp>BuyTicketMessage</samp>
| Get the combined stack size of all items with the given qualified or unqualified item ID.
| ''(Optional)'' When a destination costs money to use, a [[Modding:Tokenizable strings|tokenizable string]] for the purchase confirmation message shown. If present, <code>{0}</code> is replaced with the purchase price. Defaults to a "''Buy a ticket for {0}g?''" translation.
|}
====Open a minecart menu====
|-
You can use an <samp>Action: MinecartTransport {{o|network ID}} {{o|exclude destination ID}}</samp> [[Modding:Maps|map property]] to open the minecart menu. When the player interacts with the tile, it'll open the menu for the {{o|network ID}} network (default <samp>Default</samp>). if {{o|exclude destination ID}} is specified, the matching destination will be hidden from the list (usually because you're at that minecart). For example, the [[Bus Stop|bus stop]] minecart uses <code>Action: MinecartTransport Default Bus</code>.
| Remove the given number of items matching the given qualified or unqualified item ID. This reduces the stack size for matching items until a total of <samp>count</samp> have been removed, and clears any slots which reach a stack size of zero.
From a C# mod, you can call <code>Game1.currentLocation.ShowMineCartMenu(networkId, excludeDestinationId)</code> which works the same way (except that <samp>networkId</samp> is required).
|}</li>
<li>Many common operations have been unified, so previously player-only methods can now be used with chests too.</li>
====Example====
<li>It has an internal index by item ID, so operations like <code>items.ContainsId("(O)128")</code> are much more efficient since they no longer iterate the list.</li>
This [[Modding:Content Patcher|Content Patcher]] content pack adds the [[Railroad]] as a minecart destination, complete with a map edit adding a decorative minecart. It is available after the [[Random Events|Earthquake]] has occurred and minecarts have been unlocked.
</ul>
{{#tag:syntaxhighlight|<nowiki>
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
// add minecart destination
{
"Action": "EditData",
"Target": "Data/Minecarts",
"TargetField": [ "Default", "Destinations" ], // for the "Default" network, edit the "Destinations" field
"Entries": {
"Railroad": {
"Id": "Railroad",
"DisplayName": "[LocationName Railroad]",
"Condition": "LOCATION_ACCESSIBLE Railroad",
"TargetLocation": "Railroad",
"TargetTile": { "X": 16, "Y": 39 },
"TargetDirection": "down",
}
}
},
// add decorative minecart
{
"Action": "EditMap",
"Target": "Maps/Railroad",
"FromFile": "assets/Custom_Railroad_Minecart.tmx",
"ToArea": { "X": 15, "Y": 35, "Width": 4, "Height": 5 }
}
]
}</nowiki>|lang=javascript}}
===Custom passive festivals===
{{/doc status|[[Modding:Festival data]] or a new doc page|done=false}}
You can now add or modify passive festivals by editing the <samp>Data/PassiveFestivals</samp> asset.
(A ''passive festival'' is a [[festivals|festival]] like the [[Night Market]]. They replace a location for a period of time, the player can enter/leave them anytime, and time continues passing while at the festival.)
====Data format====
The <samp>Data/PassiveFestivals</samp> asset consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the festival.
* The value is a model with the fields listed below.
{| class="wikitable"
{| class="wikitable"
|-
|-
! game class
! field
! old code
! effect
|-
| <samp>DisplayName</samp>
| A [[Modding:Tokenizable strings|tokenizable string]] for the display name shown on the [[calendar]].
|-
| <samp>Season</samp>
| The [[season]] when the festival becomes active.
|-
|-
| <samp>StartDay</samp><br /><samp>EndDay</samp>
| The days of month when the festival becomes active.
| Use <code>items.CountId(id)</code>.
|-
|-
| <code>hasItemInInventory(id, count)</code><br /><code>hasItemInInventoryNamed(name)</code><br /><code>hasItemWithNameThatContains(name)</code>
| <samp>StartTime</samp>
| Use <code>items.ContainsId(id, count)</code>.
| The time of day when the festival opens each day.
|-
|-
| <code>hasItemInList(list, id, count)</code>
| <samp>StartMessage</samp>
| Use <code>list.ContainsId(id, count)</code>.
| A [[Modding:Tokenizable strings|tokenizable string]] for the in-game [[wikipedia:Pop-up notification|toast notification]] shown when the festival begins each day.
|-
|-
| <code>areAllItemsNull()</code>
| <samp>MapReplacements</samp>
| The locations to swap for the duration of the festival. Despite the field name, this swaps '''locations''' (e.g. as added by <samp>CustomLocations</samp> using [[Modding:Content Patcher|Content Patcher]]), and not the location's map asset.
This is specified as a string → string lookup, where the key is the original location to replace and the value is the new location. Both use the internal location name, as shown by the {{nexus mod|679|Debug Mode}} mod. For example, this swaps the <samp>Beach</samp> location with <samp>BeachNightMarket</samp> during the [[Night Market]]:
<syntaxhighlight lang="js">
"MapReplacements": {
"Beach": "BeachNightMarket"
}
</syntaxhighlight>
|-
|-
| <code>numberOfItemsInInventory()</code>
| <samp>Condition</samp>
| Use <code>items.CountItemStacks()</code> to count all items, or <code>Items.Count(p => p is Object)</code> to match this method's actual behavior.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the festival is enabled (subject to the other fields like <samp>StartDay</samp> and <samp>EndDay</samp>). Defaults to always enabled.
|-
|-
| <code>consumeObject(id, count)</code><br /><code>removeItemsFromInventory(id, count)</code>
| <samp>ShowOnCalendar</samp>
| Use <code>items.ReduceId(id, count)</code>.
| ''(Optional)'' Whether the festival appears on the [[calendar]], using the same iridium-star icon as the [[Calendar#Winter|Night Market]]. Default true.
|-
|-
|rowspan="2"| <samp>Object</samp>
| <samp>DailySetupMethod</samp><br /><samp>CleanupMethod</samp>
| <code>ConsumeInventoryItem(player, id, count)</code>
| ''(Optional)'' A C# method which applies custom logic when the day starts (<samp>DailySetupMethod</samp>) and/or overnight after the last day of the festival (<samp>CleanupMethod</samp>).
| This was somewhat specialized and shouldn't be called by mod code, but the equivalent would be <code>(obj.autoLoadChest?.items ?? player.items).ReduceId(id, count)</code>.
These must be specified in the form <samp>{{t|full type name}}: {{t|method name}}</samp> (like <samp>ExampleMod.Namespace.Type, ExampleMod: MethodName</samp>). The methods must be static, take zero arguments, and return void.
|-
|-
| <code>GetTallyOfObject(player, id)</code>
| <samp>CustomFields</samp>
| This was somewhat specialized and shouldn't be called by mod code, but the equivalent would be <code>(obj.autoLoadChest?.items ?? player.items).CountId(id)</code>.
| The [[#Custom data fields|custom fields]] for this entry.
|}
|}
===ItemContextTagManager class===
====NPC schedules====
When a passive festival is active, NPCs will check for [[Modding:Schedule data|a schedule entry]] in this order:
{| class="wikitable"
{| class="wikitable"
|-
|-
! method
! syntax
! effect
! summary
|-
|-
| <code>GetBaseContextTags(id)</code>
| <samp>{{t|festival ID}}_{{t|festival day}}</samp>
| Get the base context tags for an item from the <samp>Data/ObjectContextTags</samp> asset. This doesn't include dynamic context tags added by the instance, which you can get via <code>item.GetContextTags()</code>.
| Applies on the given date. The {{t|festival day}} is relative, so <samp>1</samp> matches the festival <samp>StartDay</samp>.<br /><small>Example: <samp>NightMarket_3</samp> or <samp>marriage_NightMarket_3</samp></small>
|-
|-
| <code>DoesTagQueryMatch(query, tags)</code>
| <samp>{{t|festival ID}}</samp>
| Get whether a context tag query matches the given tags. For example, <code>ItemContextTagManager.DoesTagQueryMatch("bone_item, !fossil_item", item.GetContextTags())</code> returns true if the item is a bone item but not a fossil (like the [[Bone Flute]]).
| Applies if there's no date-specific entry.<br /><small>Example: <samp>NightMarket</samp> or <samp>marriage_NightMarket</samp></small>
|}
|}
===Other item changes===
If the NPC is married to a player, they'll add a <samp>marriage_</samp> prefix to the keys (like <samp>marriage_{{t|festival ID}}_{{t|festival day}}</samp>) and ignore any entry without the prefix.
===Custom weather===
{{/doc status|[[Modding:Weather data]]|done=false}}
You can now change the weather algorithm by editing [[#Custom location contexts|location context data]], and (with a C# mod) implement custom weathers.
Fields like <samp>Game1.weather</samp> and <samp>Game1.weatherForTomorrow</samp> are now strings to support custom mod weather IDs. The change for vanilla weather has no effect on Content Patcher packs, since the new weather IDs match the ones Content Patcher was using before (i.e. <samp>Sun</samp>, <samp>Rain</samp>, <samp>Snow</samp>, <samp>Storm</samp>, and <samp>Wind</samp>). C# mods may also see a <samp>Festival</samp> weather, while Content Patcher packs will see <samp>Sun</samp> for it. The constants like <samp>Game1.weather_sunny</samp> have the new string values (with new constants like <samp>Game1.legacy_weather_sunny</samp> for the legacy values).
The base game will treat an invalid weather as sunny. C# mods can implement custom weather effects using [[Modding:Modder Guide/APIs/Events|normal SMAPI events]] like <samp>UpdateTicked</samp>, or by [[Modding:Modder Guide/APIs/Harmony|patching]] methods like <samp>Game1.ApplyWeatherForNewDay</samp> and <samp>Game1.populateDebrisWeatherArray</samp>.
===Custom world maps===
{{/doc status|[[Modding:World map]]|done=true}}
[[File:Modding map area.png|thumb|The default world map, with the farm map area highlighted.]]
You can now change the world map shown in the game menu by editing the <samp>Data/WorldMap</samp> asset. This lets you...
* add custom maps for certain locations;
* apply texture overlays;
* add/edit tooltips;
* set real-time player marker positioning;
* etc.
The game's default map is fully defined in <samp>Data/WorldMap</samp>, including all the display text and conditional changes.
===New map properties===
{{/doc status|[[Modding:Maps#Known_map_properties]]|done=true}}
1.6 adds several new [[Modding:Maps|map properties]].
====Building construction====
{| class="wikitable"
{| class="wikitable"
|-
|-
! field/method
! property
! effect
! explanation
|-
|-
| <samp>Item.IsRecipe</samp><br /><samp>Item.Quality</samp><br /><samp>Item.Stack</samp></samp><br /><samp>Item.sellToStorePrice(…)</samp>
| <samp>CanBuildHere T</samp><br />''(valid in any outdoor location)''
| Equivalent to the previous <samp>Object</samp> fields/methods, to simplify common code and avoid needing to special-case <samp>Object</samp> items.
| Whether to allow constructing buildings in this location. The game will adjust automatically to account for it (e.g. Robin will let you choose where to build). See [[#Build anywhere|''build anywhere'' in what's new]].
|-
|-
| <samp>FishingRod.CanUseBait()</samp><br /><samp>FishingRod.CanUseTackle()</samp><br /><samp>FishingRod.GetBait()</samp><br /><samp>FishingRod.GetTackle()</samp><br /><samp>FishingRod.HasMagicBait()</samp><br /><samp>FishingRod.HasCuriosityLure()</samp>
| <samp>BuildConditions {{t|query}}</samp><br />''(valid in any outdoor location)''
| If <samp>CanBuildHere</samp> is set, an optional [[Modding:Game state queries|game state query]] which indicates whether building is allowed currently.
|-
|-
| <samp>IndoorPot.Water()</samp>
| <samp>LooserBuildRestrictions T</samp><br />''(valid in any outdoor location)''
| If set, tiles don't need to be marked <samp>Buildable T</samp> or <samp>Diggable T</samp> in their properties. Tiles can be blocked with <samp>Buildable F</samp> instead. The other restrictions still apply.
|-
|-
| <samp>Tool.isScythe()</samp>
| <samp>ValidBuildRect {{t|x}} {{t|y}} {{t|width}} {{t|height}}</samp><br />''(valid in any outdoor location)''
| Equivalent to the previous <samp>MeleeWeapon</samp> method, to simplify common code and avoid needing to special-case <samp>MeleeWeapon</samp> items.
| The tile area within the map where buildings may be placed. If omitted, buildings may be placed in any open space in the map.
|}
|}
====Crops====
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! property
! effect
! explanation
|-
|-
| <samp>AllowGiantCrops T</samp>
| If set with any non-blank value, [[Crops#Giant Crops|giant crops]] can grow in this location (if crops are also allowed per the [[#Custom crops|crop data]] or [[#Custom location contexts|<samp>PlantableLocations</samp> context field]]).
| <samp>MapPath</samp>
| The asset name for the map to use for this location.
|-
| <samp>AlwaysActive</samp>
|-
|-
| <samp>Type</samp>
| <samp>DirtDecayChance {{t|chance}}</samp>
| ''(Optional)'' The full name of the C# location class to create. This must be one of the vanilla types to avoid a crash when saving. There are too many to list here, but the most useful types are likely <samp>StardewValley.GameLocation</samp> (default value) and <samp>StardewValley.Locations.DecoratableLocation</samp>.
| The probability that each dirt tile will disappear overnight if it doesn't contain a crop, as a value between 0 (never) and 1 (always). Defaults to 0 (greenhouses), 0.1 (farms), and 1 (anywhere else).
|}
|}
====Farmhouse interior====
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! property
! effect
! explanation
|-
|-
| <samp>ArtifactSpots</samp>
| <samp>FarmHouseStarterGift [{{t|id}} {{o|count}}]+</samp>
| ''(Optional)'' The items that can be found when digging [[Artifact Spot|artifact spots]] in this location.
| The items that should appear in the initial gift box placed in the farmhouse when the save is created. This consists of one or more pairs of item ID (which can be qualified or unqualified) and count. The count is optional on the last entry.
For example, this will add 10 pufferfish (object 128) and a blobfish mask (hat 56):
<pre>FarmHouseStarterGift (O)128 10 (H)56 1</pre>
If omitted, the default items (usually a 15 parsnip seeds) are added instead.
|}
====Warps & map positions====
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! property
! effect
! explanation
|-
|-
| ''common fields''
| <samp>AllowWakeUpWithoutBed {{t|allow}}</samp>
| See [[#Item spawn fields|item spawn fields]] for the generic item fields supported by artifact spot drops.
| Whether the player can wake up in this location without a bed, similar to the island farmhouse. This is typically used with <samp>PassOutLocations</samp> in [[#Custom location contexts|<samp>Data/LocationContexts</samp>]].
|-
|-
| <samp>Chance</samp>
| <samp>DefaultWarpLocation {{t|x}} {{t|y}}</samp><br />''(valid in any location)''
| The default arrival tile, used when a player or NPC is added to the location without a target tile (e.g. using [[Modding:Console commands|debug commands]] like <samp>debug warp</samp> or <samp>debug eventbyid</samp>).
|-
|-
| <samp>ApplyGenerousEnchantment</samp>
| <samp>PetBowlLocation {{t|x}} {{t|y}}</samp><br />''(valid in the farm)''
| The default position of the pet bowl
|-
|-
| <samp>OneDebrisPerDrop</samp>
| <samp>SpouseRoomPosition {{t|x}} {{t|y}}</samp><br />''(valid in farmhouse)''
| The top-left position at which to place the [[Marriage#Spouse Rooms|spouse room]].
|-
|-
| <samp>ContinueOnDrop</samp>
| <samp>TravelingCartPosition {{t|x}} {{t|y}}</samp><br />''(valid in the forest)''
| ''(Optional)'' Whether to continue checking for more items to drop when this item is dropped. Default false.
| The top-left position at which to place the [[Traveling Cart]]. This is the top-left corner of the collision box, so the roof will extend two tiles above this tile.
| <samp>Precedence</samp>
|}
|}
===Other map property changes===
{{/doc status|[[Modding:Maps]]|done=true}}
| ''(Optional)'' The distinct [[fishing]] areas within the location. These can be referenced by fish via <samp>FishAreaId</samp>, and determine which fish are collected by [[Crab Pot|crab pots]].
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! map property
! effect
! changes
|-
| <samp>Arch</samp><br /><samp>asdf</samp><br /><samp>Debris</samp><br /><samp>Fish</samp>
| Removed (these were unused).
|-
| <samp>FarmHouseFlooring</samp><br /><samp>FarmHouseFurniture</samp><br /><samp>FarmHouseStarterSeedsPosition</samp><br /><samp>FarmHouseWallpaper</samp>
| These now work independently. For example, you can now use <samp>FarmHouseFlooring</samp> without needing to set <samp>FarmHouseFurniture</samp> too.
|-
| <samp>Music</samp>
| Deprecated; use the music fields in [[#Custom locations|<samp>Data/Locations</samp>]] instead. This property is only applied if the location has no music in <samp>Data/Locations</samp>. This was removed from all vanilla maps.
|-
|-
| <samp>Position</samp>
| <samp>NPCWarp</samp><br /><samp>Warp</samp>
| Now fault-tolerant. They'll automatically ignore extra spaces, log an informative warning if parsing still fails, and continue with the next warp if possible.
|-
|-
| <samp>CrabPotFishTypes</samp>
| <samp>Stumps</samp>
| ''(Optional)'' A list of fish types that can be caught by crab pots within the area. This is matched against field index 4 in [[Modding:Fish data|<samp>Data/Fish</samp>]] for 'trap' (i.e. crab pot) fish. The vanilla types are <samp>freshwater</samp> and <samp>ocean</samp>. If omitted, defaults to <samp>freshwater</samp>.
| Now works in all locations.
|-
|-
| <samp>CrabPotJunkChance</samp>
| <samp>UniquePortrait</samp><br /><samp>UniqueSprite</samp>
| ''(Optional)'' The chance that crab pots within the area will find junk instead of a fish each time they produce a harvest. This is ignored if the player has the [[Fishing#Fishing Skill|Mariner]] profession. Default <samp>0.2</samp> (20%).
| Deprecated; use [[#Custom NPC appearance|custom NPC appearances]] instead. These properties will override NPC appearances. This was removed from all vanilla maps.
|}
|}
===Tile property changes===
{{/doc status|[[Modding:Maps#Known tile properties]]|done=true}}
<ul>
<li>You can now override a tile index property by setting it as a tile property.</li>
<li>Added new [[Modding:Maps|tile properties]]:
{| class="wikitable"
{| class="wikitable"
! layer
! property
! explanation
|-
|-
| <samp>Paths</samp>
| <samp>SpawnTree {{t|category}} {{t|ID}} {{t|Growth stage}} {{t|Regrowth stage}}</samp>
| Spawns a tree when the map is created. {{t|category}} may be either <samp>wild</samp> or <samp>fruit</samp>. <samp>wild</samp> will spawn a [[Trees|wild tree]], while <samp>fruit</samp> will spawn a [[Fruit Trees|fruit tree]].
|}
</li>
<li>Added new <samp>Action</samp> [[Modding:Maps|tile properties]]:
{| class="wikitable"
|-
|-
! layer
! property
! explanation
|-
|-
| <samp>Chance</samp>
| <samp>Buildings</samp>
| ''(Optional)'' The probability that the fish will spawn if selected, as a decimal value between 0 (never) and 1 (always). Default 1.
| <samp>Action BuildingSilo</samp>
| If a building covers this tile, enables [[silo]] interactions on this tile subject to the building's <samp>HayCapacity</samp> field in <samp>Data/Buildings</samp>.
|-
|-
| <samp>Season</samp>
| <samp>Buildings</samp>
| ''(Optional)'' If set, the specific season when the fish can be caught. This is much more efficient than using <samp>Condition</samp>, but only supports a single season. Defaults to <samp>null</samp> (all seasons).
| <samp>Action BuildingToggleAnimalDoor</samp>
| If a building covers this tile, opens or closes its animal door.
|-
|-
| <samp>FishAreaId</samp>
| <samp>Buildings</samp>
| ''(Optional)'' If set, the fish area in which the fish can be caught (as an area ID defined under <samp>FishAreas</samp>). Defaults to <samp>null</samp> (all zones).
| <samp>Action Dialogue</samp>
|  
* The message can now be a [[Modding:Tokenizable strings|tokenizable string]].
* Fixed the cursor not changing to the inspection icon when hovering on an <samp>Action Dialogue</samp> tile.
|-
|-
| <samp>BobberPosition</samp>
| <samp>Buildings</samp>
| ''(Optional)'' If set, the tile area within the location where the fishing rod's bobber must land to catch the fish. Default <samp>null</samp> (anywhere).
| <samp>Action Forge</samp>
| Opens the [[Forge]] menu.
|-
|-
| <samp>PlayerPosition</samp>
| <samp>Buildings</samp>
| ''(Optional)'' If set, the tile area within the location where the player must be standing to catch the fish. Default <samp>null</samp> (anywhere).
| <samp>Action None</samp>
| Does nothing. This is used to mark the tile interactive if the click will be handled separately.
|-
|-
| <samp>MinFishingLevel</samp>
| <samp>Buildings</samp>
| ''(Optional)'' The minimum fishing level needed for the fish to appear. Default 0.
| <samp>Action ObeliskWarp {{t|location name}} {{t|x}} {{t|y}} {{o|whether to dismount}}</samp>
| Warps the player to the specified location name and position with the [[Warp Totem|Obelisk]] animation/sound effects.
|-
|-
| <samp>ApplyDailyLuck</samp>
| <samp>Buildings</samp>
| ''(Optional)'' Whether to add the player's [[Luck|daily luck]] to the spawn chance. This affects both the <samp>Chance</samp> field and the <samp>Data\Fish</samp> chance, if applicable. Default false.
| <samp>Action OpenShop {{t|shop id}} {{o|from direction}} {{o|open time}} {{o|close time}} {{o|owner tile area}}</samp>
| Open the [[#Custom shops|shop]] with the given {{t|shop id}}. All arguments besides the ID are optional:
* {{o|from direction}}: if specified, the player must be standing in this direction relative to the shop (one of <samp>down</samp>, <samp>up</samp>, <samp>left</samp>, <samp>right</samp>, or <samp>none</samp>). Setting this to <samp>none</samp> disables the requirement. The default for most vanilla shops is <samp>down</samp>.
* {{o|open time}} and {{o|close time}}: the start & end times in 26-hour format when the shop is available. Interacting with the tile outside those times does nothing.
* {{o|owner tile area}}: if specified, the tile area which must contain one of the shop owners for the shop to be available. For a custom shop, these are defined by its <samp>Owners</samp> field. This can be specified in two forms: <samp>{{t|x}} {{t|y}}</samp> for a single tile, or <samp>{{t|x}} {{t|y}} {{t|width}} {{t|height}}</samp> for a multi-tile area.
|-
|-
| <samp>CuriosityLureBuff</samp>
| <samp>Buildings</samp>
| ''(Optional)'' The value to add to the spawn chance when the player has the [[Curiosity Lure]] equipped, if set to 0 or higher. This affects both the <samp>Chance</samp> field and the <samp>Data\Fish</samp> chance, if applicable. Default -1, which keeps the default behavior (i.e. no effect on the <samp>Chance</samp> field and a scaled boost to the <samp>Data\Fish</samp> chance).
| <samp>Action PlayEvent {{t|event id}} {{o|check preconditions}} {{o|skip if seen}} {{o|fallback action}}</samp>
|-
| Immediately start an [[Modding:Event data|event]], subject to the conditions:
| <samp>CatchLimit</samp>
* {{o|check preconditions}}: whether to ignore the action if the [[Modding:Event data#Event preconditions|event's preconditions]] don't match (one of <samp>true</samp> or <samp>false</samp>). Default true.
* {{o|skip if seen}}: whether to ignore the action if the player has already seen the given event. Default true.
|-
| ''(Optional)'' Whether the player must fish with Magic Bait for this fish to spawn. Default false.
|-
If the event doesn't start for any reason (including the preceding conditions):
* <samp>-1100</samp> to <samp>-1000</samp>: global priority items (e.g. Qi Beans);
* If {{o|fallback action}} is specified, it'll be run as an action. This can be any <samp>Action</samp> tile property (without the "Action " prefix), like <code>Action PlayEvent 60367 true true PlayEvent 520702 false false</code> to play a different event.
* Otherwise the action is silently ignored.
* <samp>1</samp> to <samp>100</samp>: normal low-priority items;
For example, <code>Action PlayEvent 60367 false false</code> will replay the bus arrival event from the start of the game.
|-
|}
| <samp>SetFlagOnCatch</samp>
</li>
| ''(Optional)'' The mail flag to set for the current player when this fish is successfully caught. Default none.
<li>Added new <samp>TouchAction</samp> [[Modding:Maps|tile properties]]:
{| class="wikitable"
|-
! layer
! property
! explanation
|-
| <samp>Back</samp>
| <samp>TouchAction PlayEvent {{t|event id}} {{o|check preconditions}} {{o|skip if seen}} {{o|fallback action}}</samp>
| Equivalent to <samp>Action PlayEvent</samp>, but activated on touch. Note that {{o|fallback action}} is an <samp>Action</samp> tile property, ''not'' a <samp>TouchAction</samp> tile property.
|}</li>
<li>Changed existing tile properties:
{| class="wikitable"
|-
! layer
! property
! reason
|-
|-
| <samp>ChanceModifiers</samp>
|rowspan="4"| <samp>Back</samp>
| ''(Optional)'' [[#Quantity modifiers|Quantity modifiers]] applied to the <samp>Chance</samp> value. Default none.
| <samp>NoSpawn</samp>
| Added <samp>NoSpawn false</samp> form, which disables any previous <samp>NoSpawn</samp> property on the tile. For example, this can be used to enable spawning on a tile which has a <samp>NoSpawn</samp> tile index property.
|-
|-
| <samp>ChanceModifierMode</samp>
| <samp>TouchAction Bus</samp>
| ''(Optional)'' [[#Quantity modifiers|quantity modifier modes]] which indicate what to do if multiple modifiers in the <samp>ChanceModifiers</samp> field apply at the same time. Default <samp>Stack</samp>.
| Removed. This wasn't used by the game or mods.
|-
| <samp>TouchAction Emote</samp>
| Fixed error if the specified NPC isn't found.
|-
| <samp>Treasure</samp>
| Added <samp>Treasure Item {{t|item ID}}</samp> form which accepts a [[#Custom items|qualified or unqualified item ID]].
|-
|rowspan="2"| <samp>Buildings</samp>
| <samp>Action ItemChest</samp><br /><samp>Action Minecart</samp><br /><samp>Action RemoveChest</samp>
| Removed. These weren't used by the game or mods.
|-
| <samp>Action Kitchen</samp>
| Now works in any location (including those without a fridge).
|}
|}
</li>
</ul>
===Other location/map changes===
{{/doc status|[[Modding:Maps]] and other pages as needed|done=false}}
* Farm data:
** Added <samp>SpawnMonstersByDefault</samp> field to <samp>Data/AdditionalFarms</samp> to set the default value of the 'spawn monsters at night' [[Options#Advanced Game Options|advanced save option]].
** Fixed crash on new-save screen if the farm type's tooltip has no description.
* General location data:
** All locations can now have animals. The <samp>IAnimalLocation</samp> is now obsolete and implemented by <samp>GameLocation</samp>.
** Added new [[Modding:Fish data|fishing areas]] to simplify compatibility between fish & map mods (specifically for hilltop farm, wilderness farm, town, and desert).
** Added a descriptive error when a required location or layer isn't found. Mods can use <samp>map.RequireLayer</samp> and <samp>Game1.RequireLocation</samp> to get a location with similar error-checking.
** Added <samp>WarpPathfindingCache</samp> for C# mods, which modularizes the NPC warp route logic. You can edit its <samp>IgnoreLocationNames</samp>, <samp>OverrideTargetNames</samp>, and <samp>GenderRestrictions</samp> fields if needed for custom locations.
** Game logic which checks tile indexes is now more fault-tolerant, so it won't crash if an expected tile was edited.
** Finished migrating <samp>DecoratableLocation</samp> flooring/wallpaper areas to string IDs (started in Stardew Valley 1.5.5).
* General map changes:
** Added validation for [[Modding:Maps|map properties and tile properties]]. If the format is invalid, the game will now log a detailed error and skip it.
** Removed unused [[Modding:Maps#Paths layer|path tiles]] in <samp>Maps/paths</samp> and all map files.
* Location context data:
** Building interiors now inherit their parent's location context by default.
** Added <samp>Game1.locationContextData</samp> to cache the data from <samp>Data/LocationContexts</samp>.
** Added constants for the vanilla context IDs like <samp>LocationContexts.IslandId</samp>.
** Added validation for required location context IDs (and <samp>LocationContexts.Require(id)</samp> for mod logic).
** Removed the <samp>Name</samp> field in <samp>Data/LocationContexts</samp>, which duplicated the ID.
<ul>
<li>Added methods to simplify common operations:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! type
! method
! effect
! effect
|-
|-
| ''common fields''
|rowspan="7"| <samp>Building</samp>
| See [[#Item spawn fields|item spawn fields]] for the generic item fields supported by forage items.
| <samp>GetParentLocation</samp>
| Get the location which contains this building.
|-
| <samp>IsInCurrentLocation</samp>
| Get whether the building is in the same location as the current player.
|-
| <samp>HasIndoors</samp>
| Get whether the building has an interior location.
|-
| <samp>GetIndoors</samp>
| Get the location within this building, if applicable.
|-
| <samp>HasIndoorsName</samp>
| Get whether the building has an interior location and its unique name matches the given value (like <code>building.HasIndoorsName("FarmHouse")</code>).
|-
| <samp>GetIndoorsName</samp>
| Get the unique name of the location within this building, if applicable.
|-
|-
| <samp>Chance</samp>
| ...
| ''(Optional)'' The probability that the item will spawn if selected, as a decimal value between 0 (never) and 1 (always). Default 1.
| ''see also [[#Other building changes|other building changes]] for non-location methods.''
|-
|-
| <samp>Season</samp>
|rowspan="7"|<samp>Cabin</samp><br /><samp>FarmHouse</samp>
| <samp>GetCellar</samp>
| Get the [[cellar]] location linked to this cabin, if any.
|-
|}
| <samp>CanAssignFarmhand</samp><br /><samp>AssignFarmhand</samp>
| ''(Cabin only)'' Check whether the cabin is available to assign to a farmhand, or perform the assignment.
|-
| <samp>HasOwner</samp>
| Get whether the home has an assigned player, regardless of whether they've finished creating their character.
|-
|-
| <samp>OwnerId</samp>
| Get the unique ID of the player who owns this home, if any.
|-
|-
| <samp>Name</samp>
| <samp>IsOwnedByCurrentPlayer</samp>
| The unique ID for the location context. This should only contain alphanumeric/underscore/dot characters. For custom contexts, this should be prefixed with your mod ID like <samp>Example.ModId_ContextName</samp>.
| Get whether the cabin belongs to the current player.
|-
|-
| <samp>IsOwnerActivated</samp>
| Get whether the home has an assigned player and they've finished creating their character.
|-
|-
| <samp>DefaultValidPlantableLocations</samp>
| <samp>HasNpcSpouse</samp>
| ''(Optional)'' The internal names of the locations where crops can be planted and grown by default (see also [[#Custom planting restrictions|custom planting restrictions]]).
| Get whether the player who owns this home is married to any NPC (when used like <samp>HasNpcSpouse()</samp>) or a specific NPC (like <samp>HasNpcSpouse(name)</samp>). This also replaces <samp>shouldShowSpouseRoom()</samp>.
|-
|-
| <samp>AllowRainTotem</samp>
|rowspan="2"| <samp>Farm</samp>
| ''(Optional)'' Whether a [[Rain Totem]] can be used to force rain in this context tomorrow.
| <samp>GetStarterFarmhouseLocation</samp>
| Get the default tile position for the farmhouse. (See also <samp>farm.GetMainFarmHouseEntry()</samp>.)
|-
|-
| <samp>MaxPassOutCost</samp>
| <samp>GetStarterPetBowlLocation</samp>
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context, the maximum amount of [[gold]] lost. If omitted or set to <samp>-1</samp>, uses the same value as the <samp>Default</samp> context ({{price|1000}} by default).
| Get the default tile position for the pet bowl.
|-
|-
| <samp>PassOutMail</samp>
|rowspan="19"| <samp>GameLocation</samp>
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context, the possible [[Modding:Mail data|letter IDs]] to add to their mailbox (if they haven't received it before). If multiple letters are valid, one will be chosen randomly (unless one specifies <samp>SkipRandomSelection</samp>).
| <samp>AddDefaultBuildings</samp>
| Can be overridden to add custom buildings when the location is created and/or loaded. These can either be re-added whenever they're missing (like the vanilla farmhouse), or only built once on save creation (like the vanilla pre-built cabins).
This consists of a list of models with these fields:
This replaces the former <samp>farm.AddModularShippingBin()</samp> method.
|-
| <samp>GetFridge</samp><br /><samp>GetFridgePosition</samp>
| Get the fridge's chest or tile position, if the location has one.
|-
| <samp>GetSeason</samp><br /><samp>GetSeasonIndex</samp><br /><samp>GetSeasonKey</samp>
| Get the local season that applies within the location as an enum, number (like <samp>0</samp> for spring), or string (like <samp>spring</samp>) respectively. For example, it's always summer on [[Ginger Island]].
|-
| <samp>GetWeather</samp><br /><samp>IsDebrisWeatherHere</samp><br /><samp>IsLightningHere</samp><br /><samp>IsRainingHere</samp><br /><samp>IsSnowingHere</samp>
| Get the current weather in this location's context, regardless of whether the player is indoors and sheltered from it.
|-
|-
| <samp>InDesertContext</samp><br /><samp>InIslandContext</samp><br /><samp>InValleyContext</samp>
| Get whether this location is within the <samp>Island</samp> or <samp>Default</samp> location context respectively.
|-
|-
| <samp>Mail</samp>
| <samp>IsActiveLocation</samp>
| The [[Modding:Mail data|letter ID]] to add.
| Get whether this location is actively synced to the current player (see [[Modding:Modder Guide/Game Fundamentals#Farmhand shadow world|farmhand shadow world]]).
|-
|-
| <samp>MaxPassOutCost</samp>
| <samp>IsTemporary</samp>
| ''(Optional)'' The maximum amount of [[gold]] lost. This is applied after the context's <samp>MaxPassOutCost</samp> (i.e. the context's value is used to calculate the random amount, then this field caps the result). Defaults to unlimited.
| Get whether this is a temporary location for a festival or minigame. This is cached based on the location name (e.g. locations starting with <samp>Temp</samp> or some other specific names).
|-
|-
| <samp>Condition</samp>
| <samp>GetLocationContextId</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this entry is active. Defaults to always true.
| Get the ID of the location context in <samp>Data/LocationContexts</samp> which contains this building.
|-
|-
| <samp>SkipRandomSelection</samp>
| <samp>GetContainingBuilding</samp>
| ''(Optional)'' If true, send this mail if the <samp>Condition</samp> matches instead of choosing a random valid mail. Default false.
| Get the building instance which contains this location (like the cabin for a cabin interior), if applicable.
|-
|-
| <samp>PassOutLocations</samp>
| <samp>GetParentLocation</samp>
| ''(Optional)'' When the player passes out (due to [[energy|exhaustion]] or at 2am) in this context ''and'' they started the day in a different location context, the locations where they'll wake up. (If the player started the day in the same context, they'll wake up in the last bed they slept in instead.)
| Get the parent location which contains this one (like the farm for a cabin interior), or <samp>null</samp> if it has no parent.
|-
|-
| <samp>GetRootLocation</samp>
| Get the parent location which contains this one (like the farm for a cabin interior), or the location itself if it has no parent.
|-
|-
| <samp>Location</samp>
| <samp>GetInstancedBuildingInteriors</samp>
| The internal location name.
| Get all building interiors within this location which are instanced to the building (i.e. not in <samp>Game1.locations</samp> separately).
|-
|-
| <samp>Position</samp>
| <samp>GetMapPropertySplitBySpaces</samp><br /><samp>GetTilePropertySplitBySpaces</samp>
| Get the value of a map/tile property and split it into individual words. If the map/tile property isn't defined, returns an empty array.
For example:
<syntaxhighlight lang="c#">
string[] fields = Game1.currentLocation.GetMapPropertySplitBySpaces("ScreenshotRegion");
</syntaxhighlight>
|-
|-
| <samp>ReviveLocations</samp>
| <samp>HasMapPropertyWithValue</samp>
| ''(Optional)'' If the player just got knocked out in combat, the location names where they'll wake up.
| Get whether a map property is defined and has a non-empty value.
For example:
<syntaxhighlight lang="c#">
bool canUseCasks = Game1.currentLocation.HasMapPropertyWithValue("CanCaskHere");
</syntaxhighlight>
|-
|-
| <samp>StoreHayInAnySilo</samp>
| Add hay to any silo with free space (preferring silos in the current location, then the farm, then anywhere).
|-
|-
| <samp>Location</samp>
| <samp>TryGetMapProperty</samp>
| The internal location name.
| Get a map property value as a string, if it's defined.
For example:
<syntaxhighlight lang="c#">
if (this.TryGetMapProperty("Warps", out string warps))
{
// ...
}
</syntaxhighlight>
|-
| <samp>TryGetMapPropertyAs</samp>
| Get a map property and parse it into into a <samp>bool</samp>, <samp>double</samp>, <samp>Point</samp>, <samp>Rectangle</samp>, or <samp>Vector2</samp> value.
For example:
<syntaxhighlight lang="c#">
if (!this.TryGetMapPropertyAs("MailboxLocation", out Point position))
{
position = new Point(68, 16); // default value
}
</syntaxhighlight>
|-
| <samp>removeObjectsAndSpawned</samp>
| Remove all objects, bushes, resource clumps, and terrain features within a tile area.
|-
| <samp>OnBuildingConstructed</samp><br /><samp>OnBuildingMoved</samp><br /><samp>OnBuildingDemolished</samp>
| These methods are called for all players when any player constructs, moves, or demolishes a building.
|-
|rowspan="3"| <samp>LibraryMuseum</samp>
| <samp>HasDonatedArtifacts()</samp>
| Get whether any items have been donated to the [[museum]].
|-
| <samp>HasDonatedArtifactAt(tile)</samp>
| Get whether any donated item is currently placed at the given tile position within the [[museum]].
|-
| <samp>HasDonatedArtifact(itemId)</samp>
| Get whether an artifact with the given qualified or unqualified item ID has been donated to the [[museum]].
|-
|rowspan="2"| <samp>MineShaft</samp>
| <samp>GetLevelName</samp>
| Get the location name for a generated [[The Mines|mine]] or [[Skull Cavern]] level.
For example:
<syntaxhighlight lang="c#">
string locationName = MineShaft.GetLevelName(10); // returns "UndergroundMine10"
Game1.warpFarmer(locationName, 0, 0, false);
</syntaxhighlight>
|-
|-
| <samp>Position</samp>
| <samp>IsGeneratedLevel</samp>
| The tile position within the location, specified as an object with <samp>X</samp> and <samp>Y</samp> fields.
| Get whether a location or location name is a generated [[The Mines|mine]] or [[Skull Cavern]] level.
For example:
<syntaxhighlight lang="c#">
string locationName = "UndergroundMine10";
bool isMine = MineShaft.IsGeneratedLevel(locationName, out int level); // returns true, 10
</syntaxhighlight>
|-
|-
| <samp>Condition</samp>
| <samp>VolcanoDungeon</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this entry is active. Defaults to always applied.
| <samp>GetLevelName</samp><br /><samp>IsGeneratedLevel</samp>
| Equivalent to the matching <samp>MineShaft</samp> methods, but for the [[Volcano Dungeon]].
|}
|}
</li>
</ul>
* Added map/tile property <samp>TryAdd</samp>/<samp>TryGetValue</samp> extensions in <samp>StardewValley.Extensions</samp> for string property values. For example, this lets you do <samp>map.Properties.TryGetValue(key, out string value)</samp>.
* <samp>MineShaft.tryToAddMonster</samp> now returns whether a monster was added.
* <samp>Game1.GetNumberBuildingsConstructed</samp> and <samp>location.getNumberBuildingsConstructed</samp> now have overloads to count all building types and/or specify whether to count under-construction buildings.
* Fixed <samp>location.refurbishMapPortion</samp> copying <samp>Back</samp> source properties to the <samp>Building</samp> target layer.
* Fixed door warps in custom indoor locations not consistently detected by the game.
==What's new for buildings==
===Custom buildings===
{{/doc status|[[Modding:Blueprint data]]|done=false}}
You can now add custom buildings by editing the <samp>Data/Buildings</samp> asset. This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the building type.
* The value is a model with the fields listed below.
====Required fields====
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>SeasonOverride</samp>
| <samp>Name</samp><br /><samp>Description</samp>
| A [[Modding:Tokenizable strings|tokenizable string]] for the display name and description (e.g. shown in the construction menu).
|-
| <samp>Texture</samp>
| The asset name for the texture under the game's Content folder.
|}
|}
====Construction====
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>WeatherConditions</samp>
| <samp>Builder</samp>
| ''(Optional)'' The weather logic to apply for locations in this context (ignored if <samp>CopyWeatherFromLocation</samp> is set). Defaults to always sunny. If multiple are specified, the first matching weather is applied.
| ''(Optional)'' The NPC from whom you can request construction. The vanilla values are [[Carpenter's Shop|<samp>Robin</samp>]] and [[Wizard's Tower#Buildings|<samp>Wizard</samp>]], but you can specify a different name if a C# mod opens a construction menu for them. Defaults to <samp>Robin</samp>. If omitted, it won't appear in any menu.
|-
| <samp>BuildCost</samp>
| ''(Optional)'' The gold cost to construct the building. Defaults to {{price|0}}.
|-
| <samp>BuildMaterials</samp>
| ''(Optional)'' The materials you must provide to start construction, as a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Weather</samp>
| <samp>Id</samp>
| The [[#Custom weather|weather ID]] to set.
| ''(Optional)'' The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list. Defaults to the <samp>ItemId</samp> if not specified.
|-
|-
| <samp>Condition</samp>
| <samp>ItemId</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether to apply the weather. Defaults to always applied.
| The required item ID (qualified or unqualified).
|-
|-
| <samp>CopyWeatherFromLocation</samp>
| <samp>Amount</samp>
| ''(Optional)'' The <samp>Name</samp> (i.e. unique ID) of the location context from which to inherit weather.
| The number of the item required.
|}
|}
|-
|-
| <samp>BuildDays</samp>
| ''(Optional)'' The number of days needed to complete construction (e.g. <samp>1</samp> for a building completed the next day). If set to 0, construction finishes instantly. Defaults to 0.
|-
|-
| <samp>DefaultMusic</samp>
| <samp>BuildCondition</samp>
| ''(Optional)'' The [[#Custom audio|cue ID]] for the music to play when the player is in the location, unless overridden by a <samp>Music</samp> map property. Despite the name, this has a higher priority than the seasonal music fields below. Ignored if omitted.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the building should be available in the construction menu. Defaults to always available.
|-
|-
| <samp>DefaultMusicCondition</samp>
| <samp>BuildMenuDrawOffset</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which returns whether the <samp>DefaultMusic</samp> field should be applied (if more specific music isn't playing). Defaults to always true.
| ''(Optional)'' A pixel offset to apply to the building sprite when drawn in the construction menu. Default none.
|-
|-
| <samp>DefaultMusicDelayOneScreen</samp>
| <samp>AdditionalPlacementTiles</samp>
| ''(Optional)'' When the player warps and the music changes, whether to silence the music and play the ambience (if any) until the next warp (similar to the default valley locations). Default false.
| ''(Optional)'' The extra tiles to treat as part of the building when placing it through the construction menu. For example, the farmhouse uses this to make sure the stairs are clear. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>DefaultBaseChance</samp>
| <samp>TileArea</samp>
| The probability that an item will be found when searching garbage cans, as a value between 0 (never) and 1 (always). If the probability check fails, only items that set <samp>IgnoreBaseChance</samp> can spawn. This can be overridden by the per-garbage-can <samp>BaseChance</samp> field. Default 0.2.
| The tile area relative to the top-left corner of the building, specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields.
|-
|-
| <samp>BeforeAll</samp><br /><samp>AfterAll</samp>
| <samp>OnlyNeedsToBePassable</samp>
| The items to prepend (<samp>BeforeAll</samp>) or append (<samp>AfterAll</samp>) to the <samp>GarbageCans</samp> → <samp>Items</samp> field for all garbage cans. These work exactly like the items in that field (e.g. subject to the garbage can's base chance).
| ''(Optional)'' Whether this area allows tiles that would normally not be buildable, so long as they are passable. For example, this is used to ensure that an entrance is accessible. Default false.
|}
|-
|-
| <samp>GarbageCans</samp>
| <samp>IndoorItems</samp>
| The data for individual garbage cans. This consists of a string → model lookup with these fields:
| ''(Optional)'' The items to place in the building interior when it's constructed or upgraded. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| ''entry key''
| <samp>Id</samp>
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>BaseChance</samp>
| <samp>ItemId</samp>
| ''(Optional)'' If set, overrides the root <samp>DefaultBaseChance</samp> field for this garbage can. Defaults to <samp>DefaultBaseChance</samp>.
| The [[#Custom items|qualified item ID]] for the item to place.
|-
|-
| <samp>Items</samp>
| <samp>Tile</samp>
| ''(Optional)'' The items to try spawning when the player searches the garbage can. The first matching item in <samp>BeforeAll</samp> + <samp>Items</samp> + <samp>AfterAll</samp> will be spawned, and any further items will be ignored. Defaults to none.
| The tile position at which to place the item, specified as an object with <samp>X</samp> and <samp>Y</samp> fields.
|-
| <samp>Indestructible</samp>
| ''(Optional)'' Whether to prevent the player from destroying, picking up, or moving the item. Default false.
|}
|-
| <samp>MagicalConstruction</samp>
| ''(Optional)'' Whether the building is magical. This changes the carpenter menu to a mystic theme while this building's blueprint is selected, and completes the construction instantly when placed.
|-
| <samp>AddMailOnBuild</samp>
| ''(Optional)'' A list of [[Modding:Mail data|letter IDs]] to send to all players when the building is constructed for the first time.
|}
====Upgrades====
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| ''common fields''
| <samp>BuildingToUpgrade</samp>
| ''(Optional)'' The ID of the building for which this is an upgrade, or omit to allow constructing it as a new building. For example, the [[Coop|Big Coop]] sets this to <samp>"Coop"</samp>. Any numbers of buildings can be an upgrade for the same building, in which case the player can choose one upgrade path.
|-
| <samp>IndoorItemMoves</samp>
| ''(Optional)'' When applied as an upgrade to an existing building, the placed items in its interior to move when transitioning to the new map. This is a list of models with these fields:
{| class="wikitable"
|-
! field
! effect
|-
|-
| <samp>IgnoreBaseChance</samp>
| <samp>Id</samp>
| ''(Optional)'' Whether this item can spawn even if the <samp>BaseChance</samp> probability check didn't pass. Default false.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>IsMegaSuccess</samp>
| <samp>Source</samp>
| ''(Optional)'' Whether to treat this item as a 'mega success' if it's selected, which plays a special <samp>crit</samp> sound and bigger animation. Default false.
| The tile position on which any item will be moved.
|-
|-
| <samp>IsDoubleMegaSuccess</samp>
| <samp>Destination</samp>
| ''(Optional)'' Whether to treat this item as an 'double mega success' if it's selected, which plays an explosion sound and dramatic animation. Default false.
| The tile position to which to move the item.
|-
|-
| <samp>AddToInventoryDirectly</samp>
| <samp>Size</samp>
| ''(Optional)'' Whether to add the item to the player's inventory directly, opening an item grab menu if they don't have room in their inventory. If false, the item will be dropped on the ground next to the garbage can instead. Default false.
| ''(Optional)'' The tile size of the area to move, specified as a model with <samp>X</samp> and <samp>Y</samp> fields. Defaults to a 1×1 area. If this is multiple tiles, the <samp>Source</samp> and <samp>Destination</samp> specify the top-left coordinate of the area.
|}
|}
|-
| <samp>UpgradeSignTile</samp>
| ''(Optional)'' The tile position relative to the top-left corner of the building where the upgrade sign will be placed when Robin is building an upgrade, in the form <samp>"{{t|x}}, {{t|y}}"</samp>. Defaults to approximately <samp>"5, 1"</samp> if the building interior type is <samp>Shed</samp>, else <samp>"0, 0"</samp>.
|-
| <samp>UpgradeSignHeight</samp>
| ''(Optional)'' The pixel height of the upgrade sign when Robin is building an upgrade. Defaults to 0.
|}
|}
====Exterior behavior====
{| class="wikitable"
|-
! field
! effect
|-
| <samp>Size</samp>
| ''(Optional)'' The building's width and height when constructed, measured in tiles. Defaults to a 1 x 1 area.
|-
| <samp>CollisionMap</samp>
| ''(Optional)'' An ASCII text block which indicates which of the building's tiles the players can walk onto, where each character can be <samp>X</samp> (blocked) or <samp>O</samp> (passable). Defaults to all tiles blocked.
For example, a [[stable]] covers a 2x4 tile area with the front two tiles passable:
<pre>XXXX
XOOX</pre>
When the collision map is parsed, leading/trailing whitespace is trimmed (both for the entire map and for each line). In JSON, you can specify it in two forms:
<syntaxhighlight lang="js">
// single line with \n line breaks
"CollisionMap": "XXXX\nXOOX"
// multi-line with optional indentation
"CollisionMap": "
XXXX
XOOX
"
</syntaxhighlight>
|-
| <samp>HumanDoor</samp>
| ''(Optional)'' The position of the door that can be clicked to warp into the building interior. This is measured in tiles relative to the top-left corner tile. Defaults to disabled.
|-
| <samp>AnimalDoor</samp>
| ''(Optional)'' The position and size of the door that animals use to enter/exit the building, if the building interior is an animal location, specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields. This is measured in tiles relative to the top-left corner tile. Defaults to disabled.
|-
| <samp>AnimalDoorOpenDuration</samp><br /><samp>AnimalDoorCloseDuration</samp>
| ''(Optional)'' The duration of the open/close animation for the animal door, measured in milliseconds. If omitted, the door switches to the open/closed state instantly.
|-
| <samp>AnimalDoorOpenSound</samp><br /><samp>AnimalDoorCloseSound</samp>
| ''(Optional)'' The sound which is played once each time the animal door is opened/closed. Disabled by default.
|}
</syntaxhighlight>
====Exterior appearance====
{| class="wikitable"
|-
! field
! effect
|-
| <samp>SourceRect</samp>
| ''(Optional)'' The building's pixel area within the <samp>Texture</samp>, specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields. Defaults to the entire texture.
|-
| <samp>Skins</samp>
| ''(Optional)'' The appearances which can be selected from Robin's menu (like stone/plank/log [[cabin]]s), in addition to the default appearance based on <samp>Texture</samp>. This consists of a list of models with these fields:
{| class="wikitable"
|-
! field
! effect
|-
| <samp>Id</samp>
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for the skin.
|-
| <samp>Name</samp><br /><samp>Description</samp>
| [[Modding:Tokenizable strings|Tokenizable strings]] for the skin's display name and description.
|-
| <samp>Texture</samp>
| The asset name for the texture under the game's Content folder.
|-
| <samp>Condition</samp>
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this skin should be available to apply. This doesn't change buildings which already have it applied. Defaults to always true.
|-
| <samp>BuildDays</samp><br /><samp>BuildCost</samp><br /><samp>BuildMaterials</samp>
| ''(Optional)'' If set, overrides the equivalent field in the building data.
|-
| <samp>ShowAsSeparateConstructionEntry</samp>
| ''(Optional)'' Whether this skin should be shown as a separate building option in the construction menu (like cabins). Default false.
|-
| <samp>Metadata</samp>
| ''(Optional)'' Equivalent to the <samp>Metadata</samp> field on the building. Properties defined in this field are added to the building's metadata when this skin is active, overwriting the previous property with the same name if applicable. Default none.
|}
|-
| <samp>FadeWhenBehind</samp>
| ''(Optional)'' Whether the building should become semi-transparent when the player is behind it. Default true.
|-
| <samp>DrawOffset</samp>
| ''(Optional)'' A pixel offset applied to the building sprite's placement in the world. Default 0.
|-
| <samp>SeasonOffset</samp>
| ''(Optional)'' A pixel offset to apply each season. This is applied to the <samp>SourceRect</samp> position by multiplying the offset by 0 (spring), 1 (summer), 2 (fall), or 3 (winter). Default 0, so all seasons use the same source rect.
|-
| <samp>SortTileOffset</samp>
| ''(Optional)'' A Y tile offset applied when figuring out render layering. For example, a value of <samp>2.5</samp> will treat the building as if it was 2.5 tiles further up the screen for the purposes of layering. Default 0.
|-
| <samp>DrawLayers</samp>
| ''(Optional)'' A list of textures to draw over or behind the building, with support for conditions and animations. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>AreaID</samp>
| <samp>Id</samp>
| A unique identifier for the area. The ID should only contain alphanumeric/underscore/dot characters. For custom areas, this should be prefixed with your mod ID like <samp>Example.ModId_AreaName</samp>.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>Group</samp>
| <samp>SourceRect</samp>
| A unique group key shared between all areas drawn on the same map (see [[#Concepts|concepts]]). When the player is in an area for one group, all map areas with a different group key are hidden automatically. The base valley map added by the base game has the group key <samp>SDV</samp>. This should only contain alphanumeric/underscore/dot characters. For custom groups, this should be prefixed with your mod ID like <samp>Example.ModId_GroupName</samp>.
| The pixel area within the <samp>texture</samp> to draw, formatted like <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp>. If the overlay is animated via <samp>FrameCount</samp>, this is the area of the first frame.
|-
| <samp>DrawPosition</samp>
| The tile position at which to draw the top-left corner of the texture, relative to the building's top-left corner tile.
|-
|-
| <samp>Texture</samp>
| <samp>Texture</samp>
| The asset name for the texture to draw when the area is applied to the map.
| ''(Optional)'' The asset name of the texture to draw. Defaults to the building's default <samp>Texture</samp> field.
|-
|-
| <samp>SourceRect</samp>
| <samp>DrawInBackground</samp>
| The pixel area within the <samp>Texture</samp> to draw, formatted like <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp>. Omit this field to make the area invisible (''e.g.,'' to add zones or tooltips without changing the map).
| ''(Optional)'' Whether to draw the texture behind the building sprite (i.e. underlay) instead of over it.
|-
|-
| <samp>DestRect</samp>
| <samp>SortTileOffset</samp>
| The pixel area within the map which is covered by this area, formatted like <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp>.
| ''(Optional)'' A Y tile offset applied when figuring out render layering. For example, a value of <samp>2.5</samp> will treat the texture as if it was 2.5 tiles further up the screen for the purposes of layering. Default 0.
|-
|-
| <samp>Zones</samp>
| <samp>OnlyDrawIfChestHasContents</samp>
| The in-game locations to match with the map. Each zone can provide one or more of the following:
| ''(Optional)'' The ID of a chest defined in the <samp>Chests</samp> field which must contain items. If it's empty, this overlay won't be rendered. Default none.
|-
|-
| <samp>FrameCount</samp><br /><samp>FramesPerRow</samp><br /><samp>FrameDuration</samp>
| ''(Optional)'' If <samp>FrameCount</samp> is more than one, the building overlay will be animated automatically. For each frame, the <samp>SourceRect</samp> will be offset by its <samp>Width</samp> to the right up to <samp>FramesPerRow - 1</samp> times, and then down by its <samp>Height</samp>. Each frame will be rendered on-screen for <samp>FrameDuration</samp> milliseconds before switching to the next frame.
| <samp>ValidAreas</samp>
For example, if you set <samp>FrameCount</samp> to 6 and <samp>FramesPerRow</samp> to 3, the building will expect the frames to be laid out like this in the spritesheet (where frame 1 matches <samp>SourceRect</samp>):
<pre>
┌───┬───┬───┐
│ 1 │ 2 │ 3 │
├───┼───┼───┤
│ 4 │ 5 │ 6 │
└───┴───┴───┘
</pre>
|-
|-
| <samp>DisplayName</samp>
| <samp>AnimalDoorOffset</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] for the scroll text (shown at the bottom of the map when the player is in this area). Defaults to the parent area's <samp>DisplayName</samp>. If this is the exact string <samp>FarmName</samp>, it shows the farm name instead.
| ''(Optional)'' A pixel offset applied to the draw layer when the animal door is open. While the door is opening, the percentage open is applied to the offset (e.g. 50% open = 50% offset).
|}
|}
|-
|-
| <samp>DisplayName</samp>
| <samp>DrawShadow</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] for the tooltip (shown when the mouse is over the area) and scroll (shown at the bottom of the map when the player is in the location). If omitted or empty, the tooltip/scroll isn't shown. Defaults to empty.
| ''(Optional)'' Whether to draw an automatic shadow along the bottom edge of the building's sprite. Default true.
|}
====Interior====
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>DisplayAsUnknown</samp>
| <samp>IndoorMap</samp>
| ''(Optional)'' Whether to replace the tooltip for the area with <samp>???</samp> if the <samp>Condition</samp> isn't met. Default false.
| ''(Optional)'' The name of the map asset under <samp>Maps</samp> to load for the building interior. For example, <samp>"Shed"</samp> will load the [[shed]]'s <samp>Maps/Shed</samp> map.
|-
|-
| <samp>IncludeInGroupDetection</samp>
| <samp>IndoorMapType</samp>
| ''(Optional)'' Whether to use this area when the game is scanning areas to see which group the player is in. If this is false, it will be ignored even if the player is in the area. Default true.
| ''(Optional)'' The full name of the C# location class which will manage the building's interior location. This must be one of the vanilla types to avoid a crash when saving. There are too many to list here, but the most useful types are likely...
* <samp>StardewValley.AnimalHouse</samp>;
* <samp>StardewValley.Locations.Cabin</samp>;
* <samp>StardewValley.Locations.Cellar</samp>;
* <samp>StardewValley.Locations.DecoratableLocation</samp>;
* <samp>StardewValley.Locations.FarmCave</samp>;
* <samp>StardewValley.Locations.FarmHouse</samp>;
* <samp>StardewValley.Shed</samp>;
* and <samp>StardewValley.SlimeHutch</samp>.
Defaults to the generic <samp>StardewValley.GameLocation</samp> class.
|-
| <samp>NonInstancedIndoorLocation</samp>
| ''(Optional)'' The name of the existing global location to treat as the building's interior, like <samp>FarmHouse</samp> and <samp>Greenhouse</samp> for their buildings.
Each location can only be used by one building. If the location is already in use (e.g. because the player has two of this building), each subsequent building will use the <samp>IndoorMap</samp> and <samp>IndoorMapType</samp> instead. For example, the first greenhouse will use the global <samp>Greenhouse</samp> location, and any subsequent greenhouse will use a separate instanced location.
|-
| <samp>MaxOccupants</samp>
| ''(Optional)'' The maximum number of animals who can live in this building.
|-
| <samp>AllowAnimalPregnancy</samp>
| ''(Optional)'' Whether animals can get pregnant and produce offspring in this building. Default false.
|-
| <samp>ValidOccupantTypes</samp>
| ''(Optional)'' A list of building IDs whose animals to allow in this building too. For example, <code>[ "Barn", "Coop" ]</code> will allow [[barn]] and [[coop]] animals in this building. Default none.
|}
|}
====Example====
====Item processing====
{| class="wikitable"
|-
{{#tag:syntaxhighlight|<nowiki>
! field
! effect
|-
| <samp>HayCapacity</samp>
| ''(Optional)'' The amount of hay that can be stored in this building. If built on the [[The Farm|farm]], this works just like [[silo]]s and contributes to the farm's available hay.
|-
| <samp>ItemConversions</samp>
| ''(Optional)'' The item processing rules which take input items and convert them into output items using the inventories defined by <samp>Chests</samp>. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>MineCartCondition</samp>
| <samp>Id</samp>
| A [[#Game state queries|game state query]] which indicates whether minecarts in general are unlocked. You usually shouldn't change this value, unless you're changing the overall game progression (e.g. adding an alternative way to unlock minecart access).
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this rule within the current list.
|-
| <samp>RequiredTags</samp>
| A list of [[Modding:Items#Context tags|context tags]] to match against an input item. An item must have ''all'' of these tags to be accepted.
|-
|-
| <samp>MineCartDestinations</samp>
| <samp>SourceChest</samp>
| The destinations which the player can travel to from any minecart. This consists of a string → model lookup, where the key is a unique destination ID (only containing alphanumeric/underscore/dot characters, with custom entries prefixed with your mod ID like <samp>Example.ModId_DestinationId</samp>), and the value is a model with these fields:
| The ID of the inventory defined in <samp>Chests</samp> from which to take input items.
|-
| <samp>DestinationChest</samp>
| The ID of the inventory defined in <samp>Chests</samp> in which to store output items.
|-
| <samp>ProducedItems</samp>
| The output items produced when an input item is converted. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Location</samp>
| ''common fields''
| The [[#Custom locations|location ID]] for the destination.
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields supported by machine output.
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
|-
|-
| <samp>Tile</samp>
| <samp>Chance</samp>
| The destination tile position within the location, specified as a model with <samp>X</samp> and <samp>Y</samp> fields.
| ''(Optional)'' The probability that the item will be produced, as a value between 0 (never drops) and 1 (always drops). Default 1 (100% chance).
|}
|-
|-
| <samp>Direction</samp>
| <samp>RequiredCount</samp>
| The direction the player should face after arrival (one of <samp>down</samp>, <samp>left</samp>, <samp>right</samp>, or <samp>up</samp>).
| ''(Optional)'' The number of the input item to consume. Default 1.
|-
|-
| <samp>DisplayName</samp>
| <samp>MaxDailyConversions</samp>
| A [[#Tokenizable string format|tokenizable string]] for the destination name shown in the minecart menu. You can use the location's display name with the <samp>LocationName</samp> token (like <code>[LocationName Desert]</code> for the [[desert]]).
| ''(Optional)'' The maximum number of the input item which can be processed each day. Each conversion rule has its own separate maximum (e.g. if you have two rules each with a max of 1, then you can convert one of each daily). Set to -1 to allow unlimited conversions. Default 1.
|}
|-
|-
| <samp>Network</samp>
| <samp>Chests</samp>
| ''(Optional)'' An arbitrary ID which groups the destination (along with any others having the same ID) into a separate network. Destinations in a network are only visible if the destination list is opened for that network via the <samp>MinecartTransport {{o|network name}}</samp> [[Modding:Maps|action property]]. If omitted, the minecart is part of the implicit default network.
| ''(Optional)'' The input/output inventories that can be accessed from a tile on the building exterior. The allowed items are defined by the separate <samp>ItemConversions</samp> field. This is a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>Id</samp>
| A key which uniquely identifies this festival. For custom festivals, the ID should only contain alphanumeric/underscore/dot characters, and should ideally be prefixed with your mod ID like <samp>Example.ModId_FestivalName</samp>.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this chest within the current list.
This is referenced from the <samp>ItemConversions</samp> field.
|-
|-
| <samp>DisplayName</samp>
| <samp>Type</samp>
| A [[#Tokenizable string format|tokenizable string]] for the display name shown on the [[calendar]].
| The inventory type. This must be one of:
* <samp>Chest</samp>: show a normal chest UI on click.
* <samp>Collect</samp>: provides items for the player to collect. Clicking the tile will do nothing (if empty), grab the item directly (if it only contains one item), else show a grab-only inventory UI.
* <samp>Load</samp>: lets the player add items for the building to process.
|-
|-
| <samp>Season</samp>
| <samp>Sound</samp>
| The [[season]] when the festival becomes active.
| ''(Optional)'' The sound to play once when the player clicks the chest.
|-
|-
| <samp>StartDay</samp><br /><samp>EndDay</samp>
| <samp>InvalidItemMessage</samp><br /><samp>InvalidCountMessage</samp><br /><samp>ChestFullMessage</samp>
| The days of month when the festival becomes active.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] to show when the player tries to add an item to the chest when...
* it isn't a supported item;
* it's supported but they don't have enough in their inventory;
* the chest has no more room to accept it.
If omitted, the player interaction is ignored with no message shown.
|-
|-
| <samp>StartTime</samp>
| <samp>InvalidItemMessageCondition</samp>
| The time of day when the festival opens each day.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether <samp>InvalidItemMessage</samp> should be shown. This can use item-related queries like <samp>ITEM_TYPE</samp>. Defaults to always true.
|-
|-
| <samp>StartMessage</samp>
| <samp>DisplayTile</samp>
| A [[#Tokenizable string format|tokenizable string]] for the in-game [[wikipedia:Pop-up notification|toast notification]] shown when the festival begins each day.
| ''(Optional)'' The chest's position on the building exterior, measured in tiles from the top-left corner of the building, specified in the form <samp>"{{t|x}}, {{t|y}}"</samp>. This affects the position of the 'item ready to collect' bubble. If omitted, the bubble is disabled.
|-
|-
| <samp>MapReplacements</samp>
| <samp>DisplayHeight</samp>
| The locations to swap for the duration of the festival. Despite the field name, this swaps '''locations''' (e.g. as added by <samp>CustomLocations</samp> using [[Modding:Content Patcher|Content Patcher]]), and not the location's map asset.
| ''(Optional)'' If <samp>DisplayTile</samp> is set, the chest's tile height like <samp>1.5</samp>.
|}
|}
====Tile interactions====
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>ShowOnCalendar</samp>
| <samp>ActionTiles</samp>
| ''(Optional)'' Whether the festival appears on the [[calendar]], using the same iridium-star icon as the [[Calendar#Winter|Night Market]]. Default true.
| ''(Optional)'' A list of tiles which the player can click to trigger an <samp>Action</samp> [[Modding:Maps|map tile property]]. This consists of a list of models with these fields:
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>Id</samp>
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>{{t|festival ID}}_{{t|festival day}}</samp>
| <samp>Tile</samp>
| Applies on the given date. The {{t|festival day}} is relative, so <samp>1</samp> matches the festival <samp>StartDay</samp>.<br /><small>Example: <samp>NightMarket_3</samp> or <samp>marriage_NightMarket_3</samp></small>
| The tile position, relative to the building's top-left corner tile.
|-
|-
| <samp>{{t|festival ID}}</samp>
| <samp>Action</samp>
| Applies if there's no date-specific entry.<br /><small>Example: <samp>NightMarket</samp> or <samp>marriage_NightMarket</samp></small>
| The [[Modding:Tokenizable strings|tokenizable string]] for the action to perform, excluding the <samp>Action</samp> prefix. For example, <samp>"Dialogue Hi there @!"</samp> to show a messagebox like "''Hi there <player name>!''". The tokenizable string is expected before the action is raised. See the [[Modding:Maps#Tile properties 2|list of tile properties]] for useful <samp>Action</samp> values.
|}
|}
|-
| <samp>DefaultAction</samp>
| ''(Optional)'' The default tile action if the clicked tile isn't in <samp>ActionTiles</samp>. Default none.
|-
| <samp>TileProperties</samp>
| ''(Optional)'' The [[Modding:Maps|map tile properties]] to set. This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! tag
! field
! effect
! effect
|-
|-
| <samp>plantable_greenhouse</samp>
| <samp>Id</samp>
| Can always be planted in a [[greenhouse]] (''i.e.,'' locations with <samp>IsGreenhouse</samp>), regardless of any other context tag.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>plantable_location_{{t|location name}}</samp><br /><samp>not_plantable_location_{{t|location name}}</samp>
| <samp>Name</samp>
| Must or must not be planted in one of these locations. This must be the internal location name (as shown by {{nexus mod|679|Debug Mode}}), lowercase and with any spaces replaced with underscores.
| The tile property name to set.
|-
|-
| <samp>plantable_context_{{t|context ID}}</samp><br /><samp>not_plantable_context_{{t|context ID}}</samp>
| <samp>Value</samp>
| Must or must not be planted in one of these [[#Custom location contexts|location contexts]]. The context ID must be lowercase, with any spaces replaced with underscores.
| ''(Optional)'' The tile property value to set, or omit to set a null value.
|-
|-
| <samp>Layer</samp>
| The name of the map layer whose tiles to change.
|-
|-
| 1
| <samp>TileArea</samp>
| <samp>plantable_greenhouse</samp> matches
| The tiles to which to add the property, relative to the top-left corner of the building's collision box. This is specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields.
| plantable
|}
|-
|-
| <samp>AdditionalTilePropertyRadius</samp>
| <samp>plantable_location_*</samp> matches
| ''(Optional)'' When checking whether the player clicked on a <samp>TileProperties</samp> tile, an added distance around the building at which tile locations may be placed. Default 0, so only tile properties within the normal building bounds will work.
| <samp>not_plantable_location_*</samp> matches<br />''or'' <samp>not_plantable_context_*</samp> matches
|}
|}
====Advanced====
{| class="wikitable"
{| class="wikitable"
|-
|-
! tags
! field
! effect
! effect
|-
|-
|rowspan="4"| ''none''
| <samp>Metadata</samp>
| ''(Optional)'' A list of custom properties applied to the building, which can optionally be overridden per-skin in the <samp>Skins</samp> field. Default none.
|rowspan="4"| default behavior
The base game recognizes these properties:
{| class="wikitable"
|-
|-
! property
! description
|-
|-
| location listed in its context's <samp>DefaultValidPlantableLocations</samp>
| <samp>ChimneyPosition: {{t|x}} {{t|y}}</samp>
| ☑ plantable
| ''(Optional)'' The pixel position at which to place a chimney on the building exterior, relative to the top-left corner of the sprite. This will apply the same logic as the farmhouse chimney (e.g. producing smoke if there's a lit fireplace inside the building).
|-
|-
| [[Bus Stop]]
| <samp>ChimneyPosition{{o|upgrade level}}: {{t|x}} {{t|y}}</samp>
| ☐
| ''(Optional, for farmhouses/cabins only)'' Override <samp>ChimneyPosition</samp> for the given upgrade level, starting from 0 for the initial farmhouse/cabin. If there's no override for the current upgrade level, the highest override for a lower upgrade level is used (if any). For example, <samp>ChimneyPosition3</samp> would be used for the third house upgrade (and the fourth if there's no <samp>ChimneyPosition4</samp>).
|}
This can also contain arbitrary custom properties, which C# mods can read using <samp>building.GetMetadata(key)</samp>.
|-
|-
| <samp>BuildingType</samp>
| [[The Farm|Farm]]
| ''(Optional)'' The full name of the C# type to instantiate for the building instance. Defaults to a generic <samp>Building</samp> instance.
'''⚠ Caution:''' this is meant to support vanilla building types like <samp>StardewValley.Shed</samp>. Setting this to a non-vanilla type will cause a crash when it's written to the save file, and may cause crashes in multiplayer. If you need custom behavior, consider handling it in C# based on the building type instead of creating a custom subclass; otherwise you'll need a framework mod like {{nexus mod|1348|SpaceCore}} to handle serialization and multiplayer sync.
|-
|-
| [[Greenhouse]]
| <samp>ModData</samp>
| ''(Optional)'' A string → string lookup of arbitrary <samp>modData</samp> values to attach to the building when it's constructed.
| overridden by <samp>plantable_greenhouse</samp>
|-
|-
| <samp>CustomFields</samp>
| [[Ginger Island|Island West]]
| The [[#Custom data fields|custom fields]] for this entry.
| ☑ plantable
|}
| matches <samp>plantable_location_islandwest</samp></samp>
|-
===Build anywhere===
| [[Ginger Island|Island South]]
{{/doc status|[[Modding:Blueprint data]] and [[Modding:Maps]]|done=false}}
|rowspan="2"| doesn't match <samp>plantable_location_islandwest</samp></samp>
* You can now allow building construction for any location using the [[#Map/tile property changes|new <samp>CanBuildHere</samp> and related map properties]]. The game will adjust accordingly (e.g. Robin will let you choose where to construct the building).
* Buildings and animals are no longer hardcoded to the [[The Farm|farm]] location (except [[cabin]]s and the [[farmhouse]] which still are).
* Scything hay will now add hay to silos in any location, and animals will be auto-fed from hay in any location.
===Other building changes===
{{/doc status|[[Modding:Blueprint data]]|done=false}}
: ''See also: [[#Other location/map changes|other location changes]] for location-related building changes.''
|rowspan="2"| matches <samp>plantable_context_island</samp>
; General building changes
* Building display names & descriptions are now in <samp>Strings/Buildings</samp> for reuse.
* Removed <samp>Data/Blueprints</samp>. This has been replaced by <samp>Data/Buildings</samp> (building data) and <samp>Strings/Buildings</samp> (display names & descriptions).
<ul>
<li>Added methods to simplify common operations:
{| class="wikitable"
|-
|-
! type
! method
! effect
|-
|-
| [[The Farm|Farm]]
|rowspan="7"| <samp>Building</samp>
| ☐
| <samp>CreateInstanceFromId</samp>
| doesn't match <samp>plantable_context_island</samp>
| Create a building instance from its type ID in <samp>Data/Buildings</samp>. For example:
<syntaxhighlight lang="c#">
Building shippingBin = Building.CreateInstanceFromId("Shipping Bin", Vector2.Zero); // creates an instance of StardewValley.Buildings.ShippingBin
</syntaxhighlight>
|-
|-
|rowspan="3"| <samp>not_plantable_context_island</samp>
| <samp>GetData</samp><br /><samp>TryGetData</samp>
| [[Ginger Island|Island West]]
| Get the data for the building's type from <samp>Data/Building</samp>.
|-
|-
| [[Ginger Island|Island South]]
| <samp>GetMetadata</samp>
| Get a value from [[#Custom buildings|the <samp>Metadata</samp> field in <samp>Data/Buildings</samp>]] for this building.
|-
|-
| [[The Farm|Farm]]
| <samp>GetPaintDataKey</samp>
| Get the key in <samp>Data/PaintData</samp> for this building, if it has any.
| default behavior
|-
|-
| <samp>ReloadBuildingData</samp>
| [[Pelican Town|Town]]
| Apply the latest data in <samp>Data/Buildings</samp> to this building.
|-
|-
| [[The Mountain|Mountain]]
| <samp>FinishConstruction</samp>
| If the building is being constructed or upgrade, instantly finish doing so.
|-
|-
| [[The Farm|Farm]]
| <samp>UpdateTransparency</samp>
| Update the building transparency on tick for the local player's position.
|}
This method mainly exists to let mods override/patch the transparency logic.
|-
|-
| <samp>Farm</samp>
| <samp>GetMainFarmHouse</samp>
| Get the main [[farmhouse]] building.
|-
|-
| <samp>DefaultWarpLocation {{t|x}} {{t|y}}</samp><br />''(valid in any location)''
| <samp>GameLocation</samp>
| The default arrival tile, used when a player or NPC is added to the location without a target tile (e.g. using [[Modding:Console commands|debug commands]] like <samp>debug warp</samp> or <samp>debug eventbyid</samp>).
| <samp>OnParentBuildingUpgraded</samp>
| Called when the building containing this location is upgraded, if applicable.
|}
|}
</li>
</ul>
* Added building <samp>id</samp> field, which uniquely identifies each building in the world.
; [[Junimo Hut|Junimo hut]] changes
* The <samp>JunimoHut.cropHarvestRange</samp> field is now per-building and editable.
; [[Fish Pond|Fish pond]] changes
<ul>
<li>In <samp>Data/FishPondData</samp>, added a <samp>Precedence</samp> field which sets the order in which entries are checked for a match (with lower values checked first). This ensures that the fallback entries are checked after specific fish. For consistency, vanilla entries use these values:
{| class="wikitable"
{| class="wikitable"
|-
|-
! property
! precedence
! explanation
! used for
|-
|-
| <samp>MusicContext {{t|context}}</samp><br />''(valid in any location)''
| 0<br /><small>(default value)</small>
| specific fish
|-
|-
| <samp>MusicIgnoreInRain T²</samp><br />''(valid in any outdoor location)''
| 100
| If set, the <samp>Music</samp> property is ignored when it's raining in this location.
| custom groups (e.g. desert fish)
|-
|-
| <samp>MusicIgnoreInSpring T²</samp><br /><samp>MusicIgnoreInSummer T²</samp><br /><samp>MusicIgnoreInFall T²</samp><br /><samp>MusicIgnoreInWinter T²</samp><br />''(valid in any outdoor location)''
| 500
| If set, the <samp>Music</samp> property is ignored in the given season.
| broad fish type (e.g. ocean fish)
|-
|-
| <samp>MusicIgnoreInFallDebris T²<br />''(valid in any outdoor location)''
| 1000
| If set, the <samp>Music</samp> property is ignored in fall during windy weather.
| fallback (e.g. fish category)
|}
|}
</li>
<li>In <samp>Data/FishPondData</samp>, the reward <samp>ItemId</samp> can now be an [[Modding:Item queries|item query]].</li>
<li>[[Legendary Fish|Legendary fish]] can now be added to [[Fish Pond|fish ponds]] if they have an entry in <samp>Data/FishPondData</samp>.</li>
</ul>
====Crops====
==What's new for NPCs==
{| class="wikitable"
===Custom NPCs===
{{/doc status|[[Modding:NPC data]]|done=false}}
[[Modding:NPC data|Custom NPC data]] has been overhauled in 1.6. The new <samp>Data/Characters</samp> asset (which replaces <samp>Data/NPCDispositions</samp> + <samp>Data/spousePatios</samp> + <samp>Data/spouseRooms</samp>) uses a data model format that's easier to edit and understand, and has a lot of fields to customize previously-hardcoded data.
| <samp>AllowGiantCrops T</samp>
====Format====
This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the NPC like <samp>Example.ModId_NpcName</samp>, which will be used as the internal <samp>Name</samp> (not <samp>DisplayName</samp>).
* The value is a model with the following fields.
====Building construction====
<dl style="margin-left: 2em;">
<dt>Basic info:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! property
! field
! explanation
! effect
|-
|-
| <samp>CanBuildHere T</samp><br />''(valid in any outdoor location)''
| <samp>DisplayName</samp>
| Whether to allow constructing buildings in this location. The game will adjust automatically to account for it (e.g. Robin will let you choose where to build). See [[#Build anywhere|''build anywhere'' in what's new]].
| A [[Modding:Tokenizable strings|tokenizable string]] for the NPC's display name.
|-
|-
| <samp>BuildConditions {{t|query}}</samp><br />''(valid in any outdoor location)''
| <samp>Language</samp>
| ''(Optional)'' The language spoken by the NPC. One of <samp>Default</samp> (the default language understood by the player) or <samp>Dwarvish</samp> (which the player can only understand after finding the [[Dwarvish Translation Guide|Dwarvish translation guide]]). Default <samp>Default</samp>.
|-
|-
| <samp>LooserBuildRestrictions T</samp><br />''(valid in any outdoor location)''
| <samp>Gender</samp>
| ''(Optional)'' The NPC's gender identity. One of <samp>Female</samp>, <samp>Male</samp>, or <samp>Undefined</samp>. Default <samp>Undefined</samp>.
|-
|-
| <samp>ValidBuildRect {{t|x}} {{t|y}} {{t|width}} {{t|height}}</samp><br />''(valid in any outdoor location)''
| <samp>Age</samp>
| ''(Optional)'' The general age of the NPC. One of <samp>Child</samp>, <samp>Teen</samp>, or <samp>Adult</samp>. Default <samp>Adult</samp>.
This affects generated dialogue lines (e.g. a child might say "stupid" and an adult might say "depressing"), generic dialogue (e.g. a child might respond to dumpster diving with "''Eww... What are you doing?''" and a teen would say "''Um... Why are you digging in the trash?''"), and the gift they choose as [[Feast of the Winter Star]] gift-giver. Children are also excluded from item delivery quests.
|-
| <samp>Manner</samp>
| ''(Optional)'' A measure of the character's general politeness, which affects some generic dialogue lines. One of <samp>Neutral</samp>, <samp>Polite</samp>, or <samp>Rude</samp>. Default <samp>Neutral</samp>.
|-
|-
| <samp>SocialAnxiety</samp>
| ''(Optional)'' A measure of the character's comfort with social situations, which affects some generic dialogue lines. One of <samp>Neutral</samp>, <samp>Outgoing</samp>, or <samp>Shy</samp>. Default <samp>Neutral</samp>.
|-
|-
| <samp>Buildings</samp>
| <samp>Optimism</samp>
| <samp>Action BuildingSilo</samp>
| ''(Optional)'' A measure of the character's overall optimism. One of <samp>Neutral</samp>, <samp>Negative</samp>, or <samp>Positive</samp>. Default <samp>Neutral</samp>.
|-
|-
| <samp>Buildings</samp>
| <samp>BirthSeason</samp>
| <samp>Action BuildingToggleAnimalDoor</samp>
| ''(Optional if non-social)'' The season name (case-sensitive) for the NPC's birthday. One of <samp>spring</samp>, <samp>summer</samp>, <samp>fall</samp>, or <samp>winter</samp>. Default none.
|-
|-
| <samp>Buildings</samp>
| <samp>BirthDay</samp>
| <samp>Action Forge</samp>
| ''(Optional if non-social)'' The day number for the NPC's birthday. Default 0.
|-
|-
| <samp>Buildings</samp>
| <samp>HomeRegion</samp>
| <samp>Action ObeliskWarp {{t|location name}} {{t|x}} {{t|y}} {{o|whether to dismount}}</samp>
| ''(Optional)'' The region of the world in which the NPC lives (one of <samp>Desert</samp>, <samp>Town</samp>, or <samp>Other</samp>). For example, only <samp>Town</samp> NPCs are counted for the introductions [[Quests#List of Story Quests|quest]], can be selected as a secret santa for the [[Feast of the Winter Star]], or get a friendship boost from the [[Luau]]. Default <samp>Other</samp>.
| Warps the player to the specified location name and position with the [[Warp Totem|Obelisk]] animation/sound effects.
|-
|-
| <samp>Buildings</samp>
| <samp>IsDarkSkinned</samp>
| <samp>Action OpenShop {{t|shop id}} {{o|from direction}} {{o|open time}} {{o|close time}} {{o|owner tile area}}</samp>
| ''(Optional)'' Whether the NPC has dark skin, which affects the chance of children with the player having dark skin too. Default false.
|}
|}
</li>
</dd>
<dt>Social features:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>CanSocialize</samp>
| A key which uniquely identifies this building. This should match the asset key. The ID should only contain alphanumeric/underscore/dot characters, and should ideally be prefixed with your mod ID like <samp>Example.ModId_BuildingName</samp>.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether to enable social features (like birthdays, gift giving, [[friendship]], and an entry in the social tab). Default true.
|-
|-
| <samp>Name</samp><br /><samp>Description</samp>
| <samp>CanBeRomanced</samp>
| A [[#Tokenizable string format|tokenizable string]] for the display name and description (e.g. shown in the construction menu).
| ''(Optional)'' Whether the NPC can be dated and romanced. This enables romance features for this NPC (like a 'single' label in the social menu, bouquet gifting, and marriage). Default false.
|-
|-
| <samp>Texture</samp>
| <samp>CanReceiveGifts</samp>
| The asset name for the texture under the game's Content folder.
| ''(Optional)'' Whether players can give gifts to this NPC. Default true.
The NPC must also be social per <samp>CanSocialize</samp> and have an entry in <samp>Data/NPCGiftTastes</samp> to be giftable, regardless of this value.
|-
| <samp>CanCommentOnPurchasedShopItems</samp>
| ''(Optional)'' Whether this NPC can comment on items that a player sold to a shop which then resold it to them. If null (or omitted), this will default to true if their <samp>HomeRegion</samp> is set to <samp>Town</samp>.
The NPC must also be social per <samp>CanSocialize</samp> to allow it, regardless of this value.
|-
|-
| <samp>CanGreetNearbyCharacters</samp>
| ''(Optional)'' Whether this NPC can show a speech bubble greeting nearby players or NPCs, and or be greeted by other NPCs. Default true.
|-
|-
| <samp>Builder</samp>
| <samp>CanVisitIsland</samp>
| ''(Optional)'' The NPC from whom you can request construction. The vanilla values are [[Carpenter's Shop|<samp>Robin</samp>]] and [[Wizard's Tower#Buildings|<samp>Wizard</samp>]], but you can specify a different name if a C# mod opens a construction menu for them. Defaults to <samp>Robin</samp>. If omitted, it won't appear in any menu.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the NPC can visit the [[Ginger Island]] resort once it's unlocked. Default true.
The NPC must also be social per <samp>CanSocialize</samp> to visit the island, regardless of this value.
|-
|-
| <samp>BuildCost</samp>
| <samp>LoveInterest</samp>
| ''(Optional)'' The gold cost to construct the building. Defaults to {{price|0}}.
| ''(Optional)'' Unused.
|-
|-
| <samp>BuildMaterials</samp>
| <samp>Calendar</samp>
| ''(Optional)'' The materials you must provide to start construction, as a list of models with these fields:
| ''(Optional)'' Determines when the NPC's birthday is shown in the [[calendar]]. Possible values:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! value
! effect
! effect
|-
|-
| <samp>ItemId</samp>
| <samp>HiddenAlways</samp>
| The required item ID (qualified or unqualified).
| They never appear in the calendar.
|-
| <samp>HiddenUntilMet</samp>
| Until the player meets them, they don't appear in the calendar.
|-
|-
| <samp>Amount</samp>
| <samp>AlwaysShown</samp>
| The number of the item required.
| They always appear in the calendar.
|}
|}
Defaults to <samp>AlwaysShown</samp>.
|-
|-
| <samp>BuildDays</samp>
| <samp>SocialTab</samp>
| ''(Optional)'' The number of days needed to complete construction (e.g. <samp>1</samp> for a building completed the next day). If set to 0, construction finishes instantly. Defaults to 0.
| ''(Optional)'' Determines how the NPC is shown on the [[friendship|social tab]] when unlocked. Possible values:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! value
! effect
! effect
|-
|-
| <samp>Tile</samp>
| <samp>HiddenAlways</samp>
| The tile position relative to the top-left corner of the building, specified as an object with <samp>X</samp> and <samp>Y</samp> fields.
| They never appear in the social tab.
|-
|-
| <samp>IndoorItems</samp>
| <samp>HiddenUntilMet</samp>
| ''(Optional)'' The items to place in the building interior when it's constructed or upgraded. This consists of a list of models with these fields:
| Until the player meets them, they don't appear on the social tab.
|-
|-
| <samp>UnknownUntilMet</samp>
| Until the player meets them, their name on the social tab is replaced with "???".
|-
|-
| <samp>ItemId</samp>
| <samp>AlwaysShown</samp>
| The [[#Custom items|qualified item ID]] for the item to place.
| They always appear in the social tab (including their name).
|}
|}
Defaults to <samp>UnknownUntilMet</samp>.
|-
|-
| <samp>MagicalConstruction</samp>
| <samp>SpouseAdopts</samp>
| ''(Optional)'' Whether the building is magical. This changes the carpenter menu to a mystic theme while this building's blueprint is selected, and completes the construction instantly when placed.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the player will need to adopt children with this spouse, instead of either the player or NPC giving birth. If null, defaults to true for same-gender and false for opposite-gender spouses.
The <samp>Target</samp> player is the one they're married to.
|-
|-
| <samp>AddMailOnBuild</samp>
| <samp>SpouseWantsChildren</samp>
| ''(Optional)'' A list of [[Modding:Mail data|letter IDs]] to send to all players when the building is constructed for the first time.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the spouse will ask to have children. Defaults to true.
The <samp>Target</samp> player is the one they're married to.
|-
|-
| <samp>SpouseGiftJealousy</samp>
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the [[Marriage#Jealousy|spouse will get jealous of gifts to other NPCs]]. Defaults to true.
The <samp>Target</samp> player is the one they're married to, and the <samp>Target</samp> item is the one that was gifted.
|-
|-
| <samp>BuildingToUpgrade</samp>
| <samp>SpouseGiftJealousyFriendshipChange</samp>
| ''(Optional)'' The ID of the building for which this is an upgrade, or omit to allow constructing it as a new building. For example, the [[Coop|Big Coop]] sets this to <samp>"Coop"</samp>. Any numbers of buildings can be an upgrade for the same building, in which case the player can choose one upgrade path.
| ''(Optional)'' The [[Friendship|friendship point]] effect when the <samp>SpouseGiftJealously</samp> is triggered. Default -30.
|-
|-
| <samp>IndoorItemMoves</samp>
| <samp>SpouseRoom</samp>
| ''(Optional)'' When applied as an upgrade to an existing building, the placed items in its interior to move when transitioning to the new map. This is a list of models with these fields:
| ''(Optional)'' The [[Marriage#Spouse Rooms|NPC's spouse room]] in the farmhouse when the player marries them, if applicable. If this is omitted for a marriageable NPC, they'll use Abigail's spouse room by default.
This consists of a model with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Source</samp>
| <samp>MapAsset</samp>
| The tile position on which any item will be moved.
| ''(Optional)'' The asset name for the spouse room map. The <samp>Map/</samp> prefix is added automatically and shouldn't be included. Defaults to <samp>spouseRooms</samp>.
|-
|-
| <samp>Destination</samp>
| <samp>MapSourceRect</samp>
| The tile position to which to move the item.
| ''(Optional)'' The tile area within the <samp>MapAsset</samp> containing the spouse's room. This should usually be a 6x9 tile area, though the game will try to adjust to a different size. Specified as a model with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields. Defaults to <samp>(0, 0, 6, 9)</samp>.
|}
|}
|-
|-
| <samp>UpgradeSignTile</samp>
| <samp>SpousePatio</samp>
| ''(Optional)'' The tile position relative to the top-left corner of the building where the upgrade sign will be placed when Robin is building an upgrade, in the form <samp>"{{t|x}}, {{t|y}}"</samp>. Defaults to approximately <samp>"5, 1"</samp> if the building interior type is <samp>Shed</samp>, else <samp>"0, 0"</samp>.
| ''(Optional)'' The [[Marriage#Spouse Outside Area|NPC's patio area]] on the farm when the player marries them, if any. Default none.
This consists of a model with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Size</samp>
| <samp>MapAsset</samp>
| ''(Optional)'' The building's width and height when constructed, measured in tiles. Defaults to a 1 x 1 area.
| ''(Optional)'' The asset name for the patio area. The <samp>Map/</samp> prefix is added automatically and shouldn't be included. Defaults to <samp>spousePatios</samp>.
|-
| <samp>MapSourceRect</samp>
| ''(Optional)'' The tile area within the <samp>MapAsset</samp> containing the spouse's patio area. This must be a 4x4 tile area. Specified as a model with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields. Defaults to <samp>(0, 0, 4, 4)</samp>.
|-
|-
| <samp>CollisionMap</samp>
| <samp>SpriteAnimationFrames</samp>
| ''(Optional)'' An ASCII text block which indicates which of the building's tiles the players can walk onto, where each character can be <samp>X</samp> (blocked) or <samp>O</samp> (passable). Defaults to all tiles blocked.
| ''(Optional)'' The spouse's animation frames when they're in the patio. Each frame is an array containing [0] the sprite index in their spritesheet, and [1] the optional duration in milliseconds (default 100). If omitted or empty, the NPC won't be animated.
For example, a [[stable]] covers a 2x4 tile area with the front two tiles passable:
For example, here is Abigail playing the flute:
<syntaxhighlight lang="js">
<syntaxhighlight lang="js">
"SpriteAnimationFrames": [
"CollisionMap": "XXXX\nXOOX"
[16, 500], // show index 16 for 500ms
[17, 500],
// multi-line with optional indentation
[18, 500],
[19] // if duration is omitted, defaults to 100ms
]
</syntaxhighlight>
</syntaxhighlight>
|-
|-
| <samp>HumanDoor</samp>
| <samp>SpriteAnimationPixelOffset</samp>
| ''(Optional)'' The position of the door that can be clicked to warp into the building interior. This is measured in tiles relative to the top-left corner tile. Defaults to disabled.
| ''(Optional)'' The pixel offset to apply to the NPC's sprite when they're animated in the patio, specified as a model with <samp>X</samp> and <samp>Y</samp> fields. This is ignored if the NPC isn't animated via <samp>SpriteAnimationFrames</samp>. Default none.
|}
|-
|-
| <samp>AnimalDoor</samp>
| <samp>SpouseFloors</samp><br /><samp>SpouseWallpapers</samp>
| ''(Optional)'' The position and size of the door that animals use to enter/exit the building, if the building interior is an animal location, specified in the form <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp>. This is measured in tiles relative to the top-left corner tile. Defaults to disabled.
| ''(Optional)'' The floors and wallpapers which the NPC may randomly apply to the farmhouse when married to the player. If omitted or empty, the NPC will randomly choose a base floor (0–39) or wallpaper (0–111).
|-
|-
| <samp>AnimalDoorOpenDuration</samp><br /><samp>AnimalDoorCloseDuration</samp>
| <samp>IntroductionsQuest</samp>
| ''(Optional)'' The duration of the open/close animation for the animal door, measured in milliseconds. If omitted, the door switches to the open/closed state instantly.
| ''(Optional)'' Whether to include this NPC in [[Quests#List of Story Quests|the ''introductions'' quest]]. If <samp>null</samp> (or omitted), this will default to true if the <samp>HomeRegion</samp> field is set to <samp>Town</samp>.
|-
|-
| <samp>AnimalDoorOpenSound</samp><br /><samp>AnimalDoorCloseSound</samp>
| <samp>ItemDeliveryQuests</samp>
| ''(Optional)'' The sound which is played once each time the animal door is opened/closed. Disabled by default.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this NPC can give item delivery quests. If <samp>null</samp> (or omitted), this will default to true if the <samp>HomeRegion</samp> field is set to <samp>Town</samp>.
The NPC must also be social per <samp>CanSocialize</samp> to allow it, regardless of this value.
|-
|-
| <samp>PerfectionScore</samp>
| ''(Optional)'' Whether to include this NPC when checking whether the player has max friendships with every NPC for the perfection score. Default true.
The NPC must also be social per <samp>CanSocialize</samp> to be counted, regardless of this value.
|-
|-
| <samp>SourceRect</samp>
| <samp>EndSlideShow</samp>
| ''(Optional)'' The building's pixel area within the <samp>Texture</samp>, in the form <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp> (like <samp>"0 0 112 128"</samp>). Defaults to the entire texture.
| ''(Optional)'' How the NPC appears in the end-game perfection slide show. Possible values:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! value
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>Hidden</samp>
| A key which uniquely identifies the skin. The ID should only contain alphanumeric/underscore/dot characters. For custom skins, it should be prefixed with your mod ID like <samp>Example.ModId_SkinName</samp>.
| The NPC doesn't appear in the slide show.
|-
|-
| <samp>Name</samp><br /><samp>Description</samp>
| <samp>MainGroup</samp>
| [[#Tokenizable string format|Tokenizable strings]] for the skin's display name and description.
| The NPC is added to the main group of NPCs which walk across the screen.
|-
|-
| <samp>Texture</samp>
| <samp>TrailingGroup</samp>
| The asset name for the texture under the game's Content folder.
| The NPC is added to the trailing group of NPCs which follow the main group.
|}
Defaults to <samp>MainGroup</samp>.
|-
|-
| <samp>Metadata</samp>
| <samp>FriendsAndFamily</samp>
| ''(Optional)'' Equivalent to the <samp>Metadata</samp> field on the building. Properties defined in this field are added to the building's metadata when this skin is active, overwriting the previous property with the same name if applicable. Default none.
| ''(Optional)'' The NPC's closest friends and family, as a dictionary where the key is the other NPC's internal name and the value is an optional tokenizable string for the name to use in dialogue text (like 'mom'). Default none.
This affects generic dialogue for revealing likes and dislikes to family members, and may affect <samp>inlaw_<NPC></samp> dialogues. This isn't necessarily comprehensive.
|}
|}
</dd>
<dt>Dumpster diving:</dt>
<dd>
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>DrawOffset</samp>
| <samp>DumpsterDiveEmote</samp>
| ''(Optional)'' A pixel offset applied to the building sprite's placement in the world. Default 0.
| ''(Optional)'' The emote ID to show above the NPC's head when they see a player rummaging through trash. See [[Modding:event data#Emotes|emote IDs]]. If omitted or <samp>null</samp>, the default depends on the NPC's age: a child will show sad (28), a teen will show a question mark (8), and an adult will show angry (12).
|-
|-
| <samp>SeasonOffset</samp>
| <samp>DumpsterDiveFriendshipEffect</samp>
| ''(Optional)'' A pixel offset to apply each season. This is applied to the <samp>SourceRect</samp> position by multiplying the offset by 0 (spring), 1 (summer), 2 (fall), or 3 (winter). Default 0, so all seasons use the same source rect.
| ''(Optional)'' The friendship point change if this NPC sees a player rummaging through trash. Default -25.
|-
|}</dd>
<dt>Festivals:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>SourceRect</samp>
| <samp>FlowerDanceCanDance</samp>
| The pixel area within the <samp>texture</samp> to draw, formatted like <samp>"{{t|x}} {{t|y}} {{t|width}} {{t|height}}"</samp>. If the overlay is animated via <samp>FrameCount</samp>, this is the area of the first frame.
| ''(Optional)'' Whether players can ask the NPC to dance at the Flower Dance festival. The possible values are <samp>true</samp> (can always ask), <samp>false</samp> (can never ask), or <samp>null</samp> (can ask if they're romanceable). Default <samp>null</samp>.
If the NPC can dance, you should also add the [[Modding:NPC data#Overworld_sprites|dance sprite frames]] and <samp>FlowerDance_Decline</samp> [[Modding:Dialogue|dialogue text]]. You can optionally set the <samp>FlowerDance_Accept</samp> dialogue too (though NPCs have a default accept dialogue if not).
|-
|-
| <samp>DrawPosition</samp>
| <samp>WinterStarParticipant</samp>
| The tile position at which to draw the top-left corner of the texture, relative to the building's top-left corner tile.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this NPC can give and receive gifts at the [[Feast of the Winter Star]]. If <samp>null</samp> (or omitted), this will default to true if the <samp>HomeRegion</samp> field is set to <samp>Town</samp>.
|-
|-
| <samp>Texture</samp>
| <samp>WinterStarGifts</samp>
| ''(Optional)'' The asset name of the texture to draw. Defaults to the building's default <samp>Texture</samp> field.
| At the [[Feast of the Winter Star]], the possible gifts this NPC can give to players. A matching entry is selected at random.
This consists of a list of models with these fields:
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| ''common fields''
| ''(Optional)'' A Y tile offset applied when figuring out render layering. For example, a value of <samp>2.5</samp> will treat the texture as if it was 2.5 tiles further up the screen for the purposes of layering. Default 0.
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields.
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
|}
|}
<dt>Spawn rules:</dt>
<dd>
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>FrameCount</samp><br /><samp>FramesPerRow</samp><br /><samp>FrameDuration</samp>
| <samp>UnlockConditions</samp>
| ''(Optional)'' If <samp>FrameCount</samp> is more than one, the building overlay will be animated automatically. For each frame, the <samp>SourceRect</samp> will be offset by its <samp>Width</samp> to the right up to <samp>FramesPerRow - 1</samp> times, and then down by its <samp>Height</samp>. Each frame will be rendered on-screen for <samp>FrameDuration</samp> milliseconds before switching to the next frame.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the NPC should be added to the world, checked when loading a save and when ending each day. This only affects whether the NPC is added when missing; returning false won't remove an NPC that's already been added. Defaults to true.
|-
|-
| <samp>AnimalDoorOffset</samp>
| <samp>SpawnIfMissing</samp>
| ''(Optional)'' A pixel offset applied to the draw layer when the animal door is open. While the door is opening, the percentage open is applied to the offset (e.g. 50% open = 50% offset).
| ''(Optional)'' Whether to add this NPC to the world if they're missing (if the <samp>UnlockConditions</samp> match and <samp>HomeLocation</samp> is valid). Default true.
|-
|-
| <samp>DrawShadow</samp>
| <samp>Home</samp>
| ''(Optional)'' Whether to draw an automatic shadow along the bottom edge of the building's sprite. Default true.
| ''(Optional)'' The default place where this NPC spawns and returns each day. If there are multiple entries, the first matching one is used.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>IndoorMap</samp>
| <samp>ID</samp>
| ''(Optional)'' The name of the map asset under <samp>Maps</samp> to load for the building interior. For example, <samp>"Shed"</samp> will load the [[shed]]'s <samp>Maps/Shed</samp> map.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
| <samp>Location</samp>
| ''(Optional)'' The internal name for the home location where this NPC spawns and returns each day. Default none.
|-
|-
| <samp>IndoorMapType</samp>
| <samp>Tile</samp>
| ''(Optional)'' The full name of the C# location class which will manage the building's interior location. This must be one of the vanilla types to avoid a crash when saving. There are too many to list here, but the most useful types are likely...
| ''(Optional)'' The tile position within the home location where this NPC spawns and returns each day. Specified as a model with <samp>X</samp> and <samp>Y</samp> fields. Defaults to <samp>(0, 0)</samp>.
Defaults to the generic <samp>StardewValley.GameLocation</samp> class.
|-
|-
| <samp>NonInstancedIndoorLocation</samp>
| <samp>Direction</samp>
| ''(Optional)'' The name of the existing global location to treat as the building's interior, like <samp>FarmHouse</samp> and <samp>Greenhouse</samp> for their buildings.
| ''(Optional)'' The default direction the NPC faces when they start each day. The possible values are <samp>down</samp>, <samp>left</samp>, <samp>right</samp>, and <samp>up</samp>. Defaults to <samp>up</samp>.
|-
|-
| <samp>MaxOccupants</samp>
| <samp>Condition</samp>
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry can be selected. Default true.
|}
| ''(Optional)'' A list of building IDs whose animals to allow in this building too. For example, <code>[ "Barn", "Coop" ]</code> will allow [[barn]] and [[coop]] animals in this building. Default none.
|}
|}
</dd>
<dt>Appearance & sprite:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>HayCapacity</samp>
| <samp>TextureName</samp>
| ''(Optional)'' The amount of hay that can be stored in this building. If built on the [[The Farm|farm]], this works just like [[silo]]s and contributes to the farm's available hay.
| ''(Optional)'' The '''last segment''' of the NPC's portrait and sprite asset names. For example, set to <samp>Abigail</samp> to use <samp>Portraits/Abigail</samp> and <samp>Characters/Abigail</samp> respectively. Defaults to the internal NPC name.
|-
|-
| <samp>ItemConversions</samp>
| <samp>Appearance</samp>
| ''(Optional)'' The item processing rules which take input items and convert them into output items using the inventories defined by <samp>Chests</samp>. This consists of a list of models with these fields:
| ''(Optional)'' The portrait/sprite textures to use.
This can list any number of appearance options. They'll be sorted by <samp>Precedence</samp> value (with lower values taking priority), then filtered to those whose fields match. If multiple matching appearances have precedence, one entry is randomly chosen based on their relative weight. This randomization is stable per day, so the NPC always makes the same choice until the next day. If a portrait/sprite can't be loaded (or no appearances match), the NPC will use the default asset based on <samp>TextureName</samp>.
The NPC rechecks this field each time they change location.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>RequiredTags</samp>
| <samp>Id</samp>
| A list of [[Modding:Items#Context tags|context tags]] to match against an input item. An item must have ''all'' of these tags to be accepted.
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the current list.
|-
|-
| <samp>SourceChest</samp>
| <samp>Season</samp>
| The name of the inventory defined in <samp>Chests</samp> from which to take input items.
| ''(Optional)'' The season in which this appearance should be used (one of <samp>spring</samp>, <samp>summer</samp>, <samp>fall</samp>, or <samp>winter</samp>), or omit for any season. Defaults to any season.
|-
|-
| <samp>DestinationChest</samp>
| <samp>Indoors</samp><br /><samp>Outdoors</samp>
| ''(Optional)'' Whether this appearance should be used when indoors and/or outdoors. Both default to true.
|-
|-
| <samp>ProducedItems</samp>
| <samp>Condition</samp>
| The output items produced when an input item is converted. This consists of a list of models with these fields:
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this entry can be selected. Default true.
|-
|-
| <samp>Portrait</samp><br /><samp>Sprite</samp>
| ''(Optional)'' The asset name for the portraits and/or sprites texture to load. If omitted or it can't be loaded, it will default to the default asset per the <samp>Texture</samp> field.
|-
|-
| <samp>ItemId</samp>
| <samp>IsIslandAttire</samp>
| The [[#Custom items|qualified item ID]].
| ''(Optional)'' Whether this is island beach attire worn at the resort. Default false.
This is mutually exclusive: NPCs will never wear it in other contexts if it's true, and will never wear it as island attire if it's false.
|-
|-
| <samp>MinCount</samp><br /><samp>MaxCount</samp>
| <samp>Precedence</samp>
| The minimum/maximum number of the item to produce.
| ''(Optional)'' The order in which this entry should be checked, where lower values are checked first. This can be a negative value. Default 0.
|-
|-
| <samp>Chance</samp>
| <samp>Weight</samp>
| ''(Optional)'' The probability that the item will be produced, as a value between 0 (never drops) and 1 (always drops). This has no effect on other output items (e.g. if there are ten outputs with 100% chance, all ten will be produced). Default 1 (100% chance).
| ''(Optional)'' If multiple entries with the same <samp>Precedence</samp> match, the relative weight to use when randomly choosing one. Default 1.
For example, let's say two appearance entries match: one has a weight of 2, and the other has a weight of 1. Their probability of being chosen is 2/3 and 1/3 respectively.
|}
'''Note:''' the default textures based on <samp>TextureName</samp> must still exist, even if you use this field to override them.
|-
| <samp>MugShotSourceRect</samp>
| ''(Optional)'' The 16x24-pixel area in the character's sprite texture to show as their mug shot icon in the calendar, social menu, and other contexts. Defaults to part of their first sprite.
|-
| <samp>Size</samp>
| ''(Optional)'' The pixel size of the individual sprites in their overworld sprite spritesheet. Specified as a model with <samp>X</samp> and <samp>Y</samp> fields. Defaults to <samp>(16, 32)</samp>.
'''Note:''' sizes bigger than 16×32 will cause issues like broken spawning, pathfinding, misalignment in the [[perfection]] end-game slide show, etc.
|-
|-
| <samp>Condition</samp>
| <samp>Breather</samp>
| ''(Optional)'' If set, the output is only available if the given [[#Game state queries|game state query]] is true.
| ''(Optional)'' Whether the chest on the NPC's overworld sprite puffs in and out as they breathe. Default true</samp>.
|-
|-
| <samp>RequiredCount</samp>
| <samp>BreathChestRect</samp>
| ''(Optional)'' The number of the input item to consume. Default 1.
| ''(Optional)'' A [[Modding:Common data field types#Rectangle|rectangle]] pixel area within the spritesheet which expands and contracts to simulate breathing, relative to the top-left corner of the source rectangle for their current sprite. Omit to calculate it automatically. This should be omitted for most NPCs, unless they have a non-standard size.
|-
|-
| <samp>MaxDailyConversions</samp>
| <samp>BreathChestPosition</samp>
| ''(Optional)'' The maximum number of the input item which can be processed each day. Each conversion rule has its own separate maximum (e.g. if you have two rules each with a max of 1, then you can convert one of each daily). Set to -1 to allow unlimited conversions. Default 1.
| ''(Optional)'' A [[Modding:Common data field types#Point|point]] pixel offset to apply to the NPC's <samp>BreathChestPosition</samp> when drawn over the NPC. Omit to calculate it automatically. This should be omitted for most NPCs, unless they have a non-standard size.
|-
|-
| <samp>Chests</samp>
| <samp>Shadow</samp>
| ''(Optional)'' The input/output inventories that can be accessed from a tile on the building exterior. The allowed items are defined by the separate <samp>ItemConversions</samp> field. This is a list of models with these fields:
| ''(Optional)'' The options for the shadow to draw under the NPC, or omit to apply the default shadow behavior.
This consists of a model with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Name</samp>
| <samp>Visible</samp>
| A name for this chest, referenced from the <samp>ItemConversions</samp> field. Each chest must have a unique name within one building's chest list (but they don't need to be globally unique).
| ''(Optional)'' Whether the shadow should be drawn. Default true.
|-
| <samp>Offset</samp>
| ''(Optional)'' A [[Modding:Common data field types#Point|point]] pixel offset applied to the shadow position. Default zero.
|-
|-
| <samp>Type</samp>
| <samp>Scale</samp>
| The inventory type. This must be one of:
| ''(Optional)'' The scale at which to draw the shadow. Default 1.
This is a multiplier applied to the default shadow scale, which can change based on factors like whether the NPC is jumping. For example, <samp>0.5</samp> means half the size it'd be drawn if you didn't specify a scale.
|}
|-
|-
| <samp>Sound</samp>
| <samp>EmoteOffset</samp>
| ''(Optional)'' The sound to play once when the player clicks the chest.
| ''(Optional)'' A [[Modding:Common data field types#Point|point]] pixel offset applied to emote drawn over the NPC. Default zero.
|-
|-
| <samp>InvalidItemMessage</samp><br /><samp>InvalidCountMessage</samp><br /><samp>ChestFullMessage</samp>
| <samp>ShakePortraits</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] to show when the player tries to add an item to the chest when...
| ''(Optional)'' The portrait indexes which should shake when displayed. Default none.
|-
|-
| <samp>DisplayTile</samp>
| <samp>KissSpriteIndex</samp>
| ''(Optional)'' The chest's position on the building exterior, measured in tiles from the top-left corner of the building, specified in the form <samp>"{{t|x}}, {{t|y}}"</samp>. This affects the position of the 'item ready to collect' bubble. If omitted, the bubble is disabled.
| ''(Optional)'' If the NPC can be married, the sprite index within their <samp>Texture</samp> to use when kissing a player. Default 28.
|-
|-
| <samp>DisplayHeight</samp>
| <samp>KissSpriteFacingDirection</samp>
| ''(Optional)'' If <samp>DisplayTile</samp> is set, the chest's tile height like <samp>1.5</samp>.
| ''(Optional)'' Whether the character is facing right (true) or left (false) in their <samp>KissSpriteIndex</samp>. The sprite will be flipped as needed to face the player. Default true.
|}
|}
</dd>
<dt>[[Secrets#Gift Log|Hidden gift log emote]]:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>ActionTiles</samp>
| <samp>HiddenProfileEmoteSound</samp>
| ''(Optional)'' A list of tiles which the player can click to trigger an <samp>Action</samp> [[Modding:Maps|map tile property]]. This consists of a list of models with these fields:
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the [[#Custom audio|cue ID]] for the sound played when clicking the sprite. Defaults to <samp>drumkit6</samp>.
|-
| <samp>HiddenProfileEmoteDuration</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], how long the animation plays measured in milliseconds. Defaults to 4000 (4 seconds).
|-
|-
| <samp>HiddenProfileEmoteStartFrame</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the index within the NPC's overworld sprite spritesheet at which the animation starts. If omitted for a vanilla NPC, the game plays a default animation specific to that NPC; if omitted for a custom NPC, the game just shows them walking while facing down.
|-
|-
| <samp>Tile</samp>
| <samp>HiddenProfileEmoteFrameCount</samp>
| The tile position, relative to the building's top-left corner tile.
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the number of frames in the animation. The first frame corresponds to <samp>HiddenProfileEmoteStartFrame</samp>, and each subsequent frame will use the next sprite in the spritesheet. Default 1.
This has no effect if <samp>HiddenProfileEmoteStartFrame</samp> isn't set.
|-
|-
| <samp>Action</samp>
| <samp>HiddenProfileEmoteFrameDuration</samp>
| The [[#Tokenizable string format|tokenizable string]] for the action to perform, excluding the <samp>Action</samp> prefix. For example, <samp>"Dialogue Hi there @!"</samp> to show a messagebox like "''Hi there <player name>!''". The tokenizable string is expected before the action is raised. See the [[Modding:Maps#Tile properties 2|list of tile properties]] for useful <samp>Action</samp> values.
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], how long each animation frame is shown on-screen before switching to the next one, measured in milliseconds. Default 200.
This has no effect if <samp>HiddenProfileEmoteStartFrame</samp> isn't set.
|}
|}
</dd>
<dt>Advanced:</dt>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>LayerName</samp>
| <samp>CustomFields</samp>
| The name of the map layer whose tiles to change.
| The [[#Custom data fields|custom fields]] for this entry.
|-
|-
| <samp>Tiles</samp>
| <samp>FormerCharacterNames</samp>
| ''(Optional)'' The former NPC names which may appear in save data. If matched, the game will rename the NPC and update related data (e.g. friendship).
A former name is only applied if:
# it doesn't match a current ID in <samp>Data/Characters</samp>;
# the save has an NPC with the former name;
# the save doesn't already have an NPC with the new name.
For example:
<syntaxhighlight lang="js">
"FormerCharacterNames": [ "SomeOldName" ]
</syntaxhighlight>
| ''(Optional)'' The tile property value to set, or omit to set a null value.
Former names can have any format, but they must be '''globally''' unique. They can't match the ID or <samp>FormerCharacterNames</samp> of any other NPC in <samp>Data/Characters</samp> (whether vanilla or custom).
|-
|-
| <samp>FestivalVanillaActorIndex</samp>
| ''(Optional, Specialized)'' The NPC's index in the <samp>Maps/characterSheet</samp> tilesheet, if applicable. This is used for placing vanilla NPCs in festivals from the map; custom NPCs should use the <samp><layer>_additionalCharacters</samp> field in the festival data instead.
| <samp>Metadata</samp>
| ''(Optional)'' A list of custom properties applied to the building, which can optionally be overridden per-skin in the <samp>Skins</samp> field. Default none.
|}
|}
</dd>
</dl>
====Examples====
For example, this content pack adds a new ''Amabel'' NPC with full social features:
{{#tag:syntaxhighlight|<nowiki>
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
{
"Action": "EditData",
"Target": "Data/Characters",
|}
"Entries": {
"{{ModId}}_Amabel": {
"DisplayName": "Amabel", // this would normally use {{i18n:}} to support translations
"BirthSeason": "Fall",
"BirthDay": 14,
"HomeRegion": "Town",
"Gender": "Female",
"Age": "Teen",
"Manner": "Rude",
"SocialAnxiety": "Outgoing",
"Optimism": "Neutral",
"CanBeRomanced": true,
"LoveInterest": "Abigail",
"Home": [
{
"Id": "Default",
"Location": "SeedShop",
"Tile": { "X": 1, "Y": 9 },
"Direction": "Left"
}
]
}
}
}
]
}</nowiki>|lang=javascript}}
You can also add non-social NPCs which don't have birthdays or friendship points, accept gifts, give quests, etc:
{{#tag:syntaxhighlight|<nowiki>
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
{
"Action": "EditData",
"Target": "Data/Characters",
"Entries": {
"{{ModId}}_Belwick": {
"DisplayName": "Belwick", // this would normally use {{i18n:}} to support translations
"SocialTab": "HiddenAlways",
"CanSocialize": "FALSE",
"IntroductionsQuest": false,
"PerfectionScore": false,
"EndSlideShow": true
}
}
}
]
}</nowiki>|lang=javascript}}
===Custom NPC appearance===
{{/doc status|[[Modding:NPC data]]|done=false}}
<dl style="margin-left: 2em;">
Each NPC can now have any number of custom portraits/sprites in <samp>Data/Characters</samp> with arbitrary conditions. This lets mods add features like indoor/outdoor outfits without the performance impact of reloading textures. If multiple outfits apply, the game will choose between them with a day-stable randomization.
<dt>Main info:</dt>
<dd>
For example, you can load indoor/outdoor outfits for a custom NPC to swap between automatically:
{| class="wikitable"
<syntaxhighlight lang="js">
|-
// add base indoor/outdoor sprites
{
"Action": "Load",
"Target": "Characters/Johnny_Indoor, Characters/Johnny_Outdoor, Portraits/Johnny_Indoor, Portraits/Johnny_Outdoor",
"FromFile": "assets/{{Target}}.png"
},
// apply any overlays needed
{
"Action": "EditImage",
"Target": "Characters/Johnny_Indoor, Portraits/Johnny_Indoor",
"FromFile": "assets/overlays/{{Target}}_married.png",
"When": {
"Spouse": "Johnny"
}
},
// add NPC
{
"Action": "EditData",
"Target": "Data/Characters",
"Entries": {
"SomeMod.Id_Johnny": {
...,
"Appearance": [
{
"Id": "Outdoors",
"Indoors": false,
"Portrait": "Portraits/Johnny_Outdoor",
"Sprite": "Characters/Johnny_Outdoor"
},
{
"Id": "Default",
"Portrait": "Portraits/Johnny_Indoor",
"Sprite": "Characters/Johnny_Indoor"
}
]
}
}
}
</syntaxhighlight>
See the <samp>Appearance</samp> field in [[#Custom NPCs|custom NPC data]] for more info.
===Custom farm animals===
{{/doc status|[[Modding:Animal data]]|done=true}}
You can now create and edit [[Animals|farm animals]] by editing the revamped <samp>Data/FarmAnimals</samp> asset. This changes to a data model, adds built-in support for custom animals, and allows far more customizability per animal (like its size, growth, produce, appearance and sounds, etc).
===Custom pets===
{{/doc status|[[Modding:Pets]]|done=true}}
* You can now create and customize [[Animals#Cat or Dog|pet]]s & pet breeds by editing the new <samp>Data/Pets</samp> asset.*
* The pet bowl is now a building which can be constructed or moved. Each pet is assigned to an available pet bowl. For C# mods, each pet now has a <samp>guid</samp> field populated with a unique ID, and each pet bowl has a <samp>petGuid</samp> field which tracks its owner (see the <samp>PetBowl::HasPet()</samp> and <samp>PetBowl::FindPet()</samp> methods).
* In the [[Modding:Event data#Basic format|event character setup]], you can now use <samp>pet</samp> to add a pet of the player's selected type. Its actor name will be <samp>PetActor</samp> in other event commands. This supersedes <samp>cat</samp> (with name <samp>Cat</samp>) and <samp>dog</samp> (with name <samp>Dog</samp>), though those still work too.
* For C# mods:
** All pets now use a generic <samp>Pet</samp> class, instead of <samp>Cat</samp> or <samp>Dog</samp>. The pet type is tracked by the pet's <samp>petType</samp> field.
** The player's preferred pet type is tracked by <samp>Game1.player.whichPetType</samp>. The former <samp>catPerson</samp> field is now readonly and checks that field.
** Added <samp>Pet.type_cat</samp> and <samp>Pet.type_dog</samp> constants for the default pet types.
===Custom monster eradication goals===
{{/doc status|a new doc page|done=false}}
: ''See also: [[#Monster eradication goal flag changes|Monster eradication goal flag changes]].''
You can now add/edit [[Adventurer's Guild]] monster eradication goals by editing the new <samp>Data/MonsterSlayerQuests</samp> data asset.
This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the monster eradication goal.
* The value is a model with the fields listed below.
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>DisplayName</samp>
| <samp>DisplayName</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] for the NPC's display name. Defaults to the display name in <samp>Data/NPCDispositions</samp> (if any), else the internal NPC name.
| A [[Modding:Tokenizable strings|tokenizable string]] for the goal's display name, shown on the board in the Adventurer's Guild.
|-
|-
| <samp>Size</samp>
| <samp>Targets</samp>
| ''(Optional)'' The pixel size of the individual sprites in their overworld sprite spritesheet. Specified as a model with <samp>X</samp> and <samp>Y</samp> fields. Defaults to <samp>(16, 32)</samp>.
| A list of [[Modding:Monster data#Monster IDs|monster IDs]] that are counted towards the <samp>Count</samp>.
|-
|-
| <samp>UnlockConditions</samp>
| <samp>Count</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether the NPC should be added to the world, checked when loading a save and when ending each day. This only affects whether the NPC is added when missing; returning false won't remove an NPC that's already been added. Defaults to true.
| The total number of monsters (matching the <samp>Targets</samp>) which must be defeated to complete this goal.
|-
| <samp>RewardItemId</samp>
| ''(Optional)'' The [[#Custom items|qualified ID]] for the item that can be collected from [[Gil]] when this goal is completed. Default none.
|-
|-
| <samp>TextureName</samp>
| <samp>RewardItemPrice</samp>
| ''(Optional)'' The '''last segment''' of the NPC's portrait and sprite asset names. For example, set to <samp>Abigail</samp> to use <samp>Portraits/Abigail</samp> and <samp>Characters/Abigail</samp> respectively. Defaults to the internal NPC name.
| ''(Optional)'' The price of the <samp>RewardItemId</samp> in [[Marlon]]'s shop after the goal is completed, or -1 to disable buying it from Marlon. Default -1.
|-
|-
| <samp>Breather</samp>
| <samp>RewardDialogue</samp><br /><samp>RewardDialogueFlag</samp>
| ''(Optional)'' Whether the chest on the NPC's overworld sprite puffs in and out as they breathe. Default true</samp>.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for custom [[Gil]] dialogue shown when talking to him after completing the goal, and an optional [[Modding:Mail data|mail flag]] to set when the player has seen the dialogue. Both default to none.
</dd>
If there are reward items, they're shown after this dialogue.
If <samp>RewardDialogue</samp> is used without <samp>RewardDialogueFlag</samp>, then this dialogue will be shown each time the reward menu is opened after completing the goal, until the player collects the reward items. If the <samp>RewardItems</samp> isn't set, this can safely be omitted since the goal will be marked collected immediately.
<dt>Spawn info:</dt>
This doesn't send a letter; see <samp>RewardMail</samp> or <samp>RewardMailAll</samp> for that.
<dd>
|-
|-
| <samp>RewardFlag</samp><br /><samp>RewardFlagAll</samp>
| ''(Optional)'' The [[Modding:Mail data|mail flag ID]] to set for the current player (<samp>RewardFlag</samp>) or all players (<samp>RewardFlagAll</samp>) when talking to [[Gil]] after completing the goal. Default none.
Note that <samp>RewardFlag</samp> is usually not needed, since the game will also set a <samp>Gil_{{t|goal ID}}</samp> flag regardless.
This doesn't send a letter; see <samp>RewardMail</samp> or <samp>RewardMailAll</samp> for that.
|-
|-
| <samp>ForceSpawn</samp>
| <samp>RewardMail</samp><br /><samp>RewardMailAll</samp>
| ''(Optional)'' Whether to add this NPC to the world even if they don't have an entry in <samp>Data/NPCDispositions</samp>. If true, you must specify <samp>DefaultLocation</samp> to avoid errors. Defaults to false.
| ''(Optional)'' The mail letter ID to add to the mailbox tomorrow for the current player (<samp>RewardMail</samp>) or all players (<samp>RewardMailAll</samp>). Default none.
|-
|-
| <samp>DefaultLocation</samp>
| <samp>CustomFields</samp>
| ''(Optional)'' The internal name for the home location where this NPC spawns and returns each day. Defaults to the value specified in <samp>Data/NPCDispositions</samp> (if any), else causes an error.
| The [[#Custom data fields|custom fields]] for this entry.
|}
|}
<dt>Social features:</dt>
===Custom phone calls===
{{/doc status|a new doc page|done=false}}
Mods can now extend the [[telephone]] with custom calls (both incoming calls, and phone numbers which the player can call).
====Incoming calls====
You can add or customize incoming calls by editing the <samp>Data/IncomingPhoneCalls</samp> asset.
This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the incoming call data.
* The value is a model with the fields listed below.
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>SocializeConditions</samp>
| <samp>Dialogue</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether to enable social features (like birthdays, gift giving, [[friendship]], and an entry in the social tab). Defaults to true (except for monsters, horses, pets, and Junimos).
| The dialogue text to show when the player answers the phone. This can use the full [[Modding:Dialogue|dialogue format]] (including questions and different dialogue based on the selected answer).
|-
|-
| <samp>Visibility</samp>
| <samp>FromNpc</samp>
| ''(Optional)'' Determines how the NPC is shown on the [[friendship|social tab]] when unlocked. Possible values:
| ''(Optional)'' The internal name of the NPC making the call. If specified, that NPC's name and portrait will be shown.
|-
|-
| <samp>FromPortrait</samp>
| ''(Optional)'' The asset name for the portrait spritesheet to display (like <samp>Portraits/Abigail</samp>). If <samp>FromNpc</samp> is specified too, this overrides the portrait from that NPC. If both <samp>FromNpc</samp> and <samp>FromDisplayName</samp> are null, this portrait will be shown with the display name "???".
|-
| <samp>HiddenAlways</samp>
|-
|-
| <samp>Hidden</samp>
| <samp>FromDisplayName</samp>
| Until the player meets them, they don't appear on the social tab.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the calling NPC's display name. If <samp>FromNpc</samp> is specified too, this overrides the display name from that NPC.
|-
|-
| <samp>Default</samp>
| <samp>MaxCalls</samp>
| Until the player meets them, their name on the social tab is replaced with "???".
| ''(Optional)'' The maximum number of times a player can receive this phone call, or <samp>-1</samp> for no limit. Default 1.
|-
|-
| <samp>Friend</samp>
| <samp>TriggerCondition</samp><br /><samp>RingCondition</samp>
| They always appear in the social tab (including their name).
| ''(Optional)'' If set, a game state query which indicates whether to trigger this phone call (<samp>TriggerCondition</samp>) or whether the phone rings when this call is received (<samp>RingCondition</samp>).
Whether a player receives this call depends on both fields: <samp>TriggerCondition</samp> is checked on the main player before sending the call to all players, then <samp>RingCondition</samp> is checked on each player to determine whether the phone rings for them.
|-
|-
| <samp>ExcludeFromIntroductionsQuest</samp>
| <samp>IgnoreBaseChance</samp>
| ''(Optional)'' Whether this NPC will be ignored for the [[Quests#List of Story Quests|''introductions'' quest]]. Default false if the NPC is in <samp>Data/NPCDispositions</samp>, else true.
| ''(Optional)'' Whether to ignore the 1% base chance when checking whether to trigger an incoming call. If true, the game will check if this call can be received regardless of the base chance. Default false.
|-
| <samp>SimpleDialogueSplitBy</samp>
| ''(Optional, specialized)'' If set, marks the call as having a simple dialogue string without an NPC name and portrait, with lines split into multiple boxes by this substring. For example, <code>"SimpleDialogueSplitBy": "#"</code> will split <code>Box A#Box B#Box C</code> into three consecutive dialogue boxes.
You should omit this in most cases, and use the regular dialogue format in <samp>Dialogue</samp> to split lines if needed. This is mainly intended to support some older vanilla phone calls.
|-
| <samp>CustomFields</samp>
| The [[#Custom data fields|custom fields]] for this entry.
|}
|}
<dt>[[Secrets#Gift Log|Hidden gift log emote]]:</dt>
====Custom handlers in C#====
<dd>
C# mods can implement <samp>StardewValley.PhoneCalls.IPhoneHandler</samp> and add it to <samp>Phone.PhoneHandlers</samp> for full control over both incoming and outgoing calls:
<syntaxhighlight lang="c#">
/// <summary>The mod entry point.</summary>
internal sealed class ModEntry : Mod
{
/// <inheritdoc />
public override void Entry(IModHelper helper)
{
Phone.PhoneHandlers.Add(new CustomPhoneHandler());
}
}
/// <summary>A custom phone handler.</summary>
internal sealed class CustomPhoneHandler : IPhoneHandler
{
...
}
</syntaxhighlight>
See <samp>StardewValley.PhoneCalls.DefaultPhoneHandler</samp> in the [[Modding:Modder Guide/Get Started#decompile|decompiled game code]] for an example implementation.
===Custom shops===
{{/doc status|[[Modding:Shops]]|done=true}}
You can now create and edit shops via the new <samp>Data/Shops</samp> asset. See [[Modding:Shops]] for documentation and examples.
===Dialogue changes===
{{/doc status|[[Modding:Dialogue]]|done=false}}
<ul>
<li>Added new [[Modding:Dialogue|dialogue]] keys:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! asset
! effect
! key format
! description
|-
|rowspan="22"| <samp>Characters/Dialogue/<name></samp>
|-
|-
| <samp>HiddenProfileEmoteSound</samp>
| <samp>AcceptBirthdayGift_{{t|id}}</samp><br /><samp>AcceptBirthdayGift_{{t|tag}}</samp><br /><samp>AcceptBirthdayGift_{{t|taste}}</samp><br /><samp>AcceptBirthdayGift_Negative</samp><br /><samp>AcceptBirthdayGift_Positive</samp><br /><samp>AcceptBirthdayGift</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the [[#Custom audio|cue ID]] for the sound played when clicking the sprite. Defaults to <samp>drumkit6</samp>.
| Shown when receiving a birthday gift from the player. If omitted, defaults to the generic translations for all NPCs.
The first matching dialogue is used in this order:
# by item ID (like <samp>AcceptBirthdayGift_(O)128</samp>);
# by context tag (like <samp>AcceptBirthdayGift_category_fish</samp>);
# by gift taste (one of <samp>AcceptBirthdayGift_Loved</samp>, <samp>AcceptBirthdayGift_Liked</samp>, <samp>AcceptBirthdayGift_Neutral</samp>, <samp>AcceptBirthdayGift_Disliked</samp>, or <samp>AcceptBirthdayGift_Hated</samp>);
# <samp>AcceptBirthdayGift_Negative</samp> (hated or disliked gift) or <samp>AcceptBirthdayGift_Positive</samp> (neutral, liked, or loved gift);
# for all items (via <samp>AcceptBirthdayGift</samp>).
|-
|-
| <samp>HiddenProfileEmoteDuration</samp>
| <samp>AcceptBouquet</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], how long the animation plays measured in milliseconds. Defaults to 4000 (4 seconds).
| Shown when the NPC accepts a [[bouquet]] from the player. Defaults to a generic dialogue.
|-
|-
| <samp>HiddenProfileEmoteStartFrame</samp>
| <samp>AcceptGift_{{t|id}}</samp><br /><samp>AcceptGift_{{t|tag}}</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the index within the NPC's overworld sprite spritesheet at which the animation starts. If omitted for a vanilla NPC, the game plays a default animation specific to that NPC; if omitted for a custom NPC, the game just shows them walking while facing down.
| Shown when receiving a non-birthday gift from the player. This can be by item ID (like <samp>AcceptGift_(O)128</samp>) or context tag (like <samp>AcceptGift_category_fish</samp>). If omitted, defaults to the dialogue in <samp>Data/NPCGiftTastes</samp>.
|-
|-
| <samp>HiddenProfileEmoteFrameCount</samp>
| <samp>DumpsterDiveComment</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], the number of frames in the animation. The first frame corresponds to <samp>HiddenProfileEmoteStartFrame</samp>, and each subsequent frame will use the next sprite in the spritesheet. Default 1.
| Shown when the NPC catches the player digging through a trash can. Defaults to a generic dialogue based on the NPC's age.
|-
|-
| <samp>HiddenProfileEmoteFrameDuration</samp>
| <samp>HitBySlingshot</samp>
| ''(Optional)'' For the [[Secrets#Gift Log|hidden gift log emote]], how long each animation frame is shown on-screen before switching to the next one, measured in milliseconds. Default 200.
| Shown when the player shoots them with a [[slingshot]]. Defaults to a generic dialogue.
|-
| <samp>RejectBouquet_Divorced</samp><br /><samp>RejectBouquet_NotDatable</samp><br /><samp>RejectBouquet_NpcAlreadyMarried</samp><br /><samp>RejectBouquet_VeryLowHearts</samp><br /><samp>RejectBouquet_LowHearts</samp><br /><samp>RejectBouquet</samp>
| Shown when the NPC rejects a [[bouquet]].
A specific dialogue is shown if possible:
* <samp>RejectBouquet_Divorced</samp>: the NPC won't accept this bouquet because you divorced them.
</dd>
* <samp>RejectBouquet_NotDatable</samp>: the NPC isn't romanceable.
</dl>
* <samp>RejectBouquet_NpcAlreadyMarried</samp>: the NPC is already married to another player. You can use <samp>{0}</samp> in the dialogue for the other player's name.
* <samp>RejectBouquet_VeryLowHearts</samp>: you have less than 4 hearts with the NPC.
* <samp>RejectBouquet_LowHearts</samp>: you have less than 8 hearts with the NPC.
If the specific dialogue isn't set, the game will use the <samp>RejectBouquet</samp> dialogue (if set), else it'll default to generic dialogue for each case.
|-
|-
| <samp>RejectGift_Divorced</samp>
| Shown when the NPC rejects a gift because you divorced them.
|-
|-
| <samp>ID</samp>
| <samp>RejectItem_{{t|id}}</samp><br /><samp>RejectItem_{{t|tag}}</samp>
| The unique farm animal ID. For custom farm animals, this should be prefixed with your mod ID like <samp>Example.ModId_FarmAnimalName</samp>.
| If set, the NPC will refuse to accept any matching item and show this dialogue instead. This can be by item ID (like <samp>RejectItem_(O)128</samp>) or context tag (like <samp>RejectItem_category_fish</samp>). This can prevent gifting, movie tickets, bouquets, mermaid pendants, etc. However it won't prevent accepting an item for an active quest or special order.
|-
|-
| <samp>DisplayName</samp>
| <samp>RejectMermaidPendant_Divorced</samp><br /><samp>RejectMermaidPendant_NeedHouseUpgrade</samp><br /><samp>RejectMermaidPendant_NotDatable</samp><br /><samp>RejectMermaidPendant_NpcWithSomeoneElse</samp><br /><samp>RejectMermaidPendant_PlayerWithSomeoneElse</samp><br /><samp>RejectMermaidPendant_Under8Hearts</samp><br /><samp>RejectMermaidPendant_Under10Hearts</samp><br /><samp>RejectMermaidPendant_Under10Hearts_AskedAgain</samp><br /><samp>RejectMermaidPendant</samp>
| A [[#Tokenizable string format|tokenizable string]] for the animal type's display name.
| Shown when the NPC rejects a [[Mermaid's Pendant|mermaid's pendant]].
A specific dialogue is shown if possible. The cases are checked in this order:
# <samp>RejectMermaidPendant_PlayerWithSomeoneElse</samp>: the player is already engaged or married to someone else. You can use <samp>{0}</samp> in the dialogue for the player's spouse name.
# <samp>RejectMermaidPendant_NotDatable</samp>: the NPC isn't romanceable.
# <samp>RejectMermaidPendant_Divorced</samp>: you divorced them, so they won't accept gifts or proposals from you.
# <samp>RejectMermaidPendant_NpcWithSomeoneElse</samp>: the NPC is already engaged or married to someone else. You can use <samp>{0}</samp> in the dialogue for the other player's name.
# <samp>RejectMermaidPendant_Under8Hearts</samp>: you have under 8 hearts with the NPC.
# <samp>RejectMermaidPendant_Under10Hearts</samp>: you have under 10 hearts with the NPC.
# <samp>RejectMermaidPendant_Under10Hearts_AskedAgain</samp>: you have under 10 hearts with the NPC, and asked again after they already said no. (Defaults to the previous dialogue if not set.)
# <samp>RejectMermaidPendant_NeedHouseUpgrade</samp>: you need to upgrade your house before they can accept.
If the specific dialogue isn't set, the game will use the <samp>RejectMermaidPendant</samp> dialogue (if set), else it'll default to generic dialogue for each case.
|-
|-
| <samp>House</samp>
| <samp>RejectMovieTicket_AlreadyInvitedBySomeoneElse</samp><br /><samp>RejectMovieTicket_AlreadyWatchedThisWeek</samp><br /><samp>RejectMovieTicket_Divorced</samp><br /><samp>RejectMovieTicket_DontWantToSeeThatMovie</samp><br /><samp>RejectMovieTicket</samp>
| Show when the NPC rejects a [[Movie Ticket|movie ticket]].
|}
A specific dialogue is shown if possible:
* <samp>RejectMovieTicket_AlreadyInvitedBySomeoneElse</samp>: someone else already invited the NPC to a movie. You can use <samp>{0}</samp> in the dialogue for the other player's name.
* <samp>RejectMovieTicket_AlreadyWatchedThisWeek</samp>: the NPC already watched a movie this week.
* <samp>RejectMovieTicket_Divorced</samp>: you divorced the NPC, so they won't accept gifts from you.
* <samp>RejectMovieTicket_DontWantToSeeThatMovie</samp>: the movie data marks that NPC as unwilling to watch it (e.g. kids for horror movies).
If the specific dialogue isn't set, the game will use the <samp>RejectMovieTicket</samp> dialogue (if set), else it'll default to generic dialogue for each case.
|-
|-
| <samp>SpouseFarmhouseClutter</samp>
| Shown by an NPC spouse when they couldn't pathfind to their kitchen standing spot in the farmhouse.
|-
|-
| <samp>PurchasePrice</samp>
| <samp>SpouseGiftJealous</samp>
| ''(Optional if not purchaseable)'' Half the cost to purchase the animal (the actual price is double this value), or a negative value to disable purchasing this animal type. Default -1.
| Shown by an NPC spouse when you gave a gift to another eligible NPC of the same gender as your spouse (unless it's their birthday). You can use <samp>{0}</samp> in the dialogue for the other NPC's name, and <samp>{1}</samp> for the gifted item name.
|-
|-
| <samp>ShopTexture</samp>
| <samp>Spouse_MonstersInHouse</samp>
| ''(Optional if not purchaseable)'' The asset name for the icon texture to show in shops. Defaults to <samp>LooseSprites/Cursors</samp> or <samp>LooseSprites/Cursors2</samp> based on the animal's position within the loaded data (but using the default isn't recommended if it's purchaseable).
| Shown by an NPC spouse when they're in the farmhouse and there's a monster close to them.
|-
|-
| <samp>ShopSourceRect</samp>
| <samp>SpouseStardrop</samp>
| ''(Optional if not purchaseable)'' The pixel area within the <samp>ShopTexture</samp> to draw, specified as an object with <samp>X</samp>, <samp>Y</samp>, <samp>Width</samp>, and <samp>Height</samp> fields. This should be 32 pixels wide and 16 high. Ignored if <samp>ShopTexture</samp> isn't set.
| Shown when receiving the [[stardrop]] from your spouse.
|-
|-
| <samp>RequiredBuilding</samp>
| <samp>Fair_Judging</samp>
| ''(Optional)'' The building that needs to be built on the farm for this animal to be available to purchase. Buildings that are upgraded from this building are valid too. Default none.
| Shown at the [[Stardew Valley Fair]] while Lewis is judging the grange displays. If omitted, the NPC will keep their normal festival dialogue.
If this is set without <samp>Fair_Judged*</samp>, the NPC will keep this dialogue after judging is done.
''This replaces the previously hardcoded translations in <samp>Strings/StringsFromCSFiles</samp>: <samp>Event.cs.1602</samp> (Marnie), <samp>Event.cs.1604</samp> (Pierre), and <samp>Event.cs.1606</samp> (Willy).''
|-
| <samp>Fair_Judged_PlayerLost_PurpleShorts</samp><br /><samp>Fair_Judged_PlayerLost_Skipped</samp><br /><samp>Fair_Judged_PlayerLost</samp><br /><samp>Fair_Judged_PlayerWon</samp><br /><samp>Fair_Judged</samp>
| Shown at the [[Stardew Valley Fair]] after Lewis finishes judging the grange displays.
The first matching dialogue is used in this order:
# <samp>Fair_Judged_PlayerLost_PurpleShorts</samp>: the player put the [[Secrets#Lucky Purple Shorts|lucky purple shorts]] in their display (which is an automatic loss). Defaults to <samp>Fair_Judged_PlayerLost</samp> if omitted.
# <samp>Fair_Judged_PlayerLost_Skipped</samp>: the player didn't put anything in their display. Defaults to <samp>Fair_Judged_PlayerLost</samp> if omitted.
# <samp>Fair_Judged_PlayerLost</samp> or <samp>Fair_Judged_PlayerWon</samp>: the player didn't/did win first place. Defaults to <samp>Fair_Judged</samp> if omitted.
# <samp>Fair_Judged</samp>: shown if a more specific dialogue didn't match. If omitted, the NPC will keep their current dialogue.
''These replace the previously hardcoded translations in <samp>Strings/StringsFromCSFiles</samp>: <samp>Event.cs.1591</samp> (Pierre when he won), <samp>Event.cs.1593</samp> (Pierre when the player won), <samp>Event.cs.1595</samp> (Marnie), <samp>Event.cs.1597</samp> (Willy), and <samp>Event.cs.1600</samp> (Marnie for the purple shorts).''
|-
|-
| <samp>UnlockCondition</samp>
| <samp>FlowerDance_Accept_Roommate</samp><br /><samp>FlowerDance_Accept_Spouse</samp><br /><samp>FlowerDance_Accept</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether the farm animal is available in the shop menu. Default always unlocked.
| Shown at the [[Flower Dance]] when the NPC agrees to dance. The game will prefer the <samp>_Roommate</samp> (if roommates) or <samp>_Spouse</samp> (if married) variant if applicable, else it'll check for the normal key. If omitted, defaults to a generic accept dialogue.
''This replaces the previously hardcoded translations in <samp>Strings/StringsFromCSFiles</samp> (<samp>Event.cs.1613</samp>, <samp>Event.cs.1615</samp>, <samp>Event.cs.1617</samp>, <samp>Event.cs.1619</samp>, <samp>Event.cs.1621</samp>, <samp>Event.cs.1623</samp>, <samp>Event.cs.1625</samp>, <samp>Event.cs.1627</samp>, <samp>Event.cs.1629</samp>, and <samp>Event.cs.1631</samp>).''
|-
|-
| <samp>ShopDisplayName</samp>
| <samp>FlowerDance_Decline</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] for the display name shown in the shop menu. Defaults to the <samp>DisplayName</samp> field.
| Shown at the [[Flower Dance]] when the NPC declines to dance. This replaces the former <samp>danceRejection</samp> key (which still works as a fallback).
|-
|-
| <samp>ShopDescription</samp>
| <samp>WinterStar_GiveGift_Before_Roommate</samp><br /><samp>WinterStar_GiveGift_Before_Spouse</samp><br /><samp>WinterStar_GiveGift_Before</samp><br /><samp>WinterStar_GiveGift_After_Roommate</samp><br /><samp>WinterStar_GiveGift_After_Spouse</samp><br /><samp>WinterStar_GiveGift_After</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] for the tooltip description shown in the shop menu. Defaults to none.
| Shown at the [[Feast of the Winter Star]] when the NPC gives the player their gift (before and after the player opens it). The game will prefer the <samp>_Roommate</samp> (if roommates) or <samp>_Spouse</samp> (if married) variant if applicable, else it'll check for the normal key. If omitted, the before/after dialogues each separately default to a generic translation for all NPCs.
|-
|-
| <samp>ShopMissingBuildingDescription</samp>
| <samp>WinterStar_ReceiveGift_{{t|id}}</samp><br /><samp>WinterStar_ReceiveGift_{{t|tag}}</samp><br /><samp>WinterStar_ReceiveGift</samp>
| ''(Optional)'' A [[#Tokenizable string format|tokenizable string]] which overrides <samp>ShopDescription</samp> if the <samp>RequiredBuilding</samp> isn't built. Defaults to none.
| Shown at the [[Feast of the Winter Star]] when receiving their gift from the player. This can be by item ID (like <samp>WinterStar_ReceiveGift_(O)128</samp>), context tag (like <samp>WinterStar_ReceiveGift_category_fish</samp>), or for any item (like <samp>WinterStar_ReceiveGift</samp>). If omitted, defaults to the generic translation for all NPCs.
|-
|-
| <samp>Genders</samp>
| <samp>WipedMemory</samp>
| ''(Optional)'' The possible genders for the animal type. Currently this only affects the text shown after purchasing the animal, like "''Great! I'll send little <name> to [his/her] new home right away''". Default <samp>Female</samp>.
| Shown the first time you talk to the NPC after erasing their memory using the [[Dark Shrine of Memory]].
|}
</li>
<li>Added new [[Modding:Dialogue|dialogue]] commands:
{| class="wikitable"
{| class="wikitable"
|-
|-
! value
! command
! effect
! description
|- id="gender-switch"
| <samp>${male^female}$</samp><br /><samp>${male^female^non-binary}$</samp>
| Change text depending on the player's gender. This largely supersedes the <samp>^</samp> dialogue token (which still works), and is supported in many more places than that token. This is applied before most other commands or parsing, so it can safely be used in cases where <samp>^</samp> might have a different meaning (e.g. mail text). For example: <code>Ahoy there ${lad^lass}$!</code> or <code>Ahoy there ${lad^lass^matey}$!</code>.
You can optionally use <samp>¦</samp> instead of <samp>^</samp>, in which case any <samp>^</samp> characters are left as-is.
Note that the non-binary value is only used if a mod overrides the player's gender, since the in-game UI only allows male or female.
|-
|-
| <samp>Male</samp><br /><samp>Female</samp>
| <samp>$action {{t|action}}</samp>
| Farm animals of this type are always male or always female.
| Run a [[Modding:Trigger actions|trigger action string]], like <samp>$action AddMoney 500</samp> to add {{price|500}} to the current player.
|-
|-
| <samp>MaleOrFemale</samp>
| <samp>$query {{t|query}}#{{t|if true}}|{{t|if false}}</samp>
| The gender of each animal is randomized based on its internal unique ID.
| Show different dialogue text depending on the [[Modding:Game state queries|game state query]] in {{t|query}}. For example:
|}
<syntaxhighlight lang="js">
"Mon": "$query !PLAYER_VISITED_LOCATION Current Mine#Did you know there's an old abandoned mine up in the mountain? Apparently it's crawling with monsters!|I heard you went into the old mines up in the mountain!#Did you find anything tasty?$h"
</syntaxhighlight>
|-
|-
| <samp>AlternatePurchaseTypes</samp>
| <samp>$t {{t|topic ID}} {{o|day length}}</samp>
| ''(Optional)'' The possible variants for this farm animal (e.g. chickens can be Brown Chicken, Blue Chicken, or White Chicken). This consists of a list of models with these fields:
| Add a [[Modding:Dialogue#Conversation topics|conversation topic]] for the next {{o|day length}} days (default 4 days).
|-
|-
| <samp>$v {{t|event id}} {{o|check preconditions}} {{o|skip if seen}}</samp>
| Immediately start an [[Modding:Event data|event]] and end the current dialogue, subject to the conditions:
* {{o|check preconditions}}: whether to ignore the command if the [[Modding:Event data#Event preconditions|event's preconditions]] don't match (one of <samp>true</samp> or <samp>false</samp>). Default true.
| <samp>AnimalIDs</samp>
* {{o|skip if seen}}: whether to ignore the command if the player has already seen the given event. Default true.
| A list of animal IDs to spawn instead of the main <samp>ID</samp> field. If multiple are listed, one is chosen at random on purchase.
|}
If multiple are listed, the first available variant is returned. Default none.
If the event is not played, the dialogue continues to the next line instead.
For example, <code>$v 60367 false false</code> will replay the bus arrival event from the start of the game. <code>$v SomeMod.Test true false#$b#Wow! Good timing!$1</code> will play the event "SomeMod.Test" if the player meets the precondition requirements. If they do not, the dialogue "Wow! Good timing!$1" will play instead.
The vanilla values are:
Note: The command will only work if it is at the very start of the dialogue. Adding any dialogue or other commands before it will cause it not to trigger the event and display the event commands as dialogue instead.
|}
|}
</li>
<li>Improved dialogue commands:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! command
! effect
! changes
|-
|-
| <samp>DaysToMature</samp>
| <samp>$p</samp>
| ''(Optional)'' The number of days until a freshly purchased/born animal becomes an adult and begins producing items. Default 1.
| You can now check multiple answer IDs. For example, this will show the first dialogue if the player chose dialogue answer 17, 18, or 19:
|-
<pre>$p 17|18|19#I guess you think nothing would happen, right?$u|Maybe a wicked ghost would appear!</pre>
|}</li>
| ''(Optional)'' Whether an animal can [[Animals#Animal Births|produce a child]] (regardless of gender). Default false.
<li>[[Modding:Dialogue#Response IDs|Dialogue response IDs]] are now [[Modding:Common data field types#Unique string ID|unique string IDs]].</li>
<li>[[Secrets#Item Spawn Cheat|Item spawn codes]] now use string item IDs. That means you can spawn any item using its [[#Custom items|qualified item ID]] (like <code>[(F)1664]</code> for a [[Mystic Rug]]), but can no longer prepend zeros (e.g. <code>[128]</code> is a pufferfish but <code>[0128]</code> is an error item).</li>
<li>For C# mods, <samp>Dialogue</samp> now tracks the translation key used to build it (when applicable). For example, you can detect when the player is rejected at the [[Flower Dance]] (derived from {{github|spacechase0/StardewValleyMods|Three-Heart Dance Partner}}):
<syntaxhighlight lang="c#">
private void OnMenuChanged(object sender, MenuChangedEventArgs e)
{
bool isDanceRejection =
Game1.currentLocation?.currentEvent?.FestivalName == "Flower Dance"
&& e.NewMenu is DialogueBox dialogueBox
&& dialogueBox.characterDialogue is {} dialogue
&& dialogue.TranslationKey == $"Characters\\Dialogue\\{dialogue.speaker?.Name}:danceRejection";
}
</syntaxhighlight>
For C# mods that create <samp>Dialogue</samp> instances directly, there's a few ways to do it now:
<syntaxhighlight lang="c#">
// from a translation key
var dialogue = new Dialogue(npc, "Strings\\StringsFromCSFiles:Utility.cs.5360");
// from custom text (with or without a translation key)
var dialogue = new Dialogue(npc, null, "Some arbitrary text to show as-is");
// from a translation with tokens
</pre>
var dialogue = Dialogue.FromTranslation(npc, "Data\\ExtraDialogue:PurchasedItem_2_QualityLow_Willy", whatToCallPlayer, particle, i.DisplayName);
</syntaxhighlight>
You can also easily add fallback logic using <samp>Dialogue.TryGetDialogue</samp> or <samp>npc.TryGetDialogue</samp>. For example:
<syntaxhighlight lang="c#">
Dialogue dialogue =
npc.TryGetDialogue($"rejection_{itemId}_{locationName}_{x}_{y}")
?? npc.TryGetDialogue($"rejection_{itemId}_{locationName}")
?? npc.TryGetDialogue($"rejection_{itemId}")
?? new Dialogue(npc, "Strings\\StringsFromCSFiles:NPC.cs.3971");
</syntaxhighlight>
</li>
<li>For C# mods, added a <samp>dialogue.sideEffects</samp> field to run code when the dialogue is displayed.</li>
<li>The 'reveal taste' dialogue command now uses the format <samp>%revealtaste:{{t|npc name}}:{{t|item ID}}</samp> to support item IDs. (The previous <samp>%revealtaste{{t|npc name}}{{t|item index}}</samp> format still works to support old content packs, but the item index can only be a number.)</li>
<li>NPCs no longer override the portrait for a gift taste dialogue that uses a portrait command explicitly.</li>
<li>Fixed unknown [[Modding:Dialogue|dialogue]] commands starting with <samp>$</samp> being parsed as a portrait number when not numeric.</li>
<li>Fixed NPCs only using a <code>{day name}{hearts}_{year}</code> dialogue if they also have a <code>{day name}{hearts}</code> one.</li>
<li>Fixed NPCs only using the <code>MovieInvitation</code> dialogue key in English.</li>
</ul>
===Schedule changes===
{{/doc status|[[Modding:Schedule data]]|done=false}}
<ul>
|-
<li>Schedule keys are now case-insensitive.</li>
<li>Added a new <samp>{{t|day of week}}_{{t|min hearts}}</samp> schedule key.</li>
<li>Added an <samp>NPC.ScheduleKey</samp> field which always matches their loaded schedule.</li>
<li>Schedule commands now trim surrounding whitespace, so they can be multilined for readability. For example:
<syntaxhighlight lang="js">"Wed": "
1000 ArchaeologyHouse 11 9 0/
1800 Town 47 87 0/
2200 SeedShop 1 9 3 abigail_sleep
"</syntaxHighlight></li>
<li>Removed an unintended schedule fallback to a <samp>{season}_spring_{hearts}</samp> key. It'll skip to the <samp>spring</samp> default instead.</li>
<li>Schedules are now fault-tolerant:
* Fixed crash if a selected schedule can't be parsed. The NPC now logs an error and continues with the next fallback instead.
* Fixed crash if certain hardcoded schedules aren't present (like Penny's <samp>marriageJob</samp> or Pam's <samp>bus</samp>).
* Fixed error if a schedule command is empty.</li>
</ul>
===Other NPC changes===
{{/doc status|[[Modding:NPC data]] as needed|done=false}}
| ''(Optional)'' The [[#Custom items|tool ID]] with which produced items can be collected from the animal, if the <samp>HarvestType</samp> is set to <samp>HarvestWithTool</samp>. The values recognized by the vanilla tools are <samp>MilkPail</samp> and <samp>Shears</samp>. Default none.
<ul>
<li>Added <samp>Game1.characterData</samp> and <samp>Game1.farmAnimalData</samp> to read NPC/animal info without constantly reloading the <samp>Data/Characters</samp> or <samp>Data/FarmAnimals</samp> asset.</li>
<li>All translated NPC names are now in <samp>Strings/NPCNames</samp>.
<li>Added new fields & methods for C# mods:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! type
! field/method
! effect
! effect
|-
|-
| <samp>Sound</samp>
|rowspan="2"| <samp>AdventureGuild</samp>
| ''(Optional)'' The [[#Custom audio|audio cue ID]] for the sound produced by the animal (e.g. when pet). Default none.
| <samp>IsComplete(data)</samp>
| Get whether an [[Adventurer's Guild]] monster eradication goal has been completed, regardless of whether the player collected its rewards yet.
|-
| <samp>HasCollectedReward(player, id)</samp>
| Get whether a given player has completed an [[Adventurer's Guild]] monster eradication goal and collected its rewards. For example:
<syntaxhighlight lang="c#">
bool isPhoneUnlocked = AdventureGuild.HasCollectedReward(Game1.player, "Gil_FlameSpirits");
</syntaxhighlight>
|-
|-
| <samp>BabySound</samp>
| <samp>AnimalHouse</samp>
| ''(Optional)'' Overrides <samp>Sound</samp> field when the animal is a baby. Has no effect if <samp>Sound</samp> isn't specified. Default none.
| <samp>adoptAnimal</samp>
| Add an animal to this location and set the location as the animal's home.
|-
|-
| <samp>Texture</samp>
| <samp>AnimatedSprite</samp>
| ''(Optional)'' The asset name for the animal's spritesheet. Defaults to <samp>Animals/{{t|ID}}</samp> (like <samp>Animals/Goat</samp> for a [[goat]]).
| <samp>Owner</samp>
| The NPC which owns the sprite.
|-
|-
| <samp>HarvestedTexture</samp>
|rowspan="3"| <samp>Character</samp>
| ''(Optional)'' Overrides <samp>Texture</samp> if the animal doesn't currently have an item ready to collect (like the [[sheep]]'s sheared sprite). Default none.
| <samp>IsVillager</samp>
| Whether this is an NPC-type villager (i.e. not a monster, horse, pet, player's child, etc). In other words, this checks whether the NPC would use data from <samp>Data/Characters</samp> (regardless of whether they currently have an entry in the asset).
|-
|-
| <samp>BabyTexture</samp>
| <samp>StandingPixel</samp>
| ''(Optional)'' Overrides <samp>Texture</samp> and <samp>HarvestedTexture</samp> when the animal is a baby. Default none.
| The character's cached pixel position within the current location, based on the center pixel of their bounding box.
|-
|-
| <samp>UseFlippedRightForLeft</samp>
| <samp>Tile</samp><br /><samp>TilePoint</samp>
| ''(Optional)'' When the animal is facing left, whether to use a flipped version of their right-facing sprite. Default false.
| The character's cached tile position within their current location. <samp>Tile</samp> is their exact non-integer position, and <samp>TilePoint</samp> is their integer tile position.
|-
|-
| <samp>SpriteWidth</samp><br /><samp>SpriteHeight</samp>
|rowspan="7"| <samp>FarmAnimal</samp>
| ''(Optional)'' The pixel height & width of the animal's sprite (before the in-game pixel zoom). Both default to 16.
| <samp>isAdult</samp>
| Get whether the farm animal is fully grown (opposite of <samp>isBaby()</samp>).
|-
|-
| <samp>Skins</samp>
| <samp>CanGetProduceWithTool</samp>
| ''(Optional)'' A list of alternate appearances. If specified, a skin is chosen at random when the animal is purchased. This consists of a list of models with these fields:
| Get whether the farm animal's produce can be collected with a given tool (e.g. milk pail for a cow).
|-
|-
| <samp>CanLiveIn</samp>
| Get whether the animal can be added to a building.
|-
|-
| <samp>ID</samp>
| <samp>GetDisplayName</samp><br /><samp>GetShopDescription</samp>
| Get the translated display name or shop description for this animal.
|-
|-
| <samp>Weight</samp>
| <samp>GetHarvestType</samp>
| ''(Optional)'' A multiplier for the probability to choose this skin when an animal is purchased. For example, <samp>2.0</samp> will double the chance this skin is selected relative to the other skins. Default <samp>1.0</samp>.
| Get whether the animal's produce is dropped or collected with a tool.
|-
|-
| <samp>Texture</samp><br /><samp>HarvestedTexture</samp><br /><samp>BabyTexture</samp>
| <samp>growFully</samp>
| ''(Optional)'' Overrides the equivalent main field when this skin is selected. Defaults to the main field's value.
| Instantly age the animal to adulthood if it's still a baby.
|-
|-
| <samp>ReloadTextureIfNeeded</samp>
| Update the animal sprite based on the current state + data.
|-
|-
| <samp>CanSwim</samp>
| rowspan="2"| <samp>Farmer</samp>
| ''(Optional)'' Whether animals on the farm can swim in water once they've been pet. Default false.
| <samp>GetDisplayPants</samp><br /><samp>GetDisplayShirt</samp>
| Get the texture and sprite index to draw for the player's pants or shirt. This accounts for override clothing, worn clothing, and the default clothing drawn when the farmer isn't wearing anything.
For example:
<syntaxhighlight lang="c#">
Game1.player.GetDisplayShirt(out Texture2D texture, out int spriteIndex);
</syntaxhighlight>
|-
|-
| <samp>BabiesFollowAdults</samp>
| <samp>CanDyePants</samp><br /><samp>CanDyeShirt</samp>
| Get whether the currently equipped pants or shirt can be [[Dyeing|dyed]].
| ''(Optional)'' The price when [[Animals#Selling Animals|the player sells the animal]], before the friendship boost. Default 0.
|-
|-
| <samp>Monster</samp>
| <samp>GetDisplayName(name)</samp>
| Get the translated display name for a monster type.
|-
|-
| <samp>StatToIncrementOnProduce</samp>
|rowspan="4"| <samp>NPC</samp>
| ''(Optional)'' The game stat counters to increment when the animal produces an item. Default none. This consists of a list of models with these fields:
| <samp>CanReceiveGifts</samp>
| Get whether this NPC can receive gifts from the player (regardless of whether they've already received one today).
|-
|-
| <samp>GetData</samp><br /><samp>NPC.TryGetData</samp>
| Get the underlying data from <samp>Data/Characters</samp> for this NPC, if any.
|-
|-
| <samp>StatName</samp>
| <samp>NPC.GetDisplayName(name)</samp>
| The name of the stat counter field on <samp>Game1.stats</samp>.
| Get the translated display name in the current language for an NPC by their internal name.
|-
|-
| <samp>RequiredTags</samp>
| <samp>hasDarkSkin</samp>
| ''(Optional)'' A comma-delimited list of [[Modding:Items#Context tags|context tags]] required on the main input item. The stat is only incremented if the item has ''all'' of these. You can negate a tag with <samp>!</samp> (like <code>bone_item,!fossil_item</code> for bone items that aren't fossils). Defaults to always enabled.
| Whether this character has dark skin for the purposes of child genetics.
|-
|-
| <samp>UpDownPetHitboxTileSize</samp><br /><samp>LeftRightPetHitboxTileSize</samp>
| <samp>Pet</samp>
| <samp>GetPetData</samp><br /><samp>TryGetData</samp>
| Get the underlying data from <samp>Data/Pets</samp> for this pet, if any.
|-
|-
| <samp>BabyUpDownPetHitboxTileSize</samp><br /><samp>BabyLeftRightPetHitboxTileSize</samp>
| <samp>ShopMenu</samp>
| <samp>ShopId</samp>
| A key which identifies the current shop. This may be the unique shop ID in <samp>Data/Shops</samp> for a standard shop, <samp>Dresser</samp> or <samp>FishTank</samp> for furniture, etc. This is guaranteed to be set to a relevant shop ID.
This replaces the former <samp>shopContext</samp> field, and will usually have the same value in cases where that was set to a unique shop ID.
|-
|-
| <samp>MeatID</samp>
| <samp>Utility</samp>
| ''(Optional)'' Sets the animal's unused meat ID field when purchased. Default none.
| <samp>getAllVillagers</samp>
| Get all villager NPCs (excluding horses, pets, monsters, player children, etc). This works just like <samp>getAllCharacters</samp> with an added filter.
|}
|}
</li>
<li>NPCs now update on save loaded when their home data changes.</li>
<li><samp>NPC.reloadSprite()</samp> now has an argument to only reload the appearance, without changing other data.</li>
<li><samp>Utility.getAllCharacters()</samp> now returns a plain <samp>List<NPC></samp> value instead of a custom <samp>DisposableList<NPC></samp>, so you can use normal LINQ querying on it.</li>
<li><samp>Utility.GetHorseWarpRestrictionsForFarmer(player)</samp> now returns an enum (which is more efficient and easier for mods to patch), and added a new <samp>Utility.GetHorseWarpErrorMessage(restrictions)</samp> method to get the error message to show for it.</li>
<li><samp>Farmer.hasAFriendWithHeartLevel</samp> now has an optional max-hearts argument.</li>
<li>Removed most <samp>FarmAnimal</samp> fields/properties which just mirror the underlying data.</li>
<li>Removed invalid item IDs in <samp>Data/NPCGiftTastes</samp>.</li>
<li>Fixed NPCs sometimes duplicated on save load (particularly if their home location changed).</li>
<li>Fixed child NPCs like [[Jas]] or [[Vincent]] ignoring relative titles like "mom" in <samp>Data/NPCDispositions</samp> (now <samp>Data/Characters</samp>) for reveal-gift-taste dialogues.</li>
<li>Fixed custom NPCs ignoring dialogue when they use a subclass of <samp>NPC</samp>.</li>
<li>Fixed monsters not loading their display name from <samp>Data/Monsters</samp> for English players.</li>
<li>Fixed player children not applying the <samp>IsInvisible</samp> flag.</li>
</ul>
===Custom pets===
==What's new for everything else==
====Format====
===Buff overhaul===
{{/doc status|a new doc page|done=false}}
: ''See also: [[#Custom buffs|custom buffs]].''
This consists of a list of models with these fields:
1.6 rewrites buffs to work more consistently and be more extensible:
* Buff logic is unified into <samp>Game1.player.buffs</samp>, which is the single source of truth for buff data. This replaces the previous <samp>player.added*</samp> and <samp>player.appliedBuffs</samp> fields, <samp>BuffsDisplay</samp> logic, enchantment stat bonuses, and boots/ring attribute changes on (un)equip.
* This also removes limitations on buff types (e.g. buffs can add weapon bonuses and weapons can add attribute buffs) and buffable equipment (e.g. equipped tools can have buffs too).
* Buff effects are now fully recalculated when they change, to fix a range of longstanding bugs like attribute drift and double-debuffs. Just like before, the buffs are managed locally; only the buff IDs and aggregate attribute effects are synced.
'''For C# mods:'''
* Each buff now has a unique string ID. You can apply a new buff with the same ID to replace it (so you no longer need to manually find and remove previous instances of the buff).
* The buff duration can now be set to <samp>Buff.ENDLESS</samp> to remove the duration. It'll last all day until the player sleeps.
* You can add standard buff effects to any equipment by overriding <samp>Item.AddEquipmentEffects</samp>, or add custom behaviour/buffs by overriding <samp>Item.onEquip</samp> and <samp>Item.onUnequip</samp>.
* You can add custom food or drink buffs by overriding <samp>Item.GetFoodOrDrinkBuffs()</samp>.
* The <samp>Buff</samp> constructor now supports a custom icon texture, sprite index, display name, description, and millisecond duration to fully support custom buffs.
* You can change how buff attributes are displayed (or add new attributes) by extending the <samp>BuffsDisplay.displayAttributes</samp> list.
* You can have invisible buffs by setting <samp>buff.visible = false</samp>.
For example, here's how to add a custom buff which adds +3 speed:
<syntaxhighlight lang="c#">
Buff buff = new Buff(
id: "Example.ModId_ZoomZoom",
displayName: "Zoom Zoom", // can optionally specify description text too
iconTexture: this.Helper.ModContent.Load<Texture2D>("assets/zoom.png"),
iconSheetIndex: 0,
duration: 30_000, // 30 seconds
effects: new BuffEffects()
{
Speed = { 10 } // shortcut for buff.Speed.Value = 10
}
);
Game1.player.applyBuff(buff);
</syntaxhighlight>
You can also implement your own custom effects in code by checking if the buff is active, like <code>Game1.player.hasBuff("Example.ModId_ZoomZoom")</code>.
===Custom audio===
{{/doc status|[[Modding:Audio]]|done=true}}
You can now add or edit music tracks or sound effects by editing the new <samp>Data/AudioChanges</samp> asset. New cues are added to the game's soundbank, so they can be used anywhere normal audio can be used (e.g. the <samp>Music</samp> [[Modding:Maps|map property]]). This supports <samp>.ogg</samp> and <samp>.wav</samp> files, and the vanilla audio features (e.g. randomizing audio from one ID).
Audio is also more fault-tolerant in 1.6: the game no longer crashes when playing audio which doesn't exist, it now logs an error and returns a default quiet click sound instead. (If you use <code>try..catch</code> to check if an audio cue exists, you should check <code>Game1.soundbank.Exists(name)</code> instead.)
===Custom buffs===
{{/doc status|a new doc page|done=false}}
: ''See also: [[#Buff overhaul|buff overhaul]].''
You can now define custom buffs by editing the new <samp>Data/Buffs</samp> asset. You can then use the buff from other places like <samp>Data/Object</samp>'s <samp>Buff</samp> field or the C# <samp>Buff</samp> constructor.
This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the buff.
* The value is a model with the fields listed below.
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! field
! effect
! purpose
|-
|-
| <samp>Name</samp>
| <samp>DisplayName</samp>
| A unique name for the state. This only needs to be unique within the pet type (e.g. <samp>Cat</samp> and <samp>Dog</samp> can have different behaviors with the same name).
| A [[Modding:Tokenizable strings|tokenizable string]] for the buff name.
|-
|-
| <samp>Description</samp>
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the buff name. Default none.
|-
|-
| <samp>Direction</samp>
| <samp>IsDebuff</samp>
| ''(Optional)'' The specific direction to face at the start of this state (one of <samp>left</samp>, <samp>right</samp>, <samp>up</samp>, or <samp>down</samp>), unless overridden by <samp>RandomizeDirection</samp>.
| ''(Optional)'' >Whether this buff counts as a debuff, so its duration should be halved when wearing a [[Sturdy Ring|sturdy ring]]. Default false.
|-
|-
| <samp>RandomizeDirection</samp>
| <samp>GlowColor</samp>
| ''(Optional)'' Whether to point the pet in a random direction at the start of this state (overriding the <samp>Direction</samp> if specified). Default false.
| ''(Optional)'' The glow color to apply to the player. See [[#Color fields|color format]]. Default none.
|-
|-
| <samp>IsSideBehavior</samp>
| <samp>Duration</samp>
| ''(Optional)'' Whether to constrain the pet's facing direction to left and right while the state is active. Default false.
| The duration in milliseconds for which the buff should be active. This can be set to value <samp>-2</samp> for a buff that should last for the rest of the day.
|-
</dd>
| <samp>MaxDuration</samp>
| ''(Optional)'' The maximum buff duration in milliseconds. If specified and larger than <samp>Duration</samp>, a random value between <samp>Duration</samp> and <samp>MaxDuration</samp> will be selected for each buff. Default none.
<dt>Movement:</dt>
<dd>
|-
|-
| <samp>IconTexture</samp>
| The asset name for the texture containing the buff's sprite.
|-
|-
| <samp>WalkInDirection</samp>
| <samp>IconSpriteIndex</samp>
| ''(Optional)'' Whether to walk in the pet's facing direction. Default false.
| ''(Optional)'' The sprite index for the buff icon within the <samp>IconTexture</samp>. Default 0.
|-
|-
| <samp>MoveSpeed</samp>
| <samp>Effects</samp>
| ''(Optional)'' Overrides the pet's <samp>MoveSpeed</samp> field while this state is active. Default -1 (which uses the pet's <samp>MoveSpeed</samp> value).
| ''(Optional)'' The buff attributes to apply. Default none.
This consists of a model with any combination of these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! field
! effect
! purpose
|-
|-
| <samp>SoundOnStart</samp>
| <samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel</samp>
| ''(Optional)'' An amount applied to the matching [[Skills|skill level]] while the buff is active. This can be negative for a debuff. Default 0.
|-
|-
| <samp>SoundRange</samp><br /><samp>SoundRangeFromBorder</samp>
| <samp>Attack</samp><br /><samp>Defense</samp><br /><samp>MagneticRadius</samp><br /><samp>MaxStamina</samp><br /><samp>Speed</samp>
| ''(Optional)'' An amount applied to the player's [[attack]], [[defense]], [[Magnetism|magnetic radius]], maximum [[Energy|stamina]], or [[speed]] while the buff is active. This can be negative for a debuff. Default 0.
| ''(Optional)'' Whether to mute the <samp>SoundOnStart</samp> when the 'mute animal sounds' option is set. Default false.
|}
|}
|-
|-
| <samp>ActionsOnApply</samp>
| ''(Optional)'' Run any number of [[Modding:Trigger actions|trigger action strings]] when the buff is applied to the current player. For example, this increments a player stat:
<syntaxhighlight lang="js">
"ActionsOnApply": [
"IncrementStat {{ModId}}_NumberEaten 1"
]
</syntaxhighlight>
|-
|-
| <samp>AnimationEndBehaviorChanges</samp><br /><samp>TimeoutBehaviorChanges</samp><br /><samp>PlayerNearbyBehaviorChanges</samp><br /><samp>RandomBehaviorChanges</samp><br /><samp>JumpLandBehaviorChanges</samp>
| <samp>CustomFields</samp>
| ''(Optional)'' A list of possible behavior transitions to start when the criteria are achieved. If multiple transitions are listed, a random one will be selected. If omitted, it won't affect behavior transitions.
| ''(Optional)'' The [[#Custom data fields|custom fields]] for this entry.
|}
===Custom data fields===
{{/doc status|[[Modding:Common data field types#Custom fields]]|done=true}}
Many data assets now have a <samp>CustomFields</samp> field. This is ignored by the game, but lets mods add their own data (e.g. to enable mod framework features).
<dt>Animation and per-frame sounds:</dt>
For example, a content pack can [[#Custom crops|add a crop]] with custom fields:
<dd>
{{#tag:syntaxhighlight|<nowiki>
{| class="wikitable"
{
|-
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
{
"Action": "EditData",
"Target": "Data/Crops",
"Entries": {
"Example.Id_CucumberSeeds": {
"Seasons": [ "summer" ],
"DaysInPhase": [ 1, 2, 2, 2 ],
"HarvestItemId": "Example.Id_Cucumber",
"Texture": "{{InternalAssetKey: assets/crops.png}}",
"SpriteIndex": 0,
"CustomFields": {
"Example.FrameworkMod/WetTexture": "{{InternalAssetKey: assets/crops-wet.png}}"
}
}
}
}
]
}</nowiki>|lang=javascript}}
And then a C# mod could handle the custom field if it's set:
<syntaxhighlight lang="c#">
if (Game1.currentLocation.IsRainingHere())
{
CropData data = crop.GetData();
if (data != null && data.CustomFields.TryGetValue("Example.FrameworkMod/WetTexture", out string textureName))
{
// do magic
}
}
</syntaxhighlight>
See <samp>CustomFields</samp> in the docs for each asset type to see if it's supported. Besides the sections listed on this page, custom fields were also added to <samp>Data/AdditionalFarms</samp>, <samp>Data/AdditionalLanguages</samp>, <samp>Data/FishPondData</samp>, <samp>Data/HomeRenovations</samp>, <samp>Data/Movies</samp>, and <samp>Data/SpecialOrders</samp>.
See [[Modding:Common data field types#Custom fields]] for the main docs.
===Custom giant crops===
{{/doc status|a new doc page|done=false}}
You can now add/edit [[Crops#Giant Crops|giant crops]] by editing the <samp>Data/GiantCrops</samp> data asset.
This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the giant crop.
* The value is a model with the fields listed below.
{| class="wikitable"
|-
! field
! field
! effect
! effect
|-
|-
| <samp>Animation</samp>
| <samp>FromItemId</samp>
| ''(Optional)'' The animation frames to play while this state is active. This consists of a list of models with these fields:
| The [[#Custom items|item ID]] (qualified or unqualified) for the harvest ID of the regular crop which can turn into this giant crop. For example, <samp>(O)254</samp> is [[melon]].
Any number of giant crops can use the same <samp>FromItemId</samp> value. The first giant crop whose other fields match (if any) will spawn.
|-
| <samp>HarvestItems</samp>
| The items which can be dropped when you break the giant crop. If multiple items match, they'll all be dropped.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Frame</samp>
| ''common fields''
| The frame index in the animation. This should be an incremental number starting at 0.
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields supported for harvest items.
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
|-
|-
| <samp>Duration</samp>
| <samp>Chance</samp>
| The millisecond duration for which the frame should be kept on-screen before continuing to the next frame.
| ''(Optional)'' The probability that this entry is selected, as a value between 0 (never drops) and 1 (always drops). Default 1 (100% chance).
|-
|-
| <samp>HitGround</samp>
| <samp>ForShavingEnchantment</samp>
| ''(Optional)'' Whether to play the footstep sound for the tile under the pet when the frame starts. Default false.
| ''(Optional)'' Whether this item is only dropped for [[Enchantments#Tool enchantments|Shaving enchantment]] drops (<samp>true</samp>), only when the giant crop is broken (<samp>false</samp>), or both (<samp>null</samp>). Default both.
|-
|-
| <samp>Jump</samp>
| <samp>ScaledMinStackWhenShaving</samp><br /><samp>ScaledMaxStackWhenShaving</samp>
| ''(Optional)'' Whether the pet should perform a small hop when the frame starts, including a 'dwop' sound. Default false.
| ''(Optional)'' If set, the min/max stack size when this item is dropped due to the [[Forge#Enchantments|shaving enchantment]], scaled to the tool's power level.
This value is multiplied by the health deducted by the tool hit which triggered the enchantment. For example, an iridium axe which reduced the giant crop's health by 3 points will produce three times this value per hit.
If both fields are set, the stack size is randomized between them. If only one is set, it's applied as a limit after the generic fields. If neither is set, the generic <samp>MinStack</samp>/<samp>MaxStack</samp> fields are applied as usual without scaling.
|}
|-
|-
| <samp>Sound</samp>
| <samp>Texture</samp>
| ''(Optional)'' The [[#Custom audio|audio cue ID]] for the sound to play when the animation starts or loops. If set to <samp>BARK</samp>, the pet's <samp>BarkSound</samp> (or breed's <samp>BarkOverride</samp>) field is used. Defaults to none.
| The asset name for the texture containing the giant crop's sprite.
|-
|-
| <samp>SoundRange</samp><br /><samp>SoundRangeFromBorder</samp><br /><samp>SoundIsVoice</samp>
| <samp>TexturePosition</samp>
| ''(Optional)'' The top-left pixel position of the sprite within the <samp>Texture</samp>, specified as a model with <samp>X</samp> and <samp>Y</samp> fields. Defaults to (0, 0).
|-
|-
| <samp>Shake</samp>
| <samp>TileSize</samp>
| ''(Optional)'' The millisecond duration for which to shake the pet when the state starts. Default 0.
| ''(Optional)'' The area in tiles occupied by the giant crop, specified as a model with <samp>X</samp> and <samp>Y</samp> fields. This affects both its sprite size (which should be 16 pixels per tile) and the grid of crops needed for it to grow. Note that giant crops are drawn with an extra tile's height. Defaults to (3, 3).
|-
|-
| <samp>LoopMode</samp>
| <samp>Health</samp>
| ''(Optional)'' What to do when the last animation frame is reached while the behavior is still active. The possible values are <samp>Hold</samp> (keep the last frame visible until the animation ends), <samp>Loop</samp> (restart from the first frame), or <samp>None</samp> (equivalent to <samp>Loop</samp>). Default <samp>None</samp>.
| ''(Optional)'' The health points that must be depleted to break the giant crop. The number of points depleted per [[axe]] chop depends on the axe power level. Default 3.
|-
|-
| <samp>AnimationMinimumLoops</samp><br /><samp>AnimationMaximumLoops</samp>
| <samp>Chance</samp>
| ''(Optional)'' The minimum and maximum number of times to play the animation. Both must be specified to have any effect. The game will choose an inclusive random value between them. Both default to -1 (don't repeat animation).
| ''(Optional)'' The percentage chance that a given grid of crops will grow into the giant crop each night, as a value between 0 (never) and 1 (always). Default 0.01 (1%).
Note that the chance is checked for each giant crop that applies. If three giant crops each have a 1% chance of spawning for the same crop, then there's a 3% chance that one of them will spawn.
|-
|-
| <samp>Breeds</samp>
| <samp>Condition</samp>
| The cosmetic breeds which can be selected in the character customization menu when creating a save. This consists of a list of models with these fields:
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether this giant crop is available to spawn. Defaults to always true.
|-
|-
| <samp>CustomFields</samp>
| The [[#Custom data fields|custom fields]] for this entry.
| ''(Optional)'' Override the pet's <samp>BarkSound</samp> field for this breed, if set.
| <samp>VoicePitch</samp>
|}
|}
====Pet bowl====
===Custom jukebox tracks===
{{/doc status|a new doc page|done=false}}
You can now change [[jukebox]] audio tracks by editing the new <samp>Data/JukeboxTracks</samp> data asset.
This consists of a string → model lookup, where...
* The key is the [[#Custom audio|audio cue ID]] to play (case-sensitive).
* The value is a model with the fields listed below.
If the player has heard a music track not listed in <samp>Data/JukeboxTracks</samp>, it's automatically available with the title set to the cue name. To disable a track, add an entry with <samp>"Available": false</samp>.
{| class="wikitable"
{| class="wikitable"
! effect
! effect
|-
|-
| <samp>ID</samp>
| <samp>Name</samp>
| A key which uniquely identifies this goal. The ID should only contain alphanumeric/underscore/dot characters, and custom goal IDs should ideally be prefixed with your mod ID like <samp>Example.ModId_GoalName</samp>.
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the music track's in-game title. Defaults to the ID.
|-
|-
| <samp>DisplayName</samp>
| <samp>Available</samp>
| A [[#Tokenizable string format|tokenizable string]] for the goal's display name, shown on the board in the Adventurer's Guild.
| ''(Optional)'' Whether the track should be shown in the jukebox menu. This can be <samp>true</samp> (always shown), <samp>false</samp> (never shown), or <samp>null</samp> (show if the player has heard it before). Default <samp>null</samp>.
Tracks with <samp>"Available": true</samp> are listed first in the jukebox menu.
|-
|-
| <samp>Targets</samp>
| <samp>AlternativeTrackIds</samp>
| ''(Optional)'' A list of other cue names for this audio track (not case-sensitive). If the player has heard any of these track IDs, this entry is available in the menu. Default none.
For example, this can be used when renaming a track to keep it unlocked for existing players:
<syntaxhighlight lang="js">
"{{ModId}}_TrackName": {
"Name": "{{i18n: track-name}}",
| ''(Optional)'' The [[#Custom items|qualified item ID]] for the item that can be collected from [[Gil]] when this goal is completed. There's no reward item if omitted.
"AlternativeTrackIds": [ "OldTrackName" ]
}
</syntaxhighlight>
|}
|}
===Custom shops===
===Custom movies===
====Format====
{{/doc status|[[Modding:Movie theater data]]|done=false}}
: ''See also: [[#Custom movie concessions|custom movie concessions]].''
[[Modding:Movie theater data#Movie data|Movie data]] was previously very limited and prone to mod conflicts, since (a) we needed incrementing movie IDs like <samp>spring_movie_3</samp>, (b) we were limited to one movie per season, and (c) all sprites for each movie had to be in the vanilla <samp>LooseSprites/Movies</samp> spritesheet.
Stardew Valley 1.6 revamps how movies work to address those limitations.
<dl>
<dt>Movie selection</dt>
<dd><p>Movies were previously selected based on a specific ID pattern: <samp>spring_movie_0</samp> would play in spring the year you built the movie theater, <samp>spring_movie_1</samp> would play in spring the next year, etc. That meant it'd take two in-game years to see the first custom movie, and ID conflicts had to be managed manually.</p>
In 1.6, we can now have multiple movies per month based on the new fields listed below. If multiple movies can play in the same season, each movie will be shown for an equal block of days within the month (e.g. four movies will each play for seven consecutive days). If there are more movies than days, 28 movies will be chosen at random to play that month.</dd>
<dt>New data fields</dd>
<dd>
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Items</samp>
| <samp>Seasons</samp>
| The items to add to the shop inventory. This consists of a list of values with these fields:
| ''(Optional)'' The seasons when the movie should play, or omit for any season. For example:
<syntaxhighlight lang="js">"Seasons": [ "Spring", "Summer" ]</syntaxhighlight>
|-
|-
| <samp>YearModulus</samp><br /><samp>YearRemainder</samp>
| ''(Optional)'' If set, plays the movie on alternating years based on the formula <samp>theater_age % modulus == remainder</samp>, where <samp>theater_age</samp> is the number of years since the movie theater was built. If omitted, the movie plays in any year.
|-
| ''common fields''
For example:
<syntaxhighlight lang="js">
// play in the first year, and every second year thereafter
"YearModulus": 2,
"YearRemainder": 0
</syntaxhighlight>
<syntaxhighlight lang="js">
// play in the second year, and every second year thereafter
"YearModulus": 2,
"YearRemainder": 1
</syntaxhighlight>
|-
|-
| <samp>ApplyDifficultyModifier</samp>
| <samp>Texture</samp>
| ''(Optional)'' Whether to multiply the price by the difficulty modifier, which reduces the price for higher [[options|profit margins]]. This can be <samp>true</samp> (always apply it), <samp>false</samp> (never apply it), or <samp>null</samp> (apply for certain items like saplings). This is applied before any quantity modifiers. Default <samp>null</samp>.
| ''(Optional)'' The asset name for the movie poster and screen images, or omit to use <samp>LooseSprites\Movies</samp>.
This must be a spritesheet with one 490×128 pixel row per movie. A 13×19 area in the top-left corner of the row should contain the movie poster. With a 16-pixel offset from the left edge, there should be two rows of five 90×61 pixel movie screen images, with a six-pixel gap between each image. (The movie doesn't need to use all of the image slots.)
|-
|-
| <samp>AvailableStockLimit</samp>
| <samp>CranePrizes</samp>
| ''(Optional)'' If <samp>Stock</samp> is set, how the limit is applied in multiplayer. This has no effect on recipes.
| ''(Optional)'' The items to add to the [[Movie Theater#Crane Game|crane game]] prize pool on days when this movie is playing, if any.
This consists of a list of models with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! value
! field
! effect
! effect
|-
|-
| <samp>Global</samp>
| ''common fields''
| The limit applies to every player in the world. For example, if the <samp>Stock</samp> was <samp>1</samp> and a player bought it, no other players could buy one.
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields supported for ammo items.
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
|-
|-
| <samp>Player</samp>
| <samp>Rarity</samp>
| Each player has a separate <samp>Stock</samp> limit. For example, if the <samp>Stock</samp> was <samp>1</samp>, each player could buy one.
| ''(Optional)'' The prize pool to add the item to. The possible values are <samp>1</samp> (common), <samp>2</samp> (rare), and <samp>3</samp> (deluxe). Default <samp>1</samp>.
|}
|-
|-
| <samp>None</samp>
| <samp>ClearDefaultCranePrizeGroups</samp>
| Ignore the <samp>Stock</samp> value. This is used for items that adjust their own stock via code (e.g. by checking mail).
| ''(Optional)'' The prize pools whose default items to discard, so only those specified by <samp>CranePrizes</samp> are available. Default none.
For example:
<syntaxhighlight lang="js">"ClearDefaultCranePrizeGroups": [ 2, 3 ]</syntaxhighlight>
|}
|}
</dd>
<dt>Other changes</dt>
<dd>
* <samp>Data/Movies</samp>, <samp>Data/Concessions</samp>, and <samp>Data/MoviesReactions</samp> no longer have language variants. Instead translations were moved into <samp>Strings/*</samp> assets, and the data assets use [[Modding:Tokenizable strings|tokenizable strings]] to get text.
* <samp>Data/Movies</samp> is now a list instead of a dictionary. The order determines the order movies are shown within a season. Content packs can edit them the same way as before.
* Added a <samp>debug movieSchedule {{o|year}}</samp> command to help troubleshoot movie selection.
* Added methods for C# mods: <samp>MovieTheater.GetMovieToday()</samp>, <samp>GetUpcomingMovie()</samp>, and <samp>GetUpcomingMovie(afterDate)</samp>.
</dd>
</dl>
For example, this content pack adds a new 'Pufferchick II' movie which plays in winter every third year:
{{#tag:syntaxhighlight|<nowiki>
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
{
"Action": "EditData",
"Target": "Data/Movies",
"Entries": {
"{{ModId}}_PufferchickII": {
"Id": "{{ModId}}_PufferchickII", // must specify ID again when creating a new entry
"Seasons": [ "winter" ],
|}
"YearModulus": 3,
"YearRemainder": 0,
"Title": "Pufferchick II", // display text should usually use {{i18n}} for translations in actual usage
"Description": "A sequel to the breakthrough adventure anime Pufferchick. The world is saved; what happens next?",
"Tags": [ "family", "adventure" ],
"Texture": "{{InternalAssetKey: assets/movie.png}}", // an image in your content pack
"SheetIndex": 0,
"Scenes": [ ... ]
}
}
}
]
}</nowiki>|lang=javascript}}
===Custom wedding event===
{{/doc status|a new doc page|done=false}}
The [[Marriage#The Wedding|wedding]] event can now be changed by editing the <samp>Data\Weddings</samp> data asset, which consists of a data model with two relevant fields (listed below).
{| class="wikitable"
|-
|-
! field
! effect
|-
|-
| <samp>Owners</samp>
| <samp>EventScript</samp>
| ''(Optional)'' The portrait and dialogue to show in the shop menu UI.
| The [[Modding:Event data|event scripts]] which play the wedding. The game will use the script for the spouse NPC/player if it exists, otherwise it'll use the default script.
This consists of a string → string dictionary, where...
* The key is an NPC internal name (like <samp>Abigail</samp>), unique player ID, or <samp>default</samp> for the default script (which handles marrying either an NPC or player);
* The value is a [[Modding:Tokenizable strings|tokenizable strings]] for the event script to play.
The event scripts also have access to three extra tokens:
{| class="wikitable"
{| class="wikitable"
|-
|-
! field
! token
! effect
! effect
|-
|-
| <samp>Name</samp>
| <samp>[SetupContextualWeddingAttendees]</samp>
| One of...
| The concatenated <samp>Setup</samp> values for each of the <samp>Attendees</samp> present in the wedding.
|-
|-
| <samp>Condition</samp>
| <samp>[ContextualWeddingCelebrations]</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this owner entry is available. If omitted, it's always available.
| The concatenated <samp>Celebration</samp> values for each of the <samp>Attendees</samp> present in the wedding.
|-
|-
| <samp>Portrait</samp>
| <samp>[SpouseActor]</samp>
| ''(Optional)'' One of...
| The actor ID for the NPC or other player being married (like <samp>Abigail</samp> for an NPC or <samp>farmer2</samp> for a player). This can be used in event commands like <code>faceDirection [SpouseActor] 1</code>.
(You can also use <samp>spouse</samp> as an actor ID, but that will only work when marrying an NPC.)
|}
|-
|-
| <samp>Dialogues</samp>
| <samp>Attendees</samp>
| ''(Optional)'' A list of possible dialogues if this entry is selected. Each day one dialogue will be randomly chosen to show in the shop UI. Each dialogue consists of a model with these fields:
| The other NPCs which should attend the wedding (unless they're the spouse). This consists of a string → model lookup, where the key is the internal NPC name, and the value is a model with these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! effect
! effect
|-
|-
| <samp>Id</samp>
| <samp>ID</samp>
| An ID for this dialogue. This only needs to be unique within the current dialogue list. For a custom entry, you should use a unique ID which includes your mod ID like <samo>ExampleMod.Id_DialogueName</samp>.
| The internal NPC name.
|-
|-
| <samp>Dialogue</samp>
| <samp>Setup</samp>
| The dialogue text to show, as a [[#Tokenizable string format|tokenizable string]]. The resulting text is parsed using the [[Modding:Dialogue|dialogue format]].
| The NPC's tile position and facing direction when they attend. This is equivalent to field index 2 in the [[Modding:Event data#Basic format|event basic data]].
|-
|-
| <samp>RandomDialogue</samp>
| <samp>Celebration</samp>
| ''(Optional)'' A list of dialogue texts to randomly choose from, using the same format as <samp>Dialogue</samp>. If set, <samp>Dialogue</samp> is optional and ignored. Each entry in the list has an equal probability of being chosen, and the choice is persisted for the current day. For example:
| ''(Optional)'' The [[Modding:Event data|event script]] to run during the celebration, like <samp>faceDirection Pierre 3 true</samp> which makes Pierre turn to face left. This can contain any number of script commands.
|-
|-
| <samp>Condition</samp>
| <samp>Condition</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether the dialogue should be available. If omitted, the dialogue is always available.
| ''(Optional)'' A [[Modding:Game state queries|game state query]] which indicates whether the NPC should attend. Defaults to true.
|-
| <samp>IgnoreUnlockConditions</samp>
| ''(Optional)'' Whether to add the NPC even if their entry in <samp>Data/Characters</samp> has an <samp>UnlockConditions</samp> field which doesn't match. Default false.
|}
|}
|}
|}
===Game state queries===
{| class="wikitable"
{{/doc status|[[Modding:Game state queries]]|done=true}}
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this theme should be applied. Defaults to always true.
|-
A ''game state query'' is a new vanilla way to specify conditions for some content like [[#Custom shops|shop data]], inspired by [[Modding:Content Patcher|Content Patcher]]'s conditions.
===Gender changes===
{{/doc status|[[Modding:Dialogue]]|done=false}}
* Added an [[#gender-switch|''inline gender-switch token'']] to change text depending on the player's gender. This reduces duplicate text, works in more places than the <samp>^</samp> dialogue token, works in mail and other places where <samp>^</samp> has a different meaning, and supports non-binary gender.
* For C# mod authors, added a unified <samp>Gender</samp> field for players and NPCs with the possible values <samp>Male</samp>, <samp>Female</samp>, and <samp>Unspecified</samp>. This replaces <samp>Farmer.isMale</samp> and the numeric NPC gender constants. Note that vanilla still only sets players to male or female, though mods can override it.
* Gender-specific clothing variants can now be worn by any gender.
* Removed French-only support for using <samp>^</samp> dialogue token in non-dialogue text. This is superseded by the new inline gender-switch command.
{{#tag:syntaxhighlight|<nowiki>
===Item queries===
{{/doc status|[[Modding:Item queries]]|done=true}}
''Item queries'' are a new built-in way to choose one or more items dynamically, instead of specifying a single item ID. These are used in various places like [[#Custom machines|machine data]] and [[#Custom shops|shop data]].
For example, a shop can sell a random [[House Plant|house plant]] using the <samp>RANDOM_ITEMS</samp> query:
<syntaxhighlight lang="js">
{
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"ItemId": "RANDOM_ITEMS (F) 1376 1390",
"Changes": [
"MaxItems": 1
}
</syntaxhighlight>
===Item spawn fields===
{{/doc status|[[Modding:Item queries#Item spawn fields]]|done=true}}
Several data assets (like [[#Custom machines|machines]] and [[#Custom shops|shops]]) let you configure items to create using item queries. For consistency, these all share a set of common fields.
===Color fields===
{{/doc status|[[Modding:Common data field types#Color]]|done=true}}
1.6 adds a standardized color format used in various data fields. This can be a color name, hexadecimal color code, or 8-bit RGB color code.
For example, you can set debris color in [[#Custom wild trees|<samp>Data/WildTrees</samp>]]:
<syntaxhighlight lang="js">
"DebrisColor": "White"
</syntaxhighlight>
====Vanilla shop IDs====
===<samp>modData</samp> field changes===
The <samp>modData</samp> fields are dictionaries of arbitrary string values which are synchronized in multiplayer and persisted in the save file, so mods can store custom data about the instances. The game already has the field for buildings, characters (including NPCs and players), items, locations, and terrain features.
{| class="wikitable sortable"
Stardew Valley 1.6...
* Adds <samp>modData</samp> fields to the <samp>Crop</samp>, <samp>Projectile</samp>, and <samp>Quest</samp> types too.
! shop
* Moves <samp>ModDataDictionary</samp> into the <samp>StardewValley.Mods</samp> namespace.
* Fixes <samp>Item.modData</samp> not copied when performing special equipment replacement (e.g. for the [[Pans|copper pan]] work as a hat).
|-
===Quantity modifiers===
{{/doc status|[[Modding:Common data field types#Quantity_modifiers]]|done=true}}
''Quantity modifiers'' apply dynamic changes to a numeric field in a data asset like [[#Custom shops|<samp>Data/Shops</samp>]] or [[#Custom machines|<samp>Data/Machines</samp>]]. For example, you can multiply a shop item's price or increase a machine output's quality. You can specify any number of modifiers for the same field.
===Tokenizable string format===
{{/doc status|[[Modding:Tokenizable strings]]|done=true}}
Stardew Valley 1.6 adds ''tokenizable strings'', which support any combination of literal text and token values. That includes a set of built-in tokens like <samp>FarmName</samp>, <samp>LocalizedText</samp>, etc.
For example, previously you often needed to load text from a [[Modding:Common data field types#Translation key|translation key]]. With this new format, you can use the literal text directly in the asset instead (including [[Modding:Content Patcher|Content Patcher]] tokens):
<syntaxhighlight lang="js">
// before
"Dialogue": "Strings\\StringsFromCSFiles:ShopMenu.cs.11488",
// after: any combination of literal text and tokens
"Dialogue": "Welcome to Pierre's, {{PlayerName}}! How is [FarmName] doing?",
</syntaxhighlight>
Tokenizable strings are only usable in specific fields (as indicated in their wiki or code docs).
See [[Modding:Tokenizable strings]] for usage.
===[[Modding:Event data|Event]] changes===
{{/doc status|[[Modding:Event data]]|done=false}}
====High-level changes====
* Event IDs are now [[Modding:Common data field types#Unique string ID|unique string IDs]], so mods can use a unique key instead of hoping no other mod uses the same number. Unconditional events must have an empty precondition in their key (like <samp>"Example.ModId_EventName/"</samp>) to distinguish them from forks.
* Event/festival commands with a direction argument now allow both case-insensitive names (like <samp>up</samp>) and numeric values.
* Event script errors are now logged (in addition to being shown in the chatbox like before).
* For C# mods:
** You can now add custom event preconditions & commands using new <samp>Event</samp> methods (<samp>RegisterPrecondition</samp>, <samp>RegisterPreconditionAlias</samp>, <samp>RegisterCommand</samp>, and <samp>RegisterCommandAlias</samp>).
** Added <samp>Event.fromAssetName</samp>, which indicates which data asset (if any) the event was loaded from.
** Added <samp>Game1.eventsSeenSinceLastLocationChange</samp> to track the events that played since the player arrived in their current location.
====Precondition changes====
<ul>
<li>Added validation for preconditions. If a format or assumption is invalid, the game now logs a detailed error.</li>
<li>Added case-insensitive readable names for all preconditions. For example, <code>j 4/t 800 1300/a 0 54/H</code> can now optionally be written <code>daysPlayed 4/time 800 1300/tile 0 54/isHost</code>.
{{collapse|list of new names|content=
List of new event precondition names:
<pre>
alias | readable name
----- | ------------------------------
* | WorldState
*n | HostOrLocalMail
a | Tile
b | ReachedMineBottom
B | SpouseBed
C | CommunityCenterOrWarehouseDone
c | FreeInventorySlots
D | Dating
e | SawEvent
f | Friendship
g | Gender
H | IsHost
h | MissingPet
Hn | HostMail
i | HasItem
j | DaysPlayed
J | JojaBundlesDone
L | InUpgradedHouse
m | EarnedMoney
M | HasMoney
N | GoldenWalnuts
n | LocalMail
O | Spouse
p | NpcVisibleHere
q | ChoseDialogueAnswers
r | Random
R | Roommate
S | SawSecretNote
s | Shipped
t | Time
u | DayOfMonth
v | NpcVisible
w | Weather
x | SendMail
y | Year
</pre>
And for deprecated preconditions (e.g. <code>NotSeason</code> is superseded by <code>!Season</code>):
<pre>
alias | readable name
----- | ---------------------------------
*l | NotHostOrLocalMail
A | NotActiveDialogueEvent
d | NotDayOfWeek
F | NotFestivalDay
Hl | NotHostMail
k | NotSawEvent
l | NotLocalMail
o | NotSpouse
Rf | NotRoommate
U | NotUpcomingFestival
X | NotCommunityCenterOrWarehouseDone
z | NotSeason
</pre>
}}
</li>
<li>Event & preconditions are now quote-aware, so you can escape spaces and slashes in arguments like <code>/G "SEASON Spring"/</code>.</li>
<li>Added new preconditions:
{| class="wikitable"
|-
|-
! precondition
! description
|-
|-
| [[Casino]]
| <samp>!</samp>
| <samp>Casino</samp>
| Prefixing <samp>!</samp> to any other precondition will now invert it. For example, <code>!spouse Abigail</code> will match if the player is ''not'' married to Abigail.
|-
|-
| <samp>ActiveDialogueEvent {{t|id}}</samp>
| <samp>Blacksmith</samp> (regular shop)<br /><samp>ClintUpgrade</samp> (tool upgrades)
| The special dialogue event with the given ID (including [[Modding:Dialogue#Conversation_topics|Conversation Topics]]) is in progress.
|-
|-
| [[Desert Trader|Desert trader]]
| <samp>DayOfWeek {{t|day}}+</samp>
| <samp>DesertTrade</samp>
| Today is one of the specified days (may specify multiple days). This can be a case-insensitive three-letter abbreviation (like <samp>Mon</samp>) or full name (like <samp>Monday</samp>).
|-
|-
| <samp>FestivalDay</samp>
| <samp>Dwarf</samp>
| Today is a [[Festivals|festival]] day.
|-
|-
| [[Harvey's Clinic|Harvey's clinic]]
| <samp>GameStateQuery {{t|query}}</samp>
| A [[Modding:Game state queries|game state query]] matches, like <code>G !WEATHER Here Sun</code> for 'not sunny in this location'.
|-
|-
| <samp>Season {{t|season}}+</samp>
| <samp>IceCreamStand</samp>
| The current season is one of the given values (may specify multiple seasons).
|-
|-
| [[Island Trader|Island trader]]
| <samp>Skill {{t|skill name}} {{t|min level}}</samp>
| <samp>IslandTrade</samp>
| The current farmer has reached at least {{t|min level}} for the given {{t|skill name}} (one of <samp>Combat</samp>, <samp>Farming</samp>, <samp>Fishing</samp>, <samp>Foraging</samp>, <samp>Luck</samp>, or <samp>Mining</samp>).
|-
|-
| [[Joja Mart]]
| <samp>UpcomingFestival {{t|day offset}}</samp>
| <samp>Joja</samp>
| A [[Festivals|festival]] day will occur within the given number of days.
|}</li>
<li>Changed specific preconditions:
{| class="wikitable"
|-
|-
! name
! changes
|-
|-
| [[Marnie's Ranch|Marnie's ranch]]
| <samp>ChoseDialogueAnswers</samp> (<samp>q</samp>)
|  
* Fixed precondition ignoring every second answer ID.
|-
|-
| [[Pierre's General Store|Pierre's general store]]
| <samp>InUpgradedHouse</samp> (<samp>L</samp>)
|  
* Added optional argument for the min upgrade level.
|-
|-
| [[Carpenter's Shop|Robin's carpenter shop]]
| <samp>MissingPet</samp> (<samp>h</samp>)
|  
* You can now specify any pet type ID.
* You can now omit the argument to check for a pet of any type.
|-
|-
| [[Saloon|Stardrop Saloon]]
| <samp>NotDayOfWeek</samp> (<samp>d</samp>)
|  
* You can now specify a full name like <samp>Monday</samp>.
* The day of week is now case-insensitive.
|-
|-
| [[Oasis|Sandy's Oasis shop]]
| <samp>NotSeason</samp> (<samp>z</samp>)
|  
* You can now list values (like <code>notSeason spring summer fall</code> instead of <code>notSeason fall/notSeason winter/notSeason fall</code>).
|-
|-
| [[Traveling Cart|Traveling cart]]
| <samp>ReachedMineBottom</samp> (<samp>b</samp>)
|  
* Argument is now optional (default 1).
|-
|-
| <samp>SendMail</samp> (<samp>x</samp>)
| <samp>FishShop</samp>
|  
* Deprecated; see [[#Send-mail (x) precondition deprecated|''Send-mail (x) precondition deprecated'']] for more info.
|-
|-
| <samp>Tile</samp> (<samp>a</samp>)
|  
|-
* Now also works when the player isn't currently warping, in which case it checks their current tile instead of their warp arrival tile.
|}</li>
</ul>
====Command changes====
<ul>
<li>Added validation for event commands. If a format or assumption is invalid, the game now logs a detailed error and (if applicable) skips the command, instead of crashing or silently ignoring it. This also means event arguments are stricter (e.g. you can no longer set a true/false field to an invalid value, inner quotes in quoted arguments now need to be escaped, etc).</li>
<li>Event commands are now quote-aware, so you can escape spaces and slashes in arguments like <code>/speak "I'm running A/B tests"/</code>.</li>
<li>Event commands now trim surrounding whitespace, so they can be multilined for readability. Line breaks must be before or after the <samp>/</samp> delimiter. For example:
<syntaxhighlight lang="js">
"SomeEventId/": "
none/
-1000 -1000/
farmer 5 7 0/
...
"
</syntaxHighlight>
This can be also combined with the [[Modding:Event data#Comments|comment syntax]] to add notes. For example:
<syntaxhighlight lang="js">
"SomeEventId/": "
none/ -- music/
-1000 -1000/ -- initial viewport position/
farmer 5 7 0/ -- actor positions/
...
"
</syntaxHighlight>
</li>
<li>You can now mark NPCs optional in event commands by suffixing their name with <code>?</code>. For example, <code>jump Kent?</code> won't log an error if Kent is missing. When used in the initial event positions, the NPC is only added in they exist in <samp>Data/Characters</samp> and their <samp>UnlockConditions</samp> match.</li>
<li>Added new event commands:
{| class="wikitable"
|-
|-
! command
! description
|-
|-
| [[Festival of Ice]]
| <samp>action {{t|action}}</samp>
| Run a [[Modding:Trigger actions|trigger action string]], like <samp>action AddMoney 500</samp> to add {{price|500}} to the current player.
|-
|-
| <samp>addItem {{t|item ID}} {{o|count}} {{o|quality}}</samp>
| <samp>Festival_FeastOfTheWinterStar_Pierre</samp>
| Add an item to the player inventory (or open a grab menu if their inventory is full). The {{t|item ID}} is the [[#Custom items|qualified or unqualified item ID]], and {{o|quality}} is a [[Modding:Items#Quality|numeric quality value]].
|-
|-
| [[Flower Dance]]
| <samp>addSpecialOrder {{t|order ID}}</samp><br /><samp>removeSpecialOrder {{t|order ID}}</samp>
| <samp>Festival_FlowerDance_Pierre</samp>
| Add or remove a special order to the player team. This affects all players, since special orders are shared.
|-
|-
| [[Luau]]
| <samp>eventSeen {{t|event ID}} {{o|seen}}</samp>
| <samp>Festival_Luau_Pierre</samp>
| Add or remove an event ID from the player's list of seen events, based on {{o|seen}} (default <samp>true</samp> to add).
An event can mark ''itself'' unseen using <samp>eventSeen {{t|event ID}} false</samp>. This takes effect immediately (i.e. the event won't be added to the list when it completes), but the game will prevent the event from playing again until the player changes location to avoid event loops. The event will still replay when re-entering the location.
|-
|-
| [[Night Market]] (decoration boat)
| <samp>mailToday {{t|mail key}}</samp>
| <samp>Festival_NightMarket_DecorationBoat</samp>
| Adds a letter to the mailbox immediately, given the {{t|mail key}} in <samp>Data/Mail</samp>.
|-
|-
| <samp>questionAnswered {{t|answer ID}} {{o|answered}}</samp>
| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>
| Add or remove an answer ID from the player's list of chosen dialogue answers, based on {{o|answered}} (default <samp>true</samp> to add).
|-
|-
| [[Spirit's Eve]]
| <samp>replaceWithClone {{t|NPC name}}</samp>
| Replace an NPC already in the event with a temporary copy. This allows changing the NPC for the event without affecting the real NPC.
For example, this event changes Marnie's name/portrait only within the event:
<syntaxhighlight lang="js">
"Some.ModId_ExampleEvent/": "continue/64 15/farmer 64 15 2 Marnie 64 17 0/replaceWithClone Marnie/changeName Marnie Pufferchick/changePortrait Marnie Pufferchick/[...]/end"
</syntaxhighlight>
|-
|-
| [[Stardew Valley Fair]]
| <samp>setSkipActions {{o|actions}}</samp>
| <samp>Festival_StardewValleyFair_StarTokens</samp>
| Set [[Modding:Trigger actions|trigger actions]] that should run if the player skips the event. You can list multiple actions delimited with <samp>#</samp>, or omit {{o|actions}} so no actions are run. When the player skips, the last <samp>setSkipActions</samp> before that point is applied.
|}
For example, this adds the [[Garden Pot|garden pot]] recipe and item to the player if the event is skipped, but avoids adding the item if the event already did it:
<pre>
/setSkipActions AddCraftingRecipe Current "Garden Pot"#AddItem (BC)62
/skippable
/...
/addItem (BC)62
/setSkipActions AddCraftingRecipe Current "Garden Pot"
</pre>
Skip actions aren't applied if the event completes normally without being skipped.
|-
|-
| <samp>stopSound {{t|sound ID}} {{o|immediate}}</samp>
| Stop a sound started with the <samp>startSound</samp> command. This has no effect if the sound has already stopped playing on its own (or hasn't been started). If you started multiple sounds with the same ID, this will stop all of them (e.g. <code>startSound fuse/startSound fuse/stopSound fuse</code>).
By default the sound will stop immediately. For looping sounds, you can pass <samp>false</samp> to the {{o|immediate}} argument to stop the sound when it finishes playing the current iteration instead (e.g. <code>stopSound fuse false</code>).
|-
|-
| <samp>temporaryAnimatedSprite ...</samp>
| <samp>Catalogue</samp>
| Add a temporary animated sprite to the event, using these space-delimited fields:
{| class="wikitable"
|-
|-
| [[Furniture Catalogue]]
! index
| <samp>Furniture Catalogue</samp>
! field
|}
! effect
|-
| 0
| <samp>texture</samp>
| The asset name for texture to draw.
|-
| 1–4
| <samp>rectangle</samp>
| The pixel area within the <samp>texture</samp> to draw, in the form <samp>{{t|x}} {{t|y}} {{t|width}} {{t|height}}</samp>.
|-
| 5
| <samp>interval</samp>
| The millisecond duration for each frame in the animation.
|-
| 6
| <samp>frames</samp>
| The number of frames in the animation.
|-
| 7
| <samp>loops</samp>
| The number of times to repeat the animation.
|-
| 8–9
| <samp>tile</samp>
| The tile position at which to draw the sprite, in the form <samp>{{t|x}} {{t|y}}</samp>.
|-
| 10
| <samp>flicker</samp>
| Causes the sprite to flicker in and out of view repeatedly. (one of <samp>true</samp> or <samp>false</samp>).
|-
| 11
| <samp>flip</samp>
| Whether to flip the sprite horizontally when it's drawn (one of <samp>true</samp> or <samp>false</samp>).
|-
| 12
| <samp>sort tile Y</samp>
| The tile Y position to use in the layer depth calculation, which affects which sprite is drawn on top if two sprites overlap. The larger the number, the higher layer the sprite is on.
|-
<li>Fixed NPCs only using a <code>{day name}{hearts}_{year}</code> dialogue if they also have a <code>{day name}{hearts}</code> one.</li>
| 13
| <samp>alpha fade</samp>
| Fades out the sprite based on alpha set. The larger the number, the faster the fade out. 1 is instant.
|-
| 14
| <samp>scale</samp>
| A multiplier applied to the sprite size (in addition to the normal 4× pixel zoom).
|-
| 15
| <samp>scale change</samp>
| Changes the scale based on the multiplier applied on top of the normal zoom. Continues endlessly.
|-
| 16
| <samp>rotation</samp>
| The rotation to apply to the sprite, measured in [[wikipedia:radians|radians]].
'''For C# mods:'''
|-
|-
| 17
| <samp>rotation change</samp>
| Continuously rotates the sprite, causing it to spin. The speed is determined by input value.
|-
|-
| <samp>ID</samp>
| 18+
| ''flags''
| Any combination of these space-delimited flags:
* <samp>color {{t|color}}</samp>: apply a [[#Color fields|standard color]] to the sprite.
* <samp>hold_last_frame</samp>: after playing the animation once, freeze the last frame as long as the sprite is shown.
* <samp>ping_pong</samp>: Causes the animation frames to play forwards and backwards alternatingly. Example: An animation with the frames 0, 1, 2 will play "0 1 2 0 1 2" without the ping_pong flag and play "0 1 2 1 0" with the ping_pong flag.
* <samp>motion {{t|x}} {{t|y}}</samp>: Sprite moves based on the values set. Numbers can be decimals or negative.
* <samp>acceleration {{t|x}} {{t|y}}</samp>: '''[TODO: document what this does]'''
* <samp>acceleration_change {{t|x}} {{t|y}}</samp>: '''[TODO: document what this does]'''
|}
|-
|-
| <samp>FilePaths</samp>
| <samp>translateName {{t|actor}} {{t|translation key}}</samp>
| A list of file paths (not asset names) from which to load the audio. These can be absolute paths or relative to the game's <samp>Content</samp> folder. Each file can be <samp>.ogg</samp> or <samp>.wav</samp>. If you list multiple paths, a random one will be chosen each time it's played.
| Set the display name for an NPC in the event to match the given translation key.
|-
|-
| <samp>Category</samp>
| <samp>warpFarmers [{{t|x}} {{t|y}} {{t|direction}}]+ {{t|default offset}} {{t|default x}} {{t|default}} {{t|direction}}</samp>
| The [[Modding:Audio#Category list|audio category]], which determines which volume slider in the game options applies. This should be one of <samp>Default</samp>, <samp>Music</samp>, <samp>Sound</samp>, <samp>Ambient</samp>, or <samp>Footsteps</samp> (see [[Modding:Audio#Category list|a description of each category]]). Defaults to <samp>Default</samp>.
| Warps connected players to the given [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinates]] and [[Modding:Event data#Directions|numeric directions]]. The {{t|x}} {{t|y}} {{t|direction}} triplet is repeated for each connected player (e.g. the first triplet is for the main player, second triplet is for the first farmhand, etc). The triplets are followed by an offset direction (one of <samp>up</samp>, <samp>down</samp>, <samp>left</samp>, or <samp>right</samp>), and a final triplet which defines the default values used by any other player.
|}
</li>
<li>Fixed some commands assuming a boolean argument is true if present, regardless of its value. This affects the <samp>changeToTemporaryMap</samp>, <samp>emote</samp>, <samp>extendSourceRect</samp>, <samp>faceDirection</samp>, <samp>globalFade</samp>, <samp>globalFadeToClear</samp>, <samp>positionOffset</samp>, and <samp>warp</samp> commands.</li>
<li>Fixed some commands assuming any value except the exact case-sensitive string <samp>true</samp> is false. This affects the <samp>animate</samp>, <samp>glow</samp>, <samp>hideShadow</samp>, <samp>ignoreMovementAnimation</samp>, <samp>temporaryAnimatedSprite</samp>, <samp>temporarySprite</samp>, and <samp>viewport</samp> commands.</li>
<li>Fixed some commands silently ignoring values they can't parse as the expected type. This affects the <samp>addItem</samp>, <samp>makeInvisible</samp>, and <samp>removeItem</samp> commands.</li>
<li>Fixed crash when some commands are passed <samp>farmer[number]</samp> for a player who's not available, or <samp>farmer[number]</samp> when they expect <samp>farmer</samp>.</li>
<li>Fixed some commands not taking into account custom farmer actors when checking <samp>farmer*</samp> actor IDs.</li>
<li>Fixed warp-out event commands able to use NPC-only or gendered warps. They now use a valid warp for the player if possible.</li>
<li>Changed specific commands:
{| class="wikitable"
|-
|-
! command
! changes
|-
|-
| <samp>addCookingRecipe</samp>
| Fixed error if player already knows the recipe.
|-
|-
| <samp>true</samp>
| <samp>addMailReceived</samp>
| Reduces memory usage when the audio cue isn't active, but increases performance impact when it's played. Playing the audio multiple times will multiply the memory and performance impact while they're active, since each play will stream a new instance. Recommended for longer audio cues (like music or ambient noise), or cues that are rarely used in a specific scenario (e.g. a sound that only plays once in an event).
|  
* Renamed to <samp>mailReceived</samp>. (The old name is now an alias, so it'll still work.)
* You can now remove a mail received by setting the optional third argument to false, like <samp>mailReceived {{t|id}} false</samp>.
|-
|-
| <samp>false</samp>
| <samp>addTemporaryActor</samp>
| Increases memory usage (since it's fully loaded into memory), but reduces performance impact when it's played. It can be played any number of times without affecting memory or performance (it'll just play the cached audio). Recommended for sound effects, or short audio cues that are played occasionally.
|  
|}
* Underscores in the asset name are now only replaced with spaces if an exact match wasn't found. You should quote arguments containing spaces instead, like <code>addTemporaryActor "White Chicken" …</code>.
* Underscores in the display name are no longer replaced with spaces. You should quote arguments containing spaces instead.
* Argument 9 ({{o|animal name}}) is now {{o|override name}}, and can be used to set the name for non-animals too.
|-
|-
| <samp>Looped</samp>
| <samp>animate</samp>
| Whether the audio cue loops continuously until stopped. Default false.
| Underscores in the NPC name are now only replaced with spaces if an exact match wasn't found. You should quote arguments containing spaces instead, like <code>animate "Mr Qi" …</code>.
|-
|-
| <samp>UseReverb</samp>
| <samp>ambientLight</samp>
| Whether to apply a [[wikipedia:Reverberation|reverb]] effect to the audio. Default false.
| Removed four-argument form (which was unused and had confusing behavior). The other versions of <samp>ambientLight</samp> still work like before.
|-
|-
| <samp>awardFestivalPrize</samp>
| Added support for arbitrary item IDs, like <code>awardFestivalPrize (O)128</code> for a pufferfish.
|-
|-
| <samp>ID</samp>
| <samp>changeLocation</samp>
| The unqualified item ID produced by the underlying crop (''i.e.'' the [[Modding:Crop data|'index of harvest' field in <samp>Data/Crops</samp>]]). The giant crop has a chance of growing when there's a grid of fully-grown crops which produce this item ID in a grid of <samp>TileSize</samp> tiles.
| It now updates the event position offset if needed.
|-
|-
| <samp>Texture</samp>
| <samp>changeName</samp>
| The asset name for the texture containing the giant crop's sprite.
| Underscores in the NPC name are no longer replaced with spaces. You should quote arguments containing spaces instead, like <code>changeName Leo "Neo Leo"</code>.
|-
|-
| <samp>Corner</samp>
| <samp>changePortrait</samp><br /><samp>changeSprite</samp>
| You can now omit the suffix argument to reset the NPC back to their normal portrait/sprite.
|-
|-
| <samp>TileSize</samp>
| <samp>faceDirection</samp>
| ''(Optional)'' The area in tiles occupied by the giant crop, specified as a model with <samp>X</samp> and <samp>Y</samp> fields. This affects both its sprite size (which should be 16 pixels per tile) and the grid of crops needed for it to grow. Note that giant crops are drawn with an extra tile's height. Defaults to (3, 3).
| You can now specify the direction in words, like <samp>faceDirection up</samp>
|-
|-
| <samp>Chance</samp>
| <samp>ignoreMovementAnimation</samp>
| ''(Optional)'' The percentage chance a given grid of crops will grow into the giant crop each night, as a value between 0 (never) and 1 (always). Default 0.01.
|  
* Fixed its ''ignore'' argument being ignored.
* Underscores in the NPC name are now only replaced with spaces if an exact match wasn't found. You should quote arguments containing spaces instead, like <code>ignoreMovementAnimation "Mr Qi" …</code>.
|-
|-
| <samp>HarvestedItemId</samp>
| <samp>itemAboveHead</samp>
| ''(Optional)'' The item ID which is harvested when you break the giant crop. Defaults to the <samp>ID</samp>.
| Added support for arbitrary item IDs, like <code>itemAboveHead (O)128</code> for a pufferfish.
|-
|-
| <samp>MinYields</samp>
| <samp>makeInvisible</samp>
| ''(Optional)'' The minimum number of the <samp>HarvestedItemId</samp> to drop when the giant crop is broken.
| Fixed terrain features not hidden when using the default area size.
|-
|-
| <samp>MaxYields</samp>
| <samp>playSound</samp>
| ''(Optional)'' The maximum number of the <samp>HarvestedItemId</samp> to drop when the giant crop is broken. Default 21.
| Sounds started via <samp>playSound</samp> now stop automatically when the event ends.
|-
|-
| <samp>removeItem</samp>
| Added argument for an optional count, like <code>removeItem (O)128 10</code> to remove 10 pufferfish.
|-
|-
| <samp>WeddingEvent</samp>
| <samp>speak</samp>
| The [[Modding:Event data|event]] script which plays the wedding. The default script automatically handles marrying either an NPC or player, but mods can edit it conditionally to run a custom script (e.g. if the player is marrying their custom NPC).
| Fixed friendship & socialize quest not updated when calling it with a translation key.
|}</li>
<li>Removed some commands:
{| class="wikitable"
|-
|-
! command
! changes
|-
|-
| <samp>addToTable</samp>
| Removed (it was unused and worked in counterintuitive ways).
|-
|-
| <samp>ID</samp>
| <samp>addTool</samp>
| The internal NPC name.
| Removed (it was unused and only supported the [[Return Scepter|return scepter]]). Use <samp>addItem</samp> instead, which supports adding tools.
|-
|-
| <samp>Setup</samp>
| <samp>grabObject</samp>
| The NPC's tile position and facing direction when they attend. This is equivalent to field index 2 in the [[Modding:Event data#Basic format|event basic data]].
| Removed (it was unused and broken).
|-
|-
| <samp>Celebration</samp>
| <samp>showRivalFrame</samp><br /><samp>taxVote</samp>
| Removed (they were part of unimplemented features).
|-
|-
| <samp>Condition</samp>
| <samp>weddingSprite</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether the NPC should attend. Defaults to true.
| Removed (it was broken and unused).
|}
|}
</ul>
===Game state queries===
====Festival changes====
* Festivals can now have a custom festival-started notification message by setting the <samp>startedMessage</samp> field in <samp>Data/Festivals/*</samp> to a [[Modding:Tokenizable strings|tokenizable string]].
* Festivals now set the event ID to a value like <samp>festival_fall16</samp>, instead of <samp>-1</samp>.
* All in-festival data fields now support [[Modding:Festival data#Year variants|year variants]].
* Fixed NPCs getting duplicated in festivals if they're added to the <samp>set-up</samp> fields multiple times. Subsequent entries now move them instead.
* Fixed [[Modding:Festival data#Year variants|year variants]] for festival <samp>set-up</samp> field being appended to the main script instead of replacing it.
====Send-mail (<samp>x</samp>) precondition deprecated====
Using the <samp>x</samp> event precondition as a way to send mail is now deprecated (but still works). You should use [[#Trigger actions|trigger actions]] instead to perform actions like that.
All vanilla events which used it have been replaced by equivalent trigger actions. This event IDs below no longer exist; if you check them (e.g. via <samp>HasSeenEvent</samp>), you'll need to check the new action or the mail flag they set instead.
<dl>
{| class="wikitable"
{| class="wikitable"
|-
|-
! Condition
! old event ID
! effect
! new action ID
! mail flag
|-
|-
| <samp>DAY_OF_MONTH {{t|day}}</samp>
| <samp>68</samp>
| The day of month. This can be an integer between 0 and 28, or <samp>even</samp>/<samp>odd</samp> to match on any even/odd day.
| <samp>Mail_Mom_5K</samp>
| <samp>mom1</samp>
|-
|-
| <samp>DAY_OF_WEEK {{t|day}}</samp>
| <samp>69</samp>
| The day of week. This can be an integer between 0 (Sunday) and 6 (Saturday), three-letter English name (like <samp>Fri</samp>), or full English name (like <samp>Friday</samp>).
| <samp>Mail_Mom_15K</samp>
| <samp>mom2</samp>
|-
|-
| <samp>DAYS_PLAYED {{t|count}}</samp>
| <samp>70</samp>
| Whether at least {{t|count}} days have been played in the current save (including the current one). This always increments in sync with the date in the base game, but when mods change the in-game date, they may or may not update this value.
| <samp>Mail_Mom_32K</samp>
| <samp>mom3</samp>
|-
|-
| <samp>IS_FESTIVAL_DAY {{o|day offset}}</samp>
| <samp>71</samp>
| Whether there's a festival today, with an optional {{o|day offset}} (e.g. 1 for tomorrow).
| <samp>Mail_Mom_120K</samp>
| <samp>mom4</samp>
|-
|-
| <samp>IS_PASSIVE_FESTIVAL_OPEN {{t|id}}</samp>
| <samp>72</samp>
| Whether a [[#Custom passive festivals|passive festival]] with the given ID is active today, and the current time is within its opening hours.
| <samp>Mail_Dad_5K</samp>
| <samp>dad1</samp>
|-
|-
| <samp>IS_PASSIVE_FESTIVAL_TODAY {{t|id}}</samp>
| <samp>73</samp>
| Whether a [[#Custom passive festivals|passive festival]] with the given ID is active today.
| <samp>Mail_Dad_15K</samp>
| <samp>dad2</samp>
|-
|-
| <samp>SEASON {{t|season}}+</samp>
| <samp>74</samp>
| The season (one of <samp>spring</samp>, <samp>summer</samp>, <samp>fall</samp>, or <samp>winter</samp>). You can specify multiple possible values (like <samp>SEASON spring summer</samp> for spring ''or'' summer).
| <samp>Mail_Dad_32K</samp>
| <samp>dad3</samp>
|-
|-
| <samp>TIME {{t|min}} {{t|max}}</samp>
| <samp>75</samp>
| Whether the current time is between {{t|min}} and {{t|max}} inclusively, specified in [[Modding:Modder Guide/Game Fundamentals#Time format|26-hour time]]. Each value can be set to 0 or less to ignore it (''e.g.'' <samp>TIME 900 -1</samp> for 9am or later).
| <samp>Mail_Dad_120K</samp>
| <samp>dad4</samp>
|-
|-
| <samp>YEAR {{t|min year}}</samp>
| <samp>76</samp>
| Whether the year is equal '''or more than''' the given value. For example, <code>YEAR 2</code> is true in year 2 and all later years.
| <samp>Mail_Tribune_UpAndComing</samp>
|}
| <samp>newsstory</samp>
</dd>
|-
|-
| <samp>706</samp>
| <samp>Mail_Pierre_Fertilizers</samp>
| <samp>fertilizers</samp>
|-
|-
| <samp>CAN_BUILD_CABIN</samp>
| <samp>707</samp>
| Whether players can build more [[cabin]]s (i.e. they haven't reached the maximum number of player slots yet).
| <samp>Mail_Pierre_FertilizersHighQuality</samp>
| <samp>fertilizers2</samp>
|-
|-
| <samp>CAN_BUILD_FOR_CABINS {{t|building ID}}</samp>
| <samp>909</samp>
| Whether there are fewer of the given building constructed than there are cabins.
| <samp>Mail_Robin_Woodchipper</samp>
| <samp>WoodChipper</samp>
|-
|-
| <samp>FARM_CAVE {{t|type}}</samp>
| <samp>2111194</samp>
| The current [[The Farm#The Cave|farm cave]] (one of <samp>Bats</samp>, <samp>Mushrooms</samp>, or <samp>None</samp>).
| <samp>Mail_Emily_8heart</samp>
| <samp>EmilyClothingTherapy</samp>
|-
|-
| <samp>FARM_NAME {{t|name}}</samp>
| <samp>2111294</samp>
| The name of the farm.
| <samp>Mail_Emily_10heart</samp>
| <samp>EmilyCamping</samp>
|-
|-
| <samp>FARM_TYPE {{t|type}}</samp>
| <samp>2346091</samp>
| The [[Farm Maps|farm type]]. The {{t|type}} can be one of...
| <samp>Mail_Alex_10heart</samp>
| <samp>joshMessage</samp>
|-
|-
| <samp>FOUND_ALL_LOST_BOOKS</samp>
| <samp>2346092</samp>
| Whether all the [[Lost Books]] for the [[museum]] have been found.
| <samp>Mail_Sam_10heart</samp>
| <samp>samMessage</samp>
|-
|-
| <samp>IS_COMMUNITY_CENTER_COMPLETE</samp>
| <samp>2346093</samp>
| Whether the [[Community Center|community center]] has been repaired.
| <samp>Mail_Harvey_10heart</samp>
| <samp>harveyBalloon</samp>
|-
|-
| <samp>IS_CUSTOM_FARM_TYPE</samp>
| <samp>2346094</samp>
| Whether the [[Farm Maps|farm type]] is a custom one created by a mod. (This returns false for mods which edit/replace a vanilla farm type.)
| <samp>Mail_Elliott_10heart</samp>
| <samp>elliottBoat</samp>
|-
|-
| <samp>IS_HOST</samp>
| <samp>2346095</samp>
| Whether the current player is the main/host player.
| <samp>Mail_Elliott_8heart</samp>
| <samp>elliottReading</samp>
|-
|-
| <samp>IS_ISLAND_NORTH_BRIDGE_FIXED</samp>
| <samp>2346096</samp>
| Whether the [[Ginger Island#Island North|North Ginger Island]] bridge to the dig site has been repaired.
| <samp>Mail_Penny_10heart</samp>
| <samp>pennySpa</samp>
|-
|-
| <samp>IS_JOJA_MART_COMPLETE</samp>
| <samp>2346097</samp>
| Whether the [[Joja Warehouse|Joja warehouse]] has been built.
| <samp>Mail_Abigail_8heart</samp>
| <samp>abbySpiritBoard</samp>
|-
|-
| <samp>IS_MULTIPLAYER</samp>
| <samp>3333094</samp>
| Whether the game is currently in multiplayer mode (regardless of whether there's multiple players connected).
| <samp>Mail_Pierre_ExtendedHours</samp>
| <samp>pierreHours</samp>
|-
|-
| <samp>IS_VISITING_ISLAND {{t|name}}</samp>
| <samp>3872126</samp>
| Whether the named NPC is visiting [[Ginger Island]] today.
| <samp>Mail_Willy_BackRoomUnlocked</samp>
| <samp>willyBackRoomInvitation</samp>
|}
===[[Modding:Mail data|Mail]] changes===
{{/doc status|[[Modding:Mail data]]|done=false}}
<ul>
<li>Mail can now have multiple items attached (using multiple <samp>%item</samp> commands). When the player grabs the top item, the next one will appear in the slot to grab next.</li>
<li>Added mail commands:
{| class="wikitable"
|-
|-
! command
! effect
|-
|-
| <samp>LOCATION_IS_MINES {{t|location}}</samp><br /><samp>LOCATION_IS_SKULL_CAVE {{t|location}}</samp>
| <samp>%action {{t|action}}%%</samp>
| Whether the [[#Target location|given location]] is in [[The Mines|the mines]] or [[Skull Cavern]].
| Run a [[Modding:Trigger actions|trigger action string]], like <samp>%action AddMoney 500%%</samp> to add {{price|500}} to the current player.
|}</li>
<li>Improved mail commands:
{| class="wikitable"
|-
|-
| <samp>LOCATION_SEASON {{t|location}} [{{t|season}}]+</samp>
! command
! changes
|-
| <samp>%item</samp>
|  
* Added <samp>%item id {{t|item id}} {{o|count}}</samp> form which accepts a [[#Custom items|qualified or unqualified item ID]]. If multiple items are listed (''e.g.,'' <samp>%item id (BC)12 3 (O)34 5 %%</samp>) one set will be picked randomly. This deprecates the <samp>bigobject</samp>, <samp>furniture</samp>, <samp>object</samp>, and <samp>tools</samp> options.
* Added <samp>%item specialOrder {{t|order id}} {{o|immediately}}</samp> form to attach a special order to the letter.
* Added optional {{t|key}} argument to <samp>%item cookingRecipe {{t|key}}</samp>, to learn a specific [[Modding:Recipe data|cooking recipe]]. The previous <samp>%item cookingRecipe</samp> form (without a key) works the same way as before.
* The type argument is now case-insensitive.
* Fixed <samp>%item craftingRecipe</samp> not supporting recipe IDs containing underscores. It now checks for an exact match first, then tries replacing underscores with spaces like before, then logs a warning if neither was found instead of adding an invalid recipe.
|}</li>
<li>All wallet items are now tracked via mail flags. That adds these mail flags: <samp>HasClubCard</samp>, <samp>HasDarkTalisman</samp>, <samp>HasDwarvishTranslationGuide</samp>, <samp>HasMagicInk</samp>, <samp>HasMagnifyingGlass</samp>, <samp>HasRustyKey</samp>, <samp>HasSkullKey</samp>, <samp>HasSpecialCharm</samp>, <samp>HasTownKey</samp>, and <samp>HasUnlockedSkullDoor</samp>.</li>
<li>Fixed letter viewer error when opening an invalid letter.</li>
</ul>
===Stat changes for C# mods===
The tracked stats API (e.g. <code>Game1.stats</code> and <code>Game1.player.stats</code>) has been overhauled.
In particular, all stats are now in the underlying stat dictionary. If you use a stat field directly (like <code>stats.dirtHoed</code>), you'll need to use the property (like <code>stats.DirtHoed</code>) or method (like <code>stats.Get(StatsKey.DirtHoed)</code>). This lets the game or mods access all stats in a standard way without reflection. 1.6 also adds <samp>StatsKey</samp> constants for all stats tracked by the game.
The <samp>stats</samp> API has also been redesigned:
{| class="wikitable"
{| class="wikitable"
|-
|-
! name
! member
! effect
! comments
|-
|-
| <samp>GoldenCoconutCracked</samp>
| <samp>Values</samp>
| Whether the player has cracked open any [[Golden Coconut]]s (<samp>true</samp> or <samp>false</samp>).
| The numeric metrics tracked by the game. This replaces <samp>stats_dictionary</samp>.
|-
|-
| <samp>GoldenWalnutsFound</samp><br /><samp>GoldenWalnuts</samp>
| <samp>Get(key)</samp>
| Get the value of a tracked stat. This replaces <samp>getStat</samp>.
For example:
<syntaxhighlight lang="c#">
uint daysPlayed = Game1.stats.Get(StatKeys.DaysPlayed);
</syntaxhighlight>
|-
|-
| <samp>IsGoblinRemoved</samp>
| <samp>Set(key, value)</samp>
| Whether the [[Henchman]] has been removed, so the player can access [[Witch's Hut]] (<samp>true</samp> or <samp>false</samp>).
| Set the new value of a tracked stat. This method is new.
For example:
<syntaxhighlight lang="c#">
Game1.stats.Set(StatKeys.ChildrenTurnedToDoves, 5);
</syntaxhighlight>
|-
|-
| <samp>IsSubmarineLocked</samp>
| <samp>Increment(key)</samp><br /><samp>Increment(key, amount)</samp>
| Add the given amount to the stat (default 1), and return the new stat value. This improves on the original <samp>incrementStat</samp>.
For example:
<syntaxhighlight lang="c#">
uint stepsTaken = Game1.stats.Increment(StatKeys.StepsTaken);
</syntaxhighlight>
| The current [[The Mines#Shrine of Challenge|Shrine of Challenge]] difficulty level for the [[The Mines|mine]] or [[Skull Cavern]] (a numeric value, where <samp>0</samp> is the default level when the shrine is deactivated).
|}
|}
This can also be used to track custom mod stats, they doesn't need to be stats normally tracked by the game. Custom stats should be prefixed with your mod's unique ID to avoid conflicts:
<syntaxhighlight lang="c#">
Game1.stats.Set("Your.ModId_CustomStat", 5);
</syntaxhighlight>
And finally, setting a stat to 0 now removes it from the stats dictionary (since that's the default for missing stats).
<dt>Player info & progress</dt>
===New C# utility methods===
<dd>
Stardew Valley 1.6 adds several new methods to simplify common logic.
{| class="wikitable"
====Argument handling====
The new <samp>ArgUtility</samp> class handles splitting, reading, and validating <samp>string[]</samp> argument lists. The main methods are:
; Splitting arrays:
: {| class="wikitable"
|-
|-
! Condition
! <samp>ArgUtility</samp> method
! effect
! effect
|-
|-
| <samp>MINE_LOWEST_LEVEL_REACHED {{t|level}}</samp>
| <samp>SplitBySpace</samp>
| Whether any player has reached at least level {{t|level}} in [[The Mines|the mines]].
| Split space-separated arguments in a string. This automatically ignores extra spaces, so <samp>" x y "</samp> and <samp>"x y"</samp> are equivalent. For example:
<syntaxhighlight lang="c#">
string[] fields = ArgUtility.SplitBySpace("a b c");
string secondField = fields[1]; // "b"
</syntaxhighlight>
|-
|-
| <samp>PLAYER_COMBAT_LEVEL {{t|player}} {{t|level}}</samp><br /><samp>PLAYER_FARMING_LEVEL {{t|player}} {{t|level}}</samp><br /><samp>PLAYER_FISHING_LEVEL {{t|player}} {{t|level}}</samp><br /><samp>PLAYER_FORAGING_LEVEL {{t|player}} {{t|level}}</samp><br /><samp>PLAYER_LUCK_LEVEL {{t|player}} {{t|level}}</samp><br /><samp>PLAYER_MINING_LEVEL {{t|player}} {{t|level}}</samp>
| <samp>SplitBySpaceAndGet</samp>
| Get the value at an index in a space-delimited string (if found), else return the default value. For example:
<syntaxhighlight lang="c#">
string thirdField = ArgUtility.SplitBySpaceAndGet("a b c", 2); // "c"
string invalidFieldA = ArgUtility.SplitBySpaceAndGet("a b c", 5); // null
string invalidFieldB = ArgUtility.SplitBySpaceAndGet("a b c", 5, defaultValue: "boop"); // "boop"
</syntaxhighlight>
This is more efficient than <samp>SplitBySpace</samp> when you only need a single value, but it's slower if you need multiple values.
|-
|-
| <samp>PLAYER_CURRENT_MONEY {{t|player}} {{t|amount}}</samp>
| <samp>SplitBySpaceQuoteAware</samp>
| Split space-separated arguments in a string, with support for using quotes to protect spaces within an argument. See <samp>SplitQuoteAware</samp> below for info on quote handling.
For example:
<syntaxhighlight lang="c#">
string buildingName = ArgUtility.SplitBySpaceQuoteAware("BUILDINGS_CONSTRUCTED Here \"Junimo Hut\"")[1]; // Junimo Hut
</syntaxhighlight>
|-
|-
| <samp>PLAYER_FARMHOUSE_UPGRADE {{t|player}} {{t|level}}</samp>
| <samp>SplitQuoteAware</samp>
| Whether the [[#Target player|specified player(s)]] have upgraded their [[farmhouse]] or [[cabin]] to at least the given level (see [https://github.com/Pathoschild/StardewMods/blob/develop/ContentPatcher/docs/author-guide/tokens.md#FarmhouseUpgrade possible levels]).
| Split delimited arguments in a string, with support for using quotes to protect delimiters within an argument.
A quote in the text causes any delimiter to be ignored until the next quote, unless it's escaped like <code>\"</code>. Unescaped quotes are removed from the string. (Remember that backslashes need to be escaped in C# or JSON strings, like <code>"\\"</code> for a single backslash.)
For example:
<syntaxhighlight lang="c#">
ArgUtility.SplitQuoteAware("A,B,C", ','); // [ "A", "B", "C" ]
ArgUtility.SplitQuoteAware("A,\"B,C\",D", ','); // [ "A", "B,C", "D" ]
ArgUtility.SplitQuoteAware("A,\\\"B,C", ','); // [ "A", "\"B", "C" ]
</syntaxhighlight>
You can also set the optional arguments for more advanced cases. For example, [[Modding:Game state queries|game state queries]] use this to split twice:
<syntaxhighlight lang="c#">
string gameStateQuery = "BUILDINGS_CONSTRUCTED Here \"Junimo Hut\", SEASON Spring";
string[] queries = ArgUtility.SplitQuoteAware(gameStateQuery, ',', StringSplitOptions.RemoveEmptyEntries, keepQuotesAndEscapes: true); // [ "BUILDINGS_CONSTRUCTED Here \"Junimo Hut\"", "SEASON Spring" ]
string buildingName = ArgUtility.SplitBySpaceQuoteAware(queries[0]); // Junimo Hut
</syntaxhighlight>
|-
|-
| <samp>PLAYER_GENDER {{t|player}} {{t|gender}}</samp>
| <samp>EscapeQuotes</samp>
| Whether the [[#Target player|specified player(s)]] are <samp>Male</samp> or <samp>Female</samp>.
| Escape quotes in a string so they're ignored by methods like <samp>SplitQuoteAware</samp>.
This isn't idempotent (e.g. calling it twice will result in double-escaped quotes).
|-
|-
| <samp>PLAYER_HAS_ACHIEVEMENT {{t|player}} {{t|achievement id}}</samp>
| <samp>UnsplitQuoteAware</samp>
| Whether the [[#Target player|specified player(s)]] have unlocked a specific achievement ID. The valid IDs are listed in [[Modding:Achievement data|<samp>Data/Achievements</samp>]], plus a few Steam achievement IDs that aren't listed.
| Combine an array of arguments into a single string with a custom delimiter, using quotes where needed to escape delimiters within an argument. Calling <samp>SplitQuoteAware</samp> on the resulting string with the same delimiter will produce the original values.
For example:
<syntaxhighlight lang="c#">
string args = ArgUtility.UnsplitQuoteAware(new[] { "A", "B C", "D" }, ' '); // A "B C" D
</syntaxhighlight>
This isn't idempotent (e.g. calling it twice will result in double-escaped quotes).
|}
; Reading arrays:
: {| class="wikitable"
|-
|-
! <samp>ArgUtility</samp> method
! effect
|-
|-
| <samp>PLAYER_HAS_CAUGHT_FISH {{t|player}} {{t|id}}</samp>
| <samp>HasIndex</samp>
| Whether the [[#Target player|specified player(s)]] have caught at least one fish with the given ID.
| Get whether an index is within the bounds of the array. For example:
<syntaxhighlight lang="c#">
string[] fields = ArgUtility.SplitByString("10 5");
bool inRange = ArgUtility.HasIndex(fields, 1); // true (index 1 has the value '5')
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_CONVERSATION_TOPIC {{t|player}} {{t|id}}</samp>
| <samp>Get</samp><br /><samp>GetBool</samp><br /><samp>GetDirection</samp><br /><samp>GetEnum</samp><br /><samp>GetFloat</samp><br /><samp>GetInt</samp>
| Whether the [[#Target player|specified player(s)]] have a [[Modding:Dialogue#Conversation topics|conversation topic]] with the ID {{t|id}} active.
| Get the value at a position in an array, parsed as the relevant type (e.g. a string, boolean, [[Modding:Event data#Directions|direction]], enum, etc). If the index isn't in the array or the value can't be parsed as the expected type, returns a default value.
For example, code like this:
<syntaxhighlight lang="c#">
int value = fields.Length > 4 && int.TryParse(fields[4], out int parsed)
? parsed
: -1;
</syntaxhighlight>
Can now be rewritten like this:
<syntaxhighlight lang="c#">
int value = ArgUtility.GetInt(fields, 4, -1);
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_CRAFTING_RECIPE {{t|player}} {{t|recipe name}}</samp><br /><samp>PLAYER_HAS_COOKING_RECIPE {{t|player}} {{t|recipe name}}</samp>
| <samp>TryGet</samp><br /><samp>TryGetBool</samp><br /><samp>TryGetDirection</samp><br /><samp>TryGetEnum</samp><br /><samp>TryGetFloat</samp><br /><samp>TryGetInt</samp><br /><samp>TryGetPoint</samp><br /><samp>TryGetRectangle</samp><br /><samp>TryGetVector2</samp>
| Whether the [[#Target player|specified player(s)]] know the crafting/cooking recipe identified by its internal name (spaces allowed). For example, <code>PLAYER_HAS_CRAFTING_RECIPE CURRENT Field Snack</code>.
| Try to get a parsed value from an array by its index. If it's not found or can't be converted to the expected value, it sets the <samp>out string error</samp> argument so you can log an error if needed.
For example, this parses a numeric value from a space-delimited string:
<syntaxhighlight lang="c#">
string[] fields = ArgUtility.SplitByString("10 35");
if (ArgUtility.TryGetInt(fields, 1, out int value, out string error))
this.Helper.Monitor.Log($"Parsed value: {value}"); // "Parsed value: 35"
else
this.Helper.Monitor.Log($"Failed parsing value: {error}", LogLevel.Warn);
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_DIALOGUE_ANSWER {{t|player}} {{t|id}}</samp>
| <samp>TryGetOptional</samp><br /><samp>TryGetOptionalBool</samp><br /><samp>TryGetOptionalDirection</samp><br /><samp>TryGetOptionalEnum</samp><br /><samp>TryGetOptionalFloat</samp><br /><samp>TryGetOptionalInt</samp><br /><samp>TryGetOptionalRemainder</samp>
| Whether the [[#Target player|specified player(s)]] have chosen the given dialogue answer in a previous dialogue.
| Equivalent to <samp>TryGet*</samp>, except that it'll return a default value if the argument is missing. For example:
<syntaxhighlight lang="c#">
string[] fields = ArgUtility.SplitByString("10");
if (ArgUtility.TryGetOptionalInt(fields, 1, out int value, out error, defaultValue: 99))
this.Helper.Monitor.Log($"Parsed value: {value}"); // "Parsed value: 99"
else
this.Helper.Monitor.Log($"Failed parsing value: {error}", LogLevel.Warn);
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_FLAG {{t|player}} {{t|id}}</samp>
| <samp>GetRemainder</samp><br /><samp>TryGetRemainder</samp><br /><samp>TryGetOptionalRemainder</samp>
| Whether the [[#Target player|specified player(s)]] have the given [[Modding:Mail data|mail flag]] set (with spaces allowed in the {{t|id}}).
| Similar to the previous methods, but gets arguments starting from an index as a concatenated string. For example:
<syntaxhighlight lang="c#">
string[] fields = ArgUtility.SplitByString("A B C D E F");
if (ArgUtility.TryGetRemainder(fields, 2, out string remainder, out string error))
this.Helper.Monitor.Log($"Remainder: {remainder}"); // "Remainder: C D E F"
else
this.Helper.Monitor.Log($"Failed getting remainder: {error}", LogLevel.Warn);
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_ITEM {{t|player}} {{t|item}} {{o|count}}</samp>
| <samp>GetSubsetOf</samp>
| Whether the [[#Target player|specified player(s)]] have at least one of a normal item (not bigcraftable, furniture, etc) in their inventory. The {{t|item}} can be <samp>858</samp> (Qi Gems), <samp>73</samp> (Walnuts), or the [[#Custom items|qualified or unqualified item ID]].
| Get a slice of the input array. For example:
<syntaxhighlight lang="c#">
string[] subset1 = ArgUtility.GetSubsetOf(new[] { "A", "B", "C", "D" }, startAt: 1); // B, C, D
string[] subset2 = ArgUtility.GetSubsetOf(new[] { "A", "B", "C", "D" }, startAt: 1, length: 2); // B, C
</syntaxhighlight>
This is fault-tolerant as long as <samp>startAt</samp> isn't negative. For example:
<syntaxhighlight lang="c#">
string[] subset2 = ArgUtility.GetSubsetOf(new[] { "A", "B", "C", "D" }, startAt: 100); // <empty array>
string[] subset1 = ArgUtility.GetSubsetOf(new[] { "A", "B", "C", "D" }, startAt: 1, length: 100); // B, C, D
</syntaxhighlight>
|}
====Content assets====
{| class="wikitable"
|-
|-
! method
! effect
|-
|-
| <samp>PLAYER_HAS_READ_LETTER {{t|player}} {{t|id}}</samp>
| <samp>LocalizedContentManager.DoesAssetExist</samp>
| Whether the [[#Target player|specified player(s)]] have read a letter, where {{t|id}} is the internal mail ID (spaces allowed). For example, <code>PLAYER_HAS_READ_LETTER Any Visited_Island</code>.
| Get whether an asset exists in the game's <samp>Content</samp> folder or is provided through [[Modding:Modder Guide/APIs/Content|SMAPI's content API]]. For example:
<syntaxhighlight lang="c#">
bool exists = Game1.content.DoesAssetExist<Map>("Maps/Town");
</syntaxhighlight>
|-
|-
| <samp>PLAYER_HAS_SECRET_NOTE {{t|player}} {{t|id}}</samp>
| <samp>LocalizedContentManager.IsValidTranslationKey</samp>
| Whether the [[#Target player|specified player(s)]] have read a secret note, where {{t|id}} is the secret note's integer ID.
| Get whether a string is a translation key in the form <samp>{{t|asset name}}:{{t|key}}</samp>, and the asset and key both exist. For example:
<syntaxhighlight lang="c#">
bool exists = Game1.content.IsValidTranslationKey("Strings\\NPCNames:Abigail");
</syntaxhighlight>
|}
====Filtering====
The game now has an optimized <samp>RemoveWhere</samp> method for O(n) filtering on <samp>NetCollection</samp>, <samp>NetDictionary</samp>, <samp>NetList</samp>, and (via extension) <samp>IDictionary</samp>. This also deprecates <samp>Filter</samp> methods where they existed.
For example:
<syntaxhighlight lang="c#">
int dirtTilesRemoved = Game1.currentLocation.terrainFeatures.RemoveWhere(pair => pair.Value is HoeDirt);
</syntaxhighlight>
====Game paths====
The game folder paths were previously hardcoded throughout the code. These are now centralized with a few methods:
{| class="wikitable"
|-
|-
! method
! effect
|-
|-
| <samp>PLAYER_MOD_DATA {{t|player}} {{t|key}} {{t|value}}</samp>
| <samp>Program.GetLocalAppDataFolder</samp><br /><samp>Program.GetAppDataFolder</samp>
| Whether the [[#Target player|specified player(s)]] have a <samp>player.modData</samp> entry added by a mod with the given {{t|key}} and {{t|value}}.
| Get the absolute path to the game's app data folder (which contains the [[saves|<Samp>Saves</samp> folder]]) or local app data folder (which contains <samp>ErrorLogs</samp> and <samp>Screenshots</samp>). These methods are equivalent on Windows, but different on Linux/macOS.
|-
|-
| <samp>PLAYER_MONEY_EARNED {{t|player}} {{t|amount}}</samp>
| <samp>Program.GetSavesFolder</samp>
| Whether the [[#Target player|specified player(s)]] have earned at least {{t|amount}} gold.
| Get the absolute path to the game's [[saves|<samp>Saves</samp> folder]].
|-
|-
| <samp>PLAYER_SHIPPED_BASIC_ITEM {{t|player}} {{t|item ID}} {{o|min count}}</samp>
| <samp>Game1.GetScreenshotFolder</samp>
| Whether the [[#Target player|specified player(s)]] have shipped the given item at least {{o|min count}} times (or once if the min isn't specified). This only works for the items tracked by the game for shipping stats (shown in the [[Shipping#Collection|shipping collections menu]]).
| Get the absolute path to the game's <samp>Screenshots</samp> folder.
|-
|-
| <samp>PLAYER_SPECIAL_ORDER_ACTIVE {{t|player}} {{t|order id}}</samp>
| <samp>options.GetFilePathForDefaultOptions</samp>
| Whether the [[#Target player|specified player(s)]] have the given [[Special Orders|special order]] active.
| Get the absolute path to the game's <samp>default_options</samp> file.
|}
| Whether the [[#Target player|specified player(s)]] have a special rule active for a [[Special Orders|special order]]. Some vanilla rules are...
====Hash sets====
Since the [[#Hash set fields|game now uses hash sets]], it has a few extensions for working with them:
{| class="wikitable"
{| class="wikitable"
|-
|-
! rule ID
! method
! effect
! effect
|-
|-
| <samp>DROP_QI_BEANS</samp>
| <samp>AddRange</samp>
| The player can find [[Qi Beans]] for the ''Qi's Crop'' order.
| Add all the values from a list or enumerable to the set.
|-
|-
| <samp>LEGENDARY_FAMILY</samp>
| <samp>RemoveWhere</samp>
| The player catch the new legendary fish for the ''Extended Family'' order.
| Remove all values matching a condition.
|-
|-
| <samp>MINE_HARD</samp><br /><samp>SC_HARD</samp>
| <samp>Toggle</samp>
| Raises the difficulty level of the mines or [[Skull Cavern]].
| Add or remove a value in the set based on a boolean. For example:
<syntaxhighlight lang="c#">
public bool hasClubCard
{
get { return mailReceived.Contains("HasClubCard"); }
set { mailReceived.Toggle("HasClubCard", value); }
}
</syntaxhighlight>
|}
|}
<dt>Player relationships</dt>
====Iteration====
<dd>
The new <samp>Utility.ForEach*</samp> methods let you check every thing of a type in the game world quickly and efficiently (with minimal allocations, boxing, etc). These are significantly faster than equivalent code using LINQ or <samp>yield</samp> methods.
{| class="wikitable"
{| class="wikitable"
|-
|-
! Condition
! method
! effect
! effect
|-
|-
| <samp>PLAYER_HAS_CHILDREN {{t|player}} {{t|count}}</samp>
| <samp>Utility.ForEachBuilding</samp>
| Perform an action for each building in the game world.
| Whether the [[#Target player|specified player(s)]] have a [[Animals#Cat or Dog|pet]].
|-
|-
| <samp>PLAYER_HEARTS {{t|player}} {{t|npc}} {{t|heart level}}</samp>
| <samp>Utility.ForEachCharacter</samp><br /><samp>Utility.ForEachVillager</samp>
| Whether the [[#Target player|specified player(s)]] have a friend with at least {{t|heart level}} hearts of [[friendship]]. The {{t|npc}} can be an NPC's internal name, <samp>Any</samp> (check every NPC), or <samp>AnyDateable</samp> (check every romanceable NPC).
| Perform an action for each NPC in the game world. <samp>ForEachCharacter</samp> matches all NPC types (villagers, horses, pets, monsters, player children, etc), while <samp>ForEachVillager</samp> only matches villager NPCs like [[Abigail]].
|-
|-
| <samp>PLAYER_HAS_MET {{t|player}} {{t|npc}}</samp>
| <samp>Utility.ForEachCrop</samp>
| Whether the [[#Target player|specified player(s)]] have talked to an NPC at least once. The {{t|npc}} is an NPC's internal name.
| Perform an action for each crop in the game world planted in the ground or in a [[Garden Pot|garden pot]].
|-
|-
| <samp>PLAYER_IS_DATING {{t|player}} {{t|npc}}</samp><br /><samp>PLAYER_IS_ENGAGED {{t|player}} {{t|target}}</samp><br /><samp>PLAYER_IS_MARRIED {{t|player}} {{t|target}}</samp><br /><samp>PLAYER_IS_DIVORCED {{t|player}} {{t|npc}}</samp>
| <samp>Utility.ForEachItem</samp>
| Whether the [[#Target player|specified player(s)]] have this relationship status with an NPC. The player is dating after giving the NPC a [[bouquet]], and engaged after giving a [[Mermaid's Pendant]] but before the marriage. The {{t|npc}} can be an NPC's internal name, or <samp>Any</samp> (check every romanceable NPC).
| Perform an action for each item in the game world, including items within items (e.g. in a chest or on a table), hats placed on children, items in player inventories, etc.
|-
|-
| <samp>PLAYER_IS_ROOMMATE {{t|player}} {{t|target}}</samp>
| <samp>Utility.ForEachItemIn</samp>
| Whether the [[#Target player|specified player(s)]] have a roommate. The {{t|target}} can be an NPC's internal name, <samp>Any</samp> (with any NPC), or <samp>Player</samp> (always false).
| Perform an action for each item within a given location, including items within items (e.g. in a chest or on a table).
|-
|-
| <samp>PLAYER_PREFERRED_PET {{t|player}} {{t|pet}}</samp>
| <samp>Utility.ForEachLocation</samp>
| Whether the preferred pet for the [[#Target player|specified player(s)]] is <samp>Cat</samp> or <samp>Dog</samp>.
| Perform an action for each location in the game world, optionally including building interiors and generated [[The Mines|mine]] or [[Volcano Dungeon|volcano]] levels.
|}
|}
<dt>Randomization</dt>
For example, this code counts how many parsnips are planted everywhere in the world:
<dd>
<syntaxhighlight lang="c#">
int parsnips = 0;
Utility.ForEachCrop(crop =>
{
if (crop.IndexOfHarvest == "24")
parsnips++;
return true; // whether to keep iterating after this crop
});
</syntaxhighlight>
Or you could replace all instances of an obsolete item with a new one:
<syntaxhighlight lang="c#">
Utility.ForEachItem((item, remove, replaceWith) =>
{
if (item.QualifiedItemId == "(O)OldId")
{
Item newItem = ItemRegistry.Create("(O)NewId", item.Stack, item.Quality);
replaceWith(newItem);
}
return true;
});
</syntaxhighlight>
C# mods which add custom item types can override <samp>Item.ForEachItem</samp> to add support for nested items.
====Randomization====
{| class="wikitable"
{| class="wikitable"
|-
|-
! Condition
! method
! effect
! effect
|-
|-
| <samp>RANDOM {{t|chance}} {{o|@addDailyLuck}}</samp>
| <samp>Utility.CreateDaySaveRandom</samp>
| A random probability check which is re-rolled each time it's called. For example, <code>RANDOM 0.4</code> is true 40% of the time.
| Creates a <samp>Random</samp> instance using the most common seed (based on the save ID and total days played).
|-
|-
| <samp>SYNCED_DAY_CHOICE {{t|key}} {{t|min}} {{t|max}} {{t|choices}}+</samp><br /><samp>SYNCED_TICK_CHOICE {{t|key}} {{t|min}} {{t|max}} {{t|choices}}+</samp>
| <samp>Utility.CreateRandom</samp><br /><samp>Utility.CreateRandomSeed</samp>
| Choose a random integer between {{t|min}} and {{t|max}} inclusively, and check whether it matches one of the {{t|choices}}. All queries with the same {{t|key}} value will choose the same integer for the entire day (<samp>SYNCED_DAY_CHOICE</samp>) or current game update tick (<samp>SYNCED_TICK_CHOICE</samp>). For example, <samp>SYNCED_DAY_CHOICE example_key 1 5 1 2</samp> chooses a random value between 1 and 5, and checks if it's 1 or 2.
| Creates a <samp>Random</samp> (or seed for a <samp>Random</samp>) by combining the given seed values, which can be any numeric type.
|-
|-
| <samp>SYNCED_DAY_RANDOM {{t|key}} {{t|chance}} {{o|@addDailyLuck}}</samp><br /><samp>SYNCED_TICK_RANDOM {{t|key}} {{t|chance}} {{o|@addDailyLuck}}</samp>
| <samp>Utility.TryCreateIntervalRandom</samp>
| Get an RNG which produces identical results for all RNGs created with the same sync key during the given interval (one of <samp>tick</samp>, <samp>day</samp>, <samp>season</samp>, or <samp>year</samp>), including between players in multiplayer mode.
For example, this will return the same number each time it's called until the in-game day changes:
<syntaxhighlight lang="c#">
public int GetDailyRandomNumber()
{
Utility.TryCreateIntervalRandom("day", "example sync key", out Random random, out _);
return random.Next();
}
</syntaxhighlight>
|-
|-
| <samp>SYNCED_SUMMER_RAIN_RANDOM {{t|base chance}} {{t|day multiplier}}</samp>
| <samp>Utility.TryGetRandom</samp>
| A specialized variant of <samp>SYNCED_DAY_RANDOM</samp> used to calculate the chance of rain in summer, which increases with the day number.
| Get a random entry from a dictionary.
|-
|-
| <samp>random.Choose</samp>
| Choose a random option from the values provided:
<syntaxhighlight lang="c#">
string npcName = Game1.random.Choose("Abigail", "Penny", "Sam");
</syntaxhighlight>
|-
|-
| <samp>ITEM_HAS_TAG {{t|tags}}</samp>
| <samp>random.ChooseFrom</samp>
| Whether the item has all of the given space-delimited tags. For example, <code>ITEM_HAS_TAG bone_item marine_item</code> will only match items with both tags.
| Choose a random option from a list or array:
<syntaxhighlight lang="c#">
string[] names = new[] { "Abigail", "Penny", "Sam" };
string npcName = Game1.random.ChooseFrom(names);
</syntaxhighlight>
|-
|-
| <samp>ITEM_ID {{t|item ID}}</samp>
| <samp>random.NextBool</samp>
| Whether the item has the given [[#Custom items|qualified or unqualified item ID]].
| Randomly choose <samp>true</samp> or <samp>false</samp>. For example:
<syntaxhighlight lang="c#">
bool flipSprite = Game1.random.NextBool();
</syntaxhighlight>
You can optionally set the probability of <samp>true</samp>:
<syntaxhighlight lang="c#">
bool flipSprite = Game1.random.NextBool(0.8);
</syntaxhighlight>
|}
|}
====Other====
Here are some of the other new methods:
{| class="wikitable"
{| class="wikitable"
|-
|-
! Condition
! method
! effect
! effect
|-
|-
| <samp>TRUE</samp>
| <samp>Game1.getOfflineFarmhands()</samp>
| A condition which always matches.
| Get all farmhands who aren't connected to the game.
|-
|-
| <samp>FALSE</samp>
| <samp>Game1.PerformActionWhenPlayerFree</samp>
| A condition which never matches.
| Calls the provided callback next time the player is free (e.g. no menu or event is up, not using a tool, etc). If the player is already free, it's run immediately.
For example, if you receive your first geode from a fishing chest, this is used to show the geode-received animation & animation when it closes.
|-
|-
| <samp>Game1.createRadialDebris_MoreNatural</samp>
| Scatter item debris around a position with a more randomized distribution than <samp>createRadialDebris</samp>.
|-
|-
| <samp>Here</samp>
| <samp>Object.GetCategoryColor</samp><br /><samp>Object.GetCategoryDisplayName</samp>
| The current player's location (regardless of the [[#Target player|target player]]).
| Get the color and display name for the given category number when it's shown in a tooltip.
|-
|-
| <samp>Target</samp>
| <samp>Utility.distanceFromScreen</samp>
| This value depends on the context:
| Get the pixel distance between a position in the world and the player's screen viewport, where 0 is within the viewport.
|-
|-
| <samp>Utility.DrawErrorTexture</samp>
| Draw the game's missing-texture image (🚫) to the screen, stretched to fit a given pixel area.
|-
|-
| <samp>Data/Machines</samp>
| <samp>Utility.DrawSquare</samp>
| The location containing the machine.
| Draw a square to the screen with a background color and/or borders.
|-
|-
| ''custom queries''
| <samp>Utility.GetEnumOrDefault</samp>
| Get an enum value if it's valid, else get a default value. This is mainly used to validate input from data files.
For example:
<syntaxhighlight lang="c#">
NpcGender gender = (NPCGender)999999;
gender = Utility.GetEnumOrDefault(gender, Gender.Male); // returns Gender.Male since there's no enum constant with value 999999
</syntaxhighlight>
|-
|-
| ''any other''
| <samp>Utility.getRandomNpcFromHomeRegion</samp>
| If the [[#Target player|player <samp>Target</samp>]] is set, that player's location. Otherwise equivalent to <samp>Here</samp>.
| Get a random social NPC based on their <samp>HomeRegion</samp> value in [[#Custom NPCs|<samp>Data/Characters</samp>]]. For example, this gets a random NPC for the <samp>Town</samp> home region:
<syntaxhighlight lang="c#">
NPC npc = Utility.getRandomNpcFromHomeRegion(NPC.region_town);
</syntaxhighlight>
|-
|-
| ''any other''
| <samp>Utility.isFestivalDay</samp>
| The [[#Custom locations|location ID]] (i.e. internal name) for the location to check.
| This method existed before 1.6, but you can now omit arguments to check today instead of a specific date:
<syntaxhighlight lang="c#">
bool festivalToday = Utility.isFestivalToday();
</syntaxhighlight>
====Target player====
Or check for a festival in specific location context:
<syntaxhighlight lang="c#">
bool desertFestivalToday = Utility.isFestivalToday(LocationContexts.DesertId);
</syntaxhighlight>
|-
|-
| <samp>Utility.IsPassiveFestivalDay</samp>
| This method existed before 1.6, but now can now omit arguments to check today instead of a specific date:
<syntaxhighlight lang="c#">
bool passiveFestivalToday = Utility.IsPassiveFestivalDay();
</syntaxhighlight>
Or check for a specific passive festival:
<syntaxhighlight lang="c#">
bool nightMarketToday = Utility.IsPassiveFestivalDay("NightMarket");
</syntaxhighlight>
|-
|-
| <samp>Any</samp>
| <samp>Utility.TryGetPassiveFestivalData</samp><br /><samp>Utility.TryGetPassiveFestivalDataForDay</samp>
| At least one player must match the condition, regardless of whether they're online.
| Get the [[#Custom passive festivals|passive festival data]] for the given ID or date.
|-
|-
| <samp>All</samp>
| <samp>Utility.TryParseDirection</samp>
| Every player must match the condition, regardless of whether they're online.
| Parse a string into a direction value (like <samp>Game1.down</samp>), if it's valid. This supports case-insensitive direction names (one of <samp>down</samp>, <samp>left</samp>, <samp>right</samp>, or <samp>up</samp>) or [[Modding:Event data#Directions|numeric values]].
|-
|-
| <samp>Current</samp>
| <samp>Utility.TryParseEnum</samp>
| The local player.
| Parse a string into an enum value if possible, case-insensitively. Unlike [https://learn.microsoft.com/en-us/dotnet/api/system.enum.tryparse <samp>Enum.TryParse</samp>], an invalid numeric value won't be cast:
<syntaxhighlight lang="c#">
Enum.TryParse("999999", out DayOfWeek day); // true, even though there's no matching DayOfWeek value
Utility.TryParseEnum("999999", out DayOfWeek day); // false
</syntaxhighlight>
|-
|-
| <samp>Host</samp>
| <samp>Utility.fuzzyCompare</samp>
| The main player.
| Get whether a term is a fuzzy match for a search query. Returns the numeric match priority (where lower values are a better match), or null if the term doesn't match the query.
|-
|-
| <samp>Target</samp>
| <samp>rectangle.GetPoints</samp><br /><samp>rectangle.GetVectors</samp>
| This value depends on the context:
| Get all the integer coordinates within a given <samp>Rectangle</samp>. For example:
<syntaxhighlight lang="c#">
var tileArea = new Rectangle(0, 0, 2, 2);
Point[] tiles = tileArea.GetPoints(); // (0, 0), (1, 0), (0, 1), (1, 1)
</syntaxhighlight>
|-
|-
| <samp>Utility.GetDeterministicHashCode</samp>
| ''(Specialized)'' Get a [https://en.wikipedia.org/wiki/Hash_function hash code] for a string key or numeric values. Unlike [https://learn.microsoft.com/en-us/dotnet/api/system.object.gethashcode <samp>string.GetHashCode</samp>] or [https://learn.microsoft.com/en-us/dotnet/api/system.hashcode.combine <samp>HashCode.Combine</samp>], this produces a consistent hash for the same inputs between sessions and connected players.
|-
|-
| <samp>Data/LocationContexts</samp>
| <samp>Utility.WrapIndex</samp>
| For the <samp>PassOutLocations</samp> field only, the player whose pass-out location to get.
| Constrain an index to a range by wrapping out-of-bounds values to the other side (e.g. last index + 1 is the first index, and first index - 1 is the last one).
For example:
<syntaxhighlight lang="c#">
string[] values = new[] { "0", "1", "2" };
int index = Utility.WrapIndex(-1, values.Length); // 2
</syntaxhighlight>
|}
|}
====Using queries elsewhere====
===Static delegate builder===
C# code can use the <samp>GameStateQuery</samp> class to work with queries, like <code>GameStateQuery.CheckConditions(query)</code>.
For C# mods, <samp>StaticDelegateBuilder</samp> is a specialized class which converts a method name into an optimized delegate which can be called by code. This is used by vanilla code to optimize methods referenced in assets like [[#Custom machines|<samp>Data/Machines</samp>]].
For example, given a static method like this:
<syntaxhighlight lang="c#">
public static bool OutputDeconstructor(Object machine, Item inputItem, bool probe, MachineItemOutput outputData, out int? overrideMinutesUntilReady) { ... }
</syntaxhighlight>
====Extensibility====
And a delegate which matches it:
<syntaxhighlight lang="c#">
public delegate bool MachineOutputDelegate(Object machine, Item inputItem, bool probe, MachineItemOutput outputData, out int? overrideMinutesUntilReady);
</syntaxhighlight>
You can create an optimized delegate and call it like this:
<syntaxhighlight lang="c#">
if (StaticDelegateBuilder.TryCreateDelegate("StardewValley.Object.OutputDeconstructor", out MachineOutputDelegate method, out string error))
return method(this, inputItem, probe, outputData, out minutesUntilMorning);
else
Game1.log.Warn($"Machine {ItemId} has invalid output method: {error}");
</syntaxhighlight>
The <samp>TryCreateDelegate</samp> method will cache created delegates, so calling it again will just return the same delegate instance.
====Available queries====
===Game logging changes===
The game now writes debug output through an internal <samp>Game1.log</samp> wrapper, instead of using <samp>Console.WriteLine</samp> directly. For example:
{| class="wikitable"
<syntaxhighlight lang="c#">
// old code
Console.WriteLine("Error playing sound: " + ex);
// new code
Game1.log.Error("Error playing sound.", ex);
</syntaxhighlight>
This has a few benefits:
* For vanilla players, the game no longer uses time & resources writing to a console that's not visible anyway.
* For modded players, SMAPI can now...
** distinguish between the game's debug/warn/error messages (so many warnings/errors that would previously appear as hidden <samp>TRACE</samp> messages will now be shown with the correct level);
** apply its formatting rules to exceptions logged by the game too;
** redirect game output much more efficiently without console interception.
===Other changes===
====Audio====
<ul>
<li>Added <samp>Game1.sounds</samp>, which unifies the high-level sound effect logic (e.g. distance fading and multiplayer sync).</li>
<li>Added <samp>silence</samp> [[Modding:Audio|audio cue]] for music. This is different from <samp>none</samp> in that it suppresses both town music and ambient sounds.</li>
<li>Added <samp>Game1.soundBank.Exists(cueName)</samp> method to check if an audio cue exists.</li>
<li>Added <samp>Game1.playSound</samp> overloads to get the audio cue being played.</li>
<li>Added <samp>character.playNearbySoundAll</samp> and <samp>playNearbySoundAllLocal</samp> methods to play a sound for players near the player/character.</li>
<li>Added position argument to <samp>DelayedAction.playSoundAfterDelay</samp>.</li>
<li>Removed <samp>NetAudioCueManager</samp> and <samp>Game1.locationCues</samp> (unused).</li>
<li>Unified the methods for playing normal/pitched/positional sounds (which also adds support for pitched non-synced & pitched positional sounds):
{| class="wikitable"
|-
|-
! query
! old methods
! effect
! new method
|-
|-
| <samp>ALL_ITEMS {{o|type ID}}</samp>
| <samp>Game1.playSound</samp><br /><samp>Game1.playSoundAt</samp><br /><samp>Game1.playSoundPitched</samp>
| Every item provided by the [[#Custom items|item data definitions]]. If {{o|type ID}} is set to an item type identifier (like <samp>(O)</samp> for object), only returns items from the matching item data definition.
| <samp>Game1.playSound</samp>
|-
|-
| <samp>DISH_OF_THE_DAY</samp>
| <samp>GameLocation.playSound</samp><br /><samp>GameLocation.playSoundAt</samp><br /><samp>GameLocation.playSoundPitched</samp>
| The [[The Stardrop Saloon#Rotating Stock|Saloon's dish of the day]].
| <samp>GameLocation.playSound</samp>
|-
|-
| <samp>FLAVORED_ITEM {{t|type}} {{t|flavor ID}}</samp>
| <samp>GameLocation.localSound</samp><br /><samp>GameLocation.localSoundAt</samp>
| <samp>GameLocation.localSound</samp>
|-
|-
| <samp>ITEMS_SOLD_BY_PLAYER {{t|shop location}}</samp>
| <samp>NetAudio.Play</samp><br /><samp>NetAudio.PlayAt</samp><br /><samp>NetAudio.PlayPitched</samp>
| <samp>NetAudio.Play</samp>
|-
|-
| <samp>LOCATION_FISH {{t|location}} {{t|bobber tile}} {{t|depth}}</samp>
| <samp>NetAudio.PlayLocal</samp><br /><samp>NetAudio.PlayLocalAt</samp>
| A random item that can be found by fishing in the given location. The {{t|location}} should be the internal name of the location, {{t|bobber tile}} is the position of the fishing rod's bobber in the water (in the form <samp>{{t|x}} {{t|y}}</samp>), and {{t|depth}} is the bobber's distance from the nearest shore measured in tiles (where 0 is directly adjacent to the shore).
| <samp>NetAudio.PlayLocal</samp>
|}</li>
</ul>
====Debug commands====
{{/doc status|[[Modding:Console commands]]|done=true}}
| Returns a [[Lost Books|lost book]] if the player hasn't found them all yet, else the result of the {{o|alternate query}} if specified, else nothing.
| <samp>RANDOM_BASE_SEASON_ITEM</samp>
<ul>
<li>All debug commands are now quote-aware, so you can pass spaces in arguments like <code>debug build "Junimo Hut"</code>.</li>
<li>Added new [[Modding:Console commands|debug commands]]:
{| class="wikitable"
{| class="wikitable"
|-
|-
! format
! command
! item criteria
! description
|-
|-
| <samp>action {{t|action}}</samp>
| Run a [[Modding:Trigger actions|trigger action string]], like <samp>action AddMoney 500</samp> to add {{price|500}} to the current player.
|-
|-
| <samp>@has_category {{o|category}}</samp>
| <samp>artifactSpots</samp>
| Must have one of the given [[Modding:Items#Categories|object categories]] (space-delimited), or any valid category if none specified. Can be negated with <samp>@!has_category</samp>.
| Spawn an [[Artifact Spot|artifact spot]] in each empty tile around the player.
|-
|-
| <samp>@has_id {{t|id}}+</samp>
| <samp>endEvent</samp> / <samp>ee</samp>
| Immediately end the current event or festival, applying the event's skip logic (if any). The event is marked seen, but you can rewatch it using the <samp>eventById</samp> command if needed.
This replaces the pre-1.6 commands (<samp>ee</samp>, <samp>endEvent</samp>/<samp>leaveEvent</samp>, and <samp>eventOver</samp>) which worked in different ways and had side-effects like restarting the event or clearing the player's mail.
|-
|-
| <samp>@has_id_in_base_range {{t|min}} {{t|max}}</samp>
| <samp>exportShops</samp>
| Must have a numeric ID between the {{t|min}} and {{t|max}} values (inclusive). Can be negated with <samp>@!has_id_in_base_range </samp>.
| Export a summary of what's in every shop in the game, taking into account their current conditions. This is saved to a file on disk, and the file path shown in the console.
|-
|-
| <samp>@has_id_prefix {{t|prefix}}+</samp>
| <samp>filterLoadMenu</samp> / <samp>flm</samp>
| ''Syntax: <samp>filterLoadMenu {{t|search text}}''
Filter the current list of saves to those whose player name or farm name contains the given text.
|-
|-
| <samp>@has_object_type {{o|type}}+</samp>
| <samp>forcebuild</samp>
| Must have one of the given object ty pes (space-delimited), or any valid type if none specified. Can be negated with <samp>@!has_object_type</samp>.
| Equivalent to <samp>build</samp>, but disables all safety checks so you can build in a location that wouldn't normally allow buildings, build on top of farm animals or placed objects, etc.
|-
|-
| <samp>gamequery</samp> / <samp>gq</samp>
| ''Syntax:'' <samp>gq {{t|query}}</samp>
| <samp>@allow_missing_price</samp>
| Allow items with a base sell price of 0 or lower. If omitted, those items are skipped.
Check whether the given [[Modding:Game state queries|game state query]] matches in the current context. For example:
<syntaxhighlight lang="js">
<pre>
{
gq !SEASON Spring, WEATHER Here Sun
> Result: true.
</pre>
}
|-
</syntaxhighlight>
| <samp>itemquery</samp> / <samp>iq</samp>
| ''Syntax:'' <samp>iq {{t|query}}</samp>
Open a shop menu with all the items matching an [[Modding:Item queries|item query]] (all items free). For example:
<syntaxhighlight lang="js">
* <samp>debug iq ALL_ITEMS</samp> shows all items;
* <samp>debug iq ALL_ITEMS (W)</samp> shows all weapons;
* <samp>debug iq (O)128</samp> shows a pufferfish (object 128);
* <samp>debug iq FLAVORED_ITEM Wine (O)128</samp> shows Pufferfish Wine.
</syntaxhighlight>
<syntaxhighlight lang="js">
</syntaxhighlight>
</syntaxhighlight>
|-
|-
| <samp>SECRET_NOTE_OR_ITEM {{o|alternate query}}</samp>
| <samp>logFile</samp>
| Returns a [[Secret Notes|secret note]] (or [[Journal Scraps|journal scrap]] on the island) if the player hasn't found them all yet, else the result of the {{o|alternate query}} if specified, else nothing.
| Begin writing debug messages to a log file at <samp>%appdata%/StardewValley/ErrorLogs/game-latest.txt</samp> to simplify troubleshooting. You can also enter <samp>/logtext</samp> into the in-game chatbox to enable it.
This does nothing if SMAPI is installed, since the debug messages are already saved to SMAPI's log.
|-
|-
| <samp>SHOP_TOWN_KEY</samp>
| <samp>logSounds</samp>
| The special [[Key To The Town|town key]] item. This is only valid in shops.
| Log info about each sound effect played to the SMAPI console window.
|-
|-
| <samp>TOOL_UPGRADES {{o|tool ID}}</samp>
| <samp>movieSchedule {{o|year}}</samp>
| The tool upgrades listed in <samp>Data/Shops</samp> whose conditions match the player's inventory (i.e. the same rules as [[Blacksmith|Clint's tool upgrade shop]]). If {{o|tool ID}} is specified, only upgrades which consume that tool ID are shown.
| Lists the movies that will play in a given {{o|year}} (default this year), with the dates they'll play.
|-
|-
| <samp>qualifiedid</samp>
| Print the held item's display name and [[#Custom items|qualified item ID]].
|-
|-
| <samp>ID</samp>
| <samp>search</samp>
| A unique identifier for this entry (not the item itself) within the current list. The ID should only contain alphanumeric/underscore/dot characters. For custom items, this should be prefixed with your mod ID like <samp>Example.ModId_Parsnips</samp>.
| ''Syntax:'' <samp>search {{o|term}}</samp>
List all debug commands that match the given search term (or all debug commands if the search term is omitted). For example:
<pre>debug search backpack
> Found 2 debug commands matching search term 'backpack':
- Backpack
- FillBackpack (fbp, fill, fillbp)</pre>
|-
|-
| <samp>ItemId</samp>
| <samp>setFarmEvent</samp> / <samp>sfe</samp>
| One of:
| ''Syntax:'' <samp>setFarmEvent {{t|event id}}</samp>
* the [[#Custom items|qualified or unqualified item ID]] (like <samp>(O)128</samp> for a [[pufferfish]]);
* or an [[#Item queries|item query]] to dynamically choose one or more items.
Queue an [[Random Events#Farm events|overnight farm event]] if one doesn't plan naturally instead. The {{t|event id}} can be one of...
* <samp>dogs</samp>;
* [[Random Events#Earthquake|<samp>earthquake</samp>]];
* [[Random Events#The Crop Fairy|<samp>fairy</samp>]];
* [[Random Events#Meteorite|<samp>meteorite</samp>]];
* [[Random Events#Stone Owl|<samp>owl</samp>]];
* [[Random Events#Strange Capsule|<samp>ufo</samp>]];
* [[Random Events#The Witch|<samp>witch</samp>]].
Note that even if the farm event runs, it may exit without doing anything (e.g. rare events like <samp>ufo</samp> have extra condition checks when the start).
|-
|-
| <samp>RandomItemId</samp>
| <samp>shop</samp>
| ''(Optional)'' A list of item IDs to randomly choose from, using the same format as <samp>ItemId</samp> (including item queries). If set, <samp>ItemId</samp> is optional and ignored. Each entry in the list has an equal probability of being chosen. For example:
| ''Syntax:'' <samp>shop {{t|shop ID}} {{o|owner name}}</samp>
<syntaxhighlight lang="js">
// wood, stone, or pizza
Open a [[#Custom shops|shop defined in <samp>Data/Shops</samp>]], regardless of whether one of the owners is nearby. Specifying {{o|owner name}} will use that NPC, otherwise the command will find the closest valid NPC if possible (else open with no NPC).
|-
</syntaxhighlight>
| <samp>skinBuilding</samp> / <samp>bsm</samp>
| If the player is standing right under a building, open a menu to change the building appearance.
|-
|-
| <samp>Condition</samp>
| <samp>testwedding</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this entry should be applied. Defaults to always true.
| Immediately play the [[Marriage#The Wedding|wedding]] event. This requires the player to be married first - to test specific NPCs, <samp>debug marry</samp> the NPC followed by this command.
|-
|-
| <samp>IsRecipe</samp>
| <samp>thishouseupgrade</samp> / <samp>thishouse</samp> / <samp>thu</samp>
| ''(Optional)'' Whether to get the crafting/cooking recipe for the item, instead of the item itself. Default false.
| Equivalent to <samp>houseupgrade</samp>, but can be used to upgrade another player's house by running it from inside or just south of its exterior.
|-
|-
| <samp>Quality</samp>
| <samp>toggleCheats</samp>
| ''(Optional)'' The quality of the item to find. One of <samp>0</samp> (normal), <samp>1</samp> (silver), <samp>2</samp> (gold), or <samp>4</samp> (iridium). Invalid values will snap to the closest valid one (e.g. <samp>7</samp> will become iridium). Default -1, which keeps the value set by the item query (usually 0).
| Enable or disable entering debug commands into the in-game chat (prefixed with <samp>/</samp>).
|-
|-
| <samp>MinStack</samp>
| <samp>tokens</samp>
| ''(Optional)'' The item's minimum and default stack size. Default -1, which keeps the value set by the item query (usually 1).
| ''Syntax:'' <samp>tokens {{t|tokenized string}}</samp>
Parses a [[Modding:Tokenizable strings|tokenizable string]] and prints its output. For example:
<pre>
tokens [LocalizedText Strings\StringsFromCSFiles:MapPage.cs.11064 [EscapedText [FarmName]]]
> Result: "Lon Lon Farm"
</pre>
|-
|-
| <samp>MaxStack</samp>
| <samp>worldMapLines</samp>
| ''(Optional)'' If set to a value higher than <samp>MinStack</samp>, the stack is set to a random value between them (inclusively). Default -1.
| Toggles the [[Modding:World map#Debug view|world map's debug view]].
|}</li>
<li>Improved existing debug commands:
{| class="wikitable"
|-
|-
! command
! changes
|-
|-
| <samp>QualityModifiers</samp><br /><samp>StackModifiers</samp>
| <samp>build</samp>
| ''(Optional)'' [[#Quantity modifiers|Quantity modifiers]] applied to the <samp>Quality</samp> or <samp>Stack</samp> value. Default none.
| Removed custom space handling; quote arguments with spaces instead of replacing them with 9 (e.g. <code>Junimo9Hut</code> → <code>"Junimo Hut"</code>).
|-
|-
| <samp>QualityModifierMode</samp><br /><samp>StackModifierMode</samp>
| <samp>clearFurniture</samp>
| ''(Optional)'' [[#Quantity modifiers|quantity modifier modes]] which indicate what to do if multiple modifiers in the <samp>QualityModifiers</samp> or <samp>StackModifiers</samp> field apply at the same time. Default <samp>Stack</samp>.
| Now works outside the farmhouse too.
|-
|-
| <samp>dialogue</samp>
| Removed custom space handling; quote NPC names containing spaces instead, with all text after the first argument treated as part of the dialogue (e.g. <code>debug dialogue "Some NPC" Some dialogue text$h</code>).
|-
|-
| <samp>Id</samp>
| <samp>ebi</samp>
| An ID for this modifier. This only needs to be unique within the current modifier list. For a custom entry, you should use a unique ID which includes your mod ID like <samp>ExampleMod.Id_ModifierName</samp>.
| Fixed event not played correctly if called from the same location as the event.
|-
|-
| <samp>Modification</samp>
| <samp>fish</samp>
| The type of change to apply. The possible values are <samp>Add</samp>, <samp>Subtract</samp>, <samp>Multiply</samp>, <samp>Divide</samp>, and <samp>Set</samp>.
| Fixed error if you're not holding a fishing rod. It now opens the fishing minigame with no tackle instead.
|-
|-
| <samp>Amount</samp>
| <samp>frameOffset</samp>
| ''(Optional if <samp>RandomAmount</samp> specified)'' The operand applied to the target value (e.g. the multiplier if used with <samp>Multiply</samp>).
|  
* Simplified usage. You can now pass negative offsets directly (like <samp>debug frameOffset -5 -10</samp>) instead of using the <samp>s</samp> number prefix.
* Fixed command only taking the last digit in each number.
|-
|-
| <samp>RandomAmount</samp>
| <samp>getStat</samp><br /><samp>setStat</samp>
| Added argument validation.
|-
|-
| <samp>Condition</samp>
| <samp>grass</samp>
| ''(Optional)'' A [[#Game state queries|game state query]] which indicates whether this change should be applied. Defaults to always true.
| Now applies to the current location, instead of the farm.
|-
|-
| <samp>growAnimals</samp><br /><samp>growAnimalsFarm</samp>
| Merged into one <samp>growAnimals</samp> command that supports any location and doesn't reset the age of animals which are already adults.
|-
|-
| <samp>Stack</samp>
| <samp>growCrops</samp>
| Apply each modifier to the result of the previous one. For example, two modifiers which double a value will quadruple it.
| Fixed error growing mixed seeds or giant crops.
|-
|-
| <samp>Minimum</samp>
| <samp>itemNamed</samp>
| Apply the modifier which results in the lowest value.
| Removed custom space handling; quote arguments with spaces instead of removing them (e.g. <code>EelRoe</code> → <code>"Eel Roe"</code>).
|-
|-
| <samp>Maximum</samp>
| <samp>junimoGoodbye</samp><br /><samp><samp>junimoStar</samp>
| Apply the modifier which results in the highest value.
| Added validation to check that you're inside the community center.
|}
|-
| <samp>killAll</samp><br /><samp>killAllHorses</samp><br /><samp>killNpc</samp>
| These now remove matching NPCs inside constructed buildings too.
|-
<syntaxhighlight lang="js">
| <samp>killMonsterStat</samp>
| Removed custom space handling; quote arguments with spaces instead of replacing them with 0 (e.g. <code>Dust0Spirit</code> → <code>"Dust Spirit"</code>).
|-
| <samp>mailForTomorrow</samp>
| Fixed zeros in the mail ID getting replaced with underscores.
|-
| <samp>monster</samp>
</syntaxhighlight>
| Added validation for the monster name.
|-
| <samp>moveBuilding</samp>
| Now applies to the current location, instead of the farm.
|-
| <samp>movie</samp>
| Rewritten; it's now simpler, applies the normal game logic, defaults to today's movie, and avoids depending on NPC indexes in <samp>Data/NPCDispositions</samp> since those can change with custom NPCs.
New usage:
<syntaxhighlight lang="js">
: ''<samp>debug movie {{o|movie ID}} {{o|invite NPC name}}''
: ''<samp>debug movie current {{o|invite NPC name}}''
</syntaxhighlight>
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 uses the default value.
|-
|-
| <samp>panMode</samp>
| The command no longer overrides debug command handling while it's active. Instead you can now turn it back off by running <samp>debug panMode</samp> again, clear with <samp>debug panMode clear</samp>, or set a time with <samp>debug panMode {time}</samp>.
|-
|-
| <samp>[ArticleFor {{t|word}}]</samp>
| <samp>paintBuilding</samp>
| The grammatical article (''a'' or ''an'') for the given word when playing in English, else blank. For example, <code>[ArticleFor apple] apple</code> will output ''an apple''.
|  
* Now applies to the current location, instead of the farm.
* Added validation for the target building.
|-
|-
| <samp>[CharacterName {{t|name}}]</samp>
| <samp>playSound</samp>
| The translated display name for an NPC, given their internal name.
| Added an optional pitch argument, like <samp>debug playSound barrelBreak 1200</samp>. The pitch is a value from 1 (low pitch) to 2400 (high pitch) inclusively.
|-
|-
| <samp>[DataString {{t|asset name}} {{t|key}} {{t|index}}]</samp>
| <samp>question</samp>
| Parses the data asset identified by {{t|asset name}}, finds the entry matching {{t|key}}, splits the slash-delimited string, and returns the value with index {{t|index}} (starting from 0).
| You can now forget a selected answer (instead of adding it) by setting the second argument to false, like <samp>question {{t|id}} false</samp>.
|-
|-
| <samp>[DayOfMonth]</samp>
| <samp>runTestEvent</samp>
| The numeric day of month, like <samp>5</samp> on spring 5.
| Fixed support for Unix line endings.
|-
|-
| <samp>[EscapedText {{t|text}}]</samp>
| <samp>seenEvent</samp>
| You can now forget an event (instead of adding it) by setting the second argument to false, like <samp>seenEvent {{t|id}} false</samp>.
|-
|-
| <samp>[FarmerUniqueID]</samp>
| <samp>seenMail</samp>
| The target player's unique internal multiplayer ID
| You can now remove a mail received (instead of adding it) by setting the second argument to false, like <samp>seenMail {{t|id}} false</samp>.
|-
|-
| <samp>[FarmName]</samp>
| <samp>skinBuilding</samp>
| The farm name for the current save (without the injected "Farm" text).
|  
* Now applies to the current location, instead of the farm.
* Added validation for the target building.
|-
|-
| <samp>[GenderedText {{t|male text}} {{t|female text}}</samp>
| <samp>skullGear</samp>
| Depending on the target player's gender, show either the male text or female text. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.
|  
* Fixed command setting 32 slots instead of 36.
* Fixed command not adding empty inventory slots as expected by some game code.
|-
|-
| <samp>[LocalizedText {{t|string key}}]</samp>
| <Samp>setupFishPondFarm</samp>
| Translation text loaded from the given [[Modding:Modder Guide/Game Fundamentals#String keys|string key]]. If the translation has placeholder tokens like <samp>{0}</samp>, you can add the values after the string key.
| Fixed error if the farm already has non-fish-pond buildings constructed.
|-
|-
| <samp>[LocationName {{t|location ID}}]</samp>
| <samp>speech</samp>
| The translation display name for a location given its ID (''i.e.'' the same ID as in <samp>Data/AdditionalLocationData</samp>).
| Removed custom space handling; quote NPC names containing spaces instead, with all text after the first argument treated as part of the dialogue (e.g. <code>debug speech "Some NPC" Some dialogue text$h</code>).
|-
|-
| <samp>[PositiveAdjective]</samp>
| <samp>spreadDirt</samp>
| A random adjective from the <samp>Strings\Lexicon</samp> data asset's <samp>RandomPositiveAdjective_PlaceOrEvent</samp> entry.
| Now applies to the current location, instead of the farm.
|-
|-
| <samp>[Season]</samp>
| <samp>spreadSeeds</samp>
| The current season name, like ''spring''.
| Now applies to the current location, instead of the farm.
|-
|-
| <samp>[SpouseFarmerText {{t|spouse is farmer text}} {{t|spouse is NPC text}}</samp>
| <samp>thisHouseUpgrade</samp>
| Show a different text depending on whether the target player's spouse is a player or NPC. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.
| Now applies to the current location, instead of the farm.
|-
|-
| <samp>[SpouseGenderedText {{t|male text}} {{t|female text}}]</samp>
| <samp>warpToPlayer</samp>
| Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's NPC or player spouse instead.
| Removed custom space handling; quote arguments with spaces instead of removing them (e.g. <code>JohnSmith</code> → <code>"John Smith"</code>).
|-
|-
| <samp>[SuggestedItem]</samp>
| <samp>whereIs</samp>
| '''(For shops only.)''' The name of a random item currently available in the shop stock.
|  
|}
* Now lists all matching NPCs instead of the first one.
* Now searches the current event or festival, if any.
|}</li>
<li>Removed some debug commands:
<li>Added new [[Modding:Dialogue|dialogue]] commands:
{| class="wikitable"
{| class="wikitable"
|-
|-
! command
! command
! description
! notes
|-
|-
| <samp>$f {{t|response IDs}}</samp>
| <samp>ax</samp><br /><samp>bigItem</samp>/<samp>b</samp>/<samp>bi</samp>/<samp>big</samp><br /><samp>boots</samp><br /><samp>clothes</samp><br /><samp>hoe</samp><br /><samp>milkPail</samp>/<samp>mp</samp><br /><samp>pan</samp><br /><samp>pickaxe</samp>/<samp>pick</samp>/<samp>pickax</samp><br /><samp>ring</samp>/<samp>addRing</samp><br /><samp>shears</samp>/<samp>scissors</samp><br /><samp>slingshot</samp><br /><samp>tool</samp><br /><samp>wateringCan</samp>/<samp>can</samp><br /><samp>wand</samp><br /><samp>weapon</samp>
| Forget any number of space-delimited [[Modding:Dialogue#Response IDs|dialogue response IDs]] previously answered by the player.
| These are replaced by more general commands like <code>item (O)128</code> (spawn item by ID), <code>fuzzyItemNamed pufferfish</code> (spawn by item name), or <code>itemQuery FLAVORED_ITEM Wine (O)128</code> (spawn by [[Modding:Item queries|item query]]).
|-
|-
| <samp>$v {{t|event id}} {{o|check preconditions}} {{o|skip if seen}}</samp>
| <samp>addQuartz</samp><br /><samp>blueBook</samp><br /><samp>blueprint</samp><br /><samp>end</samp>
| These were part of unused features removed in 1.6.
|-
|-
| <samp>changeStat</samp>
| Removed; use <samp>setStat</samp> instead.
|-
|-
| <samp>addItem {{t|item ID}} {{o|count}} {{o|quality}}</samp>
| <samp>ee</samp><br /><samp>endEvent</samp>/<samp>leaveEvent</samp><br /><samp>eventOver</samp>
| Add an item to the player inventory (or open a grab menu if their inventory is full). The {{t|item ID}} is the [[#Custom items|qualified or unqualified item ID]], and {{o|quality}} is a [[Modding:Items#Quality|numeric quality value]].
| Replaced by the new <samp>endEvent</samp> command.
|-
|-
| <samp>temporaryAnimatedSprite ...</samp>
| <samp>everythingshop</samp>
| Add a temporary animated sprite to the event, using these space-delimited fields:
| Removed. You can get all items like <code>debug iq ALL_ITEMS</code>, or all items of a given type like <code>debug iq ALL_ITEMS (O)</code>.
|-
|-
| <samp>oldMineGame</samp>
| Removed along with the pre-1.4 [[Junimo Kart]] code.
|-
|-
| 0
| <samp>pathSpouseToMe</samp>/<samp>pstm</samp>
| <samp>texture</samp>
| Removed along with the unimplemented farm activities code.
| The asset name for texture to draw.
|}</li>
<li>Added alternative names for some debug commands (new names in parentheses): <samp>bpm</samp> + <samp>bsm</samp> (<samp>paintBuilding</samp> + <samp>skinBuilding</samp>), <samp>craftingRecipe</samp> (</samp>addCraftingRecipe</samp>), <samp>db</samp> (</samp>speakTo</samp>), <samp>dialogue</samp> (</samp>addDialogue</samp>), <samp>pdb</samp> (</samp>printGemBirds</samp>), <samp>r</samp> (</samp>resetForPlayerEntry</samp>), <samp>removeLargeTf</samp> (</samp>removeLargeTerrainFeature</samp>), <samp>sb</samp> (</samp>showTextAboveHead</samp>), <samp>sl</samp> + <samp>sr</samp> (<samp>shiftToolbarLeft</samp> + </samp>shiftToolbarRight</samp>), <samp>sn</samp> (</samp>secretNote</samp>), and <samp>tls</samp> (</samp>toggleLightingScale</samp>).</li>
<li>Reworked how debug commands log output. This fixes an issue where they don't always log to the right place (e.g. a command run through the chatbox might log to the console or vice-versa), and lets mods pass a custom logger to capture or redirect output.</li>
</ul>
====Location logic====
* The [[desert]] no longer assumes the player arrived by bus unless their previous location was the [[Bus Stop|bus stop]].
* The ticket price for the bus and Willy's boat can now be edited by C# mods via <samp>BusStop.TicketPrice</samp> and <samp>BoatTunnel.TicketPrice</samp> respectively.
| 6
====Menus & UI====
| <samp>frames</samp>
* Rewrote calendar menu (<samp>Billboard</samp>) to simplify custom events & event types. C# mods can now edit <samp>billboard.calendarDayData</samp> or patch <samp>billboard.GetEventsForDay</samp> to add new events.
* Added <samp>Game1.textShadowDarkerColor</samp> field for the colors previously hardcoded in <samp>Utility.drawTextWithShadow</samp>.
* Added <samp>MoneyDial.ShouldShakeMainMoneyBox</samp> field to simplify custom dials.
* Partly de-hardcoded <samp>ShopMenu</samp> filter tabs. You can now change filter tabs by setting the <samp>shopMenu.tabButtons</samp> field with arbitrary <samp>Func<ISalable, bool> Filter</samp> values, or by using a predefined set of tabs like <samp>shopMenu.UseDresserTabs()</samp>.
* The <samp>SpriteText</samp> methods now accept arbitrary <samp>Color</samp> tints instead of a few predefined color IDs.
| The number of times to repeat the animation.
* The <samp>DiscreteColorPicker.getColorFromSelection</samp> methods are now static for reuse.
* Fixed <samp>DiscreteColorPicker</samp> constructor ignoring the initial color argument, and added a constructor which takes a <samp>Color</samp> value.
* Fixed an edge case where a custom language's fonts wouldn't be loaded when switching language.
====[[Modding:Modder Guide/Game Fundamentals#Net fields|Net fields]]====
* Removed implicit conversion operators for most types due to their sometimes counter-intuitive behavior. The only ones left are <samp>NetBool</samp>, <samp>NetInt</samp>, and <samp>NetString</samp>; those are now marked obsolete and will raise build warnings on use.
* <samp>NetLocationRef</samp> now has a public <samp>LocationName</samp> and <samp>IsStructure</samp>, and its <samp>Update</samp> method allows forcing an update.
| '''[TODO: document what this does]''' (one of <samp>true</samp> or <samp>false</samp>).
====Quests====
|-
{{/doc status|[[Modding:Quest data]]|done=false}}
| <samp>flip</samp>
* Quests now have string IDs, to simplify custom quest frameworks.
* Added validation for quest data parsing.
* In [[Modding:Special orders|<samp>Data/SpecialOrders</samp>]], the <samp>Duration</samp> and <samp>Repeatable</samp> fields are now strongly-typed and case-insensitive.
* For C# mods, fixed <samp>DescriptionElement</samp> not allowing more than four translation token substitutions.
====Dates & seasons====
* Added a <samp>Season</samp> enum for strongly-typed, case-insensitive season checks (like <code>Game1.season == Season.Spring</code> instead of <code>Game1.currentSeason == "spring"</code>).
* Added <samp>Game1.season</samp>, <samp>Game1.GetSeasonForLocation</samp>, <samp>Game1.WorldDate.Season</samp>, and <samp>location.GetSeason()</samp> to get the season enum.
* Added <samp>Utility.getSeasonKey</samp> to get the key form from a season enum.
* Improved <samp>WorldDate</samp>:
** added <samp>Now()</samp> to get a new instance matching the current date;
** added <samp>WorldDate.Equals</samp> and <samp>GetHashCode</samp> implementations;
** added code docs;
** <samp>TotalDays</samp> is no longer written to the save file.
* Renamed some members for clarity (<samp>Game1.GetSeasonForLocation</samp> → <samp>GetSeasonKeyForLocation</samp>, <samp>location.GetSeasonForLocation</samp> → <samp>GetSeasonKey</samp>, <samp>WorldDate.Season</samp> → <samp>SeasonKey</samp>).
* Fixed <samp>location.GetSeasonKey()</samp> not applying the greenhouse logic.
====Time====
* For C# mods, the <samp>Game1.realMilliSecondsPerGame</samp> and <samp>Game1.realMilliSecondsPerGameTenMinutes</samp> fields are no longer marked <samp>const</samp>, and the <samp>GameLocation.getExtraMillisecondsPerInGameMinuteForThisLocation()</samp> method has been replaced with a settable <samp>ExtraMillisecondsPerInGameMinute</samp> property. That lets you change the time rate used by the vanilla game code, but you should be careful doing this since it may cause unintended effects.
====Other====
* Error stack traces on Linux/macOS now have line numbers.
* All space-delimited fields now ignore extra spaces instead of crashing. This affects map/tile properties, data assets, event commands, game state queries, etc.
* All players and NPCs now have <samp>Tile</samp> & <samp>TilePoint</samp> properties (their cached tile position) and a <samp>StandingPixel</samp> property (the cached pixel coordinate at the center of their bounding box). These [[#Other breaking API changes|replace various deleted methods]].
* All terrain features now have <samp>Tile</samp> and <samp>Location</samp> properties, and their methods no longer have location/tile parameters in most cases.
* All [[Modding:Modder Guide/Game Fundamentals#Net fields|net fields]] now have <samp>Name</samp> and <samp>Owner</samp> fields, which are used to show informative error messages when there's a sync issue and validate common mistakes (e.g. a net field not added to the <samp>NetFields</samp> collection).
* The game now tracks the locations a player has visited. Mods can check the list in C# (via <samp>Game1.player.locationsVisited</samp>) or [[Modding:Game state queries|game state queries]] (via <samp>PLAYER_VISITED_LOCATION</samp>). For pre-existing saves, the list is retroactively populated based on accessible locations, events seen, mail flags set, etc.
* Added menu queuing (via <samp>Game1.nextClickableMenu</samp> in C#). For example, this applies if you try to take an item from a mail letter when your inventory is full.
* Added C# code docs in many places.
* Added <samp>Id</samp> fields to simplify content pack edits in fish pond, movie concession, random bundle, and tailoring recipe data.
* Added <samp>Game1.Multiplayer</samp> to get the game's low-level handler. (Most code should still use [[Modding:Modder Guide/APIs/Multiplayer|SMAPI's multiplayer API]] though.)
* Added <samp>Game1.versionBuildNumber</samp> with the build number (like <samp>26039</samp>).
* Added field-changed events to <samp>NetPosition</samp>.
* Added <samp>LocalizedContentManager.CurrentLanguageString</samp>, which caches the language code like <samp>pt-BR</samp>).
* The game now uses <samp>[XmlInclude]</samp> on its types more consistently. That means the default save serializer can handle more types (e.g. all monsters), and it's easier to create custom serializers.
* Refactored many parts of the code to make it more moddable for C# mods. This includes marking all classes public, changing <samp>private</samp> members to <samp>protected</samp> or <samp>public</samp>, marking members <samp>virtual</samp>, rewriting or splitting code so it's easier to extend, etc.
* The <samp>startup_preferences</samp> file is now formatted to simplify troubleshooting.
* Fixed many cases where the game used <samp>Game1.player</samp> instead of the provided player.
==Breaking changes for C# mods==
'''This section only describes how this update may break existing mods. See the ''what's new'' sections above for more info, including new functionality mods can use.'''
See also [[#Breaking changes for content packs|''Breaking changes for content packs'']], which affect C# mods too.
===.NET 6===
: ''See also: [[#.NET 6|.NET 6]] under what's new.''
Stardew Valley 1.6 updates from .NET 5 to .NET 6. SMAPI can still load .NET 5 mods fine, but you'll get a build error when compiling them. To update a C# mod:
<ol>
<li>Make sure you have [https://visualstudio.microsoft.com/vs Visual Studio Community 2022] or later. (Compiling .NET 6 with earlier versions of Visual Studio isn't officially supported.)</li>
<li>In Visual Studio, click ''Help > Check For Updates'' and install the latest version.</li>
<li>Fully exit Visual Studio.</li>
<li>Open each mod's <samp>.csproj</samp> file in a text editor, then find this line:
<syntaxhighlight lang="xml">
<TargetFramework>net5.0</TargetFramework>
</syntaxhighlight>
And change it to this:
<syntaxhighlight lang="xml">
<TargetFramework>net6.0</TargetFramework>
</syntaxhighlight>
</li>
<li>Delete your solution's hidden <samp>.vs</samp> folder, and every project's <samp>bin</samp> and <samp>obj</samp> folders.</li>
<li>Reopen the solution in Visual Studio, click ''Build > Rebuild Solution'', and make sure it still loads into the game fine.</li>
</ol>
===Item ID changes===
: ''See also: [[#Custom items|custom items in what's new]].''
The [[#Custom items|main <samp>Item</samp> properties have changed]]. To migrate existing code:
<ul>
<li>Don't use <samp>ParentSheetIndex</samp> to compare items. For example, <samp>item.ParentSheetIndex == 0</samp> will match both [[weeds]] and any custom item whose sprite is the first one in its custom spritesheet. You should compare items using [[#Custom items|their new <samp>ItemId</samp> and <samp>QualifiedItemId</samp> properties]] instead. For example, here's how to migrate various common forms:
{| class="wikitable"
|-
|-
! old code
! new code
|-
|-
|-
|-
| <samp>item.ParentSheetIndex == 848</samp>
| <samp>scale</samp>
| <samp>item.QualifiedItemId == "(O)848"</samp>
| A multiplier applied to the sprite size (in addition to the normal 4× pixel zoom).
|-
|-
| 15
| <samp>IsNormalObjectAtParentSheetIndex(item, 74)</samp>
| <samp>scale change</samp>
| <samp>item.QualifiedItemId == "(O)74"</samp>
|-
|-
| <samp>!item.bigCraftable && item.ParentSheetIndex == 128</samp>
| <samp>rotation</samp>
| <samp>item.QualifiedItemId == "(O)128"</samp>
| The rotation to apply to the sprite, measured in [[wikipedia:radians|radians]].
|-
|-
| <samp>item is Boots && item.ParentSheetIndex == 505</samp>
| <samp>rotation change</samp>
| <samp>item.QualifiedItemId == "(B)505"</samp>
| '''[TODO: document what this does]'''
|}</li>
<li>Don't assume item sprites are in the vanilla spritesheets. For example, instead of rendering <samp>Game1.objectSpriteSheet</samp> for an object, call <code>ItemRegistry.GetMetadata(item.QualifiedItemId).GetTexture()</code> to get its texture.</li>
<li>Creating items works just like before, except that you now specify the item's <samp>ItemId</samp> (''not'' <samp>QualifiedItemId</samp>) instead of its <samp>ParentSheetIndex</samp>. This is the same value for vanilla items. For example:
</li>
<li>The <samp>removeItem</samp> command now has an optional count in the form <samp>removeItem {{t|item ID}} {{o|count}}</samp>.</li>
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
new Object("634", 1); // vanilla item
new Object("Example.ModId_Watermelon", 1); // custom item
</syntaxhighlight>
</syntaxhighlight>
You can also use the new <samp>ItemRegistry</samp> API to construct items from their <samp>QualifiedItemId</samp>:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
Item item = ItemRegistry.Create("(B)505"); // Rubber Boots
</syntaxhighlight></li>
</ul>
</syntaxhighlight>
===Other ID changes===
Many other things in the game now have unique string IDs too (including [[#Buff overhaul|buffs]], [[#String event IDs|events]], and fruit trees). To migrate existing code:
| <samp>Get</samp><br /><samp>GetFloat</samp><br /><samp>GetInt</samp>
| Get a parsed value from an array by its index (if found and valid), else the default value.
* When referencing numeric IDs, you usually just need to convert them into a string (like <code>Game1.player.hasBuff("1590166")</code> or <code>Game1.player.eventsSeen.Contains("1590166")</code>).
<syntaxhighlight lang="c#">
* When creating buffs, see [[#Buff overhaul|buff overhaul]] for how to create buffs now.
* For pre-existing content pack data, see migration steps in the ''[[#Unique string IDs|unique string IDs]]'' section.
===Building and animal changes===
: ''See also: [[#Build anywhere|build anywhere in what's new]].''
|-
* Since all locations now allow buildings and animals, mod code which handles <samp>BuildableGameLocation</samp> and <samp>IAnimalLocation</samp> won't detect all buildable locations. You can replace them with <samp>location.IsBuildableLocation()</samp> (or just access <samp>location.buildings</samp> directly) and <samp>location.animals.Any()</samp> instead. Mods should no longer have any reference at all to <samp>BuildableGameLocation</samp> and <samp>IAnimalLocation</samp>.
<syntaxhighlight lang="c#">
* Since buildings can be built anywhere, you can no longer assume a building is on the farm. You can check the new <samp>building.buildingLocation</samp> field instead.
* You should review direct references to the farm (like <code>Game1.getFarm()</code> or <code>Game1.getLocationFromName("Farm")</code>) to see if it needs to be rewritten to allow other locations.
* <code>Utility.numSilos()</code> should no longer be used to calculate available hay, since it doesn't account for custom buildings with hay storage. Use <code>Game1.getFarm().GetHayCapacity()</code> instead.
* The <samp>Cat</samp> and <samp>Dog</samp> classes are now unused; all pets are now <samp>Pet</samp> directly.
</syntaxhighlight>
<syntaxhighlight lang="c#">
</syntaxhighlight>
===Player changes===
: ''See also: [[#Buff overhaul|buff overhaul in what's new]].''
<ul>
<li>Several <samp>Game1.player</samp> / <samp>Farmer</samp> fields changed as part of the [[#Buff overhaul|buff overhaul]]:
{| class="wikitable"
|-
! old field
! how to migrate
|-
| <samp>appliedBuffs</samp><br /><samp>appliedSpecialBuffs</samp>
| Use <code>Game1.player.hasBuff(id)</code> instead.
|-
| <samp>attack</samp><br /><samp>immunity</samp>
| Use <samp>Attack</samp> and <samp>Immunity</samp> instead.
|-
| <samp>addedCombatLevel</samp><br /><samp>addedFarmingLevel</samp><br /><samp>addedFishingLevel</samp><br /><samp>addedForagingLevel</samp><br /><samp>addedLuckLevel</samp><br /><samp>addedMiningLevel</samp><br /><samp>attackIncreaseModifier</samp><br /><samp>critChanceModifier</samp><br /><samp>critPowerModifier</samp><br /><samp>knockbackModifier</samp><br /><samp>weaponPrecisionModifier</samp><br /><samp>weaponSpeedModifier</samp>
| Use equivalent properties under <samp>Game1.player.buffs</samp> instead (e.g. <samp>Game1.player.buffs.CombatLevel</code>).
|-
| <samp>resilience</samp>
| Use <samp>buffs.Defense</samp> instead.
|-
| <samp>addedSpeed</samp><br /><samp>CombatLevel</samp><br /><samp>CraftingTime</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MagneticRadius</samp><br /><samp>MaxStamina</samp><br /><samp>MiningLevel</samp><br /><samp>Stamina</samp>
| These are now readonly and can't be set directly. You can change them by [[#Buff overhaul|adding a buff]] (which can be invisible), equipment bonus, etc instead.
|}</li>
<li>Buffs are now recalculated automatically, and you can reset a buff by just reapplying it. See [[#Buff overhaul|buff overhaul]] for more info.</li>
<li>Buff logic has been centralized into <samp>Game1.player.buffs</samp>. This replaces a number of former fields/methods like <samp>Game1.buffsDisplay</samp>.</li>
</ul>
===Collision changes===
The game's tile collision logic has been overhauled and merged into a simpler set of methods on <samp>GameLocation</samp> instances:
{| class="wikitable"
{| class="wikitable"
! effect
! effect
|-
|-
| <samp>StringToDirection</samp>
| <samp>CanSpawnCharacterHere</samp>
| Converts a string direction (one of <samp>down</samp>, <samp>left</samp>, <samp>right</samp>, or <samp>up</samp>) into a direction code recognized by various game methods (''i.e.'' <samp>Game1.down</samp>, etc). If the string contains a number, the numeric value is returned (even if it's not a valid direction). If it's any other unrecognized value, the method returns -1.
| Get whether NPCs can be placed on the given tile (e.g. it's within the map bounds and tile is walkable), there's no placed object there, and the <samp>NoFurniture</samp> [[Modding:Maps|tile property]] isn't set.
|-
| <samp>CanItemBePlacedHere</samp>
| Get whether items can be placed on the given tile in non-floating form (e.g. it's within the map bounds and not blocked by a non-walkable item), and the <samp>NoFurniture</samp> [[Modding:Maps|tile property]] isn't set.
|-
|-
| <samp>CreateDaySaveRandom</samp>
| <samp>isBuildable</samp>
| Creates a <samp>Random</samp> instance using the most common seed (based on the save ID and total days played).
| Get whether buildings can be placed on the given tile.
|-
| <samp>IsTilePassable</samp>
| Get whether the tile can be walked on (ignoring collisions with in-game objects, NPCs, etc).
|-
|-
| <samp>CreateRandom</samp>
| <samp>IsTileOccupiedBy</samp>
| Creates a <samp>Random</samp> by combining the given seed values, which can be any numeric type.
| Get whether the tile contains a player, object, NPC/monster/pet/etc, terrain feature, building, etc. You can choose which entities to check, and which ones to ignore if they don't block movement.
|-
|-
| <samp>TryParseEnum</samp>
| <samp>IsTileBlockedBy</samp>
| Parses a string into an enum value if possible, case-insensitively. Unlike [https://learn.microsoft.com/en-us/dotnet/api/system.enum.tryparse <samp>Enum.TryParse</samp>], an invalid numeric value won't be cast:
| Equivalent to calling both <samp>IsTilePassable</samp> and <samp>IsTileOccupiedBy</samp>.
<syntaxhighlight lang="c#">
</syntaxhighlight>
|-
|-
| <samp>GetDeterministicHashCode</samp>
| <samp>IsLocationSpecificOccupantOnTile</samp><br /><samp>IsLocationSpecificPlacementRestriction</samp>
| ''(Specialized)'' Get a [https://en.wikipedia.org/wiki/Hash_function hash code] which is always the same for a given input (unlike [https://learn.microsoft.com/en-us/dotnet/api/system.object.gethashcode <samp>string.GetHashCode()</samp>]), even if you restart the game or play on another computer. For example, this ensures that randomized shop items are the same across all players in multiplayer and don't change when you reload the save.
| Generally shouldn't be used directly. Checks for location-specific collisions (e.g. ladders in [[The Mines|the mines]] or parrot platforms on [[Ginger Island]]).
|}
|}
===Static delegate builder===
===Other breaking API changes===
''(This section is meant as a quick reference if you have build errors; there's no need to read through it otherwise.)''
====Removed unused code====
1.6 removes a lot of unused code. That includes these classes:
===Game logging changes===
{| class="wikitable"
{| class="wikitable"
|-
|-
! command
! namespace
! description
! class name
|-
|-
| <samp>bsm</samp>
| <samp>StardewValley</samp>
| If the player is standing right under a building, open a menu to change the building appearance.
|  
* <samp>BuildingUpgrade</samp>
* <samp>DisposableList</samp>
* <samp>FurniturePlacer</samp>
* <samp>ListPool</samp>
* <samp>OneTimeRandom</samp>
|-
|-
| <samp>forcebuild</samp>
| <samp>StardewValley.Characters</samp>
| Equivalent to <samp>build</samp>, but disables all safety checks so you can build in a location that wouldn't normally allow buildings, build on top of farm animals or placed objects, etc.
|  
* <samp>BotchedNetBool</samp>
* <samp>BotchedNetField</samp>
* <samp>BotchedNetInt</samp>
* <samp>BotchedNetLong</samp>
|-
| <samp>StardewValley.Menus</samp>
|  
* <samp>FarmInfoPage</samp>
* <samp>MiniatureTerrainFeature</samp><!-- not a typo, it really was in StardewValley.Menus -->
|-
| <samp>StardewValley.Monsters</samp>
|  
* <samp>LavaCrab</samp>
|-
| <samp>StardewValley.Objects</samp>
|  
* <samp>ObjectFactory</samp> (replaced by [[#Custom items|<samp>ItemRegistry</samp>]])
|-
| <samp>StardewValley.TerrainFeatures</samp>
|  
* <samp>Quartz</samp>
|-
|-
| <samp>gamequery</samp> / <samp>gq</samp>
| <samp>StardewValley.Tools</samp>
| ''Syntax:'' <samp>gq {{t|query}}</samp>
|  
* <samp>Blueprints</samp>
* <samp>ToolFactory</samp> (replaced by [[#Custom items|<samp>ItemRegistry</samp>]])
|}
And these class members:
{| class="wikitable"
|-
|-
! type
! members
|-
|-
| <samp>qualifiedid</samp>
| <samp>Axe</samp>
| Print the held item's display name and [[#Custom items|qualified item ID]].
|  
* <samp>StumpStrength</samp>
|-
|-
| <samp>shop</samp>
| <samp>Bush</samp>
| ''Syntax:'' <samp>shop {{t|shop ID}} {{o|owner name}}</samp>
|  
* <samp>alpha</samp>
* <samp>lastPlayerToHit</samp>
|-
|-
| <samp>testwedding</samp>
| <samp>Chest</samp>
| Immediately play the [[Marriage#The Wedding|wedding]] event.
|  
* <samp>chestType</samp>
* <samp>coins</samp>
|-
| <samp>CosmeticPlant</samp>
|  
* <samp>scale</samp>
|-
|-
| <samp>thishouseupgrade</samp> / <samp>thishouse</samp> / <samp>thu</samp>
| <samp>CraftingRecipe</samp>
| Equivalent to <samp>houseupgrade</samp>, but can be used to upgrade another player's house by running it from inside or just south of its exterior.
|  
|}</li>
* <samp>itemType</samp>
<li>Fixed <samp>ebi</samp> [[Modding:Console commands|debug command]] not playing events correctly if called from the same location as the event.</li>
|-
</ul>
| <samp>Critter</samp>
|  
* <samp>InitShared()</samp>
* Quests now have string IDs, to simplify custom quest frameworks.
|-
| <samp>Crop</samp>
|  
* For C# mods, the <samp>Game1.realMilliSecondsPerGame</samp> and <samp>Game1.realMilliSecondsPerGameTenMinutes</samp> fields are no longer marked <samp>const</samp>, and the <samp>GameLocation.getExtraMillisecondsPerInGameMinuteForThisLocation()</samp> method has been replaced with a settable <samp>ExtraMillisecondsPerInGameMinute</samp> property. That lets you change the time rate used by the vanilla game code, but you should be careful doing this since it may cause unintended effects.
* <samp>daysOfUnclutteredGrowth</samp>
|-
| <samp>Dialogue</samp>
* All space-delimited fields now ignore extra spaces instead of crashing. This affects map/tile properties, data assets, event commands, game state queries, etc.
|  
* The [[desert]] no longer assumes the player arrived by bus unless their previous location was the [[Bus Stop|bus stop]].
* <samp>dialogueToBeKilled</samp>
* The <samp>SpriteText</samp> methods now accept arbitrary <samp>Color</samp> tints instead of a few predefined color IDs.
|-
| <samp>Farm</samp>
|  
* <samp>GetSpouseOutdoorAreaSpritesheetIndex()</samp>
|-
| <samp>FarmAnimal</samp>
|  
* <samp>homeLocation</samp>
|-
| <samp>Farmer</samp>
|  
<ol>
* <samp>barnUpgradeLevel</samp> and <samp>BarnUpgradeLevel</samp>
<li>Make sure you have [https://visualstudio.microsoft.com/vs Visual Studio Community 2022] or later. (Compiling .NET 6 with earlier versions of Visual Studio isn't officially supported.)</li>
* <samp>blueprints</samp>
<li>In Visual Studio, click ''Help > Check For Updates'' and install the latest version.</li>
* <samp>coalPieces</samp> and <samp>CoalPieces</samp>
<li>Fully exit Visual Studio.</li>
* <samp>coopUpgradeLevel</samp> and <samp>CoopUpgradeLevel</samp>
<li>Open each mod's <samp>.csproj</samp> file in a text editor, then find this line:
* <samp>copperPieces</samp> and <samp>CopperPieces</samp>
<syntaxhighlight lang="xml">
* <samp>eyeColor</samp>
<TargetFramework>net5.0</TargetFramework>
* <samp>feed</samp> and <samp>Feed</samp>
</syntaxhighlight>
* <samp>furnitureOwned</samp>
* <samp>goldPieces</samp> and <samp>GoldPieces</samp>
* <samp>hasBusTicket</samp>
<syntaxhighlight lang="xml">
* <samp>hasGreenhouse</samp>
<TargetFramework>net6.0</TargetFramework>
* <samp>iridiumPieces</samp> and <samp>IridiumPieces</samp>
</syntaxhighlight>
* <samp>ironPieces</samp> and <samp>IronPieces</samp>
</li>
* <samp>newSkillPointsToSpend</samp>
<li>Delete your solution's hidden <samp>.vs</samp> folder, and every project's <samp>bin</samp> and <samp>obj</samp> folders.</li>
* <samp>overallsColor</samp>
<li>Reopen the solution in Visual Studio, click ''Build > Rebuild Solution'', and make sure it still loads into the game fine.</li>
* <samp>ownsFurniture</samp>
</ol>
* <samp>quartzPieces</samp> and <samp>QuartzPieces</samp>
* <samp>shirtColor</samp>
* <samp>skinColor</samp>
* <samp>stonePieces</samp> and <samp>StonePieces</samp>
* <samp>theaterBuildDate</samp>
* <samp>woodPieces</samp> and <samp>WoodPieces</samp>
<ul>
|-
<li>Don't use <samp>ParentSheetIndex</samp> to compare items. For example, <samp>item.ParentSheetIndex == 0</samp> will match both [[weeds]] and any custom item whose sprite is the first one in its custom spritesheet. You should compare items using [[#Custom items|their new <samp>ItemId</samp> and <samp>QualifiedItemId</samp> properties]] instead. For example, here's how to migrate various common forms:
| <samp>Game1</samp>
|  
* <samp>boardingBus</samp>
* <samp>chanceToRainTomorrow</samp>
* <samp>checkForNewLevelPerks</samp>
* <samp>cloud</samp>
* <samp>coopDwellerBorn<samp>
* <samp>cropsOfTheWeek</samp>
* <samp>currentBarnTexture</samp>
* <samp>currentBillboard</samp>
* <samp>currentCoopTexture</samp>
* <samp>currentFloor</samp>
* <samp>currentHouseTexture</samp>
* <samp>currentWallpaper</samp>
* <samp>dealerCalicoJackTotal</samp>
* <samp>FarmerFloor</samp>
* <samp>farmerWallpaper</samp>
* <samp>fertilizer</samp>
* <samp>floorPrice</samp>
* <samp>greenhouseTexture</samp>
* <samp>inMine<samp>
* <samp>jukeboxPlaying</samp>
* <samp>keyHelpString</samp>
* <samp>listeningForKeyControlDefinitions<samp>
* <samp>littleEffect</samp>
* <samp>logoScreenTexture</samp>
* <samp>mailboxTexture</samp>
* <samp>menuChoice</samp>
* <samp>menuUp<samp>
* <samp>nameSelectUp<samp>
* <samp>nameSelectType</samp>
* <samp>numberOfSelectedItems</samp>
* <samp>particleRaining<samp>
* <samp>pickingTool</samp>
* <samp>pickToolDelay</samp>
* <samp>pickToolInterval</samp>
* <samp>priceOfSelectedItem</samp>
* <samp>progressBar</samp>
* <samp>removeSquareDebrisFromTile(…)</samp>
* <samp>selectedItemsType</samp>
* <samp>shiny</samp>
* <samp>shippingTax</samp>
* <samp>showKeyHelp<samp>
* <samp>slotResult</samp>
* <samp>startedJukeboxMusic</samp>
* <samp>tinyFontBorder</samp>
* <samp>toolHeld</samp>
* <samp>toolIconBox</samp>
* <samp>tvStation</samp>
* <samp>tvStationTexture</samp>
* <samp>wallpaperPrice</samp>
|-
| <samp>GameLocation</samp>
|  
* <samp>boardBus(…)</samp>
* <samp>checkForMapChanges()</samp>
* <samp>getWallDecorItem(…)</samp>
* <samp>removeBatch(…)</samp>
* <samp>removeDirt(…)</samp>
* <samp>removeStumpOrBoulder(…)</samp>
* <samp>tryToBuyNewBackpack()</samp>
|-
| <samp>GiantCrop</samp>
|  
* <samp>forSale</samp>
|-
| <samp>IClickableMenu</samp>
|  
* <samp>currentRegion</samp>
|-
| <samp>MeleeWeapon</samp>
|  
* <samp>attackSwordCooldownTime</samp>
* <samp>doStabbingSwordFunction(…)</samp>
|-
|-
| <samp>Monster</samp>
|  
* <samp>doHorizontalMovement(…)</samp>
* <samp>durationOfRandomMovements</samp>
* <samp>coinsToDrop</samp>
|-
|-
| <samp>NPC</samp>
|  
* <samp>idForClones</samp>
|-
|-
| <samp>item.ParentSheetIndex == 848</samp>
| <samp>Object</samp>
| <samp>item.QualifiedItemId == "(O)848"</samp>
|  
* <samp>attachToSprinklerAttachment(…)</samp>
* <samp>canBePlacedInWater()</samp>
* <samp>consumeRecipe(…)</samp>
* <samp>copperBar</samp>
* <samp>goldBar</samp>
* <samp>iridiumBar</samp>
* <samp>ironBar</samp>
* <samp>isHoeDirt</samp> and <samp>IsHoeDirt</samp>
|-
|-
| <samp>IsNormalObjectAtParentSheetIndex(item, 74)</samp>
| <samp>PathFindController</samp>
| <samp>item.QualifiedItemId == "(O)74"</samp>
|  
* <samp>CheckClearance(…)</samp>
* <samp>limit</samp>
|-
|-
| <samp>!item.bigCraftable && item.ParentSheetIndex == 128</samp>
| <samp>SaveGame</samp>
|  
* <samp>cropsOfTheWeek</samp>
* <samp>currentFloor</samp>
* <samp>currentWallpaper</samp>
* <samp>FarmerFloor</samp>
* <samp>farmerWallpaper</samp>
* <samp>shippingTax</samp>
|-
|-
| <samp>item is Boots && item.ParentSheetIndex == 505</samp>
| <samp>Spiker</samp>
| <samp>item.QualifiedItemId == "(B)505"</samp>
|  
* <samp>GetSpawnPosition</samp>
<li>Don't assume item sprites are in the vanilla spritesheets. For example, instead of rendering <samp>Game1.objectSpriteSheet</samp> for an object, call <code>ItemRegistry.GetMetadata(item.QualifiedItemId).GetTexture()</code> to get its texture.</li>
|-
<li>Creating items works just like before, except that you now specify the item's <samp>ItemId</samp> (''not'' <samp>QualifiedItemId</samp>) instead of its <samp>ParentSheetIndex</samp>. This is the same value for vanilla items. For example:
| <samp>Stats</samp>
|  
* <samp>barsSmelted</samp> and <samp>BarsSmelted</samp>
* <samp>coalFound</samp> and <samp>CoalFound</samp>
* <samp>coinsFound</samp> and <samp>coinsFound</samp>
* <samp>starLevelCropsShipped</samp> and <samp>starLevelCropsShipped</samp>
|-
| <samp>Tool</samp>
|  
* <samp>batteredSwordSpriteIndex</samp>
* <samp>copperColor</samp>
* <samp>GetSecondaryEnchantmentCount()</samp>
* <samp>goldColor</samp>
* <samp>iridiumColor</samp>
* <samp>nonUpgradeable</samp>
* <samp>parsnipSpriteIndex</samp>
* <samp>Stackable</samp>
* <samp>startOfNegativeWeaponIndex</samp>
* <samp>steelColor</samp>
|-
| <samp>Utility</samp>
|  
* <samp>buyFloor()</samp>
* <samp>buyWallpaper()</samp>
* <samp>cropsOfTheWeek()</samp>
* <samp>facePlayerEndBehavior(…)</samp>
* <samp>getRandomSlotCharacter()</samp>
* <samp>plantCrops(…)</samp>
* <samp>showLanternBar()</samp>
|}
====Renamed classes====
These classes were renamed in 1.6:
{| class="wikitable"
</syntaxhighlight>
|-
! old name
! new name
|-
| <samp>Game1.MusicContext</samp>
| <samp>MusicContext</samp> (in <samp>StardewValley.GameData</samp>)
|-
| <samp>LocationContext</samp>
| <samp>LocationContexts</samp>
|-
| <samp>SpecialOrder.QuestStatus</samp>
| <samp>SpecialOrderStatus</samp> (in <samp>StardewValley.SpecialOrders</samp>)
|}
And these were moved to a different namespace:
{| class="wikitable"
|-
! type
! old namespace
! new namespace
|-
| <samp>AmethystEnchantment</samp><br /><samp>AquamarineEnchantment</samp><br /><samp>ArchaeologistEnchantment</samp><br /><samp>ArtfulEnchantment</samp><br /><samp>AutoHookEnchantment</samp><br /><samp>AxeEnchantment</samp><br /><samp>BaseEnchantment</samp><br /><samp>BaseWeaponEnchantment</samp><br /><samp>BottomlessEnchantment</samp><br /><samp>BugKillerEnchantment</samp><br /><samp>CrusaderEnchantment</samp><br /><samp>DiamondEnchantment</samp><br /><samp>EfficientToolEnchantment</samp><br /><samp>EmeraldEnchantment</samp><br /><samp>FishingRodEnchantment</samp><br /><samp>GalaxySoulEnchantment</samp><br /><samp>GenerousEnchantment</samp><br /><samp>HaymakerEnchantment</samp><br /><samp>HoeEnchantment</samp><br /><samp>JadeEnchantment</samp><br /><samp>MagicEnchantment</samp><br /><samp>MasterEnchantment</samp><br /><samp>MilkPailEnchantment</samp><br /><samp>PanEnchantment</samp><br /><samp>PickaxeEnchantment</samp><br /><samp>PowerfulEnchantment</samp><br /><samp>PreservingEnchantment</samp><br /><samp>ReachingToolEnchantment</samp><br /><samp>RubyEnchantment</samp><br /><samp>ShavingEnchantment</samp><br /><samp>ShearsEnchantment</samp><br /><samp>SwiftToolEnchantment</samp><br /><samp>TopazEnchantment</samp><br /><samp>VampiricEnchantment</samp><br /><samp>WateringCanEnchantment</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.Enchantments</samp>
|-
| <samp>Extensions</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.Extensions</samp>
|-
| <samp>ModDataDictionary</samp><br /><samp>ModHooks</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.Mods</samp>
|-
| <samp>PathFindController</samp><br /><samp>PathNode</samp><br /><samp>PriorityQueue</samp><br /><samp>SchedulePathDescription</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.Pathfinding</samp>
|-
| <samp>SpecialOrder</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.SpecialOrders</samp>
|-
| <samp>CollectObjective</samp><br /><samp>DeliverObjective</samp><br /><samp>DonateObjective</samp><br /><samp>FishObjective</samp><br /><samp>GiftObjective</samp><br /><samp>JKScoreObjective</samp><br /><samp>OrderObjective</samp><br /><samp>ReachMineFloorObjective</samp><br /><samp>ShipObjective</samp><br /><samp>SlayObjective</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.SpecialOrders.Objectives</samp>
|-
| <samp>FriendshipReward</samp><br /><samp>GemsReward</samp><br /><samp>MailReward</samp><br /><samp>MoneyReward</samp><br /><samp>OrderReward</samp><br /><samp>ResetEventReward</samp>
| <samp>StardewValley</samp>
| <samp>StardewValley.SpecialOrders.Rewards</samp>
|}
====Other API changes====
These class members changed in 1.6:
===Other ID changes===
{| class="wikitable"
|-
! type
! member
! migration
|-
| <samp>BigSlime</samp>
| <samp>heldObject</samp>
| Replaced by <samp>heldItem</samp>, which allows non-object items too.
|-
|-
|rowspan="3"| <samp>Bush</samp>
| <samp>overrideSeason</samp>
| Removed; use <code>bush.Location.GetSeason()</code> instead.
|-
|-
| <samp>appliedBuffs</samp><br /><samp>appliedSpecialBuffs</samp>
| <samp>greenhouseBush</samp>
| Removed; use <code>bush.IsSheltered()</code> or <code>bush.currentLocation.IsGreenhouse</code> instead.
|-
|-
| <samp>attack</samp><br /><samp>immunity</samp>
| <samp>inBloom</samp>
| Use <samp>Attack</samp> and <samp>Immunity</samp> instead.
| Remove the arguments, like <code>bush.inBloom(Game1.currentSeason, Game1.dayOfMonth)</code> → <code>bush.inBloom()</code>.
|-
|-
| <samp>addedCombatLevel</samp><br /><samp>addedFarmingLevel</samp><br /><samp>addedFishingLevel</samp><br /><samp>addedForagingLevel</samp><br /><samp>addedLuckLevel</samp><br /><samp>addedMiningLevel</samp><br /><samp>attackIncreaseModifier</samp><br /><samp>critChanceModifier</samp><br /><samp>critPowerModifier</samp><br /><samp>knockbackModifier</samp><br /><samp>resilience</samp><br /><samp>weaponPrecisionModifier</samp><br /><samp>weaponSpeedModifier</samp>
|rowspan="3"| <samp>Character</samp>
| Use equivalent properties under <samp>Game1.player.buffs</samp> instead (e.g. <samp>Game1.player.buffs.CombatLevel</code>).
| <samp>getStandingX</samp><br /><samp>getStandingY</samp><br /><samp>getStandingXY</samp>
| Removed; use <samp>character.StandingPixel</samp> instead.
|-
|-
| <samp>addedSpeed</samp><br /><samp>CombatLevel</samp><br /><samp>CraftingTime</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MagneticRadius</samp><br /><samp>MaxStamina</samp><br /><samp>MiningLevel</samp><br /><samp>Stamina</samp>
| <samp>getTileLocation</samp><br /><samp>getTileX</samp><br /><samp>getTileY</samp><br />
| Removed; use <samp>character.Tile</samp> instead.
|}</li>
|-
|-
| <samp>getTileLocationPoint</samp>
| Removed; use <samp>character.TilePoint</samp> instead.
|-
|-
| <samp>CanSpawnCharacterHere</samp>
| <samp>Chest</samp>
| Get whether NPCs can be placed on the given tile (e.g. it's within the map bounds and tile is walkable), '''and''' there's no placed object (even if walkable like flooring) and the <samp>NoFurniture</samp> [[Modding:Maps|tile property]] isn't set.
| <samp>MoveToSafePosition</samp>
| Replaced by the simpler <samp>TryMoveToSafePosition</samp>
|-
|-
| <samp>CanItemBePlacedHere</samp>
|rowspan="2"| <samp>Dialogue</samp>
| Get whether items can be placed on the given tile in non-floating form (e.g. it's within the map bounds and not blocked by a non-walkable item). If the <samp>item_is_passable</samp> argument is true, this ignores players/NPCs on the tile.
| <samp>dialogues</samp>
| Changed from <code>List<string></code> to <code>List<DialogueLine></code>. The <samp>Text</samp> field on each dialogue line is equivalent to the old value.
|-
|-
| <samp>isBuildable</samp>
| <samp>isOnFinalDialogue()</samp>
| Get whether buildings can be placed on the given tile.
| This now indicates whether it's showing the last dialogue ''with message text''; there may still be entries in <samp>dialogues</samp> which apply side-effects without message text.
|-
|-
| <samp>IsTilePassable</samp>
|rowspan="3"| <samp>Farmer</samp>
| Get whether the tile can be walked on (ignoring collisions with in-game objects, NPCs, etc).
| <samp>changePants(…)</samp>
| Renamed to <samp>changePantsColor(…)</samp> for consistency with <samp>change[Eye|Hair|Shoe]Color</samp>.
|-
|-
| <samp>IsTileOccupiedBy</samp>
| <samp>isMarried()</samp>
| Get whether the tile contains a player, object, NPC/monster/pet/etc, terrain feature, building, etc. You can specify <code>ignore_passables: false</code> to ignore objects which can be walked over (like flooring), and override <samp>collision_mask</samp> to change the collision logic (e.g. <code>collision_mask: GameLocation.CollisionMask.All & ~GameLocation.CollisionMask.Farmers</code> to ignore players on the tile).
| Renamed to <samp>isMarriedOrRoommates()</samp> for clarity.
|-
|-
| <samp>IsTileBlockedBy</samp>
| <samp>visibleQuestCount</samp>
| Equivalent to calling both <samp>IsTilePassable</samp> and <samp>IsTileOccupiedBy</samp>.
| Replaced by <samp>hasVisibleQuests</samp>.
|-
| <samp>Flooring</samp>
| <samp>GetFloorPathLookup</samp>
| Use <samp>Game1.floorPathData</samp> instead.
|-
| <samp>Forest</samp>
| <samp>log</samp>
| Moved into <samp>Forest.resourceClumps</samp>.
|-
| <samp>FruitTree</samp>
| <samp>GreenHouseTree</samp>
| Replaced by <samp>IgnoresSeasonsHere()</samp>.
|-
|rowspan="3"| <samp>Game1</samp>
| <samp>bigCraftableInformation</samp>
| Overhauled into [[#Custom big craftables|<samp>Game1.bigCraftableData</samp>]].
|-
| <samp>clothingInformation</samp>
| Overhauled into [[#Custom shirts|<samp>Game1.shirtData</samp>]] and [[#Custom pants|<samp>Game1.pantsData</samp>]].
|-
| <samp>objectInformation</samp>
| Overhauled into [[#Custom objects|<samp>Game1.objectData</samp>]].
|-
|rowspan="3"| <samp>GameLocation</samp>
| <samp>getCharacters</samp>
| Removed; use the <samp>characters</samp> field instead.
|-
| <samp>GetMapPropertyPosition</samp>
| Replaced by <samp>TryGetMapPropertyAs</samp>, which supports multiple data types (not just <samp>Point</samp>).
|-
|-
| <samp>IsLocationSpecificOccupantOnTile</samp><br /><samp>IsLocationSpecificPlacementRestriction</samp>
| <samp>isTileOccupied</samp><br /><samp>isTileOccupiedForPlacement</samp><br /><samp>isTileOccupiedIgnoreFloors</samp><br /><samp>isTileLocationOpenIgnoreFrontLayers</samp><br /><samp>isTileLocationTotallyClearAndPlaceable</samp><br /><samp>isTileLocationTotallyClearAndPlaceableIgnoreFloors</samp>
| Generally shouldn't be used directly. Checks for location-specific collisions (e.g. ladders in [[The Mines|the mines]] or parrot platforms on [[Ginger Island]]).
| Removed. The collision logic has been significantly rewritten and uses a new set of methods (mainly <samp>isTilePassable</samp>, <samp>IsTileOccupiedBy</samp>, and <samp>CanItemBePlacedHere</samp>). Mods should ideally be updated to use the new methods.
Here's a drop-in set of extension methods which re-add the older methods. This lets you temporarily fix code until you can update it properly, but depending on these isn't recommended since they won't be maintained in future versions.
{{collapse|expand for non-recommended code|content=<syntaxhighlight lang="c#">
public static class GameLocationExtensions
{
public static bool isTileOccupiedForPlacement(this GameLocation location, Vector2 tileLocation, Object toPlace = null)
{
return location.CanItemBePlacedHere(tileLocation, toPlace != null && toPlace.isPassable());
}
==Breaking changes for content packs==
public static bool isTileOccupied(this GameLocation location, Vector2 tileLocation, string characterToIgnore = "", bool ignoreAllCharacters = false)
{
CollisionMask mask = ignoreAllCharacters ? CollisionMask.All & ~CollisionMask.Characters & ~CollisionMask.Farmers : CollisionMask.All;
return location.IsTileOccupiedBy(tileLocation, mask);
}
===Standardized data fields===
public static bool isTileOccupiedIgnoreFloors(this GameLocation location, Vector2 tileLocation, string characterToIgnore = "")
{
return location.IsTileOccupiedBy(tileLocation, CollisionMask.Buildings | CollisionMask.Furniture | CollisionMask.Objects | CollisionMask.Characters | CollisionMask.TerrainFeatures, ignorePassables: CollisionMask.Flooring);
}
public static bool isTileLocationOpenIgnoreFrontLayers(this GameLocation location, Location tile)
{
return location.map.RequireLayer("Buildings").Tiles[tile.X, tile.Y] == null && !location.isWaterTile(tile.X, tile.Y);
}
public static bool isTileLocationTotallyClearAndPlaceable(this GameLocation location, int x, int y)
{
return location.isTileLocationTotallyClearAndPlaceable(new Vector2(x, y));
}
public static bool isTileLocationTotallyClearAndPlaceableIgnoreFloors(this GameLocation location, Vector2 v)
{
return location.isTileOnMap(v) && !location.isTileOccupiedIgnoreFloors(v) && location.isTilePassable(new Location((int)v.X, (int)v.Y), Game1.viewport) && location.isTilePlaceable(v);
}
// after
public static bool isTileLocationTotallyClearAndPlaceable(this GameLocation location, Vector2 v)
{
Vector2 pixel = new Vector2((v.X * Game1.tileSize) + Game1.tileSize / 2, (v.Y * Game1.tileSize) + Game1.tileSize / 2);
foreach (Furniture f in location.furniture)
{
if (f.furniture_type != Furniture.rug && !f.isPassable() && f.GetBoundingBox().Contains((int)pixel.X, (int)pixel.Y) && !f.AllowPlacementOnThisTile((int)v.X, (int)v.Y))
return false;
}
return location.isTileOnMap(v) && !location.isTileOccupied(v) && location.isTilePassable(new Location((int)v.X, (int)v.Y), Game1.viewport) && location.isTilePlaceable(v);
}
}
</syntaxhighlight>
}}
|-
| <samp>GiantCrop</samp>
| <samp>which</samp>
| Replaced by <samp>itemId</samp>.
|-
| <samp>Item</samp>
| <samp>SanitizeContextTag</samp>
| Replaced by <samp>ItemContextTagManager.SanitizeContextTag</samp>.
|-
| <samp>LocalizedContentManager</samp>
| <samp>LanguageCodeString</samp>
| Now static.
|-
| <samp>LocationContextData</samp>
| <samp>Name</samp>
| Removed; use its dictionary key in <samp>Game1.locationContextData</samp> instead.
|-
| <samp>NetFields</samp>
| <samp>AddFields</samp>
| Removed; use <samp>AddField</samp> instead. For example:
<syntaxhighlight lang="c#">
// old code
NetFields.AddFields(textureName, spriteWidth, spriteHeight);
// new code
NetFields
.AddField(textureName)
.AddField(spriteWidth)
.AddField(spriteHeight);
</syntaxhighlight>
<ul>
Note that the second argument (<samp>name</samp>) should usually be omitted, since it'll be auto-populated from the value passed to the first argument.
|-
|-
|rowspan="7"| <samp>NPC</samp>
| <samp>canReceiveThisItemAsGift(…)</samp>
| Removed. The closest equivalent is <code>item.canBeGivenAsGift()</code>, or you can check if the NPC will accept the player's held object (as a gift or otherwise) using <code>npc.tryReceiveActiveObject(Game1.player, probe: true)</code>.
|-
|-
| <samp>Buildings/houses</samp>
| <samp>Gender</samp><br /><samp>female</samp><br /><samp>male</samp><br /><samp>undefined</samp>
| fixed missing pixels
| The <samp>Gender</samp> field now uses a <samp>Gender</samp> enum instead of numeric constants. For example, <code>npc.Gender == NPC.female</code> becomes <code>npc.Gender == Gender.Female</code> in 1.6.
|-
|-
| <samp>Characters/Dialogue/Emily</samp><br /><samp>Characters/Dialogue/Lewis</samp>
| <samp>homeRegion</samp>
| Removed; use <samp>npc.GetData()?.HomeRegion</samp> instead. Change <samp>0</samp> to <samp>"Other"</samp> or <samp>NPC.region_other</samp>, <samp>1</samp> to <samp>"Desert"</samp> or <samp>NPC.region_desert</samp>, and <samp>2</samp> to <samp>"Town"</samp> or <samp>NPC.region_town</samp>.
|-
|-
| <samp>Characters/Dialogue/Linux</samp>
| <samp>isBirthday</samp>
| fixed typos
| Remove the arguments, like <code>npc.isBirthday(Game1.currentSeason, Game1.dayOfMonth)</code> → <code>npc.isBirthday()</code>.
|-
|-
| <samp>Characters/Dialogue/MarriageDialogueEmily</samp>
| <samp>isVillager()</samp>
| changed <samp>spring_Maru</samp> key to <samp>spring_Emily</samp>
| Deprecated; use the <samp>character.IsVillager</samp> property instead.
|-
|-
| <samp>Characters/Dialogue/MarriageDialogueMaru</samp><br /><samp>Characters/Dialogue/Maru</samp><br /><samp>Characters/Dialogue/Robin</samp><br /><samp>Characters/Dialogue/Sam</samp>
| <samp>populateRoutesFromLocationToLocationList</samp>
| Replaced by <samp>WarpPathfindingCache.PopulateCache</samp>.
|-
|-
| <samp>Data/AquariumFish</samp>
| <samp>Schedule</samp>
| [[#Custom items|changed key type]], [[#Standardized data fields|standardized fields]]
| No longer assignable, use one of the <samp>TryLoadSchedule</samp> overloads instead.
|-
|-
| <samp>Data/BigCraftablesInformation</samp>
|rowspan="3"| <samp>Object</samp>
| [[#Custom items|changed key type]], [[#Standardized data fields|standardized fields]]
| <samp>GetContextTagList()</samp>
| Replaced by <samp>GetContextTags()</samp>, which returns a hash set instead of a list.
|-
|-
| <samp>Data/Boots</samp>
| <samp>HasBeenPickedUpByPlayer</samp>
| [[#Custom items|changed key type]], added display name
| Removed; use <samp>HasBeenInInventory</samp> instead.
|-
|-
| <samp>Data/Bundles</samp>
| <samp>isPotentialBasicShippedCategory</samp>
| [[#Standardized data fields|standardized fields]], added display name
| The second argument should now be an integer (like <samp>-75</samp> or <samp>Object.VegetableCategory</samp>) instead of a string (like <samp>"-75"</samp>).
|-
|-
| <samp>Data/ClothingInformation</samp>
|rowspan="9"| <samp>Utility</samp>
| [[#Custom items|changed key type]], [[#Standardized data fields|standardized fields]]
| <samp>doesItemWithThisIndexExistAnywhere</samp>
| Replace with <samp>Utility.doesItemExistAnywhere</samp>, which takes a string item ID. For example:
* <code>Utility.doesItemWithThisIndexExistAnywhere(128)</code> → <code>Utility.doesItemExistAnywhere("(O)128")</code>;
* <code>Utility.doesItemWithThisIndexExistAnywhere(128, true)</code> → <code>Utility.doesItemExistAnywhere("(BC)128")</code>.
|-
|-
| <samp>Data/CookingRecipes</samp>
| <samp>ForAllLocations</samp><br /><samp>iterateAllCrops</samp><br /><samp>iterateAllItems</samp>
| added display name
| Removed; use the equivalent <samp>Utility.ForEach*</samp> methods instead.
|-
|-
| <samp>Data/CraftingRecipes</samp>
| <samp>GetHorseWarpRestrictionsForFarmer</samp>
| added display name, fixed typo in Cookout Kit entry
| This now returns a flag enum instead of a list of integer values. The equivalent values are 1 → <samp>NoOwnedHorse</samp>, 2 → <samp>Indoors</samp>, 3 → <samp>NoRoom</samp>, and 4 → <samp>InUse</samp>.
For example:
<syntaxhighlight lang="c#">
// old code
bool inUse = Utility.GetHorseWarpRestrictionsForFarmer(player).Any(p => p == 4);
// new code
bool inUse = Utility.GetHorseWarpRestrictionsForFarmer(player).HasFlag(Utility.HorseWarpRestrictions.InUse);
</syntaxhighlight>
Or to check if no restrictions apply:
<syntaxhighlight lang="c#">
bool canSummon = Utility.GetHorseWarpRestrictionsForFarmer(player) == Utility.HorseWarpRestrictions.None;
</syntaxhighlight>
C# mods can patch <samp>Utility.GetHorseWarpErrorMessage</samp> if they need to add an error message for a custom restriction value.
|-
|-
| <samp>Data/Crops</samp>
| <samp>getRandomTownNPC(…)</samp>
| [[#Custom items|changed key type]]
| Replaced by either <code>Utility.GetRandomWinterStartParticipant(…)</code> or <code>Utility.getRandomNpcFromHomeRegion(NPC.region_town)</code>.
|-
|-
| <samp>Data/Events/FishShop</samp><br /><samp>Data/Events/IslandSouth</samp><br /><samp>Data/Events/Mountain</samp><br /><samp>Data/Events/SebastianRoom</samp><br /><samp>Data/Events/Town</samp>
| <samp>getTodaysBirthdayNPC</samp>
| Remove the arguments, like <code>Utility.getTodaysBirthdayNPC(Game1.currentSeason, Game1.dayOfMonth)</code> → <code>Utility.getTodaysBirthdayNPC()</code>.
|-
|-
| <samp>Data/Festivals/spring13</samp><br /><samp>Data/Festivals/spring24</samp><br /><samp>Data/Festivals/summer11</samp><br /><samp>Data/Festivals/summer28</samp><br /><samp>Data/Festivals/winter8</samp>
| <samp>getPooledList</samp><br /><samp>returnPooledList</samp>
| migrated to new <samp>warpFarmers</samp> command
| The game no longer uses a list pool. In most cases you should use the [[#Iteration|<samp>Utility.ForEach*</samp> methods]] instead, which don't need it.
|-
|-
| <samp>Data/Fish</samp>
| <samp>numObelisksOnFarm</samp>
| [[#Custom items|changed key type]]
| Renamed to <samp>GetObeliskTypesBuilt</samp>, which searches all locations.
| '''✘ broken'''
|-
| <samp>numSilos</samp>
| Removed.
If you're using this to calculate hay capacity, it's a bit more complicated in 1.6 since hay storage can be enabled for custom buildings and building construction can be enabled for any location. To get capacity for the current location, use <samp>Game1.currentLocation.GetHayCapacity()</samp> instead. To get total hay capacity in the world, use <samp>Utility.ForEachLocation</samp> to call it on every location.
If you actually need the number of silos, use <samp>location.getNumberBuildingsConstructed("Silo")</samp> (one location) or <samp>Game1.GetNumberBuildingsConstructed("Silo")</samp> (all locations).
|-
|-
| <samp>Data/FishPondData</samp>
| <samp>removeThisCharacterFromAllLocations</samp>
| [[#Custom items|changed <samp>ItemId</samp> field type]]
| Removed; use <samp>Game1.removeCharacterFromItsLocation</samp> instead.
|-
|-
| <samp>Data/fruitTrees</samp>
| <samp>ShopMenu</samp>
| [[#Custom items|changed key type]]
| <samp>storeContext</samp>
| Replaced by <samp>ShopId</samp>.
|
|-
|-
| <samp>Data/Furniture</samp>
|rowspan="3"| <samp>Stats</samp>
| [[#Custom items|changed key type]], [[#Standardized data fields|standardized fields]], added display name
| <samp>averageBedtime</samp><br /><samp>beveragesMade</samp><br /><samp>bouldersCracked</samp><br /><samp>caveCarrotsFound</samp><br /><samp>cheeseMade</samp><br /><samp>chickenEggsLayed</samp><br /><samp>copperFound</samp><br /><samp>cowMilkProduced</samp><br /><samp>cropsShipped</samp><br /><samp>daysPlayed</samp><br /><samp>diamondsFound</samp><br /><samp>dirtHoed</samp><br /><samp>duckEggsLayed</samp><br /><samp>fishCaught</samp><br /><samp>geodesCracked</samp><br /><samp>giftsGiven</samp><br /><samp>goatCheeseMade</samp><br /><samp>goatMilkProduced</samp><br /><samp>goldFound</samp><br /><samp>goodFriends</samp><br /><samp>individualMoneyEarned</samp><br /><samp>iridiumFound</samp><br /><samp>ironFound</samp><br /><samp>itemsCooked</samp><br /><samp>itemsCrafted</samp><br /><samp>itemsForaged</samp><br /><samp>itemsShipped</samp><br /><samp>monstersKilled</samp><br /><samp>mysticStonesCrushed</samp><br /><samp>notesFound</samp><br /><samp>otherPreciousGemsFound</samp><br /><samp>piecesOfTrashRecycled</samp><br /><samp>preservesMade</samp><br /><samp>prismaticShardsFound</samp><br /><samp>questsCompleted</samp><br /><samp>rabbitWoolProduced</samp><br /><samp>rocksCrushed</samp><br /><samp>seedsSown</samp><br /><samp>sheepWoolProduced</samp><br /><samp>slimesKilled</samp><br /><samp>stepsTaken</samp><br /><samp>stoneGathered</samp><br /><samp>stumpsChopped</samp><br /><samp>timesFished</samp><br /><samp>timesUnconscious</samp><br /><samp>totalMoneyGifted</samp><br /><samp>trufflesFound</samp><br /><samp>weedsEliminated</samp>
| Removed; use the equivalent property or methods. For example, <code>Game1.stats.daysPlayed</code> can be replaced with <code>Game1.stats.DaysPlayed</code> or methods like <code>Game1.stats.Get(StatKeys.DaysPlayed)</code>. See [[#Stat changes for C# mods|stat changes for C# mods]].
|-
|-
| <samp>Data/hats</samp>
| <samp>getStat(…)</samp><br /><samp>incrementStat(…)</samp>
| [[#Custom items|changed key type]], [[#Standardized data fields|standardized fields]], added display name
| Replaced by <samp>Get(…)</samp> and <samp>Increment(…)</samp>. See [[#Stat changes for C# mods|stat changes for C# mods]].
|-
|-
| <samp>Data/mail</samp>
| <samp>stat_dictionary</samp>
| fixed typos
| Renamed to <samp>Values</samp>. See [[#Stat changes for C# mods|stat changes for C# mods]].
| ✘ will remove changes
|-
|-
| <samp>Data/ObjectContextTags</samp>
| <samp>Woods</samp>
| added new entries & tags
| <samp>stumps</samp>
| '''✘ broken'''
| Moved into <samp>resourceClumps</samp>.
|}
===Check for obsolete code===
Perform a full rebuild of your mod (in Visual Studio, click ''Build > Rebuild Solution''), then check the Error List pane for any warnings like "'''X' is obsolete''". Anything from the vanilla game code which is marked obsolete won't work anymore and is only kept for save migrations. Usually the warning will include an explanation of what you should use instead.
==Breaking changes for content packs==
'''This section only describes how this update may break existing mods. See the ''what's new'' sections above for more info, including new functionality mods can use.'''
===Standardized ID fields===
Stardew Valley 1.6 adds an <samp>Id</samp> field to these assets. For Content Patcher content packs, these replace the previous synthetic ID:
{| class="wikitable"
|-
|-
! asset
! old key
! new key
! migration steps
|-
|-
| <samp>Data/Quests</samp>
| <samp>Data/ConcessionTastes</samp><br /><samp>Data/MovieReactions</samp><br /><samp>Data/RandomBundles</samp> (area)<br /><samp>Data/RandomBundles</samp> (bundle)
| changed item fields to use item IDs (backwards-compatible)
| <samp>Name</samp><br /><samp>NPCName</samp><br /><samp>AreaName</samp><br />''none''
| ✘ will remove changes
|<samp>Id</samp>
| ✓ mostly unaffected
| None. The <samp>Id</samp> field is set automatically to the same value (or <samp>Name</samp> for bundles), so there's no change for content packs. Omit the new field when creating a new entry.
|-
|-
| <samp>Data/SecretNotes</samp>
| <samp>Data/FishPondData</samp><br /><samp>Data/RandomBundles</samp> (bundle set)
| updated <samp>%revealtaste</samp> format (backwards-compatible)
| <samp>RequiredTags</samp><br />''none''
| ✘ will remove changes
| <samp>Id</samp>
| ✓ mostly unaffected
| Use the new <samp>Id</samp> field to target an entry, and add it when creating a new entry. Required.
|-
|-
| <samp>Data/TailoringRecipes</samp>
| <samp>Data/TailoringRecipes</samp>
| changed to [[#Custom items|string item IDs]] ('''TODO: possibly backwards-compatible?''')
| <samp>FirstItemTags</samp> and <samp>SecondItemTags</samp>
| '''✘ broken'''
| <samp>Id</samp>
| Use the new <samp>Id</samp> field to target an entry, and add it when creating a new entry. Defaults to the <samp>CraftedItemIds</samp> (comma-delimited) or <samp>CraftedItemId</samp> value if omitted, but there's a high chance of conflicts so mods should always specify a unique ID.
|}
| <samp>Data/TV/TipChannel</samp>
| fixed typo
For example, let's say you have a patch like this using Content Patcher:
{{#tag:syntaxhighlight|<nowiki>
| ✓ mostly unaffected
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
"Changes": [
| [[#Custom items|changed key type]], added display name
{
"Action": "EditData",
| '''✘ likely broken'''
"Target": "Data/TailorRecipes",
"Entries": {
"item_cloth|item_pufferchick": {
"FirstItemTags": [ "item_cloth" ],
"SecondItemTags": [ "item_pufferchick" ],
"CraftedItemId": "(S)1260"
}
}
}
]
}</nowiki>|lang=javascript}}
| <samp>Maps/AnimalShop</samp>
When updating to Stardew Valley 1.6, replace the synthetic ID (<samp>item_cloth|item_pufferchick</samp>) with a real one:
* To edit an existing entry, unpack the asset and get its new <samp>Id</samp> value.
| '''✘ broken'''
* To add a custom entry, use a [[Modding:Common data field types#Unique string ID|unique string ID]].
For example:
{{#tag:syntaxhighlight|<nowiki>
| [[#Other changes|changed map & tile properties to string]]
{
"Format": "</nowiki>{{Content Patcher version}}<nowiki>",
|
"Changes": [
{
"Action": "EditData",
"Target": "Data/TailorRecipes",
"Entries": {
"ExampleAuthor.ModId_RainCoatFromPufferchick": {
"Id": "ExampleAuthor.ModId_RainCoatFromPufferchick", // need to specify ID again when creating it
"FirstItemTags": [ "item_cloth" ],
"SecondItemTags": [ "item_pufferchick" ],
"CraftedItemId": "(S)1260"
}
}
}
]
}</nowiki>|lang=javascript}}
===Event ID changes===
{{/doc status|[[Modding:Event data]]|done=false}}
: ''See also: [[#String event IDs|string event IDs in what's new]].''
Events now have unique string IDs.
When creating an event:
<ul>
<li>New events should use a globally unique ID in the form <samp>Your.ModId_EventName</samp>. Existing events should be fine as-is, but it may be worth migrating them to avoid future conflicts.</li>
<li>Every non-fork event '''must''' have a precondition in its key (even if it's empty). For example, change <code>"Your.ModId_EventName": "..."</code> to <code>"Your.ModId_EventName/": "..."</code>. This is needed for the game to distinguish between events and fork scripts.
<syntaxhighlight lang="js">
"Example.ModId_EventName/": "...", // event: loaded automatically by the game
"SomeFork": "..." // event fork: ignored unless it's loaded through an event script
</syntaxhighlight></li>
</ul>
===Monster eradication goal flag changes===
{{/doc status|a new doc page|done=false}}
: ''See also: [[#Custom monster eradication goals|Custom monster eradication goals]].''
The game now tracks [[Adventurer's Guild]] monster eradication goal completion by the goal ID, instead of the produced item. You'll need to replace these mail flags if you check them:
{| class="wikitable"
|-
|-
! old flag
! new flag
|-
|-
| <samp>Maps/BathHouse_Pool</samp>
| <samp>Gil_Slime Charmer Ring</samp>
| added <samp>Music</samp> map property
| <samp>Gil_Slimes</samp>
|-
|-
| <samp>Maps/Beach</samp>
| <samp>Gil_Savage Ring</samp>
| added <samp>DefaultCrabPotArea</samp> + <samp>LegendaryFishAreaCorners</samp> + <samp>Music</samp> + <samp>MusicIgnoreInRain</samp> map properties
| <samp>Gil_Shadows</samp>
|-
|-
| <samp>Maps/Beach-NightMarker</samp>
| <samp>Gil_Vampire Ring</samp>
| added <samp>DefaultCrabPotArea</samp> + <samp>DefaultFishingArea</samp> map properties
| <samp>Gil_Bats</samp>
|-
|-
| <samp>Maps/BoatTunnel</samp>
| <samp>Gil_Skeleton Mask</samp>
| [[#Other changes|changed map & tile properties to string]], added <samp>DefaultCrabPotArea</samp> map property
| <samp>Gil_Skeletons</samp>
|-
|-
| <samp>Maps/Cabin</samp><br /><samp>Maps/Cabin1</samp><br /><samp>Maps/Cabin1_marriage</samp><br /><samp>Maps/Cabin2</samp><br /><samp>Maps/Cabin2_marriage</samp>
| <samp>Gil_Insect Head</samp>
| <samp>Gil_Insects</samp>
|-
|-
| <samp>Maps/Caldera</samp>
| <samp>Gil_Hard Hat</samp>
| added <samp>Music</samp> map property
| <samp>Gil_Duggy</samp>
|-
|-
| <samp>Maps/Club</samp>
| <samp>Gil_Burglar's Ring</samp>
| added <samp>LocationContext</samp> map property
| <samp>Gil_DustSpirits</samp>
|-
|-
| <samp>Maps/Coop</samp><br /><samp>Maps/Coop2</samp>
| <samp>Gil_Crabshell Ring</samp>
| <samp>Gil_Crabs</samp>
|-
|-
| <samp>Maps/Coop3</samp>
| <samp>Gil_Arcane Hat</samp>
| [[#Other changes|changed map & tile properties to string]], added <samp>AutoFeed</samp> map property
| <samp>Gil_Mummies</samp>
|-
|-
| <samp>Maps/Desert</samp>
| <samp>Gil_Knight's Helmet</samp>
| added <samp>LocationContext</samp> map property
| <samp>Gil_Dinos</samp>
|-
|-
| <samp>Maps/ElliottHouse</samp>
| <samp>Gil_Napalm Ring</samp>
| added <samp>Music</samp> map property
| <samp>Gil_Serpents</samp>
|-
|-
| <samp>Maps/Farm</samp><br /><samp>Maps/Farm_Combat</samp>
| <samp>Gil_Telephone</samp>
| [[#Other changes|changed map & tile properties to string]], updated farmhouse area for moveable farmhouse
| <samp>Gil_FlameSpirits</samp>
|}
|
===XNB impact===
====Overview====
This section provides a summary of the XNB files which changed in Stardew Valley 1.6. This doesn't include new files (since they won't impact existing mods), or text changes in non-English files.
[[Modding:Using XNB mods|XNB mods]] are disproportionately affected, since...
# they replace the entire file;
# they're loaded through the MonoGame content pipeline which is less tolerant of format changes;
# they don't benefit from the compatibility rewrites [[Modding:Content Patcher|Content Patcher]] provides for its content packs.
Content Patcher packs are typically unaffected (and Content Patcher will try to rewrite content packs automatically). However if a content pack replaces an entire asset instead of editing, it's more likely to be affected like an XNB mod.
====Changed assets====
Compatibility is broadly grouped into four categories:
* "'''✘ broken'''": mods will remove new content or significant changes, or the mod's intended changes will no longer work. Effects may range from display bugs to crashes, depending how the game uses that specific content.
* "✘ will remove changes": mods will remove minor changes in 1.6 (e.g. typo fixes).
* "✓ mostly unaffected": mods will only be affected if they replace the entire asset, or edit specific entries or fields.
* Blank: no expected impact for the vast majority of mods.
{| class="wikitable"
|-
|-
| <samp>Maps/Farm_Fishing</samp><br /><samp>Maps/Farm_Foraging</samp><br /><samp>Maps/Farm_FourCorners</samp>
!rowspan="2"| content asset
| [[#Other changes|changed map & tile properties to string]], added <samp>DefaultFishingArea</samp> map property, updated farmhouse area for moveable farmhouse
!rowspan="2"| changes in 1.6
!colspan="2"| compatibility for pre-1.6 mods
|-
|-
! XNB mods
! Content Patcher packs
|-
|-
| <samp>Maps/Farm_Island</samp>
| <samp>Buildings/houses</samp>
| [[#Other changes|changed map & tile properties to string]], added <samp>DefaultFishingArea</samp> + <samp>DefaultCrabPotArea</samp> map properties, updated farmhouse area for moveable farmhouse
|  
| '''✘ broken'''
* fixed missing pixels
|
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Farm_Mining</samp>
| <samp>Characters/Dialogue/Abigail</samp><br /><samp>Characters/Dialogue/Alex</samp>
| [[#Other changes|changed map & tile properties to string]], added <samp>DefaultFishingArea</samp> map property, updated farmhouse area for moveable farmhouse
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/FarmHouse</samp><br /><samp>Maps/FarmHouse_Bedroom_Normal</samp><br /><samp>Maps/FarmHouse_Bedroom_Open</samp><br /><samp>Maps/FarmHouse_Cellar</samp><br /><samp>Maps/FarmHouse_ChildBed_0</samp><br /><samp>Maps/FarmHouse_ChildBed_1</samp><br /><samp>Maps/FarmHouse_CornerRoom_Add</samp><br /><samp>Maps/FarmHouse_CornerRoom_Remove</samp><br /><samp>Maps/FarmHouse_SouthernRoom_Add</samp><br /><samp>Maps/FarmHouse_SouthernRoom_Remove</samp><br /><samp>Maps/FarmHouse1</samp><br /><samp>Maps/FarmHouse1_marriage</samp><br /><samp>Maps/FarmHouse2</samp><br /><samp>Maps/FarmHouse2_marriage</samp>
| <samp>Characters/Dialogue/Caroline</samp><br /><samp>Characters/Dialogue/Demetrius</samp>
| [[#Other changes|changed map & tile properties to string]]
|  
|
* fixed typos
|
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Forest</samp>
| <samp>Characters/Dialogue/Elliott</samp>
| added <samp>DefaultFishingArea</samp> + <samp>FishingAreaCorners</samp> + <samp>LegendaryFishAreaCorners</samp> map properties
|  
* added [[#Dialogue changes|flower dance dialogue]]
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Greenhouse</samp>
| <samp>Characters/Dialogue/Emily</samp>
| [[#Other changes|changed map & tile properties to string]]
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
* updated <samp>%revealtaste</samp> format (backwards-compatible)
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Island_W</samp>
| <samp>Characters/Dialogue/George</samp>
| added <samp>LegendaryFishAreaCorners</samp> and <samp>FishingAreaCorners</samp> map property
|  
* added [[#Dialogue changes|Winter Star gift exchange dialogue]]
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/IslandFarmHouse</samp>
| <samp>Characters/Dialogue/Gus</samp>
| [[#Other changes|changed map & tile properties to string]]
|  
|
* fixed typos
|
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/JojaMart</samp>
| <samp>Characters/Dialogue/Haley</samp>
| added <samp>Music</samp> and <samp>MusicContext</samp> map properties
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/LeahHouse</samp><br /><samp>Maps/LeoTreeHouse</samp>
| <samp>Characters/Dialogue/Harvey</samp>
| added <samp>Music</samp> map property
|  
* added [[#Dialogue changes|flower dance dialogue]]
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/MarnieBarn</samp><br /><samp>Maps/Mine</samp>
| <samp>Characters/Dialogue/Jas</samp><br /><samp>Characters/Dialogue/Jodi</samp>
| [[#Other changes|changed map & tile properties to string]]
|  
|
* fixed typos
|
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Mountain</samp>
| <samp>Characters/Dialogue/Krobus</samp>
| [[#Other changes|changed map & tile properties to string]], added <samp>LegendaryFishAreaCorners</samp> map property
|  
* added [[#Dialogue changes|roommate stardrop dialogue]]
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Leah</samp>
|  
* added [[#Dialogue changes|flower dance dialogue]]
| '''✘ broken'''
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Lewis</samp>
|  
* updated <samp>%revealtaste</samp> format (backwards-compatible)
|
|
|
|
|-
|-
| <samp>Maps/MovieTheaterScreen</samp>
| <samp>Characters/Dialogue/Linus</samp>
| [[#Other changes|changed map & tile properties to string]]; changes to allow more players/NPCs at a time
|  
* added [[#Dialogue changes|dumpster dive dialogue]]
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
| ✘ broken if they edit the affected tiles
| ✓ mostly unaffected
|-
|-
| <samp>Maps/MovieTheaterScreen_TileSheet</samp>
| <samp>Characters/Dialogue/Marnie</samp>
| improved light cone; changes to allow more players/NPCs at a time.
|  
| ✘ broken visuals
* added [[#Dialogue changes|Stardew Valley Fair dialogue]]
| '''✘ broken'''
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
|-
| <samp>Maps/paths</samp>
| <samp>Characters/Dialogue/MarriageDialogue</samp><br /><samp>Characters/Dialogue/MarriageDialogueAbigail</samp><br /><samp>Characters/Dialogue/MarriageDialogueElliott</samp>
| added icon for [[#Custom wild trees|custom wild tree spawn]]
|  
|
* fixed typos
|
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Saloon</samp>
| <samp>Characters/Dialogue/MarriageDialogueEmily</samp>
| added <samp>Music</samp> map property
|  
* changed <samp>spring_Maru</samp> key to <samp>spring_Emily</samp>
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/MarriageDialogueKrobus</samp><br /><samp>Characters/Dialogue/MarriageDialogueLeah</samp><br /><samp>Characters/Dialogue/MarriageDialogueMaru</samp><br /><samp>Characters/Dialogue/MarriageDialoguePenny</samp><br /><samp>Characters/Dialogue/MarriageDialogueSam</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
|-
| <samp>Maps/SandyHouse</samp>
| <samp>Characters/Dialogue/Maru</samp>
| added <samp>LocationContext</samp> and <samp>Music</samp> map properties
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/ScienceHouse</samp>
| <samp>Characters/Dialogue/Penny</samp>
| added <samp>Music</samp> map property
|  
* added [[#Dialogue changes|flower dance dialogue]]
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Sewer</samp>
| <samp>Characters/Dialogue/Pierre</samp>
| added <samp>LegendaryFishAreaCorners</samp> map property
|  
* added [[#Dialogue changes|Stardew Valley Fair dialogue]]
* fixed typos
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected
|-
|-
| <samp>Maps/Shed</samp>
| <samp>Characters/Dialogue/Robin</samp>
| added <samp>FloorIDs</samp> and <samp>WallIDs</samp> [[Modding:Maps|map properties]]
|  
| '''✘ broken'''
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Sam</samp>
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Sandy</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Sebastian</samp>
|  
* added [[#Dialogue changes|flower dance dialogue]]
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Willy</samp>
|  
* added [[#Dialogue changes|Stardew Valley Fair dialogue]]
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Dialogue/Shane</samp>
|  
* added [[#Dialogue changes|flower dance dialogue]]
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Characters/Farmer/hats</samp>
|  
* removed stray pixel on chicken mask
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Characters/schedules/Elliott</samp>
|  
* fixed order of <samp>Fri_6</samp> and <samp>Fri</samp> entries
| '''✘ broken'''
|
|
|-
|-
| <samp>Maps/SkullCave</samp>
| <samp>Characters/schedules/Lewis</samp>
| added <samp>LocationContext</samp> map property
|  
| '''✘ broken'''
* fixed <samp>winter_Sun</samp> schedule
|
| '''✘ broken'''
|-
| ✓ mostly unaffected
| <samp>Maps/spousePatios</samp>
|-
| [[#Other changes|changed map & tile properties to string]]
| <samp>Characters/schedules/Maru</samp>
|  
* fixed <samp>summer_Mon</samp> and <samp>summer_Sun</samp> schedules
| '''✘ broken'''
| ✓ mostly unaffected
|-
| '''✘ broken'''
| <samp>Characters/schedules/Penny</samp>
|
|  
|-
* fixed <samp>summer_Sun</samp> schedule
| <samp>Maps/Town</samp>
| '''✘ broken'''
| added <samp>LegendaryFishAreaCorners</samp> and multiple <samp>Music*</samp> map properties, changed to [[#Custom garbage cans|new garbage can IDs]] (backwards-compatible)
| ✓ mostly unaffected
|-
|
| <samp>Characters/Schedules/Shane</samp>
|-
|  
| <samp>Maps/Mines/Volcano_SetPieces_32</samp>
* fixed dialogue key
| [[#Other changes|changed map & tile properties to string]]
| ✘ will remove changes
|
| ✓ mostly unaffected
|
|-
|-
| <samp>Data/animationDescriptions</samp>
| <samp>Maps/Woods</samp>
|  
| added <samp>Music</samp> and <samp>MusicIgnoreInRain</samp> map properties
* fixed frame in Lewis' Saloon drinking animation
| '''✘ broken'''
| ✘ will remove changes
|
| ✓ mostly unaffected
|-
|-
| <samp>Strings/Buildings</samp>
| <samp>Data/AquariumFish</samp>
| added new entries for paint regions
|  
| '''✘ broken'''
* [[#Custom items|changed key type]]
|
* added hat position for [[Sea Urchin]]
| '''✘ broken'''
| ✓ mostly unaffected
| fixed typos
|-
| <samp>Data/BigCraftablesInformation</samp>
|  
* asset replaced by [[#Custom big craftables|<samp>Data/BigCraftables</samp>]]:
| <samp>Strings/UI</samp>
** migrated to data model format
** added new features
| '''✘ broken'''
| '''✘ broken'''
|
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|}
|-
| <samp>Data/Blueprints</samp>
|  
* asset replaced by [[#Custom buildings|<samp>Data/Buildings</samp>]]:
** migrated to data model format
** added new features
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/Boots</samp>
|  
* [[#Custom items|changed key type]]
* added display name
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/Bundles</samp>
|  
* can no longer omit empty fields before display name
* added display name field in English
* removed meat items in animal bundle
| '''✘ broken'''
| '''✘ likely broken'''
|-
| <samp>Data/ClothingInformation</samp>
|  
* asset replaced by [[#Custom pants|<samp>Data/Pants</samp>]] and [[#Custom shirts|<samp>Data/Shirts</samp>]]:
** migrated to data model format
** added new features
| '''✘ broken'''
| '''✘ likely broken'''
|-
| <samp>Data/Concessions</samp>
|  
* [[#Custom movie concessions|added new required fields (<samp>Texture</samp> and <samp>SpriteIndex</samp>)]]
* replaced translations with [[Modding:Tokenizable strings|tokenizable strings]]
* changed IDs to strings
| '''✘ broken'''
| '''✘ likely broken'''
|-
| <samp>Data/ConcessionTastes</samp>
|  
* added automatic <samp>ID</samp> field
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/CookingRecipes</samp>
|  
* replaced translations with [[Modding:Tokenizable strings|tokenizable strings]]
* display names can now be omitted to use item name
| ✘ will remove changes
| ✓ may remove unaffected
|-
| <samp>Data/CraftingRecipes</samp>
|  
* replaced translations with [[Modding:Tokenizable strings|tokenizable strings]]
* display names can now be omitted to use item name
* added <samp>default</samp> unlock condition
* fixed typo in Cookout Kit entry
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/Crops</samp>
|  
* [[#Custom crops|completely overhauled]]
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/Events/AnimalShop</samp>
|  
* updated command syntax (backwards-compatible)
|
|
|-
| <samp>Data/Events/Farm</samp>
|  
* replaced send-mail events with [[Modding:Trigger actions|trigger actions]]
* updated pet event to support custom pet types
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(✘ may cause duplicate mail if they edit<br />send-mail events)</small>
|-
| <samp>Data/Events/FishShop</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/Forest</samp>
|  
* fixed typos
* updated Jas <samp>faceDirection</samp> command for sewer event
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/IslandHut</samp>
|  
* updated how Leo's name is translated
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/IslandNorth</samp>
|  
* updated quote format
* fixed blank music field (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(✘ likely broken if they edit the <samp>6497421</samp> event)</small>
|-
| <samp>Data/Events/IslandSouth</samp>
|  
* fixed blank music field (backwards-compatible)
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/JoshHouse</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/LeahHouse</samp>
|  
* fixed <samp>move</samp> command format in Leah's 2-heart event
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/Events/Mountain</samp>
|  
* fixed skipped dialogue in Maru's 14-heart event
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/Saloon</samp><br /><samp>Data/Events/ScienceHouse</samp><br /><samp>Data/Events/SebastianRoom</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Events/Town</samp>
|  
* fixed <samp>warp</samp> command format in community center completed event
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/Events/WizardHouse</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/ExtraDialogue</samp>
|  
* split <samp>SummitEvent_Dialogue1_Spouse</samp> entry
* fixed event command formats in some summit dialogue
* moved [[#Dialogue changes|dumpster dive dialogue into NPC files]]
* removed unused entries
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/FarmAnimals</samp>
|  
* [[#Custom farm animals|completely overhauled]]
| '''✘ broken'''
| '''✘ broken'''
|-
| <samp>Data/Festivals/fall16</samp>
|  
* updated command syntax (backwards-compatible)
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Festivals/fall27</samp>
|  
* removed <samp>shop</samp> field (moved into [[#Custom shops|<samp>Data/Shops</samp>]])
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
| <samp>Data/Festivals/spring13</samp>
|  
* migrated to new <samp>warpFarmers</samp> command
* removed <samp>shop</samp> field (moved into [[#Custom shops|<samp>Data/Shops</samp>]])
* updated <samp>faceDirection</samp> syntax
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(✘ broken if they edit <samp>mainEvent</samp> or<br /><samp>afterEggHunt</samp> fields)</small>
|-
| <samp>Data/Festivals/spring24</samp><br /><samp>Data/Festivals/summer11</samp><br /><samp>Data/Festivals/summer28</samp>
|  
* migrated to new <samp>warpFarmers</samp> command
* removed <samp>shop</samp> field (moved into [[#Custom shops|<samp>Data/Shops</samp>]])
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(✘ broken if they edit <samp>mainEvent</samp> field)</small>
|-
| <br /><samp>Data/Festivals/winter8</samp>
|  
* migrated to new <samp>warpFarmers</samp> command
* removed <samp>shop</samp> field (moved into [[#Custom shops|<samp>Data/Shops</samp>]])
* removed broken <samp>loadActors MainEvent</samp> command
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(✘ broken if they edit <samp>mainEvent</samp> or<br /><samp>afterIceFishing</samp> field)</small>
|-
| <samp>Data/Festivals/winter25</samp>
|  
* removed <samp>shop</samp> field (moved into [[#Custom shops|<samp>Data/Shops</samp>]])
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
| <samp>Data/Fish</samp>
|  
* no longer has per-language versions
* [[#Custom items|changed key type]]
* field 13 now refers to whether fish can be tutorial catch
| '''✘ broken'''
| ✘ likely broken
|-
| <samp>Data/FishPondData</samp>
|  
* added required <samp>Id</samp> & optional <samp>Precedence</samp> fields
* standardized <samp>ID</samp>→<samp>Id</samp> naming
* changed to qualified item IDs
* moved fallback entries to bottom
| '''✘ broken'''
| ✘ likely broken
|-
| <samp>Data/fruitTrees</samp>
|  
* [[#Custom fruit trees|completely overhauled]]
| '''✘ broken'''
| '''✘ broken'''
|-
| <samp>Data/Furniture</samp>
|  
* [[#Custom items|changed key type]]
* replaced translations with [[Modding:Tokenizable strings|tokenizable strings]]
* [[#Custom items|changed key type]]
* can no longer omit empty fields before display name
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/hats</samp>
|  
* [[#Custom items|changed key type]]
* can no longer omit empty fields before display name
* added display name field in English
| '''✘ broken'''
| '''✘ likely broken'''
|-
| <samp>Data/Locations</samp>
|  
* [[#Custom locations|completely overhauled]]
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/mail</samp>
|  
* migrated to <samp>%item id</samp> (backwards-compatible)
* removed unused entries
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Monsters</samp>
|  
* changed ''Dust Spirit'' display name to ''Dust Sprite''
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/Movies</samp>
|  
* [[#Custom movies|significantly overhauled]]
| '''✘ broken'''
| '''✘ broken'''
|-
| <samp>Data/MoviesReactions</samp>
|  
* replaced translations with [[Modding:Tokenizable strings|tokenizable strings]]
* standardized <samp>ID</samp>→<samp>Id</samp> naming
* fixed typo
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/NPCDispositions</samp>
|  
* asset replaced by [[#Custom NPCs|<samp>Data/Characters</samp>]]
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/NPCGiftTastes</samp>
|  
* removed invalid item IDs
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/ObjectContextTags</samp>
|  
* asset removed (replaced by <samp>ContextTags</samp> field in [[#Custom big craftables|<samp>Data/BigCraftables</samp>]] and [[#Custom objects|<samp>Data/Objects</samp>]])
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration,<br />except context tags defined<br />before their objects and context<br />tags for bigcraftables.)
</small>
|-
| <samp>Data/ObjectInformation</samp>
|  
* asset replaced by [[#Custom objects|<samp>Data/Objects</samp>]]:
** migrated to data model format
** added new features
** added new entries
** adjusted [[#Other item changes|litter items]]
** fixed typos
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>Data/PaintData</samp>
|  
* fixed trailing slash in <samp>Deluxe Barn</samp> entry
|
|
|-
| <samp>Data/Quests</samp>
|  
* changed key type to string
* migrated to use item IDs (backwards-compatible)
* fixed typo
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/RandomBundles</samp>
|  
* add optional <samp>Id</samp> field
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Data/SecretNotes</samp>
|  
* updated <samp>%revealtaste</samp> format (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/SpecialOrders</samp>
|  
* changed type of <samp>Repeatable</samp> and <samp>Duration</samp> fields
* added optional <samp>CustomFields</samp> and <samp>Conditions</samp> fields
| '''✘ broken'''
|
|-
| <samp>Data/SpousePatios</samp><br /><samp>Data/SpouseRooms</samp>
|  
* removed asset (merged into [[#Custom NPCs|<samp>Data/Characters</samp>]])
| '''✘ broken'''
| '''✘ broken'''
|-
| <samp>Data/TailoringRecipes</samp>
|  
* changed to [[#Custom items|string item IDs]] (backwards-compatible)
* added optional <samp>Id</samp> and <samp>CraftedItemIdFeminine</samp> fields
* removed <samp>CraftedItemColor</samp> field
* adjusted recipes for gender-variant shirts
* standardized <samp>ID</samp>→<samp>Id</samp> naming
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(<samp>MoveEntries</samp> may break, but fallback entries<br />are now checked last automatically)</small>
|-
| <samp>Data/TV/CookingChannel</samp><br /><samp>Data/TV/TipChannel</samp>
|  
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Data/weapons</samp>
|  
* [[#Custom melee weapons|completely overhauled]]
| '''✘ broken'''
| ✓ mostly unaffected<br /><small>(covered by runtime migration)</small>
|-
| <samp>LooseSprites/Cursors</samp>
|  
* new sprites in empty area
* moved mailbox to <samp>Buildings/Mailbox</samp>
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>LooseSprites/Cursors2</samp>
|  
* new sprite in empty area
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>LooseSprites/map</samp>
|  
* redrawn to better match in-game locations
* added more detail
| '''✘ broken'''
| ✘ likely broken
|-
| <samp>Maps/AbandonedJojaMart</samp><br /><samp>Maps/AdventureGuild</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/AnimalShop</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/ArchaeologyHouse</samp>
|  
* removed unused pathfinding tiles
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
|
|
|-
| <samp>Maps/Backwoods</samp><br /><samp>Maps/Backwoods_GraveSite</samp><br /><samp>Maps/Backwoods_Staircase</samp>
|  
* removed unused tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Barn</samp><br /><samp>Maps/Barn2</samp>
|  
* removed unused map properties
|
|
|-
| <samp>Maps/Barn3</samp>
|  
* added <samp>AutoFeed</samp> map property
* removed unused map properties
| '''✘ broken'''
|
|-
| <samp>Maps/BathHouse_Entry</samp><br /><samp>Maps/BathHouse_MensLocker</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* removed unused pathfinding tiles
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/BathHouse_Pool</samp>
|  
* removed unused pathfinding tiles
* removed unused map & tile properties
|
|
|-
| <samp>Maps/BathHouse_WomensLocker</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* removed unused pathfinding tiles
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Beach</samp>
|  
* removed unused map properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Beach-Jellies</samp><br /><samp>Maps/Beach-Luau</samp><br /><samp>Maps/Beach-NightMarket</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Blacksmith</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/BoatTunnel</samp>
|  
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/BugLand</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/BusStop</samp>
|  
* removed unused map/tile properties
* removed unused pathfinding tiles
* changed <samp>Action BusTicket</samp> to <samp>Action None</samp>
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Caldera</samp>
|  
* removed unused map property
|
|
|-
| <samp>Maps/Cellar</samp>
|  
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Club</samp>
|  
* added <samp>LocationContext</samp> map property
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Coop</samp><br /><samp>Maps/Coop2</samp>
|  
* removed unused map properties
|
|
|-
| <samp>Maps/Coop3</samp>
|  
* added <samp>AutoFeed</samp> map property
* removed unused map properties
| '''✘ broken'''
|
|-
| <samp>Maps/Desert</samp>
|  
* added <samp>LocationContext</samp> map property
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
|
|-
| <samp>Maps/ElliottHouse</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Farm</samp><br /><samp>Maps/Farm_Combat</samp><br /><samp>Maps/Farm_Fishing</samp><br /><samp>Maps/Farm_Foraging</samp><br /><samp>Maps/Farm_FourCorners</samp><br /><samp>Maps/Farm_Island</samp><br /><samp>Maps/Farm_Mining</samp>
|  
* added new tilesheet
* added cabin positions for players 5–8
* added <samp>PetBowlLocation</samp> map property (for <samp>Maps/Four_Corners</samp> and <samp>Farm/Island</samp> only)
* added <samp>SpouseAreaLocation</samp> map property (for <samp>Maps/Farm_Island</samp> only)
* significant tile & tile property changes
* removed farmhouse + pet bowl areas (now moveable)
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✘ may remove changes
|-
| <samp>Maps/Farm_Greenhouse_Dirt</samp><br /><samp>Maps/Farm_Greenhouse_Dirt_FourCorners</samp>
|  
* removed unused map properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/FarmHouse</samp><br /><samp>Maps/FarmHouse_Bedroom_Normal</samp><br /><samp>Maps/FarmHouse_Bedroom_Open</samp><br /><samp>Maps/FarmHouse_Cellar</samp><br /><samp>Maps/FarmHouse_ChildBed_0</samp><br /><samp>Maps/FarmHouse_ChildBed_1</samp><br /><samp>Maps/FarmHouse_CornerRoom_Add</samp><br /><samp>Maps/FarmHouse_CornerRoom_Remove</samp><br /><samp>Maps/FarmHouse_SouthernRoom_Add</samp><br /><samp>Maps/FarmHouse_SouthernRoom_Remove</samp><br /><samp>Maps/FarmHouse1</samp><br /><samp>Maps/FarmHouse1_marriage</samp><br /><samp>Maps/FarmHouse2</samp><br /><samp>Maps/FarmHouse2_marriage</samp>
|  
* removed unused map properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/FishingGame</samp>
|  
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/FishShop</samp>
|  
* fixed broken <samp>DayTiles</samp> and <samp>NightTiles</samp> values
* removed unused pathfinding tiles
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Forest</samp>
|  
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Forest-FlowerFestival</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Forest-IceFestival</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* fixed warp positions
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Forest-SewerClean</samp>
|  
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/HaleyHouse</samp><br /><samp>Maps/HarveyRoom</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Hospital</samp>
|  
* removed deprecated <samp>UniquePortrait</samp> & <samp>UniqueSprite</samp> map properties
* removed unused pathfinding tiles
| ✘ will remove changes<br /><small>(This may cause mod conflicts)</samp>
| ✓ mostly unaffected
|-
| <samp>Maps/Island_Bridge_Broken</samp><br /><samp>Maps/Island_Bridge_Repaired</samp><br /><samp>Maps/Island_House_Cave</samp>
|  
* removed unused map properties
|
|
|-
| <samp>Maps/Island_N</samp>
|  
* update walnut bush tile so it still works in 1.6
* removed unused tile property
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/IslandNorthCave1</samp><br /><samp>Maps/IslandSouthEastCave</samp><br /><samp>Maps/IslandSouthEastCave_pirates</samp><br /><samp>Maps/IslandWestCave1</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Island_Bridge_Broken</samp><br /><samp>Maps/Island_Bridge_Repaired</samp>
|  
* removed unused map property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Island_E</samp><br /><samp>Maps/IslandFarmCave</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Island_House_Cave</samp>
|  
* removed unused map property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Island_Hut</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Island_N</samp>
|  
* added a <samp>NowSpawn False</samp> tile property to fix tree that hides a golden walnut
* removed unused tile property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Island_N_Trader</samp><br /><samp>Maps/Island_Secret</samp>
|  
* removed unused tile property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Island_Shrine</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Island_W</samp>
|  
* removed unused tile property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/IslandFarmHouse</samp>
|  
* removed unused tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/JojaMart</samp><br /><samp>Maps/JoshHouse</samp><br /><samp>Maps/LeahHouse</samp><br /><samp>Maps/ManorHouse</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/MarnieBarn</samp>
|  
* removed unused map properties
|
|
|-
| <samp>Maps/Mine</samp>
|  
* updated for [[#Custom minecarts|minecart changes]]
* removed unused map properties
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Mountain</samp>
|  
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Mountain-BridgeFixed</samp><br /><samp>Maps/Mountain_Shortcuts</samp>
|  
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/MovieTheater</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/MovieTheaterScreen</samp>
|  
* updated for tilesheet changes
| ✘ broken visuals (e.g. missing chairs)
| ✓ mostly unaffected<br /><small>(✘ broken visuals if they edit the affected tiles)</small>
|-
| <samp>Maps/MovieTheaterScreen_TileSheet</samp>
|  
* improved light cone
* moved chair sprite to make room for new light cone
| ✘ broken visuals (e.g. missing chairs)
| ✓ mostly unaffected<br /><small>(✘ broken visuals if they edit the affected sprites)</small>
|-
| <samp>Maps/paths</samp>
|  
* added icon for [[#Custom wild trees|custom wild tree spawn]]
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/QiNutRoom</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Railroad</samp>
|  
* removed unused map property
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Saloon</samp><br /><samp>Maps/SamHouse</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/SandyHouse</samp>
|  
* added <samp>LocationContext</samp> map property
| '''✘ broken'''
|
|-
| <samp>Maps/ScienceHouse</samp><br /><samp>Maps/SebastianRoom</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/SeedShop</samp>
|  
* removed unused tile properties
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Sewer</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Shed</samp><br /><samp>Maps/Shed2</samp>
|  
* added <samp>FloorIDs</samp> and <samp>WallIDs</samp> map properties
| '''✘ broken'''
|
|-
| <samp>Maps/SkullCave</samp>
|  
* added <samp>LocationContext</samp> map property
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/SlimeHutch</samp>
|  
* removed unused tile property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/spousePatios</samp>
|  
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/spring_outdoorsTileSheet</samp><br /><samp>Maps/summer_outdoorsTileSheet</samp><br /><samp>Maps/fall_outdoorsTileSheet</samp><br /><samp>Maps/winter_outdoorsTileSheet</samp>
|  
* pet bowl moved to <samp>Buildings/Pet Bowl</samp>
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
| <samp>Maps/Submarine</samp>
|  
* removed unused tile property
|
|
|-
| <samp>Maps/Sunroom</samp>
|  
* added <samp>IsGreenhouse</samp map property
| '''✘ broken'''
|
|-
| <samp>Maps/Tent</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Town</samp>
|  
* updated [[#Custom garbage cans|garbage can IDs]] (backwards-compatible)
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Town-Christmas</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Town-DogHouse</samp>
|  
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Town-EggFestival</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* fixed Elliott appearing twice during egg hunt
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Town-Fair</samp>
|  
* removed unused map/tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Town-Halloween</samp>
|  
* updated for festival shops now in <samp>Data/Shops</samp>
* removed unused map/tile properties
* removed unused pathfinding tiles
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Maps/Town-Theater</samp><br /><samp>Maps/Town-TheaterCC</samp><br /><samp>Maps/Town-TrashGone</samp>
|  
* removed unused tile properties
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Maps/Trailer</samp>
|  
* removed unused tile property
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Trailer_big</samp>
|  
* removed unused pathfinding tiles
|
|
|-
| <samp>Maps/Tunnel</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* removed unused map property
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/WitchHut</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/WitchSwamp</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/WitchWarpCave</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/WizardHouse</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* removed unused pathfinding tiles
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/WizardHouseBasement</samp>
|  
* moved <samp>Music</samp> property into <samp>Data/Locations</samp>
* removed unused map property
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Maps/Woods</samp>
|  
* removed unused tile property
* standardized <samp>T</samp> for boolean tile property values (backwards-compatible)
|
|
|-
| <samp>Minigames/boatJourneyMap</samp>
|  
* asset replaced by redrawn seasonal variants like <samp>fall_boatJourneyMap</samp>
| '''✘ broken'''
| '''✘ broken'''
|-
| <samp>Strings/Characters</samp>
|  
* added new entries
| '''✘ broken'''
|
|-
| <samp>Strings/BundleNames</samp>
|  
* removed unused entries
|
|
|-
| <samp>Strings/Characters</samp>
|  
* added new entries
* removed unused entry
| '''✘ broken'''
|
|-
| <samp>Strings/credits</samp>
|  
* updated for 1.6
* various changes
| ✘ will remove changes
| ✘ will remove changes
|-
| <samp>Strings/Events</samp>
|  
* moved [[#Dialogue changes|flower dance dialogue]] for Emily and Shane to their NPC dialogue files
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
| <samp>Strings/FarmAnimals</samp>
|  
* added new entries
| '''✘ broken'''
|
|-
| <samp>Strings/Lexicon</samp>
|  
* removed unused entries
|
|
|-
| <samp>Strings/Locations</samp>
|  
* added new entries
* added placeholder to <samp>BusStop_BuyTicketToDesert</samp>
* renamed <samp>BoatTunnel_BuyTicket</samp> to <samp>BuyTicket</samp>
* updated how Professor Snail's name is translated, removed unused entries
* fixed typos
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Strings/NPCNames</samp>
|  
* added new entries
* removed unused entry
| '''✘ broken'''
|
|-
| <samp>Strings/Notes</samp>
|  
* trimmed trailing whitespace
|
|
|-
| <samp>Strings/Objects</samp>
|  
* added new entries
* removed unused entries
| '''✘ broken'''
|
|-
| <samp>Strings/schedules/Caroline</samp>
|  
* fixed typo
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Strings/SpecialOrderStrings</samp>
|  
* renamed ''Dust Spirits'' to ''Dust Sprites''
* fixed typos
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <samp>Strings/StringsFromCSFiles</samp>
|  
* added new entries
* removed unused entries
* reworked <samp>FarmComputer_*</samp> translations
* merged some gendered translations
* merged <samp>ItemDeliveryQuest.cs.13533</samp> into <samp>ItemDeliveryQuest.cs.13534</samp>–<samp>13536</samp>
* changed some player names from <samp>{0}</samp> to <samp>@</samp>
* fixed typo
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <samp>Strings/StringsFromMaps</samp>
|  
* fixed typos
* removed unused entries
| ✘ will remove changes
|
|-
| <samp>Strings/UI</samp>
|  
* added new entries
* added placeholder for cabin count in <samp>Character_CoopHelpString</samp>
* fixed typos
* removed unused entries
| '''✘ broken'''
| ✓ mostly unaffected
|}
====Removed unused assets====
Stardew Valley 1.6 deletes assets which weren't used by the game. Mods usually aren't affected by this.
Removed assets:
* <samp>Characters/Dana</samp>
* <samp>Characters/Dick</samp>
* <samp>Characters/femaleRival</samp>
* <samp>Characters/maleRival</samp>
* <samp>Characters/shirts</samp>
* <samp>Characters/WeddingOutfits</samp>
* <samp>Data/TV/InterviewShow</samp>
* <samp>Effects/BrightWhite</samp>
* <samp>Fonts/tinyFontBorder</samp>
* <samp>Maps/Cabin</samp>
* <samp>Maps/Cabin1</samp>
* <samp>Maps/Cabin1_marriage</samp>
* <samp>Maps/Cabin2</samp>
* <samp>Maps/Cabin2_marriage</samp>
* <samp>Maps/Island_Boulder_Removed</samp>
* <samp>Maps/qiNutRoom_tilesheet_0</samp>
* <samp>Maps/spring_outrdoorsTileSheet_lightergrass</samp>
* <samp>Portraits/Dobson</samp>
* <samp>TerrainFeatures/DiggableWall_basic</samp>
* <samp>TerrainFeatures/DiggableWall_basic_dark</samp>
* <samp>TerrainFeatures/DiggableWall_frost</samp>
* <samp>TerrainFeatures/DiggableWall_frost_dark</samp>
* <samp>TerrainFeatures/DiggableWall_lava</samp>
* <samp>TerrainFeatures/DiggableWall_lava_dark</samp>
* <samp>TerrainFeatures/Quartz</samp>
==Vanilla release notes==
==Vanilla release notes==
''Moved to [[Version History#1.6]].''
==See also==
==See also==
* [[User:Pathoschild/Modding wishlist/Completed#Done in Stardew Valley 1.6|Modding wishlist items done in Stardew Valley 1.6]]
* [[User:Pathoschild/Modding wishlist/Completed#Done in Stardew Valley 1.6|Modding wishlist items done in Stardew Valley 1.6]] lists a few specialized changes not mentioned on this page.
[[Category:Modding]]
[[Category:Modding]]