path: root/docs/release-notes.md

# Release notes
## 2.5.3
* For players:
  * Fixed some incompatible-mod errors not showing the mod URL.
  * Updated compatibility list.

* For the [log parser][]:
  * Fixed mod list not including all mods if at least one has no author name.
  * Fixed some log entries being incorrectly filtered.

## 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...
  * removed all code marked obsolete;
  * removed TrainerMod's `save` and `load` commands;
  * removed support for mods with no `Name`, `Version`, or `UniqueID` in their manifest;
  * removed support for multiple mods having the same `UniqueID` value;
  * removed access to SMAPI internals through the reflection helper.

* **Command-line install**
  For power users and mod managers, the SMAPI installer can now be scripted using command-line arguments
  (see [technical docs](technical-docs.md#command-line-arguments)).

### Change log
For players:
* SMAPI now alerts you when mods have new versions available.
* SMAPI now warns you about mods which may impact game stability or compatibility.
* The console is now simpler and easier to read, and adjusts its colors to fit your terminal background color.
* Renamed installer folder to avoid confusion.
* Updated compatibility list.
* Fixed update check errors on Linux/Mac.
* Fixed collection-changed errors during startup for some players.

For mod developers:
* Added support for editing, injecting, and reloading XNB data loaded by the game at any time.
* Added support for automatic mod update checks.
* Added unified input events.
* Added support for suppressing input.
* Added support for optional dependencies.
* Added support for specifying the mod version as a string (like `"1.0-alpha"`) in `manifest.json`.
* Added day of week to `SDate` instances.
* Added `IEquatable<ISemanticVersion>` to `ISemanticVersion`.
* Updated Json.NET from 8.0.3 to 10.0.3.
* Removed the TrainerMod's `save` and `load` commands.
* Removed all deprecated code.
* Removed support for mods with no `Name`, `Version`, or `UniqueID` in their manifest.
* Removed support for mods with a non-unique `UniqueID` value in their manifest.
* Removed access to SMAPI internals through the reflection helper, to discourage fragile mods.
* Fixed `SDate.Now()` crashing when called during the new-game intro.
* Fixed `TimeEvents.AfterDayStarted` being raised during the new-game intro.
* Fixed SMAPI allowing map tilesheets with absolute or directory-climbing paths. These are now rejected even if the path exists, to avoid problems when players install the mod.

For power users:
* Added command-line arguments to the SMAPI installer so it can be scripted.

For SMAPI developers:
* Significantly refactored SMAPI to support changes in 2.0 and upcoming releases.
* Overhauled `StardewModdingAPI.config.json` format to support mod data like update keys.
* Removed SMAPI 1._x_ compatibility mode.

## 1.15.4
For players:
* Fixed errors when loading some custom maps on Linux/Mac or using XNB Loader.
* Fixed errors in rare cases when a mod calculates an in-game date.

For modders:
* Added UTC timestamp to log file.

For SMAPI developers:
* Internal changes to support the upcoming SMAPI 2.0 release.

## 1.15.3
For players:
* Fixed mods being wrongly marked as duplicate in some cases.

## 1.15.2
For players:
* Improved errors when a mod DLL can't be loaded.
* Improved errors when using very old versions of Stardew Valley.
* Updated compatibility list.

For mod developers:
* Added `Context.CanPlayerMove` property for mod convenience.
* Added content helper properties for the game's current language.
* Fixed `Context.IsPlayerFree` being false if the player is performing an action.
* Fixed `GraphicsEvents.Resize` being raised before the game updates its window data.
* Fixed `SemanticVersion` not being deserialisable through Json.NET.
* Fixed terminal not launching on Xfce Linux.

For SMAPI developers:
* Internal changes to support the upcoming SMAPI 2.0 release.

## 1.15.1
For players:
* Fixed controller mod input broken in 1.15.
* Fixed TrainerMod packaging unneeded files.

For modders:
* Fixed mod registry lookups by unique ID not being case-insensitive.

## 1.15
For players:
* Cleaned up SMAPI console a bit.
* Revamped TrainerMod's item commands:
  * `player_add` is a new command to add any item to your inventory (including tools, weapons, equipment, craftables, wallpaper, etc). This replaces the former `player_additem`, `player_addring`, and `player_addweapon`.
  * `list_items` now shows all items in the game. You can search by item type like `list_items weapon`, or search by item name like `list_items galaxy sword`.
  * `list_items` now also matches translated item names when playing in another language.
  * `list_item_types` is a new command to see a list of item types.
* Fixed unhelpful error when a `config.json` is invalid.
* Fixed rare crash when window loses focus for a few players (further to fix in 1.14).
* Fixed invalid `ObjectInformation.xnb` causing a flood of warnings; SMAPI now shows one error instead.
* Updated mod compatibility list.

For modders:
* Added `SDate` utility for in-game date calculations (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Dates)).
* Added support for minimum dependency versions in `manifest.json` (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Manifest)).
* Added more useful logging when loading mods.
* Added a `ModID` property to all mod helpers for extension methods.
* Changed `manifest.MinimumApiVersion` from string to `ISemanticVersion`. This shouldn't affect mods unless they referenced that field in code.
* Fixed `SemanticVersion` parsing some invalid versions into close approximations (like `1.apple` &rarr; `1.0-apple`).
* Fixed `SemanticVersion` not treating hyphens as separators when comparing prerelease tags.  
  <small>_(While that was technically correct, it leads to unintuitive behaviour like sorting `-alpha-2` _after_ `-alpha-10`, even though `-alpha.2` sorts before `-alpha.10`.)_</small>
