v50 Steam/Premium information for editors
- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.
Editing Mod info token
Jump to navigation
Jump to search
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
{{av}} | {{av}} | ||
{{Modding}} | {{Modding}} | ||
+ | {{new}} | ||
− | '''Mod info tokens''' are used in a | + | '''Mod info tokens''' are used in a mod's info.txt file. |
{{clear}} | {{clear}} | ||
− | + | ==Tokens== | |
− | {{ | + | {| {{prettytable}} |
+ | |- bgcolor="#999999" | ||
+ | ! Token | ||
+ | ! Arguments | ||
+ | ! Usage | ||
+ | ! Description | ||
− | + | |- | |
− | {{ | + | | {{text anchor|ID}} |
+ | | id | ||
+ | | {{tc|red|Required}} | ||
+ | | The ID of the mod. This should be unique, with no two mods sharing the same ID. IDs starting with "vanilla_" are reserved for vanilla raws. | ||
− | == | + | |- |
− | + | | {{text anchor|NUMERIC_VERSION}} | |
− | + | | integer | |
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The numeric version of the mod. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|DISPLAYED_VERSION}} | ||
+ | | string | ||
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The version of the mod, as displayed in-game. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|EARLIEST_COMPATIBLE_NUMERIC_VERSION}} | ||
+ | | integer | ||
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The earliest compatible numeric version of the mod. Installed mods are automatically updated, if a later compatible version is available. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|DISPLAYED_VERSION}} | ||
+ | | string | ||
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The earliest compatible numeric version, as displayed in-game. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|AUTHOR}} | ||
+ | | string | ||
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The name of the author (usually you). | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|NAME}} | ||
+ | | string | ||
+ | | {{tc|red|Required{{verify}}}} | ||
+ | | The name of the mod. | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|DESCRIPTION}} | ||
+ | | string | ||
+ | | | ||
+ | | A description of the mod, shown in the mod loading screen. | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|REQUIRES_ID}} | ||
+ | | string | ||
+ | | | ||
+ | | Mod cannot be used unless mod with given ID is also loaded. | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|REQUIRES_ID_BEFORE_ME}} | ||
+ | | string | ||
+ | | | ||
+ | | Mod cannot be used unless mod with given ID is earlier in the mod load list. | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|REQUIRES_ID_AFTER_ME}} | ||
+ | | string | ||
+ | | | ||
+ | | Mod cannot be used unless mod with given ID is later in the mod load list. | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|CONFLICTS_WITH_ID}} | ||
+ | | string | ||
+ | | | ||
+ | | Mod cannot be used if mod with given ID is also loaded. | ||
+ | |- | ||
+ | |||
+ | |} | ||
+ | |||
+ | === Steam Workshop tokens === | ||
+ | |||
+ | These tokens are used to get the mod to work on Steam Workshop. | ||
+ | |||
+ | {| {{prettytable}} | ||
+ | |- bgcolor="#999999" | ||
+ | ! Token | ||
+ | ! Arguments | ||
+ | ! Usage | ||
+ | ! Description | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_TITLE}} | ||
+ | | string | ||
+ | | {{tc|red|Required}} | ||
+ | | The title of the mod on Steam Workshop. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_DESCRIPTION}} | ||
+ | | string | ||
+ | | | ||
+ | | The description of the mod on Steam Workshop. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_TAG}} | ||
+ | | string | ||
+ | | | ||
+ | | Any number can be used. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_KEY_VALUE_TAG}} | ||
+ | | string1, | ||
+ | string2 | ||
+ | | | ||
+ | | Any number can be used. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_METADATA}} | ||
+ | | string | ||
+ | | | ||
+ | | | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_CHANGELOG}} | ||
+ | | string | ||
+ | | | ||
+ | | A changelog for the version you're uploading. This should be different each time you update a mod, and only include the changes in the new version. Steam Workshop congregates all version changelogs, so a full changelog can be seen there. | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|STEAM_FILE_ID}} | ||
+ | | string | ||
+ | | {{tc|red|Required (subsequent times)}} | ||
+ | | Connects the mod to an entry on the Steam Workshop. | ||
+ | |||
+ | Generated automatically the first time you upload a mod to Workshop, '''do not include it manually'''. If you upload a mod with an existing STEAM_FILE_ID token, it will update the Workshop entry connected to the ID. You can presumably only do this if you're the original uploader of said mod. | ||
+ | |||
+ | |} | ||
{{Category|Modding}} | {{Category|Modding}} | ||
{{Category|Tokens}} | {{Category|Tokens}} |