105,716
edits
Changes
Jump to navigation
Jump to search
mLine 6:
Line 6: − + − + − + − + − + − + − + − + Line 32:
Line 32: − + − + Line 43:
Line 43: − + − + Line 105:
Line 105: − + − + − + Line 115:
Line 115: − + − + − + Line 127:
Line 127: − + − + Line 134:
Line 134: − + − + − +
Modding:Modder Guide/Release (view source)
Revision as of 18:48, 4 November 2021
, 18:48, 4 November 2021Text replacement - "tt>" to "samp>"
===For SMAPI mods===
===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 <samp>.zip</samp> file containing a mod with your compiled files, <samp>manifest.json</samp>, any <samp>i18n</samp> 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. See [http://semver.org/ semantic version] for more information on version numbering.
# Edit your mod's <samp>manifest.json</samp> 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 <samp>bin/Debug</samp> or <samp>bin/Release</samp> folder (depending on your build configuration).
# There should be a <tt>.zip</tt> file there for your mod version.
# There should be a <samp>.zip</samp> file there for your mod version.
That <tt>.zip</tt> file is the release package for your mod, ready to upload.
That <samp>.zip</samp> 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 <samp>.zip</samp> file.
* The <tt>.zip</tt> file is missing:
* The <samp>.zip</samp> file is missing:
** Make sure you're looking at the right folder (either <tt>bin/Debug</tt> or <tt>bin/Release</tt>).
** Make sure you're looking at the right folder (either <samp>bin/Debug</samp> or <samp>bin/Release</samp>).
** Make sure there are no build errors.
** Make sure there are no build errors.
===For content pack mods===
===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.
The 'release package' for a content pack mod is just a <samp>.zip</samp> file containing a mod with your files, which must include at least a <samp>manifest.json</samp> and a <samp>content.json</samp>. See the specific guidelines for your framework mod that you are using.
====Create a content pack====
====Create a content pack====
# Create a folder with the name you want (see [[Modding:Content_packs#Folder name|folder naming convention]]).
# Create a folder with the name you want (see [[Modding:Content_packs#Folder name|folder naming convention]]).
# Inside the folder:
# 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 a <samp>manifest.json</samp> file with the <samp>ContentPackFor</samp> 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.)
#* 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.
# Launch the game, and make sure your new content pack appears under "Loaded X content packs" in the SMAPI console.
====Release your content pack====
====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.) See [http://semver.org/ semantic version] for more information on version numbering.
# Update the <samp>Version</samp> 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.
# Create a <samp>.zip</samp> file containing the content pack's folder.
# Upload that file to your chosen release site. See below guide to sites.
# Upload that file to your chosen release site. See below guide to sites.
# From your mod page, go to ''Manage > Files''.
# From your mod page, go to ''Manage > Files''.
# Fill in the form:
# Fill in the form:
#* 'File name' should have the mod name and version (like <tt>PineapplesEverywhere 1.0</tt>).
#* 'File name' should have the mod name and version (like <samp>PineapplesEverywhere 1.0</samp>).
#* 'File version' field should match the version in your <tt>manifest.json</tt>! If it doesn't, players may get incorrect update alerts.
#* 'File version' field should match the version in your <samp>manifest.json</samp>! If it doesn't, players may get incorrect update alerts.
#* Tick the "this is the latest version" checkbox so players get update alerts.
#* Tick the "this is the latest version" checkbox so players get update alerts.
#* 'File description' is up to you. You can mention the minimum SMAPI version (if any), what changed, link to release notes, etc.
#* 'File description' is up to you. You can mention the minimum SMAPI version (if any), what changed, link to release notes, etc.
# Upload the <tt>.zip</tt> file [[#Prepare the release package|you prepared above]].
# Upload the <samp>.zip</samp> file [[#Prepare the release package|you prepared above]].
===Using ModDrop===
===Using ModDrop===
====Release via webpage====
====Release via webpage====
<ol>
<ol>
<li>Go to [https://www.moddrop.com/stardew-valley/ ''ModDrop''] and choose <tt>Upload Your Mod</tt>.</li>
<li>Go to [https://www.moddrop.com/stardew-valley/ ''ModDrop''] and choose <samp>Upload Your Mod</samp>.</li>
<li>Confirm that the mod is yours to publish to proceed.</li>
<li>Confirm that the mod is yours to publish to proceed.</li>
<li>Choose <tt>Upload a File from Your Computer</tt>.</li>
<li>Choose <samp>Upload a File from Your Computer</samp>.</li>
<li>Choose a name for your mod and upload the <tt>.zip</tt> file [[#Prepare the release package|you prepared above]]. Page will display a green check next to the mod name if that name is available to use.</li>
<li>Choose a name for your mod and upload the <samp>.zip</samp> file [[#Prepare the release package|you prepared above]]. Page will display a green check next to the mod name if that name is available to use.</li>
<li>Choose the name of the mod file you want to display, the version number, release status (alpha, beta, release), add a description ([[Modding:Modder_Guide/Release#Create_a_mod_page|see the Nexus description tips]]), and optionally add patch notes or notes for yourself.</li>
<li>Choose the name of the mod file you want to display, the version number, release status (alpha, beta, release), add a description ([[Modding:Modder_Guide/Release#Create_a_mod_page|see the Nexus description tips]]), and optionally add patch notes or notes for yourself.</li>
<li>Upload an image for your mod.</li>
<li>Upload an image for your mod.</li>
====Release via app====
====Release via app====
<ol>
<ol>
<li>Open [https://www.moddrop.com/app/ ''ModDrop app''] and click on your username (top right corner). Choose <tt>Forge</tt>.</li>
<li>Open [https://www.moddrop.com/app/ ''ModDrop app''] and click on your username (top right corner). Choose <samp>Forge</samp>.</li>
<li>Choose <tt>Publish a new mod</tt>.</li>
<li>Choose <samp>Publish a new mod</samp>.</li>
<li>Follow the same steps as listed above for the site.</li>
<li>Follow the same steps as listed above for the site.</li>
</ol>
</ol>
====Sync Nexus mods to ModDrop====
====Sync Nexus mods to ModDrop====
<ol>
<ol>
<li>Open [https://www.moddrop.com/app/ ''ModDrop app''] and click on your username (top right corner). Choose <tt>Forge</tt>.</li>
<li>Open [https://www.moddrop.com/app/ ''ModDrop app''] and click on your username (top right corner). Choose <samp>Forge</samp>.</li>
<li>Choose <tt>Sync my mods from another site</tt>.</li>
<li>Choose <samp>Sync my mods from another site</samp>.</li>
<li>Follow the prompts to add your Nexus API key.</li>
<li>Follow the prompts to add your Nexus API key.</li>
<li>Choose <tt>Find new mods to sync</tt> and follow the prompts.</li>
<li>Choose <samp>Find new mods to sync</samp> and follow the prompts.</li>
<li>Confirm that the mod is yours to publish and that ModDrop is allowed to sync updates from your Nexus account.</li>
<li>Confirm that the mod is yours to publish and that ModDrop is allowed to sync updates from your Nexus account.</li>
<li>You will receive a confirmation that the request is complete. ModDrop reviews all submissions, so it may take some time for your mod to appear on the app/site.</li>
<li>You will receive a confirmation that the request is complete. ModDrop reviews all submissions, so it may take some time for your mod to appear on the app/site.</li>