Difference between revisions of "Mod info token"

Revision as of 00:30, 21 December 2022

v50.12 · v0.47.05

This article is about the current version of DF.
Note that some content may still need to be updated.

Mod info tokens are used in a mod's info.txt file.

Token	Arguments	Usage	Description
ID	id	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.
NUMERIC_VERSION	integer	Required^[Verify]	The numeric version of the mod.
DISPLAYED_VERSION	string	Required^[Verify]	The version of the mod, as displayed in-game.
EARLIEST_COMPATIBLE_NUMERIC_VERSION	integer	Required^[Verify]	The earliest compatible numeric version of the mod. Installed mods are automatically updated, if a later compatible version is available.
DISPLAYED_VERSION	string	Required^[Verify]	The earliest compatible numeric version, as displayed in-game.
AUTHOR	string	Required^[Verify]	The name of the author (usually you).
NAME	string	Required^[Verify]	The name of the mod.
DESCRIPTION	string		A description of the mod, shown in the mod loading screen.
REQUIRES_ID	string		Mod cannot be used unless mod with given ID is also loaded.
REQUIRES_ID_BEFORE_ME	string		Mod cannot be used unless mod with given ID is earlier in the mod load list.
REQUIRES_ID_AFTER_ME	string		Mod cannot be used unless mod with given ID is later in the mod load list.
CONFLICTS_WITH_ID	string		Mod cannot be used if mod with given ID is also loaded.

These tokens are used to get the mod to work on Steam Workshop.

Token	Arguments	Usage	Description
STEAM_TITLE	string	Required	The title of the mod on Steam Workshop.
STEAM_DESCRIPTION	string		The description of the mod on Steam Workshop.
STEAM_TAG	string		Any number can be used.
STEAM_KEY_VALUE_TAG	string1, string2		Any number can be used.
STEAM_METADATA	string
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.
STEAM_FILE_ID	string	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.

@@ Line 58: / Line 58: @@
 |-
+|-
 | {{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.
+|-
 |}