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.

Graphics token

From Dwarf Fortress Wiki
Jump to navigation Jump to search
This article is about the current version of DF.
Note that some content may still need to be updated.


For an explanation of how to use the various graphics types, see Graphics.

The [OBJECT:GRAPHICS] token defines the use of various tile-based graphics in the game. As of version 50.01, graphics tokens have been greatly expanded to accommodate the release of the Steam & Itch premium version. These tokens, and explanations on how to use them, are listed below; the list will expand as the tokens are discovered and understood.

Creature Graphics[edit]

Creature graphics are found within graphics_creature_x files (such as graphics_creature_domestic or graphics_creature_layered). All graphics files must begin with the file name, followed by the [OBJECT:GRAPHICS] type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in creature graphics.

Types[edit]

Type Arguments Description
CREATURE_GRAPHICS The simplest and most common form of creature graphics for defining one sprite for each basic condition.

Further conditions are required for this to function following the creature graphics format. Accepts large graphics tokens.

Additionally used to start defining a layered graphics set.

CREATURE_CASTE_GRAPHICS Nearly the same as [CREATURE_GRAPHICS], but allows a separate sprite to be defined for each caste.

A simple alternative to Layered Graphics.

Requires conditions defined in creature graphics format. Accepts large graphics tokens.

STATUE_CREATURE_GRAPHICS Format for beginning a creature statue definition. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.
STATUE_CREATURE_CASTE_GRAPHICS Format for beginning a creature statue definition while specifying caste. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.
TILE_GRAPHICS_RECTANGLE Graphics for a 3x2 rectangle; for creatures, this is used exclusively for representing Forgotten Beasts based on their body parts. Uses forgotten beast graphics. It's also, however, used for interface graphics, see graphics_interface.txt.

Conditions[edit]

Different graphics can be defined for the same creature based on some properties about it. Below is a list of all the basic "creature texture" types that can be used as additional conditions to various basic sprites.

Condition Description
DEFAULT The default condition that will be displayed unless overwritten by a more specific one below.
LAW_ENFORCE Displayed if the unit is law enforcement.
TAX_ESCORT Displayed if the unit escorts a tax collector (unused).
ANIMATED Displayed if the creature is raised from the dead using an I_EFFECT:ANIMATE interaction.
GHOST Displayed if the creature is a ghost.
ADVENTURER Displayed if the creature is an adventurer.
CORPSE Displayed for corpses.

Basic creature sprite types[edit]

An individual sprite can be of any of the following classes. If "accepts secondary" is "yes", it can also have an extra condition tacked on at the end.

Condition Description
Basic Condition Any of the above conditions can be used on their own, as the default for that condition class.
Unit type Any Unit type token can be used. You may also append a basic condition as above to further specify.
Position Any Position token can be used, such as MONARCH, BROKER etc. All position tokens are raw-defined; any modded positions can have their own graphics. You may also append a basic condition as above to further specify.
LIST_ICON The default icon for this creature in lists, such as Arena mode or overall training.
EGG The sprite for a clutch of eggs.
SKELETON The sprite for a rotten corpse.
SKELETON_WITH_SKULL The sprite for a rotten corpse that can have a totem made from it.

Layered Conditions[edit]

Layers aren't very useful on their own, so they come with a set of conditions to define how when they are displayed and how they interact.

Token Arguments Type Description
LAYER_SET
  • condition
Creature
Graphics
Begins defining a layer set for a creature's graphics. Valid values of condition are DEFAULT, PORTRAITv51.01, or any valid values
LS_PALETTEv51.01
  • name
Layer
Set
Begins defining a palette for the layer set. Its name can be referenced by [USE_PALETTE]. Unlike the palettes used to render all descriptor color tokens, it can be of arbitrary length.
LS_PALETTE_FILEv51.01
  • file name
Palette The file name of the 8bit RGBA (sometimes called 32bit) in the /graphics/images folder of the mod, such as images/portraits/dwarf_portrait_body_palette.png.
LS_PALETTE_DEFAULTv51.01
  • integer
Palette Defines the default row of a layer set palette, conventionally 0. The exact color values on this row will be replaced on layer images with the colors in the same column, based on what row is passed as an argument to [USE_PALETTE].
LG_CONDITION_BPv51.01
  • selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
  • category, type, or token
Layer
Group
Allows the entire layer group (rather than an individual layer) to be switched on and off depending on the conditions of a body part. Should accept the same tokens [CONDITION_BP] does.[Verify]
END_LAYER_GROUP Layer
Group
Explicitly marks the end of a layer group, which allows layers after to not belong to any layer group.
CONDITION_ITEM_WORN Armor
Wieldables
Defines a clothing or armor graphic by the specific part it is equipped to, the type of armor it is, and the internal id of that item.

