Modding:Content packs

From Stardew Valley Wiki
Revision as of 20:28, 17 February 2018 by Pathoschild (talk | contribs) (create page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Ready to share your content pack with the world? Create a .zip file containing the content pack's folder, and upload that file to Nexus Mods.

Don't forget to change the Version field in the manifest when you upload a new version! SMAPI will use for update and compatibility checks.

Consume a content pack

If you're writing a SMAPI mod which will read content packs, see Modding:SMAPI APIs#Content packs.