summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-02-01 11:11:44 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-02-01 11:11:44 -0500
commitaeb72586fdd94219cb9ae11cfd9f162765a5bc51 (patch)
tree8cc4c01245119faf1885501f1a3fcb95c6314b5a /docs
parentd0885831c3698bcb353d76c147500b7ea1dfbc78 (diff)
downloadSMAPI-aeb72586fdd94219cb9ae11cfd9f162765a5bc51.tar.gz
SMAPI-aeb72586fdd94219cb9ae11cfd9f162765a5bc51.tar.bz2
SMAPI-aeb72586fdd94219cb9ae11cfd9f162765a5bc51.zip
prepare for release
Diffstat (limited to 'docs')
-rw-r--r--docs/release-notes.md20
-rw-r--r--docs/technical/mod-package.md2
2 files changed, 12 insertions, 10 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index fca18bd2..f1981218 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,17 +1,18 @@
&larr; [README](README.md)
# Release notes
-## Upcoming release
+## 3.2
+Released 01 February 2020 for Stardew Valley 1.4.1 or later.
* For players:
- * SMAPI now prevents crashes due to mods adding invalid schedule data.
+ * SMAPI now prevents crashes due to invalid schedule data.
* SMAPI now prevents crashes due to invalid building types.
* Added support for persistent `smapi-internal/config.json` overrides (see info in the file).
* Updated minimum game version (1.4 → 1.4.1).
* Fixed 'collection was modified' error when returning to title in rare cases.
- * Fixed update-check error if a mod's Chucklefish page has no version.
- * Fixed SMAPI beta versions not showing update alert on next launch (thanks to danvolchek!).
+ * Fixed error when update-checking a mod with a Chucklefish page that has no version.
* Fixed rare error when building/demolishing buildings.
+ * Fixed SMAPI beta versions not showing update alert on next launch (thanks to danvolchek!).
* For the Console Commands mod:
* Added `performance` command to track mod performance metrics. This is an advanced experimental feature. (Thanks to Drachenkätzchen!)
@@ -22,20 +23,21 @@
* Fixed Android issue where game files were backed up.
* For modders:
- * Added support for loading `.tmx` map files.
- * Added JSON converter for `Vector2` values, so they work consistently crossplatform.
+ * Added support for `.tmx` map files.
+ * Added special handling for `Vector2` values in `.json` files, so they work consistently crossplatform.
* Reworked the order that asset editors/loaders are called between multiple mods to support some framework mods like Content Patcher and Json Assets. Note that the order is undefined and should not be depended on.
- * Removed invalid-schedule validation which had false positives.
+ * Fixed incorrect warning about mods adding invalid schedules in some cases. The validation was unreliable, and has been removed.
* Fixed asset propagation not updating other players' sprites.
* Fixed asset propagation for player sprites not updating recolor maps (e.g. sleeves).
- * Fixed `helper.Data.Read/WriteGlobalData` using the `Saves` folder instead of the game's appdata folder. The installer will move existing folders automatically.
+ * Fixed asset propagation for marriage dialogue.
* Fixed dialogue asset changes not correctly propagated until the next day.
- * Fixed dialogue asset propagation for marriage dialogue.
+ * Fixed `helper.Data.Read`/`WriteGlobalData` using the `Saves` folder instead of the game's appdata folder. The installer will move existing folders automatically.
* Fixed issue where a mod which implemented `IAssetEditor`/`IAssetLoader` on its entry class could then remove itself from the editor/loader list.
* For SMAPI/tool developers:
* Added internal performance monitoring (thanks to Drachenkätzchen!). This is disabled by default in the current version, but can be enabled using the `performance` console command.
* Added internal support for four-part versions to support SMAPI on Android.
+ * Rewrote `SemanticVersion` parsing.
* Updated links for the new r/SMAPI subreddit.
* The `/mods` web API endpoint now includes version mappings from the wiki.
* Dropped API support for the pre-3.0 update-check format.
diff --git a/docs/technical/mod-package.md b/docs/technical/mod-package.md
index a54d3011..e771d7a9 100644
--- a/docs/technical/mod-package.md
+++ b/docs/technical/mod-package.md
@@ -289,7 +289,7 @@ which can be uploaded to NuGet or referenced directly.
## Release notes
### 3.1
* Added support for semantic versioning 2.0.
-* `0Harmony.dll` is now ignored if the mod references it directly (it's bundled with SMAPI).
+* `0Harmony.dll` is now ignored if the mod references Harmony directly (it's bundled with SMAPI).
### 3.0
* Updated for SMAPI 3.0 and Stardew Valley 1.4.