translators
8,446
edits
Changes
Jump to navigation
Jump to search
Line 108:
Line 108: − + − {| class="wikitable"+ − |- − ! mod site − ! description − |- valign="top" − | [https://community.playstarbound.com/resources/categories/stardew-valley.22/ Chucklefish] − | Make sure you have a mod release page (with a URL containing <tt>/resources/</tt> instead of <tt>/thread/</tt>) and it has a [http://semver.org/ semantic version], then specify the mod ID (the number in the mod page URL). <source lang="javascript">"UpdateKeys": [ "Chucklefish:4250" ]</source> − − | [https://www.curseforge.com/stardewvalley CurseForge] − | Make sure the latest file's display name contains a [http://semver.org/ semantic version] at the end, with a space before the version and optional file extension. For example, SMAPI will recognise the version in these display names: <code>1.3.0</code>, <code>Example Mod 1.10</code>, <code>Example Mod 1.10.0-prerelease.zip</code>. <source lang="javascript">"UpdateKeys": [ "CurseForge:309243" ]</source> − |- valign="top" − | [https://github.com/ GitHub] − | Make sure your [https://help.github.com/articles/creating-releases/ GitHub project has at least one release] and the latest release's tag is a [http://semver.org/ semantic version], then specify your GitHub username and project name. <source lang="javascript">"UpdateKeys": [ "GitHub:Pathoschild/LookupAnything" ]</source> − |- valign="top" − | [https://www.moddrop.com/sdv/ ModDrop] − | Make sure the mod page has a [http://semver.org/ semantic version], then specify the mod ID (the number in the mod page URL). <source lang="javascript">"UpdateKeys": [ "ModDrop:123338" ]</source> − |- valign="top" − | [https://www.nexusmods.com/stardewvalley Nexus Mods] − | Make sure the Nexus mod has a [http://semver.org/ semantic version], then specify the mod ID (the number in the mod page URL). When creating a new mod on Nexus, the ID is added to the URL after the first step, before you need to upload the file. <source lang="javascript">"UpdateKeys": [ "Nexus:541" ]</source> − |} − − If you set multiple values, SMAPI will check them all and show an alert for the latest version it finds. (If multiple sites have the latest version, it will link to the earlier one in the list.) − <source lang="javascript">"UpdateKeys": [ "Chucklefish:4250", "Nexus:541", "GitHub:Pathoschild/LookupAnything" ]</source>
Modding:Modder Guide/APIs/Manifest (view source)
Revision as of 03:42, 24 May 2020
, 03:42, 24 May 2020→Update checks: link to new update checks page
===Update checks===
===Update checks===
SMAPI can detect new versions of your mod and alert the user with a link to your mod page. You can enable this by setting the <tt>UpdateKeys</tt> field in your <tt>manifest.json</tt> with one of the following values, which tells SMAPI where to check.
SMAPI can detect new versions of your mod and alert the user with a link to your mod page. You can enable this by setting the <tt>UpdateKeys</tt> field in your <tt>manifest.json</tt>, which tells SMAPI where to check.
See [[../Update checks|''update checks'']] for more information.
|- valign="top"
===Anything else===
===Anything else===
Any other fields will be stored in the <tt>IManifest.ExtraFields</tt> dictionary, which is available through the [[../#Mod registry|mod registry]]. Extra fields are ignored by SMAPI, but may be useful for extended metadata intended for other mods.
Any other fields will be stored in the <tt>IManifest.ExtraFields</tt> dictionary, which is available through the [[../#Mod registry|mod registry]]. Extra fields are ignored by SMAPI, but may be useful for extended metadata intended for other mods.