summaryrefslogtreecommitdiff
path: root/docs/release-notes.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-10-09 19:42:24 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-10-09 19:42:24 -0400
commitee77efcc976ef1a5ee64933a6174d2fac9c6d0f9 (patch)
tree2eeecc639014a6558e3d0f3ca41f65b429211412 /docs/release-notes.md
parent4d2ad379b4198fa7a341c6ba2bb6455d488b414f (diff)
downloadSMAPI-ee77efcc976ef1a5ee64933a6174d2fac9c6d0f9.tar.gz
SMAPI-ee77efcc976ef1a5ee64933a6174d2fac9c6d0f9.tar.bz2
SMAPI-ee77efcc976ef1a5ee64933a6174d2fac9c6d0f9.zip
prepare for release
Diffstat (limited to 'docs/release-notes.md')
-rw-r--r--docs/release-notes.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index b5a0adaf..7574d62b 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -7,20 +7,22 @@
_If needed, you can update to SMAPI 3.16.0 first and then install the latest version._
-->
-## Upcoming release
+## 3.17.0
+Released 09 October 2022 for Stardew Valley 1.5.6 or later. See [release highlights](https://www.patreon.com/posts/73090322).
+
* For players:
- * You can now download SMAPI 'strict mode' from the [Nexus optional files](https://www.nexusmods.com/stardewvalley/mods/2400/). This removes all deprecated APIs, which may significantly improve performance. However mods which still show deprecation warnings won't work.
- * The SMAPI installer now also detects game folders listed in Steam's `.vdf` library data on Windows (thanks to pizzaoverhead!).
+ * You can now download SMAPI 'strict mode' from [Nexus files](https://www.nexusmods.com/stardewvalley/mods/2400/?tab=files), which removes all deprecated APIs. This may significantly improve performance, but mods which still show deprecation warnings won't work.
+ * The SMAPI installer now also detects game folders in Steam's `.vdf` library data on Windows (thanks to pizzaoverhead!).
* SMAPI now prevents mods from enabling Harmony debug mode, which impacts performance and creates a file on your desktop.
_You can allow debug mode by editing `smapi-internal/config.json` in your game folder._
* Optimized performance and memory usage (thanks to atravita!).
* Other internal optimizations.
* Added more file extensions to ignore when searching for mod folders: `.7z`, `.tar`, `.tar.gz`, and `.xcf` (thanks to atravita!).
- * Removed `UseRawImageLoading` option. This is now always enabled, except when PyTK is installed.
+ * Removed transitional `UseRawImageLoading` option added in 3.15.0. This is now always enabled, except when PyTK is installed.
* Fixed update alerts incorrectly shown for prerelease versions on GitHub that aren't marked as prerelease.
* For mod authors:
- * When [providing a mod API for a C# mod](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Integrations), you can now get an optional parameter with the mod requesting the API (thanks to KhloeLeclair!). This avoids needing the pattern where each method needs the requesting mod's manifest.
+ * When [providing a mod API in a C# mod](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Integrations), you can now get the mod requesting it as an optional parameter (thanks to KhloeLeclair!).
* SMAPI now treats square brackets in the manifest `Name` field as round ones to avoid breaking tools which parse log files.
* Made deprecation message wording stronger for the upcoming SMAPI 4.0.0 release.
* The `Texture2D.Name` field is now set earlier to support mods like SpriteMaster.