translators
8,403
edits
Changes
Jump to navigation
Jump to search
Line 6:
Line 6: − + Line 106:
Line 106: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Line 120:
Line 193: − + − + Line 711:
Line 784: − − ===XNB impact=== − Here's a summary of the XNB files which changed in Stardew Valley 1.5.5. − − Notes: − * This ignores text changes in non-English files for simplicity. − * New content files aren't listed, since they won't impact existing mods. − * XNB mods are disproportionately affected, since they replace the entire file. Content Patcher packs are typically unaffected unless they replace the entire file (in which case see the XNB mod column). − − Shorthand: − * 'broken' means removing new content or potentially important changes, or potentially causing significant display bugs. This is a broad category — the game may work fine without it or crash, depending how it uses that specific content. − * 'mostly unaffected' means mods will only be affected if they edit specific entries or fields. − * Blank means no expected impact for the vast majority of mods. − − {| class="wikitable" − |- − ! content file − ! changes − ! XNB − ! Content Patcher − |- − | <tt>Data/TV/TipChannel</tt> − | fixed typo − | ✘ will remove changes − | ✓ mostly unaffected − |- − | <tt>Effects/BloomCombine</tt><br /><tt>Effects/BloomExtract</tt><br /><tt>Effects/GaussianBlur</tt> − | deleted − | − | − |- − | <tt>Fonts/*</tt> − | no changes<br />([[Modding:Editing XNB files#unpack|unpacked format]] may differ on Windows due to [[#64-bit MonoGame and .NET 5|MonoGame]]) − | − | − |- − | <tt>LooseSprites/Cursors2</tt> − | new sprite in empty area − | '''✘ broken''' − | ✓ mostly unaffected − |- − | <tt>Maps/Desert</tt> − | cosmetic fixes − | ✘ will remove changes − | ✓ mostly unaffected − |- − | <tt>Maps/ElliottHouse</tt> − | minor fixes − | ✘ will remove changes − | ✓ mostly unaffected − |- − | <tt>Maps/Farm</tt><br /><tt>Maps/Farm_Combat</tt><br /><tt>Maps/Farm_Fishing</tt><br /><tt>Maps/Farm_Foraging</tt><br /><tt>Maps/Farm_FourCorners</tt><br /><tt>Maps/Farm_Island</tt><br /><tt>Maps/Farm_Mining</tt> − | cave and shipping areas now use tile properties to disable building, instead of being hardcoded − | ✘ will remove those build restrictions − | ✘ may remove those build restrictions − |- − | <tt>Maps/FarmHouse</tt><br /><tt>Maps/FarmHouse1</tt><br /><tt>Maps/FarmHouse1_marriage</tt><br /><tt>Maps/FarmHouse2</tt><br /><tt>Maps/FarmHouse2_marriage</tt><br /><tt>Maps/Farmhouse_*</tt> renovation maps<br /><tt>Maps/IslandFarmHouse</tt><br /><tt>Maps/Shed</tt><br /><tt>Maps/Shed2</tt> − | added new [[#Custom floors/walls|wall/flooring properties]] − | '''✘ broken''' (will disable most floor/walls when renovations applied) − | ✘ may disable some floor/walls when renovations applied − |- − | <tt>Maps/spouseRooms</tt> − | added [[#Custom spouse rooms|spouse standing spots]] (defaults to old offset if not set) − | ✓ mostly unaffected − | ✓ mostly unaffected − |- − | <tt>Strings/Locations</tt> − | changed <tt>ManorHouse_DivorceBook_*</tt> entries to support [[#Non-Krobus roommates|Non-Krobus roommates]] − | '''✘ broken''' − | ✓ mostly unaffected − |}
Modding:Migrate to Stardew Valley 1.5.5 (view source)
Revision as of 16:50, 6 October 2021
, 16:50, 6 October 2021split into breaking changes vs new functionality
This page explains how to update your mods for compatibility with {{version|1.5.5|Stardew Valley 1.5.5}}, and documents some of the changes and new functionality.
This page explains how to update your mods for compatibility with {{version|1.5.5|Stardew Valley 1.5.5}}, and documents some of the changes and new functionality.
==For SMAPI mods==
==Breaking changes for SMAPI mods==
===Stardew Valley compatibility branch===
===Stardew Valley compatibility branch===
Stardew Valley 1.5.5 is available in two branches on each OS (with identical content for players): the ''main branch'' which is installed by default, and an optional ''compatibility branch'' for [https://www.stardewvalley.net/compatibility older systems]. These have identical content for players, but use different technologies:
Stardew Valley 1.5.5 is available in two branches on each OS (with identical content for players): the ''main branch'' which is installed by default, and an optional ''compatibility branch'' for [https://www.stardewvalley.net/compatibility older systems]. These have identical content for players, but use different technologies:
Previously the game assembly was <code>Stardew Valley</code> on Windows, and <code>StardewValley</code> on Linux and macOS. The assembly is now named <code>Stardew Valley</code> on all platforms. Most mods shouldn't be affected once you update the mod build package.
Previously the game assembly was <code>Stardew Valley</code> on Windows, and <code>StardewValley</code> on Linux and macOS. The assembly is now named <code>Stardew Valley</code> on all platforms. Most mods shouldn't be affected once you update the mod build package.
==Breaking changes for Content Patcher packs==
===XNB impact===
Here's a summary of the XNB files which changed in Stardew Valley 1.5.5.
Notes:
* This ignores text changes in non-English files for simplicity.
* New content files aren't listed, since they won't impact existing mods.
* XNB mods are disproportionately affected, since they replace the entire file. Content Patcher packs are typically unaffected unless they replace the entire file (in which case see the XNB mod column).
Shorthand:
* 'broken' means removing new content or potentially important changes, or potentially causing significant display bugs. This is a broad category — the game may work fine without it or crash, depending how it uses that specific content.
* 'mostly unaffected' means mods will only be affected if they edit specific entries or fields.
* Blank means no expected impact for the vast majority of mods.
{| class="wikitable"
|-
! content file
! changes
! XNB
! Content Patcher
|-
| <tt>Data/TV/TipChannel</tt>
| fixed typo
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <tt>Effects/BloomCombine</tt><br /><tt>Effects/BloomExtract</tt><br /><tt>Effects/GaussianBlur</tt>
| deleted
|
|
|-
| <tt>Fonts/*</tt>
| no changes<br />([[Modding:Editing XNB files#unpack|unpacked format]] may differ on Windows due to [[#64-bit MonoGame and .NET 5|MonoGame]])
|
|
|-
| <tt>LooseSprites/Cursors2</tt>
| new sprite in empty area
| '''✘ broken'''
| ✓ mostly unaffected
|-
| <tt>Maps/Desert</tt>
| cosmetic fixes
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <tt>Maps/ElliottHouse</tt>
| minor fixes
| ✘ will remove changes
| ✓ mostly unaffected
|-
| <tt>Maps/Farm</tt><br /><tt>Maps/Farm_Combat</tt><br /><tt>Maps/Farm_Fishing</tt><br /><tt>Maps/Farm_Foraging</tt><br /><tt>Maps/Farm_FourCorners</tt><br /><tt>Maps/Farm_Island</tt><br /><tt>Maps/Farm_Mining</tt>
| cave and shipping areas now use tile properties to disable building, instead of being hardcoded
| ✘ will remove those build restrictions
| ✘ may remove those build restrictions
|-
| <tt>Maps/FarmHouse</tt><br /><tt>Maps/FarmHouse1</tt><br /><tt>Maps/FarmHouse1_marriage</tt><br /><tt>Maps/FarmHouse2</tt><br /><tt>Maps/FarmHouse2_marriage</tt><br /><tt>Maps/Farmhouse_*</tt> renovation maps<br /><tt>Maps/IslandFarmHouse</tt><br /><tt>Maps/Shed</tt><br /><tt>Maps/Shed2</tt>
| added new [[#Custom floors/walls|wall/flooring properties]]
| '''✘ broken''' (will disable most floor/walls when renovations applied)
| ✘ may disable some floor/walls when renovations applied
|-
| <tt>Maps/spouseRooms</tt>
| added [[#Custom spouse rooms|spouse standing spots]] (defaults to old offset if not set)
| ✓ mostly unaffected
| ✓ mostly unaffected
|-
| <tt>Strings/Locations</tt>
| changed <tt>ManorHouse_DivorceBook_*</tt> entries to support [[#Non-Krobus roommates|Non-Krobus roommates]]
| '''✘ broken'''
| ✓ mostly unaffected
|}
==New features for SMAPI mods==
===Scarecrow changes===
===Scarecrow changes===
You can now patch <code>Object.IsScarecrow()</code> and/or <code>Object.GetRadiusForScarecrow()</code> (or add [[#Custom scarecrows|context tags]]) to support custom scarecrows or custom ranges.
You can now patch <code>Object.IsScarecrow()</code> and/or <code>Object.GetRadiusForScarecrow()</code> (or add [[#Custom scarecrows|context tags]]) to support custom scarecrows or custom ranges.
===Content changes===
===Content changes===
See ''[[#For Content Patcher packs|For Content Patcher packs]]'' below, which applies for C# mods too.
See ''[[#New features for Content Patcher packs|new features for Content Patcher packs]]'' below, which applies for C# mods too.
==For Content Patcher packs==
==New features for Content Patcher packs==
Stardew Valley 1.5.5 has no known breaking changes for content packs. All content packs should work fine once the framework mod that loads them is updated.
Stardew Valley 1.5.5 has no known breaking changes for content packs. All content packs should work fine once the framework mod that loads them is updated.
===Improved map seats===
===Improved map seats===
When defining map seats via <tt>Data\ChairTiles</tt> (see [[Modding:Migrate to Stardew Valley 1.5#Sitting on non-furniture chairs|docs in the 1.5 migration guide]]), you can now set the type field to <tt>custom {{t|offset_x}} {{t|offset_y}} {{t|extra_height}}</tt> to override the hardcoded offset and height values in code. The three values are measured in tiles (e.g. an X offset value of 0.5 would shift the sitting location by half a tile).
When defining map seats via <tt>Data\ChairTiles</tt> (see [[Modding:Migrate to Stardew Valley 1.5#Sitting on non-furniture chairs|docs in the 1.5 migration guide]]), you can now set the type field to <tt>custom {{t|offset_x}} {{t|offset_y}} {{t|extra_height}}</tt> to override the hardcoded offset and height values in code. The three values are measured in tiles (e.g. an X offset value of 0.5 would shift the sitting location by half a tile).
==See also==
==See also==