Changes

Jump to navigation Jump to search
update for disabled beta fields
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 52: Line 54:  
   |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
  |pull request      = https://github.com/Pathoschild/Example/pull/1
   
</pre>
 
</pre>
 
{{#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
 
   |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
  |pull request      = https://github.com/Pathoschild/Example/pull/1
   
}}
 
}}
 
{{#invoke:SMAPI compatibility|footer}}
 
{{#invoke:SMAPI compatibility|footer}}
Line 88: 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 116: Line 117:  
| The unofficial update's version number, if any.
 
| The unofficial update's version number, if any.
 
|-
 
|-
| <code>pull request</code>
+
| <code>chucklefish</code>
| The URL of the pull request which submits changes for an unofficial update to the author, if any.
  −
|-
  −
| <code>cf id</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>
+
| <code>moddrop</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>
   
| 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].
 
|-
 
|-
Line 136: Line 131:  
| <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>links</code>
  −
| A comma-delimited list of URLs to add as superscript links. Mainly useful for linking to pull requests.
   
|-
 
|-
 
| <code>warnings</code>
 
| <code>warnings</code>
Line 150: 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 173: Line 166:  
| The unofficial update's version number, if any.
 
| The unofficial update's version number, if any.
 
|}
 
|}
 
+
-->
===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.
  −
|}
  −
 
   
===Valid statuses===
 
===Valid statuses===
 
{| class="wikitable"
 
{| class="wikitable"
Line 233: Line 198:  
|}
 
|}
   −
[[Category:Modding]]
+
[[Category:Modding Modules]]
translators
8,444

edits

Navigation menu