StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
The modding API for Stardew Valley.
263 Commits 10 Branches 117 Tags 23 MiB
C# 94.5%
JavaScript 1.9%
HTML 1.8%
CSS 0.8%
Shell 0.6%
Other 0.4%
Go to file
ClxS 12e4822cbf Updated version number 2016-10-07 18:29:26 +01:00
docs/imgs Attempt to migrate to new directory structure. 2016-05-29 18:23:01 -04:00
src Updated version number 2016-10-07 18:29:26 +01:00
.gitignore do ignore packages I derped 2016-03-20 15:49:36 -04:00
CHANGELOG.md Add CHANGELOG.md 2016-05-29 19:27:17 -04:00
LICENSE license change. GPL to LGPL. 2016-04-06 06:08:32 -04:00
README.md Update README.md 2016-10-05 18:38:10 +01:00

README.md

<html>
Version: 0.40.0 Alpha Changelog License Wiki

ABOUT
SMAPI (Stardew Modding Application Programming Interface) is a tool to help modders make changes to Stardew. It is a standalone executable which goes alongside your Stardew.exe.
REQUIREMENTS
Microsoft .NET Framework 4.5
INSTALLATION
  1. Make sure all requirements are installed.
  2. Extract the SMAPI zip archive alongside your Stardew.exe. For example, if using Steam this would be somewhere like ‘C:/ProgramFiles/Steam/steamapps/common/StardewValley’.
  3. To start SMAPI, launch StardewModdingAPI.exe.
NOTE!: If you are using Steam and still wish to have the Steam overlay while playing, you will need to add a launch option to the game. For example, this launch option will tell Steam to use SMAPI by default: "C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley\StardewModdingAPI.exe %command%
MOD DEVELOPERS
Mod developers would work off the release branch. The master branch will contain mid-version updates which could make your mods incompatable with both the current release and the upcoming releases. You should also take a look at the Wiki for some quick modding tutorials.
FUTURE PLANS
  • Content only mods.
  • Support for a wide range of events.
  • Enable the addition of new custom content such as locations, NPCs, and items.
</html>