diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release-notes.md | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index da651be2..3dee3705 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,28 +1,27 @@ # Release notes ## 2.5 * For players: - * **Added support for content packs**. + * **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 to unhandled errors (i.e. most errors will now mention which mod caused them). + * 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 required mod's name and URL to dependency errors. - * Fixed unhandled mod errors being logged under `[SMAPI]` instead of the mod name. - * Fixed uninstall script not confirming success on Linux/Mac. + * 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 content pack APIs. + * 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: `helper.ReadJsonFile` and `helper.WriteJsonFile` now normalise path separators automatically. - * Fixed deadlock in rare cases when injecting a file with an asset loader. + * 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][]: - * Significantly reduced download size when viewing files with repeated errors. * 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. |