README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

<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>HELP + SUPPORT</b></td>
  </tr>
  <tr>
    <td>
      This repository is archived and issues are not actively read. For support with issues, please check the Stardew Valley official forums: http://community.playstarbound.com/threads/stardew-modding-api-0-40-1-1.108375/
    </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-gb/download/details.aspx?id=30653">Microsoft .NET Framework 4.5</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>