update docs (#253)

This commit is contained in:
Jesse Plamondon-Willard 2018-05-12 19:27:23 -04:00
parent 92bfa6fa5b
commit 803a36133d
2 changed files with 11 additions and 2 deletions

View File

@ -1,6 +1,6 @@
**SMAPI** is an open-source modding API for [Stardew Valley](http://stardewvalley.net/) that lets **SMAPI** is an open-source modding API for [Stardew Valley](http://stardewvalley.net/) that lets
you play the game with mods. It's safely installed alongside the game's executable, and doesn't you play the game with mods. It's safely installed alongside the game's executable, and doesn't
change any of your game files. It serves six main purposes: change any of your game files. It serves eight main purposes:
1. **Load mods into the game.** 1. **Load mods into the game.**
_SMAPI loads mods when the game is starting up so they can interact with it. (Code mods aren't _SMAPI loads mods when the game is starting up so they can interact with it. (Code mods aren't
@ -25,10 +25,18 @@ change any of your game files. It serves six main purposes:
crashing the game, and makes it possible to troubleshoot errors in the game itself that would crashing the game, and makes it possible to troubleshoot errors in the game itself that would
otherwise show a generic 'program has stopped working' type of message._ otherwise show a generic 'program has stopped working' type of message._
6. **Provide update checks.** 6. **Provide update checks.**
_SMAPI automatically checks for new versions of your installed mods, and notifies you when any _SMAPI automatically checks for new versions of your installed mods, and notifies you when any
are available._ are available._
7. **Provide compatibility checks.**
_SMAPI automatically detects outdated or broken code in mods, and safely disables them before
they cause problems._
8. **Back up your save files.**
_SMAPI automatically creates a daily backup of your saves and keeps ten backups, in case
something goes wrong. (Via the bundled SaveBackup mod.)_
## Documentation ## Documentation
Have questions? Come [chat on Discord](https://discord.gg/KCJHWhX) with SMAPI developers and other Have questions? Come [chat on Discord](https://discord.gg/KCJHWhX) with SMAPI developers and other
modders! modders!

View File

@ -2,6 +2,7 @@
## 2.6 beta ## 2.6 beta
* For players: * For players:
* Updated for Stardew Valley 1.3 (no longer compatible with earlier versions). * Updated for Stardew Valley 1.3 (no longer compatible with earlier versions).
* Added a bundled save backup mod.
* Added beta update channel. * Added beta update channel.
* Added prompt when in beta channel and a new version is found. * Added prompt when in beta channel and a new version is found.
* Added friendly error when game can't start audio. * Added friendly error when game can't start audio.