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

From Stardew Valley Wiki
Jump to navigation Jump to search
(tweak text)
(→‎Usage: remove deleted 'pull request' parameter)
 
(132 intermediate revisions by 3 users not shown)
Line 6: Line 6:
 
! compatibility
 
! compatibility
 
! broke in
 
! broke in
−
! &nbsp;</noinclude>
+
! source
−
|- id="{{{name}}}" data-status="{{{status|ok}}}" {{#if:{{{source|}}}|data-has-source}} style="line-height: 1em; {{#switch:{{{status|ok}}} |ok=background: #9F9; |workaround=background: #CF9; |broken|soon-official=background: #F99; |obsolete=background: #999}}"
+
! &nbsp;
−
| {{#if:{{{url|}}}|[{{{url}}} {{{name}}}]|{{{name}}}}}{{#if:{{{name2|}}}|<br /><small style="font-size:0.75em;">(aka {{{name2}}})</small>}}
+
</noinclude><!--
−
| {{{author}}}{{#if:{{{author2|}}}|<br /><small style="font-size:0.75em;">(aka {{{author2}}})</small>}}
+
 
−
| {{#switch:{{{status|ok}}} |ok=✓ |workaround=⚠ |soon-official=↻ |broken={{#if:{{{source|}}}|↻|✖}}|obsolete=✖}} {{#switch:{{{status|ok}}}
+
Define a few variables here:
−
  |ok      = {{#if:{{{summary|}}}|{{{summary}}}|use latest version.}}
+
  {{#arrayindex:has_source|0}}    = set if a GitHub project name or custom source URL is set, else blank
−
  |obsolete = {{#if:{{{summary|}}}|{{{summary}}}|obsolete.}}
+
  {{#arrayindex:status|0}}        = compatibility status for the stable SMAPI/SDV release
−
  |#default = broken{{#ifeq:{{{status|}}}|obsolete|obsolete|broken}}{{#if:{{{summary|}}}|, {{{summary}}}|{{#switch:{{{status|ok}}}|broken={{#if:{{{source|}}}|, not updated yet|, not open-source}}|soon-official=, author will update it soon}}.}}
+
  {{#arrayindex:beta_status|0}}    = compatibility status for the beta SMAPI/SDV release
−
}}
+
 
 +
-->{{#arraydefine:has_source|{{#if:{{{github|}}}{{{source|}}}|1}}}}<!--
 +
 
 +
-->{{#arraydefine:status|{{#if:{{{status|}}}
 +
  |{{{status}}}
 +
  |{{#if:{{{unofficial url|}}}
 +
    |unofficial
 +
    |{{#if:{{{broke in|}}}
 +
      |broken
 +
      |ok
 +
    }}
 +
  }}
 +
}}}}<!--
 +
 
 +
Parse input arrays
 +
 
 +
-->{{#arraydefine:names|{{{name|}}}}}{{#arrayslice:altNames|names|1}}<!--
 +
-->{{#arraydefine:authors|{{{author|}}}}}{{#arrayslice:altAuthors|authors|1}}<!--
 +
-->{{#arraydefine:ids|{{{id|}}}}}<!--
 +
-->{{#arraydefine:warnings|{{{warnings|}}}}}<!--
 +
 
 +
Build output
 +
 
 +
-->
 +
|- class="mod" style="line-height: 1em; {{#switch:{{#arrayindex:status|0}} |ok|optional=background: #9F9; |workaround|unofficial=background: #CF9; |broken=background: #F99; |obsolete|abandoned=background: #999}}" <!--
 +
-->id="{{anchorencode:{{#arrayindex:names|0}}}}" <!--
 +
-->data-id="{{#arrayprint:ids|,|@@@|@@@}}" <!--
 +
-->data-name="{{#arrayprint:names|,|@@@|@@@}}" <!--
 +
-->data-author="{{#arrayprint:authors|,|@@@|@@@}}" <!--
 +
-->{{#if:{{{chucklefish id|}}}|data-cf-id="{{{chucklefish id}}}"}} <!--
 +
-->{{#if:{{{curseforge id|}}}|data-curseforge-id="{{{curseforge id}}}"}} <!--
 +
-->{{#if:{{{curseforge key|}}}|data-curseforge-key="{{{curseforge key}}}"}} <!--
 +
-->{{#if:{{{nexus id|}}}|data-nexus-id="{{{nexus id}}}"}} <!--
 +
-->{{#if:{{{moddrop id|}}}|data-moddrop-id="{{{moddrop id}}}"}} <!--
 +
-->{{#if:{{{github|}}}|data-github="{{{github}}}"}} <!--
 +
-->{{#if:{{{source|}}}|data-custom-source="{{#tag:nowiki|{{{source}}}}}"}} <!--
 +
-->data-url="{{#tag:nowiki|{{#if:{{{nexus id|}}}|{{nexus mod|{{{nexus id}}}}}|{{#if:{{{moddrop id|}}}|{{ModDrop mod|{{{moddrop id}}}}}|{{#if:{{{curseforge key|}}}|https://www.curseforge.com/stardewvalley/mods/{{urlencode:{{{curseforge key}}}}}|{{#if:{{{chucklefish id|}}}|https://community.playstarbound.com/resources/{{urlencode:{{{chucklefish id}}}}}|{{{url|}}}}}}}}}}}}}" <!--
 +
-->data-status="{{#arrayindex:status|0}}" <!--
 +
-->{{#if:{{{broke in|}}}|data-broke-in="{{{broke in}}}"}} <!--
 +
-->{{#if:{{{unofficial version|}}}|data-unofficial-version="{{{unofficial version}}}"}} <!--
 +
-->{{#if:{{{unofficial url|}}}|data-unofficial-url="{{#tag:nowiki|{{{unofficial url}}}}}"}} <!--
 +
-->{{#if:{{{pull request|}}}|data-pr="{{#tag:nowiki|{{{pull request}}}}}"}} <!--
 +
-->{{#ifexpr:{{#arraysize:warnings}} > 0|data-warnings="{{#arrayprint:warnings|, |@@@|@@@}}"}} <!--
 +
-->{{#if:{{{content pack for|}}}|data-content-pack-for="{{{content pack for}}}"}} <!--
 +
-->{{#if:{{{dev note|}}}|data-dev-note="{{{dev note}}}"}} <!--
 +
-->{{#if:{{{map local versions|}}}|data-map-local-versions="{{{map local versions}}}"}} <!--
 +
-->{{#if:{{{map remote versions|}}}|data-map-remote-versions="{{{map remote versions}}}"}}<!--
 +
-->{{#if:{{{change update keys|}}}|data-change-update-keys="{{{change update keys}}}"}}
 +
| {{#if:{{{nexus id|}}}|[{{nexus mod|{{{nexus id}}}}} {{#arrayindex:names|0}}]|{{#if:{{{moddrop id|}}}|{{ModDrop mod|{{{moddrop id}}}|{{#arrayindex:names|0}}}}|{{#if:{{{curseforge key|}}}|[https://www.curseforge.com/stardewvalley/mods/{{urlencode:{{{curseforge key}}}}} {{#arrayindex:names|0}}]|{{#if:{{{chucklefish id|}}}|[https://community.playstarbound.com/resources/{{urlencode:{{{chucklefish id}}}}} {{#arrayindex:names|0}}]|{{#if:{{{url|}}}|[{{{url}}} {{#arrayindex:names|0}}]|{{#arrayindex:names|0}}}}}}}}}}}}{{#ifexpr:{{#arraysize:altNames}} > 0|<br /><small style="font-size:0.75em;">(aka {{#arrayprint:altNames|, |@@@|@@@}})</small>}}
 +
| {{#arrayindex:authors|0}}{{#ifexpr:{{#arraysize:altAuthors}} > 0|<br /><small style="font-size:0.75em;">(aka {{#arrayprint:altAuthors|, |@@@|@@@}})</small>}}
 +
|<!--
 +
 
 +
summary--><span class="mod-summary">{{#switch:{{#arrayindex:status|0}}
 +
|ok         = ✓ {{#if:{{{summary|}}}|{{{summary}}}|use latest version.}}
 +
|optional  = ✓ {{#if:{{{summary|}}}|{{{summary}}}|use optional download.}}
 +
|unofficial = ⚠ broken{{#if:{{{unofficial url|}}}|, use [{{{unofficial url}}} unofficial update]{{#if:{{{unofficial version|}}}|&#32;(<small>{{{unofficial version}}}</small>)}}|{{{unofficial url}}}}}.
 +
|workaround = ⚠ broken, {{{summary}}}
 +
|broken    = ↻ broken, {{#if:{{{summary|}}}|{{{summary}}}|{{#if:{{#arrayindex:has_source|0}}|not updated yet.|not open-source.}}}}
 +
|obsolete   = ✖ {{#if:{{{summary|}}}|{{{summary}}}|remove this mod (obsolete).}}
 +
|abandoned  = ✖ {{#if:{{{summary|}}}|{{{summary}}}|remove this mod (no longer maintained).}}
 +
|unknown    = ☐ {{#if:{{{summary|}}}|{{{summary}}}|not tested yet.}}
 +
}}</span>{{#ifeq:{{#arrayindex:status|0}}|optional|<ref name="optional-update" />}}<!--
 +
 
 +
warnings-->{{#if:{{{warnings|}}}|<br />⚠&#32;{{#arrayprint:warnings|<br />⚠&#32;}}}}
 
| <small>{{{broke in|}}}</small>
 
| <small>{{{broke in|}}}</small>
−
| {{#if:{{{source|}}}|[{{{source}}} source]}}{{#if:{{{hide-url|}}}|&#32;[{{{hide-url}}} <sup>o</sup>]}}{{#if:{{{links|}}}|&#32;{{#arraydefine:linkArray|{{{links}}}}}{{#arrayprint:linkArray|&#32;|@@@@|<sup>[@@@@ {{#expr:{{#arraysearch:linkArray|@@@@}} + 1}}]</sup>}}}}<noinclude>
+
| {{#if:{{{github|}}}|[https://github.com/{{{github}}} source]|{{#if:{{{source|}}}|[{{{source}}} source]|<span style="color: red; font-size: 0.85em; opacity: 0.5;">closed source</span>}}}}
 +
| class="no-wrap"|<small><!--
 +
 
 +
anchor-->[[#{{#arrayindex:names|0}}|#]] <!--
 +
pull request-->{{#if:{{{pull request|}}}|&#32;[{{{pull request}}} PR]}} <!--
 +
developer note-->{{#if:{{{dev note|}}}|<abbr title="{{{dev note|}}}">[dev note]</abbr>}}<!--
 +
 
 +
validation-->{{#ifeq:{{#if:{{{curseforge id|}}}|1|0}}|{{#if:{{{curseforge key|}}}|1|0}}||<abbr title="The mod data is invalid: can't specify CurseForge key or ID without the other.">[⚠ invalid data]</abbr>}}</small><noinclude>
 
|}
 
|}
  
−
==Usage==
+
==Examples==
−
For a compatible mod:
+
===Compatible mod===
 
<pre>
 
<pre>
 
{{/entry
 
{{/entry
 
   |name    = Lookup Anything
 
   |name    = Lookup Anything
 
   |author  = Pathoschild
 
   |author  = Pathoschild
−
   |url      = http://www.nexusmods.com/stardewvalley/mods/541
+
   |id      = Pathoschild.LookupAnything
−
   |source   = https://github.com/Pathoschild/StardewMods
+
  |nexus id = 541
 +
   |github   = Pathoschild/StardewMods
 
}}
 
}}
 
</pre>
 
</pre>
  
−
For a mod with a non-OK status:
+
{| class="wikitable plainlinks"
 +
|-
 +
! mod name
 +
! author
 +
! compatibility
 +
! broke in
 +
! source
 +
! &nbsp;
 +
{{Modding:Mod compatibility/entry
 +
  |name    = Lookup Anything
 +
  |author  = Pathoschild
 +
  |id      = Pathoschild.LookupAnything
 +
  |nexus id = 541
 +
  |github  = Pathoschild/StardewMods
 +
}}
 +
|}
 +
 
 +
===Broken mod===
 
<pre>
 
<pre>
 
{{/entry
 
{{/entry
 
   |name    = Lookup Anything
 
   |name    = Lookup Anything
 
   |author  = Pathoschild
 
   |author  = Pathoschild
−
   |url      = http://www.nexusmods.com/stardewvalley/mods/541
+
   |id      = Pathoschild.LookupAnything
−
   |source   = https://github.com/Pathoschild/StardewMods
+
  |nexus id = 541
−
   |status   = broken
+
   |github   = Pathoschild/StardewMods
 +
  |summary  =
 +
 
 +
  |broke in = Stardew Valley 1.2
 +
}}
 +
</pre>
 +
{| class="wikitable plainlinks"
 +
|-
 +
! mod name
 +
! author
 +
! compatibility
 +
! broke in
 +
! source
 +
! &nbsp;
 +
{{Modding:Mod compatibility/entry
 +
  |name    = Lookup Anything
 +
  |author  = Pathoschild
 +
   |id      = Pathoschild.LookupAnything
 +
  |nexus id = 541
 +
  |github   = Pathoschild/StardewMods
 
   |summary  =  
 
   |summary  =  
 +
 
   |broke in = Stardew Valley 1.2
 
   |broke in = Stardew Valley 1.2
−
  |links    = <!-- any comma-separated URLs to pull requests, discussions, etc -->
 
 
}}
 
}}
 +
|}
 +
 +
===Unofficial update===
 +
For an unofficial update, use the broken-mod template and add these under <samp>broke in</samp>:
 +
<pre>
 +
  |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-62#post-3329160
 +
  |unofficial version = 1.18.2-unofficial.1-example
 +
  |pull request      = https://github.com/Pathoschild/Example/pull/1
 +
</pre>
 +
{| class="wikitable plainlinks"
 +
|-
 +
! mod name
 +
! author
 +
! compatibility
 +
! broke in
 +
! source
 +
! &nbsp;
 +
{{Modding:Mod compatibility/entry
 +
  |name    = Lookup Anything
 +
  |author  = Pathoschild
 +
  |id      = Pathoschild.LookupAnything
 +
  |nexus id = 541
 +
  |github  = Pathoschild/StardewMods
 +
  |summary  =
 +
 +
  |broke in          = Stardew Valley 1.2
 +
  |unofficial url    = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-62#post-3329160
 +
  |unofficial version = 1.18.2-unofficial.1-example
 +
  |pull request      = https://github.com/Pathoschild/Example/pull/1
 +
}}
 +
|}
 +
 +
==Usage==
 +
===Limitations===
 +
* Avoid using quotes (<code>"</code>) in argument values; use <code>&amp;quot;</code> instead.
 +
* The <nowiki>name</nowiki>, <nowiki>author</nowiki>, and <nowiki>id</nowiki> arguments are comma-separated. If the actual value contains a comma, use <code>&amp;#44;</code> instead.
 +
 +
===Main fields (shown above)===
 +
{| class="wikitable"
 +
|-
 +
! field
 +
! purpose
 +
|-
 +
| <code>name</code>
 +
| The normalised display name for the mod. Delimit alternate names with commas.
 +
|-
 +
| <code>author</code>
 +
| The name of the author, as shown on Nexus or in its <samp>manifest.json</samp> file. Delimit alternate names with commas.
 +
|-
 +
| <code>id</code>
 +
| The unique mod ID, as listed in its <samp>manifest.json</samp> file. Delimit alternate/older IDs with commas (ideally in latest to oldest order). For very old mods with no ID, use <samp>none</samp> to disable validation checks.
 +
|-
 +
| <code>nexus id</code>
 +
| The mod's unique ID on Nexus (if any). This is the number in the mod page's URL.
 +
|-
 +
| <code>github</code>
 +
| The mod's GitHub repository in the form <samp>owner/repo</samp>.
 +
|-
 +
| <code>summary</code>
 +
| Specify custom notes or instructions about the mod's compatibility. Should usually be blank.
 +
|-
 +
| <code>broke in</code>
 +
| The SMAPI or Stardew Valley update which broke this mod (if applicable).
 +
|}
 +
 +
===Other fields===
 +
{| class="wikitable"
 +
|-
 +
! field
 +
! purpose
 +
|-
 +
| <code>status</code>
 +
| Whether the mod is compatible with the latest versions of Stardew Valley and SMAPI (see [[#Valid statuses]]). If not specified, it defaults to <code>unofficial</code> if an unofficial URL is given, else <code>broken</code> if <code>broke in</code> is specified, else <code>ok</code>.
 +
|-
 +
| <code>unofficial url</code>
 +
| A page URL where the player can download an unofficial update, if any.
 +
|-
 +
| <code>unofficial version</code>
 +
| The unofficial update's version number, if any.
 +
|-
 +
| <code>chucklefish id</code>
 +
| The mod's ID in the [https://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mod repository].
 +
|-
 +
| <code>curseforge id</code>
 +
| The mod's project ID in the [https://www.curseforge.com/stardewvalley CurseForge mod repository]. This is the value shown on the mod page next to "Project ID".
 +
|-
 +
| <code>curseforge key</code>
 +
| The mod's key in the [https://www.curseforge.com/stardewvalley CurseForge mod repository]. This is the mod key shown in the mod page's URL.
 +
|-
 +
| <code>moddrop id</code>
 +
| The mod's ID in the [https://www.moddrop.com/stardew-valley/ ModDrop mod repository].
 +
|-
 +
| <code>url</code>
 +
| The arbitrary mod URL, if not on a known mod site. Avoid if possible, since this makes crossreferencing more difficult.
 +
|-
 +
| <code>source</code>
 +
| An arbitrary source code URL, if not on GitHub. Avoid if possible, since this makes crossreferencing more difficult.
 +
|-
 +
| <code>warnings</code>
 +
| Text explaining additional compatibility warnings about the mod (''e.g.,'' not compatible with Linux/Mac).
 +
|-
 +
| <code>content pack for</code>
 +
| The name of the mod which loads this content pack.
 +
|-
 +
| <code>dev note</code>
 +
| Special notes intended for developers who maintain unofficial updates or submit pull requests.
 +
|}
 +
 +
===Override fields===
 +
These fields override information provided by the author in the <samp>manifest.json</samp> or mod page, so they should only be used as a last resort.
 +
 +
{| class="wikitable"
 +
|-
 +
! field
 +
! purpose
 +
|-
 +
| <code>change update keys</code>
 +
| Overrides the [[Modding:Modder Guide/APIs/Update checks|update keys]] from the <samp>manifest.json</samp> or other compatibility list fields. Remove a key with <code>-</code>, add a key with an optional <code>+</code>, and separate keys with commas. For example:
 +
<pre>
 +
|override update keys = -Nexus:991, +Nexus:991@CFA
 +
</pre>
 +
|-
 +
| <code>map remote version</code>
 +
| When SMAPI performs an update check for the mod, this field overrides the version returned by the server. SMAPI will match the original version using [https://semver.org/ semantic rules] if it's parseable (''e.g.,'' <code>1.0</code> and <code>1.0.0</code> are equivalent), else it'll fallback to case-insensitive string comparison (''e.g.,'' <code>1.01</code> and <code>1.01.0</code> are ''not'' equivalent). If an invalid format is specified or the new version can't be parsed, the mapping will be ignored.
 +
 +
'''This is a specialised field; it's better to correct the mod page if possible.'''
 +
 +
Mappings are specified with an arrow, and multiple mappings can be separated by a semi-colon:
 +
<pre>
 +
|map remote versions = 0.01 → 0.0.1; 0.0.1-beta → 0.0.1
 
</pre>
 
</pre>
 +
|-
 +
| <code>map local version</code>
 +
| Equivalent to <code>map remote version</code>, but for the manifest version.
 +
|}
  
−
Valid statuses:
+
===Valid statuses===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! status
 
! status
−
! meaning
+
! description
−
! default summary
 
 
|-
 
|-
 
| <code>ok</code>
 
| <code>ok</code>
−
| The mod is compatible. This is the default and doesn't need to be specified.
+
| The mod is compatible. This is the default and doesn't need to be specified.<br />Default summary: ''use latest version.''
−
| ''use latest version.''
+
|-
 +
| <code>optional</code>
 +
| The mod is compatible, if you use an optional download on the mod page.<br />Default summary: ''use optional download.<sup>[[#footnote|[1]]]</sup>''
 +
|-
 +
| <code>unofficial</code>
 +
| The mod is compatible using an unofficial update. There's no need to specify this; if you also set <samp>unofficial url</samp> and <samp>unofficial version</samp>, you can remove the status field.
 
|-
 
|-
 
| <code>workaround</code>
 
| <code>workaround</code>
−
| The mod isn't compatible, but the player can fix it or there's a good alternative.
+
| The mod isn't compatible, but the player can fix it or there's a good alternative. A summary should be provided manually. If you also set <samp>unofficial url</samp> and <samp>unofficial version</samp>, you can remove the status field.
−
|
 
 
|-
 
|-
−
| <code>soon-official</code>
+
| <code>broken</code>
−
| The mod isn't compatible, but the author has said they'll update it.
+
| The mod isn't compatible. The message depends on whether the <code>source</code> link is set.<br />Default summary: ''broken, not updated yet'' or ''broken, not open-source.''
−
| ''author will update it soon.''
 
 
|-
 
|-
−
| <code>broken</code>
+
| <code>abandoned</code>
−
| The mod isn't compatible. The message depends on whether the <code>source</code> link is set.
+
| The mod is no longer maintained by the author, and an unofficial update or continuation is unlikely. This should only be used when the author has definitively abandoned the mod (either explicitly, or by removing the mod page or downloads).<br />Default summary: ''no longer maintained.''
−
| ''broken, not updated yet.''<br />''broken, not open-source.''
 
 
|-
 
|-
 
| <code>obsolete</code>
 
| <code>obsolete</code>
 
| The mod is no longer needed and should be removed.
 
| The mod is no longer needed and should be removed.
−
|  
+
|-
 +
| <code>unknown</code>
 +
| The mod's compatibility status hasn't been tested. This should only be used as a placeholder (''e.g.,'' when adding a new beta), it should never be used long since that defeats the purpose of the compatibility list.
 
|}
 
|}
  
−
Other fields:
+
[[de:Modding:SMAPI Kompatibilität/entry]]
−
* <code>|name2=name</code> and <code>|author2=name</code> add also-known-as lines for the mod name & author respectively.
 
−
* <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>|links=URLs</code> adds superscript links (comma-separated). Mainly useful for linking to pull requests.
 
−
 
 
−
==Script==
 
−
This script generates the template call when run from a Nexus or Chucklefish mod page.
 
−
<source lang="javascript">
 
−
switch(location.host)
 
−
{
 
−
case "www.nexusmods.com":
 
−
var url = location.origin + location.pathname.replace(/\/*$/, '');
 
−
var name = $(".header-name").text();
 
−
var author = $(".uploader a").text();
 
−
var author2 = $(".header-author strong").text();
 
−
break;
 
−
 
 
−
case "community.playstarbound.com":
 
−
var url = location.origin + location.pathname.replace(/\/*$/, '');
 
−
var name = $.trim($("h1:first").contents().first().text());
 
−
var author = $(".primaryContent[data-author]:first").attr("data-author");
 
−
break;
 
−
 
 
−
default:
 
−
throw `Unknown domain: ${location.host}`;
 
−
}
 
−
 
 
−
var template = `
 
−
{{/entry
 
−
  |name    = ${name}
 
−
  |author  = ${author}`;
 
−
if(author2 && author2 != author)
 
−
  template += '\n' + `  |author2 = ${author2}`;
 
−
template += `
 
−
  |url    = ${url}
 
−
  |status  = ok
 
−
  |summary =
 
−
  |source  =
 
−
}}
 
−
`;
 
−
</source>
 
  
−
[[Category:Modding]]</noinclude>
+
[[Category:Modding]]
 +
</noinclude>

Latest revision as of 19:47, 2 March 2024

mod name author compatibility broke in source  
✓ use latest version. closed source #

Examples

Compatible mod

{{/entry
  |name     = Lookup Anything
  |author   = Pathoschild
  |id       = Pathoschild.LookupAnything
  |nexus id = 541
  |github   = Pathoschild/StardewMods
}}
mod name author compatibility broke in source  
Lookup Anything Pathoschild ✓ use latest version. source #

Broken mod

{{/entry
  |name     = Lookup Anything
  |author   = Pathoschild
  |id       = Pathoschild.LookupAnything
  |nexus id = 541
  |github   = Pathoschild/StardewMods
  |summary  = 

  |broke in = Stardew Valley 1.2
}}
mod name author compatibility broke in source  
Lookup Anything Pathoschild ↻ broken, not updated yet. Stardew Valley 1.2 source #

Unofficial update

For an unofficial update, use the broken-mod template and add these under broke in: 

  |unofficial url     = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-62#post-3329160
  |unofficial version = 1.18.2-unofficial.1-example
  |pull request       = https://github.com/Pathoschild/Example/pull/1
mod name author compatibility broke in source  
Lookup Anything Pathoschild ⚠ broken, use unofficial update (1.18.2-unofficial.1-example). Stardew Valley 1.2 source # PR

Usage

Limitations

  • Avoid using quotes (") in argument values; use &quot; instead.
  • The name, author, and id arguments are comma-separated. If the actual value contains a comma, use &#44; instead.

Main fields (shown above)

field purpose
name The normalised display name for the mod. Delimit alternate names with commas.
author The name of the author, as shown on Nexus or in its manifest.json file. Delimit alternate names with commas.
id The unique mod ID, as listed in its manifest.json file. Delimit alternate/older IDs with commas (ideally in latest to oldest order). For very old mods with no ID, use none to disable validation checks.
nexus id The mod's unique ID on Nexus (if any). This is the number in the mod page's URL.
github The mod's GitHub repository in the form owner/repo.
summary Specify custom notes or instructions about the mod's compatibility. Should usually be blank.
broke in The SMAPI or Stardew Valley update which broke this mod (if applicable).

Other fields

field purpose
status Whether the mod is compatible with the latest versions of Stardew Valley and SMAPI (see #Valid statuses). If not specified, it defaults to unofficial if an unofficial URL is given, else broken if broke in is specified, else ok.
unofficial url A page URL where the player can download an unofficial update, if any.
unofficial version The unofficial update's version number, if any.
chucklefish id The mod's ID in the Chucklefish mod repository.
curseforge id The mod's project ID in the CurseForge mod repository. This is the value shown on the mod page next to "Project ID".
curseforge key The mod's key in the CurseForge mod repository. This is the mod key shown in the mod page's URL.
moddrop id The mod's ID in the ModDrop mod repository.
url The arbitrary mod URL, if not on a known mod site. Avoid if possible, since this makes crossreferencing more difficult.
source An arbitrary source code URL, if not on GitHub. Avoid if possible, since this makes crossreferencing more difficult.
warnings Text explaining additional compatibility warnings about the mod (e.g., not compatible with Linux/Mac).
content pack for The name of the mod which loads this content pack.
dev note Special notes intended for developers who maintain unofficial updates or submit pull requests.

Override fields

These fields override information provided by the author in the manifest.json or mod page, so they should only be used as a last resort.

field purpose
change update keys Overrides the update keys from the manifest.json or other compatibility list fields. Remove a key with -, add a key with an optional +, and separate keys with commas. For example: 
|override update keys = -Nexus:991, +Nexus:991@CFA
map remote version When SMAPI performs an update check for the mod, this field overrides the version returned by the server. SMAPI will match the original version using semantic rules if it's parseable (e.g., 1.0 and 1.0.0 are equivalent), else it'll fallback to case-insensitive string comparison (e.g., 1.01 and 1.01.0 are not equivalent). If an invalid format is specified or the new version can't be parsed, the mapping will be ignored.

This is a specialised field; it's better to correct the mod page if possible.

Mappings are specified with an arrow, and multiple mappings can be separated by a semi-colon: 

|map remote versions = 0.01 → 0.0.1; 0.0.1-beta → 0.0.1
map local version Equivalent to map remote version, but for the manifest version.

Valid statuses

status description
ok The mod is compatible. This is the default and doesn't need to be specified.
Default summary: use latest version.
optional The mod is compatible, if you use an optional download on the mod page.
Default summary: use optional download.[1]
unofficial The mod is compatible using an unofficial update. There's no need to specify this; if you also set unofficial url and unofficial version, you can remove the status field.
workaround The mod isn't compatible, but the player can fix it or there's a good alternative. A summary should be provided manually. If you also set unofficial url and unofficial version, you can remove the status field.
broken The mod isn't compatible. The message depends on whether the source link is set.
Default summary: broken, not updated yet or broken, not open-source.
abandoned The mod is no longer maintained by the author, and an unofficial update or continuation is unlikely. This should only be used when the author has definitively abandoned the mod (either explicitly, or by removing the mod page or downloads).
Default summary: no longer maintained.
obsolete The mod is no longer needed and should be removed.
unknown The mod's compatibility status hasn't been tested. This should only be used as a placeholder (e.g., when adding a new beta), it should never be used long since that defeats the purpose of the compatibility list.
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Mod_compatibility/entry&oldid=153863"