blob: 2405147519bafd358dceedaf5ffc60e4d85f924c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
## 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.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.
|