For example, a condition representing a right handed mitten or glove would be defined as: [CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_MITTENS] Also accepts the input ANY_HELD or WIELD (e.g. WIELD:WEAPON:ANY).

SHUT_OFF_IF_ITEM_PRESENT Armor Causes the current layer to not be rendered if the creature has one of the items worn or equipped. Also accepts the input ANY_HELD or WIELD (e.g. WIELD:WEAPON:ANY).
CONDITION_CASTE
  • caste name(s)
General Displays this layer if the creature is this caste. Only one caste is accepted for each condition, but multiple caste conditions can be used in one layer and the layer will be displayed if any of them match.
CONDITION_DYE
  • dye color
Armor Should represent which color the clothing is dyed. Currently nonfunctional.v50.05
CONDITION_NOT_DYED Armor Should check if the clothing is dyed. Currently nonfunctional.v50.05
CONDITION_MATERIAL_FLAG
  • material flag
Material Changes graphics based on the material an equipped item is made of. Valid material flags are similar to reactant conditions including:
  • WOVEN_ITEM
  • ANY_X_MATERIAL
with X being:
  • PLANT, SILK, YARN, LEATHER, WOOD, SHELL, BONE, STONE, GEM, TOOTH, HORN, PEARL
  • IS_DIVINE_MATERIAL
  • NOT_ARTIFACT
  • IS_CRAFTED_ARTIFACT
  • METAL_ITEM_MATERIAL
  • GLASS_MATERIAL
  • FIRE_BUILD_SAFE
  • MAGMA_BUILD_SAFE

among other, less useful ones.

CONDITION_MATERIAL_TYPE
  • material token
Material Changes graphics based on the material an equipped item is made of. Valid material types take the form METAL:COPPER where copper can be replaced with any weapons-grade metal. General material tokens are not functional. [CONDITION_MATERIAL_FLAG] is a better option for any material condition other than metal.
CONDITION_PROFESSION_CATEGORY General Checks the profession category of the creature to act as a condition. Multiple profession category tokens can be chained together. You can also use multiple of these tokens instead of listing them all in a single one, but this is functionally identical. Valid Profession tokens which are not categories will be ignored; values that do not match any existing Profession will be treated as NONE and thus apply to doctors, military, etc..
CONDITION_RANDOM_PART_INDEX
  • body part
  • integer index
  • integer range
General Chooses a random layer within the same group of body parts. Index is which option this condition is, out of Range number of options. Ex:

[CONDITION_RANDOM_PART_INDEX:HEAD:3:4] Is the third possible random head out of four total options. One of these random conditions each will be put into a set of four slightly different heads to add some random variation in the appearance of the creature's head.

CONDITION_HAUL_COUNT_MIN
  • integer
General Counts how many items the creature is hauling. Used for [PACK_ANIMAL]s in vanilla.
CONDITION_HAUL_COUNT_MAX
  • integer
General Counts how many items the creature is hauling. Used for [PACK_ANIMAL]s in vanilla.
CONDITION_CHILD General Checks if the creature is a child or baby.
CONDITION_NOT_CHILD General Checks if the creature is an adult.
CONDITION_GHOST General Checks if the creature is a ghost.
CONDITION_SYN_CLASS Syndrome Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
  • ZOMBIE
  • NECROMANCER
  • VAMPCURSE
  • RAISED_UNDEAD
  • GHOUL
CONDITION_TISSUE_LAYER Tissue Selects a tissue layer to use for checking other conditions. Ex:

[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]

TISSUE_MIN_LENGTH
  • integer
Tissue Checks the current [CONDITION_TISSUE_LAYER]'s LENGTH appearance modifier. Is true if the LENGTH is greater than the integer input.
TISSUE_MAX_LENGTH
  • integer
Tissue Checks the current [CONDITION_TISSUE_LAYER]'s LENGTH appearance modifier. Is true if the LENGTH is less than the integer input.
TISSUE_MAY_HAVE_COLOR Tissue Checks the selected tissue's color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.
TISSUE_MAY_HAVE_SHAPING
  • styling token
Tissue Checks the current [CONDITION_TISSUE_LAYER]'s shaping (hairstyle). Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.[Verify]
TISSUE_NOT_SHAPED Tissue Checks the current [CONDITION_TISSUE_LAYER]'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.
TISSUE_SWAP
  • IF_MIN_CURLY
  • integer
  • tile page id
  • x position
  • y position
Tissue Checks if a tissue is sufficiently curly, and if so swaps to display a different image. The new image is defined by the tile page ID, x position, and y position.

This condition should be within a [LAYER:... ] that has a similar graphic to the on in the TISSUE_SWAP. The current [CONDITION_TISSUE_LAYER] group must also include a [TISSUE_MIN_LENGTH].

