Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(add older name for TMXL Map Toolkit, update links)
(→‎SMAPI mods: new mods: Anti-Social NPCs, Farm in the Sky, Placeable Mine Shafts, SDV Game of Life, Sleepless in Stardew, Tool Upgrade Delivery; correct mod ID for Helpful Spouses)
(6 intermediate revisions by the same user not shown)
Line 318: Line 318:
 
   |nexus id = 2887
 
   |nexus id = 2887
 
   |github  = funny-snek/anticheat-and-servercode
 
   |github  = funny-snek/anticheat-and-servercode
 +
}}
 +
{{/entry
 +
  |name    = Anti-Social NPCs
 +
  |author  = Super Aardvark, ubererdferkel
 +
  |id      = SuperAardvark.AntiSocial
 +
  |nexus id = 5371
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 524: Line 531:
 
   |moddrop id = 467021
 
   |moddrop id = 467021
 
   |github  =  
 
   |github  =  
−
}}
 
−
{{/entry
 
−
  |name    = Auto Save
 
−
  |author  = Enaium
 
−
  |id      = Enaium.AutoSave
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 553: Line 552:
 
   |nexus id = 4924
 
   |nexus id = 4924
 
   |github  =  
 
   |github  =  
−
}}
 
−
{{/entry
 
−
  |name    = Auto Tool
 
−
  |author  = Enaium
 
−
  |id      = Enaium.AutoTool
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 953: Line 944:
 
   |github  = KathrynHazuka/StardewValley_BirthdayMail
 
   |github  = KathrynHazuka/StardewValley_BirthdayMail
 
   |dev note = author ignored previous PRs
 
   |dev note = author ignored previous PRs
−
}}
 
