Module:SMAPI compatibility overrides/doc - Revision history

imported>Margotbean: category change

2023-01-18T22:12:50Z

category change

← Older revision		Revision as of 22:12, 18 January 2023
Line 82:		Line 82:
	{{#invoke:SMAPI compatibility overrides\|footer}}		{{#invoke:SMAPI compatibility overrides\|footer}}

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

imported>Pathoschild: subcategorize

2022-07-21T02:14:50Z

subcategorize

← Older revision		Revision as of 02:14, 21 July 2022
Line 82:		Line 82:
	{{#invoke:SMAPI compatibility overrides\|footer}}		{{#invoke:SMAPI compatibility overrides\|footer}}

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

imported>Pathoschild: + reason field

2022-05-01T00:26:12Z

+ reason field

← Older revision		Revision as of 00:26, 1 May 2022
Line 54:		Line 54:

	SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.		SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.
			\|-
			\| <code>reason</code>
			\| A human-readable reason the values need to be overridden, so it's easier to check whether it still needs to be overridden later.
	\|}		\|}

Line 64:		Line 67:
	\|local version = 1.05-beta → 1.0.5-beta		\|local version = 1.05-beta → 1.0.5-beta
	\|remote version = 1.06 → 1.0.6		\|remote version = 1.06 → 1.0.6
			\|reason = test values
	}}		}}
	</pre>		</pre>
Line 74:		Line 78:
	\|local version = 1.05-beta → 1.0.5-beta		\|local version = 1.05-beta → 1.0.5-beta
	\|remote version = 1.06 → 1.0.6		\|remote version = 1.06 → 1.0.6
			\|reason = test values
	}}		}}
	{{#invoke:SMAPI compatibility overrides\|footer}}		{{#invoke:SMAPI compatibility overrides\|footer}}

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

imported>Margotbean: update link

2022-02-18T23:28:06Z

update link

← Older revision		Revision as of 23:28, 18 February 2022
Line 34:		Line 34:
	\|-		\|-
	\| <code>name</code>		\| <code>name</code>
	\| The mod's name as it appears in the [[Modding:~~SMAPI~~ compatibility]] list. If the mod has multiple names, specify the first one.		\| The mod's name as it appears in the [[Modding:Mod compatibility]] list. If the mod has multiple names, specify the first one.
	\|-		\|-
	\| <code>id</code>		\| <code>id</code>

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

2021-11-08T00:40:43Z

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

← Older revision		Revision as of 00:40, 8 November 2021
Line 53:		Line 53:
	\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You should generally only use replace in this field, since only the first value will be used.		\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You should generally only use replace in this field, since only the first value will be used.

	SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.		SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.
	\|}		\|}

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

2021-11-07T23:41:39Z

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

← Older revision		Revision as of 23:41, 7 November 2021
Line 53:		Line 53:
	\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You should generally only use replace in this field, since only the first value will be used.		\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You should generally only use replace in this field, since only the first value will be used.

	SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.		SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.
	\|}		\|}

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

2021-11-04T18:48:40Z

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

← Older revision		Revision as of 18:48, 4 November 2021
Line 23:		Line 23:
	\|}		\|}

	Each field can list multiple change descriptors delimited with commas. For example, <code>-Nexus:541, +Nexus:905</code> would delete <tt>Nexus:541</tt> from the update keys and add <tt>Nexus:905</tt>. These operate on distinct values, so <code>-Nexus:</code> won't match anything (unless there's actually an update key without a number).		Each field can list multiple change descriptors delimited with commas. For example, <code>-Nexus:541, +Nexus:905</code> would delete <samp>Nexus:541</samp> from the update keys and add <samp>Nexus:905</samp>. These operate on distinct values, so <code>-Nexus:</code> won't match anything (unless there's actually an update key without a number).

	===Fields===		===Fields===
Line 37:		Line 37:
	\|-		\|-
	\| <code>id</code>		\| <code>id</code>
	\| The [[Modding:Modder Guide/APIs/Manifest\|manifest]] <tt>UniqueID</tt> field of the mod to change. This can be comma-delimited.		\| The [[Modding:Modder Guide/APIs/Manifest\|manifest]] <samp>UniqueID</samp> field of the mod to change. This can be comma-delimited.
	\|}		\|}

