Modding:Mod compatibility/entry

mod name	author	compatibility	broke in	source
	{{{author}}}	Modding:SMAPI compatibility/entry/summary		closed source	# ⚠ no id Modding:SMAPI compatibility/entry/status

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

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

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

mod name	author	compatibility	broke in	source

Usage

Main fields (shown above)

field	purpose
name	The normalised display name for the mod. Combine with name2 (see below) to add alternate names.
author	The name of the author, as shown on Nexus or in its manifest.json file. Combine with author2 (see below) to add alternate names.
id	The latest unique mod ID, as listed in its manifest.json file. In rare cases where there are parallel current releases with different IDs, this can be comma-delimited. 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.
old ids	IDs which identify older versions of this mod.
cf id	The mod's ID in the Chucklefish mod repository.
url	The arbitrary mod URL, if not on Nexus or Chucklefish. 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.
name2 author2	Adds alternate mod and author names.
hide-url	Use this instead of (url) to move it into a superscript link. Mainly useful for broken mods with a workaround, so players don't automatically click through to the old mod.
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).

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.

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.

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