From b8a566a060eb5caa8cc37edba3ca670192f7a35b Mon Sep 17 00:00:00 2001 From: kchapelier Date: Mon, 6 Jan 2020 09:27:24 +0100 Subject: Add french translation --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/README.md b/docs/README.md index 3a570f48..50478b52 100644 --- a/docs/README.md +++ b/docs/README.md @@ -64,7 +64,7 @@ locale | status ---------- | :---------------- default | ✓ [fully translated](../src/SMAPI/i18n/default.json) Chinese | ✓ [fully translated](../src/SMAPI/i18n/zh.json) -French | ❑ not translated +French | ✓ [fully translated](../src/SMAPI/i18n/fr.json) German | ✓ [fully translated](../src/SMAPI/i18n/de.json) Hungarian | ❑ not translated Italian | ❑ not translated -- cgit From 18c69c5587f1196afc5c380cb078157e71b1a385 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Tue, 7 Jan 2020 21:26:58 -0500 Subject: intercept schedule errors --- docs/release-notes.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index ed6f9013..cf8fee7a 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,6 +1,11 @@ ← [README](README.md) # Release notes +## Upcoming release + +* For players: + * SMAPI now prevents mods from crashing the game with invalid schedule data. + ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From ceff27c9a82bb16358aa0f390ce3f346c06c47bc Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Tue, 7 Jan 2020 21:29:49 -0500 Subject: update min game version 1.4.1 is needed due to the new gamepad option, which SMAPI 3.1 added support for. --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index cf8fee7a..5aa279b5 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -5,6 +5,7 @@ * For players: * SMAPI now prevents mods from crashing the game with invalid schedule data. + * Updated minimum game version (1.4 → 1.4.1). ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From 219696275df054d25cd385f950eb01ee33312e76 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 11 Jan 2020 13:20:37 -0500 Subject: fix errors due to async threads creating content managers --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 5aa279b5..dd4158aa 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,6 +6,7 @@ * For players: * SMAPI now prevents mods from crashing the game with invalid schedule data. * Updated minimum game version (1.4 → 1.4.1). + * Fixed 'collection was modified' error when returning to title in rare cases. ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From bffc7f28e9abcdb2a3e5e8ee5353f4c2f7e111a0 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 11 Jan 2020 19:16:46 -0500 Subject: fix update-check error for Chucklefish pages with no version --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index dd4158aa..22e609dd 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -7,6 +7,7 @@ * SMAPI now prevents mods from crashing the game with invalid schedule data. * 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. ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From 2b68be4ebbb16213167b9bd04e891c7e05c67400 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 11 Jan 2020 20:33:01 -0500 Subject: add version mappings from the wiki to API data --- docs/release-notes.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 22e609dd..63cbbc2c 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -9,6 +9,9 @@ * 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. +* For SMAPI/tool developers: + * The `/mods` web API endpoint now includes version mappings from the wiki. + ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From 5518e4cf241e487da26bd2e651a57724389edfe2 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 12 Jan 2020 15:45:54 -0500 Subject: fix asset propagation for player sprites not affecting other players or recolor maps --- docs/release-notes.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 63cbbc2c..f5c49a88 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -9,6 +9,9 @@ * 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. +For modders: + * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). + * For SMAPI/tool developers: * The `/mods` web API endpoint now includes version mappings from the wiki. -- cgit From 8b1fd90c6e72bff99d81a3b9614fdeaa6f67a950 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 12 Jan 2020 15:53:59 -0500 Subject: remove invalid-schedule error which can have false positives (e.g. when NPC is married to a player) --- docs/release-notes.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index f5c49a88..bc30bed7 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -11,8 +11,9 @@ For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). + * Removed invalid-schedule validation which had false positives. -* For SMAPI/tool developers: +For SMAPI/tool developers: * The `/mods` web API endpoint now includes version mappings from the wiki. ## 3.1 -- cgit From d68e4f97665898027f45782b8e66333912ae08ea Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 12 Jan 2020 19:41:14 -0500 Subject: drop pre-3.0 update-check support --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index bc30bed7..e2c6d500 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -15,6 +15,7 @@ For modders: For SMAPI/tool developers: * The `/mods` web API endpoint now includes version mappings from the wiki. + * Dropped API support for the pre-3.0 update-check format. ## 3.1 Released 05 January 2019 for Stardew Valley 1.4 or later. -- cgit From 700ea3cf1babe29d0365cdfec3cb2cd5a31e3f2b Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 12 Jan 2020 20:46:29 -0500 Subject: update release note (#691) --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index e2c6d500..fbf60573 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -8,6 +8,7 @@ * 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!). For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). -- cgit From 25a22f5d7c527e60919b0e08a212578a323a8165 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 18 Jan 2020 16:21:16 -0500 Subject: update community links --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index fbf60573..68ef3d71 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -15,6 +15,7 @@ For modders: * Removed invalid-schedule validation which had false positives. For SMAPI/tool developers: + * 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. -- cgit From 1670a2f3a6263da158db5231f60d42d529734209 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Wed, 22 Jan 2020 19:06:33 -0500 Subject: fix global data stored in saves folder --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 68ef3d71..b7bd7b53 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -13,6 +13,7 @@ For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * Removed invalid-schedule validation which had false positives. + * Fixed `helper.Data.Read/WriteGlobalData` using the `Saves` folder. The installer will move existing folders to the appdata folder. For SMAPI/tool developers: * Updated links for the new r/SMAPI subreddit. -- cgit From 381de5eba9f9822c3483abdf64396cec794e3d03 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Wed, 22 Jan 2020 20:36:24 -0500 Subject: add test_input console command --- docs/release-notes.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index b7bd7b53..8dac1d0c 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -10,6 +10,9 @@ * 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!). +For the Console Commands mod: + * Added `test_input` command to view button codes in the console. + For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * Removed invalid-schedule validation which had false positives. @@ -31,13 +34,14 @@ Released 05 January 2019 for Stardew Valley 1.4 or later. * Fixed compatibility with Linux Mint 18 (thanks to techge!), Arch Linux, and Linux systems with libhybris-utils installed. * Fixed memory leak when repeatedly loading a save and returning to title. * Fixed memory leak when mods reload assets. - * Fixes for Console Commands mod: - * added new clothing items; - * fixed spawning new flooring and rings (thanks to Mizzion!); - * fixed spawning custom rings added by mods; - * Fixed errors when some item data is invalid. * Updated translations. Thanks to L30Bola (added Portuguese), PlussRolf (added Spanish), and shirutan (added Japanese)! +* For the Console Commands mod: + * Added new clothing items. + * Fixed spawning new flooring and rings (thanks to Mizzion!). + * Fixed spawning custom rings added by mods. + * Fixed errors when some item data is invalid. + * For the web UI: * Added option to edit & reupload in the JSON validator. * File uploads are now stored in Azure storage instead of Pastebin, due to ongoing Pastebin perfomance issues. -- cgit From d1935e686c6396519a1ff9b1b429cd55adcf8d11 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Thu, 23 Jan 2020 00:31:26 -0500 Subject: add full internal support for non-standard four-part versions --- docs/release-notes.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 8dac1d0c..35fdbb4b 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -10,15 +10,16 @@ * 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!). -For the Console Commands mod: +* For the Console Commands mod: * Added `test_input` command to view button codes in the console. -For modders: +* For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * Removed invalid-schedule validation which had false positives. * Fixed `helper.Data.Read/WriteGlobalData` using the `Saves` folder. The installer will move existing folders to the appdata folder. -For SMAPI/tool developers: +* For SMAPI/tool developers: + * Added internal support for four-part versions to support SMAPI on Android. * 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. -- cgit From e33386abcc03c6fd94c365309a23e66f0fe9d6eb Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 25 Jan 2020 11:00:37 -0500 Subject: prevent load crashes due to invalid building types --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 35fdbb4b..970f26f1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -5,6 +5,7 @@ * For players: * SMAPI now prevents mods from crashing the game with invalid schedule data. + * SMAPI now prevents load crashes due to invalid building types. * 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. -- cgit From 4db7ca28f68be2e25b565a1b98e2c05fb42a5a88 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 25 Jan 2020 11:05:36 -0500 Subject: fix error building/demolishing buildings for some players --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 970f26f1..d8ff8f6a 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -10,6 +10,7 @@ * 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 rare error when building/demolishing buildings. * For the Console Commands mod: * Added `test_input` command to view button codes in the console. -- cgit From 7a6dab7548e7bc32a685e916edec83f6458881c1 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 25 Jan 2020 15:21:40 -0500 Subject: fix dialogue asset propagation --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index d8ff8f6a..fdae4dc5 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -19,6 +19,7 @@ * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * Removed invalid-schedule validation which had false positives. * Fixed `helper.Data.Read/WriteGlobalData` using the `Saves` folder. The installer will move existing folders to the appdata folder. + * Fixed dialogue asset changes not correctly propagated until the next day. * For SMAPI/tool developers: * Added internal support for four-part versions to support SMAPI on Android. -- cgit From fc0b98be4584eec2b06a3af09cc4b85f9e9a9efc Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 25 Jan 2020 18:22:50 -0500 Subject: add user settings that override defaults (#693) --- docs/release-notes.md | 1 + docs/technical/smapi.md | 13 ++----------- 2 files changed, 3 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index fdae4dc5..dc26db2d 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,6 +6,7 @@ * For players: * SMAPI now prevents mods from crashing the game with invalid schedule data. * SMAPI now prevents load 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. diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md index d565aeb4..c9d5c07e 100644 --- a/docs/technical/smapi.md +++ b/docs/technical/smapi.md @@ -19,17 +19,8 @@ This document is about SMAPI itself; see also [mod build package](mod-package.md ## Customisation ### Configuration file -You can customise the SMAPI behaviour by editing the `smapi-internal/config.json` file in your game -folder. - -Basic fields: - -field | purpose ------------------ | ------- -`DeveloperMode` | Default `false` (except in _SMAPI for developers_ releases). Whether to enable features intended for mod developers (mainly more detailed console logging). -`CheckForUpdates` | Default `true`. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background. -`VerboseLogging` | Default `false`. Whether SMAPI should log more information about the game context. -`ModData` | Internal metadata about SMAPI mods. Changing this isn't recommended and may destabilise your game. See documentation in the file. +You can customise some SMAPI behaviour by editing the `smapi-internal/config.json` file in your +game folder. See documentation in the file for more info. ### Command-line arguments The SMAPI installer recognises three command-line arguments: -- cgit From 9f36b2b3d69ee0a45241bfcc45953df29f167aef Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 26 Jan 2020 20:48:29 -0500 Subject: update release notes --- docs/release-notes.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index dc26db2d..5379950e 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -14,6 +14,7 @@ * Fixed rare error when building/demolishing buildings. * For the Console Commands mod: + * Added `performance` command to track mod performance metrics. This is an advanced experimental feature. (Thanks to Drachenkätzchen!) * Added `test_input` command to view button codes in the console. * For modders: @@ -23,6 +24,7 @@ * Fixed dialogue asset changes not correctly propagated until the next day. * 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. * Updated links for the new r/SMAPI subreddit. * The `/mods` web API endpoint now includes version mappings from the wiki. -- cgit From e5d8acf240f923a09bdaad3fb14b2c34847860dc Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Thu, 30 Jan 2020 22:10:16 -0500 Subject: rework asset editor/loader tracking so they're affected by load order --- docs/release-notes.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 5379950e..dada7726 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -19,9 +19,11 @@ * For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). + * 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 `helper.Data.Read/WriteGlobalData` using the `Saves` folder. The installer will move existing folders to the appdata folder. * Fixed dialogue asset changes not correctly propagated until the next day. + * 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. -- cgit From 125b38c6e62d86115045c2cece6c6c3d1da35600 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 00:18:56 -0500 Subject: improve Save Backup compatibility on Android --- docs/release-notes.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index dada7726..b49307c6 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -17,6 +17,10 @@ * Added `performance` command to track mod performance metrics. This is an advanced experimental feature. (Thanks to Drachenkätzchen!) * Added `test_input` command to view button codes in the console. +* For the Save Backup mod: + * Fixed extra files under `Saves` (e.g. manual backups) not being ignored. + * Fixed Android issue where game files were backed up. + * For modders: * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * 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. -- cgit From c8191449a00e3db08214e3b1146e17f89f0245c5 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 00:27:53 -0500 Subject: add support for *.tmx map files --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index b49307c6..1ad73492 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -22,6 +22,7 @@ * Fixed Android issue where game files were backed up. * For modders: + * Added support for loading `.tmx` map files. * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * 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. -- cgit From 70a1334f2c50cff279344b9b9d52d71c847516a7 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 01:08:29 -0500 Subject: add JSON converter for Vector2 --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 1ad73492..13735e76 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -23,6 +23,7 @@ * For modders: * Added support for loading `.tmx` map files. + * Added JSON converter for `Vector2` values, so they work consistently crossplatform. * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * 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. -- cgit From 0fddc7f5109bffe2912e9fdcf5ed398d80c25dec Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 01:11:46 -0500 Subject: polish release notes --- docs/release-notes.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 13735e76..fca18bd2 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -4,8 +4,8 @@ ## Upcoming release * For players: - * SMAPI now prevents mods from crashing the game with invalid schedule data. - * SMAPI now prevents load crashes due to invalid building types. + * SMAPI now prevents crashes due to mods adding 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. @@ -24,11 +24,13 @@ * For modders: * Added support for loading `.tmx` map files. * Added JSON converter for `Vector2` values, so they work consistently crossplatform. - * Asset propagation for player sprites now affects other players' sprites, and updates recolor maps (e.g. sleeves). * 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 `helper.Data.Read/WriteGlobalData` using the `Saves` folder. The installer will move existing folders to the appdata folder. + * 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 dialogue asset changes not correctly propagated until the next day. + * Fixed dialogue asset propagation for marriage dialogue. * 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: @@ -39,7 +41,7 @@ * Dropped API support for the pre-3.0 update-check format. ## 3.1 -Released 05 January 2019 for Stardew Valley 1.4 or later. +Released 05 January 2019 for Stardew Valley 1.4.1 or later. * For players: * Added separate group in 'skipped mods' list for broken dependencies, so it's easier to see what to fix first. -- cgit From d0885831c3698bcb353d76c147500b7ea1dfbc78 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 11:09:21 -0500 Subject: ignore Harmony DLL in mod build package --- docs/technical/mod-package.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/technical/mod-package.md b/docs/technical/mod-package.md index 5b971f96..a54d3011 100644 --- a/docs/technical/mod-package.md +++ b/docs/technical/mod-package.md @@ -287,7 +287,11 @@ That will create a `Pathoschild.Stardew.ModBuildConfig-.nupkg` file in which can be uploaded to NuGet or referenced directly. ## Release notes -### Upcoming release +### 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). + +### 3.0 * Updated for SMAPI 3.0 and Stardew Valley 1.4. * Added automatic support for `assets` folders. * Added `$(GameExecutableName)` MSBuild variable. @@ -298,6 +302,7 @@ which can be uploaded to NuGet or referenced directly. * Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly. * Fixed `` not working for `i18n` files. * Dropped support for older versions of SMAPI and Visual Studio. +* Migrated package icon to NuGet's new format. ### 2.2 * Added support for SMAPI 2.8+ (still compatible with earlier versions). -- cgit From aeb72586fdd94219cb9ae11cfd9f162765a5bc51 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 1 Feb 2020 11:11:44 -0500 Subject: prepare for release --- docs/release-notes.md | 20 +++++++++++--------- docs/technical/mod-package.md | 2 +- 2 files changed, 12 insertions(+), 10 deletions(-) (limited to 'docs') 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 @@ ← [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. -- cgit