diff options
author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2018-08-01 11:07:29 -0400 |
---|---|---|
committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2018-08-01 11:07:29 -0400 |
commit | 60b41195778af33fd609eab66d9ae3f1d1165e8f (patch) | |
tree | 7128b906d40e94c56c34ed6058f27bc31c31a08b /docs/README.md | |
parent | b9bc1a6d17cafa0a97b46ffecda432cfc2f23b51 (diff) | |
parent | 52cf953f685c65b2b6814e375ec9a5ffa03c440a (diff) | |
download | SMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.tar.gz SMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.tar.bz2 SMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.zip |
Merge branch 'develop' into stable
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md index bdfc5c9d..e7d6d682 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ **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 -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.** _SMAPI loads mods when the game is starting up so they can interact with it. (Code mods aren't @@ -25,16 +25,24 @@ 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 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 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 Have questions? Come [chat on Discord](https://discord.gg/KCJHWhX) with SMAPI developers and other modders! ### For players -* [Modding guides](https://stardewvalleywiki.com/Modding:Index#For_players) +* [Player guide](https://stardewvalleywiki.com/Modding:Player_Guide) ### For modders * [Modding documentation](https://stardewvalleywiki.com/Modding:Index) |