View source for Modding:Content packs

←[[Modding:Index|Index]]

A '''content pack''' is a collection of files loaded by a specific [[Modding:Content pack frameworks|content pack framework]] (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 [[Modding:Player Guide/Getting Started|player guide]]). Make sure you install the mod it needs too.

== For Modders ==
=== Creating a Content Pack ===
# Decide which [[Modding:Content pack frameworks|content pack framework]] you'll use (each framework defines the particular files you need).
# [[Modding:Player Guide/Getting Started#Getting started|Install SMAPI]].
# Create the generic content pack format (identical for all frameworks):
## Open your game's <tt>Mods</tt> folder (located in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]]).
## Add a subfolder with the name you want (see [[#Folder name|folder naming convention]]).
## In the subfolder, add a <tt>manifest.json</tt> file with the <tt>ContentPackFor</tt> field (see [[Modding:Modder Guide/APIs/Manifest|manifest format]]).
# Add the files needed by the content pack framework (see its mod page for details).
# Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console.

=== Releasing Your Content Packs ===
# Add an [[Modding:Modder Guide/APIs/Manifest#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.)
# Create a <tt>.zip</tt> file containing the content pack's folder.
# Upload that file to [http://www.nexusmods.com/stardewvalley Nexus Mods].

In your mod description, providing clear install steps will help reduce support questions. Example BBCode:
<pre>
[size=5]Install[/size]
[list=1]
[*][url=https://smapi.io]Install the latest version of SMAPI[/url].
[*][url=<url of required mod>]Install <name of required mod>[/url].
[*]Download this mod and unzip it into [font=Courier New]Stardew Valley/Mods[/font].
[*]Run the game using SMAPI.
[/list]
</pre>

===Consume a content pack===
If you're writing a SMAPI mod which will read content packs, see [[Modding:Modder Guide/APIs/Content Packs]].

==Conventions==
These are recommended practices, but they're not required.

===Folder name===
The folder name should use [https://en.wikipedia.org/wiki/Camel_case upper camel case] with a prefix showing which mod it's for. For example, a folder named <code>[CP] SampleName</code> is a content pack for Content Patcher.

Here are some common prefixes:
{| class="wikitable"
|-
! prefix
! for mod
|-
| <code>[AHM]</code>
| {{Nexus mod|1538|Animal Husbandry Mod}}
|-
| <code>[BAGI]</code>
| {{Nexus mod|2080|Better Artisan Goods Icons}}
|-
| <code>[BFAV]</code>
| {{Nexus mod|3296|Better Farm Animal Variety}}
|-
| <code>[BL]</code>
| {{Nexus Mod|2905|Bus Locations}}
|-
| <code>[CF]</code>
| {{Nexus mod|1254|Custom Furniture}}
|-
| <code>[CFR]</code>
| {{Nexus mod|991|Custom Farming Redux}}
|-
| <code>[CM]</code>
| {{Nexus mod|3043|Custom Music}}
|-
| <code>[CP]</code>
| {{Nexus mod|1915|Content Patcher}}
|-
| <code>[FR]</code>
| {{Nexus mod|3731|Farmhouse Redone}}
|-
| <code>[FTM]</code>
| {{Nexus mod|3231|Farm Type Manager}}
|-
| <code>[JA]</code>
| {{Nexus mod|1720|Json Assets}}
|-
| <code>[MFM]</code>
| {{Nexus mod|1536|Mail Framework Mod}}
|-
| <code>[MTN]</code>
| {{Nexus mod|2256|More Than Necessary}}
|-
| <code>[PFM]</code>
| {{Nexus mod|4970|Producer Framework Mod}}
|-
| <code>[PP]</code>
| {{Nexus mod|4703|Pond Painter}}
|-
| <code>[STF]</code>
| {{Nexus mod|5005|Shop Tile Framework}}
|-
| <code>[TMX]</code>
| {{Nexus mod|1820|TMX Loader}}
|}

=== Folder structure ===
The folder should contain your <code>manifest.json</code>, the <code>content.json</code> (or the correct json for your framework), and an <code>assets</code> folder that contains any other files your mod uses.  This may include pngs, other json files, or tbin files, among others.  The assets folder may use further subfolders if you wish, though it is not required.

[[Category:Modding]]
[[zh:模组:内容包]]