path: root/docs/release-notes.md

# Release notes
## 2.6 beta
* For players:
  * Updated for Stardew Valley 1.3 (no longer compatible with earlier versions).
  * Added a bundled save backup mod.
  * Added beta update channel.
  * Added prompt when in beta channel and a new version is found.
  * Added friendly error when game can't start audio.
  * Added console warning for mods which don't have update checks configured.
  * Improved how mod warnings are shown in the console.
  * Fixed console color scheme on Mac or in PowerShell, configurable via `StardewModdingAPI.config.json`.
  * Fixed detection of GOG Galaxy install path in rare cases.
  * Fixed install error on Linux/Mac in some cases.
  * Fixed `smapi.io/install` not linking to a useful page.
  * Fixed `world_setseason` command not running season-change logic.
  * Fixed mod update checks failing if a mod only has prerelease versions on GitHub.
  * Fixed launch issue for Linux players with some terminals. (Thanks to HanFox and kurumushi!)
  * Fixed Nexus mod update alerts not showing HTTPS links.
  * Renamed `install.exe` to `install on Windows.exe` to avoid confusion.

* For modders:
  * Added code analysis to mod build config package to flag common issues as warnings.
  * Replaced `LocationEvents` with a more powerful set of events for multiplayer:
    * now raised for all locations;
    * now includes added/removed building interiors;
    * each event now provides a list of added/removed values;
    * added buildings-changed event.
  * Added `Context.IsMultiplayer` and `Context.IsMainPlayer` flags.
  * Added `Constants.TargetPlatform` which says whether the game is running on Linux, Mac, or Windows.
  * Added `semanticVersion.IsPrerelease()` method.
  * Fixed error if a mod loads a PNG while the game is loading (e.g. custom map tilesheets via `IAssetLoader`).
  * Fixed assets loaded by temporary content managers not being editable by mods.
  * Fixed assets not reloaded consistently when the player switches language.
  * Fixed input suppression not working consistently for clicks.
  * Fixed console command input not saved to the log.
  * Fixed `helper.ModRegistry.GetApi` interface validation errors not mentioning which interface caused the issue.
  * Fixed some common non-mod build output being included in release zip.
  * Added option to suppress update checks for a specific mod in `StardewModdingAPI.config.json`.
  * Fixed mods able to intercept other mods' assets via the internal asset keys.
  * Fixed mods able to indirectly change other mods' data through shared content caches.
  * Fixed issue where a mod crashing in `CanEdit` or `CanLoad` could cause an abort-retry loop.
  * **Breaking changes** (see [migration guide](https://stardewvalleywiki.com/Modding:Migrate_to_Stardew_Valley_1.3)):
     * Dropped some deprecated APIs.
     * `LocationEvents` have been rewritten (see above).
     * Mods can't intercept chatbox input, including the game's hotkeys to toggle the chatbox (default `T` and `?`).
     * Mod IDs should only contain letters, numbers, hyphens, dots, and underscores (so they can be safely used in many contexts like URLs); this restriction is now enforced.

* In console commands:
  * Added `player_add name`, which lets you add items to your inventory by name instead of ID.
  * Fixed `world_settime` sometimes breaking NPC schedules (e.g. so they stay in bed).

* For the log parser:
  * Fixed issue parsing content packs with no description.

* For SMAPI developers:
  * Added more consistent crossplatform handling using a new `EnvironmentUtility`, including MacOS detection.
  * Added beta update channel to SMAPI, the web API, and home page.
  * Added more stylish pufferchick on the home page.
  * Split mod DB out of `StardewModdingAPI.config.json` into its own file.
  * Rewrote input suppression using new SDV 1.3 APIs.
  * Rewrote world/player state tracking:
    * much more efficient than previous method;
    * uses net field events where available;
    * lays groundwork for tracking events for multiple players.

## 2.5.5
* For players:
  * Fixed mod not loaded if it has an optional dependency that's loaded but skipped.
  * Fixed mod update alerts not shown if one mod has an invalid remote version.
  * Fixed SMAPI update alerts linking to the GitHub repository instead of [smapi.io](https://smapi.io).
  * Fixed SMAPI update alerts for draft releases.
  * Fixed error when two content packs use different capitalisation for the same required mod ID.
  * Fixed rare crash if the game duplicates an item.

* For the [log parser][]:
  * Tweaked UI.

## 2.5.4
* For players:
  * Fixed some textures not updated when a mod changes them.
  * Fixed visual bug on Linux/Mac when mods overlay textures.
  * Fixed error when mods remove an asset editor/loader.
  * Fixed minimum game version incorrectly increased in SMAPI 2.5.3.

* For the [log parser][]:
  * Fixed error when log text contains certain tokens.

* For modders:
  * Updated to Json.NET 11.0.2.

* For SMAPI developers:
  * Added support for beta update track to support upcoming Stardew Valley 1.3 beta.

## 2.5.3
* For players:
  * Simplified and improved skipped-mod messages.
  * Fixed rare crash with some combinations of manifest fields and internal mod data.
  * Fixed update checks failing for Nexus Mods due to a change in their API.
  * Fixed update checks failing for some older mods with non-standard versions.
  * Fixed failed update checks being cached for an hour (now cached 5 minutes).
  * Fixed error when a content pack needs a mod that couldn't be loaded.
  * Fixed Linux ["magic number is wrong" errors](https://github.com/mono/mono/issues/6752) by changing default terminal order.
  * Updated compatibility list and added update checks for more mods.

* For the [log parser][]:
  * Fixed incorrect filtering in some cases.
  * Fixed error if mods have duplicate names.
  * Fixed parse bugs if a mod has no author name.

* For SMAPI developers:
  * Internal changes to support the upcoming Stardew Valley 1.3 update.

## 2.5.2
* For modders:
  * Fixed issue where replacing an asset through `asset.AsImage()` or `asset.AsDictionary()` didn't take effect.

* For the [log parser][]:
  * Fixed blank page after uploading a log in some cases.

## 2.5.1
* For players:
  * Fixed event error in rare cases.

## 2.5
* For players:
  * **Added support for [content packs](https://stardewvalleywiki.com/Modding:Content_packs)**.  
    <small>_Content packs are collections of files for a SMAPI mod to load. These can be installed directly under `Mods` like a normal SMAPI mod, get automatic update and compatibility checks, and provide convenient APIs to the mods that read them._</small>
  * Added mod detection for unhandled errors (so most errors now mention which mod caused them).
  * Added install scripts for Linux/Mac (no more manual terminal commands!).
  * Added the missing mod's name and URL to dependency errors.
  * Fixed uninstall script not reporting when done on Linux/Mac.
  * Updated compatibility list and enabled update checks for more mods.

* For modders:
  * Added support for content packs and new APIs to read them.
  * Added support for `ISemanticVersion` in JSON models.
  * Added `SpecialisedEvents.UnvalidatedUpdateTick` event for specialised use cases.
  * Added path normalising to `ReadJsonFile` and `WriteJsonFile` helpers (so no longer need `Path.Combine` with those).
  * Fixed deadlock in rare cases with asset loaders.
  * Fixed unhelpful error when a mod exposes a non-public API.
  * Fixed unhelpful error when a translation file has duplicate keys due to case-insensitivity.
  * Fixed some JSON field names being case-sensitive.

* For the [log parser][]:
  * Added support for SMAPI 2.5 content packs.
  * Reduced download size when viewing a parsed log with repeated errors.
  * Improved parse error handling.
  * Fixed 'log started' field showing incorrect date.

* For SMAPI developers:
  * Overhauled mod DB format to be more concise, reduce the memory footprint, and support versioning/defaulting more fields.
  * Reimplemented log parser with serverside parsing and vue.js on the frontend.

## 2.4
* For players:
  * Fixed visual map glitch in rare cases.
  * Fixed error parsing JSON files which have curly quotes.
  * Fixed error parsing some JSON files generated on another system.
  * Fixed error parsing some JSON files after mods reload core assemblies, which is no longer allowed.
  * Fixed intermittent errors (e.g. 'collection has been modified') with some mods when loading a save.
  * Fixed compatibility with Linux Terminator terminal.

* For the [log parser][]:
  * Fixed error parsing logs with zero installed mods.

* For modders:
  * Added `SaveEvents.BeforeCreate` and `AfterCreate` events.
  * Added `SButton` `IsActionButton()` and `IsUseToolButton()` extensions.
  * Improved JSON parse errors to provide more useful info for troubleshooting.
  * Fixed events being raised while the game is loading a save file.
  * Fixed input events not recognising controller input as an action or use-tool button.
  * Fixed input events setting the same `IsActionButton` and `IsUseToolButton` values for all buttons pressed in an update tick.
  * Fixed semantic versions ignoring `-0` as a prerelease tag.
  * Updated Json.NET to 11.0.1-beta3 (needed to avoid a parser edge case).

* For SMAPI developers:
  * Overhauled input handling to support future input events.

## 2.3
* For players:
  * Added a user-friendly [download page](https://smapi.io).
  * Improved cryptic libgdiplus errors on Mac when Mono isn't installed.
  * Fixed mod UIs hidden when menu backgrounds are enabled.

* For modders:
  * **Added mod-provided APIs** to allow simple integrations between mods, even without direct assembly references.
  * Added `GameEvents.FirstUpdateTick` event (called once after all mods are initialised).
  * Added `IsSuppressed` to input events so mods can optionally avoid handling keys another mod has already handled.
  * Added trace message for mods with no update keys.
  * Adjusted reflection API to match actual usage (e.g. renamed `GetPrivate*` to `Get*`), and deprecated previous methods.
  * Fixed `GraphicsEvents.OnPostRenderEvent` not being raised in some specialised cases.
  * Fixed reflection API error for properties missing a `get` and `set`.
  * Fixed issue where a mod could change the cursor position reported to other mods.
  * Updated compatibility list.

* For the [log parser][]:
  * Fixed broken favicon.

## 2.2
* For players:
  * Fixed error when a mod loads custom assets on Linux/Mac.
  * Fixed error when checking for updates on Linux/Mac due to API HTTPS redirect.
  * Fixed error when Mac adds an `mcs` symlink to the installer package.
  * Fixed `player_add` command not handling tool upgrade levels.
  * Improved error when a mod has an invalid `EntryDLL` filename format.
  * Updated compatibility list.

* For the [log parser][]:
  * Logs no longer expire after a week.
  * Fixed error when uploading very large logs.
  * Slightly improved the UI.

* For modders:
  * Added `helper.Content.NormaliseAssetName` method.
  * Added `SDate.DaysSinceStart` property.
  * Fixed input events' `e.SuppressButton(button)` method ignoring specified button.
  * Fixed input events' `e.SuppressButton()` method not working with mouse buttons.

## 2.1
* For players:
  * Added a [log parser][] site.
  * Added better Steam instructions to the SMAPI installer.
  * Renamed the bundled _TrainerMod_ to _ConsoleCommands_ to make its purpose clearer.
  * Removed the game's test messages from the console log.
  * Improved update-check errors when playing offline.
  * Fixed compatibility check for players with Stardew Valley 1.08.
  * Fixed `player_setlevel` command not setting XP too.

* For modders:
  * The reflection API now works with public code to simplify mod integrations.
  * The content API now lets you invalidated multiple assets at once.
  * The `InputEvents` have been improved:
    * Added `e.IsActionButton` and `e.IsUseToolButton`.
    * Added `ToSButton()` extension for the game's `Game1.options` button type.
    * Deprecated `e.IsClick`, which is limited and unclear. Use `IsActionButton` or `IsUseToolButton` instead.
    * Fixed `e.SuppressButton()` not correctly suppressing keyboard buttons.
    * Fixed `e.IsClick` (now `e.IsActionButton`) ignoring custom key bindings.
  * `SemanticVersion` can now be constructed from a `System.Version`.
  * Fixed reflection API blocking access to some non-SMAPI members.
  * Fixed content API allowing absolute paths as asset keys.
  * Fixed content API failing to load custom map tilesheets that aren't preloaded.
  * Fixed content API incorrectly detecting duplicate loaders when a mod implements `IAssetLoader` directly.

* For SMAPI developers:
  * Added the installer version and platform to the installer window title to simplify troubleshooting.

## 2.0
### Release highlights
* **Mod update checks**  
  SMAPI now checks if your mods have updates available, and will alert you in the console with a convenient link to the
  mod page. This works with mods from the Chucklefish mod site, GitHub, or Nexus Mods. SMAPI 2.0 launches with
  update-check support for over 250 existing mods, and more will be added as modders enable the feature.

* **Mod stability warnings**  
  SMAPI now detects when a mod contains code which can destabilise your game or corrupt your save, and shows a warning
  in the console.

* **Simpler console**  
   The console is now simpler and easier to read, some commands have been streamlined, and the colors now adjust to fit
   your terminal background color.

* **New features for modders**  
  SMAPI 2.0 adds several features to enable new kinds of mods (see
  [API documentation](https://stardewvalleywiki.com/Modding:SMAPI_APIs)).

  The **content API** lets you edit, inject, and reload XNB data loaded by the game at any time. This lets SMAPI mods do
  anything previously only possible with XNB mods, and enables new mod scenarios not possible with XNB mods (e.g.
  seasonal textures, NPC clothing that depend on the weather or location, etc).

  The **input events** unify controller + keyboard + mouse input into one event and constant for easy handling, and add
  metadata like the cursor position and grab tile to support click handling. They also let you prevent the game from
  receiving input, to enable new scenarios like action highjacking and UI overlays.

  The mod manifest has a few changes too:
  * The **`UpdateKeys` field** lets you specify your Chucklefish, GitHub, or Nexus mod IDs. SMAPI will automatically
    check for newer versions and notify the player.
  * The **version field** is now a semantic string like `"1.0-alpha"`. (Mods which still use the version structure will
    still work fine.)
  * The **dependencies field** now lets you add optional dependencies which should be loaded first if available.

  Finally, the `SDate` utility now has a `DayOfWeek` field for more convenient date calculations, and `ISemanticVersion`
  now implements `IEquatable<ISemanticVersion>`.

* **Goodbye deprecated code**  
  SMAPI 2.0 removes all deprecated code to unshackle future development. That includes...