diff options
Diffstat (limited to 'release-notes.md')
| -rw-r--r-- | release-notes.md | 53 |
1 files changed, 46 insertions, 7 deletions
diff --git a/release-notes.md b/release-notes.md index e39ae3a8..6b860f4f 100644 --- a/release-notes.md +++ b/release-notes.md @@ -1,14 +1,53 @@ # Release notes +## 2.0 (upcoming) +<!--See [log](https://github.com/Pathoschild/SMAPI/compare/1.10...2.0).--> -<!-- -## 2.0 -See [log](https://github.com/Pathoschild/SMAPI/compare/1.10...2.0). +For players: +* The SMAPI console is now much simpler and easier-to-read. For mod developers: -* Added `ContentEvents.AssetLoading` event with a helper which lets you intercept the XNB content - load, and dynamically adjust or replace the content being loaded (including support for patching - images). ---> +* Added API to edit XNB images & data loaded by the game (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Content)). +* Added API to inject new XNB images & data (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Content)). +* Added `InputEvents` which unify keyboard, mouse, and controller input for much simpler input handling (see [API reference](http://stardewvalleywiki.com/Modding:SMAPI_APIs#Input_events)). +* Added useful `InputEvents` metadata like the cursor position, grab tile, etc. +* Added ability to prevent the game from handling a button press via `InputEvents`. +* In `manifest.json`: + * Dependencies can now be optional. + * The version can now be a string like `"1.0-alpha"` instead of a structure. +* Removed all deprecated code. + +## 1.15 +See [log](https://github.com/Pathoschild/SMAPI/compare/1.14...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` → `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). |