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

From Stardew Valley Wiki
Jump to navigation Jump to search
(automate "use latest version" summary for OK status if not specified, update example)
(add default summary for broken status, document statuses)
Line 9: Line 9:
 
| {{#if:{{{url|}}}|[{{{url}}} {{{name}}}]|{{{name}}}}}
 
| {{#if:{{{url|}}}|[{{{url}}} {{{name}}}]|{{{name}}}}}
 
| {{{author}}}
 
| {{{author}}}
| {{#switch:{{{status}}} |ok=✓ |workaround=⚠ |broken=✖}} {{#if:{{{summary|}}}|{{{summary}}}|{{#switch:{{{status}}}|ok=use latest version.}}}}
+
| {{#switch:{{{status}}} |ok=✓ |workaround=⚠ |broken=✖}} {{#if:{{{summary|}}}|{{{summary}}}|{{#switch:{{{status}}}|ok=use latest version. |broken=broken, not open-source.}}}}
 
| {{#if:{{{source|}}}|[{{{source}}} source]}}{{#if:{{{hide-url|}}}|&#32;[{{{hide-url}}} ᵒ]}}{{#if:{{{link1|}}}|&#32;[{{{link1}}} ¹]}}{{#if:{{{link2|}}}|&#32;[{{{link2}}} ²]}}<noinclude>
 
| {{#if:{{{source|}}}|[{{{source}}} source]}}{{#if:{{{hide-url|}}}|&#32;[{{{hide-url}}} ᵒ]}}{{#if:{{{link1|}}}|&#32;[{{{link1}}} ¹]}}{{#if:{{{link2|}}}|&#32;[{{{link2}}} ²]}}<noinclude>
 
|}
 
|}
Line 25: Line 25:
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
Valid statuses:
 +
{| class="wikitable"
 +
|-
 +
! status
 +
! meaning
 +
! default summary
 +
|-
 +
| <code>ok</code>
 +
| The mod is compatible with SMAPI 2.0.
 +
| ''use latest version.''
 +
|-
 +
| <code>broken</code>
 +
| 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.''
 +
|-
 +
| <code>workaround</code>
 +
| The mod isn't compatible with SMAPI 2.0, but the player can fix it or there's a good alternative.
 +
|
 +
|}
  
 
Other fields:
 
Other fields:

Revision as of 17:50, 11 July 2017

Usage

Basic fields:

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

Valid statuses:

status meaning default summary
ok The mod is compatible with SMAPI 2.0. use latest version.
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.
workaround The mod isn't compatible with SMAPI 2.0, but the player can fix it or there's a good alternative.

Other fields:

  • |hide-url=URL (replacing |url=) moves the URL into a superscript link.
  • |link1=URL and |link2=URL adds superscript links.