summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-09-02 18:54:56 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-09-02 18:54:56 -0400
commit8789b7efa816aab0f4ce9d3149c26b8033e0b0a5 (patch)
tree392f2f010ebcb7f795c8e1cc75286396f3fa8e44 /docs
parent5848a355bac789ba8d879df64bea400d17ea83f5 (diff)
downloadSMAPI-8789b7efa816aab0f4ce9d3149c26b8033e0b0a5.tar.gz
SMAPI-8789b7efa816aab0f4ce9d3149c26b8033e0b0a5.tar.bz2
SMAPI-8789b7efa816aab0f4ce9d3149c26b8033e0b0a5.zip
prepare path utilities for the upcoming Stardew Valley 1.5.5
The game will use Linux-style paths for assets on all platforms, which will break the current equivalence between path and asset name formats.
Diffstat (limited to 'docs')
-rw-r--r--docs/release-notes.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 45670c29..53640c93 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -9,11 +9,17 @@
* Updated compatibility list.
* For mod authors:
+ * Added `PathUtilities.NormalizeAssetName` and `PathUtilities.PreferredAssetSeparator` to prepare for the upcoming Stardew Valley 1.5.5.
* Fixed content packs created via `helper.ContentPacks.CreateFake` or `CreateTemporary` not initializing translations correctly.
* For console commands:
* Added `hurry_all` command which immediately warps all NPCs to their scheduled positions.
+**Update note for mod authors:**
+Stardew Valley 1.5.5 will change how asset names are formatted. If you use `PathUtilities.NormalizePath`
+to format asset names, you should switch to `PathUtilities.NormalizeAssetName` now so your code will
+continue working in the next game update.
+
## 3.12.5
Released 26 August 2021 for Stardew Valley 1.5.4 or later.