The modding API for Stardew Valley.

Go to file

Zoryn Aaron 65b798d5f5 i hate ticking versions i always forget		2016-04-04 06:26:41 -04:00
StardewModdingAPI	i hate ticking versions i always forget	2016-04-04 06:26:41 -04:00
TrainerMod	Revert "Updated version string"	2016-04-01 20:22:28 +01:00
.gitignore	do ignore packages I derped	2016-03-20 15:49:36 -04:00
BobberBar Private Fields.txt	expose some private fields for modding	2016-02-28 22:16:32 -05:00
Game1 Static Fields.txt	expose some private fields for modding	2016-02-28 22:16:32 -05:00
LICENSE	Initial commit	2016-02-28 06:44:19 -05:00
README.md	change 'Mapping' to 'Modding'?	2016-03-29 06:44:26 -04:00
StardewModdingAPI.sln	Removed StardewInjector. That'll go in it's own testing branch when we get around trying to integrate it.	2016-03-05 12:14:53 +00:00
UpgradeLog.htm	resync for merge conflicts	2016-03-03 15:06:25 -05:00
UpgradeLog2.htm	resync for merge conflicts	2016-03-03 15:06:25 -05:00
Vanilla Items List.txt	trying to get custom content working - do NOT try to implement cc yet	2016-03-01 01:35:52 -05:00

README.md

NOTICE: THIS PROJECT IS STILL IN ALPHA

What is SMAPI

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.

Latest Version: 0.39.1

Redoes how Manifests and Configs are handled. The Config class was completely rewritten.

Installation

To install SMAPI:

Firstly, make sure you have .NET 4.5. You can get it here: https://www.microsoft.com/en-gb/download/details.aspx?id=30653
Download the the latest release binary here: https://github.com/ClxS/SMAPI/releases/latest
Extract the zip file alongside your Stardew.exe, for example, if using Steam this would be somewhere like C:/ProgramFiles/Steam/steamapps/common/StardewValley
To launch SMAPI, launch StardewValleyModdingAPI.exe

To install mods:

To install mods just download the mod's .DLL file, and place it in %appdata%\StardewValley\Mods. SMAPI will take care of the rest!

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.

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.