translators
8,445
edits
Changes
Jump to navigation
Jump to search
Line 52:
Line 52: − |pull request = https://github.com/Pathoschild/Example/pull/1 Line 65:
Line 64: − |pull request = https://github.com/Pathoschild/Example/pull/1 Line 115:
Line 113: − |- − | <code>pull request</code> − | The URL of the pull request which submits changes for an unofficial update to the author, if any. Line 136:
Line 131: − |- − | <code>links</code> − | A comma-delimited list of URLs to add as superscript links. Mainly useful for linking to pull requests. Line 172:
Line 164: − |} − − ===Override fields=== − 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" − |- − ! field − ! purpose − |- − | <code>change update keys</code> − | 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> − |override update keys = -Nexus:991, +Nexus:991@CFA − </pre> − |- − | <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. − − '''This is a specialised field; it's better to correct the mod page if possible.''' − − Mappings are specified with an arrow, and multiple mappings can be separated by a semi-colon: − <pre> − |map remote versions = 0.01 → 0.0.1; 0.0.1-beta → 0.0.1 − </pre> − |- − | <code>map local version</code> − | Equivalent to <code>map remote version</code>, but for the manifest version.
Module:SMAPI compatibility/doc (view source)
Revision as of 17:17, 30 December 2022
, 17:17, 30 December 2022remove override fields (moved into a separate template), 'pull request' and 'links' fields (no longer used)
|unofficial url = https://community.playstarbound.com/attachments/201345000
|unofficial url = https://community.playstarbound.com/attachments/201345000
|unofficial version = 1.18.2-unofficial.1-example
|unofficial version = 1.18.2-unofficial.1-example
</pre>
</pre>
{{#invoke:SMAPI compatibility|header}}
{{#invoke:SMAPI compatibility|header}}
|unofficial url = https://community.playstarbound.com/attachments/201345000
|unofficial url = https://community.playstarbound.com/attachments/201345000
|unofficial version = 1.18.2-unofficial.1-example
|unofficial version = 1.18.2-unofficial.1-example
}}
}}
{{#invoke:SMAPI compatibility|footer}}
{{#invoke:SMAPI compatibility|footer}}
| <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>cf id</code>
| <code>cf id</code>
| <code>source</code>
| <code>source</code>
| An arbitrary source code URL, if not on GitHub. Avoid if possible, since this makes crossreferencing more difficult.
| An arbitrary source code URL, if not on GitHub. Avoid if possible, since this makes crossreferencing more difficult.
|-
|-
| <code>warnings</code>
| <code>warnings</code>
| <code>beta unofficial version</code>
| <code>beta unofficial version</code>
| The unofficial update's version number, if any.
| The unofficial update's version number, if any.
|}
|}