Difference between revisions of "Modding:Content packs"
Minervamaga (talk | contribs) (→Conventions: Added section about folder structure) |
Minervamaga (talk | contribs) (→Folder name: Added several new frameworks to list) |
||
Line 50: | Line 50: | ||
| <code>[ALL]</code> | | <code>[ALL]</code> | ||
| {{nexus mod|2270|Advanced Location Loader}} | | {{nexus mod|2270|Advanced Location Loader}} | ||
+ | |- | ||
+ | | <code>[AHM]</code> | ||
+ | | {{nexus mod|1538|Animal Husbandry Mod}} | ||
|- | |- | ||
| <code>[BFAV]</code> | | <code>[BFAV]</code> | ||
Line 68: | Line 71: | ||
| <code>[FR]</code> | | <code>[FR]</code> | ||
| {{nexus mod|3731|Farmhouse Redone}} | | {{nexus mod|3731|Farmhouse Redone}} | ||
+ | |- | ||
+ | | <code>[FTM]</code> | ||
+ | | {{nexus mod|3231|Farm Type Manager}} | ||
|- | |- | ||
| <code>[JA]</code> | | <code>[JA]</code> | ||
| {{nexus mod|1720|Json Assets}} | | {{nexus mod|1720|Json Assets}} | ||
+ | |- | ||
+ | | <code>[MFM]</code> | ||
+ | | {{nexus mod|1536|Mail Framework Mod}} | ||
|- | |- | ||
| <code>[MTN]</code> | | <code>[MTN]</code> |
Revision as of 22:12, 6 December 2019
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 guide). 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 (see folder naming convention).
- 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.
In your mod description, providing clear install steps will help reduce support questions. Example BBCode:
[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]
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 upper camel case with a prefix showing which mod it's for. For example, a folder named [CP] SampleName
is a content pack for Content Patcher.
Here are some common prefixes:
prefix | for mod |
---|---|
[ALL]
|
Advanced Location Loader |
[AHM]
|
Animal Husbandry Mod |
[BFAV]
|
Better Farm Animal Variety |
[CF]
|
Custom Furniture |
[CFR]
|
Custom Farming Redux |
[CM]
|
Custom Music |
[CP]
|
Content Patcher |
[FR]
|
Farmhouse Redone |
[FTM]
|
Farm Type Manager |
[JA]
|
Json Assets |
[MFM]
|
Mail Framework Mod |
[MTN]
|
More Than Necessary |
[TMX]
|
TMX Loader |
Folder structure
The folder should contain your manifest.json
, the content.json
(or the correct json for your framework), and an assets
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.