Line 1: |
Line 1: |
| {{../header}} | | {{../header}} |
| | | |
− | SMAPI simplifies mod development by providing APIs and events you can use, which are documented below. See [[Modding:Creating a SMAPI mod]] for a guide to creating a new SMAPI mod. | + | SMAPI provides a number of APIs for mods to use. Click a section on the right or below for more details. |
| + | |
| + | ==Basic APIs== |
| + | {| class="wikitable" |
| + | |- |
| + | ! page |
| + | ! summary |
| + | |- |
| + | | [[/Manifest|Manifest]] |
| + | | A file needed for every mod or content pack which describes the mod, lists dependencies, enables update checks, etc. |
| + | |- |
| + | | [[/Events|Events]] |
| + | | Respond when something happens in the game (e.g. when a save is loaded), and often include details about what happened. |
| + | |- |
| + | | [[/Config|Mod configuration]] |
| + | | Let players edit a <tt>config.json</tt> file to configure your mod. |
| + | |- |
| + | | [[/Content|Content]] |
| + | | Load images/maps/data, and edit or replace the game's images/maps/data. |
| + | |- |
| + | | [[/Logging|Logging]] |
| + | | Write messages to the SMAPI console and log. |
| + | |- |
| + | | [[/Reflection|Reflection]] |
| + | | Access fields, properties, or methods which are normally inaccessible. |
| + | |- |
| + | | [[/Multiplayer|Multiplayer]] |
| + | | Provides methods for supporting multiplayer. |
| + | |- |
| + | | [[/Translation|Translation]] |
| + | | Translate your mod text into any game language. |
| + | |- |
| + | | [[/Utilities|Utilities]] |
| + | | Use constants, contextual information, date logic, and semantic versions. |
| + | |} |
| + | |
| + | ==Advanced APIs== |
| + | {| class="wikitable" |
| + | |- |
| + | ! page |
| + | ! summary |
| + | |- |
| + | | [[/Content Packs|Content packs]] |
| + | | Let other modders provide files for your mod to read, which players can install like any other mod. |
| + | |- |
| + | | [[/Console|Console commands]] |
| + | | Add custom commands to the SMAPI console. |
| + | |- |
| + | | [[/Integrations|Mod integrations]] |
| + | | Get information about loaded mods, and integrate with mods using mod-provided APIs. |
| + | |} |
| | | |
| ==Manifest== | | ==Manifest== |