Difference between revisions of "Modding:Content packs"
Jump to navigation
Jump to search
Pathoschild (talk | contribs) (→Release your content pack: + update key) |
Pathoschild (talk | contribs) (→Create a content pack: + install SMAPI) |
||
Line 13: | Line 13: | ||
==For modders== | ==For modders== | ||
===Create a content pack=== | ===Create a content pack=== | ||
+ | # [[Modding:Installing SMAPI|Install SMAPI]]. | ||
# Open your game's <tt>Mods</tt> folder (located in [[Modding:Player FAQs#Game folder|your game folder]]). | # Open your game's <tt>Mods</tt> folder (located in [[Modding:Player FAQs#Game folder|your game folder]]). | ||
# Add a subfolder with the name you want (usually camelcase like <tt>YourModName</tt>). | # Add a subfolder with the name you want (usually camelcase like <tt>YourModName</tt>). |
Revision as of 19:05, 18 February 2018
The following describes the upcoming SMAPI 2.5, and may change before release.
A content pack is a collection of files for a specific SMAPI mod to read (essentially a sub-mod). Content packs can contain any files, but usually consist of JSON files and images.
For players
If you want to use a content pack, install it just like a SMAPI mod (see player FAQs). Make sure you install the mod it needs too.
For modders
Create a content pack
- Install SMAPI.
- Open your game's Mods folder (located in your game folder).
- Add a subfolder with the name you want (usually camelcase like YourModName).
- Inside the subfolder:
- Add a manifest.json file with the ContentPackFor field (see manifest format).
- Add the files needed by the mod that will read it. (See the instructions for the mod for which you're creating the content pack.)
- Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console.
Release your content pack
- Add an update key to your manifest (if you haven't already).
- Update the Version field in the manifest. (Increase it for each release! SMAPI will use it for update and compatibility checks.)
- Create a .zip file containing the content pack's folder.
- Upload that file to Nexus Mods.
Consume a content pack
If you're writing a SMAPI mod which will read content packs, see Modding:SMAPI APIs#Content packs.