Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Undo revision 69415 by Vikitty (talk) Please don't replace formatting marks with curly quotes)
Line 11: Line 11:
 
==For players (Stardew Valley 1.3 beta)==
 
==For players (Stardew Valley 1.3 beta)==
 
{{upcoming|1.3}}
 
{{upcoming|1.3}}
−
<div style="border: 1px solid red; border-left: 1em solid red; padding: 0.5em 1em; border-radius: 5px;">‘’'Note:’'’ during the Stardew Valley 1.3 beta, mods may provide an optional update without changing their main version. SMAPI won’t show an update alert in those cases, but the updates will be listed here.</div>
+
<div style="border: 1px solid red; border-left: 1em solid red; padding: 0.5em 1em; border-radius: 5px;">'''Note:''' during the Stardew Valley 1.3 beta, mods may provide an optional update without changing their main version. SMAPI won't show an update alert in those cases, but the updates will be listed here.</div>
  
 
===What to do===
 
===What to do===
−
# For each mod you have installed, follow the instructions in the list below. If it’s not listed, try updating to its latest version.
+
# For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
−
# If a mod is still failing, post a message in the [https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/ coordination thread] (with [[Modding:Player FAQs#SMAPI log|your SMAPI log]] attached) and we’ll help.
+
# If a mod is still failing, post a message in the [https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/ coordination thread] (with [[Modding:Player FAQs#SMAPI log|your SMAPI log]] attached) and we'll help.
  
 
===SMAPI mods===
 
===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.
+
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.
  