imported>Pathoschild: /* Fields */ clarify

2021-10-02T20:58:14Z

Fields: clarify

← Older revision		Revision as of 20:58, 2 October 2021
Line 51:		Line 51:
	\|-		\|-
	\| <code>local version</code><br /><code>remote version</code>		\| <code>local version</code><br /><code>remote version</code>
	\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You ~~can~~ only use replace ~~changes~~ in this field.		\| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest\|mod manifest]] (local) or mod page (remote). You should generally only use replace in this field, since only the first value will be used.

	SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.		SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.

imported>Pathoschild: correct link

2021-10-02T16:11:00Z

correct link

← Older revision		Revision as of 16:11, 2 October 2021
Line 1:		Line 1:
	This module provides the table structure and data for the [[Modding:Mod compatibility#~~Data~~ overrides]] list, which SMAPI uses to override data specified in mods' [[Modding:Modder Guide/APIs/Manifest\|manifests]] or mod pages.		This module provides the table structure and data for the [[Modding:Mod compatibility#Mod data overrides]] list, which SMAPI uses to override data specified in mods' [[Modding:Modder Guide/APIs/Manifest\|manifests]] or mod pages.

	==Usage==		==Usage==

imported>Pathoschild: create page

2021-10-02T16:10:15Z

create page

New page

This module provides the table structure and data for the [[Modding:Mod compatibility#Data overrides]] list, which SMAPI uses to override data specified in mods' [[Modding:Modder Guide/APIs/Manifest|manifests]] or mod pages.

==Usage==
===Change descriptor===
A ''change descriptor'' describes a specific change to make for a field. There are three supported changes:
{| class="wikitable"
|-
! operation
! format
! effect
|-
| remove
| <code>-value</code>
| Delete that distinct value from the field.
|-
| add
| <code>+value</code>
| Add that distinct value to the field.
|-
| replace
| <code>old value → new value</code>
| Replace the old value (if found) with the new one.
|}

Each field can list multiple change descriptors delimited with commas. For example, <code>-Nexus:541, +Nexus:905</code> would delete <tt>Nexus:541</tt> from the update keys and add <tt>Nexus:905</tt>. These operate on distinct values, so <code>-Nexus:</code> won't match anything (unless there's actually an update key without a number).

===Fields===
There are two required static fields:

{| class="wikitable"
|-
! field
! effect
|-
| <code>name</code>
| The mod's name as it appears in the [[Modding:SMAPI compatibility]] list. If the mod has multiple names, specify the first one.
|-
| <code>id</code>
| The [[Modding:Modder Guide/APIs/Manifest|manifest]] <tt>UniqueID</tt> field of the mod to change. This can be comma-delimited.
|}

And these optional [[#change descriptor|change descriptor]] fields:

{| class="wikitable"
|-
! field
! effect
|-
| <code>update keys</code>
| Override the [[Modding:Modder Guide/APIs/Update checks|update keys]] SMAPI uses to perform update checks.
|-
| <code>local version</code><br /><code>remote version</code>
| Override the version number specified in the [[Modding:Modder Guide/APIs/Manifest|mod manifest]] (local) or mod page (remote). You can only use replace changes in this field.

SMAPI will compare using [https://semver.org/ semantic versioning] if they're 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.
|}

===Example===
<pre>
{{#invoke:SMAPI compatibility overrides|entry
|name = Lookup Anything
|id = Pathoschild.LookupAnything
|update keys = -Nexus:541, +Nexus:905
|local version = 1.05-beta → 1.0.5-beta
|remote version = 1.06 → 1.0.6
}}
</pre>

{{#invoke:SMAPI compatibility overrides|header}}
{{#invoke:SMAPI compatibility overrides|entry
|name = Lookup Anything
|id = Pathoschild.LookupAnything
|update keys = -Nexus:541, +Nexus:905
|local version = 1.05-beta → 1.0.5-beta
|remote version = 1.06 → 1.0.6
}}
{{#invoke:SMAPI compatibility overrides|footer}}

[[Category:Modding]]