Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: new mods: Alvadea's Farm Maps - Goldrush, Better Fishing, Chest Preview, Custom Backpack Framework, Custom Farm Loader, Custom Gift Limits, Dynamic Crops, Early Ginger Island, Farm Animal Harvest Helper, Farm Anywhere, Fine I'll Go Make My Own Seeds, Fishing Nets, Gender Setter, Giant Omelet, Its Time to Wake Up, Junimo Cart More Score, Main Questline Redux, Move Greenhouse Plot, NPC Clothing Framework, Orchard - Better Fruit Trees, Outfit Sets, Platonic Partners and Friendships)
(→‎SMAPI mods: new mods: Press to Quack, Quick Swap, Random Bundles, Remember Birthday Gifts, Seacliff Farm for Android, Send Items Multiplayer, Shopping Cart, Slime Hutch Water Spots, Social Page Order Menu, Stack Quality, Stardew Valley - Roguelike, Stop Sounds When in Background, Unique Valley, Week Starts Sunday, Winter Rain)
Line 9,357: Line 9,357:
 
   |nexus id = 7638
 
   |nexus id = 7638
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Press to Quack
 +
  |author  = DraconisLeonidas
 +
  |id      = DraconisLeonidas.PressToQuack
 +
  |nexus id = 13583
 +
  |github  = DraconisLeonidas/PressToQuack
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,726: Line 9,733:
 
   |nexus id = 2375
 
   |nexus id = 2375
 
   |github  = Brian-Wuest/Quick_Start
 
   |github  = Brian-Wuest/Quick_Start
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Quick Swap
 +
  |author  = Allan Wang
 +
  |id      = AllanWang.QuickSwap
 +
  |nexus id = 13956
 +
  |github  = AllanWang/Stardew-Mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 9,794: Line 9,808:
 
   |id      = drbirbdev.RanchingToolUpgrades
 
   |id      = drbirbdev.RanchingToolUpgrades
 
   |nexus id = 12280
 
   |nexus id = 12280
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Random Bundles
 +
  |author  = balllight
 +
  |id      = balllight.RandomBundles
 +
  |nexus id = 13790
 
   |github  =
 
   |github  =
 
}}
 
}}
Line 10,039: Line 10,060:
 
   |nexus id = 13028
 
   |nexus id = 13028
 
   |github  = adroslice/sdv-relativity-mirror
 
   |github  = adroslice/sdv-relativity-mirror
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Remember Birthday Gifts<!--Nexus-->, Remember Birthdays<!--manifest-->
 +
  |author  = zeldela
 +
  |id      = zeldela-RememberBirthdays
 +
  |nexus id = 13554
 +
  |github  = zeldela/sdv-mods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,495: Line 10,523:
 
   |nexus id = 5773
 
   |nexus id = 5773
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Seacliff Farm for Android<!--Nexus-->, SeaCliff Farm Code<!--manifest-->
 +
  |author  = FreeTheJunimos
 +
  |id      = freethejunimos.seaclifffarm
 +
  |nexus id = 13911
 +
  |github  =
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 10,615: Line 10,650:
 
   |id      = DonDorscha.SellQuality
 
   |id      = DonDorscha.SellQuality
 
   |nexus id = 12469
 
   |nexus id = 12469
 +
  |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Send Items Multiplayer
 +
  |author  = hafnerpw
 +
  |id      = hafnerpw.SendItemsMultiplayer
 +
  |nexus id = 13794
 
   |github  =
 
   |github  =
 
}}
 
}}
Line 10,755: Line 10,797:
 
   |nexus id = 8569
 
   |nexus id = 8569
 
   |github  = TheMightyAmondee/Shoplifter
 
   |github  = TheMightyAmondee/Shoplifter
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Shopping Cart
 +
  |author  = furyx639
 +
  |id      = furyx639.ShoppingCart
 +
  |nexus id = 13701
 +
  |github  = ImJustMatt/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,116: Line 11,165:
 
   |moddrop id = 129011
 
   |moddrop id = 129011
 
   |github  = spacechase0/StardewValleyMods
 
   |github  = spacechase0/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Slime Hutch Water Spots
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.SlimeHutchWaterSpots
 +
  |nexus id = 13778
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,257: Line 11,313:
 
   |id      = aedenthorn.SocialPageOrderButton
 
   |id      = aedenthorn.SocialPageOrderButton
 
   |nexus id = 7871
 
   |nexus id = 7871
 +
  |github  = aedenthorn/StardewValleyMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Social Page Order Menu
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.SocialPageOrderMenu
 +
  |nexus id = 13698
 
   |github  = aedenthorn/StardewValleyMods
 
   |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
