From e1e558a37f16ba42a1420ed40bb016b2e9beb7dc Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 19:03:55 -0400 Subject: [PATCH] New README A new README design with some simple project art. --- README.md | 93 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 71 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 81da4656..5b2916b2 100644 --- a/README.md +++ b/README.md @@ -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. + + + + + + + + + + +
Version: 0.40.0 AlphaChangelogLicenseWiki
+ + + + + + + +
ABOUT
+ 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. +
+ + + + + + + +
REQUIREMENTS
+ Microsoft .NET Framework 4.6.1 +
+ + + + + + + +
INSTALLATION
+
    +
  1. Make sure all requirements are installed.
    2. +
  2. 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’.
    3. +
  3. To launch SMAPI, launch StardewValleyModdingAPI.exe.
    4. +
+
+ + + + + + + +
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. You should also take a look at the Wiki for some quick modding tutorials. +
+ +