−
{| class=”wikitable sortable plainlinks” id=”mod-list”
+
{| class="wikitable sortable plainlinks" id="mod-list"
 
|-
 
|-
 
! mod name
 
! mod name
 
! author
 
! author
−
! compatibility<ref name="compatibility">This only shows whether a mod is ‘’compatible’’; it may have bugs unrelated to SMAPI compatibility.</ref>
+
! compatibility<ref name="compatibility">This only shows whether a mod is ''compatible''; it may have bugs unrelated to SMAPI compatibility.</ref>
 
! broke in
 
! broke in
 
! (metadata)
 
! (metadata)
Line 202: Line 202:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = A Tapper’s Dream
+
   |name    = A Tapper's Dream
 
   |name2    = A Tree Overhaul
 
   |name2    = A Tree Overhaul
 
   |author  = Goldenrevolver
 
   |author  = Goldenrevolver
Line 244: Line 244:
 
   |author  = WhiteMind
 
   |author  = WhiteMind
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1895
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1895
−
   |source  = https://github.com/WhiteMinds/mod-sv-autofish
+
   |source  =  
 
   |status  = broken
 
   |status  = broken
 
   |summary  =  
 
   |summary  =  
Line 620: Line 620:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Children’s Beds Removal
+
   |name    = Children's Beds Removal
 
   |author  = Prismuth
 
   |author  = Prismuth
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1655
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1655
Line 1,081: Line 1,081:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Don’t Eat That
+
   |name    = Don't Eat That
 
   |author  = Pyrohead37
 
   |author  = Pyrohead37
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1951
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1951
Line 1,536: Line 1,536:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Grandfather’s Gift
+
   |name    = Grandfather's Gift
 
   |author  = ShadowDragon8685
 
   |author  = ShadowDragon8685
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/985
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/985
Line 2,307: Line 2,307:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Persival’s BundleMod
+
   |name    = Persival's BundleMod
 
   |author  = Persival
 
   |author  = Persival
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/438
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/438
Line 2,541: Line 2,541:
 
{{/entry
 
{{/entry
 
   |name    = Reseed
 
   |name    = Reseed
−
   |name2    = Roc’s Reseed Mod
+
   |name2    = Roc's Reseed Mod
 
   |author  = rocslayer
 
   |author  = rocslayer
 
   |author2  = James Overton
 
   |author2  = James Overton
Line 2,809: Line 2,809:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Siv’s Marriage
+
   |name    = Siv's Marriage
 
   |author  = sivolobwho
 
   |author  = sivolobwho
 
   |author2  = Tori Leblanc or Siv
 
   |author2  = Tori Leblanc or Siv
Line 2,937: Line 2,937:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Spouse’s Room Mod
+
   |name    = Spouse's Room Mod
 
   |author  = Wata
 
   |author  = Wata
 
   |author2  = Watagatapitusberry
 
   |author2  = Watagatapitusberry
Line 3,115: Line 3,115:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Stephan’s Lots of Crops
+
   |name    = Stephan's Lots of Crops
 
   |author  = stephanreiken
 
   |author  = stephanreiken
 
   |url      = https://community.playstarbound.com/resources/4314
 
   |url      = https://community.playstarbound.com/resources/4314
Line 3,182: Line 3,182:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Teh’s Fishing Overhaul
+
   |name    = Teh's Fishing Overhaul
 
   |author  = TehPers
 
   |author  = TehPers
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/866
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/866
Line 3,441: Line 3,441:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Where’s My Items
+
   |name    = Where's My Items
 
   |author  = f4iTh
 
   |author  = f4iTh
 
   |author2  = JertsukkaTheMan
 
   |author2  = JertsukkaTheMan
Line 3,513: Line 3,513:
  
 
===XNB mods===
 
===XNB mods===
−
‘’'XNB mods are an older type of mod and are no longer recommended.’'’ This section shows SMAPI or [https://www.nexusmods.com/stardewvalley/mods/1915 Content Patcher] mods you can use instead. (Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of [[Modding:Content packs|SMAPI content packs]].)
+
'''XNB mods are an older type of mod and are no longer recommended.''' This section shows SMAPI or [https://www.nexusmods.com/stardewvalley/mods/1915 Content Patcher] mods you can use instead. (Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of [[Modding:Content packs|SMAPI content packs]].)
  
−
‘’'Modders:’'’ when migrating XNB mods, only use <tt>Action: Load</tt> if you actually need to replace the whole file (e.g. portrait mods). Don’t use <tt>Action: Load</tt> for dialogue mods or to change a small part of a file!
+
'''Modders:''' when migrating XNB mods, only use <tt>Action: Load</tt> if you actually need to replace the whole file (e.g. portrait mods). Don't use <tt>Action: Load</tt> for dialogue mods or to change a small part of a file!
  
−
{| class=”wikitable plainlinks sortable”
+
{| class="wikitable plainlinks sortable"
 
|-
 
|-
 
! mod name
 
! mod name
Line 3,795: Line 3,795:
 
}}
 
}}
 
{{/xnb
 
{{/xnb
−
   |original name  = Tokiri’s Pet Replacements - Dog (Fox)
+
   |original name  = Tokiri's Pet Replacements - Dog (Fox)
 
   |original author = Tokiri
 
   |original author = Tokiri
 
   |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
 
   |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
Line 3,804: Line 3,804:
 
}}
 
}}
 
{{/xnb
 
{{/xnb
−
   |original name  = Tokiri’s Pet Replacements - Horse (Ridable wolf)
+
   |original name  = Tokiri's Pet Replacements - Horse (Ridable wolf)
 
   |original author = Tokiri
 
   |original author = Tokiri
 
   |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
 
   |original url    = https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/
Line 3,836: Line 3,836:
 
==For players (Stardew Valley 1.2)==
 
==For players (Stardew Valley 1.2)==
 
===What to do===
 
===What to do===
−
# For each mod you have installed, follow the instructions in the list below. If it’s not listed, try updating to its latest version.
+
# For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
−
# If a mod is still failing, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] (with [[Modding:Player FAQs#SMAPI log|your SMAPI log]] attached) and we’ll help.
+
# If a mod is still failing, post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread] (with [[Modding:Player FAQs#SMAPI log|your SMAPI log]] attached) and we'll help.
  
 
===SMAPI mods===
 
===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.
+
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.
  
−
{| class=”wikitable plainlinks” id=”mod-list”
+
{| class="wikitable plainlinks" id="mod-list"
 
|-
 
|-
 
! mod name
 
! mod name
 
! author
 
! author
−
! compatibility<ref name="compatibility">This only shows whether a mod is ‘’compatible’’; it may have bugs unrelated to SMAPI compatibility.</ref>
+
! compatibility<ref name="compatibility">This only shows whether a mod is ''compatible''; it may have bugs unrelated to SMAPI compatibility.</ref>
 
! broke in
 
! broke in
 
! (metadata)
 
! (metadata)
Line 3,984: Line 3,984:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = A Tapper’s Dream
+
   |name    = A Tapper's Dream
 
   |name2    = A Tree Overhaul
 
   |name2    = A Tree Overhaul
 
   |author  = Goldenrevolver
 
   |author  = Goldenrevolver
Line 4,306: Line 4,306:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Children’s Beds Removal
+
   |name    = Children's Beds Removal
 
   |author  = Prismuth
 
   |author  = Prismuth
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1655
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1655
Line 4,658: Line 4,658:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Don’t Eat That
+
   |name    = Don't Eat That
 
   |author  = Pyrohead37
 
   |author  = Pyrohead37
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1951
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/1951
Line 5,031: Line 5,031:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Grandfather’s Gift
+
   |name    = Grandfather's Gift
 
   |author  = ShadowDragon8685
 
   |author  = ShadowDragon8685
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/985
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/985
Line 5,615: Line 5,615:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Persival’s BundleMod
+
   |name    = Persival's BundleMod
 
   |author  = Persival
 
   |author  = Persival
 
   |hide-url = https://www.nexusmods.com/stardewvalley/mods/438
 
   |hide-url = https://www.nexusmods.com/stardewvalley/mods/438
Line 5,794: Line 5,794:
 
{{/entry
 
{{/entry
 
   |name    = Reseed
 
   |name    = Reseed
−
   |name2    = Roc’s Reseed Mod
+
   |name2    = Roc's Reseed Mod
 
   |author  = rocslayer
 
   |author  = rocslayer
 
   |author2  = James Overton
 
   |author2  = James Overton
Line 5,998: Line 5,998:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Siv’s Marriage
+
   |name    = Siv's Marriage
 
   |author  = sivolobwho
 
   |author  = sivolobwho
 
   |author2  = Tori Leblanc or Siv
 
   |author2  = Tori Leblanc or Siv
Line 6,093: Line 6,093:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Spouse’s Room Mod
+
   |name    = Spouse's Room Mod
 
   |author  = Wata
 
   |author  = Wata
 
   |author2  = Watagatapitusberry
 
   |author2  = Watagatapitusberry
Line 6,259: Line 6,259:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Stephan’s Lots of Crops
+
   |name    = Stephan's Lots of Crops
 
   |author  = stephanreiken
 
   |author  = stephanreiken
 
   |url      = https://community.playstarbound.com/resources/4314
 
   |url      = https://community.playstarbound.com/resources/4314
Line 6,314: Line 6,314:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Teh’s Fishing Overhaul
+
   |name    = Teh's Fishing Overhaul
 
   |author  = TehPers
 
   |author  = TehPers
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/866
 
   |url      = https://www.nexusmods.com/stardewvalley/mods/866
Line 6,530: Line 6,530:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = Where’s My Items
+
   |name    = Where's My Items
 
   |author  = f4iTh
 
   |author  = f4iTh
 
   |author2  = JertsukkaTheMan
 
   |author2  = JertsukkaTheMan
Line 6,586: Line 6,586:
 
==For mod developers==
 
==For mod developers==
 
===Updating a mod===
 
===Updating a mod===
−
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 [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.
 
* 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.
Line 6,592: Line 6,592:
  
 
===Creating an unofficial update===
 
===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).
+
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).
  
 
# [https://help.github.com/articles/fork-a-repo/ Fork the code].
 
# [https://help.github.com/articles/fork-a-repo/ Fork the code].

Revision as of 01:34, 2 May 2018

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to April 2018. The two main events are Stardew Valley 1.2 in July 2017, and Stardew Valley 1.3 in April 2018.

Sometimes a mod will stop working due to a major game update; SMAPI automatically disables incompatible mods. This page lists known SMAPI mods and their compatibility with the latest versions, and explains how to fix broken mods if possible.

Check the section applicable to you:

For players (Stardew Valley 1.3 beta)

The following describes the upcoming Stardew Valley 1.3, and may change before release.
Note: during the Stardew Valley 1.3 beta, mods may provide an optional update without changing their main version. SMAPI won't show an update alert in those cases, but the updates will be listed here.

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.

XNB mods

XNB mods are an older type of mod and are no longer recommended. This section shows SMAPI or Content Patcher mods you can use instead. (Content Patcher is a SMAPI mod that makes XNB-like changes with all the benefits of SMAPI content packs.)

Modders: when migrating XNB mods, only use Action: Load if you actually need to replace the whole file (e.g. portrait mods). Don't use Action: Load for dialogue mods or to change a small part of a file!

Modding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnbModding:Mod compatibility/xnb
mod name original author Content Patcher equivalent links
  1. ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.

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 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 and add -unofficial.1-yourName.
    For example, if the current version is 1.0.0 and your name is SampleUser, change it to 1.0.1-unofficial.1-sampleUser. If you need to release a new unofficial update, just increment unofficial.1 to unofficial.2, etc. This ensures that official versions supersede unofficial ones (e.g. for update checks), and other users can release newer unofficial updates if needed.
  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.3
 
 32% are compatible or have a working alternative.
 
 41% have an update coming soon.
 
 27% 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.2
 
 94% are compatible or have a working alternative.
 
 1% have an update coming soon.
 
 5% are broken and not open-source.¹
¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.

Modding:Player Guide/footer

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=69419"