From e1e558a37f16ba42a1420ed40bb016b2e9beb7dc Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 19:03:55 -0400 Subject: New README A new README design with some simple project art. --- README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 71 insertions(+), 22 deletions(-) (limited to 'README.md') 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. +
+ + -- cgit From 5626e45354efe03c9d5dac9ead750cc649eba804 Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 19:10:48 -0400 Subject: Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5b2916b2..220ed5cd 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@
  1. Make sure all requirements are installed.
  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. +
  4. To launch SMAPI, launch StardewModdingAPI.exe.
-- cgit From 5c73fa3e9b9f7307cb97603e5e90a8888bebe507 Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 19:13:30 -0400 Subject: A little more style --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 220ed5cd..3209f87a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Wiki +
@@ -45,25 +46,25 @@
ABOUT
- +
FUTURE PLANSMOD DEVELOPERS
-
    -
  • 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 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.
- +
MOD DEVELOPERSFUTURE PLANS
- 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. +
    +
  • Content only mods.
    • +
  • Support for a wide range of events.
    • +
  • Enable the addition of new custom content such as locations, NPCs, and items.
    • +
-- cgit From 4978d7e03230840eaac7e5d386855806e8bb85ae Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 20:00:39 -0400 Subject: Add note for Steam users. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3209f87a..825b349a 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@
  • 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’.
  • To launch SMAPI, launch StardewModdingAPI.exe.
    • + 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% -- cgit From 1212222e9f59a68a9f167d20bbddd8a4e1a3cf81 Mon Sep 17 00:00:00 2001 From: Michael Sincavage Date: Sun, 29 May 2016 20:24:10 -0400 Subject: Fix typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 825b349a..d9923d4f 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@
    1. Make sure all requirements are installed.
    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 StardewModdingAPI.exe.
      4. +
    4. To start SMAPI, launch StardewModdingAPI.exe.
    - 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% + 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% -- cgit