Difference between revisions of "Modding:Mod compatibility/entry"

From Stardew Valley Wiki
Jump to navigation Jump to search
(+ soon and soon-official statuses)
(→‎Usage: tweak documentation)
Line 55: Line 55:
  
 
Other fields:
 
Other fields:
* <code>|hide-url=URL</code> (replacing <code>|url=</code>) moves the URL into a superscript link.
+
* <code>|hide-url=URL</code> (replacing <code>|url=</code>) 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.
* <code>|link1=URL</code> and <code>|link2=URL</code> adds superscript links.
+
* <code>|link1=URL</code> and <code>|link2=URL</code> adds superscript links. Mainly useful for linking to pull requests.
  
 
[[Category:Modding]]</noinclude>
 
[[Category:Modding]]</noinclude>

Revision as of 18:50, 11 July 2017

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.

Other fields:

  • |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.