Module:SMAPI compatibility/doc - Revision history

imported>Pathoschild: update for disabled beta fields

2024-03-30T15:13:50Z

update for disabled beta fields

← Older revision		Revision as of 15:13, 30 March 2024
Line 142:		Line 142:
	\|}		\|}

	<!-- set 'enableBeta = true' in Lua code to enable these~~-->~~		<!-- set 'enableBeta = true' in Lua code to enable these
	===Beta fields===		===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.		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.
Line 166:		Line 166:
	\| The unofficial update's version number, if any.		\| The unofficial update's version number, if any.
	\|}		\|}
			-->
	===Valid statuses===		===Valid statuses===
	{\| class="wikitable"		{\| class="wikitable"

imported>Pathoschild: update for enabled beta fields

2023-12-30T01:07:37Z

update for enabled beta fields

← Older revision		Revision as of 01:07, 30 December 2023
Line 142:		Line 142:
	\|}		\|}

	<!-- set 'enableBeta = true' in Lua code to enable these		<!-- set 'enableBeta = true' in Lua code to enable these-->
	===Beta fields===		===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.		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.
Line 166:		Line 166:
	\| The unofficial update's version number, if any.		\| The unofficial update's version number, if any.
	\|}		\|}
	~~-->~~

	===Valid statuses===		===Valid statuses===

imported>Pathoschild: update for argument changes

2023-06-29T23:46:48Z

update for argument changes

← Older revision		Revision as of 23:46, 29 June 2023
Line 5:		Line 5:
	<pre>		<pre>
	{{#invoke:SMAPI compatibility\|entry		{{#invoke:SMAPI compatibility\|entry
	\|name = Lookup Anything		\|name = Lookup Anything
	\|author = Pathoschild		\|author = Pathoschild
	\|id = Pathoschild.LookupAnything		\|id = Pathoschild.LookupAnything
	\|nexus id = 541		\|nexus = 541
	\|github = Pathoschild/StardewMods		\|github = Pathoschild/StardewMods
	}}		}}
	</pre>		</pre>
