Modding:Mod compatibility/entry - Revision history

imported>Pathoschild: restore latest version

2026-07-01T18:43:16Z

restore latest version

Show changes

imported>Pathoschild: temporarily revert to original version

2026-07-01T18:39:16Z

temporarily revert to original version

Show changes

imported>Peaw at 12:40, 12 July 2024

2024-07-12T12:40:15Z

← Older revision		Revision as of 12:40, 12 July 2024
Line 317:		Line 317:

	[[de:Modding:SMAPI Kompatibilität/entry]]		[[de:Modding:SMAPI Kompatibilität/entry]]
			[[tr:Modlama:Mod Uyumluluğu/entry]]

	[[Category:Modding]]		[[Category:Modding]]
	</noinclude>		</noinclude>

imported>Pathoschild: /* Usage */ remove deleted 'pull request' parameter

2024-03-02T19:47:38Z

Usage: remove deleted 'pull request' parameter

← Older revision		Revision as of 19:47, 2 March 2024
Line 228:		Line 228:
	\| <code>unofficial version</code>		\| <code>unofficial version</code>
	\| The unofficial update's version number, if any.		\| 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>		\| <code>chucklefish id</code>

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

2021-11-08T00:39:48Z

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

← Older revision		Revision as of 00:39, 8 November 2021
Line 251:		Line 251:
	\|-		\|-
	\| <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 275:		Line 275:
	\|-		\|-
	\| <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 316:		Line 316:
	\|-		\|-
	\| <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.
	\|}		\|}

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

2021-11-07T23:41:44Z

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

← Older revision		Revision as of 23:41, 7 November 2021
Line 251:		Line 251:
	\|-		\|-
	\| <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 275:		Line 275:
	\|-		\|-
	\| <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 316:		Line 316:
	\|-		\|-
	\| <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.
	\|}		\|}

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

2021-11-04T18:48:59Z

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

← Older revision		Revision as of 18:48, 4 November 2021
Line 152:		Line 152:

	===Unofficial update===		===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>		<pre>
	\|unofficial url = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-62#post-3329160		\|unofficial url = https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-62#post-3329160
Line 196:		Line 196:
	\|-		\|-
	\| <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 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>		\| <code>nexus id</code>
Line 205:		Line 205:
	\|-		\|-
	\| <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 261:		Line 261:

	===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 269:		Line 269:
	\|-		\|-
	\| <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 301:		Line 301:
	\|-		\|-
	\| <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>

imported>Pathoschild: undo last edit

2021-07-01T15:51:00Z

undo last edit

Show changes

imported>Pathoschild: temporarily restore 2017-07-09 version

2021-07-01T15:48:01Z

temporarily restore 2017-07-09 version

Show changes

imported>Pathoschild: drop beta fields (no longer needed for SMAPI 3.6-beta, since nearly all mods should be compatible at release)

2020-06-15T04:11:06Z

drop beta fields (no longer needed for SMAPI 3.6-beta, since nearly all mods should be compatible at release)

Show changes