−
{{/entry
 
−
  |name    = Birthday Reminder Mail
 
−
  |author  = Katlamos
 
−
  |id      = Katlamos.BirthdayReminderMail
 
−
  |nexus id = 4501
 
−
  |github  =
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,938: Line 1,922:
 
{{/entry
 
{{/entry
 
   |name    = Custom Localization
 
   |name    = Custom Localization
−
   |author  = Zane York
+
   |author  = ZaneYork
−
   |id      = ZaneYork.CustomLocalization
+
   |id      = SMAPI.CustomLocalization
 
   |nexus id = 5377
 
   |nexus id = 5377
 
   |github  = ZaneYork/SDV_CustomLocalization
 
   |github  = ZaneYork/SDV_CustomLocalization
  
−
   |summary  = use latest version (Android only).
+
  |status  = broken
 +
   |summary  = except on Android.
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,629: Line 2,614:
 
   |nexus id = 3731
 
   |nexus id = 3731
 
   |github  = mjSurber/FarmHouseRedone
 
   |github  = mjSurber/FarmHouseRedone
 +
}}
 +
{{/entry
 +
  |name    = Farm in the Sky, Fundo
 +
  |author  = BrasileiroTop
 +
  |id      = BrasileiroTop.Fundo
 +
  |nexus id = 5423
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,324: Line 3,316:
 
   |name    = Helpful Spouses
 
   |name    = Helpful Spouses
 
   |author  = furyx639, LeFauxMatt
 
   |author  = furyx639, LeFauxMatt
−
   |id      = furyx639.HelpSpouses
+
   |id      = furyx639.HelpfulSpouses
 
   |nexus id = 5175
 
   |nexus id = 5175
 
   |github  = ImJustMatt/SDVCustomChores
 
   |github  = ImJustMatt/SDVCustomChores
Line 3,645: Line 3,637:
 
}}
 
}}
 
{{/entry
 
{{/entry
−
   |name    = ItemBags
+
   |name    = Item Bags
 
   |author  = SlayerDharok
 
   |author  = SlayerDharok
 
   |id      = SlayerDharok.Item_Bags
 
   |id      = SlayerDharok.Item_Bags
Line 4,986: Line 4,978:
  
 
   |broke in = SMAPI 3.0
 
   |broke in = SMAPI 3.0
 +
}}
 +
{{/entry
 +
  |name    = Placeable Mine Shafts
 +
  |author  = aedenthorn
 +
  |id      = Aedenthorn.PlaceShaft
 +
  |nexus id = 5440
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 5,026: Line 5,025:
 
   |id      = Cherry.PlatonicRelationships
 
   |id      = Cherry.PlatonicRelationships
 
   |nexus id = 4668
 
   |nexus id = 4668
−
   |moddrop id = 16353
+
   |moddrop id = 716353
 
   |github  = ChroniclerCherry/stardew-valley-mods
 
   |github  = ChroniclerCherry/stardew-valley-mods
 
}}
 
}}
Line 5,423: Line 5,422:
 
   |author  = Enaium, Lightcolour888
 
   |author  = Enaium, Lightcolour888
 
   |id      = Enaium.RealTime
 
   |id      = Enaium.RealTime
−
   |nexus id =  
+
   |nexus id = 5336
−
  |url      = http://svmod.enaium.cn/
 
 
   |github  = Enaium/Stardew_Valley_Mods
 
   |github  = Enaium/Stardew_Valley_Mods
 
}}
 
}}
Line 5,765: Line 5,763:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
 
   |summary  = use [[#Yet Another Harvest With Scythe Mod|Yet Another Harvest With Scythe Mod]] instead.
 +
}}
 +
{{/entry
 +
  |name    = SDV Game of Life
 +
  |author  = Super Aardvark, ubererdferkel
 +
  |id      = SuperAardvark.GameOfLife
 +
  |nexus id = 5361
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,136: Line 6,141:
 
   |nexus id = 963
 
   |nexus id = 963
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{/entry
 +
  |name    = Sleepless in Stardew
 +
  |author  = instafluff
 +
  |id      = instafluff.sleeplessinstardew
 +
  |nexus id = 5445
 +
  |github  = instafluff/SleeplessInStardew
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,725: Line 6,737:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
−
}}
 
−
{{/entry
 
−
  |name    = Teleport
 
−
  |author  = Enaium
 
−
  |id      = Enaium.Teleport
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,924: Line 6,928:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 +
}}
 +
{{/entry
 +
  |name    = Tool Upgrade Delivery
 +
  |author  = SorryLate
 +
  |id      = SorryLate.ToolUpgradeDelivery
 +
  |nexus id = 5421
 +
  |github  = sorrylate/Stardew-Valley-Mod
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,936: Line 6,947:
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3349760
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/#post-3349760
 
   |pull request      = https://github.com/Felix-Dev/StardewMods/pull/6
 
   |pull request      = https://github.com/Felix-Dev/StardewMods/pull/6
−
}}
 
−
{{/entry
 
−
  |name    = TP NPC
 
−
  |author  = Enaium
 
−
  |id      = Enaium.TPNPC
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 6,993: Line 6,996:
 
   |nexus id = 4031
 
   |nexus id = 4031
 
   |github  =  
 
   |github  =  
−
}}
 
−
{{/entry
 
−
  |name    = TreeCapitator
 
−
  |author  = Enaium
 
−
  |id      = Enaium.TreeCapitator
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 7,118: Line 7,113:
 
   |id      = Armitxes.UnlimitedPlayers
 
   |id      = Armitxes.UnlimitedPlayers
 
   |nexus id = 2213
 
   |nexus id = 2213
 +
  |curseforge id  = 362847
 +
  |curseforge key = unlimited-players
 
   |github  = Armitxes/StardewValley_UnlimitedPlayers
 
   |github  = Armitxes/StardewValley_UnlimitedPlayers
 
}}
 
}}
Line 7,219: Line 7,216:
  
 
   |broke in = SMAPI 2.0
 
   |broke in = SMAPI 2.0
−
}}
 
−
{{/entry
 
−
  |name    = Walkshop
 
−
  |author  = Enaium
 
−
  |id      = Enaium.Walkshop
 
−
  |nexus id =
 
−
  |url      = http://svmod.enaium.cn/
 
−
  |github  = Enaium/Stardew_Valley_Mods
 
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 04:35, 22 February 2020

Modding:Player Guide/header

SMAPI mod compatibility, July 2017 to present. See notable events which affect this chart.

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 mods.smapi.io 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

SMAPI mods (obsolete)

These mods are either obsolete, or have been abandoned by their authors and probably won't 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.

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 official 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).

Footnotes

  1. ↑ 1.0 1.1 1.2 This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI compatibility.
  2. ↑ If a mod says "use optional download", its main version isn't compatible but there's an official optional update. If the mod is on Nexus, click "Files" on the mod page and check for a newer version (often under 'optional files').
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility&oldid=97080"