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

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 " instead.
The name, author, and id arguments are comma-separated. If the actual value contains a comma, use , 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.

@@ Line 13: / Line 13: @@
    {{#arrayindex:has_source|0}}     = set if a GitHub project name or custom source URL is set, else blank
    {{#arrayindex:status|0}}        = compatibility status for the stable SMAPI/SDV release
+  {{#arrayindex:beta_status|0}}    = compatibility status for the beta SMAPI/SDV release
 -->{{#arraydefine:has_source|{{#if:{{{github|}}}{{{source|}}}|1}}}}<!--
@@ Line 59: / Line 60: @@
 -->{{#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:{{{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>}}
 |<!--
-stable label (if different)-->{{#ifeq:{{#arrayindex:status_compare|0}}|different|'''{{version|stable|link=0}}:'''&#32;}}<!--
 summary--><span class="mod-summary">{{#switch:{{#arrayindex:status|0}}
@@ Line 74: / Line 74: @@
   |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" />}}<!--
@@ Line 151: / Line 152: @@
 ===Unofficial update===
-For an unofficial update, use the broken-mod template and add these under <tt>broke in</tt>:
+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
@@ Line 195: / Line 196: @@
 |-
 | <code>author</code>
-| The name of the author, as shown on Nexus or in its <tt>manifest.json</tt> file. Delimit alternate names with commas.
+| 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 <tt>manifest.json</tt> file. Delimit alternate/older IDs with commas (ideally in latest to oldest order). For very old mods with no ID, use <tt>none</tt> to disable validation checks.
+| 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>
@@ Line 204: / Line 205: @@
 |-
 | <code>github</code>
-| The mod's GitHub repository in the form <tt>owner/repo</tt>.
+| The mod's GitHub repository in the form <samp>owner/repo</samp>.
 |-
 | <code>summary</code>
@@ Line 227: / Line 228: @@
 | <code>unofficial version</code>
 | The unofficial update's version number, if any.
-|-
-| <code>pull request</code>
-| The URL of the pull request which submits changes for an unofficial update to the author, if any.
 |-
 | <code>chucklefish id</code>
@@ Line 241: / Line 239: @@
 |-
 | <code>moddrop id</code>
-| The mod's ID in the [https://www.moddrop.com/sdv/ ModDrop mod repository].
+| The mod's ID in the [https://www.moddrop.com/stardew-valley/ ModDrop mod repository].
 |-
 | <code>url</code>
@@ Line 250: / Line 248: @@
 |-
 | <code>warnings</code>
-| Text explaining additional compatibility warnings about the mod (e.g. not compatible with Linux/Mac).
+| Text explaining additional compatibility warnings about the mod (''e.g.,'' not compatible with Linux/Mac).
 |-
 | <code>content pack for</code>
@@ Line 257: / Line 255: @@
 | <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.
+| 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.'''
@@ Line 285: / Line 298: @@
 |-
 | <code>unofficial</code>
-| The mod is compatible using an unofficial update. There's no need to specify this; if you also set <tt>unofficial url</tt> and <tt>unofficial version</tt>, you can remove the status field.
+| 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>
-| 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 <tt>unofficial url</tt> and <tt>unofficial version</tt>, you can remove the status field.
+| 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>broken</code>
@@ Line 298: / Line 311: @@
 | <code>obsolete</code>
 | 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.
 |}