translators
8,403
edits
Changes
Jump to navigation
Jump to search
Line 10:
Line 10: − + Line 35:
Line 35: + + + + + + + + + + + + + + + + + + + + + + + + +
+ folder name convention
# [[Modding:Player Guide/Getting Started#Getting started|Install SMAPI]].
# [[Modding:Player Guide/Getting Started#Getting started|Install SMAPI]].
# Open your game's <tt>Mods</tt> folder (located in [[Modding:Player Guide/Getting Started#Find your game folder|your game folder]]).
# 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 (usually camelcase like <tt>YourModName</tt>).
# Add a subfolder with the name you want (see [[#Folder name|folder naming convention]]).
# Inside the subfolder:
# Inside the subfolder:
#* Add a <tt>manifest.json</tt> file with the <tt>ContentPackFor</tt> field (see [[Modding:Modder Guide/APIs/Manifest|manifest format]]).
#* Add a <tt>manifest.json</tt> file with the <tt>ContentPackFor</tt> field (see [[Modding:Modder Guide/APIs/Manifest|manifest format]]).
===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==
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>[ALL]</code>
| {{nexus mod|2270|Advanced Location Loader}}
|-
| <code>[CFR]</code>
| {{nexus mod|991|Custom Farming Redux}}
|-
| <code>[CP]</code>
| {{nexus mod|1915|Content Patcher}}
|-
| <code>[JA]</code>
| {{nexus mod|1720|Json Assets}}
|}
[[Category:Modding]]
[[Category:Modding]]