diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2018-12-07 13:40:44 -0500 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2018-12-07 13:40:44 -0500 |
| commit | a78b1935928919694dfe8de823a1accd6d222732 (patch) | |
| tree | 3f17b6087cf2749e52c1e237de17e2e9addb6c06 /docs | |
| parent | 4cd9eda1591c3908bf80b60c2902491a7595ee27 (diff) | |
| parent | 8901218418693d610a17b22fe789ba6279f63446 (diff) | |
| download | SMAPI-a78b1935928919694dfe8de823a1accd6d222732.tar.gz SMAPI-a78b1935928919694dfe8de823a1accd6d222732.tar.bz2 SMAPI-a78b1935928919694dfe8de823a1accd6d222732.zip | |
Merge branch 'develop' into stable
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release-notes.md | 31 | ||||
| -rw-r--r-- | docs/technical-docs.md | 4 |
2 files changed, 31 insertions, 4 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index 90986cd4..cf11df7c 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,9 +1,36 @@ # Release notes +## 2.9 +* For players: + * Added support for ModDrop in update checks and the mod compatibility list. + * Added friendly error for Steam players when Steam isn't loaded. + * Fixed cryptic error when running the installer from inside a zip file on Windows. + * Fixed error when leaving and rejoining a multiplayer server in the same session. + * Fixed empty "mods with warnings" list in some cases due to hidden warnings. + * Fixed Console Commands' handling of tool upgrade levels for item commands. + +* For modders: + * Added ModDrop update keys (see [docs](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Manifest#Update_checks)). + * Added `IsLocalPlayer` to new player events. + * Added `helper.CreateTemporaryContentPack` to replace the deprecated `CreateTransitionalContentPack`. + * Reloading a map asset will now update affected locations. + * Reloading the `Data\NPCDispositions` asset will now update affected NPCs. + * Disabled trace messages related to paranoid mode when it's disabled. + * Fixed world events like `ObjectListChanged` not working in the mines. + * Fixed some map tilesheets not editable if not playing in English. + * Fixed newlines in manifest fields not being ignored. + * Fixed `Display.RenderedWorld` event invoked after overlays are rendered. + * **Deprecations:** + * All static events are deprecated and will be removed in SMAPI 3.0. Mods should use the new event system available through `helper.Events` instead; see [_migrate to SMAPI 3.0_](https://stardewvalleywiki.com/Modding:Migrate_to_SMAPI_3.0) for details. + +* For the web UI: + * Added stats to compatibility list. + * Fixed compatibility list showing beta header when there's no beta in progress. + ## 2.8.2 -* Fixed game crash in MacOS since SMAPI 2.8. +* Fixed game crash in MacOS with SMAPI 2.8. ## 2.8.1 -* Fixed installer error on Windows. +* Fixed installer error on Windows with SMAPI 2.8. ## 2.8 * For players: diff --git a/docs/technical-docs.md b/docs/technical-docs.md index 5883ee00..1d69f868 100644 --- a/docs/technical-docs.md +++ b/docs/technical-docs.md @@ -105,8 +105,8 @@ SMAPI uses a small number of conditional compilation constants, which you can se flag | purpose ---- | ------- -`SMAPI_FOR_WINDOWS` | Indicates that SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. - +`SMAPI_FOR_WINDOWS` | Whether SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. +`SMAPI_3_0_STRICT` | Whether to exclude all deprecated APIs from compilation. This is useful for testing mods for SMAPI 3.0 compatibility. # SMAPI web services ## Overview |