Line 3: |
Line 3: |
| 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. | | 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 == | + | == 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. | | 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 == | + | == For modders == |
| === Create a content pack === | | === Create a content pack === |
| # Decide which [[Modding:Content pack frameworks|content pack framework]] you'll use (each framework defines the particular files you need). | | # Decide which [[Modding:Content pack frameworks|content pack framework]] you'll use (each framework defines the particular files you need). |
Line 17: |
Line 17: |
| # Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console. | | # Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console. |
| | | |
− | === Releasing Your Content Packs === | + | ===Release your content pack=== |
| # Add an [[Modding:Modder Guide/APIs/Manifest#Update checks|update key]] to your manifest (if you haven't already). | | # 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.) | | # Update the <tt>Version</tt> field in the manifest. (Increase it for each release! SMAPI will use it for update and compatibility checks.) |
Line 34: |
Line 34: |
| </pre> | | </pre> |
| | | |
− | === Consume a Content Pack === | + | ===Consume a content pack=== |
| If you're writing a SMAPI mod which will read content packs, see [[Modding:Modder Guide/APIs/Content Packs]]. | | If you're writing a SMAPI mod which will read content packs, see [[Modding:Modder Guide/APIs/Content Packs]]. |
| | | |
− | == Conventions== | + | ==Conventions== |
| These are recommended practices, but they're not required. | | These are recommended practices, but they're not required. |
| | | |
− | === Folder Name === | + | ===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. | | 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. |
| | | |
Line 47: |
Line 47: |
| |- | | |- |
| ! Prefix | | ! Prefix |
− | ! For Mod | + | ! For mod |
| |- | | |- |
| | <code>[AHM]</code> | | | <code>[AHM]</code> |
Line 102: |
Line 102: |
| | | |
| === Folder structure === | | === 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 <code>.png</code> files, other <code>.json</code> files, and even or <code>.tmx/.tbin</code> files, among others. The assets folder may use further subfolders if you wish, though it is not required. | + | 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 <tt>.png</tt> files, other <tt>.json</tt> files, and even or <tt>.tmx/.tbin</tt> files, among others. The assets folder may use further subfolders if you wish, though it is not required. |
| | | |
| [[Category:Modding]] | | [[Category:Modding]] |
| [[zh:模组:内容包]] | | [[zh:模组:内容包]] |