StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move license back to root so GitHub sees it, readme tweaks

This commit is contained in:
Jesse Plamondon-Willard 2017-10-07 23:33:03 -04:00
parent d0dd2f7ba7
commit 99617211fa
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/LICENSE.md → LICENSE.txt
View File

14
docs/README.md
View File

@ -1,14 +1,14 @@
**SMAPI** is an [open-source](LICENSE.md) 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:
**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:
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
possible without SMAPI to load them.)_
2. **Provide APIs and events for mods.**
_SMAPI provides low-level APIs and events which let mods interact with the game in ways they
otherwise couldn't._
_SMAPI provides APIs and events which let mods interact with the game in ways they otherwise
couldn't._
3. **Rewrite mods for crossplatform compatibility.**
_SMAPI rewrites mods' compiled code before loading them so they work on Linux/Mac/Windows
@ -16,8 +16,8 @@ doesn't change any of your game files. It serves six main purposes:
game._
4. **Rewrite mods to update them.**
_SMAPI detects when a mod accesses part of the game that changed in a recent update which
affects many mods, and rewrites the mod so it's compatible._
_SMAPI detects when a mod accesses part of the game that changed in a game update which affects
many mods, and rewrites the mod so it's compatible._
5. **Intercept errors.**
_SMAPI intercepts errors that happen in the game, displays the error details in the console

2
src/SMAPI.sln
View File

@ -12,6 +12,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".root", ".root", "{86C452BE
..\.editorconfig = ..\.editorconfig
..\.gitattributes = ..\.gitattributes
..\.gitignore = ..\.gitignore
..\LICENSE.txt = ..\LICENSE.txt
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StardewModdingAPI.Installer", "SMAPI.Installer\StardewModdingAPI.Installer.csproj", "{443DDF81-6AAF-420A-A610-3459F37E5575}"
@ -33,7 +34,6 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{EB35A917-67B9-4EFA-8DFC-4FB49B3949BB}"
ProjectSection(SolutionItems) = preProject
..\docs\CONTRIBUTING.md = ..\docs\CONTRIBUTING.md
..\docs\LICENSE.md = ..\docs\LICENSE.md
..\docs\README.md = ..\docs\README.md
..\docs\release-notes.md = ..\docs\release-notes.md
EndProjectSection