Editing Graphics token

{{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&rarr;right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top&rarr;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&rarr;right).
* ''y position'': The y position of the graphic to be displayed in tiles counting from 0 (top&rarr;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<br>Group
| Begins defining a layer group. Current effect unknown.{{verify}}

|-
| {{text_anchor|END_LAYER_GROUP}} ||   || Layer<br>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<br>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}} ||
* 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}} ||
* {{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<br>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]]