summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-02-08 18:20:03 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-02-08 18:20:03 -0500
commit84b9f4336d5b0c7f269a7bfbb94042360574bbaa (patch)
tree0a4d138f88522ca101bff739c8ade1f62c74fbfe /docs
parent79c616600576acf16f70daad68cc60a22cbbbf74 (diff)
parent41f77f51c0203fa36c1e47cf67409244ed3c2ff2 (diff)
downloadSMAPI-84b9f4336d5b0c7f269a7bfbb94042360574bbaa.tar.gz
SMAPI-84b9f4336d5b0c7f269a7bfbb94042360574bbaa.tar.bz2
SMAPI-84b9f4336d5b0c7f269a7bfbb94042360574bbaa.zip
Merge branch 'develop' into stable
Diffstat (limited to 'docs')
-rw-r--r--docs/mod-build-config.md14
-rw-r--r--docs/release-notes.md33
-rw-r--r--docs/technical-docs.md4
3 files changed, 43 insertions, 8 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index 0c1cc10a..a97c3171 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -132,8 +132,6 @@ If you don't want to include a file in the mod folder or release zip:
relative path in your mod folder, that file won't be included.
### Non-mod projects
-**(upcoming in 2.1)**
-
You can use the package in non-mod projects too (e.g. unit tests or framework DLLs). You'll need to
disable deploying the mod and creating a release zip:
@@ -218,10 +216,18 @@ That error means the package couldn't find your game. You can specify the game p
_[Game path](#game-path)_ above.
## Release notes
-### 2.1 alpha
+### 2.2
+* Added support for SMAPI 2.8+ (still compatible with earlier versions).
+* Added default game paths for 32-bit Windows.
+* Fixed valid manifests marked invalid in some cases.
+
+### 2.1
* Added support for Stardew Valley 1.3.
-* Added support for unit test projects.
+* Added support for non-mod projects.
* Added C# analyzers to warn about implicit conversions of Netcode fields in Stardew Valley 1.3.
+* Added option to ignore files by regex pattern.
+* Added reference to new SMAPI DLL.
+* Fixed some game paths not detected by NuGet package.
### 2.0.2
* Fixed compatibility issue on Linux.
diff --git a/docs/release-notes.md b/docs/release-notes.md
index e08e7af4..4527b12d 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,12 +1,41 @@
# Release notes
+## 2.10.2
+Released 08 January 2019 for Stardew Valley 1.3.32–33.
+
+* For players:
+ * SMAPI now keeps the first save backup created for the day, instead of the last one.
+ * Fixed save backup for some Linux/Mac players. (When compression isn't available, SMAPI will now create uncompressed backups instead.)
+ * Fixed some common dependencies not linking to the mod page in 'missing mod' errors.
+ * Fixed 'unknown mod' deprecation warnings showing a stack trace when developers mode not enabled.
+ * Fixed 'unknown mod' deprecation warnings when they occur in the Mod constructor.
+ * Fixed confusing error message when using SMAPI 2.10._x_ with Stardew Valley 1.3.35+.
+ * Tweaked XNB mod message for clarity.
+ * Updated compatibility list.
+
+* For the web UI:
+ * Added beta status filter to compatibility list.
+ * Fixed broken ModDrop links in the compatibility list.
+
+* For modders:
+ * Asset changes are now propagated into the parsed save being loaded if applicable.
+ * Added locale to context trace logs.
+ * Fixed error loading custom map tilesheets in some cases.
+ * Fixed error when swapping maps mid-session for a location with interior doors.
+ * Fixed `Constants.SaveFolderName` and `CurrentSavePath` not available during early load stages when using `Specialised.LoadStageChanged` event.
+ * Fixed `LoadStage.SaveParsed` raised before the parsed save data is available.
+ * Fixed 'unknown mod' deprecation warnings showing the wrong stack trace.
+ * Fixed `e.Cursor` in input events showing wrong grab tile when player using a controller moves without moving the viewpoint.
+ * Fixed incorrect 'bypassed safety checks' warning for mods using the new `Specialised.LoadStageChanged` event in 2.10.
+ * Deprecated `EntryDll` values whose capitalisation don't match the actual file. (This works on Windows, but causes errors for Linux/Mac players.)
+
## 2.10.1
-Released 30 December 2018 for Stardew Valley 1.3.32.
+Released 30 December 2018 for Stardew Valley 1.3.32–33.
* For players:
* Fixed some mod integrations not working correctly in SMAPI 2.10.
## 2.10
-Released 29 December 2018 for Stardew Valley 1.3.32.
+Released 29 December 2018 for Stardew Valley 1.3.32–33.
* For players:
* Added `world_clear` console command to remove spawned or placed entities.
diff --git a/docs/technical-docs.md b/docs/technical-docs.md
index 1d69f868..98dd3540 100644
--- a/docs/technical-docs.md
+++ b/docs/technical-docs.md
@@ -70,8 +70,8 @@ on the wiki for the first-time setup.
## Customisation
### Configuration file
-You can customise the SMAPI behaviour by editing the `StardewModdingAPI.config.json` file in your
-game folder.
+You can customise the SMAPI behaviour by editing the `smapi-internal/StardewModdingAPI.config.json`
+file in your game folder.
Basic fields: