summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-02-01 16:21:35 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-02-01 16:21:35 -0500
commitc8d627cdf2ae3126584ec2500877ff19987db17f (patch)
tree2cc6f604df00027239476acf3a74ae6bb0761323 /docs
parentf976b5c0f095a881fc20f6ce5dcf5a50ebb2b5da (diff)
parent17a9193fd28c527dcba40360702adb277736cc45 (diff)
downloadSMAPI-c8d627cdf2ae3126584ec2500877ff19987db17f.tar.gz
SMAPI-c8d627cdf2ae3126584ec2500877ff19987db17f.tar.bz2
SMAPI-c8d627cdf2ae3126584ec2500877ff19987db17f.zip
Merge branch 'develop' into stable
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md2
-rw-r--r--docs/release-notes.md54
-rw-r--r--docs/technical/mod-package.md7
-rw-r--r--docs/technical/smapi.md13
4 files changed, 57 insertions, 19 deletions
diff --git a/docs/README.md b/docs/README.md
index 3a570f48..50478b52 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -64,7 +64,7 @@ locale | status
---------- | :----------------
default | ✓ [fully translated](../src/SMAPI/i18n/default.json)
Chinese | ✓ [fully translated](../src/SMAPI/i18n/zh.json)
-French | ❑ not translated
+French | ✓ [fully translated](../src/SMAPI/i18n/fr.json)
German | ✓ [fully translated](../src/SMAPI/i18n/de.json)
Hungarian | ❑ not translated
Italian | ❑ not translated
diff --git a/docs/release-notes.md b/docs/release-notes.md
index ed6f9013..f1981218 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,8 +1,49 @@
&larr; [README](README.md)
# Release notes
+## 3.2
+Released 01 February 2020 for Stardew Valley 1.4.1 or later.
+
+* For players:
+ * SMAPI now prevents crashes due to invalid schedule data.
+ * SMAPI now prevents crashes due to invalid building types.
+ * Added support for persistent `smapi-internal/config.json` overrides (see info in the file).
+ * Updated minimum game version (1.4 → 1.4.1).
+ * Fixed 'collection was modified' error when returning to title in rare cases.
+ * Fixed error when update-checking a mod with a Chucklefish page that has no version.
+ * Fixed rare error when building/demolishing buildings.
+ * Fixed SMAPI beta versions not showing update alert on next launch (thanks to danvolchek!).
+
+* For the Console Commands mod:
+ * Added `performance` command to track mod performance metrics. This is an advanced experimental feature. (Thanks to Drachenkätzchen!)
+ * Added `test_input` command to view button codes in the console.
+
+* For the Save Backup mod:
+ * Fixed extra files under `Saves` (e.g. manual backups) not being ignored.
+ * Fixed Android issue where game files were backed up.
+
+* For modders:
+ * Added support for `.tmx` map files.
+ * Added special handling for `Vector2` values in `.json` files, so they work consistently crossplatform.
+ * Reworked the order that asset editors/loaders are called between multiple mods to support some framework mods like Content Patcher and Json Assets. Note that the order is undefined and should not be depended on.
+ * Fixed incorrect warning about mods adding invalid schedules in some cases. The validation was unreliable, and has been removed.
+ * Fixed asset propagation not updating other players' sprites.
+ * Fixed asset propagation for player sprites not updating recolor maps (e.g. sleeves).
+ * Fixed asset propagation for marriage dialogue.
+ * Fixed dialogue asset changes not correctly propagated until the next day.
+ * Fixed `helper.Data.Read`/`WriteGlobalData` using the `Saves` folder instead of the game's appdata folder. The installer will move existing folders automatically.
+ * Fixed issue where a mod which implemented `IAssetEditor`/`IAssetLoader` on its entry class could then remove itself from the editor/loader list.
+
+* For SMAPI/tool developers:
+ * Added internal performance monitoring (thanks to Drachenkätzchen!). This is disabled by default in the current version, but can be enabled using the `performance` console command.
+ * Added internal support for four-part versions to support SMAPI on Android.
+ * Rewrote `SemanticVersion` parsing.
+ * Updated links for the new r/SMAPI subreddit.
+ * The `/mods` web API endpoint now includes version mappings from the wiki.
+ * Dropped API support for the pre-3.0 update-check format.
+
## 3.1
-Released 05 January 2019 for Stardew Valley 1.4 or later.
+Released 05 January 2019 for Stardew Valley 1.4.1 or later.
* For players:
* Added separate group in 'skipped mods' list for broken dependencies, so it's easier to see what to fix first.
@@ -12,13 +53,14 @@ Released 05 January 2019 for Stardew Valley 1.4 or later.
* Fixed compatibility with Linux Mint 18 (thanks to techge!), Arch Linux, and Linux systems with libhybris-utils installed.
* Fixed memory leak when repeatedly loading a save and returning to title.
* Fixed memory leak when mods reload assets.
- * Fixes for Console Commands mod:
- * added new clothing items;
- * fixed spawning new flooring and rings (thanks to Mizzion!);
- * fixed spawning custom rings added by mods;
- * Fixed errors when some item data is invalid.
* Updated translations. Thanks to L30Bola (added Portuguese), PlussRolf (added Spanish), and shirutan (added Japanese)!
+* For the Console Commands mod:
+ * Added new clothing items.
+ * Fixed spawning new flooring and rings (thanks to Mizzion!).
+ * Fixed spawning custom rings added by mods.
+ * Fixed errors when some item data is invalid.
+
* For the web UI:
* Added option to edit & reupload in the JSON validator.
* File uploads are now stored in Azure storage instead of Pastebin, due to ongoing Pastebin perfomance issues.
diff --git a/docs/technical/mod-package.md b/docs/technical/mod-package.md
index 5b971f96..e771d7a9 100644
--- a/docs/technical/mod-package.md
+++ b/docs/technical/mod-package.md
@@ -287,7 +287,11 @@ That will create a `Pathoschild.Stardew.ModBuildConfig-<version>.nupkg` file in
which can be uploaded to NuGet or referenced directly.
## Release notes
-### Upcoming release
+### 3.1
+* Added support for semantic versioning 2.0.
+* `0Harmony.dll` is now ignored if the mod references Harmony directly (it's bundled with SMAPI).
+
+### 3.0
* Updated for SMAPI 3.0 and Stardew Valley 1.4.
* Added automatic support for `assets` folders.
* Added `$(GameExecutableName)` MSBuild variable.
@@ -298,6 +302,7 @@ which can be uploaded to NuGet or referenced directly.
* Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly.
* Fixed `<IgnoreModFilePatterns>` not working for `i18n` files.
* Dropped support for older versions of SMAPI and Visual Studio.
+* Migrated package icon to NuGet's new format.
### 2.2
* Added support for SMAPI 2.8+ (still compatible with earlier versions).
diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md
index d565aeb4..c9d5c07e 100644
--- a/docs/technical/smapi.md
+++ b/docs/technical/smapi.md
@@ -19,17 +19,8 @@ This document is about SMAPI itself; see also [mod build package](mod-package.md
## Customisation
### Configuration file
-You can customise the SMAPI behaviour by editing the `smapi-internal/config.json` file in your game
-folder.
-
-Basic fields:
-
-field | purpose
------------------ | -------
-`DeveloperMode` | Default `false` (except in _SMAPI for developers_ releases). Whether to enable features intended for mod developers (mainly more detailed console logging).
-`CheckForUpdates` | Default `true`. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background.
-`VerboseLogging` | Default `false`. Whether SMAPI should log more information about the game context.
-`ModData` | Internal metadata about SMAPI mods. Changing this isn't recommended and may destabilise your game. See documentation in the file.
+You can customise some SMAPI behaviour by editing the `smapi-internal/config.json` file in your
+game folder. See documentation in the file for more info.
### Command-line arguments
The SMAPI installer recognises three command-line arguments: