Modding:Mod compatibility/entry

mod name	author	compatibility
{{{name}}}	{{{author}}}	✓ use latest version.

Usage

For a compatible mod:

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

For a mod with a non-OK status:

{{/entry
  |name     = Lookup Anything
  |author   = Pathoschild
  |url      = http://www.nexusmods.com/stardewvalley/mods/541
  |source   = https://github.com/Pathoschild/StardewMods
  |status   = broken
  |summary  = 
  |broke in = Stardew Valley 1.2
  |links    = <!-- any comma-separated URLs to pull requests, discussions, etc -->
}}

Valid statuses:

status	meaning	default summary
ok	The mod is compatible. This is the default and doesn't need to be specified.	use latest version.
workaround	The mod isn't compatible, but the player can fix it or there's a good alternative.
soon	The mod isn't compatible, but it's open-source so an unofficial update will be prepared soon (if the author doesn't update it first).	update coming soon.
soon-official	The mod isn't compatible, but the author has said they'll update it.	author will update it soon.
broken	The mod isn't compatible, isn't open-source (or requires significant refactoring from the author), and there's no indication that the author will update it yet.	broken, not open-source. broken, needs update from the author.
obsolete	The mod is no longer needed and should be removed.

Other fields:

• |name2=name and |author2=name add also-known-as lines for the mod name & author respectively.
• |hide-url=URL (replacing |url=) 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.
• |links=URLs 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.

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