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

74 lines
2.6 KiB
Markdown
Raw Normal View History

New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
<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>
A little more style
2016-05-30 07:13:30 +08:00
</br>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
<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>
Update README.md
2016-10-06 01:38:10 +08:00
<a href="https://www.microsoft.com/en-gb/download/details.aspx?id=30653">Microsoft .NET Framework 4.5</a>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</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>
Fix typos
2016-05-30 08:24:10 +08:00
<li>To start SMAPI, launch StardewModdingAPI.exe.</li>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</ol>
Fix typos
2016-05-30 08:24:10 +08:00
NOTE!: If you are using Steam and still wish to have the Steam overlay while playing, you will need to add a launch option to the game. For example, this launch option will tell Steam to use SMAPI by default: "C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley\StardewModdingAPI.exe %command%
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</td>
</tr>
</table>
<table>
<tr>
A little more style
2016-05-30 07:13:30 +08:00
<td align="center" width="888px"><b>MOD DEVELOPERS</b></td>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</tr>
<tr>
<td>
A little more style
2016-05-30 07:13:30 +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. You should also take a look at the <a href="https://github.com/ClxS/SMAPI/wiki">Wiki</a> for some quick modding tutorials.
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</td>
</tr>
</table>
<table>
<tr>
A little more style
2016-05-30 07:13:30 +08:00
<td align="center" width="888px"><b>FUTURE PLANS</b></td>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</tr>
<tr>
<td>
A little more style
2016-05-30 07:13:30 +08:00
<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>
New README A new README design with some simple project art.
2016-05-30 07:03:55 +08:00
</td>
</tr>
</table>
</body>
</html>