diff options
| author | Carl <slxxls92@gmail.com> | 2016-05-30 01:33:37 +0100 |
|---|---|---|
| committer | Carl <slxxls92@gmail.com> | 2016-05-30 01:33:37 +0100 |
| commit | fa666f803398e29a7ffec0707cd6a1ec3571d3e9 (patch) | |
| tree | 71099c94fa92196cfb6cdb42a56379e6fdaa4364 /README.md | |
| parent | 4edee54da20e7655ae24cf1ac2abded5ec1ba2c5 (diff) | |
| parent | 1212222e9f59a68a9f167d20bbddd8a4e1a3cf81 (diff) | |
| download | SMAPI-fa666f803398e29a7ffec0707cd6a1ec3571d3e9.tar.gz SMAPI-fa666f803398e29a7ffec0707cd6a1ec3571d3e9.tar.bz2 SMAPI-fa666f803398e29a7ffec0707cd6a1ec3571d3e9.zip | |
Merge pull request #118 from Gormogon/master
Some Semi-Big Changes
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 95 |
1 files changed, 73 insertions, 22 deletions
@@ -1,22 +1,73 @@ -## 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> +</br> +<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 start SMAPI, launch StardewModdingAPI.exe.</li> + </ol> + 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% + </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> +<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> +</body> +</html> |