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.

Difference between revisions of "Mod info token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(add purge button)
(→‎Tokens: I put this table in a template so it can be transcluded. May have been better to put it in a page or subpage, instead of the template namespace, but I did use tpl NS)
Tag: Replaced
Line 6: Line 6:
 
{{clear}}
 
{{clear}}
  
==Tokens==
+
<!-- to edit this section click the edit link inline on the read tab -->
{| {{prettytable}}
+
{{Info.txt tokens}}
|- 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}}
 
| The numeric version of the mod.
 
 
 
|-
 
| {{text anchor|DISPLAYED_VERSION}}
 
| string
 
| {{tc|red|Required}}
 
| The version of the mod, as displayed in-game.
 
 
 
|-
 
| {{text anchor|EARLIEST_COMPATIBLE_NUMERIC_VERSION}}
 
| integer
 
| {{tc|red|Required}}
 
| The earliest compatible numeric version of the mod. Installed mods are automatically updated, if a later compatible version is available.
 
 
 
|-
 
| {{text anchor|EARLIEST_COMPATIBLE_DISPLAYED_VERSION}}
 
| string
 
| {{tc|red|Required}}
 
| 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.
 
|-
 
 
 
|}
 
 
 
<!-- to edit this section click the edit link inline -->
 
{{Steam workshop tokens}}
 
 
 
{{purge}}
 
 
 
{{Category|Modding}}
 
{{Category|Tokens}}
 

Revision as of 00:44, 29 January 2023

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.

Info.txt 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 An integer version number for the mod. Must be greater than or equal to EARLIEST_COMPATIBLE_NUMERIC_VERSION. Must be integer.
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.