Difference between revisions of "Modding:Mod compatibility"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎SMAPI mods: new mods: Advanced Key Bindings, Better Hitbox, Better Meteorites, Breath of Fire 3 Fishing Sounds, Bug Net, Cellar Available, Cozy Clothing, Deep Woods Seasonal Obelisk, Fast Petting, Fish Finder, Generic Mod Config Menu, Go To Bed)
Line 127: Line 127:
 
   |unofficial version = 1.1.1-unofficial.1-ddgroves
 
   |unofficial version = 1.1.1-unofficial.1-ddgroves
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-70#post-3335226
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-70#post-3335226
 +
}}
 +
{{/entry
 +
  |name    = Advanced Key Bindings
 +
  |author  = Drachenkatze
 +
  |id      = Drachenkatze.AdvancedKeyBindings
 +
  |nexus id = 5127
 +
  |github  = Drachenkaetzchen/AdvancedKeyBindings
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 763: Line 770:
 
   |nexus id = 1430
 
   |nexus id = 1430
 
   |github  = danvolchek/StardewMods
 
   |github  = danvolchek/StardewMods
 +
}}
 +
{{/entry
 +
  |name    = Better Hitbox
 +
  |author  = fodkod, Kodfod
 +
  |id      = kodfod.hitbox
 +
  |nexus id = 4973
 +
  |github  = Kodfod/BetterHitboxStardew
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 781: Line 795:
 
   |nexus id = 2221
 
   |nexus id = 2221
 
   |github  = hawkfalcon/Stardew-Mods
 
   |github  = hawkfalcon/Stardew-Mods
 +
}}
 +
{{/entry
 +
  |name    = Better Meteorites
 +
  |author  = spacechase0
 +
  |id      = spacechase0.BetterMeteorites
 +
  |nexus id = 5096
 +
  |github  = spacechase0/BetterMeteorites
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,028: Line 1,049:
  
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/bow/ latest version from author's website].
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/bow/ latest version from author's website].
 +
}}
 +
{{/entry
 +
  |name    = Breath of Fire 3 Fishing Sounds
 +
  |author  = Guedez, guedez2
 +
  |id      = bof.three.fishing.sounds
 +
  |nexus id = 5105
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,046: Line 1,074:
 
   |nexus id = 3429
 
   |nexus id = 3429
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{/entry
 +
  |name    = Bug Net
 +
  |author  = spacechase0 + Keychain + ParadigmNomad
 +
  |id      = spacechase0.BugNet
 +
  |nexus id = 5099
 +
  |github  = spacechase0/BugNet
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,189: Line 1,224:
 
   |unofficial version = 1.1.6-unofficial.1-Strobe
 
   |unofficial version = 1.1.6-unofficial.1-Strobe
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-13#post-3353372
 
   |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-13#post-3353372
 +
}}
 +
{{/entry
 +
  |name    = Cellar Available
 +
  |author  = candidus42
 +
  |id      = Candidus42.CellarAvailable
 +
  |nexus id = 5104
 +
  |github  = mus-candidus/CellarAvailable
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 1,596: Line 1,638:
  
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/cooking-skill/ latest version from author's website].
 
   |summary  = get [https://spacechase0.com/mods/stardew-valley/cooking-skill/ latest version from author's website].
 +
}}
 +
{{/entry
 +
  |name    = Cozy Clothing
 +
  |author  = CompSciLauren
 +
  |id      = CompSciLauren.CozyClothing
 +
  |nexus id = 5093
 +
  |github  = CompSciLauren/stardew-valley-cozy-clothing-mod
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,087: Line 2,136:
 
   |nexus id = 2571
 
   |nexus id = 2571
 
   |github  = maxvollmer/DeepWoodsMod
 
   |github  = maxvollmer/DeepWoodsMod
 +
}}
 +
{{/entry
 +
  |name    = Deep Woods Seasonal Obelisk
 +
  |author  = Sandman53
 +
  |id      = maxvollmer.deepwoodsmod.seasonalobelisk
 +
  |nexus id = 5016
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,615: Line 2,671:
 
   |status  = workaround
 
   |status  = workaround
 
   |summary  = use [[#Auto Speed|Auto Speed]] instead.
 
   |summary  = use [[#Auto Speed|Auto Speed]] instead.
 +
}}
 +
{{/entry
 +
  |name    = Fast Petting
 +
  |author  = DerTod2
 +
  |id      = de.dertod2.FastPetting
 +
  |nexus id = 5039
 +
  |github  =
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,694: Line 2,757:
  
 
   |broke in = Stardew Valley 1.4
 
   |broke in = Stardew Valley 1.4
 +
}}
 +
{{/entry
 +
  |name    = Fish Finder
 +
  |author  = Aair, AairTheGreat
 +
  |id      = AairTheGreat.FishFinder
 +
  |nexus id = 5011
 +
  |github  = AairTheGreat/StardewValleyMods
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 2,947: Line 3,017:
 
   |links      = https://github.com/mralbobo/stardew-gate-opener/pull/5
 
   |links      = https://github.com/mralbobo/stardew-gate-opener/pull/5
 
   |link labels = PR
 
   |link labels = PR
 +
}}
 +
{{/entry
 +
  |name    = Generic Mod Config Menu
 +
  |author  = spacechase0
 +
  |id      = spacechase0.GenericModConfigMenu
 +
  |nexus id = 5098
 +
  |github  = spacechase0/GenericModConfigMenu
 
}}
 
}}
 
{{/entry
 
{{/entry
Line 3,013: Line 3,090:
 
   |nexus id = 2641
 
   |nexus id = 2641
 
   |github  =  
 
   |github  =  
 +
}}
 +
{{/entry
 +
  |name    = Go To Bed
 +
  |author  = candidus42
 +
  |id      = Candidus42.GoToBed
 +
  |nexus id = 4967
 +
  |github  = mus-candidus/GoToBed
 
}}
 
}}
 
{{/entry
 
{{/entry

Revision as of 05:10, 7 January 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=94037"