diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/mod-build-config.md | 23 | ||||
| -rw-r--r-- | docs/release-notes.md | 29 |
2 files changed, 50 insertions, 2 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md index ca750c86..0d72e4d9 100644 --- a/docs/mod-build-config.md +++ b/docs/mod-build-config.md @@ -120,6 +120,19 @@ or you have multiple installs, you can specify the path yourself. There's two wa The configuration will check your custom path first, then fall back to the default paths (so it'll still compile on a different computer). +### Unit test projects +**(upcoming in 2.0.3)** + +You can use the package in unit test projects too. Its optional unit test mode... + +1. disables deploying the project as a mod; +2. disables creating a release zip; +2. and copies the referenced DLLs into the build output for unit test frameworks. + +To enable it, add this above the first `</PropertyGroup>` in your `.csproj`: +```xml +<ModUnitTests>True</ModUnitTests> +``` ## Troubleshoot ### "Failed to find the game install path" @@ -127,6 +140,16 @@ That error means the package couldn't find your game. You can specify the game p _[Game path](#game-path)_ above. ## Release notes +### 2.0.3 alpha +* Added support for Stardew Valley 1.3. +* Added support for unit test projects. + +### 2.0.2 +* Fixed compatibility issue on Linux. + +### 2.0.1 +* Fixed mod deploy failing to create subfolders if they don't already exist. + ### 2.0 * Added: mods are now copied into the `Mods` folder automatically (configurable). * Added: release zips are now created automatically in your build output folder (configurable). diff --git a/docs/release-notes.md b/docs/release-notes.md index fdc06c87..b3300800 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,18 +1,43 @@ # Release notes +<!-- ## 2.6 alpha * For players: - * Updated for Stardew Valley 1.3 (multiplayer update); no longer compatible with earlier versions. + * Added support for Stardew Valley 1.3+; no longer compatible with earlier versions. + * Fixed SMAPI update alerts linking to the GitHub repository instead of [smapi.io](https://smapi.io). + * Fixed SMAPI update checks not showing newer beta versions when using a beta version. * For modders: - * Dropped support for some deprecated APIs. + * Dropped some deprecated APIs. * Fixed some assets not being editable. +* For SMAPI developers: + * Added prerelease versions to the mod update-check API response where available (GitHub only). + * Added support for beta releases on the home page. +--> + +## 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. |