Dwarf Fortress Wiki - User contributions [en]

Graphics token

2024-06-09T17:07:29Z

BarelyCreative: /* Layered Conditions */ added missing DISTURBED_DEAD syndrome class

{{Quality|Exceptional}}
{{av}}
{{Modding}}
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}}

The <code>[OBJECT:GRAPHICS]</code> [[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 <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]].

=== Types ===
{| {{prettytable}}
|- bgcolor="#dddddd"
! Type
! Arguments
! Description

|-
| {{text anchor|CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].

Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.

|-
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].

Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

|-
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|STATUE_CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]] while specifying caste. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
|
* [[Creature token|creature id]]
| Graphics for a 3x2 rectangle; for creatures, this is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|DEFAULT}} || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|LAW_ENFORCE}} || Displayed if the unit is law enforcement.

|-
| {{text anchor|TAX_ESCORT}} || Displayed if the unit escorts a tax collector (unused).

|-
| {{text anchor|ANIMATED}} || Displayed if the creature is raised from the dead using an I_EFFECT:ANIMATE interaction.

|-
| {{text anchor|GHOST}} || Displayed if the creature is a ghost.

|-
| {{text anchor|ADVENTURER}} || Displayed if the creature is an adventurer.

|-
| {{text anchor|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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text_anchor|Basic Condition}} || Any of the [[Graphics token#Conditions|above conditions]] can be used on their own, as the default for that condition class.

|-
| {{text_anchor|Unit type}} || Any [[Unit type token]] can be used. You may also append a [[Graphics token#Conditions|basic condition as above]] to further specify.

|-
| {{text_anchor|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 [[Graphics token#Conditions|basic condition as above]] to further specify.

|-
| {{text_anchor|LIST_ICON}} || The default icon for this creature in lists, such as [[Arena]] mode or overall training.

|-
| {{text_anchor|EGG}} || The sprite for a clutch of eggs.

|-
| {{text_anchor|SKELETON}} || The sprite for a rotten corpse.

|-
| {{text_anchor|SKELETON_WITH_SKULL}} || The sprite for a rotten corpse that can have a [[totem]] made from it.

|}

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

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_SET}} ||
* condition
| Creature Graphics
| Begins defining a layer set for a creature's graphics. Valid values of ''condition'' are DEFAULT, PORTRAIT{{version|50.13}}, or CORPSE. Valid values for basic conditions may not work.{{verify}}

|-
| {{text_anchor|LS_PALETTE}}{{version|50.13}} ||
* name
|| Layer Set
|| Begins defining a palette for the layer set. Its name can be referenced by {{token|USE_PALETTE|g}}. Unlike the palettes used to render all [[descriptor color token]]s, it can be of arbitrary length.

|-
| {{text_anchor|LS_PALETTE_FILE}}{{version|50.13}} ||
* file name
| Palette
| The file name of the 8bit RGBA (sometimes called 32bit) in the <tt>/graphics/images</tt> folder of the mod, such as <tt>images/portraits/dwarf_portrait_body_palette.png</tt>.

|-
| {{text_anchor|LS_PALETTE_DEFAULT}}{{version|50.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 {{token|USE_PALETTE|g}}.

|-
| {{text_anchor|LG_CONDITION_BP}}{{version|50.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 {{token|CONDITION_BP|g}} does. {{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| Explicitly marks the end of a layer group, which allows layers after to not belong to any layer group.

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_MITTENS]</code>
Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

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

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. General [[material token]]s are '''not''' functional. {{token|CONDITION_MATERIAL_FLAG|g}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token#Profession Categories|profession category token(s)]]
|| 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 <code>NONE</code> and thus apply to doctors, military, etc..

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || || General
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || || General
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || || General
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* [[Syndrome#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

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s shaping (hairstyle). Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.{{verify}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER|g}} group must also include a {{token|TISSUE_MIN_LENGTH|g}}.

|-
| {{text_anchor|ITEM_QUALITY}}{{version|50.13}} ||
* integer
| Armor Wieldables{{verify}}
|| Checks the current {{token|CONDITION_ITEM_WORN|g}}'s [[quality]]. 0 is base quality, 5 is masterwork. See [CONDITION_MATERIAL_FLAG:IS_CRAFTED_ARTIFACT] for [[artifact]]-quality items.

|-
| {{text_anchor|USE_PALETTE}}{{version|50.13}} ||
* layer set palette
* row
| General
|| Colors the layer using that row of the layer-set-specific {{token|LS_PALETTE|g}}.

|-
| {{text_anchor|USE_STANDARD_PALETTE_FROM_ITEM}}{{version|50.13}} || || Armor Wieldables{{verify}}
|| Uses the default palette to render the layer based on the [[Material definition token#STATE_COLOR|color]] of the current {{token|CONDITION_ITEM_WORN|g}}.

|-
| {{text_anchor|CONDITION_BP}}{{version|50.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.

|-
| {{text_anchor|BP_APPEARANCE_MODIFIER_RANGE}}{{version|50.13}} ||
* QUALITY
* minimum
* maximum
| Body
|| Checks if current {{token|CONDITION_BP|g}}'s {{token|BP_APPEARANCE_MODIFIER|c}} falls within the chosen range.

|-
| {{text_anchor|BP_PRESENT}}{{version|50.13}} || || Body
|| Checks if the current {{token|CONDITION_BP|g}} is present and not destroyed, pulped, or severed. Can also be applied to {{token|LG_CONDITION_BP|g}}.

|-
| {{text_anchor|BP_SCARRED}}{{version|50.13}} || || Body
|| Checks if the current {{token|CONDITION_BP|g}} is scarred. Seems to also require {{token|BP_PRESENT|g}} to avoid illogical results. {{verify}}

|}

=== Vermin Conditions ===
Special Conditions for {{token|VERMIN|c}} creature graphics:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || The default graphic for this vermin.

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| {{text_anchor|TILE_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}

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

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

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

|-
| {{text_anchor|FOOD_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for FOOD items.

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

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

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

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

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

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

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

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

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

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

|-
| {{text_anchor|TRAPCOMP_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for TRAPCOMP items.

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

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

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for SIEGEAMMO items.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for AMMO items.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|WEAPON_GRAPHICS}}
|
* Item ID
| Begins defining graphics for WEAPON items.

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

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

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

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

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

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

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

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

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

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

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

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

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

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

|-
| {{text_anchor|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.
|-
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
|
* Tile page ID
* x index
* y index
| Defines the built item graphics for HIVE items.

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

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

|-
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
|
* Shape ID
* Tile page ID
* x index
* y index
| Defines graphics for shaped items; currently used for dice.

|}

== World Map Graphics ==
World map graphics are defined in <code>[[Game_folders_and_files#Game_folder|Dwarf Fortress]]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>
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==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-04-22T01:35:57Z

BarelyCreative: /* Layered Conditions */ Fixed broken links to other graphics tokens

{{Quality|Unrated}}
{{av}}
{{Modding}}
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}}

The <code>[OBJECT:GRAPHICS]</code> [[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 <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]].

=== Types ===
{| {{prettytable}}
|- bgcolor="#dddddd"
! Type
! Arguments
! Description

|-
| {{text anchor|CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].

Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.

|-
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].

Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

|-
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
|
* [[Creature token|creature id]]
| Graphics for a 3x2 rectangle that is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]].

|}

=== Basic Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} if there is no {{token|BABY|g}} token defined for that creature's graphics, or only for the child state if there are baby graphics defined.

|-
| {{text anchor|BABY}} || Yes || Will only be displayed if the creature is a {{token|BABY|c}}.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

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

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_SET}} ||
* condition
| Creature Graphics
| Begins defining a layer set for a creature's graphics. Valid values of ''condition'' are DEFAULT, CORPSE, and ANIMATED.{{verify}}

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Only the first layer in a layer group with all its conditions satisfied will be rendered.

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| Explicitly marks the end of a layer group, which allows layers after to not belong to any layer group.

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_MITTENS]</code>
Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

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

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. General [[material token]]s are '''not''' functional. {{token|CONDITION_MATERIAL_FLAG|g}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token#Profession Categories|profession category token(s)]]
|| 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 <code>NONE</code> and thus apply to doctors, military, etc..

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* [[Syndrome#SYN_CLASS|SYN_CLASS]]
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s shaping (hairstyle). Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.{{verify}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER|g}} group must also include a {{token|TISSUE_MIN_LENGTH|g}}.

|}

=== Vermin Conditions ===
Special Conditions for {{token|VERMIN|c}} creature graphics:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| {{text_anchor|TILE_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}

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

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

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

|-
| {{text_anchor|FOOD_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for FOOD items.

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

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

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

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

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

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

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

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

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

|-
| {{text_anchor|TRAPCOMP_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for TRAPCOMP items.

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

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

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for SIEGEAMMO items.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for AMMO items.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|WEAPON_GRAPHICS}}
|
* Item ID
| Begins defining graphics for WEAPON items.

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

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

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

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

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

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

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

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

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

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

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

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

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

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

|-
| {{text_anchor|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.
|-
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
|
* Tile page ID
* x index
* y index
| Defines the built item graphics for HIVE items.

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

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

|-
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
|
* Shape ID
* Tile page ID
* x index
* y index
| Defines graphics for shaped items; currently used for dice.

|}

== World Map Graphics ==
World map graphics are defined in <code>[[Game_folders_and_files#Game_folder|Dwarf Fortress]]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>
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==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-04-18T01:04:30Z

BarelyCreative: /* Layered Conditions */ fixed some outdated or inaccurate statements

{{Quality|Unrated}}
{{av}}
{{Modding}}
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}}

The <code>[OBJECT:GRAPHICS]</code> [[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 <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]].

=== Types ===
{| {{prettytable}}
|- bgcolor="#dddddd"
! Type
! Arguments
! Description

|-
| {{text anchor|CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].

Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.

|-
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].

Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

|-
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
|
* [[Creature token|creature id]]
| Graphics for a 3x2 rectangle that is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]].

|}

=== Basic Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} if there is no {{token|BABY|g}} token defined for that creature's graphics, or only for the child state if there are baby graphics defined.

|-
| {{text anchor|BABY}} || Yes || Will only be displayed if the creature is a {{token|BABY|c}}.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

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

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_SET}} ||
* condition
| Creature Graphics
| Begins defining a layer set for a creature's graphics. Valid values of ''condition'' are DEFAULT, CORPSE, and ANIMATED.{{verify}}

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Only the first layer in a layer group with all its conditions satisfied will be rendered.

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| Explicitly marks the end of a layer group, which allows layers after to not belong to any layer group.

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_MITTENS]</code>
Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

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

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. General [[material token]]s are '''not''' functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token#Profession Categories|profession category token(s)]]
|| 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 <code>NONE</code> and thus apply to doctors, military, etc..

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* [[Syndrome#SYN_CLASS|SYN_CLASS]]
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|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}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}.

|}

=== Vermin Conditions ===
Special Conditions for {{token|VERMIN|c}} creature graphics:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| {{text_anchor|TILE_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}

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

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

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

|-
| {{text_anchor|FOOD_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for FOOD items.

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

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

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

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

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

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

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

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

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

|-
| {{text_anchor|TRAPCOMP_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for TRAPCOMP items.

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

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

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for SIEGEAMMO items.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for AMMO items.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|WEAPON_GRAPHICS}}
|
* Item ID
| Begins defining graphics for WEAPON items.

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

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

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

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

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

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

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

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

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

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

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

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

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

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

|-
| {{text_anchor|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.
|-
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
|
* Tile page ID
* x index
* y index
| Defines the built item graphics for HIVE items.

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

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

|-
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
|
* Shape ID
* Tile page ID
* x index
* y index
| Defines graphics for shaped items; currently used for dice.

|}

== World Map Graphics ==
World map graphics are defined in <code>[[Game_folders_and_files#Game_folder|Dwarf Fortress]]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>
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==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-04-16T22:42:11Z

BarelyCreative: Undo revision 292845 by 73.76.252.138 (talk) Ghost syndrome class is incorrect

{{Quality|Unrated}}
{{av}}
{{Modding}}
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}}

The <code>[OBJECT:GRAPHICS]</code> [[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 <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]].

=== Types ===
{| {{prettytable}}
|- bgcolor="#dddddd"
! Type
! Arguments
! Description

|-
| {{text anchor|CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].

Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.

|-
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].

Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

|-
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
|
* [[Creature token|creature id]]
| Graphics for a 3x2 rectangle that is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]].

|}

=== Basic Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} if there is no {{token|BABY|g}} token defined for that creature's graphics, or only for the child state if there are baby graphics defined.

|-
| {{text anchor|BABY}} || Yes || Will only be displayed if the creature is a {{token|BABY|c}}.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

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

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_SET}} ||
* condition
| Creature Graphics
| Begins defining a layer set for a creature's graphics. Valid values of ''condition'' are DEFAULT, CORPSE, and ANIMATED.{{verify}}

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| marks the end of a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code>

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|CONDITION_CASTE}} ||
* caste name(s)
|| General
|| Checks if the creature's caste exactly matches the given caste name.{{version|50.05}} Can use any amount of castes.

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token#Profession Categories|profession category token(s)]]
|| 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 <code>NONE</code> and thus apply to doctors, military, etc..

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* [[Syndrome#SYN_CLASS|SYN_CLASS]]
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|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}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}.

|}

=== Vermin Conditions ===
Special Conditions for {{token|VERMIN|c}} creature graphics:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| {{text_anchor|TILE_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}

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

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

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

|-
| {{text_anchor|FOOD_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for FOOD items.

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

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

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

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

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

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

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

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

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

|-
| {{text_anchor|TRAPCOMP_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for TRAPCOMP items.

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

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

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for SIEGEAMMO items.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for AMMO items.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|WEAPON_GRAPHICS}}
|
* Item ID
| Begins defining graphics for WEAPON items.

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

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

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

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

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

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

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

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

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

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

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

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

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

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

|-
| {{text_anchor|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.
|-
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
|
* Tile page ID
* x index
* y index
| Defines the built item graphics for HIVE items.

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

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

|-
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
|
* Shape ID
* Tile page ID
* x index
* y index
| Defines graphics for shaped items; currently used for dice.

|}

== World Map Graphics ==
World map graphics are defined in <code>[[Game_folders_and_files#Game_folder|Dwarf Fortress]]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>
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==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-04-15T19:45:44Z

BarelyCreative: /* Basic Conditions */ Added baby condition for simple graphics

{{Quality|Unrated}}
{{av}}
{{Modding}}
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}}

The <code>[OBJECT:GRAPHICS]</code> [[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 <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]].

=== Types ===
{| {{prettytable}}
|- bgcolor="#dddddd"
! Type
! Arguments
! Description

|-
| {{text anchor|CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].

Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.

|-
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
|
* [[Creature token|creature id]]
* [[Caste|Caste ID]]
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].

Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].

|-
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
|
* [[Creature token|creature id]]
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.

|-
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
|
* [[Creature token|creature id]]
| Graphics for a 3x2 rectangle that is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]].

|}

=== Basic Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} if there is no {{token|BABY|g}} token defined for that creature's graphics, or only for the child state if there are baby graphics defined.

|-
| {{text anchor|BABY}} || Yes || Will only be displayed if the creature is a {{token|BABY|c}}.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

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

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_SET}} ||
* condition
| Creature Graphics
| Begins defining a layer set for a creature's graphics. Valid values of ''condition'' are DEFAULT, CORPSE, and ANIMATED.{{verify}}

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| marks the end of a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code>

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|CONDITION_CASTE}} ||
* caste name(s)
|| General
|| Checks if the creature's caste exactly matches the given caste name.{{version|50.05}} Can use any amount of castes.

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token#Profession Categories|profession category token(s)]]
|| 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 <code>NONE</code> and thus apply to doctors, military, etc..

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* [[Syndrome#SYN_CLASS|SYN_CLASS]]
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL
* GHOST

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|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}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}.

|}

=== Vermin Conditions ===
Special Conditions for {{token|VERMIN|c}} creature graphics:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| {{text_anchor|TILE_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}

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

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

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

|-
| {{text_anchor|FOOD_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for FOOD items.

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

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

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

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

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

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

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

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

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

|-
| {{text_anchor|TRAPCOMP_GRAPHICS}}
|
* Tile page ID
* x index
* y index
* Item ID
| Defines tile graphics for TRAPCOMP items.

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

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

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for SIEGEAMMO items.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.

|-
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS}}
|
* Item ID
| Begins defining graphics for AMMO items.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
|
* Tile page ID
* x index
* y index
| Wooden variant of above.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
|
* Tile page ID
* x index
* y index
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.

|-
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
|
* Tile page ID
* x index
* y index
| Wood variant of above.

|-
| {{text_anchor|WEAPON_GRAPHICS}}
|
* Item ID
| Begins defining graphics for WEAPON items.

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

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

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

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

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

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

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

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

|-
| {{text_anchor|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).

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

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

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

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

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

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

|-
| {{text_anchor|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.
|-
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
|
* Tile page ID
* x index
* y index
| Defines the built item graphics for HIVE items.

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

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

|-
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
|
* Shape ID
* Tile page ID
* x index
* y index
| Defines graphics for shaped items; currently used for dice.

|}

== World Map Graphics ==
World map graphics are defined in <code>[[Game_folders_and_files#Game_folder|Dwarf Fortress]]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>
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==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Talk:Graphics

2023-01-08T06:51:29Z

BarelyCreative: New section - This page's purpose in v50

== This page's purpose in v50 ==
I think it would be good to change [[Graphics]] into a landing page with:
* a "for/see" to a Premium-related tokens + how-to page (maybe [[Graphics token]]).
* some "for/see"s to the Classic-related reference pages (like [[Graphic set]], [[Tileset]], repositories).
* a simple explaination of what base-game graphics are.
* how-to's for installing new graphics in both versions.
I think that would clean up this page while still making the Premium and Classic graphics information available to players and modders who find the page by clicking the first "graphics" result in the search bar.

I've heard some complaints in the modding discords I'm in that [[Graphics token]] doesn't sound like a page that would have the extensive how-to's for premium graphics that are necessary. I had hoped that Graphics would be a more descriptive name for a tokens + how-to page (like [[Reaction]] or [[Syndrome]]), but I can see how a player may find this page by searching the wiki and only be interested in finding graphic/tile sets or installation instructions, so I see why this page should be more general and heavily link elsewhere.
--[[User:BarelyCreative|BarelyCreative]] ([[User talk:BarelyCreative|talk]]) 06:51, 8 January 2023 (UTC)

User:BarelyCreative

2023-01-08T06:48:06Z

BarelyCreative: Created page with "Hi, I'm Barely Creative. I've been reading this wiki at least as much as I play the game since 2014 and am excited to finally contribute! I enjoy making and helping with mods..."

Hi, I'm Barely Creative. I've been reading this wiki at least as much as I play the game since 2014 and am excited to finally contribute!

I enjoy making and helping with mods including a few creature and race mods I have on my [https://steamcommunity.com/profiles/76561198062481663/myworkshopfiles/?appid=975370 Steam workshop page].

User talk:BarelyCreative

2023-01-08T06:12:44Z

BarelyCreative: /* Graphic set */

== Graphic set ==

It is easy to get lost on this wiki, even after years here I still discover new dark corners I wasn't aware of ;) The way I see it, currently we have:
* [[Modding]] as general landing page.
* Beginners [[modding guide]]
* Various [[Token]] pages for in-depth parameter reference
* With various pages that provide more in-depth usage explanation like [[Reactions]].

For graphics, I believe that currently [https://dwarffortresswiki.org/index.php?title=Graphics&type=revision&diff=284350&oldid=282626 this info] might be best suited to [[Graphic set]]. Unless you choose to consolidate stuff (Personally, I welcome experimentation though it is hard to do so here due to lack of feedback) --[[User:Jan|Jan]] ([[User talk:Jan|talk]]) 11:52, 7 January 2023 (UTC)

:That's fair, I definitely am still uncertain how that information should be displayed. It seems to me that because graphics tokens are only really useful as part of a multi-line set [[Reaction]] or [[Syndrome]] would the best examples to follow for a graphics page. Additionally, feedback from other modders after I had added all that information to the [https://dwarffortresswiki.org/index.php?title=Graphics_token&oldid=284218 previous Graphics Tokens] page was that they ignored the page because its title seemed to imply it wouldn't have any instructions.
:For this reason, I don't love the idea of linking to a page like [[Graphics token]] or [[Graphic set]], the latter of which I completely overlooked even while actively editing the wiki. Although I can see how my first try to resolve this made the pages more confusing rather than less.

:I think it would be good to change [[Graphics]] into a landing page with:
:* a "for/see" to a Premium-related tokens + how-to page (maybe [[Graphics token]]).
:* some "for/see"s to the Classic-related reference pages (like [[Graphic set]], [[Tileset]]).
:* a simple explaination of what base-game graphics are.
:* how-to's for installing new graphics in both versions.
:I'll put that in the talk pages of both Graphics and Graphics token so I'm not making the decision unilaterally. --[[User:BarelyCreative|BarelyCreative]] ([[User talk:BarelyCreative|talk]]) 06:12, 8 January 2023 (UTC)

Squad

2023-01-07T08:43:09Z

BarelyCreative: Fixing links, switching key templates to Menu icon

{{Quality|Unrated}}
{{av}}

: ''For enemy squads, see [[ambush]] and/or [[siege]].''

[[File:dwarf_army.jpg|thumb|300px|right|A dwarf squad ready to deliver permanent deaths.]]A '''squad''' is a group of [[military]] dwarves who share the same [[scheduling|schedule]] and active military orders. Squads are a fundamental part of your fortress' military — they are the units who carry out all the orders you give them. Your ability to manage these iron-blooded dwarves could spell the difference between a healthy fort's life and death.

For quick reference: from the main game screen the '''squads''' menu is accessible through the {{Menu icon|q}} key and the '''[[burrow]]s''' menu is accessible through {{Menu icon|U}}. The squad menu and all its sub-menus are designed to be navigated almost exclusively with mouse rather than keys.

For simple, ''very'' basic, unarmed and unarmored instructions on how to attack a creature, see [[attack]].

==Forming squads==
Before you do anything with your military, you must go into the {{Menu icon|n}} [[noble]]s screen and appoint a '''[[militia commander]]'''. Your fortress can only have one militia commander, who acts as the commander-in-chief of all squads. The militia commander also serves as the leader of your first squad.

Each squad after the first will have its own [[militia captain]], who reports to the militia commander. Squad captains can be designated through the nobles screen, or by creating a new squad in the {{Menu icon|q}} squad menu and then assigning a dwarf to the first position of that squad.

Once you have a militia commander appointed, when going to the squad menu you'll notice an option to "'''Create new squad.'''" When you click this button to create a squad, you may be asked which militia captain should lead this new squad if you have appointed captains that are not currently leading one, other wise you will be asked which uniform to give the squad. The game creates three uniforms by default; if you aren't sure what to use, or if you want to customize their uniform, choose "'''No uniform'''". (See [[#Equipping soldiers|equipping soldiers]], below, for details.)

Once the first squad has been created, you can then fill out the squad with any militarily-capable dwarves in your fort, of which no more than ten can be assigned to any one squad. When you add a dwarf to one squad they will be removed from another; for this reason you will always see the majority of your dwarves in the assignment menu. Dwarves that are already in a military squad will have the name of that squad and their position within it listed in yellow text above their name, allowing you to skip over them if necessary. The assignment menu is found by clicking on the 'positions' bearded face icon above the squad name.

===Nobles in squads ===
Here's a link to the DF forum, with old{{version|0.34.11}} but potentially still relevant speculation on which nobles should not be assigned to the military due to the importance of their civilian role:
http://www.bay12forums.com/smf/index.php?topic=113639.msg3467517#msg3467517

==Equipping soldiers==
In the squad menu, select one or more squads by clicking the checkbox next to their name, then click "'''Equip'''" to view a summary of their assigned equipment. Color-coded icons will show whether the squad has their equipment fully equipped (green basic symbol), assigned but not equipped (yellow with three dots), or missing (red with exclamation point). 

From this menu, uniforms can be created and saved using the "'''Add uniform'''" button or assigned to squads to overwrite their existing equipment with the "'''Assign uniform'''" button. Uniforms are essentially a pre-designed set of equipment that you can quickly apply to any individual soldier or entire squad. You may wish to create new uniforms, and add or remove items from any uniform (even the standard ones). While using the "'''Add uniform'''" menu, uniforms are only ''created'' or ''modified'', not applied.

While still in the "'''Equip'''" menu, "'''Assign uniform'''" to open the choose uniform sub-menu and select one of your uniform templates to apply to all selected dwarves. Squads can be selected or deselected at any point in this process to change who you are assigning the uniform to without closing any of the sub-menus. Once you have all the squads selected whom you want to use the same uniform, you can click the uniform's name to apply it. The choose uniform sub-menu will close and the squads' previous uniform will be overwritten. You can also edit one position's uniform at a time by selecting the "'''Details'''" menu next to the position name. It is important to remember that this uniform is applied to that squad position rather that a particular dwarf. The uniform can be changed as discussed below and/or saved as a new uniform by typing a name into the textbox at the top of the menu, pressing {{k|enter}} the clicking "'''Confirm and save uniform'''."

In the "Details" or "Add uniform" sub-menus, you can select pieces of equipment to create a uniform with the equipment buttons - "'''New [[Armor#Upper_Body|bodywear]]'''", "'''New [[Armor#Headgear|headwear]]'''", "'''New [[Armor#Lower_Body|legwear]]'''", "'''New [[Armor#Hands|handwear]]'''", "'''New [[Armor#Footwear|footwear]]'''", "'''New [[Armor#Shield|shield]]'''", and "'''New [[weapon]]'''". You can also specify the "'''Mat'''"erial and "'''Color'''" of the equipment by clicking one of these buttons next to it. Finally, there are two settings that can be toggled in the bottom left of the menu: "'''Uniform worn over clothing'''" and "'''Partial matches okay'''". These are both on by default. "'''Over clothing'''" means the dwarf will do their best to wear their uniform in addition to their civilian [[clothing]]; if toggled, it becomes "'''Replace clothing'''", and the dwarf will strip naked before donning their military gear. "'''Partial matches okay'''" means that if a dwarf cannot satisfy an equipment assignment, they'll substitute it with something close; if toggled to "'''Exact matches only'''", they'll go that piece of equipment rather than making do with a substitute.

To select a specific piece of equipment for an individual position (such as an artifact), select "'''specific _____'''" under that equipment type (e.g. "'''specific armor'''" in the Armor field); for your convenience, highest-value equipment is listed first.

You have the option to wear equipment over clothing or to replace clothing using the "'''Uniform worn over clothing'''" button on the equipment screen. Wearing armor over clothing can cause problems as some civilian clothing (caps, gloves, and shoes) will conflict with their military counterparts (helms, gauntlets, and boots). Even though the '''Uniform''' menu will show that these items have been assigned to a solider, they will not actually be able to wear them. To avoid this use the "'''Replace clothing'''" option. As armor counts as clothing, dwarves will not get bad thoughts if only wearing armor as long as their feet, lower body, and upper body are covered.

Currently{{version|0.50.04}} it is not possible to assign ammunition for ranged soldiers, only the default "'''Archer'''" uniform is assigned [[ammunition]] by default, so the only consistent way to make functional marksdwarf squads is to create a new squad using the default archer uniform from the start.{{bug|0012008}} The dwarves will decide for themselves what ammunition to use, so they may waste all the nice metal bolts training and end up fighting battles with only wooden bolts, although the AI is intended to favor worse ammo for training. Also note that [[quiver]]s must be available for marksdwarves to equip bolts/arrows. They are not assigned in the "'''Uniform'''" menu tab and are automatically retrieved by dwarves that require them.

In previous versions soldiers who have more than one item to put on would not use distance to determine which of the remaining items will be equipped next. Therefore it was best to keep all dwarf-usable equipment within a small area, ideally near your [[barracks]]. The way dwarves equip gear has changed slightly{{version|0.50.01}}, so it is uncertain if this is still necessary.

The "'''Equip'''"-"'''Details'''" menu can also be used to ''see'' what equipment has been assigned, without changing it. And the summary icons in the main "'''Equip'''" menu can show whether the status of your squads' equipment For example, if your 9th and 10th squad members have a red pair icon with and exclamation point for their gauntlets, then you may want to make some more, and if the boots icon is yellow with three dots you may want to check that all the equipment is accessible and that the dwarf has enough space on their body to equip all their items (not missing limbs or wearing too many layers of clothes). Pressing "'''Details'''" lets you see ''precisely'' what items the dwarf has been assigned.

Dwarves do not share weapons and armor even if in the same squad and even if the equipment is currently unused by another squad-mate who is off duty. This means, for example, that you cannot have one set of armor for a squad of four dwarves who share guard duty one at a time. When one dwarf is relieved from duty, he may take off his armor (if set to wear civilian clothes) but the new dwarf going on duty will not then pick it up and wear it. Each dwarf in a squad needs his own uniform.

===Changing equipment===
Let's suppose you started with the "'''Leather armor'''" uniform and then smithed some metal armor, and now you want to change your squads to the metal armor. From the "'''Equip'''" menu, you can access the "'''Assign uniform'''" sub-menu, which will show the standard Leather, Metal, and Archer uniforms on the left (if you haven't deleted them). To change a full squad, select the squad using the checkbox to the right of their name, then select the uniform (metal) on the left, and it will be applied. Just hope you have enough metal armor and that Urist goes and picks it up!

Equipment can also be changed on an individual level e.g. if you would like to add metal gear or artifacts as they are produced. This is done from the "'''Equip'''" menu by pressing the "'''Details'''" button to the right of a squad member's position, then changing "'''Mat'''"erial, "'''Color,'''" or even the type of equipment assigned. This must then be saved by clicking the "'''Confirm'''" button or by entering a name into the textbox and pressing "'''Confirm and save uniform.'''"

Dwarves will not always pick up their military equipment immediately. An off-duty dwarf will sometimes prefer to perform one of his civilian jobs rather than putting on armor, and by default squads are assigned to wear civilian clothes when not on duty, so they will not equip their gear until an active order is assigned or the [[Scheduling#Routines|routine]] is changed to force equipping gear while off duty. Giving squads an [[#Orders|order]] will put them on duty and force them to gather their equipment with a bit more hustle.

===Equipping bone and shell armor===
One peculiarity for equipping [[bone]] and [[shell]] armor is that, for the purposes of '''uniform''' menus, bone is white and shell is dark green. Further, they are not explicitly listed in the "'''Mat'''"erial of the "'''Uniform'''" sub-menu. A workaround for this problem is that bone and shell are the only materials of their respective colors that can be used to make armor by default. So, to add bone or shell armor items to a preset uniform template, you need to add a specific type of armor (a helm, for instance) with the modifiers of "'''Color'''" as "'''white'''" or "'''dark green'''" (thus, e.g., a "'''white helm'''"). This workaround is ONLY effective if you also have no unique artifact armor made out of a white metal (such as an Aluminum Breastplate, Platinum Helm, or Silver Low Boot). It also requires that the armor template be for "'''Exact matches only'''" (not "'''Partial matches okay'''") using the buttons at the bottom of the "Uniform" sub-menu.

===Equipping leather shields===
[[Leather]] is not a selectable material in the "'''New shield'''" screen. However, its uniformly brown colour means that you can order dwarves to use only brown-coloured [[shield]]s and be reasonably confident that they will choose only leather shields. Leather and wood are quite similar as shield materials, but if your leatherworkers make better shields than your carpenters you may want to use their products instead. [[Highwood]] shields are also an option with this uniform setting, and will be chosen if their value is appropriately high.

==Orders==
[[File:Squad menu v50 04.png|right]]
Getting your military to actually ''do'' something is the second step. Squads receive '''passive orders''' through [[scheduling]], and you can give '''direct orders''' to '''attack''' one or more specific targets or to '''station''' at a specific location at will through the {{Menu icon|q}} squads menu.

Passive orders are programming that a squad will follow in the absence of direct orders. Passive orders are typically used for training and defense, while direct orders are used for taking the fight to the enemy. The main ''squads'' menu is predominantly used for direct orders, and the ''Schedule'' sub-menu is used for passive orders. This article will focus on active commands; for more information on passive orders, see [[scheduling]].

A squad that is following a direct command is free to go wherever it is ordered to go, unhindered by any [[burrow]] restrictions.

===Selecting squads/soldiers===
When needed, soldiers can be sent to do specific tasks to <strike>satiate the blood god</strike> defend your fortress. Once these orders have been cancelled, your dwarves will return to their passive orders (if on duty), or their civilian lives (if off duty). Note, however, that your dwarves may continue to move towards their prior objective and mill about for some time afterwards. For this reason (and because canceling orders causes your dwarves to immediately drop any [[wear|worn-out]] clothing) it is best to order your dwarves back to a safe area '''before''' canceling their orders.

In the {{Menu icon|q}} '''squad''' menu, you can click the checkboxes to the right of the squad names to select one or more squads to give orders to. To give orders to individual dwarves within a squad: click the third button (bearded dwarf face) on the squad to view the positions in the squad, click the checkbox next to one (or more) dwarf’s name, and then the order, equip, and schedule buttons will appear at the bottom of the menu and apply only to the selected dwarves.

If a squad is off duty when you give them an order, they will switch to on-duty status before carrying out the order. This may mean they need to pick up new equipment before they will carry out their orders, although they frequently will not pick up all of their assigned gear before giving up and moving toward the objective.

There are five types of active orders that can be given to your dwarves: attack, station, patrol, burrow defense, or train, as well as cancel order. They are selected by clicking one of the six icons along the bottom of the '''squad''' menu.

===Attack order===
The '''attack order''', sometimes referred to as the '''kill command''', instructs your squad to pursue and attack one or more specific targets. It is a very unsubtle way of beating into your dwarves' booze-addled minds that they are to kill your target or be killed in the attempt. An attack order can be used to chase a kobold thief or goblin snatcher who is running away with your precious loot, or it may very well be the last command your dwarves receive if things are getting desperate.

After selecting which squad will execute the kill command, click the sword icon to begin designating the Attack targets. You now have several options: by default (or by clicking the -> x icon in the bottom left) you will be in '''single select''' mode and can choose one or more individual targets by clicking on them. You can switch to '''box select''' mode by clicking the stamp icon in the bottom left of the attack menu and draw a selection area on the map. When you left click the box select, a new menu will appear with a list of possible targets inside the selection. To continue adding to your box selection, right click and designate more selections. Once you are happy with your targets from the single or box selections, you can click "'''Confirm'''" to issue the order and watch your dwarves happily run off to execute the order by executing the target, or "'''Cancel'''" to exit the menu without giving an attack order.

Each dwarf in the squad will attempt to move toward the target until they are within striking distance. Ranged attackers will not do anything clever, like climbing up to the top of your archery tower - if you want them to fire from a specific position, use a station order instead. If they're already somewhere they can fire from safely, one can also cut off access to the intended targets and THEN issue a kill order. If they're stationed in an archery tower and ordered to kill something they can path to, they might charge the enemy even if they have a clear shot from their current position.

This order will automatically be cancelled once the intended victim is killed. If the target is caught in a [[Trap#Cage_trap|cage trap]], though, your squad will stand over the cage waiting for new orders; when the caged target is hauled to the animal stockpile, the dwarves given the orders to kill it will follow the cage as it is hauled and wait around it once it is stockpiled until the kill command is cancelled.

Dwarves go about this with a little more vigor than required and will also attack any other creatures nearby. As a result, it is very difficult to attack members of an enemy group with any sort of precision, and if your dwarves cannot take down their target, there is no real way to get them out of combat; it's do-or-die. It is unknown whether this is a bug or a feature.{{version|0.34.07}}

===Station order===
From the {{Menu icon|q}} squad menu, a '''station order''' (also known as a '''move''' order) is issued by selecting a squad, clicking the green arrow icon, and clicking a location on the map.

Each dwarf in the squad will select a random ([[path|reachable]]) point within 3 tiles of the spot you specify, somewhere in that 7x7 box, and will move directly to that point. This can mean that, if they have a path, dwarves may obediently move to the "wrong" side of a wall or other barrier if those tiles are within the 7x7 box. Dwarves in the squad will stand there until you cancel the order, give a new order, or an enemy comes within sight. Also, if one is overcome by [[hunger]], [[thirst]], or [[exhaustion]], that dwarf will take care of their [[need]] and then return to their squad's current assignment.

On-duty soldiers will pursue and attack any hostile targets they see, either en route to their station point, or after arriving. Hostile targets may include certain wild animals that are deemed dangerous. If the dwarf loses sight of the enemy, they will return to their chosen station point.

===Patrol route order===
The '''Patrol Route''' order assigns a squad to walk along a defined path of your choice continuously while the order is active. This can be used to spread the dwarves out and increase their [[ambush]]-spotting potential, or to move your marksdwarves in and out of combat, allowing them to relax and reload before returning to the fray.

A '''Patrol''' order is issued by clicking the third order icon from left in the {{Menu icon|q}} squad menu (the one with three red X's connected by a dotted line). Clicking this icon opens the '''route''' sub-menu where any existing route can be selected from the list, inspected, or deleted. If no desirable '''routes''' exist, a new one can be started by clicking "'''Create new route'''." Because routes must be saved to be used and can be selected by other squads it is recommended to give the new route a descriptive name by typing in the textbox at the top of the sub-menu then pressing {{k|enter}}. Finally, you can begin clicking on the map to define which points you want the dwarves to walk to in order. It is important to remember that dwarves will not follow the displayed path exactly. Rather, they will path from their current location to a random point within 3 tiles of the spot you specify (the same rules as a station order) following the normal Fortress Mode [[Path|pathing rules]].{{verify}}

Similar to the '''station''' order, on-duty soldiers will pursue and attack any hostile targets they see, prior to arriving at their station, or along their route. Hostile targets may include certain wild animals that are deemed dangerous. If the dwarf loses sight of the enemy, they will return to their patrol route.

===Defend burrow order===
If you have '''[[burrow]]s''' defined through the {{Menu icon|U}} Burrows menu, you can order your soldiers to defend it. They will spread out around the zone and automatically attack any hostile creatures that enter the burrow or that they can see nearby. It is unknown if a soldier defending a burrow is limited to their line-of-sight or is simply aware that an enemy is present. This can be useful to set up a 'zone' defense that requires less intricate setup than creating multiple overlapping '''station''' or '''patrol''' orders.

The '''Defend Burrow''' order is issued by clicking the 'shield' icon at the bottom of the {{Menu icon|q}} squad menu, then selecting the burrow you want your squad to defend and clicking "'''Confirm'''."

===Train order===
Training is a necessary part of a successful military, but setting up a proper '''[[Scheduling|schedule]]''' can take more time than it is worth for a simple squad that just needs to train up quickly and get on duty. That's where the active '''Train''' order comes in. It allows you to quickly issue a continuous training order for any number of squads by selecting them in the {{Menu icon|q}} squads menu with the checkbox next to their name and clicking the 'training' axe icon.

For your dwarves to train, a they must be assigned to train at a valid '''[[barracks]]'''. This can be done through the {{Menu icon|z}} zone menu by clicking the "'''Barracks'''" blue banner button to designate a barracks zone. To train at the barracks, a squad must be assigned to it from the zones menu by clicking the '''add squad''' - banner with a plus icon then clicking the '''training''' axe icon next to your squads' name to assign them to train there.

===Cancelling orders===
Pressing the red circle with a line through it icon in the {{Menu icon|q}} squad screen will '''cancel''' the selected squads' active orders, sending them back to their civilian or pre-scheduled military lives. If a dwarf is actively engaged in combat when an order is cancelled, they may not immediately disengage subject to their [[Personality_trait#Facets|personality]]{{verify}}; as a result, your over-eager dwarves may get themselves into some trouble. Take caution when sending them deep into unfamiliar territory.

==Order scheduling==
''Full article: [[Scheduling]]''

From the {{Menu icon|q}} squad-"'''Schedule'''" menu you can activate any routines you have defined quite quickly by selecting the squads you wish to assign with the checkboxes to the right of their names then clicking on the routine you wish for the squad to follow. This will set the order schedule for the entire squad until you give them an [[#Orders|active order]] or change routines.

To edit an existing routine or create a new one you need to visit the squad schedule menu. This can be done directly from the squad menu by clicking "'''Schedule'''" then "'''Clear'''"ing and "'''Edit'''"ing one of the visible routines, clicking "'''Add/edit routines'''," or alternatively editing months individually with "'''View monthly schedule'''." The details of setting up an order schedule are described on the [[scheduling]] page.

==Bugs==
* When selecting new dwarves to place in a squad the cursor always returns to the first available dwarf instead of remaining where it is.
* Dwarves handle equipment conflicts poorly, often resulting in an ill-equipped military.{{bug|535}}
* Military dwarves may constantly perform "pickup equipment" jobs {{Bug|2687}}
* Military equipment interferes with civilian equipment (picks/axes/crossbows/quivers).{{bug|1451}}
* Marksdwarves may not equip ammunition automatically.{{bug|0012008}}

==Troubleshooting==
Getting dwarves to collect and wear their assigned equipment can be a challenge. Here are some known issues:

*Dwarves take forever to pick up their assigned equipment
**Issuing a "station" order near your equipment dump should motivate dwarves to collect their equipment before reporting for duty. If they are still not fully equipped then check the problems listed below.

*Some types of civilian clothing conflict with armor (caps and shoes are common culprits).{{bug|0010899}}
**Toggle "Replace clothing" to force dwarves to wear the assigned armor. (You can toggle it back after they are equipped and your dwarves will add back any non-conflicting clothing.)

*Dwarves don't equip hands and/or feet completely.
**Remove duplicate assignments. A single "Metal footwear" entry will assign a *pair* of boots; dwarves with two entries are assigned two *pair*, which cause conflicts and prevent the second pair from being equipped by another dwarf.
**Dwarves will also not equip multiple layers of equipment on their hands and feet even if they should be compatible.

*Dwarves drop their assigned equipment.
**Make sure they are ordered to wear their uniform when inactive, and disable all mining, hunting, and woodcutting labors (these labors conflict with military uniforms).

*Dwarves keep complaining of "[[equipment mismatch]]".
**This is an "informative" message that is frequently caused by dwarves attempting to swap their equipment for slightly better versions or finding their stored equipment temporarily inaccessible due to bugs with storage.{{bug|0038238}}

*Dwarves have tattered clothing equipped.
**Assigned clothing will generally not be swapped for new replacements, leading to stress. Remove clothing (equipment made of cloth) from the dwarf's uniform, and optionally toggle "over clothing" to allow the dwarf to collect, wear, and replace civilian clothing automatically.

*Dwarves don't pick up bolts.
**Make sure you have enough quivers and bolts. In previous version Hunters were assigned 100 bolts by default, which remained reserved whether you had any hunters or not. This number is no longer visible or editable,{{version|0.50.01}} so it may still be causing issues.

*Dwarves have the wrong bolts stuck in inventory.
**Bolts cannot currently be assigned{{version|0.50.04}} for different uses (e.g. combat vs. training), and dwarves may not pick them up at all.{{bug|0012008}}

*Dwarves move extremely slowly after equipping themselves.
**This is due the weight of the armor - most metal armor is heavy. The best way to prevent this is training the [[armor user]] skill, which reduces encumbrance penalties from worn armor, as even the strongest dwarves can be slowed by a full set of armor. [[barracks|Combat training]] will increase a dwarf's armor user skill and [[main:strength|strength]] (as will training [[Attribute#Attributes_trained_by_skills|some other skills]]). The increase in strength will allow them to carry more weight, but it is a very slow process.

{{Military}}
{{Category|Interface}}
{{Category|Military}}
[[ru:Squad]]

Uniform

2023-01-07T08:19:15Z

BarelyCreative: Fixed broken redirect

#REDIRECT [[Squad#Equipping soldiers]]

Graphics

2023-01-07T07:14:35Z

BarelyCreative: Moved how to's and references to token page from Graphics token

{{Quality|Unrated}}{{av}}
:{{for/see|a list of all Premium graphics tokens and basic usage|[[Graphics token]]}}
:{{for/see|a repository of all Classic tilesets used in DF|[[Tileset repository]]}}
:{{for/see|details on creating Classic tilesets|[[Tileset repository]]}}

The new graphics system in v50 is still being reverse engineered. It is a custom solution which appears to involve compositing graphics sets directly in C++ before texmapping them to SDL. This blitting approach is software rendered and so largely doesn't use hardware acceleration on graphics cards. This system means that despite graphics sets supporting rudimentary animation, there is no traditional sprite mapping, which places extensive limits on the types of graphics that are possible. While the number of user editable graphics sets has increased significantly in v50, many game elements are still hard coded graphics sets, or using a tileset over the older style graphics from classic DF.

= Premium Graphics =
:{{for/see|a list of all Premium graphics tokens and basic usage|[[Graphics token]]}}

The <code>[OBJECT:GRAPHICS]</code> object defines the use of various tile-based graphics in the game. As of version 50.01, graphics [[token]]s have been greatly expanded to accommodate the release of the Steam & Itch premium version. This section is a basic description of how to define various types of graphics.

Making custom graphics requires multiple interacting files to function:
# An 8bit RGBA (sometimes called 32bit) "imagename.png" in the <code>\<mod_id>\graphics\images</code> folder
# A "tile_page_name.txt" in the <code>\<mod_id>\graphics</code> folder
# A "graphics_type_name.txt" in the <code>\<mod_id>\graphics</code> folder

Mods can reuse any graphics loaded ahead of them (including vanilla) by using the same tile page token.

== Tile Page ==
Tile pages link image files to a tile page token so they can be referenced by the graphics file. Just like all other [[Raw file]]s, Tile Pages must be defined from within a properly named "tile_page_<name>.txt" file and follow:

tile_page_<name>

[OBJECT:TILE_PAGE]

After the object type is defined as above, any number of tile pages can be defined according to the format below.

[TILE_PAGE:<tile page identifier>]
[FILE:images/imagename.png]
[TILE_DIM:<tile x dim>:<tile y dim>]
[PAGE_DIM_PIXELS:<page x dim>:<page y dim>]

* ''tile page identifier'': The Internal ID being created for the image.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''tile x dim'': The width of each tile in pixels (usually 32).
* ''tile y dim'': The height of each tile in pixels (usually 32).
* ''page x dim'': The width of the image file in pixels.
* ''page y dim'': The height of the image file in pixels.

Known issues:
* Currently it is only recommended to use <code>[TILE_DIM:32:32]</code> as only the upper left 32x32 pixels are displayed on tiles defined larger, and smaller tiles are displayed starting from the upper left of each in-game square (individually by tile with large graphics) rather than centered and bottom justified as might be expected.
* It is important that the <code>[PAGE_DIM_PIXELS:<x dim>:<y dim>]</code> matches the size of the referenced image exactly - as the game will stretch tile pages with a dimension larger than the actual image by inserting blank lines, and a tile page smaller than the image will cause a crash to desktop.

== 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 <code>[OBJECT:GRAPHICS]</code> token that tells the game that the file contains graphics definitions.

=== Basic Graphics ===
The most basic form of creature graphics is a single tile, defined below:
[CREATURE_GRAPHICS:<creature id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''[[Graphics_token#Basic_Conditions|condition]]'': The condition the creature needs to be in for this image to be displayed. Use <code>DEFAULT</code> for generic graphics.
* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''color type'': (optional) Uncertain function, frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}
* ''[[Graphics_token#Basic_Conditions|secondary condition]]'': (optional) An additional condition that must be satisfied for the image to be displayed.

When the condition {{token|DEFAULT|g}} is used, this graphic will be displayed for the creature in all conditions unless additional, more specific conditions are also defined.

:'''Basic Conditions'''
Different graphics can be defined for the same creature based on some properties about it. Below is a list of the most common creature conditions tokens. Here is the full list of known creature condition tokens.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{token|DEFAULT|g}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{token|CHILD|g}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} and is younger than one of those ages.

|-
| {{token|ANIMATED|g}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{token|CORPSE|g}} || Yes || Displayed as soon as the creature dies.

|-
| {{token|LIST_ICON|g}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise.

|}

=== Caste Graphics ===
Creature caste graphics allow a simple alternative to [[#Layered Graphics|Layered Graphics]] to represent males and females of a creature with different images.
[CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being defined.
* All other parameters are identical to [[#Basic Graphics|basic graphics]].

Creature caste graphics only accept <code>MALE</code> and <code>FEMALE</code> as caste id's even in creatures that have more than two castes.

=== Large Graphics ===
The only difference between graphics for large creatures and small creatures is the addition of <code>LARGE_IMAGE</code> and additional coordinates to the line below:
[<condition>:<tile page identifier>:LARGE_IMAGE:<x1>:<y1>:<x2>:<y2>:<color type>:<secondary condition>]

* ''LARGE_IMAGE'': This tag allows a rectangular image with multiple tiles to be defined by its upper left and lower right tiles. Valid for 1x1 - 3x2 tiles.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.
* All other parameters are identical to [[#Basic Graphics|basic graphics]].

Large images and small images can be used within the same <code>CREATURE_GRAPHICS</code> or <code>CREATURE_CASTE_GRAPHICS</code> definition, and in fact it is often useful to include a single tile image to act as a {{token|LIST_ICON|g}} for menus.

=== Statue Graphics ===
Statue graphics are the generic images placed on top of a pedestal whenever a creature is the primary subject of a statue. The image is implied to occupy multiple tiles, and all examples in vanilla are 1x2 vertical rectangles. Statue graphics are defined as below:
[STATUE_CREATURE_GRAPHICS:<creature id>]
[DEFAULT:STATUES_LAYERED:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.

=== Layered Graphics ===
Layered graphics are a method for displaying overlapping body parts, equipment, clothing, professions, hairstyles.. etc. They allow much more freedom in conditions than normal [[#Basic Graphics|basic graphics]], and they allow combinations of many graphical variations within the same creature to give your graphics more personality and display more information about the individuals. All layered graphics started as shown below:
[CREATURE_GRAPHICS:<creature id>]
[LAYER_SET:<condition>]

* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[Graphics_token#Basic_Conditions|condition]]'': The condition the creature needs to be in for this set of layers to be displayed.

Once you start defining a Layer Set, you can begin adding individual layers from the bottom up to create your final image. For example, if you want to draw a helmet being worn on a head, you would define the head layer first, then define the helmet layer. Layers are defined according to this format:

[LAYER:<layer name>:<tile page id>:<x position>:<y position>:<color type>]
[<layer condition(s)>]

* ''layer name'': The internal name of the layer. No known function at this time, but using a descriptive label is recommended.
* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''[[#Large Graphics|LARGE_IMAGE]]:x1:y1:x2:y2'': (optional) Allows a multiple tile image to be displayed. Replaces <x position>:<y position>.
* ''color type'': (optional) Uncertain function, frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}
* ''[[Graphics_token#Layered_Conditions|layer condition(s)]]'': One or more conditional tokens that define under what conditions the layer is displayed and how it interacts with other layers.

=== Forgotten Beast Graphics ===
Forgotten beast graphics define layered graphics based on which body parts are present in each procedurally-generated forgotten beast.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x1>:<y1>:<x2>:<y2>:<beast body token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': X position of the lower right tile.
* ''y2'': Y position of the lower right tile.
* ''beast body token'': The internal ID of generated forgotten beast body types and body parts.

The <code>TILE_GRAPHICS_RECTANGLE</code> token displays a large image with the upper left corner being defined by <x1>, <y1> and the lower right corner defined by <x2>, <y2>. The <beast body token> is a conditional token that causes the graphics for each layer to be displayed only when the forgotten beast has that particular body type or part.{{verify}}

There is not currently a way to use procedurally defined graphics like this for non-{{token|FEATURE_BEAST|c}} creatures.{{verify}}

=== All creature tokens ===
For reference, all known creature graphics tokens are reproduced below.

:'''Basic Conditions''' Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{token|DEFAULT|g}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{token|CHILD|g}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} and is younger than one of those ages.

|-
| {{token|ANIMATED|g}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{token|CORPSE|g}} || Yes || Displayed as soon as the creature dies.

|-
| {{token|TRAINED_HUNTER|g}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{token|TRAINED_WAR|g}} || Yes || Shown for war-trained versions of this creature.

|-
| {{token|LIST_ICON|g}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{token|SKELETON|g}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{token|SKELETON_WITH_SKULL|g}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

:'''Vermin Conditions''' Special Conditions for {{token|VERMIN|c}} creature graphics:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{token|VERMIN|g}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{token|VERMIN_ALT|g}} || Image cycles every 1 second.

|-
| {{token|SWARM_SMALL|g}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{token|SWARM_MEDIUM|g}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{token|SWARM_LARGE|g}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{token|LIGHT_VERMIN|g}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{token|LIGHT_VERMIN_ALT|g}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{token|LIGHT_SWARM_SMALL|g}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc in small groups.

|-
| {{token|LIGHT_SWARM_MEDIUM|g}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc in large groups.

|-
| {{token|LIGHT_SWARM_LARGE|g}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{token|REMAINS|g}} || Vermin corpses.

|-
| {{token|HIVE|g}} || Vermin hives.
|}

:'''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.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{token|LAYER_GROUP|g}} || || Layer Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{token|END_LAYER_GROUP|g}} || || Layer Group
| marks the end of a layer group. Current effect unknown.{{verify}}

|-
| {{token|CONDITION_ITEM_WORN|g}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code>

|-
| {{token|SHUT_OFF_IF_ITEM_PRESENT|g}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{token|CONDITION_DYE|g}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{token|CONDITION_NOT_DYED|g}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{token|CONDITION_MATERIAL_FLAG|g}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{token|CONDITION_MATERIAL_TYPE|g}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG|g}} is a better option for any material condition other than metal.

|-
| {{token|CONDITION_PROFESSION_CATEGORY|g}} ||
* [[Unit type token|profession token(s)]]
|| General
|| Checks the profession of the creature to act as a condition. Multiple profession tokens can be chained together.

|-
| {{token|CONDITION_RANDOM_PART_INDEX|g}} ||
* 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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{token|CONDITION_HAUL_COUNT_MIN|g}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL|c}}s in vanilla.

|-
| {{token|CONDITION_HAUL_COUNT_MAX|g}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL|c}}s in vanilla.

|-
| {{token|CONDITION_CHILD|g}} || || General
|| Checks if the creature is a child or baby.

|-
| {{token|CONDITION_NOT_CHILD|g}} || || General
|| Checks if the creature is an adult.

|-
| {{token|CONDITION_GHOST|g}} || || General
|| Checks if the creature is a ghost.

|-
| {{token|CONDITION_SYN_CLASS|g}} ||
* {{token|SYN_CLASS|syndrome}}
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Valid values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL

|-
| {{token|CONDITION_TISSUE_LAYER|g}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{token|TISSUE_MIN_LENGTH|g}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{token|TISSUE_MAX_LENGTH|g}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{token|TISSUE_MAY_HAVE_COLOR|g}} ||
* [[Color#Color_tokens|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.

|-
| {{token|TISSUE_MAY_HAVE_SHAPING|g}} ||
* styling token
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s shaping (hairstyle). Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.{{verify}}

|-
| {{token|TISSUE_NOT_SHAPED|g}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{token|TISSUE_SWAP|g}} ||
* 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 {{token|CONDITION_TISSUE_LAYER|g}} group must also include a {{token|TISSUE_MIN_LENGTH|g}}.
|}

== Item Graphics ==
Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out.

= Classic Graphics =
{{old}}
:{{for/see|a list of all tile characters used in DF|[[Tilesets]]}}
:{{for/see|a chart with the default ASCII characters|[[Main:Character table|Character table]]}}
:{{for/see|user-created creature tilesets|[[Main:Tileset repository|Tileset repository]]}}
:{{for/see|information about Graphic sets|[[Graphic set|Graphic set]]}}
:{{for/see|information on how tilesets get colored|[[color]]}}
=== General Information ===
Although commonly referred to as text or "ASCII"-graphics, classic DF uses a bitmap [[tilesets|tileset]]* with characters from the [[Main:Character table|IBM Code Page 437]], displayed with a foreground and background color picked from 16 predefined [[Color scheme|colors]]. Text files (and often hardcoded values) define the tile, and colors of all objects.
Both color scheme and tileset can be changed (see below), and definitions that are in text files can be modified. In addition, interface text can be displayed with a TrueType font and [[creatures]] (which normally are displayed as [[tilesets#list of creatures...|letters]]) can be assigned to separate tilesets called [[graphic set]]s. The main tileset is sometimes called "character tileset", while the graphic sets are also referred to as "object tilesets".

*except when using [[Technical_tricks#Video_Card_Options|PRINT_MODE:TEXT]]

==== Tileset ====
{{Main|Tilesets}}
The main tileset (also called 'character set' or just 'tileset') is an image in BMP or PNG format that contains the 256 different tiles, corresponding to the [[Main:character table|IBM Code Page 437]], which are used to display all objects, creatures, and UI elements in game. The tiles are always arranged in a 16x16 grid, but its dimensions can be varied. You can have both square and non-square tiles, with 16x16 pixels being the most common size. Creatures are displayed as [[Tilesets#Main_creature_tiles|colored letters]] (a white 'B' is a [[polar bear]], a brown 'd' a [[dog]], and a grey 'c' is a [[cat]]).

As the tileset is limited to only 256 tiles, some objects share the same tile. Most notably, even with upper and lower case letters and 16 colors, a lot of creatures still look identical (goblin, goat, various gibbons, gremlin, goose, etc). The tile for bins, up/down stairs and the cursor are the same; bags use the same tile as the symbol for "male"; and the "female" symbol shares a graphic with amulets. Roads and large rivers on the world map, minecart tracks and walls all share the same tiles as well.

Some of those can be changed in the raws and init files, and creatures can have separate graphics, but in most cases they are hardcoded.

That also can be used to categorize custom tilesets: Those that are made for and come bundled with modified raws/init files, and those that are made for and work with the default raws. Usually, the latter are more symbolic, or 'ASCII-like', while the former are often more pictographic, detailed or "pixel-arty". These sometimes are also bundled with their own creature graphics.
Tilesets that are made for default raws have the advantage that you can use them immediately without any work for any new version that is released. With modified raws, you need to manually edit the new raws again, or wait for the maintainer to do that.

==== Graphic set ====
{{Main|Graphic set}}
Graphic sets are additional tilesets used to give objects different graphics. As opposed to the main tileset, any number of tiles can be arranged in any grid configuration. Currently, DF only supports graphic sets for creatures. Every graphic set needs a corresponding text file that assigns a tile to a creature.

==== Color ====
{{Main|Color}}
In general, a tileset has white tiles with a transparent background. White pixels show the foreground color, transparent pixels (magenta pixels for .bmp) the background color. Black pixels remain black. Shades of grey, partial transparency and even colored tiles can be used for various effects. Additionally, creature graphics can be set to be displayed in the colors they're drawn in.

Otherwise, the game selects from 16 colors (the [[color scheme]]) to decide the color: which of the 16 colors the game uses depends on the [[Color#Color_values|color value]] or [[Color#Color_tokens|color token]] of the material/item.

===Installation===
{{further information|Mod|Tilesets|Graphic set|Color scheme}}
====Repositories====
Users of the Steam version can subscribe to mods on Steam Workshop. The wiki has repositories for [[Main:Tileset_repository|tilesets]], [[Graphics_set_repository|graphic sets]], and [[color scheme]]s. You will find more in the [http://www.bay12forums.com/smf/index.php?board=28.0 bay 12 graphics subforum] and on [http://dffd.wimbli.com/ DFFD]. Some graphic sets and tilesets are additionally maintained on [https://github.com/DFgraphics github].
Often, tileset creators offer preinstalled downloads or folders you just have to drop into your DF folder and overwrite files when prompted. They usually come with installation instructions either in a readme file or in their respective forum thread. In addition, there are various [[Utilities#Launchers|launcher]] applications that let you install and change graphics automatically.

For manual installation of the various components, see here:

====Tileset====
Put the tileset you want to use into the data/art/ folder. Open up [[init.txt]] (in data/init/) with a text editor and change the entries FONT, FULLFONT, GRAPHICS_FONT, and GRAPHICS_FULLFONT to the filename of your new tileset.

====Creature Graphics====
Put the graphic set ''into a subfolder'' in raw/graphics and the corresponding text file directly in raw/graphics. If you have an active save you will have to put them into the raw folder of your save as well (data/save/<your region>/raw/graphics). Finally, set GRAPHICS to YES in data/init/[[init.txt]]

====Color Scheme====
Replace colors.txt in data/init with your new colors.

===True Type Font===
Replace font.ttf in data/art with your new font.

==See Also==
*[[Creature token]]
*[[Syndrome]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
{{Category|Interface}}

Graphics token

2023-01-07T06:56:26Z

BarelyCreative: Moved the graphics usage explanation to the graphics page. Simplified to just tokens.

Scheduling

2023-01-07T05:53:42Z

BarelyCreative: /* Orders */ Fixed link to squads page

{{Quality|Unrated}}{{av}}

No matter how much you micromanage your '''[[military]]''', your '''[[squads]]''' won't be able to get stronger or protect you from ambushes without proper scheduling practices. With practice, you'll be able to set your '''[[soldier]]s''' to follow a complicated annual training regimen, patrol major trade routes, defend important areas, or any combination of these... all with a few clicks.

The military is now controlled entirely through the squad menu, which can be accessed with the {{Menu icon|q}} key or with the banner icon in the bottom right of the main game screen. A squad must be selected by using the checkbox to the right of its name to edit its schedule, and the squad must be set to the desired routine by selecting it through the "Schedule" menu. From here, all schedulable training, defense, and patrol orders are configured within the "View monthly schedule" submenu by editing monthly orders.

==Passive defense==
The scheduling system is a feature that is versatile but initially difficult to understand. Once you learn the system, though, you will find that you barely need to manage your military at all. Effectively, a schedule selectable routine for a squad to follow, broken up by month, and different routines can be quickly and easily swapped in order to apply different schedules of your choosing to different squads of your choosing.

It is possible to give your squads different monthly schedules, create different routines which will cause squads to follow new user-programmed instructions depending on circumstance, give direct orders to attack one or more specific targets or move to a specific location, or follow patrol routes and stations with greater accuracy. The entire system (including routine names) is completely configurable, and in time you will find yourself using complicated scheduling to rotate squads between training and defending/patrolling specified areas over the course of a year without any user input, or to start defending the fort entrance or trade route with a few easy clicks.

There is a clear distinction between ''active'' orders and ''passive'' orders — the former is used for making unexpected orders to deal with a threat, the latter is a typical schedule that a dwarf will follow year-round and acts more as a defense method. The main ''squads'' menu is predominantly used for active commands, and the ''Schedule'' menu is used for passive commands. This article will focus on the '''passive''' commands you can leave your squads to follow.

For more information on '''active''' commands, see '''[[Squads]]'''.

===Routines===
The '''routine''' is a fundamental concept of passive military management. In each routine, you can program instructions for your military dwarves to follow. The game contains four routines by default — '''Off Duty,''' '''Staggered Training,''' '''Constant Training,''' and '''Ready'''. In '''Off Duty''', a squad is assigned no orders and civilian equipment. In '''Staggered Training''', a squad is assigned to train and wear military equipment in alternating blocks of 3 months each. In '''Constant Training''', a squad is assigned to train the entire year. Finally, in '''Ready''', a squad has no orders, but is assigned to wear military equipment the entire year. By default, your squads will all be set to '''Off Duty''' — in this state, they will tend to spend most of their idle time in the barracks doing individual combat drills, or in the case of some dwarves, only perform civilian work. You will need to add more routines if you want them to do anything more complicated than this.

Individual squads can be set to a certain routine by selecting the squad in the squad menu, clicking "Schedule," then clicking the appropriate routine. Squads can only be set to one routine at a time, so selecting one routine for a group removes them from the previous one.

Note that civilians can not currently be assigned to orders based on military routines and may need to be directed to safety using a [[burrow]] if your fortress is [[siege|attacked]].

====Making Routines====

[[File:Squad schedule menu v5004.png|thumb|right|300px|'''Squad Schedules''' menu with four squads assigned to the default routines.]]
Each squad can be given multiple routines to follow for an entire year, broken up by month. Each squad has a monthly schedule for each routine; it can be swapped between these routines with the procedure outlined in the previous section. Without monthly schedules, routines would do nothing; without routines monthly schedules would be inefficient to switch between; the two functions co-exist and rely on each other. The monthly schedule screen can be accessed from the '''Schedule''' menu by clicking the "View monthly schedule" button. Alternatively, all monthly orders for a routine can be edited at once directly from the Schedule menu by clicking "Clear" to remove any existing orders and "Edit" to begin bulk editing.

On the main monthly scheduling page you will see the name of the squad you are currently editing in the top left, a list of months down the left side and a list of routines for this squad the top edge. Scheduling is done separately for each month and routine; to begin editing click the "Edit" button on one of the months. If you have more routines than can be displayed along the top edge, a small yellow arrow button will appear next to the routine names to scroll between them. Scroll up and down to navigate the month list, and select any visible month to begin editing it. The orders for each month are displayed in green in the month's cell.

When you've decided which month to edit, click the "Edit" button to open the order menu. From here, you can use the four buttons at the bottom to quickly assign a new order. From left to right, these buttons create a '''Station''', '''Patrol Route''', '''Defend Burrow''', or '''Train''' order. To create a '''Defend Burrow''' order, you will first need to set up the appropriate [[burrow]], but '''Patrol Route''' allows you to create and save routes directly through a sub-menu by clicking on the map, and '''Station''' simply requires clicking the map to select a station location. Unlike the others, '''Train''' does not require a location to be set within the monthly orders menu, but rather a valid '''[[barracks]]''' zone must be defined and the squad must be assigned to train in it. Unneeded orders can be deleted by clicking the "cancel" (red circle with a line through it) button next to each assigned order. When you have finished editing the orders, click "Done editing" to save them.

Orders have soldier-based 'order criteria' that list how many soldiers in the squad the order will be assigned to at once. Using the '+' and '-' buttons next to "Minimum soldiers to follow new order" you can choose how many soldiers in the squad that the order will apply to at any one time. By default this number is ten. If you have it set to ten, the Squad will all follow it even if the squad does not have enough members, if you set it to one, only one soldier will be required to go at a time. You can also select specific positions within the squad by using the checkboxes next to each squad position to set those positions as 'preferred'. The order will then try to pick these dwarves to follow the orders if there are multiple off-duty dwarves to choose from. When you are done, click "Done editing" to save the order and return to the monthly schedule screen. If desired, multiple orders criteria can be set for each month. For example, a squad could be set to assign two soldiers to station in the tavern, four soldiers to patrol the entrance hallway, and three dwarves to train while leaving the other three dwarves idle.

Note that the text displayed on each cell (like "Train") can be completely customized text; it does '''NOT''' necessarily reflect the actual orders in the cell! When you are editing an order, you can click the text box or the feather quill icon next to it to edit the label and save it by pressing {{k|enter}}. If you do not change this name, or if you remove all orders for the month, the cell will automatically update with the current assigned orders. It is recommended to leave the name blank if you are only giving a single order, however, if you want to keep track of multiple orders per routine per month a descriptive name can be useful.

To eliminate some of the tedium in scheduling many months, you can copy-paste orders from one cell to another by clicking the "Copy" and "Paste" buttons. Press "Copy" button in the cell you want to copy from, then go to the cells you want to paste to and press "Paste" in each one.

===Orders===
:''If you were redirected here while looking for information on moving your squads to a certain point on command, you may be looking for the [[Squads#Squad#Station_order|squad movement]] section on the [[squads]] page. Multiple orders can be given to a squad by while editing monthly orders by selecting a new order from one of the bottom four buttons; this can be useful if you want part of a squad on patrol duty and another part training, or part of a squad training, and the other half stood down. Unneeded orders can be deleted by clicking the 'cancel' (red circle with a line through it) button next to each assigned order.

The five types of scheduling orders are listed below:

====Inactive / no order====
When dwarves have an empty spot in their schedule, dwarves with good [[discipline]] skill will visit the barracks and train themselves in their spare time - if you see a dwarf doing "Individual training" when they're free, that's what's happening. Technically this is not an order applicable in the monthly orders menu - it is a ''lack'' of an order. Training jobs that are not specifically ordered will be colored green in the {{Menu icon|u}}nits menu.

====Train====
For your dwarves to train, a '''[[barracks]]''' must be designated. This can be done through using {{Menu icon|z}} to open the zone menu and the blue banner "Barracks" button to designate a barracks zone. To make use of the barracks zone, a squad must be assigned to it from the zones menu by clicking the 'banner with a plus' button then using the 'bed', 'axe', 'cabinet', and/or 'chest' button to define how exactly they this barracks. Many pieces of furniture are useful within a barracks, including [[bed]]s, [[armor stand]]s, [[weapon rack]]s, and [[container|containers]]. Dwarves within the squad aren't assigned any furniture in particular, so they'll just use whatever they feel like, similar to a dormitory{{verify}}.

While being edited, barracks can be renamed with the 'quill' button, used for sleeping with the 'bed' button, training with the 'axe' button, individual equipment storage with the 'cabinet' button, and/or squad equipment storage with the 'chest' button. You can choose if a squad trains in one place and sleeps in another, or in multiple, and so on. Multiple squads can overlap with one barracks. The tooltips indicate that the individual equipment storage option will make dwarves store their assigned weapons and armor in the selected barracks, while the squad equipment storage option will cause them to store equipment designated for that squad such as ammunition when not in use.

To get marksdwarves to train in any way other than bashing each other with their crossbows, they must have quivers, an [[archery target|archery range]], and ammunition. Archers will not fire bolts without a quiver to store them in (i.e. they will not hold a single stack in their hand). The archery range is set up for the squad via building an archery target and creating an "Archery Range" zone around it. Marksdwarves are capable of training more than archery, so if they are assigned a barracks to train at they may train without an archery range (although since this training raises archery skills much more slowly, many players attempt to avoid it). If you are having trouble getting marksdwarves to train, see the appropriate section of the [[Military F.A.Q.]] for more information.

When dwarves are being ordered to train, squad members will set up training demonstrations for particular skills, or they will have dwarves spar. Any dwarves in the squad that don't qualify for these will default to individual training.

====Defend burrows====
After a [[burrow]] has been created in the {{Menu icon|U}} menu, you can order your dwarves to defend it. If an enemy enters the burrow (and is not hiding) the assigned squads will be alerted and attack it. It is unknown if a soldier defending a burrow is limited to his line-of-sight or is simply aware that an enemy is present.

====Station====
Stations are defined from within the monthly order "Edit" menu. Simply adjust the number of soldiers you want following the order, click the 'Station' - green arrow button, and click a point on the map where you want a squad to stand to define the order.

====Patrol Route====
Routes are made similarly to stations. Click the 'Patrol' - three red X button to open the route selection submenu, then either choose an existing route or define a new one by choosing "Create new route" then clicking at least two spots on the map and hitting "Confirm". As you define the route, a preview of the path will appear to show which order the soldiers will through the points. This preview does not reflect the exact path they will take and only shows the shortest line between subsequent points. Existing routes can be viewed and edited from the select route menu by clicking the 'Inspect' magnifying glass button. Because patrol routes can be saved and used by multiple squads, it is highly recommended to name them as you define them by clicking the text box or quill icon, typing a descriptive name, and pressing {{k|enter}}.

Routes are very useful for Marksdwarves. They don't like to resupply their ammo when faced with an enemy. If you have a route with two waypoints in the firing platform, and two bracketing the ammo supply, the dwarves will be able to find their ammo when empty{{verify}}.

===Instructors and demonstrations===
Members of a squad with relatively high experience in a [[combat skill]] will lead the group during a [[training]] session. This can be in the form of a demonstration. Instructors gain [[teacher|teaching]] experience, while students gain [[student]] and [[concentration]] experience. Higher levels of these skills make demonstrations more effective[http://www.bay12forums.com/smf/index.php?topic=85279.0 source]. Observing demonstrations (with typically non-existent teacher/student/concentration skills) is not as effective as practicing and sparring. To encourage sparring, create at least half as many training orders each month as you have members in the squad with two soldiers minimum for each order (i.e. a squad of 10 hammerdwarves with 5 training orders requiring 2 soldiers each).

===Individual combat drill===
Otherwise unoccupied soldiers often go to the barracks for individual combat drills regardless of the routine of their squad, if the squad to which the dwarf is assigned has any Training barracks available. Dwarves assigned to an inactive squad will remain civilians, although off-duty soldiers with high discipline tend to ignore all civilian labors if training is an option. Because of this, if you want your 'reserve' squad to actually do civilian work when not needed to defend the fort, it's preferable to disable their barracks assignment.

==Frequently asked questions==
''See [[Military F.A.Q.]]''

{{Military}}
{{Category|Military}}
[[ru:Scheduling]]

Graphics

2023-01-07T04:54:01Z

BarelyCreative: Added premium graphics section with basic usage instructions.

Graphics token

2023-01-07T00:28:39Z

BarelyCreative: /* Layered Conditons */ Added additional known conditions for shutoff and material flag

{{Quality|Unrated}}
{{av}}
{{old}}
{{Modding}}

The <code>[OBJECT:GRAPHICS]</code> [[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.

Making custom graphics requires multiple interacting files to function:
# An 8bit RGBA (sometimes called 32bit) "imagename.png" in the <code>\<mod_id>\graphics\images</code> folder
# A "tile_page_name.txt" in the <code>\<mod_id>\graphics</code> folder
# A "graphics_type_name.txt" in the <code>\<mod_id>\graphics</code> folder

Mods can reuse any graphics loaded ahead of them (including vanilla) by using the same tile page token.

== Tile Page ==

Tile pages link image files to a tile page token so they can be referenced by the graphics file. Just like all other [[Raw file]]s, Tile Pages must be defined from within a properly named "tile_page_<name>.txt" file and follow:

tile_page_<name>

[OBJECT:TILE_PAGE]

After the object type is defined as above, any number of tile pages can be defined according to the format below.

[TILE_PAGE:<tile page identifier>]
[FILE:images/imagename.png]
[TILE_DIM:<tile x dim>:<tile y dim>]
[PAGE_DIM_PIXELS:<page x dim>:<page y dim>]

* ''tile page identifier'': The Internal ID being created for the image.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''tile x dim'': The width of each tile in pixels (usually 32).
* ''tile y dim'': The height of each tile in pixels (usually 32).
* ''page x dim'': The width of the image file in pixels.
* ''page y dim'': The height of the image file in pixels.

Known issues:
* Currently it is only recommended to use <code>[TILE_DIM:32:32]</code> as only the upper left 32x32 pixels are displayed on tiles defined larger, and smaller tiles are displayed starting from the upper left of each in-game square (individually by tile with large graphics) rather than centered and bottom justified as might be expected.
* It is important that the <code>[PAGE_DIM_PIXELS:<x dim>:<y dim>]</code> matches the size of the referenced image exactly - as the game will stretch tile pages with a dimension larger than the actual image by inserting blank lines, and a tile page smaller than the image will cause a crash to desktop.

== 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 <code>[OBJECT:GRAPHICS]</code> token that tells the game that the file contains graphics definitions.

=== Basic Graphics ===
The most basic form of creature graphics is a single tile, defined below:
[CREATURE_GRAPHICS:<creature id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''[[#Condition|condition]]'': The condition the creature needs to be in for this image to be displayed. Use <code>DEFAULT</code> for generic graphics.
* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[#Tile page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''color type'': (optional) Frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}
* ''[[#Condition|secondary condition]]'': (optional) An additional condition that must be satisfied for the image to be displayed.

When the condition {{token|DEFAULT|g}} is used, this graphic will be displayed for the creature in all conditions unless additional, more specific conditions are also defined.

==== Caste Graphics ====
Creature caste graphics allow a simple alternative to [[#Layered Graphics:|Layered Graphics]] to represent males and females of a creature with different images.
[CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being specifically defined.

Creature caste graphics only accept <code>MALE</code> and <code>FEMALE</code> as caste id's even in custom creatures that have more than two castes.

==== Large Graphics ====
The only difference between graphics for large creatures and small creatures is the addition of <code>LARGE_IMAGE</code> and additional coordinates to the line below:
[<condition>:<tile page identifier>:LARGE_IMAGE:<x1>:<y1>:<x2>:<y2>:<color type>:<secondary condition>]

* ''LARGE_IMAGE'': This tag allows a rectangular image with multiple tiles to be defined by its upper left and lower right tiles. Valid for 1x1 - 3x2 tiles.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.

Large images and small images can be used within the same <code>CREATURE_GRAPHICS</code> or <code>CREATURE_CASTE_GRAPHICS</code> definition, and in fact it is often useful to include a single tile image to act as a {{token|LIST_ICON|g}} for menus.

==== Statue Graphics ====
Statue graphics are the generic images placed on top of a pedestal whenever a creature is the primary subject of a statue. The image is implied to occupy multiple tiles, and all examples in vanilla are 1x2 vertical rectangles. Statue graphics are defined as below:
[STATUE_CREATURE_GRAPHICS:<creature id>]
[DEFAULT:STATUES_LAYERED:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.

=== Layered Graphics ===
Layered graphics are a method for displaying overlapping body parts, equipment, clothing, professions, hairstyles.. etc. They allow much more freedom in conditions than normal [[#Creature Graphics|Creature Graphics]], and they allow combinations of many graphical variations within the same creature to give your graphics more personality and display more information about the individuals. All layered graphics started as shown below:
[CREATURE_GRAPHICS:<creature id>]
[LAYER_SET:<condition>]

* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[#Condition|condition]]'': The condition the creature needs to be in for this set of layers to be displayed.

Once you start defining a Layer Set, you can begin adding individual layers from the bottom up to create your final image. For example, if you want to draw a helmet being worn on a head, you would define the head layer first, then define the helmet layer. Layers are defined according to this format:

[LAYER:<layer name>:<tile page id>:<x position>:<y position>:<color type>]

* ''layer name'': The internal name of the layer. Only one layer with the same name is displayed at a time.{{verify}}
* ''[[#Tile page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''LARGE_IMAGE:x1:y1:x2:y2'': (optional) Allows a multiple tile image to be displayed. Replaces <x position>:<y position>.
* ''color type'': (optional) Frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}

==== Layered Conditons ====
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| marks the end of a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code>

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|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
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token|profession token(s)]]
|| General
|| Checks the profession of the creature to act as a condition. Multiple profession tokens can be chained together.

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child or baby.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* {{token|SYN_CLASS}}
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Valid values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|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}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}.

|}

=== Forgotten Beast Graphics ===
Forgotten beast graphics define layered graphics based on which body parts are present in each procedurally-generated forgotten beast.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x1>:<y1>:<x2>:<y2>:<beast body token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': X position of the lower right tile.
* ''y2'': Y position of the lower right tile.
* ''beast body token'': The internal ID of generated forgotten beast body types and body parts.

The <code>TILE_GRAPHICS_RECTANGLE</code> token displays a large image with the upper left corner being defined by <x1>, <y1> and the lower right corner defined by <x2>, <y2>. The <beast body token> is a conditional token that causes the graphics for each layer to be displayed only when the forgotten beast has that particular body type or part.{{verify}}

There is not currently a way to use procedurally defined graphics like this for non-{{token|FEATURE_BEAST|c}} creatures.{{verify}}

=== Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} and is younger than one of those ages.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}.

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

Special Conditions for {{token|VERMIN|c}} creature graphics:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out.

==See Also==
*[[Palette token]]
*[[Body detail plan token]]
*[[Body token]]
*[[Creature token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-01-06T18:43:01Z

BarelyCreative: /* Creature Graphics */ Added statue and layer graphics

{{Quality|Unrated}}
{{av}}
{{old}}
{{Modding}}

The <code>[OBJECT:GRAPHICS]</code> [[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.

Making custom graphics requires multiple interacting files to function:
# An 8bit RGBA (sometimes called 32bit) "imagename.png" in the <code>\<mod_id>\graphics\images</code> folder
# A "tile_page_name.txt" in the <code>\<mod_id>\graphics</code> folder
# A "graphics_type_name.txt" in the <code>\<mod_id>\graphics</code> folder

Mods can reuse any graphics loaded ahead of them (including vanilla) by using the same tile page token.

== Tile Page ==

Tile pages link image files to a tile page token so they can be referenced by the graphics file. Just like all other [[Raw file]]s, Tile Pages must be defined from within a properly named "tile_page_<name>.txt" file and follow:

tile_page_<name>

[OBJECT:TILE_PAGE]

After the object type is defined as above, any number of tile pages can be defined according to the format below.

[TILE_PAGE:<tile page identifier>]
[FILE:images/imagename.png]
[TILE_DIM:<tile x dim>:<tile y dim>]
[PAGE_DIM_PIXELS:<page x dim>:<page y dim>]

* ''tile page identifier'': The Internal ID being created for the image.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''tile x dim'': The width of each tile in pixels (usually 32).
* ''tile y dim'': The height of each tile in pixels (usually 32).
* ''page x dim'': The width of the image file in pixels.
* ''page y dim'': The height of the image file in pixels.

Known issues:
* Currently it is only recommended to use <code>[TILE_DIM:32:32]</code> as only the upper left 32x32 pixels are displayed on tiles defined larger, and smaller tiles are displayed starting from the upper left of each in-game square (individually by tile with large graphics) rather than centered and bottom justified as might be expected.
* It is important that the <code>[PAGE_DIM_PIXELS:<x dim>:<y dim>]</code> matches the size of the referenced image exactly - as the game will stretch tile pages with a dimension larger than the actual image by inserting blank lines, and a tile page smaller than the image will cause a crash to desktop.

== 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 <code>[OBJECT:GRAPHICS]</code> token that tells the game that the file contains graphics definitions.

=== Basic Graphics ===
The most basic form of creature graphics is a single tile, defined below:
[CREATURE_GRAPHICS:<creature id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''[[#Condition|condition]]'': The condition the creature needs to be in for this image to be displayed. Use <code>DEFAULT</code> for generic graphics.
* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[#Tile page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''color type'': (optional) Frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}
* ''[[#Condition|secondary condition]]'': (optional) An additional condition that must be satisfied for the image to be displayed.

When the condition {{token|DEFAULT|g}} is used, this graphic will be displayed for the creature in all conditions unless additional, more specific conditions are also defined.

==== Caste Graphics ====
Creature caste graphics allow a simple alternative to [[#Layered Graphics:|Layered Graphics]] to represent males and females of a creature with a different image.
[CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]

* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being specifically defined.

Creature caste graphics only accept <code>MALE</code> and <code>FEMALE</code> as caste id's even in custom creatures that have more than two castes.

==== Large Graphics ====
The only difference between graphics for large creatures and small creatures is the addition of <code>LARGE_IMAGE</code> and additional coordinates to the line below:
[<condition>:<tile page identifier>:LARGE_IMAGE:<x1>:<y1>:<x2>:<y2>:<color type>:<secondary condition>]

* ''LARGE_IMAGE'': This tag allows a rectangular image with multiple tiles to be defined by its upper left and lower right tiles. Valid for 1x1 - 3x2 tiles.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.

Large images and small images can be used within the same <code>CREATURE_GRAPHICS</code> or <code>CREATURE_CASTE_GRAPHICS</code> definition, and in fact it is often useful to include a single tile image to act as a {{token|LIST_ICON|g}} for menus.

==== Statue Graphics ====
Statue graphics are the generic images placed on top of a pedestal whenever a creature is the primary subject of a statue. The image is implied to occupy multiple tiles, and all examples in vanilla are 1x2 vertical rectangles. Statue graphics are defined as below:
[STATUE_CREATURE_GRAPHICS:<creature id>]
[DEFAULT:STATUES_LAYERED:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': The x position of the lower right tile.
* ''y2'': The y position of the lower right tile.

=== Layered Graphics ===
Layered graphics are a method for displaying overlapping body parts, equipment, clothing, professions, hairstyles.. etc. They allow much more freedom in conditions than normal [[#Creature Graphics|Creature Graphics]], and they allow combinations of many graphical variations within the same creature to give your graphics more personality and display more information about the individuals. All layered graphics started as shown below:
[CREATURE_GRAPHICS:<creature id>]
[LAYER_SET:<condition>]

* ''creature id'': The [[Creature token|Creature ID]] of the creature the graphics represent.
* ''[[#Condition|condition]]'': The condition the creature needs to be in for this set of layers to be displayed.

Once you start defining a Layer Set, you can begin adding individual layers from the bottom up to create your final image. For example, if you want to draw a helmet being worn on a head, you would define the head layer first, then define the helmet layer. Layers are defined according to this format:

[LAYER:<layer name>:<tile page id>:<x position>:<y position>:<color type>]

* ''layer name'': The internal name of the layer. Only one layer with the same name is displayed at a time.{{verify}}
* ''[[#Tile page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''x position'': The x position of the graphic to be displayed in tiles counting from 0 (left→right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
* ''LARGE_IMAGE:x1:y1:x2:y2'': (optional) Allows a multiple tile image to be displayed. Replaces <x position>:<y position>.
* ''color type'': (optional) Frequently replaced with <code>AS_IS</code> in vanilla [[Raw|RAW]]s. ColorTypeEnum{{cite|DF language server|https://gitlab.com/df-modding-tools/df-raw-language-server/-/blob/dev/df_ls_structure/src/objects/graphics.rs}}

==== Layered Conditons ====
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.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Type
! Description

|-
| {{text_anchor|LAYER_GROUP}} || || Layer Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} || || Layer Group
| marks the end of a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|CONDITION_ITEM_WORN}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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.
For example, a condition representing a right handed mitten or glove would be defined as:
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code>

|-
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
* BY_CATEGORY / BY_TOKEN
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|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 <code>WIELD:WEAPON:ANY</code>.

|-
| {{text_anchor|CONDITION_DYE}} ||
* dye color
|| Armor
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_NOT_DYED}} || || Armor
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}

|-
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
* material flag
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags include:
* WOVEN_ITEM
* ANY_WOOD_MATERIAL
* ANY_BONE_MATERIAL
* ANY_SHELL_MATERIAL
* ANY_PLANT_MATERIAL
* ANY_SILK_MATERIAL
* ANY_YARN_MATERIAL
* IS_DIVINE_MATERIAL
* IS_CRAFTED_ARTIFACT

|-
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
* material token
|| Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal.

|-
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
* [[Unit type token|profession token(s)]]
|| General
|| Checks the profession of the creature to act as a condition. Multiple profession tokens can be chained together.

|-
| {{text_anchor|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:
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
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.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
* integer
|| General
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.

|-
| {{text_anchor|CONDITION_CHILD}} || General ||
|| Checks if the creature is a child.

|-
| {{text_anchor|CONDITION_NOT_CHILD}} || General ||
|| Checks if the creature is an adult.

|-
| {{text_anchor|CONDITION_GHOST}} || General ||
|| Checks if the creature is a ghost.

|-
| {{text_anchor|CONDITION_SYN_CLASS}} ||
* {{token|SYN_CLASS}}
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Valid values include:
* ZOMBIE
* NECROMANCER
* VAMPCURSE
* RAISED_UNDEAD
* GHOUL
As well as any mod-defined Syndrome Classes.{{verify}}

|-
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
* BY_CATEGORY
* [[Body_token#CATEGORY|body part category]] or ALL
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
|| Tissue
|| Selects a tissue layer to use for checking other conditions. Ex:
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>

|-
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.

|-
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
* integer
|| Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.

|-
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
* [[Color#Color_tokens|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.

|-
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
* styling token
|| Tissue
|| Checks the current {{token|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}}

|-
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue
|| Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.

|-
| {{text_anchor|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 {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}.

|}

=== Forgotten Beast Graphics ===
Forgotten beast graphics define layered graphics based on which body parts are present in each procedurally-generated forgotten beast.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x1>:<y1>:<x2>:<y2>:<beast body token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x1'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y1'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''x2'': X position of the lower right tile.
* ''y2'': Y position of the lower right tile.
* ''beast body token'': The internal ID of generated forgotten beast body types and body parts.

The <code>TILE_GRAPHICS_RECTANGLE</code> token displays a large image with the upper left corner being defined by <x1>, <y1> and the lower right corner defined by <x2>, <y2>. The <beast body token> is a conditional token that causes the graphics for each layer to be displayed only when the forgotten beast has that particular body type or part.{{verify}}

There is not currently a way to use procedurally defined graphics like this for non-{{token|FEATURE_BEAST|c}} creatures.{{verify}}

=== Conditions ===
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Accepts Secondary
! Description
|-
| {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below.

|-
| {{text anchor|CHILD}} || Yes || Will only be displayed if the creature has a {{token|CHILD|c}} or {{token|BABY|c}} and is younger than one of those ages.

|-
| {{text anchor|ANIMATED}} || Yes || Displayed if the creature is risen from the dead (has {{token|NOT_LIVING|c}} or {{token|OPPOSED_TO_LIFE|c}}){{verify}}

|-
| {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies.

|-
| {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature.

|-
| {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature.

|-
| {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/

|-
| {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}}

|-
| {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}}
|}

Special Conditions for {{token|VERMIN|c}} creature graphics:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Condition
! Description
|-
| {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}}

|-
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.

|-
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.

|-
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.

|-
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.

|-
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.

|-
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc in small groups.

|-
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc in large groups.

|-
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.

|-
| {{text anchor|REMAINS}} || Vermin corpses.

|-
| {{text anchor|HIVE}} || Vermin hives.
|}

== Item Graphics ==
Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out.

==See Also==
*[[Palette token]]
*[[Body detail plan token]]
*[[Body token]]
*[[Creature token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Graphics token]]

Graphics token

2023-01-06T13:46:45Z

BarelyCreative: Addition of basic how-to's for creature graphics.

Template:V50 modding

2023-01-04T14:11:13Z

BarelyCreative: grouped entity-related tokens

{{Sidebar
| name = Template:v50 modding
| title = [[Modding]]<hr>
| contentstyle = font-size: 12px; padding-left: 5px; text-align: center;

| heading1 = <big>[[Token]]s</big>
| content1 = [[Biome token|Biome]]{{*}} [[Building token|Building]]{{*}} [[Graphics token]]{{*}} [[Interaction token|Interaction]]{{*}} [[Labor token|Labor]]{{*}} [[Mod info token|Mod info]]{{*}} [[Personality trait|Personality]]{{*}} [[Plant token|Plant]]{{*}} [[Reaction]]{{*}} [[Skill token|Skill]]{{*}} [[Syndrome token|Syndrome]]{{*}} [[Unit type token|Unit type]]{{*}} [[World token|World]]

| heading2 = Body tokens
| content2 = [[Body token|Body]]{{*}} [[Body detail plan token|Body detail plan]]{{*}} [[Bodygloss]]{{*}} [[Tissue definition token|Tissue definition]]

| heading3 = Creature tokens
| content3 = [[Creature token|Creature]]{{*}} [[Creature mannerism token|Creature mannerism]]{{*}} [[Creature texture token|Creature texture]]{{*}} [[Creature variation token|Creature variation]]

| heading4 = Descriptor tokens
| content4 = [[Descriptor color token|Descriptor color]]{{*}} [[Descriptor pattern token|Descriptor pattern]]{{*}} [[Descriptor shape token|Descriptor shape]]

| heading5 = Entity tokens
| content5 = [[Entity token|Entity]]{{*}} [[Ethic]]{{*}} [[Language token|Language]]{{*}} [[Position token|Position]]

| heading6 = Item tokens
| content6 = [[Item token|Item]]{{*}} [[Item definition token|Item definition]]{{*}} [[Ammo token|Ammo]]{{*}} [[Armor token|Armor]]{{*}} [[Instrument token|Instrument]]{{*}} [[Tool token|Tool]]{{*}} [[Trap component token|Trap component]]{{*}} [[Weapon token|Weapon]]

| heading7 = Material tokens
| content7 = [[Material token|Material]]{{*}} [[Material definition token|Material definition]]{{*}} [[Inorganic material definition token|Inorganic material definition]]
}}<includeonly>[[ru:{{PAGENAME}}]]</includeonly><noinclude>[[Category:Sidebars]][[Category:Navigation templates]]</noinclude>

Template:Menu icon

2023-01-04T13:21:13Z

BarelyCreative: Added to Category:Templates, removed inaccurate shortcut link

{{#if:{{{num|}}}|{{#ifexpr:{{{num|4}}}-{{#if:{{{4|}}}|1|0}}-{{#if:{{{3|}}}|1|0}}-{{#if:{{{2|}}}|1|0}} > 0 |[[File:Ui {{{1|<noinclude>b</noinclude>}}}.png]]{{k|{{{1|<noinclude>b</noinclude>}}}}}{{#ifexpr: {{#if:{{{2|}}}|1|0}} and {{{num|4}}}-{{#if:{{{4|}}}|1|0}}-{{#if:{{{3|}}}|1|0}} > 0 | {{{sep|}}}}}}}{{#ifexpr: {{#if:{{{2|}}}|1|0}} and {{{num|4}}}-{{#if:{{{4|}}}|1|0}}-{{#if:{{{3|}}}|1|0}} > 0 |[[File:Ui {{{1}}}{{{2}}}.png]]{{k|{{{2}}}}}{{#ifexpr: {{#if:{{{3|}}}|1|0}} and {{{num|4}}}-{{#if:{{{4|}}}|1|0}} > 0 | {{{sep|}}}}}}}{{#ifexpr: {{#if:{{{3|}}}|1|0}} and {{{num|4}}}-{{#if:{{{4|}}}|1|0}} > 0 |[[File:Ui {{{1}}}{{{2}}}{{{3}}}.png]]{{k|{{{3}}}}}{{#if:{{{4|}}} | {{{sep|}}}}}}}{{#if:{{{4|}}}|[[File:Ui {{{1}}}{{{2}}}{{{3}}}{{{4}}}.png]]{{k|{{{4}}}}}}}|[[File:Ui {{{1|<noinclude>b</noinclude>}}}.png]]{{k|{{{1|<noinclude>b</noinclude>}}}}}{{#if:{{{2|}}}|{{{sep|}}}[[File:Ui {{{1}}}{{{2}}}.png]]{{k|{{{2}}}}}}}{{#if:{{{3|}}}|{{{sep|}}}[[File:Ui {{{1}}}{{{2}}}{{{3}}}.png]]{{k|{{{3}}}}}}}{{#if:{{{4|}}}|{{{sep|}}}[[File:Ui {{{1}}}{{{2}}}{{{3}}}{{{4}}}.png]]{{k|{{{4}}}}}}}}}<noinclude>
----

===Examples of Appearance===

Selected from the {{Menu icon|b}} build menu.

===Usage===

<pre><nowiki>{{Menu icon|b}}</nowiki></pre>

Multiple keys can be passed as separate parameters to this template, with the "sep" parameter determining the separator (the default is an empty string), and the number of icons to display, counting from the end, as the "num" parameter (the default displays 4 icons).

<pre><nowiki>{{Menu icon|key|sep=separator>|num=number}}</nowiki></pre>

{|class="wikitable"
|-
|``<nowiki>{{Menu icon|b|o}}</nowiki>`` || {{Menu icon|b|o}}
|-
|``<nowiki>{{Menu icon|num=1|b|o}}</nowiki>`` || {{Menu icon|num=1|b|o}}
|-
|``<nowiki>{{Menu icon|b|o|sep=,}}</nowiki>`` || {{Menu icon|b|o|sep=,}}
|-
|``<nowiki>{{Menu icon|b|sep=+|o|f|}}</nowiki>`` || {{Menu icon|b|sep=+|o|f|}}
|-
|``<nowiki>{{Menu icon|b|o|b|sep=-}}</nowiki>`` || {{Menu icon|b|o|b|sep=-}}
|-
|``<nowiki>{{Menu icon|b|o|l|y|sep=&rarr;|num=2}}</nowiki>`` || {{Menu icon|b|o|l|y|sep=→|num=2}}
|}
----
See also: {{t|key}}
[[Category:Inline formatting templates]]
{{documentation}}
</noinclude>

v0.34:Saved game folder

2023-01-04T13:07:04Z

BarelyCreative: Changed categorization to Template:Category

{{Quality|Exceptional|21:05, 11 May 2013 (UTC)}}
{{av}}

The '''saved game folder''' is the location in where a certain region's information and necessary files are stored and accessed by ''Dwarf Fortress''. Knowledge on the technicals of the saved game folder is crucial if one wishes to [[Importing and exporting worlds|import or export saves]].

== Location ==
Individual [[world generation|worlds]] are stored in the '''data/save/''' directory in the Dwarf Fortress root directory. By default, they are saved in the format: ''region#'', where # is a number, starting with region1 and then incrementing; however, world directories can be renamed without consequence '''if the game is not running''' (this will not change the actual name of the world). On modern versions of Windows, if Dwarf Fortress is installed in the Program Files directory, the saved game folders are instead located at "Users\Myname\Appdata\Local\VirtualStore\Program Files\Dwarf Fortress\data\save" unless the game was invoked with "Run as Administrator".

If you have modified your [[d_init.txt]] to seasonally backup, then the backup folders will be named ''region#-season-year'', for example region1-spr-202.

This can become confusing if you frequently [[cheating|savescum]]. There is no way to change the name of these folders inside the game, but it is safe to change them using the standard methods of your operating system if the game is not running. However, '''never''' alter or delete the folder with the name of the game you're playing ''while saving'' from the game, or while that game is running! This can cause fatal flaws many dwarf-seasons later, and is one known cause of the "Nemesis Unit Load Failed" crash error.

== Contents ==
The saved game folder will usually have these contents:

* A subdirectory, ''raw'', containing the raws directly copied from the time the world was generated.
** Inside here is an ''objects'' folder containing the contents of the raws. This must be kept, but the contents inside can be modified to an extent.
** There is also a ''graphics'' folder for [[Graphics set repository|graphics]] for creatures.
** Finally, there may be an ''interaction examples'' folder. This, along with any files or folders not present in the aforementioned two folders, can be safely deleted.
* A series of files named ''art_image-#.dat''. As their name would suggest, these files store information about art and are necessary for proper functioning. Don't replace!
* A series of files named ''feature-#-#.dat''. The amount of these files is heavily dependent on the size of the world, and they store the information about map features (such as [[river]]s, [[cavern]]s, [[magma sea]]s, and [[adamantine|spires]]). Replacing these files will very rarely crash the game, but usually will cause unwanted effects such as magma seas present on the surface. These files do not seem to cause too many crashes when removed, and do not exist in some peculiar worlds.
* A series of files named ''region_snapshot-#.dat''. These are the historical maps available in [[Legends|Legends mode]].
* A series of files named ''site-#.dat''.
* A series of files named ''unit-#.dat''. Replacing these has been known to cause the infamous Nemesis Unit Load Failed error. Resolving the aforementioned error, however, involves copying these over from a previous backup of the save. Depending on the size of the world, there could easily be thousands of these files, making it infeasible to send the saved game folder without compressing it all in one file first.
* Depending on the mode currently active (or the lack thereof), a large file named ''world.sav'' or ''world.dat''. In [[fortress mode]], this file is named ''world.sav'' and includes the current fortress data, as well as the world data. In a save without a currently active game, this is the main save folder. The custom raws generated for the [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[night creature]]s, and [[Evil|evil effects]] are stored in this file. Replacing this entire file will almost certainly crash the game; however, replacing certain portions of the raws included may still keep the save folder working.

Missing one or more of the aforementioned important files may indicate a problem with the save; this is a very common source of crashes.

For basic backups, though, all you need to keep to is: Always copy the whole folder, not parts of it.

== Backing up saves ==
Toady recommends that you make backups, and always save to a fresh file:

# Copy the relevant region folder in "data/save" to a safe location.
# When you want to reuse it, copy that region back to "data/save".

Do '''not''' overwrite an old folder, as it might leave residual files.

Although the game has permanent death and you might want to play it in that spirit, the game is also an alpha, can crash, and your world can become corrupted by an error. You can also make use of the auto save features settable in "data/init/d_init.txt". Making backups can save you a lot of grief.

For more info on the autosave feature, see [[d_init.txt]].

==Disappearing saves==

Restoring a savegame from backup can be very confusing.

The game saves to the directory from which it was loaded, so if you restore a game from a seasonal save after a crash, you will be saving to the folder from which you loaded (like [region1-spring-1056]) and not to your default folder (like [region1]) where you would expect it.

This can cause some high blood pressure and panic, because you will see your 'Region X' save as several years older than you would expect it and it will look like you lost all your work since last autosave to some bug. The save you need to load is however going to be in the slot from which you loaded from automatic backup.

The golden rule is: if you want to restore a savegame from backup, you should rename that backup to indicate that. Remember to do that while the game is not running, per the instructions for savescumming above.

==Warning==
Save folders can be large, ranging from 20 MB for small saves to several hundred megabytes for large saves. If you run out of hard drive space while saving, Dwarf Fortress will ''pretend'' to save correctly, but the save will be unloadable. Opening other saves to verify that they still work, then saving and exiting, will corrupt your previously-working saves as well. Make sure you have sufficient free disk space before launching Dwarf Fortress! {{bug|2587}}

{{Category|Modding}}

DF2014:Saved game folder

2023-01-04T13:06:29Z

BarelyCreative: Changed categorization to Template:Category

{{Quality|Exceptional|21:05, 11 May 2013 (UTC)}}
{{av}}

The '''saved game''' files are the files that store a player's progress in ''Dwarf Fortress''. The game can be saved manually or automatically.

The '''saved game folder''' is the location where the files and information corresponding to each [[world generation|world]] (also referred to by, at least, the game, given the default characterisation of the file names as "regions") are stored and accessed by ''Dwarf Fortress''. Knowledge on the technicalities of the saved game folder is crucial if one wishes to change their computer, make a backup, or wants to share a save with someone else.

See also: [[Importing and exporting worlds]].

== Saving ==
At any time when you are playing Dwarf Fortress, you can manually save the game through the escape menu option. Simply hit {{key|Esc}} and then select Save Game. Doing so assumes you want to exit and it will take you back to the main menu. Dwarf Fortress only permits one save per world: there are no do-overs!

You can make use of auto-save feature, which allows to periodically (Seasonally or Yearly) save the game. This can be seen as either a way to prevent loss of progress or removing the ability to correct mistakes and change decisions made during the course of play forcing you to rely on skills instead of on the ability to retry indefinitely. To enable '''auto-save''' functionality and controlling its behavior, see: [[d_init.txt]].

Although the game has permanent death and you might want to play it in that spirit, the game is also in alpha, can crash, and your world can become corrupted by an error. You can make use of a auto-backup feature, which will create a copy of your saves so that you'll have several copies of your world at different times. To enable '''auto-backup''' functionality, see: [[d_init.txt]]. Making backups can save you a lot of grief.

== Save folder format ==
{| class=wikitable style="float:right; margin:10px;"
|
[[File:Folder-orange.svg|20px|link=]] save
 &emsp;[[File:Folder.svg|20px|link=]] current
 &emsp;[[File:Folder.svg|20px|link=]] region#
 &emsp;[[File:Folder.svg|20px|link=]] region#-year-month-day
|}

Your saved games are located in your ''Dwarf Fortress'' [[save game folder]]. The save folder will contain one or more sub-folders, each one holding one of your worlds, and a "current" folder. The "current" folder is used to track the changes to the active world while ''Dwarf Fortress'' is running; it is not important unless ''Dwarf Fortress'' is open, and can safely be deleted otherwise.

By default, individual worlds are saved in the format: ''region#'', where # is a number, starting with region1 and then incrementing; however, world directories can be renamed without consequence '''if the game is not running''' (this will not change the actual name of the world). If using auto-backup, then backup folders will be named ''region#-year-month-day'', for example region1-00202-01-01. (In versions prior to v0.43, the format was ''region#-season-year'' (for example region1-Spring-202) instead.)

This can become confusing if you frequently [[cheating|savescum]]<abbr id="info" class="information" title="To reload the last saved game whenever the player character dies or an unfavorable outcome has been encountered.">‡</abbr>. There is no way to change the name of these folders inside the game, but it is safe to change them using the standard methods of your operating system if the game is not running. However, '''never''' alter or delete the folder with the name of the game you're playing ''while saving'' from the game, or while that game is running!

=== Contents ===
The saved game folder will usually have these contents:

* A subdirectory, ''raw'', containing the raws directly copied from the time the world was generated.
** Inside it, is an ''objects'' folder containing the contents of the raws. This must be kept, but the contents inside can be modified to an extent.
** There is also a ''graphics'' folder for [[Graphics set repository|graphics]] for creatures.
** Finally, there may be an ''interaction examples'' folder. This, along with any files or folders not present in the aforementioned two folders, can be safely deleted.
* A series of files named ''art_image-#.dat''. As their name would suggest, these files store information about art and are necessary for proper functioning. Don't replace!
* A series of files named ''feature-#-#.dat''. These files store information about map features such as [[river]]s, [[cavern]]s, [[magma sea]]s, and [[adamantine|hidden fun stuff]]. These files are only generated for parts of the world you have explored (e.g. by embarking in Fortress mode), but using the Site Finder will tend to generate them for the entire world. Replacing these files will usually cause unwanted effects such as magma seas present on the surface or spires of [[adamantine]] spiraling up into the sky.
* A series of files named ''region_snapshot-#.dat''. These are the historical maps available in [[Legends|Legends mode]].
* A series of files named ''site-#.dat''. These files store the detailed map data of previously abandoned or retired fortresses.
* A series of files named ''unit-#.dat''. These contain the details of historical creatures which might potentially visit your fortress. Prior to version 0.44.10, modifying or deleting these files would lead to the dreaded "Nemesis Unit Load Failed" crash, but now the game will attempt to gracefully recover from such corruption by regenerating the unit from other available information.
* Depending on the mode currently active (or the lack thereof), a large file named ''world.sav'' or ''world.dat''. In [[fortress mode]], this file is named ''world.sav'' and includes the current fortress data, as well as the world data. In a save without a currently active game, this is the main save folder. The custom raws generated for the [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[night creature]]s, and [[Evil|evil effects]] are stored inside this file. Replacing this entire file will almost certainly crash the game; however, replacing certain portions of the raws included may still keep the save folder working.

Missing one or more of the aforementioned important files may indicate a problem with the save; this is a very common source of crashes.

For basic backups, though, all you need to keep to is: Always copy the whole folder, not parts of it.

== Manually backing up saves ==
Toady recommends that you make backups, and always save to a fresh file:

# Copy the relevant region folder in "data/save" to a safe location.
# When you want to reuse it, copy that region back to "data/save".

Do '''not''' overwrite an old folder, as it might leave residual files.

== Restoring saves ==
: ''See also: [[Save compatibility]]''

Restoring a savegame from backup can be very confusing: The game saves back to the directory you loaded, so if you load a seasonal save, the game will save to that folder (e.g. [region1-01056-01-01]) and not to the original folder ([region1]) where you might expect it.

This can cause some high blood pressure and panic when you see your 'Region X' save is several years older than expected, and it might look like you lost all your (fortress/adv party) work to some bug. The "missing" save is, however, going to be in the directory you loaded previously. ''Dwarf Fortress'' lists the in-game year of each save on the right of the load screen; the highest year will generally be the most recent save (unless you've savescummed from earlier saves).

''Dwarf Fortress'' autosaves to the original folder and then copies the save to a backup folder, so you should generally be able to recover from a crash by simply loading the 'main' save folder--it should be as recent as the latest "backup" save. If you want to load a backup savegame, it's recommended that you copy/rename the save to indicate that. For instance, using the examples above, copy [region1-01056-01-01] to [region1-fix] and continue play on that save (creating new backup saves of the form [region1-fix-01056-04-01]). Remember to only modify saves while the game is not running, per the instructions for savescumming above.

'''Warning''': Save folders can be large, ranging from 20 MB for small saves to several hundred megabytes for large saves. If you run out of hard drive space while saving, ''Dwarf Fortress'' will ''pretend'' to save correctly, but the save will be unloadable. Opening other saves to verify that they still work, then saving and exiting, will corrupt your previously-working saves as well. If you don't want the game to save, just kill the application. Make sure you have sufficient free disk space before launching ''Dwarf Fortress''! {{bug|2587}}

==Hints==
On Linux or macOS, you can replace the ''raw'' directory with a symbolic link to ''../../../raw'' if you want to save a few megabytes on every backup. [http://www.bay12forums.com/smf/index.php?topic=145908| Forum thread].

{{Category|Modding}}
[[ru:Saved game folder]]

DF2014:Token

2023-01-04T13:05:39Z

BarelyCreative: Changed categorization to Template:Category

{{Quality|Superior|17:08, 20 April 2018 (UTC)}}
{{av}}
{{Modding}}
In ''Dwarf Fortress'', a '''token''' is a piece of text that defines the properties of an object. An "object" could be a material, a type of tissue, an organ, a piece of armor, a creature, a biome, a civilisation, or anything else in the game. A "property" could be how large something is, what it is made from, its melting temperature, its name, its biome preference (for civilisations) or anything else that makes it unique. All information associated with the properties of an object in the game is defined using tokens. Tokens are found in the [[raws]], and can be easily [[modding|modified]], allowing users to create (and distribute) new content.

:* [[Ammo token]]s define ammunition, such as arrows and bolts.
:* [[Armor token]]s define armor.
:* [[Biome token]]s define environments for creatures, plants and entities (entities being civilisations).
:* [[Building token]]s define buildings.
:* [[Body token]]s determine bodily structure and materials.
:* [[Body detail plan token]]s define some details of a body, similar to body tokens.
:* [[Bodygloss]] tokens perform a single-word substitution of a creature's body parts.
:* [[Creature token]]s determine the properties of creatures.
:* [[Creature variation token]]s are used to create creatures derived from other already-existing creatures, without duplicating every single token.
:* [[Descriptor color token]]s define colors used in text-based descriptions. Not to be confused with [[color scheme]]s.
:* [[Descriptor pattern token]]s define color patterns.
:* [[Descriptor shape token]]s define [[shape]]s.
:* [[Entity token]]s define entities, or [[civilization]]s.
:* [[Item token]]s define the most basic form of items (made specific by material tokens). Item tokens are mainly used in [[reactions]].
:* [[Item definition token]]s are used for actual definitions of items.
:* [[Instrument token]]s define instruments.
:* [[Interaction token]]s define interactions.
:* [[Labor token]]s define labors.
:* [[Language token]]s define a language's vocabulary. Since fictional languages in ''Dwarf Fortress'' are currently only used in names, language tokens do not define grammar.
:* [[Material token]]s are used to refer to materials, similar to item tokens.
:* [[Material definition token]]s are used to define materials, similar to item definition tokens.
:* [[Inorganic material definition token]]s are used to define inorganic materials, similar to material definition tokens.
:* [[Plant token]]s define plants.
:* [[Position token]]s define positions in entities.
:* [[Skill token]]s reference skills.
:* [[Syndrome token]]s define syndromes.
:* [[Tissue definition token]]s define tissues.
:* [[Tool token]]s define tools, similar to weapon tokens.
:* [[Trap component token]]s define traps.
:* [[Unit type token]]s are referred to by tilesets and entities, for purposes of nobility and the like.
:* [[Weapon token]]s define weapons.
:* [[World token]]s are used in custom world generation.

Also note [[reactions]], which are a little more complicated than simple tokens.

This [http://www.bay12games.com/forum/index.php?board=13.0 forum] is the official DF subforum dedicated to discussions about modding.

== See also ==
{{catbox|DF2014:Tokens}}

* [[Raw file]]
* [[Modding]]
* [[Dipscript]]
* [[Speech file]]

{{Category|Modding}}
[[ru:Token]]

23a:Token

2023-01-04T13:04:41Z

BarelyCreative: Changed categorization to Template:Category

{{Quality}}
{{av}}

In Dwarf Fortress, a '''token''' is a piece of text that defines the properties of an object. An "object" could be a material, a piece of armor, a creature, a biome, a civilisation, or anything else in the game. A "property" could be how large something is, what it is made from, its name, its biome preference (for civilisations) or anything that makes it unique. All information associated with the properties of an object in the game is defined using tokens. Tokens are found in the [[Raw file|raws]], and can be easily [[modding|modified]], allowing users to create (and distribute) new content.

:* [[Ammo token]]s define ammunitions, such as arrows and bolts.
:* [[Armor token]]s define armor.
:* [[Biome token]]s define environments for creatures, plants and entities (entities being civilisations).
:* [[Body token]]s determine bodily structure.
:* [[Bodygloss]] tokens perform a single-word substitution of a creature's body parts.
:* [[Creature token]]s determine the properties of creatures.
:* [[Entity token]]s define entities, or [[civilization]]s.
:* [[Gem token]]s define gems.
:* [[Item token]]s define the most basic form of items (made specific by material tokens).
:* [[Item definition token]]s are used for actual definitions of items.
:* [[Language token]]s define a language's vocabulary. Since fictional languages in Dwarf Fortress are only used in names, language tokens do not define grammar.
:* [[Material token]]s are used to refer to materials, similar to item tokens.
:* [[Plant token]]s define plants.
:* [[Skill token]]s reference skills.
:* [[Stone token]]s define stones. Unlike in later versions, [[ore]]s are hardcoded and cannot be modified.
:* [[Tree token]]s define trees.
:* [[Trap component token]]s define trap components.
:* [[Unit type token]]s are referred to by tilesets, and entities for purposes of nobility and the like.
:* [[Weapon token]]s define weapons.

This [http://www.bay12games.com/forum/index.php?board=13.0 forum] is the official DF subforum dedicated to discussions about modding.

----

'''See Also:'''
* [[Raw file]]
* [[Modding]]
{{Category|Modding}}

40d:Specific heat

2023-01-04T13:01:57Z

BarelyCreative: Changed categorization Template:Category from links to main

{{quality|Fine|16:38, 7 October 2012 (UTC)}}{{av}}

The various SPEC_HEAT tokens control a material's '''specific heat''' capacity.

Specific heat is not a temperature. It is, more or less, the amount of energy it takes to raise the temperature of the material from one temperature to another. Gold, for instance, has a very low specific heat, so it takes very little energy to raise its temperature by one degree. Water, with a very high specific heat, takes 32 times as much energy to raise its temperature by one degree. For more information, see [[wikipedia:Specific heat capacity|Wikipedia]] [http://hypertextbook.com/physics/thermal/heat-sensible/ hypertextbook], and [http://scienceworld.wolfram.com/physics/SpecificHeat.html scienceworld].


'''SPEC_HEAT''' appears to be in units of '''J kg-1 K-1''' at '''STP'''; i.e. '''1000''' times the normally reported '''cp''' in joules per gram per kelvin, or exactly the more rarely reported '''cp''' in joules per kilogram per kelvin.

It is not understood why the game uses the '''°C''' or '''K''' scale here, while using the '''°U''' = '''°F + 9968''' scale elsewhere.

=== Sample specific heats as used by Dwarf Fortress ===

The following values are from Dwarf Fortress version 0.28.181.40d, though most also apply to other versions as well.

{| class="wikitable"
! width="50%" | Material
! width="25%" | cp in J kg-1 K-1
! width="25%" | DF uses

|-
| Adamantine
| n/a
| 7500

|-
| Aluminum
| 897
| 900

|-
| Copper
| 385
| 385

|-
| Carbon (Graphite)
| 710
| 409

|-
| Carbon (Diamond)
| 519
| 409

|-
| Gold
| 129.1
| 129

|-
| Iron, cast 
| ≈500
| 450

|-
| Iron, pig
| >500
| 500

|-
| Iron, pure
| 443
| 450

|-
| Iron, wrought 
| 480-500
| 450

|-
| Nickel
| 444
| 444

|-
| Zinc
| 388
| 390

|-
|
|
|

|-
| Alcohol, ethyl, anhydrous
| 2440
| 2440 (default for plant alcohol)

|-
| Alcohol, ethyl, 100 proof
| 3856
| not in raws

|-
| Meat (beef, carcass, not frozen) 
| 2850
| 4181

|-
| Charcoal
| ≈ 1000
| 409 (hardcoded)

|-
| Cheese (Cheddar, aged 60 weeks) 
| 3012
| 4181 (0.31), 2000 (40d)

|-
| Coke
| 850
| 409 (hardcoded)

|-
| Glass, crystal 
| ≈ 500
| 700 (hardcoded)

|-
| Glass, silica 
| ≈ 840
| 700 (hardcoded)

|-
| Granite 
| 790
| 800 (default for all stone)

|-
| Sand
| 835
| 835 (hardcoded)

|-
| Silk (silkworm?) 
| ≈ 1380
| not in raws

|-
| Silk (hornet)  
| ≈ 1500
| not in raws

|-
| Silk (spider, viscid) 
| ≈ 1400
| 420 (0.31), 1000 (40d)

|-
| Water, liquid, at STP
| 4218
| 4181 (hardcoded)

|-
| Water, solid, at STP
| 2114
| 4181 (hardcoded)

|-
| Wood [[Creature_Tokens/SPEC_HEAT#footnote2|[&dagger;]]]
| 1700 to 2900
| 420 (hardcoded prior to 0.31)

|-
|}

<tt>[&dagger;]</tt>  The specific heat of wood varies somewhat between different species. However, the variance is dominated by the moisture content of the wood. Moreover, wet wood behaves very differently below freezing. See [http://www.fpl.fs.fed.us/documnts/fplgtr/fplgtr09.pdf] 

----

The default value for '''SPEC_HEAT''' depends on the material and on the version of Dwarf Fortress in question.

----
[[wikipedia:Specific heat capacity#Table of specific heat capacities|Wikipedia]] and [http://www.engineeringtoolbox.com/specific-heat-solids-d_154.html engineeringtoolbox] have tables with other materials' specific heats.

References may report specific heat in joules per gram per degree Celsius. Because the Celsius and Kelvin systems use the same scale, differing only in their zero points, this is exactly the same as reporting in joules per gram per kelvin. '''J/g°C''' is equal to '''J/gK'''.

Sometimes references will give specific heat in calories per gram kelvin, or calories per kilogram kelvin. To convert calories per gram kelvin to '''°U''', multiply by '''4184'''. To convert calories per kilogram kelvin to '''°U''' units, multiply by '''4.184'''.

Older references may give specific heat in B.T.U. per pound per degree Fahrenheit. 1 B.T.U. per pound per degree Fahrenheit is by definition equal to 1 calorie per gram per kelvin. '''Btu/lb°F''' is equal to '''cal/gK'''. So just multiply by '''4184''' to convert to '''°U'''.

Sometimes references will report specific heat of liquids or gases in joules (or calories) per [[wikipedia:Mole (unit)|mole]] per kelvin. The symbol for this is '''Cp''' (with a capital C). This is less useful for our purposes, as you will need to know the molecular weight (in grams per mole) of the compound to convert it.
:An example: the molar heat capacity of ethyl alcohol is 113 Joules per mole per degree Centigrade. The molecular weight of ethyl alcohol is 46.07 grams per mole. Divide 113 J/mol°C by 46.07 g/mol, resulting in 2.45 J/g°C. Multiply by 1000 g/kg, resulting in 2450 J/kg°C. That is our desired result in '''DF''' units.

Note that specific ''latent'' heat is a different concept; do not use those values for '''SPEC_HEAT'''.

{{Category|Modding}}
{{Category|Tokens}}

Inorganic material definition token

2023-01-04T12:21:17Z

BarelyCreative: Token-ified some links, added implication of [special] to [deep_special]

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{Modding}}

The following tokens can be used in inorganic material definitions, generally for stones, gems, and metals, but not with materials attached to plants or creatures.
{{clear}}

{| {{prettytable}}
|- style='background-color:#ddd'
! Token
! Arguments
! Description
|-
| {{text anchor|WAFERS}}|| ||Used on metals, causes the metal to be made into wafers instead of [[bar]]s.
|-
| {{text anchor|DEEP_SPECIAL}}|| || Causes the stone to form hollow tubes leading to the [[Underworld]]. Used for [[raw adamantine]]. When mined, stone has a 100% yield. If no material with this token exists, hollow veins will instead be made of the first available inorganic, usually [[iron]]. Implies {{token|SPECIAL|Inorganic}}.
|-
| {{text anchor|METAL_ORE}}|| metal:chance || Allows the ore to be [[smelter|smelted]] into metal in the smelter. Each token with a non-zero chance causes the game to roll d100 four times, each time creating one bar of the type requested on success.
|-
| {{text anchor|THREAD_METAL}}|| metal:chance ||Allows strands to be extracted from the metal at a [[craftsdwarf's workshop]].
|-
| {{text anchor|DEEP_SURFACE}}|| ||Causes the stone to line the landscape of the [[Underworld]]. Used for [[slade]]. When mined (if it's mineable), stone has a 100% yield. If no material with this token exists, other materials will be used in place of slade. Underworld spires will still be referred to as a "spire of slade" in the world's history.
|-
| {{text anchor|AQUIFER}}|| ||Allows the stone to support an [[aquifer]].
|-
| {{text anchor|METAMORPHIC}}|| ||Causes the material to form [[metamorphic layer]]s.
|-
| {{text anchor|SEDIMENTARY}}|| ||Causes the material to form [[sedimentary layer]]s.
|-
| {{text anchor|SOIL}}|| ||Causes the material to form [[soil]] layers, allowing it to appear in (almost) any biome. Mining is faster and produces no stones.
|-
| {{text anchor|SOIL_OCEAN}}|| ||Causes the material to form [[soil|pelagic sediment]] layers beneath deep oceans. Mining is faster and produces no stones.
|-
| {{text anchor|SOIL_SAND}}|| ||Causes the material to form [[sand]] layers, allowing it to appear in [[sand desert]]s and shallow [[ocean]]s. Mining is faster and produces no stones. Sand layers can also be used for making [[glass]]. Can be combined with [SOIL].
|-
| {{text anchor|SEDIMENTARY_OCEAN_SHALLOW}}|| ||Permits an already [SEDIMENTARY] stone layer to appear underneath shallow ocean regions.
|-
| {{text anchor|SEDIMENTARY_OCEAN_DEEP}}|| ||Permits an already [SEDIMENTARY] stone layer to appear underneath deep ocean regions.
|-
| {{text anchor|IGNEOUS_INTRUSIVE}}|| || Causes the material to form [[igneous intrusive layer]]s.
|-
| {{text anchor|IGNEOUS_EXTRUSIVE}}|| || Causes the material to form [[igneous extrusive layer]]s.
|-
| {{text anchor|ENVIRONMENT}}|| class:type:freq ||Specifies what types of layers will contain this mineral. Multiple instances of the same token segment will cause the rock type to occur more frequently, but won't increase its abundance in the specified environment. See below.
|-
| {{text anchor|ENVIRONMENT_SPEC}}|| stone:type:freq ||Specifies which specific minerals will contain this mineral. See below.
|-
| {{text anchor|LAVA}}|| ||Specifies that the stone is created when combining [[water]] and [[magma]], also causing it to line the edges of [[magma]] pools and volcanoes. If multiple minerals are marked as lava stones, a different one will be used in each biome or geological region.
|-
| {{text anchor|SPECIAL}}|| ||Prevents the material from showing up in certain places. AI-controlled entities won't use the material to make items and don't bring it in caravans, though the player can use it as normal. Also, inorganic generated creatures (forgotten beasts, titans, demons) will never be composed of this material. Explicitly set by all [[evil weather]] materials and implied by {{token|DEEP_SURFACE|Inorganic}} and {{token|DEEP_SPECIAL|Inorganic}}.
|-
| {{text anchor|GENERATED}}|| ||Indicates that this is a generated material. Cannot be specified in user-defined raws.
|-
| {{text anchor|DIVINE}}|| ||Found on random-generated metals and cloth. Marks this material as usable by [[Deity]]-created generated entities.
|-
| {{text anchor|SPHERE}}|| [[sphere]] ||Found on divine materials. Presumably links the material to a god of the same sphere.
|}

==ENVIRONMENT and ENVIRONMENT_SPEC==

Format:
* [ENVIRONMENT:<class>:<inclusion type>:<frequency>]

Possible values for class:
{| {{prettytable}}
|- style='background-color:#ddd'
! Environment class token
! Description
|-
| {{text anchor|ALL_STONE}}||Will appear in every stone.
|-
| {{text anchor|IGNEOUS_ALL}}, {{text anchor|IGNEOUS_INTRUSIVE}}, {{text anchor|IGNEOUS_EXTRUSIVE}}||Will appear in igneous layers, either [[igneous intrusive]], [[igneous extrusive]], or both.
|-
| {{text anchor|SOIL}}, {{text anchor|SOIL_OCEAN}}, {{text anchor|SOIL_SAND}}||Will appear in soil. SOIL_OCEAN is oceans specifically and SOIL_SAND is sand specifically.
|-
| {{text anchor|METAMORPHIC}}||Will appear in [[metamorphic]] layers.
|-
| {{text anchor|SEDIMENTARY}}||Will appear in [[sedimentary]] layers.
|-
| {{text anchor|ALLUVIAL}}||Will appear in [[alluvial]] layers.
|}

Possible values for inclusion type:
{| {{prettytable}}
|- style='background-color:#ddd'
! Inclusion type token
! Description
|-
| {{text anchor|CLUSTER}}||Large ovoids that occupy their entire 48x48 embark tile. [[Microcline]] is an example. When mined, stone has a 25% yield (as with layer stones).
|-
| {{text anchor|CLUSTER_SMALL}}||Blobs of 3-9 tiles. Will always be successfully mined. [[Red pyrope]]s are an example. When mined, stone has a 100% yield.
|-
| {{text anchor|CLUSTER_ONE}}||Single tiles. Will always be successfully mined. [[Clear diamond]]s are an example. When mined, stone has a 100% yield.
|-
| {{text anchor|VEIN}}||Large streaks of stone. [[Native gold]] is an example. When mined, stone has a 33% yield instead of the usual 25%.
|}

An inclusion may be contained within a larger inclusion. For example, diamond small clusters are found within kimberlite veins.

The frequency number varies from 1 to 100 and determines the relative frequency at which the stone will be chosen to appear - if all frequency values are the same, then all stones will be equally likely to appear.

ENVIRONMENT_SPEC follows much the same format, but takes a specific stone material ID where ENVIRONMENT would take a class token. What you can use will depend on what inorganic raws are around.

==See also==
* [[Material definition token]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Inorganic material definition token]]

File:Ui bny.png

2023-01-04T11:21:59Z

BarelyCreative: Build - Constructions - Glass window (b-n-y) Category:Interface_images

== Summary ==
Build - Constructions - Glass window (b-n-y)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnt.png

2023-01-04T11:21:34Z

BarelyCreative: Build - Constructions - Stairs (b-n-t) Category:Interface_images

== Summary ==
Build - Constructions - Stairs (b-n-t)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnr.png

2023-01-04T11:21:14Z

BarelyCreative: Build - Constructions - Ramp (b-n-r) Category:Interface_images

== Summary ==
Build - Constructions - Ramp (b-n-r)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnp.png

2023-01-04T11:20:55Z

BarelyCreative: Build - Constructions - Support (b-n-p) Category:Interface_images

== Summary ==
Build - Constructions - Support (b-n-p)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bno.png

2023-01-04T11:20:32Z

BarelyCreative: Build - Constructions - Paved road (b-n-o) Category:Interface_images

== Summary ==
Build - Constructions - Paved road (b-n-o)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnm.png

2023-01-04T11:20:08Z

BarelyCreative: Build - Constructions - Floor bars (b-n-m) Category:Interface_images

== Summary ==
Build - Constructions - Floor bars (b-n-m)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnl.png

2023-01-04T11:19:27Z

BarelyCreative: Build - Constructions - Wall (b-n-l) Category:Interface_images

== Summary ==
Build - Constructions - Wall (b-n-l)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnk.png

2023-01-04T11:19:05Z

BarelyCreative: Build - Constructions - Track (b-n-k) Category:Interface_images

== Summary ==
Build - Constructions - Track (b-n-k)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bng.png

2023-01-04T11:18:38Z

BarelyCreative: Build - Constructions - Floor grate (b-n-g) Category:Interface_images

== Summary ==
Build - Constructions - Floor grate (b-n-g)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnf.png

2023-01-04T11:18:12Z

BarelyCreative: Build - Constructions - Floor (b-n-f) Category:Interface_images

== Summary ==
Build - Constructions - Floor (b-n-f)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnb.png

2023-01-04T11:17:43Z

BarelyCreative: Build - Constructions - Bridge (b-n-b) Category:Interface_images

== Summary ==
Build - Constructions - Bridge (b-n-b)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnY.png

2023-01-04T11:17:18Z

BarelyCreative: Build - Constructions - Gem window (b-n-Y) Category:Interface_images

== Summary ==
Build - Constructions - Gem window (b-n-Y)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnO.png

2023-01-04T11:16:49Z

BarelyCreative: Build - Constructions - Dirt road (b-n-O) Category:Interface_images

== Summary ==
Build - Constructions - Dirt road (b-n-O)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnM.png

2023-01-04T11:16:00Z

BarelyCreative: Build - Constructions - Vertical bars (b-n-M) Category:Interface_images

== Summary ==
Build - Constructions - Vertical bars (b-n-M)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnK.png

2023-01-04T11:15:30Z

BarelyCreative: Build - Constructions - Track stop (b-n-K) Category:Interface_images

== Summary ==
Build - Constructions - Track stop (b-n-K)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnG.png

2023-01-04T11:15:07Z

BarelyCreative: Build - Constructions - Wall grate (b-n-G) Category:Interface_images

== Summary ==
Build - Constructions - Wall grate (b-n-G)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bnF.png

2023-01-04T11:14:37Z

BarelyCreative: Build - Constructions - Fortification (b-n-F) Category:Interface_images

== Summary ==
Build - Constructions - Fortification (b-n-F)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmr.png

2023-01-04T10:58:48Z

BarelyCreative: Build - Machines/fluids - Rollers (b-m-r) Category:Interface_images

== Summary ==
Build - Machines/fluids - Rollers (b-m-r)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmp.png

2023-01-04T10:58:21Z

BarelyCreative: Build - Machines/fluids - Screw pump (b-m-p) Category:Interface_images

== Summary ==
Build - Machines/fluids - Screw pump (b-m-p)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmn.png

2023-01-04T10:57:51Z

BarelyCreative: Build - Machines/fluids - Millstone (b-m-n) Category:Interface_images

== Summary ==
Build - Machines/fluids - Millstone (b-m-n)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmm.png

2023-01-04T10:57:15Z

BarelyCreative: Build - Machines/fluids - Windmill (b-m-m) Category:Interface_images

== Summary ==
Build - Machines/fluids - Windmill (b-m-m)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bml.png

2023-01-04T10:56:46Z

BarelyCreative: Build - Machines/fluids - Lever (b-m-l) Category:Interface_images

== Summary ==
Build - Machines/fluids - Lever (b-m-l)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmh.png

2023-01-04T10:56:26Z

BarelyCreative: Build - Machines/fluids - Water wheel (b-m-h) Category:Interface_images

== Summary ==
Build - Machines/fluids - Water wheel (b-m-h)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmg.png

2023-01-04T10:55:59Z

BarelyCreative: Build - Machines/fluids - Gear assembly (b-m-g) Category:Interface_images

== Summary ==
Build - Machines/fluids - Gear assembly (b-m-g)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ui bmf.png

2023-01-04T10:55:28Z

BarelyCreative: Build - Machines/fluids - Floodgate (b-m-f) Category:Interface_images

== Summary ==
Build - Machines/fluids - Floodgate (b-m-f)
[[Category:Interface_images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}