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.
Mod info token
Revision as of 19:23, 5 January 2023 by Putnam3145 (talk | contribs)
v50.14 · v0.47.05 This article is about the current version of DF.Note that some content may still need to be updated. |
| Modding |
|---|
| Tokens |
| Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World |
| Body tokens |
| Body · Body detail plan · Bodygloss · Tissue |
| Creature tokens |
| Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer |
| Descriptor tokens |
| Descriptor color · Color · Descriptor pattern · Descriptor shape |
| Entity tokens |
| Entity · Ethic · Language · Value · Position |
| Job tokens |
| Building · Labor · Reaction · Skill · Unit type |
| Item tokens |
| Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon |
| Material tokens |
| Material type · Material definition · Inorganic material definition |
Mod info tokens are used in a mod's info.txt file.
Tokens
| 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 | The numeric version of the mod. |
| DISPLAYED_VERSION | string | Required | The version of the mod, as displayed in-game. |
| EARLIEST_COMPATIBLE_NUMERIC_VERSION | integer | Required | The earliest compatible numeric version of the mod. Installed mods are automatically updated, if a later compatible version is available. |
| EARLIEST_COMPATIBLE_DISPLAYED_VERSION | string | Required | 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. |
Steam Workshop tokens
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. |