Modding:Mod compatibility/entry

From Stardew Valley Wiki
< Modding:Mod compatibility
Revision as of 02:45, 18 July 2017 by Pathoschild (talk | contribs) (tweak workaround color)
Jump to navigation Jump to search

Usage

Basic fields:

{{/entry
  |name    = Lookup Anything
  |author  = Pathoschild
  |url     = http://www.nexusmods.com/stardewvalley/mods/541
  |status  = ok
  |summary = 
  |source  = https://github.com/Pathoschild/StardewMods
}}

Valid statuses:

status meaning default summary
ok The mod is compatible with SMAPI 2.0. use latest version.
workaround The mod isn't compatible with SMAPI 2.0, but the player can fix it or there's a good alternative.
soon The mod isn't compatible with SMAPI 2.0, but it's open-source so an unofficial update will be prepared soon (if the author doesn't update it first). update coming soon.
soon-official The mod isn't compatible with SMAPI 2.0, but the author has said they'll update it. author will update it soon.
broken The mod isn't compatible with SMAPI 2.0, isn't open-source, and there's no indication that the author will update it yet. broken, not open-source.
obsolete The mod is no longer needed and should be removed.

Other fields:

  • |name2=name and |author2=name add also-known-as lines for the mod name & author respectively.
  • |hide-url=URL (replacing |url=) moves the URL into a superscript link. Mainly useful for broken mods with a workaround, so players don't automatically click through to the old mod.
  • |link1=URL and |link2=URL adds superscript links. Mainly useful for linking to pull requests.