Graphics token

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼

v53.10 · v0.47.05 This article is about the current version of DF. Note that some content may still need to be updated. More Info · V

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

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

Type	Arguments	Description
CREATURE_GRAPHICS	creature id	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	creature id Caste ID	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	creature id	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	creature id Caste ID	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	creature id	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

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

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.
GLOWv51.01-beta26	The creature is in the [dark]. Graphical replacement for [GLOWTILE].
GLOW_LEFT_GONEv51.01-beta26	As [GLOW], but with their left eye missing. If the sprite is facing forwards, then the visually leftmost eye should remain.
GLOW_RIGHT_GONEv51.01-beta26	Counterpart of [GLOW_LEFT_GONE].
GLOW_CHILDv51.01-beta26	A child creature is in darkness. Does not have wound states.

Layered Conditions

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. Unless otherwise stated, a layer will only render if all of its conditions are true.

Token	Arguments	Type	Description
LAYER_GROUP		General[Verify]	Begins a layer group. Only the first-matching layer in a group will be rendered, so list more specific items at the beginning of the layer group and more general items towards the end.
LAYER_SET	condition	Creature Graphics	Begins defining a layer set for a creature's graphics. Valid values of condition are DEFAULT, PORTRAITv50.13, BABY:DEFAULTv51.01-beta20, CHILD:DEFAULTv51.01-beta20, or CORPSE Valid values for basic conditions may not work.[Verify]
LS_PALETTEv50.13	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_FILEv50.13	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_DEFAULTv50.13	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_BPv50.13	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	BY_CATEGORY / BY_TOKEN category / body part token Armor type (ARMOR, GLOVES, Etc.) Item ID(s)	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. Additional arguments can be supplied to check for additional subtypes. Valid if any matching items are worn. 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), though ANY_HELD has been bugged since v50.14.
SHUT_OFF_IF_ITEM_PRESENT	BY_CATEGORY / BY_TOKEN category / body part token Armor type Item ID(s)	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). Note that ANY_HELD has been bugged since v50.14.
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	Represents which color the clothing is dyed. Partially-working.v50.15 Takes a descriptor color. Vanilla dye options: MIDNIGHT_BLUE - (Dimple cup) EMERALD - (Blade weed) RED - (Hide root) BLACK - (Sliver barb)
CONDITION_NOT_DYED		Armor	Checks if the clothing is dyed.v50.15
CONDITION_MATERIAL_FLAG	material flag	Material	Changes graphics based on the material an equipped item is made of. Specifying multiple of this condition for a layer uses the "AND" instead of "OR" logical operator, whether placed in the same line or on separate lines. 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 (Note that this token might not have ever worked.) METAL_ITEM_MATERIAL GLASS_MATERIAL FIRE_BUILD_SAFE MAGMA_BUILD_SAFE GROWN_NOT_CRAFTEDv51.01-beta20 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 are INORGANIC or METAL:IRON where iron 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_CATEGORYv50.01-v50.13 Note: This condition is bugged and doesn't work since DFv50.14.	profession category token(s)	General	Checks the profession category of the creature to act as a condition. Multiple profession category tokens can be supplied as additional arguments, and will be valid for any of them. You can also use multiple of these tokens instead of listing them all in a single line, 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	identifier integer index integer range	General	Chooses a random layer among layers with a CONDITION_RANDOM_PART_INDEX with the same identifier. 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 different sprites 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	SYN_CLASS	Syndrome	Changes graphics based on any syndromes the creature is affected by. Vanilla values include: ZOMBIE NECROMANCER VAMPCURSE RAISED_UNDEAD DISTURBED_DEAD GHOUL
CONDITION_TISSUE_LAYER	BY_CATEGORY body part category or ALL tissue layer or ALL	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	color token(s)	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_QUALITYv50.13	integer	Armor Wieldables	Checks the current [CONDITION_ITEM_WORN]'s quality. 0 is base quality, 5 is masterwork. See [CONDITION_MATERIAL_FLAG:NOT_ARTIFACT] for non-artifact-quality items.
USE_PALETTEv50.13	layer set palette row	General	Colors the layer using that row of either the layer-set-specific [LS_PALETTE] or a predefined palette such as DEFAULT.
USE_STANDARD_PALETTE_FROM_ITEMv50.13		Armor Wieldables	Uses the default palette to render the layer based on the color of the current [CONDITION_ITEM_WORN].
CONDITION_BPv50.13	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_RANGEv50.13	QUALITY minimum maximum	Body	Checks if current [CONDITION_BP]'s [BP_APPEARANCE_MODIFIER] falls within the chosen range.
BP_PRESENTv50.13		Body	Checks if the current [CONDITION_BP] is present and not destroyed, pulped, or severed. Can also be applied to [LG_CONDITION_BP].
BP_SCARREDv50.13		Body	Checks if the current [CONDITION_BP] is scarred. Seems to also require [BP_PRESENT] to avoid illogical results.[Verify]

Vermin Conditions

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.
<