* Fixed corrupted state exceptions not being logged by SMAPI.
* Increased all deprecations to _pending removal_.

For SMAPI developers:
* Added SMAPI 2.0 compile mode, for testing how mods will work with SMAPI 2.0.
* Added prototype SMAPI 2.0 feature to override XNB files (not enabled for mods yet).
* Added prototype SMAPI 2.0 support for version strings in `manifest.json` (not recommended for mods yet).
* Compiling SMAPI now uses your `~/stardewvalley.targets` file if present.

## 1.14
See [log](https://github.com/Pathoschild/SMAPI/compare/1.13...1.14).

For players:
* SMAPI now shows friendly errors when...
  * it can't detect the game;
  * a mod dependency is missing (if it's listed in the mod manifest);
  * you have Stardew Valley 1.11 or earlier (which aren't compatible);
  * you run `install.exe` from within the downloaded zip file.
* Fixed "unknown mod" deprecation warnings by improving how SMAPI detects the mod using the event.
* Fixed `libgdiplus.dylib` errors for some players on Mac.
* Fixed rare crash when window loses focus for a few players.
* Bumped minimum game version to 1.2.30.
* Updated mod compatibility list.

For modders:
* You can now add dependencies to `manifest.json` (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Manifest)).
* You can now translate your mod (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Translation)).
* You can now load unpacked `.tbin` files from your mod folder through the content API.  
* SMAPI now automatically fixes tilesheet references for maps loaded from the mod folder.  
  <small>_When loading a map from the mod folder, SMAPI will automatically use tilesheets relative to the map file if they exists. Otherwise it will default to tilesheets in the game content._</small>
* Added `Context.IsPlayerFree` for mods that need to check if the player can act (i.e. save is loaded, no menu is displayed, no cutscene is in progress, etc).
* Added `Context.IsInDrawLoop` for specialised mods.
* Fixed `smapi-crash.txt` being copied from the default log even if a different path is specified with `--log-path`.
* Fixed the content API not matching XNB filenames with two dots (like `a.b.xnb`) if you don't specify the `.xnb` extension.
* Fixed `debug` command output not printed to console.
* Deprecated `TimeEvents.DayOfMonthChanged`, `SeasonOfYearChanged`, and `YearOfGameChanged`. These don't do what most modders think they do and aren't very reliable, since they depend on the SMAPI/game lifecycle which can change. You should use `TimeEvents.AfterDayStarted` or `SaveEvents.BeforeSave` instead.

## 1.13.1
For players:
* Fixed errors when loading a mod with no name or version.
* Fixed mods with no manifest `Name` field having no name (SMAPI will now shows their filename).

## 1.13
See [log](https://github.com/Pathoschild/SMAPI/compare/1.12...1.13).

For players:
* SMAPI now recovers better from mod draw errors and detects when the error is