Line 11,558: Line 11,621:
 
   |unofficial version = 3.0.3-unofficial.1-strobe
 
   |unofficial version = 3.0.3-unofficial.1-strobe
 
   |pull request      = https://github.com/danvolchek/StardewMods/pull/22
 
   |pull request      = https://github.com/danvolchek/StardewMods/pull/22
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stack Quality
 +
  |author  = furyx639
 +
  |id      = furyx639.StackQuality
 +
  |nexus id = 13724
 +
  |github  = ImJustMatt/StardewMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,837: Line 11,907:
 
   |curseforge key = stardew-valley-randomizer
 
   |curseforge key = stardew-valley-randomizer
 
   |github  = cTooshi/stardew-valley-randomizer
 
   |github  = cTooshi/stardew-valley-randomizer
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stardew Valley - Roguelike<!--Nexus-->, Stardew Roguelike<!--manifest-->
 +
  |author  = Tyler Gibbs and TheHaboo
 +
  |id      = tylergibbs2.StardewRoguelike
 +
  |nexus id = 13614
 +
  |github  = tylergibbs2/StardewValleyRoguelike
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 11,948: Line 12,025:
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-47583
 
   |unofficial url    = https://forums.stardewvalley.net/threads/unofficial-mod-updates.2096/post-47583
 
   |pull request      = https://github.com/Jinxiewinxie/StardewValleyMods/pull/6
 
   |pull request      = https://github.com/Jinxiewinxie/StardewValleyMods/pull/6
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Stop Sounds When in Background<!--Nexus-->, Stop Sounds When Alt Tabbed<!--manifest-->
 +
  |author  = Mustafa
 +
  |id      = Mustafa.StopSoundsWhenAltTabbed
 +
  |nexus id = 13925
 +
  |github  = mustafa-git/StopSoundsWhenAltTabbed
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 12,860: Line 12,944:
 
   |nexus id = 9540
 
   |nexus id = 9540
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Unique Valley
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.UniqueValley
 +
  |nexus id = 13828
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,281: Line 13,372:
 
   |nexus id = 8194
 
   |nexus id = 8194
 
   |github  =
 
   |github  =
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Week Starts Sunday
 +
  |author  = aedenthorn
 +
  |id      = aedenthorn.WeekStartsSunday
 +
  |nexus id = 13707
 +
  |github  = aedenthorn/StardewValleyMods
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry
Line 13,365: Line 13,463:
 
   |moddrop id = 833542
 
   |moddrop id = 833542
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 +
}}
 +
{{#invoke:SMAPI compatibility|entry
 +
  |name    = Winter Rain
 +
  |author  = idermailer
 +
  |id      = idermailer.WinterRain
 +
  |nexus id = 13767
 +
  |github  = idermailer/WinterRain
 
}}
 
}}
 
{{#invoke:SMAPI compatibility|entry
 
{{#invoke:SMAPI compatibility|entry

Revision as of 00:22, 30 September 2022

← Modding:Index
Player's guide to using mods SMAPI mascot.png
SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.
  broken (proprietary)
  broken (open-source)
  compatible

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.



Players: see smapi.io/mods for a more user-friendly view of this page.

For players

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

  • Players: See smapi.io/mods for a more user-friendly list.
  • Modders: feel free to update this list! (See instructions.) Note that only SMAPI mods should be listed, not XNB mods or content packs.

SMAPI mods (obsolete)

This list contains mods which...

  • have their mod pages hidden/deleted;
  • or have been replaced by a change in the base game;
  • or have been explicitly abandoned by the mod author (unless they're open-source and likely to be updated unofficially).

These will likely never be updated again.

Content packs

This list shows broken content packs for SMAPI mods like Content Patcher. Only incompatible content packs are listed; working content packs are not listed (even if they have non-compatibility bugs). For legacy XNB mods, see #XNB mods.

XNB mods

See Modding:Using XNB mods.

Mod data overrides

This section overrides the data specified in mods' manifest.json files or mod pages for SMAPI's update checks. This is a specialized section; in most cases it's better to correct the mod instead. See the format description when editing this section.

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. Change the version in manifest.json to the official version number plus 0.0.1, with -unofficial.1-yourName at the end.
    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).
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=142012"