diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 27 insertions, 6 deletions
@@ -1,9 +1,30 @@ -# SMAPI -A Modding API For Stardew Valley -See: https://github.com/Zoryn4163/SMAPI-Mods - ## NOTICE: THIS PROJECT IS STILL IN ALPHA +# What is SMAPI + +SMAPI (Stardew Mapping 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.37.3 +- Small performance patch + +Download: https://github.com/ClxS/SMAPI/releases/tag/0.37.3 + +## 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! -##Latest Version: [0.37.0.1](https://github.com/ClxS/SMAPI/tree/0.37.1) -Mod developers! Work from the latest release tag. The master branch may contain updates which make it incompatable with the latest release binaries.
\ No newline at end of file +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.
\ No newline at end of file |