SMAPI/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.
A few small clean ups and removed a lot of the readme until I think of what to put there 2016-03-05 06:21:16 +08:00			`## NOTICE: THIS PROJECT IS STILL IN ALPHA`
Updated readme 2016-03-07 01:53:37 +08:00
Updated readme 2016-03-07 22:35:24 +08:00			`# What is SMAPI`

change 'Mapping' to 'Modding'? 2016-03-29 18:44:26 +08:00			`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.`
Updated readme 2016-03-07 22:35:24 +08:00
readme 2016-03-24 01:46:19 +08:00			`## Latest Version: 0.39.1`
			`- Redoes how Manifests and Configs are handled. The Config class was completely rewritten.`
Updated readme 2016-03-07 22:35:24 +08:00
Updated readme to be a little less shouty 2016-03-07 22:36:11 +08:00			`## Installation`
Updated readme 2016-03-07 22:35:24 +08:00
			`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!`

Updated readme to be a little less shouty 2016-03-07 22:36:11 +08:00			`## Future Plans`
Updated readme 2016-03-07 22:35:24 +08:00			`- Content only mods`
			`- Support for a wide range of events`
			`- Enable the addition of new custom content such as locations, NPCs, and items.`

Updated readme to be a little less shouty 2016-03-07 22:36:11 +08:00			`## Mod Developers!`
Updated readme 2016-03-07 01:53:37 +08:00
Update README.md 2016-03-21 06:52:22 +08:00			`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.`