153
edits
Changes
Jump to navigation
Jump to search
Line 4:
Line 4: + + − + − + Line 14:
Line 16: − + Line 28:
Line 30: + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modding:Modder Guide/Release (view source)
Revision as of 16:58, 8 September 2019
, 16:58, 8 September 2019→Prepare the release package: Added content pack guidelines and versioning guide links
==Prepare the release package==
==Prepare the release package==
===For SMAPI mods===
The 'release package' for a SMAPI mod is just a <tt>.zip</tt> file containing a mod with your compiled files, <tt>manifest.json</tt>, any <tt>i18n</tt> files, etc. The NuGet package will create it for you automatically.
The 'release package' for a SMAPI mod is just a <tt>.zip</tt> file containing a mod with your compiled files, <tt>manifest.json</tt>, any <tt>i18n</tt> files, etc. The NuGet package will create it for you automatically.
===Generate package===
====Generate package====
# Edit your mod's <tt>manifest.json</tt> to increase the version.
# Edit your mod's <tt>manifest.json</tt> to increase the version. See [http://semver.org/ semantic version] for more information on version numbering.
# Click ''Build > Rebuild Solution'' (Visual Studio) or ''Build > Rebuild All'' (MonoDevelop) to make sure the project is compiled.
# Click ''Build > Rebuild Solution'' (Visual Studio) or ''Build > Rebuild All'' (MonoDevelop) to make sure the project is compiled.
# Open your mod project's <tt>bin/Debug</tt> or <tt>bin/Release</tt> folder (depending on your build configuration).
# Open your mod project's <tt>bin/Debug</tt> or <tt>bin/Release</tt> folder (depending on your build configuration).
That <tt>.zip</tt> file is the release package for your mod, ready to upload.
That <tt>.zip</tt> file is the release package for your mod, ready to upload.
===Troubleshoot package===
====Troubleshoot package====
Here's how to fix common issues with the generated <tt>.zip</tt> file.
Here's how to fix common issues with the generated <tt>.zip</tt> file.
** If it's a mod file: right-click on the file in Visual Studio or MonoDevelop, choose ''Properties'', and change 'Copy to Output Directory' to 'do not copy'.
** If it's a mod file: right-click on the file in Visual Studio or MonoDevelop, choose ''Properties'', and change 'Copy to Output Directory' to 'do not copy'.
** If it's an assembly reference: right-click on the reference in Visual Studio or MonoDevelop, choose ''Properties'', and change 'Copy Local' or 'Local Copy' to false.
** If it's an assembly reference: right-click on the reference in Visual Studio or MonoDevelop, choose ''Properties'', and change 'Copy Local' or 'Local Copy' to false.
==For content pack mods==
The 'release package' for a content pack mod is just a <tt>.zip</tt> file containing a mod with your files, which must include at least a <tt>manifest.json</tt> and a <tt>content.json</tt>. See the specific guidelines for your framework mod that you are using.
===Create a content pack===
# Create a folder with the name you want (see [[#Folder name|folder naming convention]]).
# Inside the folder:
#* 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 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 [[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.) See [http://semver.org/ semantic version] for more information on version numbering.
# 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>
==Release the mod==
==Release the mod==