path: root/docs/release-notes.md

← [README](README.md)

# Release notes
## 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.
  * 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 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:
  * 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.
  * 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.

## 3.1
Released 05 January 2019 for Stardew Valley 1.4 or later.

* For players:
  * Added separate group in 'skipped mods' list for broken dependencies, so it's easier to see what to fix first.
  * Added friendly log message for save file-not-found errors.
  * Updated for gamepad modes in Stardew Valley 1.4.1.
  * Improved performance in some cases.
  * 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.
  * 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.
  * File uploads now expire after one month.
  * Updated the JSON validator for Content Patcher 1.10 and 1.11.
  * Fixed JSON validator no longer letting you change format when viewing a file.
  * Fixed JSON validator for Content Patcher not requiring `Default` if `AllowBlank` was omitted.
  * Fixed log parser not correctly handling content packs with no author (thanks to danvolchek!).
  * Fixed main sidebar link pointing to wiki instead of home page.

* For modders:
  * Added `World.ChestInventoryChanged` event (thanks to collaboration with wartech0!).
  * Added asset propagation for...
    * grass textures;
    * winter flooring textures;
    * `Data\Bundles` changes (for added bundles only);
    * `Characters\Farmer\farmer_girl_base_bald`.
  * Added paranoid-mode warning for direct `Console` access.
  * Improved error messages for `TargetParameterCountException` when using the reflection API.
  * `helper.Read/WriteSaveData` can now be used while a save is being loaded (e.g. within a `Specialized.LoadStageChanged` event).
  * Removed `DumpMetadata` option. It was only for specific debugging cases, but players would sometimes enable it incorrectly and then report crashes.
  * Fixed private textures loaded from content packs not having their `Name` field set.

* For SMAPI developers:
  * You can now run local environments without configuring Amazon, Azure, MongoDB, and Pastebin accounts.

## 3.0.1
Released 02 December 2019 for Stardew Valley 1.4 or later.

* For players:
  * Updated for Stardew Valley 1.4.0.1.
  * Improved compatibility with some Linux terminals (thanks to archification and DanielHeath!).
  * Updated translations. Thanks to be