path: root/docs/release-notes.md

# Release notes
## Upcoming release
* For players:
  * Added `world_clear` console command to remove spawned or placed entities.
  * Minor performance improvement.
  * Tweaked installer to reduce antivirus false positives.

* For modders:
  * Added `GameLoop.OneSecondUpdateTicking/Ticked` events.
  * Added `Specialised.LoadStageChanged` for mods which need to do something at a specific point in the game's save loading process.
  * You can now use read/write save data as soon as the save is loaded (instead of once the world is initialised).

## 2.9.3
* For players:
  * Fixed errors hovering items in some cases with SMAPI 2.9.2.
  * Fixed some multiplayer features broken when a farmhand returns to title and rejoins.

## 2.9.2
* For players:
  * SMAPI now prevents invalid items from crashing the game on hover.
  * Fixed some multiplayer features broken when connecting via Steam friends.
  * Fixed cryptic error message when the game isn't installed correctly.
  * Fixed error when a mod makes invalid changes to an NPC schedule.
  * Fixed game launch errors logged as `SMAPI` instead of `game`.
  * Fixed Windows installer adding unneeded Unix launcher to game folder.

* For modders:
  * Moved content pack methods into a new [content pack API](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Content_Packs).
  * Fixed invalid NPC data propagated when a mod changes NPC dispositions.
  * Fixed `Display.RenderedWorld` event broken in SMAPI 2.9.1.
  * **Deprecations:**
    * The `assetData.AsDictionary<TKey, TValue>().Set` methods are now deprecated. Mods should access the `Data` property directly instead.
    * The content pack methods directly on `helper` are now deprecated. Mods should use `helper.ContentPacks` instead.

* For SMAPI developers:
  * Added SMAPI 3.0 readiness to mod API data.

## 2.9.1
* For players:
  * Fixed crash in SMAPI 2.9 when constructing certain buildings.
  * Fixed error when a map asset is reloaded in rare cases.

## 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 with SMAPI 2.8.

## 2.8.1
* Fixed installer error on Windows with SMAPI 2.8.

