StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

New README 

A new README design with some simple project art.
This commit is contained in:
Michael Sincavage 2016-05-29 19:03:55 -04:00
parent 27dece2cf4
commit e1e558a37f
1 changed files with 71 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@ -1,22 +1,71 @@
## 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.
## 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
## 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.
<html>
<body>
<img align="center" src="https://raw.githubusercontent.com/Gormogon/SMAPI/master/docs/imgs/SMAPI.png"/>
<table>
<tr align="center">
<td width="222px"><a href="https://github.com/ClxS/SMAPI/releases">Version: 0.40.0 Alpha</a></td>
<td width="222px"><a href="https://github.com/ClxS/SMAPI/blob/master/CHANGELOG.md">Changelog</a></td>
<td width="222px"><a href="https://github.com/ClxS/SMAPI/blob/master/LICENSE">License</a></td>
<td width="222px"><a href="https://github.com/ClxS/SMAPI/wiki">Wiki</a></td>
</tr>
</table>
<table>
<tr>
<td align="center" width="888px"><b>ABOUT</b></td>
</tr>
<tr>
<td>
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.
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="888px"><b>REQUIREMENTS</b></td>
</tr>
<tr>
<td>
<a href="https://www.microsoft.com/en-us/download/details.aspx?id=49981">Microsoft .NET Framework 4.6.1</a>
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="888px"><b>INSTALLATION</b></td>
</tr>
<tr>
<td>
<ol>
<li>Make sure all requirements are installed.</li>
<li>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’.</li>
<li>To launch SMAPI, launch StardewValleyModdingAPI.exe.</li>
</ol>
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="888px"><b>FUTURE PLANS</b></td>
</tr>
<tr>
<td>
<ul>
<li>Content only mods.</li>
<li>Support for a wide range of events.</li>
<li>Enable the addition of new custom content such as locations, NPCs, and items.</li>
</ul>
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="888px"><b>MOD DEVELOPERS</b></td>
</tr>
<tr>
<td>
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 <a href="https://github.com/ClxS/SMAPI/wiki">Wiki</a> for some quick modding tutorials.
</td>
</tr>
</table>
</body>
</html>