ITEM_QUALITYv51.01
  • integer
Armor
Wieldables[Verify]
Checks the current [CONDITION_ITEM_WORN]'s quality. 0 is base quality, 5 is masterwork. See [CONDITION_MATERIAL_FLAG:IS_CRAFTED_ARTIFACT] for artifact-quality items.
USE_STANDARD_PALETTE_FROM_ITEMv51.01 Armor
Wieldables[Verify]
Uses the default palette to render the layer based on the color of the current [CONDITION_ITEM_WORN].
CONDITION_BPv51.01
  • selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
  • category, type, or token
Body Defines a body part graphic using standard body token selection criteria.
BP_APPEARANCE_MODIFIER_RANGEv51.01
  • QUALITY
  • minimum
  • maximum
Body Checks if current [CONDITION_BP]'s [BP_APPEARANCE_MODIFIER] falls within the chosen range.
BP_PRESENTv51.01 Body Checks if the current [CONDITION_BP] is present and not destroyed, pulped, or severed. Can also be applied to [LG_CONDITION_BP].
BP_SCARREDv51.01 Body Checks if the current [CONDITION_BP] is scarred. Seems to also require [BP_PRESENT] to avoid illogical results.[Verify]
USE_PALETTEv51.01
  • layer set palette
  • row
General Colors the layer using that row of the layer-set-specific [LS_PALETTE].

Vermin Conditions[edit]

Special Conditions for [VERMIN] creature graphics:

Condition Description
VERMIN The default graphic for this vermin.
VERMIN_ALT Image cycles every 1 second.
SWARM_SMALL For swarming vermin like flies and fairies in small groups.
SWARM_MEDIUM For swarming vermin like flies and fairies in medium-sized groups.
SWARM_LARGE For swarming vermin like flies and fairies in large groups.
LIGHT_VERMIN For fireflies etc. Does not replace [VERMIN].
LIGHT_VERMIN_ALT Like [VERMIN_ALT] for fireflies etc.
LIGHT_SWARM_SMALL Like [SWARM_SMALL] for fireflies etc. in small groups.
LIGHT_SWARM_MEDIUM Like [SWARM_LARGE] for fireflies etc. in large groups.
LIGHT_SWARM_LARGE Like [SWARM_LARGE] for fireflies etc.
REMAINS Vermin corpses.
HIVE Vermin hives.

Item Graphics[edit]

Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out. Descriptions of the token functions is provisional.

Item graphics currently do not support LARGE_IMAGE.

Token Arguments Description
TILE_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Begins defining tile graphics for an item. Sets default tile graphic.[Verify]
BOULDER_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Material ID
Defines tile graphics variants to use for BOULDER items by material; currently all boulders use material palette instead.
ROUGH_GEM_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Material ID
Defines tile graphics variants to use for ROUGH (gem) items by material; currently all rough gems use material palette instead.
BARS_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Material ID or item ID
Defines tile graphics variants to use for BAR items by material.
FOOD_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for FOOD items.
CHEESE_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Material ID
Defines tile graphics variants to use for CHEESE items by material. Unused in vanilla raws.
ARMOR_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for ARMOR items; this is for items not being worn by a creature.
GLOVES_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for GLOVES items; this is for items not being worn by a creature.
HELM_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for HELM items; this is for items not being worn by a creature.
PANTS_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for PANTS items; this is for items not being worn by a creature.
SHOES_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for SHOES items; this is for items not being worn by a creature.
SHOES_GRAPHICS_METAL
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines metal material tile graphics variants for SHOES items; this is for items not being worn by a creature.
SHIELD_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for SHIELD items; this is for items not being worn by a creature.
SHIELD_GRAPHICS_WOODEN
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines wood material tile graphics variants for SHIELD items; this is for items not being worn by a creature.
TOY_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
  • Material ID
Defines tile graphics for TOY items. Material ID in this case is one of STONE, WOOD, METAL, or GLASS.
TRAPCOMP_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines tile graphics for TRAPCOMP items.
TRAPCOMP_GRAPHICS_WEAPON_TRAP
  • Tile page ID
  • x index
  • y index
Defines tile graphics for TRAPCOMP items when built into a weapon trap; must follow TRAPCOMP_GRAPHICS.
TRAPCOMP_GRAPHICS_UPRIGHT_#X
  • Tile page ID
  • x index
  • y index
Defines tile graphics for installed upright spike traps. These comprise two-tile graphics: # is replaced with the number of spikes, 1-10; X is replaced with T (for top graphic tile) or B (bottom graphic tile). This follows the tile graphics definition of either MENACINGSPIKE or SPEAR.
SIEGEAMMO_GRAPHICS
  • Item ID
Begins defining graphics for SIEGEAMMO items.
SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT
  • Tile page ID
  • x index
  • y index
Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.
SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD
  • Tile page ID
  • x index
  • y index