## 2.8
* For players:
  * Reorganised SMAPI files:
    * Moved most SMAPI files into a `smapi-internal` subfolder (so your game folder is less messy).
    * Moved save backups into a `save-backups` subfolder (so they're easier to find).
    * Simplified the installer files to avoid confusion.
  * Added support for organising mods into subfolders.
  * Added support for [ignoring mod folders](https://stardewvalleywiki.com/Modding:Player_Guide/Getting_Started#Install_mods).
  * Update checks now work even for mods without update keys in most cases.
  * SMAPI now prevents a crash caused by mods adding dialogue the game can't parse.
  * SMAPI now recommends a compatible SMAPI version if you have an older game version.
  * Improved various error messages to be more clear and intuitive.
  * Improved compatibility with various Linux shells (thanks to lqdev!), and prefer xterm when available.
  * Fixed transparency issues on Linux/Mac for some mod images.
  * Fixed error when a mod manifest is corrupted.
  * Fixed error when a mod adds an unnamed location.
  * Fixed friendly error no longer shown when SMAPI isn't run from the game folder.
  * Fixed some Windows install paths not detected.
  * Fixed installer duplicating bundled mods if you moved them after the last install.
  * Fixed installer allowing custom mods to be bundled with the install.
  * Fixed some translation issues not shown as warnings.
  * Fixed dependencies not correctly enforced if the dependency is installed but failed to load.
  * Fixed some errors logged as SMAPI instead of the affected mod.
  * Fixed crash log deleted immediately when you relaunch the game.
  * Updated compatibility list.

* For the web UI:
  * Added a [mod compatibility page](https://mods.smapi.io) and [privacy page](https://smapi.io/privacy).
  * The log parser now has a separate filter for game messages.
  * The log parser now shows content pack authors (thanks to danvolchek!).
  * Tweaked log parser UI (thanks to danvolchek!).
  * Fixed log parser instructions for Mac.

* For modders:
  * Added [data API](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Data) to store mod data in the save file or app data.
  * Added [multiplayer API](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Multiplayer) and [events](https://stardewvalleywiki.com/Modding:Modder_Guide/Apis/Events#Multiplayer_2) to send/receive messages and get connected player info.
  * Added [verbose logging](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Logging#Verbose_logging) feature.
  * Added `IContentPack.WriteJsonFile` method.
  * Added IntelliSense documentation for the non-developers version of SMAPI.
  * Added more events to the prototype `helper.Events` for SMAPI 3.0.
  * Added `SkillType` enum constant.
  * Improved content API:
    * added support for overlaying image assets with semi-transparency;
    * mods can now load PNGs even if the game is currently drawing.
  * When comparing mod versions, SMAPI now assigns the lowest precedence to `-unofficial` (e.g. `1.0-beta > 1.0-unofficial`).
  * Fixed content packs' `ReadJsonFile` allowing non-relative paths.
  * Fixed content packs always failing to load if they declare a dependency on a SMAPI mod.
  * Fixed trace logs not showing path for invalid mods.
  * Fixed 'no update keys' warning not shown for mods with only invalid update keys.
  * Fixed `Context.IsPlayerFree` being true while the player is mid-warp in multiplayer.
  * Fixed update-check errors sometimes being overwritten with a generic message.
  * Suppressed the game's 'added crickets' debug output.
  * Updated dependencies (Harmony 1.0.9.1 → 1.2.0.1, Mono.Cecil 0.10 → 0.10.1).
  * **Deprecations:**
    * Non-string manifest versions are now deprecated and will stop working in SMAPI 3.0. Affected mods should use a string version, like `"Version": "1.0.0"`.
    * `ISemanticVersion.Build` is now deprecated and will be removed in SMAPI 3.0. Affected mods should use `ISemanticVersion.PrereleaseTag` instead.
  * **Breaking changes:**
    * `helper.ModRegistry` now returns `IModInfo` instead of `IManifest` directly. This lets SMAPI return more metadata about mods. This doesn't affect any mods that didn't already break in Stardew Valley 1.3.32.
    * Most SMAPI files have been moved into a `smapi-internal` subfolder. This won't affect compiled mod releases, but you'll need to update the build config NuGet package.

* For SMAPI developers:
  * Added support for parallel stable/beta unofficial updates in update checks.
  * Added a 'paranoid warnings' option which reports mods using potentially sensitive .NET APIs (like file or shell access) in the mod issues list.
  * Adjusted `SaveBackup` mod to make it easier to account for custom mod subfolders in the installer.
  * Installer no longer special-cases Omegasis' older `SaveBackup` mod (now named `AdvancedSaveBackup`).
  * Fixed mod web API returning a concatenated name for mods with alternate names.

## 2.7
* For players:
  * Updated for Stardew Valley 1.3.28.
  * Improved how mod issues are listed in the console and log.
  * Revamped installer. It now...
    * uses a new format that should be more intuitive;
    * lets players on Linux/Mac choose the console color scheme (SMAPI will auto-detect it on Windows);
    * and validates requirements earlier.
  * Fixed custom festival maps always using spring tilesheets.
  * Fixed `player_add` command not recognising return scepter.
  * Fixed `player_add` command showing fish twice.
  * Fixed some SMAPI logs not deleted when starting a new session.
  * Updated compatibility list.

* For modders:
  * Added support for `.json` data files in the content API (including Content Patcher).
  * Added propagation for asset changes through the content API for...
    * child sprites;
    * dialogue;
    * map tilesheets.
  * Added `--mods-path` CLI command-line argument to switch between mod folders.
  * All enums are now JSON-serialised by name instead of numeric value. (Previously only a few enums were serialised that way. JSON files which already have numeric enum values will still be parsed fine.)
  * Fixed false compatibility error when constructing multidimensional arrays.
  * Fixed `.ToSButton()` methods not being public.

* For SMAPI developers:
  * Dropped support for pre-SMAPI-2.6 update checks in the web API.  
    _These are no longer useful, even if the player still has earlier versions of SMAPI. Older versions of SMAPI won't launch in Stardew Valley 1.3 (so they won't check for updates), and newer versions of SMAPI/mods won't work with older versions of the game._

## 2.6
* For players:
  * Updated for Stardew Valley 1.3.
  * Added automatic save backups.
  * Improved update checks:
    * added beta update channel;
    * added update alerts for incompatible mods with an unofficial update on the wiki;
    * added update alerts for optional files on Nexus;
    * added console warning for mods which don't have update checks configured;
    * added more visible prompt in beta channel for SMAPI updates;
    * fixed mod update checks failing if a mod only has prerelease versions on GitHub;
    * fixed Nexus mod update alerts not showing HTTPS links.
  * Improved mod warnings in the console.
  * Improved error when game can't start audio.
  * Improved the Console Commands mod:
    * Added `player_add name`, which adds items to your inventory by name instead of ID.
    * Fixed `world_setseason` not running season-change logic.
    * Fixed `world_setseason` not normalising the season value.
    * Fixed `world_settime` sometimes breaking NPC schedules (e.g. so they stay in bed).
    * Removed the `player_setlevel` and `player_setspeed` commands, which weren't implemented in a useful way. Use a mod like CJB Cheats Menu if you need those.
  * Fixed `SEHException` errors for some players.
  * Fixed performance issues for some players.