Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(update coordination thread links)
Line 6,097: Line 6,097:
 
See [[Modding:Index#Migration guides|migration guides]]. You can...
 
See [[Modding:Index#Migration guides|migration guides]]. You can...
 
* Add or update your mods in the list above ([[/entry#Usage|see format]]).
 
* Add or update your mods in the list above ([[/entry#Usage|see format]]).
−
* Post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] to ask questions or say when your mods are updated.
+
* Post a message in the [https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/ coordination thread] to ask questions or say when your mods are updated.
 
* Chat or ask questions in [[Modding:Community#Discord|#modding on Discord]].
 
* Chat or ask questions in [[Modding:Community#Discord|#modding on Discord]].
  
Line 6,107: Line 6,107:
 
# Increase the version in <tt>manifest.json</tt> by <tt>0.0.1-<yourname>-update</tt>.<br /><small>For example, if the current version is 1.0.0 and your username is SampleUser, you'd change the version to <tt>1.0.1-sampleUser-update</tt>. If you need to release new versions of your update, add a number at the end like <tt>1.0.1-sampleUser-update.2</tt>, <tt>1.0.1-sampleUser-update.3</tt>, etc. This ensures that official versions will supersede unofficial ones (e.g. for update checks).</small>
 
# Increase the version in <tt>manifest.json</tt> by <tt>0.0.1-<yourname>-update</tt>.<br /><small>For example, if the current version is 1.0.0 and your username is SampleUser, you'd change the version to <tt>1.0.1-sampleUser-update</tt>. If you need to release new versions of your update, add a number at the end like <tt>1.0.1-sampleUser-update.2</tt>, <tt>1.0.1-sampleUser-update.3</tt>, etc. This ensures that official versions will supersede unofficial ones (e.g. for update checks).</small>
 
# Push your changes to GitHub.
 
# Push your changes to GitHub.
−
# Post a release package to the [https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/#post-3266439/ coordination thread] with a link to your fork on GitHub.<br /><small>(If the mod uses the NuGet build package, there should be a release package named <tt><mod name> <version>.zip</tt> in your bin folder.)</small>
+
# Post a release package to the [https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524 coordination thread] with a link to your fork on GitHub.<br /><small>(If the mod uses the NuGet build package, there should be a release package named <tt><mod name> <version>.zip</tt> in your bin folder.)</small>
 
# [https://help.github.com/articles/creating-a-pull-request/ Submit a pull request] to the original author (if applicable).
 
# [https://help.github.com/articles/creating-a-pull-request/ Submit a pull request] to the original author (if applicable).
  

Revision as of 04:33, 19 April 2018

←Index

SMAPI updates almost never break mods, except when the major version changes (e.g. SMAPI 1.0 and 2.0). This page lists known SMAPI mods and their compatibility with the latest versions of SMAPI and Stardew Valley.

For players (Stardew Valley 1.2)

What to do

  1. For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
  2. If a mod is still failing, post a message in the SMAPI 2.0 migration thread (with your SMAPI log attached) and we'll help.

SMAPI mods

Here's a list of mods tested with SMAPI 2.5+ and Stardew Valley 1.2.30+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

For players (Stardew Valley 1.3 beta)

What to do

  1. For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
  2. If a mod is still failing, post a message in the coordination thread (with your SMAPI log attached) and we'll help.

SMAPI mods

Here's a list of mods tested with SMAPI 2.6+ and Stardew Valley 1.3+. Content packs aren't listed unless incompatible. It's updated periodically for new mod releases.

This list doesn't include all known mods yet.

  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

For mod developers

Updating a mod

See migration guides. You can...

Creating an unofficial update

To avoid conflicting with official updates, here's the recommended way to create an unofficial update. This assumes you're creating a basic update (not a continuation or reinvention), and the code is on GitHub (adjust the steps accordingly if it's elsewhere).

  1. Fork the code.
  2. Make your changes to that fork (see #updating a mod).
  3. Increase the version in manifest.json by 0.0.1-<yourname>-update.
    For example, if the current version is 1.0.0 and your username is SampleUser, you'd change the version to 1.0.1-sampleUser-update. If you need to release new versions of your update, add a number at the end like 1.0.1-sampleUser-update.2, 1.0.1-sampleUser-update.3, etc. This ensures that official versions will supersede unofficial ones (e.g. for update checks).
  4. Push your changes to GitHub.
  5. Post a release package to the coordination thread with a link to your fork on GitHub.
    (If the mod uses the NuGet build package, there should be a release package named <mod name> <version>.zip in your bin folder.)
  6. Submit a pull request to the original author (if applicable).

Overall compatibility

For Stardew Valley 1.2
 
 94% are compatible or have a working alternative.
 
 1% have an update coming soon.
 
 6% are broken and not open-source.¹
¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.
For Stardew Valley 1.3
 
 15% are compatible or have a working alternative.
 
 54% have an update coming soon.
 
 31% are broken and not open-source.¹
¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=68537"