Wooden variant of above.
SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT
  • Tile page ID
  • x index
  • y index
Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.
SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD
  • Tile page ID
  • x index
  • y index
Wood variant of above.
AMMO_GRAPHICS
  • Item ID
Begins defining graphics for AMMO items.
AMMO_GRAPHICS_STRAIGHT_DEFAULT
  • Tile page ID
  • x index
  • y index
Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.
AMMO_GRAPHICS_STRAIGHT_WOOD
  • Tile page ID
  • x index
  • y index
Wooden variant of above.
AMMO_GRAPHICS_DIAGONAL_DEFAULT
  • Tile page ID
  • x index
  • y index
Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.
AMMO_GRAPHICS_DIAGONAL_WOOD
  • Tile page ID
  • x index
  • y index
Wood variant of above.
WEAPON_GRAPHICS
  • Item ID
Begins defining graphics for WEAPON items.
WEAPON_GRAPHICS_DEFAULT
  • Tile page ID
  • x index
  • y index
Defines default graphics for WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
WEAPON_GRAPHICS_MATERIAL
  • Tile page ID
  • x index
  • y index
Defines material palette[Verify] graphics for WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
WEAPON_GRAPHICS_WOOD_GROWN
  • Tile page ID
  • x index
  • y index
Defines graphics for grown-wood WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
WEAPON_GRAPHICS_WOOD
  • Tile page ID
  • x index
  • y index
Defines graphics for wooden WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
WEAPON_GRAPHICS_WEAPON_TRAP
  • Tile page ID
  • x index
  • y index
Defines graphics for WEAPON item defined by WEAPON_GRAPHICS as it appears installed in a weapon trap; follows WEAPON_GRAPHICS.
TOOL_GRAPHICS
  • Tile page ID
  • x index
  • y index
  • Item ID
Defines default graphics for TOOL items; also begins defining variant graphics for material or container conditions when followed by tokens below.
ADD_TOOL_GRAPHICS
  • Item ID
Adds graphics to an existing tool defined with TOOL_GRAPHICS, followed by the tool graphics material or container condition tokens below.
TOOL_GRAPHICS_WOOD
  • Variant index
  • Tile page ID
  • x index
  • y index
Defines additonal variant graphics for wooden TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
TOOL_GRAPHICS_STONE
  • Variant index
  • Tile page ID
  • x index
  • y index
Defines additonal variant graphics for stone TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
TOOL_GRAPHICS_METAL
  • Variant index
  • Tile page ID
  • x index
  • y index
Defines additonal variant graphics for metal TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
TOOL_GRAPHICS_GLASS
  • Variant index
  • Tile page ID
  • x index
  • y index
Defines additonal variant graphics for glass TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
TOOL_GRAPHICS_CONTAINER_WOOD_LIQUID
  • Tile page ID
  • x index
  • y index
Defines graphics for wooden liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_CONTAINER_STONE_LIQUID
  • Tile page ID
  • x index
  • y index
Defines graphics for stone liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_CONTAINER_METAL_LIQUID
  • Tile page ID
  • x index
  • y index
Defines graphics for metal (and glass?) liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_CONTAINER_LIQUID
  • Tile page ID
  • x index
  • y index
Defines graphics for the liquid filling a liquid-containing container; follows TOOL_GRAPHICS_CONTAINER_*_LIQUID.
TOOL_GRAPHICS_CONTAINER_WOOD_ITEM
  • Tile page ID
  • x index
  • y index
Defines graphics for wooden containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_CONTAINER_STONE_ITEM
  • Tile page ID
  • x index
  • y index
Defines graphics for stone containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_CONTAINER_METAL_ITEM
  • Tile page ID
  • x index
  • y index
Defines graphics for metal (and glass?) containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
TOOL_GRAPHICS_HIVE_BLD
  • Tile page ID
  • x index
  • y index
Defines the built item graphics for HIVE items.
TOOL_GRAPHICS_HIVE_BLD_IN_USE
  • Tile page ID
  • x index
  • y index
Defines the built item graphics for HIVE items that have hives installed.
TOOL_GRAPHICS_HIVE_PRODUCTS
  • Tile page ID
  • x index
  • y index
Defines the built item graphics for HIVE items that are ready to be harvested.
TOOL_GRAPHICS_SHAPE
  • Shape ID
  • Tile page ID
  • x index
  • y index
Defines graphics for shaped items; currently used for dice.

World Map Graphics[edit]

World map graphics are defined in Dwarf Fortress\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt Tokens that accept variants have 5 of them:

   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>:1]
   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>:2]
   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>:3]
   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>:4]
   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>:5]

Otherwise:

  [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<TOKEN>]

See Also[edit]