Line 15:		Line 15:
	{{#invoke:SMAPI compatibility\|header}}		{{#invoke:SMAPI compatibility\|header}}
	{{#invoke:SMAPI compatibility\|entry		{{#invoke:SMAPI compatibility\|entry
	\|name = Lookup Anything		\|name = Lookup Anything
	\|author = Pathoschild		\|author = Pathoschild
	\|id = Pathoschild.LookupAnything		\|id = Pathoschild.LookupAnything
	\|nexus id = 541		\|nexus = 541
	\|github = Pathoschild/StardewMods		\|github = Pathoschild/StardewMods
	}}		}}
	{{#invoke:SMAPI compatibility\|footer}}		{{#invoke:SMAPI compatibility\|footer}}
Line 26:		Line 26:
	<pre>		<pre>
	{{#invoke:SMAPI compatibility\|entry		{{#invoke:SMAPI compatibility\|entry
	\|name = Lookup Anything		\|name = Lookup Anything
	\|author = Pathoschild		\|author = Pathoschild
	\|id = Pathoschild.LookupAnything		\|id = Pathoschild.LookupAnything
	\|nexus id = 541		\|nexus = 541
	\|github = Pathoschild/StardewMods		\|github = Pathoschild/StardewMods

	\|summary =		\|summary =
	\|broke in = Stardew Valley 1.2		\|broke in = Stardew Valley 1.2
Line 37:		Line 38:
	{{#invoke:SMAPI compatibility\|header}}		{{#invoke:SMAPI compatibility\|header}}
	{{#invoke:SMAPI compatibility\|entry		{{#invoke:SMAPI compatibility\|entry
	\|name = Lookup Anything		\|name = Lookup Anything
	\|author = Pathoschild		\|author = Pathoschild
	\|id = Pathoschild.LookupAnything		\|id = Pathoschild.LookupAnything
	\|nexus id = 541		\|nexus = 541
	\|github = Pathoschild/StardewMods		\|github = Pathoschild/StardewMods

	\|summary =		\|summary =
	\|broke in = Stardew Valley 1.2		\|broke in = Stardew Valley 1.2
Line 55:		Line 57:
	{{#invoke:SMAPI compatibility\|header}}		{{#invoke:SMAPI compatibility\|header}}
	{{#invoke:SMAPI compatibility\|entry		{{#invoke:SMAPI compatibility\|entry
	\|name = Lookup Anything		\|name = Lookup Anything
	\|author = Pathoschild		\|author = Pathoschild
	\|id = Pathoschild.LookupAnything		\|id = Pathoschild.LookupAnything
	\|nexus id = 541		\|nexus = 541
	\|github = Pathoschild/StardewMods		\|github = Pathoschild/StardewMods

	\|summary =		\|summary =
	\|broke in = Stardew Valley 1.2		\|broke in = Stardew Valley 1.2
Line 86:		Line 89:
	\| The latest 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.		\| The latest 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>		\| <code>nexus</code>
	\| The mod's unique ID on Nexus (if any). This is the number in the mod page's URL.		\| The mod's unique ID on Nexus (if any). This is the number in the mod page's URL.
	\|-		\|-
Line 114:		Line 117:
	\| The unofficial update's version number, if any.		\| The unofficial update's version number, if any.
	\|-		\|-
	\| <code>~~cf id~~</code>		\| <code>chucklefish</code>
	\| The mod's ID in the [https://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mod repository].		\| The mod's ID in the [https://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish mod repository].
	\|-		\|-
	\| <code>~~curseforge id~~</code>		\| <code>curse</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".		\| The mod's project ID and key in the [https://www.curseforge.com/stardewvalley CurseForge mod repository]. The ID is shown on the mod page next to "Project ID", and the key is shown in the mod page's URL. This must be in the form <code>id,key</code>.
	\|-
	~~\| <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>		\| <code>moddrop</code>
	\| The mod's ID in the [https://www.moddrop.com/stardew-valley/ ModDrop mod repository].		\| The mod's ID in the [https://www.moddrop.com/stardew-valley/ ModDrop mod repository].
	\|-		\|-

imported>Margotbean: category change

2023-01-18T22:13:30Z

category change

← Older revision		Revision as of 22:13, 18 January 2023
Line 199:		Line 199:
	\|}		\|}

	[[Category:Modding ~~templates~~]]		[[Category:Modding Modules]]

imported>Pathoschild: hide beta fields (disabled while there's no Stardew Valley beta)

2022-12-30T17:26:24Z

hide beta fields (disabled while there's no Stardew Valley beta)

← Older revision		Revision as of 17:26, 30 December 2022
Line 142:		Line 142:
	\|}		\|}

			<!-- set 'enableBeta = true' in Lua code to enable these
	===Beta fields===		===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.		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.
Line 165:		Line 166:
	\| The unofficial update's version number, if any.		\| The unofficial update's version number, if any.
	\|}		\|}
			-->

	===Valid statuses===		===Valid statuses===

imported>Pathoschild: remove override fields (moved into a separate template), 'pull request' and 'links' fields (no longer used)

2022-12-30T17:17:01Z

remove override fields (moved into a separate template), 'pull request' and 'links' fields (no longer used)

@@ Line 52: / Line 52: @@
    |unofficial url     = https://community.playstarbound.com/attachments/201345000
    |unofficial version = 1.18.2-unofficial.1-example
 </pre>
 {{#invoke:SMAPI compatibility|header}}
@@ Line 65: / Line 64: @@
    |unofficial url     = https://community.playstarbound.com/attachments/201345000
    |unofficial version = 1.18.2-unofficial.1-example
 }}
 {{#invoke:SMAPI compatibility|footer}}
@@ Line 115: / Line 113: @@
 | <code>unofficial version</code>
 | The unofficial update's version number, if any.
 |-
 | <code>cf id</code>
@@ Line 136: / Line 131: @@
 | <code>source</code>
 | An arbitrary source code URL, if not on GitHub. Avoid if possible, since this makes crossreferencing more difficult.
 |-
 | <code>warnings</code>
@@ Line 172: / Line 164: @@
 | <code>beta unofficial version</code>
 | The unofficial update's version number, if any.
 |}

imported>Pathoschild: subcategorize

2022-07-21T02:14:28Z

subcategorize

← Older revision		Revision as of 02:14, 21 July 2022
Line 233:		Line 233:
	\|}		\|}

	[[Category:Modding]]		[[Category:Modding templates]]

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:40:41Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:40, 8 November 2021
Line 141:		Line 141:
	\|-		\|-
	\| <code>warnings</code>		\| <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>		\| <code>content pack for</code>
Line 189:		Line 189:
	\|-		\|-
	\| <code>map remote version</code>		\| <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.'''		'''This is a specialised field; it's better to correct the mod page if possible.'''
Line 230:		Line 230:
	\|-		\|-
	\| <code>unknown</code>		\| <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.		\| 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.
	\|}		\|}

	[[Category:Modding]]		[[Category:Modding]]

imported>Margotbean: Text replacement - "(e.g. " to "(''e.g.'', "

2021-11-07T23:41:28Z

Text replacement - "(e.g. " to "(''e.g.'', "

← Older revision		Revision as of 23:41, 7 November 2021
Line 141:		Line 141:
	\|-		\|-
	\| <code>warnings</code>		\| <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>		\| <code>content pack for</code>
Line 189:		Line 189:
	\|-		\|-
	\| <code>map remote version</code>		\| <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.'''		'''This is a specialised field; it's better to correct the mod page if possible.'''
Line 230:		Line 230:
	\|-		\|-
	\| <code>unknown</code>		\| <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.		\| 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.
	\|}		\|}

	[[Category:Modding]]		[[Category:Modding]]

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:09Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 83:		Line 83:
	\|-		\|-
	\| <code>author</code>		\| <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>		\| <code>id</code>
	\| The latest 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 latest 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>		\| <code>nexus id</code>
Line 92:		Line 92:
	\|-		\|-
	\| <code>github</code>		\| <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>		\| <code>summary</code>
Line 175:		Line 175:

	===Override fields===		===Override fields===
	These fields override information provided by the author in the <tt>manifest.json</tt> or mod page, so they should only be used as a last resort.		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"		{\| class="wikitable"
Line 183:		Line 183:
	\|-		\|-
	\| <code>change update keys</code>		\| <code>change update keys</code>
	\| Overrides the [[Modding:Modder Guide/APIs/Update checks\|update keys]] from the <tt>manifest.json</tt> 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:		\| 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>		<pre>
	\|override update keys = -Nexus:991, +Nexus:991@CFA		\|override update keys = -Nexus:991, +Nexus:991@CFA
Line 215:		Line 215:
	\|-		\|-
	\| <code>unofficial</code>		\| <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>		\| <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>		\| <code>broken</code>