Difference between revisions of "Modding:Content packs"

From Stardew Valley Wiki
Jump to navigation Jump to search
Line 21: Line 21:
  
 
===Release your content pack===
 
===Release your content pack===
 +
# Add an [[Modding:SMAPI APIs#Update checks|update key]] to your manifest (if you haven't already).
 
# Update the <tt>Version</tt> field in the manifest. (Increase it for each release! SMAPI will use it for update and compatibility checks.)
 
# Update the <tt>Version</tt> field in the manifest. (Increase it for each release! SMAPI will use it for update and compatibility checks.)
 
# Create a <tt>.zip</tt> file containing the content pack's folder.
 
# Create a <tt>.zip</tt> file containing the content pack's folder.

Revision as of 20:32, 17 February 2018

Index

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

  1. Open your game's Mods folder (located in your game folder).
  2. Add a subfolder with the name you want (usually camelcase like YourModName).
  3. 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.)
  4. Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console.

Release your content pack

  1. Add an update key to your manifest (if you haven't already).
  2. Update the Version field in the manifest. (Increase it for each release! SMAPI will use it for update and compatibility checks.)
  3. Create a .zip file containing the content pack's folder.
  4. 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.