Module:SMAPI compatibility/doc

Examples

Compatible mod

{{#invoke:SMAPI compatibility|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

{{#invoke:SMAPI compatibility|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 the other fields:

  |unofficial url     = https://community.playstarbound.com/attachments/201345000
  |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 version (1.18.2-unofficial.1-example).	Stardew Valley 1.2	source	#

Usage

Limitations

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 latest 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.
pull request	The URL of the pull request which submits changes for an unofficial update to the author, if any.
cf 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.
links	A comma-delimited list of URLs to add as superscript links. Mainly useful for linking to pull requests.
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.

Beta fields

When there's a Stardew Valley beta, some mods may have different compatibility statuses for stable vs beta. You can specify these optional fields to specify a different beta status.

field	purpose
beta summary	Specify custom notes or instructions about the mod's compatibility. Should usually be blank.
beta broke in	The SMAPI or Stardew Valley update which broke this mod (if applicable).
beta 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.
beta unofficial url	A page URL where the player can download an unofficial update, if any.
beta unofficial version	The unofficial update's version number, if any.

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.

Script

This script generates the template call when run from a Nexus or Chucklefish mod page.

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  = 
}}
`;