Dwarf Fortress Wiki - User contributions [en]

Refuse

2025-09-15T04:50:12Z

Qeveren: fixed swapped "corpse" and "refuse" in first paragraph

{{Quality|Exceptional}}
{{av}}
[[File:v50_refuse_preview.png|thumb|right|Dwarf [[children]] love to play "graveyard keeper" here.]]'''Refuse''', though generally garbage, is anything which can be stored in a refuse [[stockpile]]. Such stockpiles will accept:

* [[Corpse]]s, bodyparts and bodily remains of any non-sentient [[creatures]], including things like heads, teeth, and feathers (note that the corpses of undead creatures seem to count as non-sapient even if the living versions clearly would be, and they seem to end up in the corpse section of a refuse stockpile instead of a dedicated corpse stockpile. This is presumably a bug).
* By-products of the [[meat industry|meat]] and [[fishing industry|fishing]] industries ([[bones]], raw hide, [[shell]]s)
* Things which are rotten (rotten meat, rotten meals, rotten raw hide)
* Things the dwarves have no further use for (withered plants, damaged furniture, [[Wear|tattered]] clothes)
* [[Vermin]] remains

== Uses for refuse ==
Despite the name "refuse", some items can be valuable resources for dwarven industries:

===[[Bone]]s===
A single bone can be used to make a stack of bone [[bolt]]s [5], a bone [[crossbow]], 1-3 bone [[craft]]s, or a bone [[decoration]]. Multiple bones can be used to make bone [[armor]] (no breastplates, mailshirts or boots). A stack of bones may be required for some [[strange mood]] creations.
===[[Skin|Raw hides]]===
A raw hide from any size of creature can be tanned at a [[Tanner's shop|tannery]] to produce a single unit of [[leather]]. Leather can be used to make leather clothes, leather armor, leather crafts, [[Equipment#Quivers|quivers]], [[Equipment#Backpacks|backpacks]], [[DF2012:Flask|waterskins]], [[Armor#Shield|shields]], and [[decoration]]s. Leather may be required for some [[strange mood]] creations.

===[[Wool]]===
Butchering or [[Shearer|shearing]] sheep, llamas or alpacas produces a stack of wool. Each unit of wool can be spun into yarn thread at a [[farmer's workshop]]. Yarn thread can then be woven into cloth and used to produce clothes, crafts, and decorations. Woolen cloth may be required for some [[strange mood]] creations.

===[[Hair]]===
The hair of butchered creatures (e.g. [[horse]]s or [[cow|cattle]]) can be spun into [[thread]], too, although such thread can only be used in [[healthcare]], [[bookbinding]], and [[trade]].

===Teeth, ivory, and horn===
These items can be processed by a [[bone carver]] to produce crafts and decorations.

===[[Shell]]s===
Shells can be used to produce a few types of [[armor]], crafts, and decorations. Shells may also be required for some [[strange mood]] creations.

===[[Skull]]s===
The skulls of kittens, poultry and other creatures don't need to lie uselessly in your refuse stockpile. Your [[bone carver]] can use them to make [[totem]]s, a trade good.

===Sapient corpses===
While sapient corpses are still listed as a subcategory of refuse stockpiles, your dwarves may refuse to place them there - instead preferring to use a [[corpse]] stockpile. This does not seem to apply to the formerly-undead, however, which, for some reason, get placed in the corpse section of a refuse stockpile instead of the dedicated corpse stockpile. This distinction is presumably a bug.

Dwarves that come across the corpse of a sapient creature tend to be horrified unless the dwarf has a high level of [[discipline]], cancelling their job and giving the dwarf [[Thought#Injury_and_death|bad thoughts]], so it's generally best to keep corpse stockpiles out of obvious view. Horrified merchants will also scuttle their wagons, drop their merchandise, and flee {{bug|7185}}, which may be undesirable, as there can be diplomatic penalties associated with a merchant losing goods.

Being horrified will also give a small amount of experience towards the [[discipline]] skill, so it's possible to exploit corpse stockpiles to increase the discipline of your dwarves, though this is generally ill-advised due to the high likelihood of [[Insanity|fun]].

== Refuse Stockpiles ==
A refuse stockpile works just like any other [[stockpile]] and is different from a [[Activity zone#Garbage dump|garbage dump]] zone (which accepts items explicitly marked to be dumped). The standard predefined refuse stockpile (designated by {{k|p}}-{{k|r}}) includes all types of refuse. Customized [[Stockpile#Stockpile_Settings|stockpiles]] can allow you to sort out the usable "refuse", the rotting refuse, the unusable but not rotting refuse, or even the [[Siege#Necromancer_sieges|reanimatable]] refuse. Disabling certain types of refuse in all refuse stockpiles will cause those items to accumulate wherever they are produced (eg. bones in the butcher shop) instead of tying up stockpile space.

== Avoiding Miasma ==
Some types of refuse rot, and rotting refuse produces [[miasma]] when in a subterranean tile. To avoid the miasma, you can [[garbage disposal|destroy refuse]] before it rots, or store rotting refuse in a {{DFtext|Light|6:1}} and {{DFtext|Above Ground|2:1}} tile (see [[tile attributes]]). A refuse pile on the surface works, as does exposing any part of your fortress' {{DFtext|Inside |6:0}}{{DFtext|Dark Subterranean|0:1}} tiles to sunlight and then covering them with constructed floors or walls. Such tiles will remain {{DFtext|Light |6:1}}{{DFtext|Above Ground|2:1}} and thus the refuse stored there will not generate any miasma.

== Refuse collection options ==
{{main|Standing orders}}

Refuse items lying outside your fortress will be ignored by default. You can toggle collection of refuse in the [[standing orders]] menu, {{Menu icon|y}}. Note that this setting also controls the collection of "[[dump]]ed" items outside your fortress.

{{Category|Stockpiles}}
{{Category|Items}}
[[ru:Refuse]]

Talk:Civilization and World Info

2025-08-24T02:19:21Z

Qeveren: suggest change of page name

==== Change name of page to "World screen"? ====
The actual UI button to enter this mode is called "Open the world screen"; searching the wiki for "world screen" doesn't bring up this page. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 02:18, 24 August 2025 (UTC)

Millstone

2025-08-05T19:22:25Z

Qeveren: Bags are now a separate category from coffers, no risk of them ending up in bags stockpile.

{{Quality|Exceptional}}
{{V50 machine|name=Millstone|key=n|job=[[Miller|Milling]]
|icon=[[File:millstone_icon.png]]

|construction=
* [[Furniture|Millstone]]
* [[Mechanism]]
|construction_job=
* [[Mechanic]]
|use=
* [[Blade weed]]
* [[Cave wheat]]
* [[Dimple cup]]
* [[Hide root]]
* [[Longland grass]]
* [[Quarry bush|Rock nut]]
* [[Sliver barb]]
* [[Sweet pod]]
* [[Whip vine]]
* An empty [[bag]]
* Cloth [[plant]]s
|production=
* [[Emerald dye]]
* [[Flour|Dwarven wheat flour]]
* [[Dimple dye]]
* [[Redroot dye]]
* [[Flour|Longland flour]]
* [[Quarry bush|Rock nut paste]]
* [[Sliver dye]]
* [[Dwarven sugar]]
* [[Whip vine flour]]
* [[Slurry]]
|power=Needs 10 power.
}}{{av}}

A '''millstone''' is used to grind up certain [[plants]] to make [[sugar]], [[flour]], [[dye]], and [[slurry]]. Each [[milling]] job requires an empty [[bag]]. To operate, it needs to be connected to a mechanical [[power]] source such as a [[water wheel]] or [[windmill]] that supplies it with 10 power units. If none is available, a [[quern]] can be used instead, although millstones process plants much faster than querns. Before they can be placed as a building, you must first construct the millstone at a [[Stoneworker's workshop]].

If the power to the millstone is interrupted, any jobs must be requeued when power is returned. Therefore it is best to have uninterrupted power or at least the ability to run it for a long period of time.

A millstone can be placed in a hanging state, however, it will not actually be constructed as the builder needs to be able to stand on the square on which it is being built. Because of this, a millstone must be powered from above or from the side, not from below in order to be able to complete construction.

Ensuring the exclusive milling of certain plants (to, say, produce only dye, not flour) is quite cumbersome. It requires a stockpile that only allows these plants and setting it to give to the millstone, as it provides no menu to specify what to mill. If you don't set a custom stockpile, the miller will pick the closest random plant, with the usual, occasionally surprising, definition of closest. You also need something like a furniture stockpile that allows only bags, setting that to 'giving' to the millstone too. You still have to ensure somehow that the plants arrive at the right stockpile, for example by not allowing them on any other. Once you got this working repeat for every other plant you want to mill, either switching the 'give' orders every time or setting up a separate millstone for every plant/plant combination.

For general details read [[Stockpile#Give_to_a_stockpile.2Fworkshop|Giving to a Stockpile/Workshop]].

Alternatively, to preserve what little sanity a DF player has left, just forbid all millable plants you don't want milled (for example from the [[stocks]] menu) and (re-)claim them once the milling job is done.

[[File:De re metallica 1556-164.png| thumb| Silly humans using a mechanically powered millstone to grind stuff.]]

==An example setup==
As it is most efficient to set up workshops near their materials sources, usually by putting stockpiles next to them, it's common for millstones to be set up near farm plots. Putting a millstone just under the surface lets it be powered by a windmill on the surface, like so:

::{|style="border: 1px solid #0b0; background: #dfd"
|+'''Side view'''
|- style="font-family: monospace; font-weight: bold; font-size: 135%"
|style="color: #970; padding: 0; text-decoration: underline"|-
|style="color: #970; padding: 0; text-decoration: underline"|=
|style="color: #970; padding: 0; text-decoration: underline"|-
| 
|style="color: #970; padding: 0"|-
|style="color: #970; padding: 0"|=
|style="color: #970; padding: 0"|-
| 
|- style="font-family: monospace; font-weight: bold; font-size: 135%"
|style="text-decoration: underline"| 
|style="text-decoration: underline"|*
|style="text-decoration: underline"| 
|
|style="text-decoration: underline"| 
|style="text-decoration: underline"|*
|style="text-decoration: underline"| 
|- style="font-family: monospace; font-weight: bold; font-size: 135%"
|
|1
|
|
|
|2
|
|}
Note that version 1 only works if the windmill is built first, and version 2 only works if the millstone is built first.

When building a vertically powered millstone, build the components from the bottom up. First place the millstone, then place the vertical axles above the millstone, then place the windmill last.

''For a basic overview of how the different machine parts work and work together, see [[machinery]].''

==Millable plants==
[[Sweet pod]]s can be milled into [[dwarven sugar]].

Other millable plants are listed below.

{| {{prettytable}}
|- style="background:#ddd"
!Plant
!Dye
!colspan=2|Color
!Crop type
!Value
|-
|[[Dimple cup]]
|Dimple Dye
|Midnight Blue
| bgcolor="#003366" |    
|Underground
|20[[Currency|☼]]
|-
|[[Blade weed]]
|Emerald Dye
|Emerald
| bgcolor="#50c878" |    
|Aboveground
|20[[Currency|☼]]
|-
|[[Hide root]]
|Redroot Dye
|Red
| bgcolor="#ff0000" |    
|Aboveground
|10[[Currency|☼]]
|-
|[[Sliver barb]]
|Sliver Dye
|Black
| bgcolor="#000000" |    
|Aboveground
|20[[Currency|☼]]
|}

{| class="wikitable sortable collapsible"
|-
! Crop name
!
! Crop value
! Flour
! Flour value
{{flour table row|name=Cave wheat|tile=τ|colour=7:0|fname=Dwarven wheat flour}}
{{flour table row|name=Longland grass|tile=τ|colour=6:1|fname=Longland flour}}
{{flour table row|name=Whip vine|tile=§|colour=3:1|cprice=1|fprice=25}}
{{flour table row|name=Single-grain wheat|tile=τ|colour=2:0}}
{{flour table row|name=Two-grain wheat|tile=τ|colour=2:0}}
{{flour table row|name=Soft wheat|tile=τ|colour=2:0}}
{{flour table row|name=Hard wheat|tile=τ|colour=2:0}}
{{flour table row|name=Spelt|tile=τ|colour=2:0}}
{{flour table row|name=Barley|tile=τ|colour=2:0}}
{{flour table row|name=Buckwheat|tile=τ|colour=2:0}}
{{flour table row|name=Oats|tile=τ|colour=2:0|fname=Oat flour}}
{{flour table row|name=Rye|tile=τ|colour=2:0}}
{{flour table row|name=Sorghum|tile=τ|colour=2:0}}
{{flour table row|name=Rice|tile=τ|colour=2:0}}
{{flour table row|name=Maize|tile=τ|colour=2:0}}
{{flour table row|name=Quinoa|tile=τ|colour=2:0}}
{{flour table row|name=Kaniwa|tile=τ|colour=2:0}}
{{flour table row|name=Pendant amaranth|tile=τ|colour=2:0}}
{{flour table row|name=Blood amaranth|tile=τ|colour=2:0}}
{{flour table row|name=Purple amaranth|tile=τ|colour=2:0}}
{{flour table row|name=Pearl millet|tile=τ|colour=2:0}}
{{flour table row|name=White millet|tile=τ|colour=2:0}}
{{flour table row|name=Finger millet|tile=τ|colour=2:0}}
{{flour table row|name=Foxtail millet|tile=τ|colour=2:0}}
{{flour table row|name=Fonio|tile=τ|colour=2:0}}
{{flour table row|name=Teff|tile=τ|colour=2:0}}
{{flour table row|name=Flax|tile=τ|colour=2:0}}
{{flour table row|name=Hemp|tile=τ|colour=2:0}}
|}

==Bugs==
* Dwarves will occasionally combine two separate mill products in the same bag.{{bug|4371}}

{{Workshops}}
{{buildings}}
{{Category|Farming Workshops}}

Reaction

2025-08-02T02:54:25Z

Qeveren: /* Automatic */ Verified AUTOMATIC is ignored by quern, millstone, still, and craftsdwarf's workshops, removed 'verify' notes.

{{Quality|Superior}}
{{av}}
{{Modding}}

'''Reactions''' are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. Most manufacturing jobs are [https://github.com/DFHack/df-structures/blob/master/df.job.xml hardcoded]—building beds or creating glass, for example—but a few are data-driven, and it's (sometimes) quite simple to add additional ones. There is a separate page with custom [[reaction examples]].

== Reaction differences between modes ==

In [[fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[entity token|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction — so that if you give your custom civilization a reaction to produce "star metal" or some other custom material, only they will be able to produce it. Exclusive non-{{token|SPECIAL|inorganic}} metals, such as [[steel]], may appear on [[bandit]]s and other entities with access to all materials.

In [[adventure mode]], reactions are freely available in the {{Adv menu icon|x}} create menu, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. There are several bugs with adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

== Anatomy of a reaction ==
Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). All reaction files must begin with the file name, followed by the <code>[OBJECT:REACTION]</code> token that tells the game that the file contains reaction definitions.

The reactions themselves generally adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[MAX_MULTIPLIER:<multiplier>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
[DESCRIPTION:<description>]

* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#Fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#Skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#Max multiplier|multiplier]]'': (optional) If present, the reaction will only be done the specified number of times per job; used to limit the output of reactions that accept stacks of items as reagents.
* ''[[#Automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#Adventure mode enabled|adventure mode enabled]]'': (optional) If present, the reaction can be used by the player in Adventure mode.
* ''[[#Description|description]]'': (optional) If present, shows pop-up description when the reaction is selected in workshop (not working in v50).

=== Reaction identifier ===
The REACTION token assigns a unique ID to your reaction.
[REACTION:<reaction identifier>]

The ''reaction identifier'' may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours. This is referenced in an entity definition via [[Entity_token#PERMITTED_REACTION|PERMITTED_REACTION]] to allow that entity to use the reaction.

=== Reaction name ===
The REACTION_NAME token assigns a descriptive name to your reaction in-game.
[REACTION_NAME:<name>]

==== Name ====
This can be anything at all, and is how the reaction will appear in the job list of the building it is assigned to, and so should describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===
The BUILDING token assigns the reaction to a building. Adding multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings. Omitting the BUILDING token entirely will make the reaction unusable in Fortress mode (often used to restrict certain reactions to [[Reaction#Adventure_Mode_enabled|Adventure mode]]).

[BUILDING:<building name>:<building key>]
* [[#Building name|''building name:'']] The ID of the building the reaction appears in.
* [[#Building key|''building key:'']] The hotkey to queue up the reaction in the specified building.

==== Building name ====
This is the ID of the building where the reaction will be carried out. Valid building names are as follows:

* ASHERY - [[Ashery]]
* BOWYER - [[Bowyer's workshop]]
* CARPENTER - [[Carpenter's workshop]]
* CLOTHES - [[Clothier's shop]]
* CRAFTSMAN - [[Craftsdwarf's workshop]]
* FARMER - [[Farmer's workshop]]
* GLASS - [[Glass furnace]]
* KILN - [[Kiln]] and [[Magma kiln]]
* KITCHEN - [[Kitchen]]
* LEATHER - [[Leather works]]
* MASON - [[Stoneworker's workshop]]
* METALSMITH - [[Metalsmith's forge]]
* MILLSTONE - [[Millstone]]
* QUERN - [[Quern]]
* SIEGE - [[Siege workshop]]
* SMELTER - [[Smelter]] and [[Magma smelter]]
* STILL - [[Still]]
* TANNER - [[Tanner's shop]]
* WOOD - [[Wood furnace]]
* Any custom (raw-defined) building, such as:
** SOAP_MAKER - [[Soap maker's workshop]]
** SCREW_PRESS - [[Screw press]]

==== Building key ====
This used to define the shortcut key(s) used to queue up the reaction in a workshop during gameplay. Doesn't do anything in the current version. {{version|50.01}}

=== Category ===

Categories are custom submenus for buildings' reaction menus. A reaction doesn't require a category, but if you have a lot of reactions, categories can be invaluable for organizing and presenting those reactions to players.

Categories can be nested indefinitely—you can have a category within a category within a category within a category within a category within... but as a practical matter, nesting categories more than 2 deep is not recommended.

Categories will be displayed in alphabetical order, first off the file name and then off the category name.

Categories currently have no effect on adventure mode reactions.

==== Defining a category ====

Each category needs to be defined within a reaction, usually one which should appear within its menu. Categories only need to be defined once.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| CATEGORY || style="vertical-align: top"| Category ID || The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.
|-
| style="vertical-align: top"| CATEGORY_NAME || style="vertical-align: top"| String || The name of the category as displayed in-game.
|-
| style="vertical-align: top"| CATEGORY_DESCRIPTION || style="vertical-align: top"| String || Optional. If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.
|-
| style="vertical-align: top"| CATEGORY_PARENT || style="vertical-align: top"| Category ID || Optional. If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.
|-
| style="vertical-align: top"| CATEGORY_KEY || style="vertical-align: top"| Hotkey token || Optional. If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey. Uses the same format as the BUILDING KEY described above.
|}

==== Adding reactions to an existing category ====

Just include the tag [CATEGORY:<category_id>] within your reaction definition, and if the category exists, your reaction will be added to its menu. You can only add reactions to custom categories.

Each reaction can belong to only one category.

=== Reagents ===

REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#Reagent name|name]]'': The name of the reagent, local to the reaction.
* ''[[#Quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#Item_token|item token]]'': The type (and subtype) of the item you require.
* ''[[#Material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== Name ====

The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reagents are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''', '''FLUX''', or '''seeds''' will also work equally well. The PRODUCT may make reference to this name – for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== Quantity ====

How many or how much of this reagent the reaction requires. For most item types this is just the number of them required. However, some other item types─specifically bars, cloth, thread, globs, liquids, powder, and sheets of paper or parchment─instead use numbers representing the size of the material within one (or more) of these items. For example, while REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items, REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE is an extremely tiny portion of a random spool of thread. One can see which items have what size quantities in the description of the [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] token.

If one of the reagents is in a stack, or the reaction is only using a fraction of the amount of a sized item, the reaction will consume the entire stack, or as much of the sized item as possible, and multiply the product accordingly. This behaviour can be controlled using the [[Reaction#MAX_MULTIPLIER|MAX_MULTIPLIER]] token.

==== Item token ====

[[Item token]]s are of the form ITEM_TYPE:ITEM_SUBTYPE.

The ITEM_TYPE is the category of item you require; WEAPON, TOY or SKIN_TANNED, for example.

The ITEM_SUBTYPE is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, have no subtype and only require the item token to be filled in; so if you're asking for those you should set the subtype to NONE. Subtypes are defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT])—they cannot be used in any other context.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens—this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

When no item type is specified (as in NONE:NONE), workers will not be able to find otherwise eligible items if they are inside of barrels (at least when reagents are PLANT or PLANT_GROWTH type). This is likely a bug.

==== Material token ====

[[Material token]]s come in several forms. For most reagents, this will typically be INORGANIC:MATERIAL_ID or NONE:NONE (to allow multiple materials using other modifier tokens).

Some reactions will allow the player to select specific materials after creating the job (or in [[Reaction#material_token_2|some cases]], armor size from the product), by clicking on the magnifying glass icon next to the job in the workshop queue. To permit this behaviour in your reaction, the reagent materials must be specified as follows:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Item Type
! Material
! Notes
|-
| style="vertical-align: top"| BAR BLOCKS BOULDER ROUGH SMALLGEM || style="vertical-align: top"| INORGANIC:NONE || style="vertical-align: top"| These all appear as "stone" in the material selection menu, and list all inorganic materials regardless of any material modifier tokens, eg. [ITEMS_METAL]. BAR and BLOCKS made of organic materials, and BOULDER made of clay, are excluded.
|-
| style="vertical-align: top"| SKIN_TANNED or WOOD || style="vertical-align: top"| NONE:NONE ||
|-
| style="vertical-align: top"| Other Item Types || style="vertical-align: top"| NONE:NONE || style="vertical-align: top"| These will appear if a material modifier token other than [ANY_LEATHER_MATERIAL] is included.
|}

==== Modifiers ====

Reagents may also have extra tokens added on, following the REAGENT token, in order to modify their behaviour.

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material. Modifiers can then be used to restrict this to only certain broad classes of materials.

The following is a list of all known reagent modifiers:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.
|-
| style="vertical-align: top"| ANY_GEM_MATERIAL
|
| Reagent material must have the [IS_GEM] token.
|-
| style="vertical-align: top"| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.
|-
| style="vertical-align: top"| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.
|-
| style="vertical-align: top"| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.
|-
| style="vertical-align: top"| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.
|-
| style="vertical-align: top"| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.
|-
| style="vertical-align: top"| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.
|-
| style="vertical-align: top"| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.
|-
| style="vertical-align: top"| ANY_STONE_MATERIAL
|
| Reagent material must have the [IS_STONE] token.
|-
| style="vertical-align: top"| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having TISSUE_SHAPE:STRANDS, intended for matching hair and wool. Must be used with USE_BODY_COMPONENT.
|-
| style="vertical-align: top"| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.
|-
| style="vertical-align: top"| ANY_WOOD_MATERIAL
|
| Reagent material must have the [WOOD] token.
|-
| style="vertical-align: top"| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.
|-
| style="vertical-align: top"| BUILDMAT
|
| Reagent must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| style="vertical-align: top"| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| style="vertical-align: top"| CONTAINS
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| Reagent is a container that holds the specified reagent (where ''Reagent name'' is the locally-defined name of the reagent).
|-
| style="vertical-align: top"| CONTAINS_LYE
|
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| style="vertical-align: top"| DOES_NOT_ABSORB
|
| Reagent material must have ABSORPTION:0
|-
| style="vertical-align: top"| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that [[stack]]s of reagents will correctly produce additional outputs.
|-
| style="vertical-align: top"| EMPTY
|
| If the reagent is a container, it must be empty.
|-
| style="vertical-align: top"| FIRE_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| FOOD_STORAGE_CONTAINER
|
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| style="vertical-align: top"| GLASS_MATERIAL
|
| Reagent material must have the IS_GLASS token. All 3 types of [[glass]] have this token hardcoded.
|-
| style="vertical-align: top"| HARD_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_HARD] token.
|-
| style="vertical-align: top"| HAS_EDGE
|
| Reagent must have an edge.
|-
| style="vertical-align: top"| HAS_ITEM_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the item reaction product specified by PRODUCT_ID - [[Reaction#Item_reaction_products|see below]] for more details. This can be used interchangeably with HAS_MATERIAL_REACTION_PRODUCT.
|-
| style="vertical-align: top"| HAS_MATERIAL_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the material reaction product specified by PRODUCT_ID - [[Reaction#Material_reaction_products|see below]] for more details.
|-
| style="vertical-align: top"| HAS_TOOL_USE
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE]] value
| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| style="vertical-align: top"| IS_CRAFTED_ARTIFACT{{verify}}
|
| Reagent item must be an artifact.
|-
| style="vertical-align: top"| IS_DIVINE_MATERIAL
|
| Reagent material must have the [DIVINE] token.
|-
| style="vertical-align: top"| IS_SAND_MATERIAL
|
| Reagent material must have the [SOIL_SAND] token.
|-
| style="vertical-align: top"| MAGMA_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| METAL_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_METAL] token.
|-
| style="vertical-align: top"| METAL_ORE
| style="vertical-align: top"|
* Metal ID
| Reagent material must be an ore of the specified metal.
|-
| style="vertical-align: top"| MIN_DIMENSION
| style="vertical-align: top"|
* Integer
| Reagent's item size must be at least as large as ''Integer''. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, or GLOB for this to work. See [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] below.
|-
| style="vertical-align: top"| NO_EDGE_ALLOWED
|
| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
|-
| style="vertical-align: top"| NOT_ARTIFACT{{verify}}
|
| Reagent item must not be an artifact.
|-
| style="vertical-align: top"| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
|-
| style="vertical-align: top"| NOT_ENGRAVED
|
| Reagent can not be engraved. For example, a memorial slab can not be engraved.
|-
| style="vertical-align: top"| NOT_IMPROVED
|
| Reagent has not been decorated.
|-
| style="vertical-align: top"| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| NOT_WEB
|
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| ON_GROUND
|
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from inventories (workshops, wagon) and causes infinite gathering for reactions in workshop.
|-
| style="vertical-align: top"| POTASHABLE (Deprecated)
|
| Alias for [CONTAINS_LYE].
|-
| style="vertical-align: top"| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| style="vertical-align: top"| REACTION_CLASS
| style="vertical-align: top"|
* CLASS_ID
| Reagent material must have the reaction class specified by CLASS_ID - [[Reaction#Reaction_classes|see below]] for more details.
|-
| style="vertical-align: top"| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| USE_BODY_COMPONENT
|
| Reagent must be a body part (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| style="vertical-align: top"| WEB_ONLY
|
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| WORTHLESS_STONE_ONLY
|
| Reagent material must be non-[[economic]].
|-
| style="vertical-align: top"| WOVEN_ITEM
|
| Reagent must be a clothing item made of a woven material, ie. plant, silk, or yarn cloth.
|}

=== Products ===

Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token [PRODUCT_DIMENSION:X] is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:''name''] token, where the ''name'' is the [[#Reagent name|name]] of a reagent. This requires the reagent to have the [PRESERVE_REAGENT] token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...]

==== Probability ====

The percentage chance the product will be produced when the reaction is completed. Must be an integer.

==== Quantity ====

Determines how many of the product will be produced. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, PLANT_GROWTH, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can—for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

==== Item token ====

The [[item token]] and subtype of the item you produce.

If your item has an [[Reaction#Item reaction products|item reaction product]] and you want the item type and material to be derived from one of the reagents, you can use GET_ITEM_DATA_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of both the item token ''and'' the material token (see next section). You can also specify GET_ITEM_DATA_FROM_REAGENT:reagent:NONE in order to make a direct copy of the source item, though this will not work for complex items such as corpses or prepared meals.

For products, this can also be set to CRAFTS:NONE to produce up to three random [[craft]] items. This value cannot be used in any other context.

==== Material token ====

A [[material token]] describing what the product will be made of.

If you want the product's material to be derived from one of the reagents, you can use GET_MATERIAL_FROM_REAGENT:reagent:NONE in place of the material token in order to directly use the reagent's own material; if the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID to use that.

Similarly to choosing material types for a reagent, if the item product is armor/clothing, and has the appropriate [[Entity_token#Available_resources|armor token]] in the entity file, you will be able to choose the armor/clothing size for different creatures by clicking the magnifying glass of the workshop task. However, this will only work if the product material is [[Modding pitfalls#My_custom_armor.2Fclothing_reaction_won.27t_let_user_choose_size|cloth leather or certain metals]], and the item is also recognized by the related vanilla workshop reaction{{verify}}.

==== Product modifiers ====

Zero or more tokens which further set the properties or disposition of the resulting product item.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.
|-
| style="vertical-align: top"| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.
|-
| style="vertical-align: top"| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| PRODUCT_DIMENSION
| style="vertical-align: top"|
* Integer
| Specifies the dimension of the product for those items that use dimensions. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.
|-
| style="vertical-align: top"| PRODUCT_TO_CONTAINER
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Places the product in a container; ''Name'' must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.
|-
| style="vertical-align: top"| PRODUCT_TOKEN
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Allows the product to be referred to by the given name for the purpose of being passed down as and argument in other tokens, in the same fashion as reagent names.
|-
| style="vertical-align: top"| TRANSFER_ARTIFACT_STATUS
|
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.
|}

=== Improvements ===

Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

==== Probability ====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

==== Reagent name ====
The [[#Reagent name|name]] of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

==== Improvement type ====
The following improvement types can be used:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|-
| PAGES
| Adds pages to a [[book]].
|-
| SPECIFIC
| With subtype ROLLERS, adds rollers of <material> to a [[scroll]]; with subtype HANDLE, adds a handle of <material> to an item; with subtype TRACTION_BENCH_CHAIN or TRACTION_BENCH_ROPE adds a chain or rope of <material> to an item.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

==== Material token ====

A [[material token]] describing what the decoration will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

=== Other tokens ===

==== Fuel ====

The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== Skill ====

The [[Skill token|skill tokens]] determine what skill the reaction requires and trains; also how quickly skill is gained, how quickly those skill gains raise attributes, and how skill level affects the quality of the reaction product.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| SKILL
| style="vertical-align: top"|
* [[Skill token]]
| (Optional) This identifies the skill required to carry out the reaction and is trained when the reaction is performed. Only one skill may be specified; if multiple skill tokens are defined only the last will be used. A reaction with no product will yield no experience gain. A reaction with no SKILL token will complete in a default amount of time.
|-
| style="vertical-align: top"| SKILL_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of skill gained each time the reaction is carried out. The default value is 30; higher values increase the amount of skill gain.
|-
| style="vertical-align: top"| ATTRIBUTE_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of [[Attribute|attribute]] gain that skill gain from this reaction results in. The default value is 10; higher values increase the amount of attribute gain.
|-
| style="vertical-align: top"| SKILL_ROLL_RANGE
| style="vertical-align: top"|
* Range
* Multiplier
| (Optional, requires SKILL token) This changes how much skill level affects the quality of the reaction product. The default is [SKILL_ROLL_RANGE:11:5]. The ''range'' is the base "die roll" and the ''multiplier'' determines how much the dwarf's skill can affect the reaction; the skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1), where random(x) gives a random number from 0 to x-1, inclusive (which also means that the minimum for the range is 1). The higher result on the roll, the better. Both numbers can be lowered to make the skill check harder. For example, with the default values a dwarf who is proficient in a skill has a skill level of 5; their roll will be random(11)+random(13)+random(13), meaning this dwarf can roll anywhere from 0 to 34; similarly, unskilled dwarves can roll 0 to 10 while legendary+0 (skill 15) dwarves can roll 0 to 84. If this is changed to [SKILL_ROLL_RANGE:1:8], then instead a proficient dwarf will have random(1)+random(21)+random(21), giving a roll of 0 to 40, with unskilled dwarves always rolling 0 and legendary dwarves going all the way up to 120.

As a consequence, increasing the multiplier will always make legendary dwarves more effective, even if base roll is reduced to its minimum of 1, with the default going up to 84 for default and 90 for [SKILL_ROLL_RANGE:1:6].
|}

==== Max multiplier ====

The [MAX_MULTIPLIER:<#>] token specifies how many times to do the reaction. This can be used to limit stacked reagent use to the specified quantity instead of the whole stack.

==== Automatic ====

The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]], [[still]] or [[craftsdwarf's workshop]] cannot be made automatic.

==== Mode enabled ====

Some reaction tokens enable a reaction to be used by everyone in a certain mode. These tokens are not exclusive relations; for example, you can assign an {{token|ADVENTURE_MODE_ENABLED|reaction}} reaction with a building to an entity and their citizens can then perform it at that building in [[fortress mode]].

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| ADVENTURE_MODE_ENABLED
| Available to all [[adventurer]]s, regardless of origin civilization. Required for adventurers to craft anything, as they do not use the recipes available to their origin civilization.
|-
| FORTRESS_MODE_ENABLED
| Available to all [[fortress mode]] games. Without {{token|PERMITTED_REACTION|entity}} on a specific entity, materials produced by it will not normally be added to their civilization resources.
|-
| WORLDGEN_ENABLED
| If possible, reaction's output will be added to all civilizations during worldgen, allowing the civilization to trade or embark with them.
|}

==== Description ====

This feature is exclusive to Classic Mode, as no description window pops up when mousing over reactions in workshops in Premium.

The [DESCRIPTION:<string>] token provides a text description of the reaction when it is highlighted in the building UI. Multiple DESCRIPTION tokens can be defined in a reaction, and each will appear on a new line. The pop-up box that contains the description is limited to 325 characters total. Alternatively, this token can reference a DESCRIPTION token in an existing tool definition by replacing ''string'' with USE_TOOL:<ITEM_SUBTYPE>; or an existing instrument definition with USE_INSTRUMENT:<ITEM_SUBTYPE>.

== Reaction classes and products ==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

=== Reaction classes ===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there are a half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with six nearly identical reactions that all take in either dolomite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B asks for "NONE:NONE" as its material. This means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like calcite, here:

[INORGANIC:CALCITE]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:calcite][DISPLAY_COLOR:7:7:1][TILE:'"']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:LIMESTONE:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:MARBLE:CLUSTER_SMALL:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:12902]
[SOLID_DENSITY:2930]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction. Note that some reaction classes have special meanings to the game itself—notably, the [[site finder]] knows that "FLUX" should be connected to the "Flux stone" filter.

=== Material reaction products ===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:TAN_MAT]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:TAN_MAT''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the TAN_MAT reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, the spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named TAN_MAT) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the TAN_MAT hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). For example, skin taken from a butchered dog would be turned into dog leather. Change the SKIN_TEMPLATE MATERIAL_REACTION_PRODUCT to TAN_MAT:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

If the item you're creating should be made of the ''same'' material as the raw material you're using (e.g. if you're carving a log into a training spear), you can specify "NONE" instead of the MATERIAL_REACTION_PRODUCT code:

[REACTION:MAKE WOODEN TRAINING SPEAR]
[NAME:make wooden training spear]
[BUILDING:CARPENTER:NONE]
[REAGENT:log:1:WOOD:NONE:NONE:NONE][ANY_PLANT_MATERIAL]
[PRODUCT:100:1:WEAPON:ITEM_WEAPON_SPEAR_TRAINING:'''GET_MATERIAL_FROM_REAGENT:log:NONE''']
[SKILL:CARPENTRY]

As with reaction classes, some MATERIAL_REACTION_PRODUCT identifiers have special meanings to the game itself - notably, the [[site finder]] knows that "FIRED_MAT" should be connected to the "Clay" filter, and "CHEESE_MAT" is used when making [[cheese]] from [[milk]].

=== Item reaction products ===

Item reaction products are an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA_FROM_REAGENT:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BAG:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

Do note that MATERIAL_REACTION_PRODUCT and ITEM_REACTION_PRODUCT use the same IDs, so you cannot have both a material and item reaction product of the same name. Also, though you cannot use GET_ITEM_DATA_FROM_REAGENT with a MATERIAL_REACTION_PRODUCT (there'd be no item type information), you ''can'' use GET_MATERIAL_FROM_REAGENT on an ITEM_REACTION_PRODUCT (in case you want to force your own item type).

== Reactions and world generation ==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

== Full token list ==

For the sake of convenience and readability, this is a complete compilation of the previously listed reaction tokens in alphabetical order:

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

|-
| style="vertical-align: top"| {{text anchor|ADVENTURE_MODE_ENABLED}}
|
|
| style="vertical-align: top"| This version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage if assigned to a workshop and the civilization has access.

|-
| style="vertical-align: top"| {{text anchor|FORTRESS_MODE_ENABLED}}{{version|Lua beta}}
|
|
| style="vertical-align: top"| This reaction can be accessed when playing as any civilization in [[Fortress mode]], regardless of {{token|PERMITTED_REACTION|e}}. Particularly useful for compatibility or [[Lua scripting]].

|-
| style="vertical-align: top"| {{text anchor|WORLDGEN_ENABLED}}{{version|Lua beta}}
|
|
| style="vertical-align: top"| Adds the materials provided by the reaction to all civilizations, regardless of {{token|PERMITTED_REACTION|e}}.

|-
| style="vertical-align: top"| {{text anchor|ANY_BONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [BONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_GEM_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_GEM] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_HORN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [HORN] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_LEATHER_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [LEATHER] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PEARL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [PEARL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PLANT_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be subordinate to a PLANT object.

|-
| style="vertical-align: top"| {{text anchor|ANY_SHELL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SHELL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SILK_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SILK] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SOAP_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SOAP] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_STONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STRAND_TISSUE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| style="vertical-align: top"| {{text anchor|ANY_TOOTH_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [TOOTH] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_WOOD_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [WOOD] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_YARN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [YARN] token.

|-
| style="vertical-align: top"| {{text anchor|ATTRIBUTE_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of attribute gain given per skill improvement. Default is 10.

|-
| style="vertical-align: top"| {{text anchor|AUTOMATIC}}
|
|
| style="vertical-align: top"| The reaction will be queued automatically if the reaction reagents are all present.

|-
| style="vertical-align: top"| {{text anchor|BAG}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead. Deprecated as of Version 0.50.01 in favor of BAG:NONE [[item token]].

|-
| style="vertical-align: top"| {{text anchor|BUILDING}}
| style="vertical-align: top"|
* [[#building name|Building name]]
* [[#building key|In-building reaction hotkey]]
|
| style="vertical-align: top"| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game.

|-
| style="vertical-align: top"| {{text anchor|BUILDMAT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is able to be used to build structures (Boulders, Wood, Blocks, Bars).

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_ARTIFACT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_HOSPITAL_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[healthcare|hospital]].

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_LOCATION_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[locations|location]].

|-
| style="vertical-align: top"| {{text anchor|CATEGORY}}
| style="vertical-align: top"|
* Category ID
|
| style="vertical-align: top"| Puts the reaction in a category. Categories are custom submenus for reaction menus. The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_NAME}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| The name of the category as displayed in-game.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_DESCRIPTION}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_PARENT}}
| style="vertical-align: top"|
* Category ID
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_KEY}}
| style="vertical-align: top"|
* Hotkey
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey while playing in Classic mode.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is a container that holds the specified reagent.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS_LYE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| style="vertical-align: top"| {{text anchor|DESCRIPTION}}
| style="vertical-align: top"|
* String
|
| style="vertical-align: top"| A description of the reaction that appears when it is highlighted in the building UI. ''String'' can also be replaced with a reference to existing DESCRIPTION tokens in tools (using USE_TOOL:<tool_id>) or musical instruments (using USE_TOOL:<instrument_id>).

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_ABSORB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have [ABSORPTION:0].

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_DETERMINE_PRODUCT_AMOUNT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| style="vertical-align: top"| {{text anchor|EMPTY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must be empty.

|-
| style="vertical-align: top"| {{text anchor|FIRE_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be considered [[fire-safe]] (stable [[temperature]] below {{ct|11000}}) - i.e. not wood, and not coal.

|-
| style="vertical-align: top"| {{text anchor|FORCE_EDGE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is given a sharp edge. Used for knapping.

|-
| style="vertical-align: top"| {{text anchor|FOOD_STORAGE_CONTAINER}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a barrel or any non-absorbing tool with [TOOL_USE:FOOD_STORAGE].

|-
| style="vertical-align: top"| {{text anchor|FUEL}}
|
|
| style="vertical-align: top"| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop.

|-
| style="vertical-align: top"| {{text anchor|GLASS_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material has [IS_GLASS].

|-
| style="vertical-align: top"| {{text anchor|HAS_EDGE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be sharpened (used for carving).

|-
| style="vertical-align: top"| {{text anchor|HAS_ITEM_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to HAS_MATERIAL_REACTION_PRODUCT, but requires the reagents material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| style="vertical-align: top"| {{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to REACTION_CLASS, but requires the reagents material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| style="vertical-align: top"| {{text anchor|HAS_TOOL_USE}}
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE value]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagents item type must be TOOL:NONE for this to make any sense.

|-
| style="vertical-align: top"| {{text anchor|HAS_WRITING_IMPROVEMENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must contain writing.

|-
| style="vertical-align: top"| {{text anchor|IMPROVEMENT}}
| style="vertical-align: top"|
* Probability
* [[#Reagent name|Reagent name]]
* Improvement type
* Material Token
|
| style="vertical-align: top"| Applies an improvement to the named reagent. Only meaningful if said reagent has [PRESERVE_REAGENT]. Improvement types include BANDS, COVERED, GLAZED, PAGES, RINGS_HANGING, and SPIKES

|-
| style="vertical-align: top"| {{text anchor|IS_CRAFTED_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must be an artifact.

|-
| style="vertical-align: top"| {{text anchor|IS_DIVINE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [DIVINE] token.

|-
| style="vertical-align: top"| {{text anchor|MAGMA_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Currently broken - Reagent must be considered [[magma-safe]] (stable [[temperature]] below {{ct|12000}}).

|-
| style="vertical-align: top"| {{text anchor|MAX_MULTIPLIER}}
| style="vertical-align: top"|
* Integer
|
| style="vertical-align: top"| Sets the maximum number of times a reaction is allowed to run when using stacked reagents. This can be used to ensure that the reaction doesn't repeat until the entire stack is depleted.

|-
| style="vertical-align: top"| {{text anchor|METAL_ORE}}
| style="vertical-align: top"|
* Inorganic material
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be an ore of the specified metal.

|-
| style="vertical-align: top"| {{text anchor|MIN_DIMENSION}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires that the reagent have a size of at least ''integer''. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, and GLOB items.

|-
| style="vertical-align: top"| {{text anchor|NAME}}
| style="vertical-align: top"|
* [[#name|Name]]
|
| style="vertical-align: top"| Defines the name used by the reaction in-game.

|-
| style="vertical-align: top"| {{text anchor|NO_EDGE_ALLOWED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.

|-
| style="vertical-align: top"| {{text anchor|NOT_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must not be an artifact.

|-
| style="vertical-align: top"| {{text anchor|NOT_CONTAIN_BARREL_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| style="vertical-align: top"| {{text anchor|NOT_ENGRAVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been engraved i.e. a blank memorial slab.
|-
| style="vertical-align: top"| {{text anchor|NOT_IMPROVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been decorated.

|-
| style="vertical-align: top"| {{text anchor|NOT_PRESSED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|NOT_WEB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| style="vertical-align: top"| {{text anchor|ON_GROUND}}
|
| style="vertical-align: top"| Reagent modifier
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from bins in stockpiles, nor inventories (workshops, wagon). Causes infinite collection of items if reaction is in workshop, as reagents are no longer on ground when brought to workshop. Untested in adventure mode; possibly more useful for adv. mode reactions.

|-
| style="vertical-align: top"| {{text anchor|POTASHABLE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Alias for [CONTAINS_LYE].

|-
| style="vertical-align: top"| {{text anchor|PRESERVE_REAGENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT}}
| style="vertical-align: top"|
*Probability of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
|
| style="vertical-align: top"| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA_FROM_REAGENT can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_DIMENSION}}
| style="vertical-align: top"|
* Size
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Specifies the amount of the product for those items that use dimension. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PASTE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PASTE state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PRESSED}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TO_CONTAINER}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Places the product in a container; reagent name must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TOKEN}}
| style="vertical-align: top"|
* Name
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Allows the product to be referred to by the given name, for the purpose of being passed down as argument in other tokens in the same fashion as reagent names.

|-
| style="vertical-align: top"| {{text anchor|REACTION}}
| style="vertical-align: top"|
* Identifier
|
| style="vertical-align: top"| Defines a new reaction.

|-
| style="vertical-align: top"| {{text anchor|REACTION_CLASS}}
| style="vertical-align: top"|
* CLASS_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
| style="vertical-align: top"| {{text anchor|REAGENT}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
* [[#quantity|Quantity]]
* [[Item token]]
* [[Material token]]
|
| style="vertical-align: top"| Specifies a given reagent as an input for a reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL}}
| style="vertical-align: top"|
* [[Skill token]]
|
| style="vertical-align: top"| Skill used by the reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of skill given per product made. Default is 30.

|-
| style="vertical-align: top"| {{text anchor|SKILL_ROLL_RANGE}}
| style="vertical-align: top"|
* Range
* Multiplier
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Determines how [[skill]] level affects [[quality]] of the reaction product. The skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1). random(x) returns a number between 0 and x-1, so range is always 1 or more. The default is 11. The default multiplier is 5. Higher skill rolls give better results.

|-
| style="vertical-align: top"| {{text anchor|TRANSFER_ARTIFACT_STATUS}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.

|-
| style="vertical-align: top"| {{text anchor|UNROTTEN}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be rotten, mainly for organic materials.

|-
| style="vertical-align: top"| {{text anchor|USE_BODY_COMPONENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must come off a creature's body.

|-
| style="vertical-align: top"| {{text anchor|WEB_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| style="vertical-align: top"| {{text anchor|WORTHLESS_STONE_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not made of an economic stone.

|-
| style="vertical-align: top"| {{text anchor|WOVEN_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be a woven material, eg. plant cloth, silk, yarn. This ''excludes'' CLOTH or THREAD items.

|}

== Examples ==
:''Main articles: [[Reaction examples]]''

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Reaction]]

Dragonfire

2025-07-29T02:17:03Z

Qeveren: /* Characteristics */

{{Quality|Exceptional}}
{{av}}
[[File:Dragonfire v50.png|thumb|right|A dragon spewing forth dragonfire. Its blue/purple color makes it distinct from common fire.]]

'''Dragonfire''' [[File:dragonfire_preview_anim.gif|20px|]] is a very powerful form of [[fire]] that is produced by [[dragon]]s.

==Characteristics==
[[File:Dragon's Breath Spanning Z-Levels.png|thumb|The dragonfire seen here was aimed at a dwarf 1 z-level below, and can be seen affecting both that z-level and the z-level above.]]
Dragonfire forms a rough cone shape from the dragon's front, with a range of approximately 20 tiles and a spread of 10 tiles{{cite talk|v0.34 Talk:Fire#Dragonfire}} which can span through up to two [[z-level]]s, igniting anything flammable caught in the radius. It can be told apart from common fire by its vibrant blue/purple color, though any fires it causes from contact with flammable objects will be the regular red color of flame.

Dragonfire can reach temperatures up to {{ct|50000}}. At that temperature, almost all materials should be destroyed. However, research has shown that dragonfire is quite particular about which objects it affects. When in a tile with dragonfire, organic materials will ignite, even including [[nether-cap]] [[wood]] with its fixed temperature. Non-flammable common [[stone]], [[glass]], and [[ceramic]] items will melt and boil away. Dragonfire is ineffective against [[water]], producing no [[steam]] or evaporation. [[Building]]s (but not [[construction]]s) are affected by dragonfire on their tile, making non-dragonfire-safe [[door]]s immune as long as they remain closed. Objects and buildings (and creatures) made out of [[slade]] are also immune to dragonfire, since the raws do not define a specific heat for slade, not that you can realistically build anything out of it in the first place.

Objects ignited by dragonfire drop to and continue to burn at their standard combustion temperature. However, repeated blasts of dragonfire can sustain much higher combustion temperatures, sufficient even to eventually melt nearby [[adamantine]].

==Defense==
Dragonfire can be extremely dangerous due to its wide spread potentially causing expansive fires in patches of [[grass]] or [[cave moss]] that may consume and melt [[Dwarf|dwarves]] in moments. The rate at which a dragon can breathe dragonfire is also rather quick, allowing the beast to continuously spam the attack so long as it is in combat.

Despite its powerfully destructive nature, dragonfire can be blocked by a simple [[shield]] better than 99% of the time, though this will do nothing to stop the surrounding flames from consuming the creature almost instantly if they are standing on flammable ground. Because of this, the best way to fight dragonfire is to confront the dragon while in non-flammable terrain such as stone; at this point, you just have to contend with the dragon, who may be a fierce opponent in its own right.

Dragonfire is powerful enough to burn and kill [[creature]]s who are immune to conventional fire, like [[fire imp]]s or [[magma crab]]s. The only creatures immune to dragonfire are dragons themselves (to keep them from killing themselves with their own breath), [[cave dragon]]s, and certain [[Demon|deep monsters]].

==Dragonfire-safe materials==
There are very few materials which can withstand the immense heat of dragonfire. Here is the full list:

{| {{prettytable}}
|- bgcolor="#ddd"
! width="8%" | Type
! width="15%" | Material
! width="5%" | Appearance
! width="10%" | [[Melting point]]
! width="10%" | [[Solid density]]
! width="10%" | [[Specific heat]]
! width="8%" | [[Value multiplier]]
! width="34%" | Notes

|-
| Metal
| [[Divine metal]]
| Varies
| None
| 1000
| 7500
| 300
| Found mostly in [[vault]]s

|-
| Leather
| [[Fire imp]] leather
| {{Raw Tile|ß|6:0:0}}
| None
| 500
| 420
| 3
|

|-
| Bone
| [[Fire imp]] bone
| {{Raw Tile|²|7:0:1}}
| None
| 500
| 1000
| 3
|

|-
| Bone
| [[Dragon]] bone
| {{Raw Tile|²|7:0:1}}
| None
| 500
| 30000
| 15
|

|}

==Trivia==
{{Translation| dwarven = måmgoz-ziril | elvish = vutheni-inira | goblin = kusnath-zedan | human = tamun-usmok}}
*Dragonfire's temperature of {{ct|50000}} is the highest set temperature in the game. In comparison, it is hotter than the surface of the Sun, which is around {{ct|20000}}.
*Dragonfire is the highest temperature option that can be picked in the [[object testing arena]].

{{Category|Creature attributes}}
[[Ru:Dragonfire]]

Sand

2025-07-03T21:17:21Z

Qeveren: added link to cave moss for overgrown sand tiles

{{Quality|Exceptional|11:07, 25 February 2023 (CST)}}
{{av}}
[[File:white_sand_floor_preview.png|thumb|160px|right|White sand floor.]]'''Sand''' is one of the many specific types of [[soil]] that can be found in ''Dwarf Fortress''. As all sand types are [[soil]]s, above ground [[farm plot]]s can be built on them without need for [[Irrigation|irrigation]]. Sand can also be used to make [[glass]] (see below).

There are five different colors of sand – [[yellow sand]], [[white sand]], [[black sand]], [[red sand]], and [[sand (tan)|tan sand]] – but their only difference is their appearance on the ground, as there is no difference between them for purposes of [[Glass industry|glassmaking]]. Sand typically appears in [[desert]]s and along [[ocean]] beaches, but is often found in other [[biome]]s as well.

Sandy clay, sandy clay loam, sandy loam, and loamy sand are '''not''' considered sand by the game, and thus cannot be used for glassmaking.

When an underground [[tree]] grows on a muddy stone floor tile (after discovering a [[cavern]]) and is either trampled or cut down, the floor tile turns into a soil type appropriate to the [[biome]]. Although certain biomes lack soil layers altogether (such as [[mountain]]s and [[glacier]]s), their geology data still contains at least one soil type which may be a type of sand. In the case of mountains, however, the same type of soil can also be revealed on the surface by clearing away the initial layer of [[grass]] (which will not regrow once removed).

Sand, unlike normal soil, is always depicted using the {{Tile|≈|6:0}} and {{Tile|~|6:0}} symbols and cannot be furrowed, thus causing unpaved sand [[road]]s to be covered in grass and vegetation much more quickly.

[[Grass]] and [[Cave moss|cave moss]] can grow on sand, which causes the underlying sand to be temporarily unavailable for collection, giving the message "Urist McBagger cancels Collect Sand: Sand vanished" if the job is in progress, or "Urist McBagger cancels Collect Sand: Need valid, active sand collection zone" if the job is new. You can easily remove the grass ''and'' prevent it from growing back by building a paved [[road]] ({{menu icon|b|n|O}}) over the grass; the paved road will ''not'' prevent the sand from being collected. You can also put a floor [[grate]] over a sand floor to prevent growth while allowing sand to be collected, but you must first remove the grass/sapling/shrub; you can do this by placing a dirt road over it.

==Glass==
:''See also: [[Glass industry|Glass industry]]''
Sand is used in the production of [[glass|green and clear glass]] items at a [[glass furnace]] ([[glass|crystal glass]] requires rough [[rock crystal]] in its place).

===Collecting Sand===
To collect sand, first locate some appropriate sand tiles, appearing as "[Color] Sand [Tile]" when you hover over a tile. Next, set a sand collection [[zone]] over or next to the sand tiles, by pressing {{menu icon|z}} and then designating the sand tiles as an activity zone (note that sand can be collected from adjacent sand walls, even diagonally). Then, you must build a [[glass furnace]] and activate the collect sand task.

Each dwarf collecting sand will require a [[bag]], only one dwarf will collect sand per furnace, and no other tasks can be performed at the furnace while sand is being collected. Sand collection requires the "Item Hauling" [[labor]]. The bags of sand will not be taken to the glass furnace; they are left in the sand collection zone, until hauled or dumped or selected for a glass-making job. Note that any sand tile holds an infinite amount of sand.

Filled bags of sand are considered [[furniture]], and. as such, require the "Furniture Hauling" labor to move. Sand bags are stored in furniture [[stockpile]]s with "sand bags" enabled (located under "type"). Note: You must also allow all items under "Core Quality" and "Total Quality" unless you want them to only store certain quality type bags in your stockpiles.

Collected sand is listed under [[powder]] on the [[stocks]] menu. However, if you attempt to dump the sand from this section, the dwarves will dump it from the bags{{bug|3220}} and drop it in useless piles on the floor (as if it were a [[contaminant]]) - this will also happen if you attempt to use {{menu icon|i}} to mass designate sand bags for dumping. Going to the stocks screen and removing the dump order on the sand itself will make the dwarves dump the bags and not the contents, but this must be done before any dwarf can start a sand-dumping job.

To get bags to fill with sand for your fortress, create a [[leather]] bag at a [[leather works]] or a [[cloth]] bag at a [[clothier's shop]], or buy the bags from a caravan. To have sand bags stored near your glass furnace, create a furniture [[stockpile]] with only "sand bags" enabled but with all materials and quality levels still permitted. It may be useful to construct several glass furnaces so that you can have several "collect sand" jobs queued on them at the same time, which helps ensure that you have enough filled sand bags on hand to keep your glassmaker(s) supplied. To create a reoccurring work order filling sand bags you have to manually set a condition. That condition should have the type set to "items" and the adj set to "sand-bearing" so that it reads "sand-bearing items". Set the other conditions as normal.

==Availability==
Not all embark locations have sand available. While this may prevent the establishment of a full glass industry, it does not outright prevent the making of glass at all - individual bags of sand may be purchased during [[embark]] for 1 point apiece (with a free [[bag]] included), and caravans will frequently bring several bags of sand with them each year (plus more, if requested from the [[liaison]]). Additionally, while it is rare, some caverns may contain sand in small amounts.

It is wise to always keep several bags of sand on hand, in order to deal with [[strange mood]]s requiring glass.

{{Translation
| dwarven = cuggán
| elvish = polefa
| goblin = anga
| human = zar
}}

{{D for Dwarf}}



Some dwarves don't like sand because it is coarse and rough and irritating and it gets everywhere.
[[File:Namib Desert, Namibia (Unsplash).jpg|thumb|290px|center|Hills of pre-glass.]]
{{materials}}
{{soil}}

{{Category|Materials}}
[[ru:Sand]]

Graphics

2025-03-15T20:59:28Z

Qeveren: /* Basic Graphics */

{{Quality|Superior}}{{av}}
[[File:graphics_v50_preview.png|209px|right]]
:{{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 '''graphics''' system in v50 is [https://github.com/Putnam3145/Dwarf-Fortress--libgraphics-- open-source]. 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 the game will resize other resolutions into a 32x32 tile. Depending on your zoom and interpolation settings, rescaled tiles can be subject to [Wikipedia:Artifact (error)|artefacting]].
* 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 ==
{{for/see|a list of all known creature graphics tokens|[[Graphics token#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 ===
[[File:Graphics_template_xy_positions.png|thumb|320px|right|An example of how X and Y positions are read, starting from the top left.]]
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.

{| {{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}} || Yes || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise.

|-
| {{token|CDI_LIST_ICON|g}} || Yes || Displayed in interaction menus in Adventure Mode, overrides LIST_ICON when specified in a creature [[Creature token#CAN_DO_INTERACTION|CAN_DO_INTERACTION]] using [[Interaction token#TOKEN|CDI:TOKEN]]:''token_name''. Accepts referenced ''token_name'' before standard secondaries{{verify}}.

|}

=== Caste Graphics ===
Creature caste graphics allow a simple alternative to [[#Layered Graphics|Layered Graphics]] to represent males and females (or other castes) 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]].

=== Large Graphics ===
[[File:Graphics_template_large_3x2.png|right|thumb|A 3x2 large image is rendered in the top center, with the central tile in red.]]
[[File:Graphics_template_large_2x1.png|right|thumb|A 2x1 large image is left-justified.]]
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 ===
[[File:Graphics_template_statues.png|right|thumb]]
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:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

[STATUE_CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[DEFAULT:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being defined.
* ''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.

Statue graphics will be automatically recolored based on how their [[Color#Color tokens|Color]] would appear in the default [[Graphics token#Palettes|palette]], like an item. The image (right) is an example of how a graphic would be aligned within the 1x2 grid. Vanilla statues customarily place the bottom row of pixels on the white line, with the gold box delineating where a 32px tall (exactly) sprite would fit.

=== 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#LAYER_SET|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. Does not need to be unique. 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.

====Portraits====

96x96 portraits{{version|50.13}} are shown in [[Adventure mode]] and when viewing a creature's sheet. They use the same tokens as layered graphics to display a more detailed view of a creature.

A single-layer portrait can be added to a [CREATURE_GRAPHICS] entry with this format:

[LAYER_SET:PORTRAIT]
[LAYER_GROUP]
[LAYER:MAIN:<tile page id>:<x position>:<y position>]
[END_LAYER_GROUP]

See above for the explanation of each argument.

=== Procedural Creature Graphics ===
Procedural graphics define layered graphics based on which body parts are present in each [[Creature token#GENERATED|procedurally-generated]] forgotten beast, titan, or otherwise.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x>:<y>:<width>:<height>:<PCG layering token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''width'': How many tiles right the graphic spans. Usually this is 3.
* ''height'': How many tiles down the graphic spans. Usually this is 2.
* ''[[Creature token#PCG_LAYERING|PCG layering token]]'': The internal ID of a [[procedural graphics layer]], representing 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 <x>, <y> and the size defined by <width>, <height>. The PCG layering 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.

Humanoid [[experiment]]s use <code>TILE_GRAPHICS</code> instead of <code>TILE_GRAPHICS_RECTANGLE</code>, which omits the <width> and <height> parameters.

The {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} token allows a creature to use the generation system for a given [[Graphics token#Basic creature sprite types|sprite type]] (which can be caste-specific), and each {{token|PCG_LAYERING|c}} entry will add that part to the assembled sprite.

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

== Workshop Graphics ==
Workshop graphics are displayed during each stage of construction and when it is completed. There are two layers, the base layer and an OVERLAY layer. The base layer shows the floor, tables, chairs and other basic features. The overlay shows various decorations that give the workshop its unique appearance.

base layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]
overlay layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM_OVERLAY:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]

* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''graphic tile x position'': The x position of the graphic in tiles counting from 0 (left→right).
* ''graphic tile y position'': The y position of the graphic in tiles counting from 0 (top→bottom).
* ''WORKSHOP_CUSTOM'' and ''WORKSHOP_CUSTOM_OVERLAY'': These tokens define the graphics as belonging to a custom workshop. These tokens do not exist in vanilla workshops except for the Soap maker and Screw press, which are used as examples for custom workshops.
* ''workshop id'': The ID of the workshop defined in its raws.
* ''building stage'': What building stage this graphic is displayed during.
* ''workshop tile x position'': The x position of the workshop tile where the graphic is displayed counting from 0 (left→right).
* ''workshop tile y position'': The y position of the workshop tile where the graphic is displayed counting from 0(top→bottom).

Note that an extra Y row is defined above the workshop. This allows for graphics that extend into the tile above the workshop.

Also note that currently custom furnaces do not properly work with premium graphics. The WORKSHOP_CUSTOM and WORKSHOP_CUSTOM_OVERLAY tokens ONLY work with custom workshops. If used with a custom furnace they give an error and the graphics will not appear in game. Custom furnaces can still be made to use graphics if they are defined as workshops in their raws.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_buildings_graphics\graphics\graphics_workshops.txt</code>

== World Map Graphics ==
World map graphics come in two variations:

[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>]
[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>:<variation {1 - 5}>]

* ''[[#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).
* ''graphic id'': The [[Graphics_token#World_Map_Graphics|Graphic Token]] of the world map tile the graphics represent.
* ''variation {1 - 5}'': For Graphic IDs that allow variants.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>

== Palettes ==
[[File:palettes_v50.png|right]]

[[Palette]]s are used by [[graphics]] to render colorized objects. This is usually based on [[Material definition token#STATE_COLOR|material colors]], though arbitrary palettes{{version|50.13}} can be created and applied with {{token|USE_PALETTE|g}}.

[PALETTE:<palette identifier>]
[FILE:images/imagename.png]
[PALETTE_DEFAULT:<row>] this is the one used in the images themselves
[PALETTE_COLOR:<color>:<row>]

* ''name'': The Internal ID being created for the image. DEFAULT is used by most objects and requires a PALETTE_COLOR entry for each [[Descriptor color token|raw-defined color]] that exists.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''row'': The y position of the graphic to be displayed in pixels counting from 0 (top→bottom). It is customary to place the default palette at 0.
* ''color'': A [[Color#Color tokens|color]] token.

Each row of the vanilla palettes.png file is a palette. The PALETTE_DEFAULT row is the row of colors (aka palette) used to in the internal graphics (which are loaded by a tile page) and get replaced by the colors of one of the other rows as specified in the palette_default.txt file. It isn't shown in-game, but the exact RGB values are replaced by the row specified by <code>[PALETTE_COLOR]</code> or {{token|USE_PALETTE|g}}. Each palette supports up to 18 colors.

Below is a set of color ramps used for vanilla graphics. The colors in the '''Metal''' and '''Wood''' columns will be replaced by the palette corresponding to the object's [[Material definition token#STATE_COLOR|material color]], and all other colors are off-palette and will not be colorized. '''Fake Metal''' is used for metallic details on non-metal objects, like the gray trim of a wooden buckler, and other ramps are used for workshop overlays. '''Handle''' is used throughout the game to represent brown materials, and wooden weapons are an example of how to convert it into the main palette.

<center>'''PALETTE_DEFAULT source colors'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |

{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 0px solid black"
|- style="background: #fff"
| '''Metal'''
|- style="color: black; background: #ffffff"
| #FFFFFF
|- style="color: black; background: #C7C4B4"
| #C7C4B4
|- style="color: black; background: #A5A6A5"
| #A5A6A5
|- style="color: black; background: #8A9091"
| #8A9091
|- style="color: white; background: #6B7076"
| #6B7076
|- style="color: white; background: #5A5E65"
| #5A5E65
|- style="color: white; background: #494C54"
| #494C54
|- style="color: white; background: #3C3E46"
| #3C3E46
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Wood'''
|- style="color: black; background: #D7D3D2"
| #D7D3D2
|- style="color: black; background: #B3A59E"
| #B3A59E
|- style="color: black; background: #94877E"
| #94877E
|- style="color: black; background: #746A63"
| #746A63
|- style="color: white; background: #605852"
| #605852
|- style="color: white; background: #564F49"
| #564F49
|- style="color: white; background: #4E4743"
| #4E4743
|- style="color: white; background: #463E3D"
| #463E3D
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

<center>'''Off-palette color ramps'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Metal'''
|- style="color: black; background: #FFFEFF"
| #FFFEFF
|- style="color: black; background: #CECAB9"
| #CECAB9
|- style="color: black; background: #A9AAA9"
| #A9AAA9
|- style="color: black; background: #8B9293"
| #8B9293
|- style="color: white; background: #696F75"
| #696F75
|- style="color: white; background: #565B62"
| #565B62
|- style="color: white; background: #464951"
| #464951
|- style="color: white; background: #3F434C"
| #3F434C
|- style="color: white; background: #393B44"
| #393B44
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Wood'''
|- style="color: black; background: #D8B796"
| #D8B796
|- style="color: black; background: #B7926C"
| #B7926C
|- style="color: black; background: #A57D5E"
| #A57D5E
|- style="color: black; background: #936850"
| #936850
|- style="color: white; background: #815E50"
| #815E50
|- style="color: white; background: #6F5450"
| #6F5450
|- style="color: white; background: #5B4749"
| #5B4749
|- style="color: white; background: #473941"
| #473941
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Handle'''
|- style="color: black; background: #E1CEAF"
| #E1CEAF
|- style="color: black; background: #CDAC85"
| #CDAC85
|- style="color: black; background: #B98B5B"
| #B98B5B
|- style="color: black; background: #9E674A"
| #9E674A
|- style="color: white; background: #775653"
| #775653
|- style="color: white; background: #60474B"
| #60474B
|- style="color: black; background: white"
| n/a
|- style="color: white; background: #483743"
| #483743
|- style="color: white; background: #2E2A38"
| #2E2A38
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Still'''
|- style="color: black; background: #E5B076"
| #E5B076
|- style="color: black; background: #D1894A"
| #D1894A
|- style="color: black; background: #BF703C"
| #BF703C
|- style="color: black; background: #A35D3A"
| #A35D3A
|- style="color: white; background: #85534B"
| #85534B
|- style="color: white; background: #644249"
| #644249
|- style="color: white; background: #4B4047"
| #4B4047
|- style="color: white; background: #293945"
| #293945
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

= 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

2025-03-15T20:57:04Z

Qeveren: /* Basic Graphics */ added links to CAN_DO_INTERACTION and CDI:TOKEN

{{Quality|Superior}}{{av}}
[[File:graphics_v50_preview.png|209px|right]]
:{{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 '''graphics''' system in v50 is [https://github.com/Putnam3145/Dwarf-Fortress--libgraphics-- open-source]. 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 the game will resize other resolutions into a 32x32 tile. Depending on your zoom and interpolation settings, rescaled tiles can be subject to [Wikipedia:Artifact (error)|artefacting]].
* 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 ==
{{for/see|a list of all known creature graphics tokens|[[Graphics token#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 ===
[[File:Graphics_template_xy_positions.png|thumb|320px|right|An example of how X and Y positions are read, starting from the top left.]]
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.

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

|-
| {{token|CDI_LIST_ICON|g}} || Yes || Displayed in interaction menus in Adventure Mode, overrides LIST_ICON when specified in a creature [[Creature token#CAN_DO_INTERACTION|CAN_DO_INTERACTION]] using [[Interaction token#TOKEN|CDI:TOKEN]]:''token_name''. Inputs are ''token_name'', graphics file token, graphics position values{{verify}}.

|}

=== Caste Graphics ===
Creature caste graphics allow a simple alternative to [[#Layered Graphics|Layered Graphics]] to represent males and females (or other castes) 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]].

=== Large Graphics ===
[[File:Graphics_template_large_3x2.png|right|thumb|A 3x2 large image is rendered in the top center, with the central tile in red.]]
[[File:Graphics_template_large_2x1.png|right|thumb|A 2x1 large image is left-justified.]]
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 ===
[[File:Graphics_template_statues.png|right|thumb]]
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:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

[STATUE_CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[DEFAULT:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being defined.
* ''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.

Statue graphics will be automatically recolored based on how their [[Color#Color tokens|Color]] would appear in the default [[Graphics token#Palettes|palette]], like an item. The image (right) is an example of how a graphic would be aligned within the 1x2 grid. Vanilla statues customarily place the bottom row of pixels on the white line, with the gold box delineating where a 32px tall (exactly) sprite would fit.

=== 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#LAYER_SET|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. Does not need to be unique. 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.

====Portraits====

96x96 portraits{{version|50.13}} are shown in [[Adventure mode]] and when viewing a creature's sheet. They use the same tokens as layered graphics to display a more detailed view of a creature.

A single-layer portrait can be added to a [CREATURE_GRAPHICS] entry with this format:

[LAYER_SET:PORTRAIT]
[LAYER_GROUP]
[LAYER:MAIN:<tile page id>:<x position>:<y position>]
[END_LAYER_GROUP]

See above for the explanation of each argument.

=== Procedural Creature Graphics ===
Procedural graphics define layered graphics based on which body parts are present in each [[Creature token#GENERATED|procedurally-generated]] forgotten beast, titan, or otherwise.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x>:<y>:<width>:<height>:<PCG layering token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''width'': How many tiles right the graphic spans. Usually this is 3.
* ''height'': How many tiles down the graphic spans. Usually this is 2.
* ''[[Creature token#PCG_LAYERING|PCG layering token]]'': The internal ID of a [[procedural graphics layer]], representing 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 <x>, <y> and the size defined by <width>, <height>. The PCG layering 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.

Humanoid [[experiment]]s use <code>TILE_GRAPHICS</code> instead of <code>TILE_GRAPHICS_RECTANGLE</code>, which omits the <width> and <height> parameters.

The {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} token allows a creature to use the generation system for a given [[Graphics token#Basic creature sprite types|sprite type]] (which can be caste-specific), and each {{token|PCG_LAYERING|c}} entry will add that part to the assembled sprite.

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

== Workshop Graphics ==
Workshop graphics are displayed during each stage of construction and when it is completed. There are two layers, the base layer and an OVERLAY layer. The base layer shows the floor, tables, chairs and other basic features. The overlay shows various decorations that give the workshop its unique appearance.

base layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]
overlay layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM_OVERLAY:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]

* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''graphic tile x position'': The x position of the graphic in tiles counting from 0 (left→right).
* ''graphic tile y position'': The y position of the graphic in tiles counting from 0 (top→bottom).
* ''WORKSHOP_CUSTOM'' and ''WORKSHOP_CUSTOM_OVERLAY'': These tokens define the graphics as belonging to a custom workshop. These tokens do not exist in vanilla workshops except for the Soap maker and Screw press, which are used as examples for custom workshops.
* ''workshop id'': The ID of the workshop defined in its raws.
* ''building stage'': What building stage this graphic is displayed during.
* ''workshop tile x position'': The x position of the workshop tile where the graphic is displayed counting from 0 (left→right).
* ''workshop tile y position'': The y position of the workshop tile where the graphic is displayed counting from 0(top→bottom).

Note that an extra Y row is defined above the workshop. This allows for graphics that extend into the tile above the workshop.

Also note that currently custom furnaces do not properly work with premium graphics. The WORKSHOP_CUSTOM and WORKSHOP_CUSTOM_OVERLAY tokens ONLY work with custom workshops. If used with a custom furnace they give an error and the graphics will not appear in game. Custom furnaces can still be made to use graphics if they are defined as workshops in their raws.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_buildings_graphics\graphics\graphics_workshops.txt</code>

== World Map Graphics ==
World map graphics come in two variations:

[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>]
[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>:<variation {1 - 5}>]

* ''[[#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).
* ''graphic id'': The [[Graphics_token#World_Map_Graphics|Graphic Token]] of the world map tile the graphics represent.
* ''variation {1 - 5}'': For Graphic IDs that allow variants.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>

== Palettes ==
[[File:palettes_v50.png|right]]

[[Palette]]s are used by [[graphics]] to render colorized objects. This is usually based on [[Material definition token#STATE_COLOR|material colors]], though arbitrary palettes{{version|50.13}} can be created and applied with {{token|USE_PALETTE|g}}.

[PALETTE:<palette identifier>]
[FILE:images/imagename.png]
[PALETTE_DEFAULT:<row>] this is the one used in the images themselves
[PALETTE_COLOR:<color>:<row>]

* ''name'': The Internal ID being created for the image. DEFAULT is used by most objects and requires a PALETTE_COLOR entry for each [[Descriptor color token|raw-defined color]] that exists.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''row'': The y position of the graphic to be displayed in pixels counting from 0 (top→bottom). It is customary to place the default palette at 0.
* ''color'': A [[Color#Color tokens|color]] token.

Each row of the vanilla palettes.png file is a palette. The PALETTE_DEFAULT row is the row of colors (aka palette) used to in the internal graphics (which are loaded by a tile page) and get replaced by the colors of one of the other rows as specified in the palette_default.txt file. It isn't shown in-game, but the exact RGB values are replaced by the row specified by <code>[PALETTE_COLOR]</code> or {{token|USE_PALETTE|g}}. Each palette supports up to 18 colors.

Below is a set of color ramps used for vanilla graphics. The colors in the '''Metal''' and '''Wood''' columns will be replaced by the palette corresponding to the object's [[Material definition token#STATE_COLOR|material color]], and all other colors are off-palette and will not be colorized. '''Fake Metal''' is used for metallic details on non-metal objects, like the gray trim of a wooden buckler, and other ramps are used for workshop overlays. '''Handle''' is used throughout the game to represent brown materials, and wooden weapons are an example of how to convert it into the main palette.

<center>'''PALETTE_DEFAULT source colors'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |

{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 0px solid black"
|- style="background: #fff"
| '''Metal'''
|- style="color: black; background: #ffffff"
| #FFFFFF
|- style="color: black; background: #C7C4B4"
| #C7C4B4
|- style="color: black; background: #A5A6A5"
| #A5A6A5
|- style="color: black; background: #8A9091"
| #8A9091
|- style="color: white; background: #6B7076"
| #6B7076
|- style="color: white; background: #5A5E65"
| #5A5E65
|- style="color: white; background: #494C54"
| #494C54
|- style="color: white; background: #3C3E46"
| #3C3E46
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Wood'''
|- style="color: black; background: #D7D3D2"
| #D7D3D2
|- style="color: black; background: #B3A59E"
| #B3A59E
|- style="color: black; background: #94877E"
| #94877E
|- style="color: black; background: #746A63"
| #746A63
|- style="color: white; background: #605852"
| #605852
|- style="color: white; background: #564F49"
| #564F49
|- style="color: white; background: #4E4743"
| #4E4743
|- style="color: white; background: #463E3D"
| #463E3D
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

<center>'''Off-palette color ramps'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Metal'''
|- style="color: black; background: #FFFEFF"
| #FFFEFF
|- style="color: black; background: #CECAB9"
| #CECAB9
|- style="color: black; background: #A9AAA9"
| #A9AAA9
|- style="color: black; background: #8B9293"
| #8B9293
|- style="color: white; background: #696F75"
| #696F75
|- style="color: white; background: #565B62"
| #565B62
|- style="color: white; background: #464951"
| #464951
|- style="color: white; background: #3F434C"
| #3F434C
|- style="color: white; background: #393B44"
| #393B44
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Wood'''
|- style="color: black; background: #D8B796"
| #D8B796
|- style="color: black; background: #B7926C"
| #B7926C
|- style="color: black; background: #A57D5E"
| #A57D5E
|- style="color: black; background: #936850"
| #936850
|- style="color: white; background: #815E50"
| #815E50
|- style="color: white; background: #6F5450"
| #6F5450
|- style="color: white; background: #5B4749"
| #5B4749
|- style="color: white; background: #473941"
| #473941
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Handle'''
|- style="color: black; background: #E1CEAF"
| #E1CEAF
|- style="color: black; background: #CDAC85"
| #CDAC85
|- style="color: black; background: #B98B5B"
| #B98B5B
|- style="color: black; background: #9E674A"
| #9E674A
|- style="color: white; background: #775653"
| #775653
|- style="color: white; background: #60474B"
| #60474B
|- style="color: black; background: white"
| n/a
|- style="color: white; background: #483743"
| #483743
|- style="color: white; background: #2E2A38"
| #2E2A38
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Still'''
|- style="color: black; background: #E5B076"
| #E5B076
|- style="color: black; background: #D1894A"
| #D1894A
|- style="color: black; background: #BF703C"
| #BF703C
|- style="color: black; background: #A35D3A"
| #A35D3A
|- style="color: white; background: #85534B"
| #85534B
|- style="color: white; background: #644249"
| #644249
|- style="color: white; background: #4B4047"
| #4B4047
|- style="color: white; background: #293945"
| #293945
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

= 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

2025-03-15T20:53:57Z

Qeveren: /* Basic Graphics */ More info about CDI_LIST_ICON taken from kitfox discord convos

{{Quality|Superior}}{{av}}
[[File:graphics_v50_preview.png|209px|right]]
:{{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 '''graphics''' system in v50 is [https://github.com/Putnam3145/Dwarf-Fortress--libgraphics-- open-source]. 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 the game will resize other resolutions into a 32x32 tile. Depending on your zoom and interpolation settings, rescaled tiles can be subject to [Wikipedia:Artifact (error)|artefacting]].
* 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 ==
{{for/see|a list of all known creature graphics tokens|[[Graphics token#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 ===
[[File:Graphics_template_xy_positions.png|thumb|320px|right|An example of how X and Y positions are read, starting from the top left.]]
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.

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

|-
| {{token|CDI_LIST_ICON|g}} || Yes || Displayed in interaction menus in Adventure Mode, overrides LIST_ICON when specified in a creature CAN_DO_INTERACTION using CDI:TOKEN:''token_name''. Inputs are ''token_name'', graphics file token, graphics position values{{verify}}.

|}

=== Caste Graphics ===
Creature caste graphics allow a simple alternative to [[#Layered Graphics|Layered Graphics]] to represent males and females (or other castes) 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]].

=== Large Graphics ===
[[File:Graphics_template_large_3x2.png|right|thumb|A 3x2 large image is rendered in the top center, with the central tile in red.]]
[[File:Graphics_template_large_2x1.png|right|thumb|A 2x1 large image is left-justified.]]
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 ===
[[File:Graphics_template_statues.png|right|thumb]]
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:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

[STATUE_CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[DEFAULT:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being defined.
* ''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.

Statue graphics will be automatically recolored based on how their [[Color#Color tokens|Color]] would appear in the default [[Graphics token#Palettes|palette]], like an item. The image (right) is an example of how a graphic would be aligned within the 1x2 grid. Vanilla statues customarily place the bottom row of pixels on the white line, with the gold box delineating where a 32px tall (exactly) sprite would fit.

=== 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#LAYER_SET|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. Does not need to be unique. 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.

====Portraits====

96x96 portraits{{version|50.13}} are shown in [[Adventure mode]] and when viewing a creature's sheet. They use the same tokens as layered graphics to display a more detailed view of a creature.

A single-layer portrait can be added to a [CREATURE_GRAPHICS] entry with this format:

[LAYER_SET:PORTRAIT]
[LAYER_GROUP]
[LAYER:MAIN:<tile page id>:<x position>:<y position>]
[END_LAYER_GROUP]

See above for the explanation of each argument.

=== Procedural Creature Graphics ===
Procedural graphics define layered graphics based on which body parts are present in each [[Creature token#GENERATED|procedurally-generated]] forgotten beast, titan, or otherwise.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x>:<y>:<width>:<height>:<PCG layering token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''width'': How many tiles right the graphic spans. Usually this is 3.
* ''height'': How many tiles down the graphic spans. Usually this is 2.
* ''[[Creature token#PCG_LAYERING|PCG layering token]]'': The internal ID of a [[procedural graphics layer]], representing 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 <x>, <y> and the size defined by <width>, <height>. The PCG layering 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.

Humanoid [[experiment]]s use <code>TILE_GRAPHICS</code> instead of <code>TILE_GRAPHICS_RECTANGLE</code>, which omits the <width> and <height> parameters.

The {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} token allows a creature to use the generation system for a given [[Graphics token#Basic creature sprite types|sprite type]] (which can be caste-specific), and each {{token|PCG_LAYERING|c}} entry will add that part to the assembled sprite.

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

== Workshop Graphics ==
Workshop graphics are displayed during each stage of construction and when it is completed. There are two layers, the base layer and an OVERLAY layer. The base layer shows the floor, tables, chairs and other basic features. The overlay shows various decorations that give the workshop its unique appearance.

base layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]
overlay layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM_OVERLAY:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]

* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''graphic tile x position'': The x position of the graphic in tiles counting from 0 (left→right).
* ''graphic tile y position'': The y position of the graphic in tiles counting from 0 (top→bottom).
* ''WORKSHOP_CUSTOM'' and ''WORKSHOP_CUSTOM_OVERLAY'': These tokens define the graphics as belonging to a custom workshop. These tokens do not exist in vanilla workshops except for the Soap maker and Screw press, which are used as examples for custom workshops.
* ''workshop id'': The ID of the workshop defined in its raws.
* ''building stage'': What building stage this graphic is displayed during.
* ''workshop tile x position'': The x position of the workshop tile where the graphic is displayed counting from 0 (left→right).
* ''workshop tile y position'': The y position of the workshop tile where the graphic is displayed counting from 0(top→bottom).

Note that an extra Y row is defined above the workshop. This allows for graphics that extend into the tile above the workshop.

Also note that currently custom furnaces do not properly work with premium graphics. The WORKSHOP_CUSTOM and WORKSHOP_CUSTOM_OVERLAY tokens ONLY work with custom workshops. If used with a custom furnace they give an error and the graphics will not appear in game. Custom furnaces can still be made to use graphics if they are defined as workshops in their raws.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_buildings_graphics\graphics\graphics_workshops.txt</code>

== World Map Graphics ==
World map graphics come in two variations:

[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>]
[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>:<variation {1 - 5}>]

* ''[[#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).
* ''graphic id'': The [[Graphics_token#World_Map_Graphics|Graphic Token]] of the world map tile the graphics represent.
* ''variation {1 - 5}'': For Graphic IDs that allow variants.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>

== Palettes ==
[[File:palettes_v50.png|right]]

[[Palette]]s are used by [[graphics]] to render colorized objects. This is usually based on [[Material definition token#STATE_COLOR|material colors]], though arbitrary palettes{{version|50.13}} can be created and applied with {{token|USE_PALETTE|g}}.

[PALETTE:<palette identifier>]
[FILE:images/imagename.png]
[PALETTE_DEFAULT:<row>] this is the one used in the images themselves
[PALETTE_COLOR:<color>:<row>]

* ''name'': The Internal ID being created for the image. DEFAULT is used by most objects and requires a PALETTE_COLOR entry for each [[Descriptor color token|raw-defined color]] that exists.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''row'': The y position of the graphic to be displayed in pixels counting from 0 (top→bottom). It is customary to place the default palette at 0.
* ''color'': A [[Color#Color tokens|color]] token.

Each row of the vanilla palettes.png file is a palette. The PALETTE_DEFAULT row is the row of colors (aka palette) used to in the internal graphics (which are loaded by a tile page) and get replaced by the colors of one of the other rows as specified in the palette_default.txt file. It isn't shown in-game, but the exact RGB values are replaced by the row specified by <code>[PALETTE_COLOR]</code> or {{token|USE_PALETTE|g}}. Each palette supports up to 18 colors.

Below is a set of color ramps used for vanilla graphics. The colors in the '''Metal''' and '''Wood''' columns will be replaced by the palette corresponding to the object's [[Material definition token#STATE_COLOR|material color]], and all other colors are off-palette and will not be colorized. '''Fake Metal''' is used for metallic details on non-metal objects, like the gray trim of a wooden buckler, and other ramps are used for workshop overlays. '''Handle''' is used throughout the game to represent brown materials, and wooden weapons are an example of how to convert it into the main palette.

<center>'''PALETTE_DEFAULT source colors'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |

{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 0px solid black"
|- style="background: #fff"
| '''Metal'''
|- style="color: black; background: #ffffff"
| #FFFFFF
|- style="color: black; background: #C7C4B4"
| #C7C4B4
|- style="color: black; background: #A5A6A5"
| #A5A6A5
|- style="color: black; background: #8A9091"
| #8A9091
|- style="color: white; background: #6B7076"
| #6B7076
|- style="color: white; background: #5A5E65"
| #5A5E65
|- style="color: white; background: #494C54"
| #494C54
|- style="color: white; background: #3C3E46"
| #3C3E46
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Wood'''
|- style="color: black; background: #D7D3D2"
| #D7D3D2
|- style="color: black; background: #B3A59E"
| #B3A59E
|- style="color: black; background: #94877E"
| #94877E
|- style="color: black; background: #746A63"
| #746A63
|- style="color: white; background: #605852"
| #605852
|- style="color: white; background: #564F49"
| #564F49
|- style="color: white; background: #4E4743"
| #4E4743
|- style="color: white; background: #463E3D"
| #463E3D
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

<center>'''Off-palette color ramps'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Metal'''
|- style="color: black; background: #FFFEFF"
| #FFFEFF
|- style="color: black; background: #CECAB9"
| #CECAB9
|- style="color: black; background: #A9AAA9"
| #A9AAA9
|- style="color: black; background: #8B9293"
| #8B9293
|- style="color: white; background: #696F75"
| #696F75
|- style="color: white; background: #565B62"
| #565B62
|- style="color: white; background: #464951"
| #464951
|- style="color: white; background: #3F434C"
| #3F434C
|- style="color: white; background: #393B44"
| #393B44
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Wood'''
|- style="color: black; background: #D8B796"
| #D8B796
|- style="color: black; background: #B7926C"
| #B7926C
|- style="color: black; background: #A57D5E"
| #A57D5E
|- style="color: black; background: #936850"
| #936850
|- style="color: white; background: #815E50"
| #815E50
|- style="color: white; background: #6F5450"
| #6F5450
|- style="color: white; background: #5B4749"
| #5B4749
|- style="color: white; background: #473941"
| #473941
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Handle'''
|- style="color: black; background: #E1CEAF"
| #E1CEAF
|- style="color: black; background: #CDAC85"
| #CDAC85
|- style="color: black; background: #B98B5B"
| #B98B5B
|- style="color: black; background: #9E674A"
| #9E674A
|- style="color: white; background: #775653"
| #775653
|- style="color: white; background: #60474B"
| #60474B
|- style="color: black; background: white"
| n/a
|- style="color: white; background: #483743"
| #483743
|- style="color: white; background: #2E2A38"
| #2E2A38
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Still'''
|- style="color: black; background: #E5B076"
| #E5B076
|- style="color: black; background: #D1894A"
| #D1894A
|- style="color: black; background: #BF703C"
| #BF703C
|- style="color: black; background: #A35D3A"
| #A35D3A
|- style="color: white; background: #85534B"
| #85534B
|- style="color: white; background: #644249"
| #644249
|- style="color: white; background: #4B4047"
| #4B4047
|- style="color: white; background: #293945"
| #293945
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

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

Interaction token

2025-03-15T20:43:25Z

Qeveren: /* Usage */ Added TOKEN; seems to be used to reference menu icons for the interaction in Adventure Mode?

{{Quality|Fine}}
{{av}}
{{Modding}}

The following [[token]]s can be used to define and use interactions. (''It appears that, at least in order to make the big list make a little more sense, [[Necromancer#Modding|some]] [[Interaction_examples|examples]] of those may be necessary.'')

__TOC__
{{clear}}

==Definitions==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Context
! Arguments
! Description

|-
| {{text anchor|INTERACTION}}
| Global
| ID
| Used to start defining a new interaction. The term "interaction ID" refers to the text specified within this token; this is used to make reference to the interaction in various other places.

|-
| {{text anchor|EXPERIMENT_ONLY}}
| Global
|
| Disallows use of the interaction in play, but if the interaction animates or resurrects corpses, or has an I_SOURCE:EXPERIMENT tag, it can be used in worldgen. Animation and resurrection interactions do not need I_SOURCE:EXPERIMENT to work in worldgen.

|-
| {{text anchor|I_SOURCE}}
| Global
| type
| Defines what things are capable of triggering this interaction - multiple sources may be specified. Valid values:
* '''CREATURE_ACTION''' - Specifies that the interaction may be used in conjunction with [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION]]] and [[Syndrome#CE_CAN_DO_INTERACTION|[CE_CAN_DO_INTERACTION]]], but it isn't actually necessary for this. It might exist simply to allow for the inclusion of IS_ tokens (detailed below) to be applied when the interaction is used in this context.
* '''ATTACK''' - Allows the interaction to be used in conjunction with [[Creature_token#SPECIALATTACK_INTERACTION|[SPECIALATTACK_INTERACTION]]] and [[Syndrome#CE_SPECIAL_ATTACK_INTERACTION|[CE_SPECIAL_ATTACK_INTERACTION]]].
* '''INGESTION''' - Allows the interaction to be used in conjunction with [[Syndrome#CE_BODY_MAT_INTERACTION|[CE_BODY_MAT_INTERACTION]]].
* '''DEITY''' - Allows the interaction to be inflicted upon mortals by the gods, for reasons dictated by [[Interaction_token#IS_USAGE_HINT|[IS_USAGE_HINT]]].
* '''SECRET''' - Allows the interaction to act as a secret which can be learnt and passed on to others, as specified via [[Interaction_token#IS_SECRET|[IS_SECRET]]]. Appropriate [[Interaction_token#I_EFFECT|interaction effects]] with a [[Interaction_token#IE_TARGET|creature target]] will be applied to individuals who learn the secret. It is possible to set restrictions on who may learn the secret by using creature target tokens as described below. Also see [[Interaction_token#IS_SECRET_GOAL|[IS_SECRET_GOAL]]] and [[Interaction_token#IS_SPHERE|[IS_SPHERE]]].
* '''REGION''' - Allows the interaction to take place spontaneously in regions specified using [[Interaction_token#IS_REGION|[IS_REGION]]]. Also see [[Interaction_token#IS_FREQUENCY|[IS_FREQUENCY]]] and [[Interaction_token#IE_INTERMITTENT|[IE_INTERMITTENT]]].
* '''DISTURBANCE''' - Allows the interaction to take place spontaneously in disturbed [[tomb|tombs]]; generated interactions with this token are used to create [[mummy|mummies]].
* '''UNDERGROUND_SPECIAL''' - Allows the interaction to take place spontaneously in [[Demonic fortress|curious underground structures]] (which no longer generate); generated interactions with this token used to be used to produce [[undead|zombies]] when creating the structure's inhabitants.
* '''EXPERIMENT''' - This can be used by NIGHT_CREATURE_EXPERIMENTERs while "performing horrible experiments" in worldgen. Only seems relevant for interactions that target living creatures. Note that all NIGHT_CREATURE_EXPERIMENTERs have access to generated experiments, and due to the large number of generated experiments available custom experiment interactions will tend to show up very rarely.
* '''MYTHICAL''' - Presumably used to upgrade creatures guarding a [[mysterious dungeon]].
* '''ITEM_POWER''' - Granted by a ◄[[magic]] item►. Currently can only be found on [[Primordial remnant#Equipment|remnant weapons]], which chooses a random interaction with this source.

|-
| {{text anchor|IS_HIST_STRING_1}}
| Within I_SOURCE
| text
| Describes what the interaction did to a historical figure; this is displayed in legends mode following the name of the historical figure who performed the interaction and preceding the name of the targeted historical figure (or, in the case of [[Interaction_token#I_SOURCE|[I_SOURCE:INGESTION]]], the historical figure from whom the consumed material was extracted).

[IS_HIST_STRING_1: cursed]

|-
| {{text anchor|IS_HIST_STRING_2}}
| Within I_SOURCE
| text
| Describes what the interaction did to a historical figure; this is displayed in legends mode after the name of the historical figure who was targeted by the interaction. In the case of [[Interaction_token#I_SOURCE|[I_SOURCE:INGESTION]]], it is displayed after the name of the historical figure from whom the consumed material was extracted.

[IS_HIST_STRING_2: to assume the form of a lizard-like monster every full moon]

|-
| {{text anchor|IS_TRIGGER_STRING}}
| Within I_SOURCE
| text
| Displayed as an announcement when the interaction is carried out during play. The text follows the name of the target unit, and is preceded by [[Interaction_token#IS_TRIGGER_STRING_SECOND|IS_TRIGGER_STRING_SECOND]] or [[Interaction_token#IS_TRIGGER_STRING_THIRD|IS_TRIGGER_STRING_THIRD]]. May be limited to [[Interaction_token#I_SOURCE|[I_SOURCE:DEITY]]] and [[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]] interactions at present; this still needs to be tested.

[IS_TRIGGER_STRING: been infected with a contagious ghoulish condition]

|-
| {{text anchor|IS_TRIGGER_STRING_SECOND}}
| Within I_SOURCE
| text
| Presented before the [[Interaction_token#IS_TRIGGER_STRING|IS_TRIGGER_STRING]] when describing the event in the second person.

[IS_TRIGGER_STRING_SECOND: have]

|-
| {{text anchor|IS_TRIGGER_STRING_THIRD}}
| Within I_SOURCE
| text
| Presented before the [[Interaction_token#IS_TRIGGER_STRING|IS_TRIGGER_STRING]] when describing the event in the third person.

[IS_TRIGGER_STRING_THIRD: has]

|-
| {{text anchor|IS_NAME}}
| Within I_SOURCE
| string
| Generally used with [[Interaction_token#I_SOURCE|[I_SOURCE:SECRET]]] interactions to describe what the secret is about (though it may be used to name any I_SOURCE). This name is engraved onto the appropriate secret-containing slabs from worldgen, and is used in legends mode when describing the secret being learnt by historical figures.

[IS_NAME:the secrets of life and death]

|-
| {{text anchor|IS_SPHERE}}
| Within I_SOURCE:SECRET
| [[Sphere#Available_spheres|sphere]]
| Indicates the [[sphere]] to which this secret pertains. Only one sphere can be defined for each [I_SOURCE:SECRET] token, so several [I_SOURCE:SECRET] tokens are required to make a secret belong to multiple spheres.

|-
| {{text anchor|IS_SECRET_GOAL}}
| Within I_SOURCE:SECRET
| Secret Goal token
| Indicates why somebody would want to learn the secret. Valid values:
* '''STAY_ALIVE'''
* '''MAINTAIN_ENTITY_STATUS'''
* '''START_A_FAMILY'''
* '''RULE_THE_WORLD'''
* '''CREATE_A_GREAT_WORK_OF_ART'''
* '''CRAFT_A_MASTERWORK'''
* '''BRING_PEACE_TO_THE_WORLD'''
* '''BECOME_A_LEGENDARY_WARRIOR'''
* '''MASTER_A_SKILL'''
* '''FALL_IN_LOVE'''
* '''SEE_THE_GREAT_NATURAL_SITES'''
* '''IMMORTALITY'''
* '''MAKE_A_GREAT_DISCOVERY'''
* '''ATTAIN_RANK_IN_SOCIETY'''
* '''BATHE_WORLD_IN_CHAOS'''
However, currently only IMMORTALITY will result in a secret being pursued during worldgen.

|-
| {{text anchor|IS_SECRET}}
| Within I_SOURCE:SECRET
| Secret Flag
| Indicates how the secret can be learned. Valid values:
* '''SUPERNATURAL_LEARNING_POSSIBLE''' - gods may gift the secret to their worshippers. Secrets with [[Interaction_token#IS_SPHERE|[IS_SPHERE]]] specified may only be granted by gods who have at least one matching sphere.
* '''MUNDANE_RESEARCH_POSSIBLE''' - the secret can be researched by mundane means. This doesn't do anything at present. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222].
* '''MUNDANE_TEACHING_POSSIBLE''' - the secret can be taught to apprentices
* '''MUNDANE_RECORDING_POSSIBLE:TITLE_SET:NAME_SET''' - the secret can be written in books whose title and name are taken from the specified text sets. If this tag is present, a slab will be created upon learning the secret by supernatural means.

|-
| {{text anchor|IS_USAGE_HINT}}
| Within I_SOURCE:DEITY
| Usage Hint token
| Indicates why a deity would choose to perform this interaction. See [[Interaction_token#USAGE_HINT|CDI:USAGE_HINT]] below for valid values - in this context, '''MINOR_BLESSING''', '''MEDIUM_BLESSING''', '''MINOR_CURSE''', '''MEDIUM_CURSE''', and '''MAJOR_CURSE''' are the only values that make sense.

|-
| {{text anchor|IS_REGION}}
| Within I_SOURCE:REGION
| Region type
| Indicates what types of regions are capable of performing this interaction. This token may be specified several times per I_SOURCE to permit multiple terrain/alignment types. Valid values:

* '''ANY''' permits the interaction to occur in all regions, regardless of terrain or alignment

[[Biome|Terrain]]:

* '''DESERT'''
* '''FOREST'''
* '''GLACIER'''
* '''GRASSLAND'''
* '''HILLS'''
* '''LAKE'''
* '''MOUNTAINS'''
* '''OCEAN'''
* '''SWAMP'''
* '''TUNDRA'''
* '''ANY_TERRAIN''' permits the interaction to occur in all regions which meet alignment specifications

[[Surroundings#Combinations & characteristics of surroundings|Alignment]]:

* '''NORMAL_ALLOWED'''
* '''EVIL_ALLOWED'''
* '''GOOD_ALLOWED'''
* '''SAVAGE_ALLOWED'''
* '''EVIL_ONLY'''
* '''GOOD_ONLY'''
* '''SAVAGE_ONLY'''

|-
| {{text anchor|IS_FREQUENCY}}
| Within I_SOURCE
| Probability
| When used with [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]], determines how likely it is for the region(s) specified via [[Interaction_token#IS_REGION|[IS_REGION]]] to possess this interaction.

Note: it appears that regions aren't allowed to possess more than a single regional interaction at present.

|-
| {{text anchor|IS_POWER_LEVEL}}
| Within I_SOURCE:MYTHICAL
| 1-3
| Corresponds to the three tiers of [[mysterious dungeon]].

|-
| {{text anchor|IS_DESCRIPTION}}
| Within I_SOURCE:ITEM_POWER
| string
| Adds the given string to the affected item's description.

|-
| {{text anchor|IS_CDI}}
| Within I_SOURCE:ITEM_POWER
| [[Interaction_token#Usage|CDI token]]
| Details the interaction that the item grants. Comparable to {{token|CAN_DO_INTERACTION}}.

|-
| {{text anchor|I_TARGET}}
| Global
| ID, type
| Defines the targets available for subsequent use with [[Interaction_token#I_EFFECT|[I_EFFECT]]] tokens. Multiple targets may be specified; the precise target(s) used with each interaction effect are indicated via their ID (see [[Interaction_token#IE_TARGET|[IE_TARGET]]]). Valid values:
* '''CORPSE''' - The target is a [[Item_token#CORPSE|CORPSE]] or [[Item_token#CORPSEPIECE|CORPSEPIECE]] item.
* '''CREATURE''' - The target is a [[Creature|unit]].
* '''MATERIAL''' - This is a valid target for use in [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] interaction effects, and is used to set the material or flow type of the emission. This information, in turn, is either obtained from an [[Interaction_token#IT_MATERIAL|[IT_MATERIAL]]] token or by using [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_MATERIAL]]]. Using the latter implies that the precise emission info will be provided when defining [[Interaction_token#Breath_attacks|how an interaction user can use the interaction in question via CDI tokens]], enabling one to create 'template' material emission interactions such as the MATERIAL_EMISSION and MATERIAL_EMISSION_WITH_HIDE interactions included in the vanilla raws.
* '''LOCATION''' - The target is a [[tile|local map tile]]. If used with [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_CREATURE_OR_LOCATION]]], creatures at the target tile are also valid targets.

|-
| {{text anchor|IT_LOCATION}}
| Within I_TARGET
| Location
| This is often included after [[Interaction_token#I_TARGET|[I_TARGET]]] token to add more detail about the target. Valid values:
* '''CONTEXT_CREATURE''' - Used with CREATURE to target the whole unit.
* '''CONTEXT_BP''' - Used with CREATURE to target the body part specified in [[Interaction_token#BP_REQUIRED|[CDI:BP_REQUIRED]]].
* '''CONTEXT_LOCATION''' - Used with LOCATION to target only a tile.
* '''CONTEXT_CREATURE_OR_LOCATION''' - Used with LOCATION to allow for targetting of both creatures and tiles.
* '''CONTEXT_ITEM''' - Used with CORPSE.
* '''CONTEXT_REGION''' - Can only be used by [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]] interactions.
* '''CONTEXT_MATERIAL''' - Used with MATERIAL if you want an [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] to obtain the emission material/flow type from [[Interaction_token#MATERIAL|[CDI:MATERIAL]]] or [[Interaction_token#FLOW|[CDI:FLOW]]].
* '''RANDOM_NEARBY_LOCATION''' - Used with LOCATION. Targets a location from somewhere random within a number of squares from another LOCATION target specified by its target ID. For example, [I_TARGET:B:LOCATION] with [IT_LOCATION:RANDOM_NEARBY_LOCATION:A:5] will randomly select a tile lying somewhere within a radius of 5 tiles from [I_TARGET:A:LOCATION]. A walkable path between the two locations must exist.

|-
| {{text anchor|IT_MANUAL_INPUT}}
| Within I_TARGET
| text
| Tells the adventure mode player what they should be selecting. If not specified, the player will only be able to target themselves.

|-
| {{text anchor|IT_AFFECTED_CREATURE}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| CREATURE:CASTE
| Specifies specific creatures the interaction can target.

|-
| {{text anchor|IT_AFFECTED_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction can target.

|-
| {{text anchor|IT_IMMUNE_CREATURE}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| CREATURE:CASTE
| Specifies specific creatures the interaction cannot target.

|-
| {{text anchor|IT_IMMUNE_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction cannot target.

|-
| {{text anchor|IT_REQUIRES}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must have the specified property. Valid values:
* '''FIT_FOR_ANIMATION''' - Any corpse or body part that can become a zombie (heads, hands, etc.)
* '''FIT_FOR_RESURRECTION''' - The target corpse's UPPERBODY must be attached.
* '''HAS_BLOOD'''
* '''MORTAL'''
* '''NO_AGING'''
* '''STERILE'''
* Creature token: '''BLOODSUCKER, CAN_LEARN, CAN_SPEAK, CRAZED, EXTRAVISION, MISCHIEVOUS''' (or '''MISCHIEVIOUS'''), '''NO_CONNECTIONS_FOR_MOVEMENT, NO_DIZZINESS, NO_DRINK, NO_EAT, NO_FEVERS, NO_PHYS_ATT_GAIN, NO_PHYS_ATT_RUST, NO_SLEEP, NO_THOUGHT_CENTER_FOR_MOVEMENT, NOBREATHE, NOEMOTION, NOEXERT, NOFEAR, NONAUSEA, NOPAIN, NOSTUN, NOT_LIVING, NOTHOUGHT, OPPOSED_TO_LIFE, PARALYZEIMMUNE, SUPERNATURAL, TRANCES, UTTERANCES'''

|-
| {{text anchor|IT_FORBIDDEN}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must not have the specified property. Valid values are the same as for IT_REQUIRES.

|-
| {{text anchor|IT_CANNOT_TARGET_IF_ALREADY_AFFECTED}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
|
| Prevents the interaction from targeting a creature that's already under the effect of the same interaction.

|-
| {{text anchor|IT_CANNOT_HAVE_SYNDROME_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| [[Syndrome]] class
| Prevents the interaction from targeting a creature under the effects of a syndrome having the specified SYN_CLASS value.

|-
| {{text anchor|IT_MATERIAL}}
| Within I_TARGET:MATERIAL
| type
| Specifies the type of material the interaction targets; currently only used for [[Interaction_token#I_EFFECT|MATERIAL_EMISSION]] interaction effects. See [[Interaction_token#Breath_Attacks_Types|Breath Attack Types]]. Valid values:
* '''FLOW''':Breath attack token - The emission will consist of the specified special flow type.
* '''MATERIAL''':[[Material token]]:Breath attack token - The emission will consist of the specified material dispersed in the specified manner.
* '''CONTEXT_MATERIAL''' - Indicates the emission details should be obtained from [[Interaction_token#MATERIAL|[CDI:MATERIAL]]] or [[Interaction_token#FLOW|[CDI:FLOW]]].

|-
| {{text anchor|I_EFFECT}}
| Global
| type
| Specifies what the interaction does to the targets. Multiple [I_EFFECT]s may be specified in a single interaction, and the same type may be used more than once. Valid values:

* '''ADD_SYNDROME''' - Adds one or more syndromes to a valid creature target. You must specify the syndrome details just below this interaction effect using the <code>[[Syndrome#SYNDROME|[SYNDROME]]]</code> tag followed by the relevant syndrome tokens. See [[syndrome#The anatomy of a syndrome|here]] for more information.

* '''ANIMATE''' - Raises the target corpse/bodypart as an [[undead]] unit. The zombie will always be hostile to life and will retain no information about its original personality/loyalties. Syndromes can also be specified within this tag. If a regional interaction contains this effect, affected regions will have undead wildlife.

* '''RESURRECT''' - Takes a target corpse and returns the creature to life. This can be used on parts that are not FIT_FOR_RESURRECTION, but only the main part (with an UPPERBODY attached) will remain loyal to its original faction. Syndromes can also be specified within this tag.

* '''CLEAN''' - Removes [[Contaminant|contaminants]] from a valid creature target. See {{token|IE_GRIME_LEVEL|in}} and {{token|IE_SYNDROME_TAG|in}}.

* '''CONTACT''' - Causes the creatures to touch.

* '''MATERIAL_EMISSION''' - Causes a particular material to be emitted. Used by [[evil weather]] and the MATERIAL_EMISSION interaction.

* '''HIDE''' - Allows the creature to [[Ambusher|hide]] even if another creature can see it.

* '''CREATE_ITEM''' - Creates an item as described by {{token|IE_ITEM|in}} and {{token|IE_ITEM_QUALITY|in}}.

* '''CHANGE_ITEM_QUALITY''' - Alters an item's quality level as indicated by either {{token|IE_CHANGE_QUALITY|in}} or {{token|IE_SET_QUALITY|in}}. When targeting a unit, all items equipped by that unit will be affected.

* '''SUMMON_UNIT''' - Creates a new unit at the target. The type of unit can either be specified using the {{token|CREATURE|in}} token, or made to be randomly selected as indicated by a variety of flag-based tokens: {{token|IE_CREATURE_FLAG|in}}, {{token|IE_FORBIDDEN_CREATURE_FLAG|in}}, {{token|IE_CREATURE_CASTE_FLAG|in}}, {{token|IE_FORBIDDEN_CREATURE_CASTE_FLAG|in}}, {{token|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED|in}} and/or {{token|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED|in}}. See also {{token|IE_TIME_RANGE|in}} and {{token|IE_MAKE_PET_IF_POSSIBLE|in}}.

* '''PROPEL_UNIT''' - Applies a force specified using {{token|IE_PROPEL_FORCE|in}} to a unit to knock it back.

* '''CHANGE_WEATHER''' - Changes the weather as specified by {{token|IE_ADD_WEATHER|in}} and/or {{token|IE_REMOVE_WEATHER|in}}.

* '''RAISE_GHOST''' - Present in version 0.47.01 and accepted as a valid I_EFFECT token, but does not have an effect currently.

|-
| {{text anchor|IE_ARENA_NAME}}
| Within I_EFFECT
| text
| Allows the interaction effect to be applied directly to newly spawned creatures in [[object testing arena|arena mode]]. The specified name is used to represent it within the creature creation [[Object_testing_arena#Effects|effects list]].

|-
| {{text anchor|IE_TARGET}}
| Within I_EFFECT
| ID
| Specifies which [[Interaction_token#I_TARGET|I_TARGET]] a particular interaction effect will be applied to. For example, in an interaction with the token [I_TARGET:B:CREATURE], 'B' is the ID used to indicate this target option. [I_EFFECT:ADD_SYNDROME] followed by [IE_TARGET:B] would therefore apply the syndrome to this target. Certain types of interaction effects require multiple IE_TARGET tokens in a specific order to function properly. A few effects do not require a target at all.

|-
| {{text anchor|IE_INTERMITTENT}}
| Within I_EFFECT
| Frequency
| Only appears to work with [I_SOURCE:REGION] interactions. Indicates that the effect happens intermittently and specifies roughly how often. Regional interactions aren't able to use effects which lack this token. Valid values:
* '''WEEKLY'''

Note: DAILY, MONTHLY and YEARLY also exist in the string dump but don't appear to work at present.

|-
| {{text anchor|IE_IMMEDIATE}}
| Within I_EFFECT
|
| Indicates that the effect happens immediately.

|-
| {{text anchor|IE_LOCATION}}
| Within I_EFFECT
| Location Hint
| Prevents the interaction effect from manifesting unless the target is in a location which meets the specified criteria.
Valid values:
* '''IN_WATER'''
* '''IN_MAGMA'''
* '''NO_WATER'''
* '''NO_MAGMA'''
* '''NO_THICK_FOG'''
* '''OUTSIDE'''
A [[Water#Depth|depth]] of 1/7 is sufficient for IN_WATER and IN_MAGMA.

Note: NO_THICK_FOG and OUTSIDE are accepted as valid location hints when specified with IE_LOCATION, but don't appear to work. It's possible that they're currently only implemented for use with <code>[[Interaction_token#LOCATION_HINT|[CDI:LOCATION_HINT]]]</code>.

|-
| {{text anchor|IE_ADD_WEATHER}}
| Within I_EFFECT:CHANGE_WEATHER
| type
| Indicates what type of weather is added. Valid values:
* '''FOG_MIST'''
* '''FOG_NORMAL'''
* '''FOG_THICK'''
* '''FRONT_WARM'''
* '''FRONT_COLD'''
* '''FRONT_OCCLUDED'''
* '''STRATUS_ALTO'''
* '''STRATUS_PROPER'''
* '''STRATUS_NIMBUS'''
* '''CUMULUS_MED'''
* '''CUMULUS_MULTI'''
* '''CUMULUS_NIMBUS'''
* '''CIRRUS'''

|-
| {{text anchor|IE_REMOVE_WEATHER}}
| Within I_EFFECT:CHANGE_WEATHER
| type
| Indicates what type of weather is removed. See [[Interaction_token#IE_ADD_WEATHER|above]] for a list of valid weather types.

|-
| {{text anchor|IE_GRIME_LEVEL}}
| Within I_EFFECT:CLEAN
| amount?
| [IE_GRIME_LEVEL:2] appears in the default cleaning interaction, and may indicate amount of grime cleaned.

|-
| {{text anchor|IE_SYNDROME_TAG}}
| Within I_EFFECT:CLEAN
| syndrome trigger flag
| When a creature cleans off a [[contaminant]] which is associated with a [[syndrome]], the syndrome will be contracted if it has a matching [[Syndrome#The_anatomy_of_a_syndrome|trigger flag]]. This is what enables [[cat]]s to become slightly inebriated when licking off [[alcohol]]. '''SYN_INGESTED''' appears to be the only syndrome trigger flag that works in this context.

|-
| {{text anchor|IE_PROPEL_FORCE}}
| Within I_EFFECT:PROPEL_UNIT
| amount
| Indicates the amount of force that the target will be propelled with.

|-
| {{text anchor|IE_ITEM}}
| Within I_EFFECT:CREATE_ITEM
| <probability>:<quantity>:[[item token]]:[[material token]]
| Defines what item will be created.

|-
| {{text anchor|IE_ITEM_QUALITY}}
| Within I_EFFECT:CREATE_ITEM
| <[[Item_quality|quality]]> OR <minimum [[Item_quality|quality]]>:<maximum [[Item_quality|quality]]>
| Defines what [[Item quality|quality]] the created item shall have. Can either be specified in the form of a single, fixed quality (it seems that ARTIFACT can only be used in this manner), or a minimum and maximum level (in which case the quality is selected randomly). Valid values (numerals only except for ARTIFACT):
* '''0''' = ordinary
* '''1''' = well-crafted
* '''2''' = finely crafted
* '''3''' = superior quality
* '''4''' = exceptional
* '''5''' = masterwork
* '''ARTIFACT'''

|-
| {{text anchor|IE_SET_QUALITY}}
| Within I_EFFECT:CHANGE_ITEM_QUALITY
| [[Interaction_token#IE_ITEM_QUALITY|quality level]]
| Defines a fixed [[Item_quality|quality]] level which the affected item(s) will be set to (decreasing or increasing in quality as necessary). See [[Interaction_token#IE_ITEM_QUALITY|above]] for a list of valid quality levels (but note that ARTIFACT cannot be used in this effect).

|-
| {{text anchor|IE_CHANGE_QUALITY}}
| Within I_EFFECT:CHANGE_ITEM_QUALITY
| amount
| Determines how much the [[Item_quality|quality]] of the item(s) will be changed. For instance, improving a well-crafted -item- ([[Interaction_token#IE_ITEM_QUALITY|quality level]] 1) by 2 will turn it into a superior-quality *item* (quality level 3). A negative value can be used to decrease quality. Quality cannot be increased beyond level 5 (masterwork) or decreased below level 0 (ordinary).

|-
| {{text anchor|CREATURE}}
| Within I_EFFECT:SUMMON_UNIT
| <creature token>:<caste token>
| Indicates which specific creature will be created when using this interaction. ANY can be used in place of a specific caste token. Only one [CREATURE] may currently be specified per interaction effect.

|-
| {{text anchor|IE_CREATURE_FLAG}}
| Within I_EFFECT:SUMMON_UNIT
| <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]>
| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]]. This token may be used multiple times per interaction effect; creatures which lack any of the indicated flags will never be summoned.

|-
| {{text anchor|IE_FORBIDDEN_CREATURE_FLAG}}
| Within I_EFFECT:SUMMON_UNIT
| <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]>
| When this token is added to a random creature summoning effect, any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]] will be excluded from the selection. This token may be used multiple times per interaction effect; creatures which possess any of the indicated flags will never be summoned.

|-
| {{text anchor|IE_CREATURE_CASTE_FLAG}}
| Within I_EFFECT:SUMMON_UNIT
| <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]>
| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]]. This token may be used multiple times per interaction effect; creatures which lack any of the indicated flags will never be summoned.

|-
| {{text anchor|IE_FORBIDDEN_CREATURE_CASTE_FLAG}}
| Within I_EFFECT:SUMMON_UNIT
| <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]>
| When this token is added to a random creature summoning effect, it excludes any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]]. This token may be used multiple times per interaction effect; creatures which possess any of the indicated flags will never be summoned.

|-
| {{text anchor|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED}}
| Within I_EFFECT:SUMMON_UNIT
| <minimum [[Gait#Speed|gait speed]]>
| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have at least one [[gait]] with an [[Creature_token#GAIT|<energy expenditure>]] of 0 and a [[Creature_token#GAIT|<max speed>]] less than or equal to the specified <minimum gait speed> ("less than" because lower is faster in the scale used for [[Gait#Speed|gait speed]]). [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222]

|-
| {{text anchor|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED}}
| Within I_EFFECT:SUMMON_UNIT
| <maximum [[Gait#Speed|gait speed]]>
| When this token is added to a random creature summoning effect, it excludes any creatures which have at least one [[gait]] with an [[Creature_token#GAIT|<energy expenditure>]] of 0 and a [[Creature_token#GAIT|<max speed>]] value less than or equal to the specified <maximum gait speed> (note that larger values are slower in the scale used for [[Gait#Speed|gait speed]]). [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222]

|-
| {{text anchor|IE_TIME_RANGE}}
| Within I_EFFECT:SUMMON_UNIT
| <minimum [[Time|ticks]]>:<maximum [[Time|ticks]]>
| The summoned unit vanishes in a puff of smoke once a certain amount of time has elapsed. The time limit is a randomly selected number of ticks within the specified minimum-maximum time range. The unit will persist indefinitely if this token is omitted.

|-
| {{text anchor|IE_MAKE_PET_IF_POSSIBLE}}
| Within I_EFFECT:SUMMON_UNIT
|
| Makes the summoned unit behave as a pet of the unit who performed the summoning interaction.

|-
| {{text anchor|GENERATED}}
| Global
|
| Indicates that this is a generated interaction. Cannot be specified in user-defined raws.

|}

==Usage==
To enable a particular type of creature to use an interaction directly, the [[creature token]] <code>[[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION:<interaction name>]]]</code> should be added to its creature raws (replacing '<interaction name>' with the ID of the desired interaction; for an interaction called <code>[INTERACTION:CLEANING]</code> in the raws, the ID would be "CLEANING"), followed by a series of [CDI:...] tokens as detailed below.

Interactions can also be granted to individual creatures via [[syndrome]]s using the syndrome effect token <code>[[Syndrome#CE_CAN_DO_INTERACTION|[CE_CAN_DO_INTERACTION]]]</code> followed by <code>[[Interaction_token#INTERACTION|[CDI:INTERACTION:<interaction name>]]]</code> and additional CDI tokens as required.

The following is a list of valid CDI tokens. Precede them with "CDI:" in the style of <code>[CDI:ADV_NAME:Clean]</code>, for example.
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| {{text anchor|INTERACTION}}
| ID
| Specifies which interaction can be performed. This is only needed following [[Syndrome#Special_Effects|CE_CAN_DO_INTERACTION]]; there's no need to include this after [[Creature_token#CAN_DO_INTERACTION|CAN_DO_INTERACTION]] as the latter allows you to specify the interaction directly (as explained [[Interaction_token#Usage|above]]).

|-
| {{text anchor|ADV_NAME}}
| text
| Specifies the name of the interaction as it will appear on the [[Adventurer_mode|adventure mode]] 'powers/abilities' menu.

|-
| {{text anchor|TOKEN}}
| ID
| Specifies a reference for the interaction graphics icon as it will appear on the [[Adventurer_mode|adventure mode]] 'powers/abilities' menu{{verify}}.

|-
| {{text anchor|TARGET}}
| target ID, target types
| Specifies how the creature chooses what to target. Target ID refers to an I_TARGET defined in the interaction itself. Multiple target types can be specified. If no target is specified, creature will target any available target within range, even through walls. Valid target types:
* '''LINE_OF_SIGHT''' - the source needs to be able to see the target
* '''TOUCHABLE''' - the source needs to be able to touch the target
* '''DISTURBER_ONLY''' - the target must be whoever disturbed the source (this is currently only relevant to [[mummy|mummies]], allowing them to curse solely the unit who disturbed their [[tomb|resting place]])
* '''SELF_ALLOWED''' - the target can be the source
* '''SELF_ONLY''' - the target '''must''' be the source

|-
| {{text anchor|TARGET_RANGE}}
| target ID, range
| Determines the maximum distance from the interaction user (in [[tile]]s) at which something can be considered a valid target. For [[Interaction_token#SOLID_GLOB|SOLID_GLOB]], [[Interaction_token#SHARP_ROCK|SHARP_ROCK]], [[Interaction_token#LIQUID_GLOB|LIQUID_GLOB]] and [[Interaction_token#FIREBALL|FIREBALL]] breath attacks, also determines how far the projectiles can fly before falling to the ground.

|-
| {{text anchor|MAX_TARGET_NUMBER}}
| ID, number
| Specifies the maximum number of things that can be selected for a particular I_TARGET.

|-
| {{text anchor|LOCATION_HINT}}
| Location Hint
| Prevents CPU-controlled creatures from using the interaction unless they are in a location which meets the specified criteria. See [[Interaction_token#IE_LOCATION|above]] for a list of valid location hint values.

|-
| {{text anchor|USAGE_HINT}}
| Usage hint token
| Indicates when and how CPU-controlled creatures will use the interaction. If no hint is specified in fortress mode, the interaction will be performed at every opportunity in combat. Multiple usage hints may be specified. Valid values:
* '''GREETING''' - Creatures will target 'friendly' creatures, usually at random.
* '''ATTACK''' - Targets enemy creatures in combat. If the interaction specifies SELF_ONLY, CPU-controlled creatures will never use it.
* '''DEFEND''' - Used in combat. Creature will target itself.
* '''FLEEING''' - Used when fleeing an enemy. Creature will target itself.
* '''CLEAN_SELF''' - Creature targets itself when its body is covered with [[contaminant]]s.
* '''CLEAN_FRIEND''' - As above, but targets other friendly units instead.
* '''NEGATIVE_SOCIAL_RESPONSE''' - Used when a creature is expressing contempt (for example, to a murderer). This is used in the default spitting interaction, for example.
* '''TORMENT''' - This is also used in the default spitting interaction, and is presumably used in a similar context.
* '''MINOR_BLESSING''' - Used in divination dice blessings. Targets the roller.
* '''MEDIUM_BLESSING''' - Used in divination dice blessings. Targets the roller.
* '''MINOR_CURSE''' - Used in divination dice curses. Targets the roller.
* '''MEDIUM_CURSE''' - Used in divination dice curses. Targets the roller.
* '''MAJOR_CURSE''' - Used in disturbance and deity curses. Targets the tomb disturber/temple defiler.

|-
| {{text anchor|WAIT_PERIOD}}
| number
| The creature must wait the specified number of [[time|ticks]] before being able to use the interaction again. The delay defaults to 20 ticks if this is omitted. Setting it to 0 removes the delay altogether.
Note: A WAIT_PERIOD of 10 is 10 ticks long in [[fortress mode]], but only 1 tick long in [[adventurer mode]].

|-
| {{text anchor|FREE_ACTION}}
|
| Indicates that performing the interaction doesn't take any time.

|-
| {{text anchor|BP_REQUIRED}}
| Body part criteria
| Indicates that a particular body part must be present in order to perform the interaction. Criteria are '''BY_CATEGORY:'''[[Body_token#CATEGORY|category]], '''BY_TYPE:'''type (GRASP, for example), or '''BY_TOKEN:'''[[Body_token#BP|token]] (uses the body part ID). See [[Body_token|body token]].

|-
| {{text anchor|VERBAL}}
|
| Only creatures that [[Creature_token#CAN_SPEAK|can speak]] will be able to use the interaction. Might also be needed for VERBAL_SPEECH.

|-
| {{text anchor|VERBAL_SPEECH}}
| text set
| Specifies what the creature says when they perform the interaction. Text sets are defined in text_* raws.

|-
| {{text anchor|CAN_BE_MUTUAL}}
|
| Presumably allows two creatures with the same interaction to use it on each other simultaneously, for example, cats cleaning each other.

|-
| {{text anchor|VERB}}
| self:other:mutual
| When a creature uses the interaction, a combat report message will be displayed in the form:

[interaction user(s)] [VERB text] [target creature (if applicable)]

The 'self' text is presented when describing the interaction in the second person (that is, when the interaction is carried out by the player character in [[adventure mode]]), the 'other' text is presented when describing it in the third person, and the 'mutual' text is presented when the interaction is carried out in a [[Interaction_token#CAN_BE_MUTUAL|mutual]] fashion.

[CDI:VERB:lick:licks:lick each other]

[CDI:VERB:gesture:gestures:NA]

|-
| {{text anchor|VERB_REVERSE}}
| ?
| ?

|-
| {{text anchor|TARGET_VERB}}
| self:other
| When a creature uses the interaction, a message will display, describing the target as doing this.
[CDI:TARGET_VERB:shudder and begin to move:shudders and begins to move]

|-
| {{text anchor|FLOW}}
| [[#Breath Attack Types|Breath attack token]]
| Can be used with interactions that have [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] and [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_MATERIAL]]] (or [[Interaction_token#IT_MATERIAL|[IT_MATERIAL:CONTEXT_MATERIAL]]]) to make the interaction emit a special flow type. Valid values:
* '''[[Interaction_token#FIREBALL|FIREBALL]]'''
* '''[[Interaction_token#FIREJET|FIREJET]]'''
* '''[[Interaction_token#DRAGONFIRE|DRAGONFIRE]]'''.

|-
| {{text anchor|MATERIAL}}
| [[Material token]]:[[Interaction_token#Breath_Attack_Types|Breath attack token]]
| Can be used with interactions that have [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] and [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_MATERIAL]]] (or [[Interaction_token#IT_MATERIAL|[IT_MATERIAL:CONTEXT_MATERIAL]]]) to make the interaction emit the specified material in the manner described by the [[Interaction_token#Breath_Attack_Types|breath attack token]] used.

|}

==Breath attacks==
Breath attacks are controlled by the MATERIAL_EMISSION interaction, like so:

[CAN_DO_INTERACTION:MATERIAL_EMISSION]
[CDI:ADV_NAME:Breath custom material]
[CDI:USAGE_HINT:ATTACK]
[CDI:BP_REQUIRED:BY_CATEGORY:MOUTH]
[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]
[CDI:TARGET:C:LINE_OF_SIGHT]
[CDI:TARGET_RANGE:C:15]
[CDI:MAX_TARGET_NUMBER:C:1]
[CDI:WAIT_PERIOD:50]

The most important part is this line:

[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]

The CDI refers to CAN_DO_INTERACTION; the MATERIAL states that this line shows what the material is. LOCAL_CREATURE_MAT:CUSTOMMATERIAL is your material, and TRAILING_VAPOR_FLOW refers to the breath attack type. Other types are seen below. Also important is this line:

[CDI:TARGET:C:LINE_OF_SIGHT]

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks) and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

===Breath Attack Types===

'''[CDI:MATERIAL:<[[material token]]>:<material emission type>]'''

Is used to emit a specific material in a specific manner. A list of valid emission types can be found below.

Examples:

[CDI:MATERIAL:INORGANIC:GABBRO:[[Interaction_token#SHARP_ROCK|SHARP_ROCK]]]
shoots a sharp [[gabbro]] rock
[CDI:MATERIAL:PLANT_MAT:GRASS_CAVE_WHEAT:MILL:[[Interaction_token#UNDIRECTED_DUST|UNDIRECTED_DUST]]]
releases a cloud of [[Cave wheat|dwarven wheat flour]]
[CDI:MATERIAL:CREATURE_MAT:DWARF:TEARS:[[Interaction_token#SPATTER_LIQUID|SPATTER_LIQUID]]]
creates a pool of [[dwarf|dwarven]] tears

'''[CDI:FLOW:<flow emission type>]'''

Is used to emit one of the special hardcoded flow types ([[Interaction_token#FIREBALL|FIREBALL]], [[Interaction_token#FIREJET|FIREJET]] or [[Interaction_token#DRAGONFIRE|DRAGONFIRE]]).

Example:

[CDI:FLOW:[[Interaction_token#DRAGONFIRE|DRAGONFIRE]]]

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Usage Type
! Description
|-
| {{text anchor|TRAILING_DUST_FLOW}}
| MATERIAL
| Shoots a trail of solid dust at the target. Appears to use [[cave-in]] dust physics, as the dust cloud will fling around anything it comes in contact with (including the creature who emitted it), making it capable of smashing creatures into the ground and flinging them over walls. Creatures caught in the dust cloud will be [[contaminant|covered]] with dust; this will trigger any associated [[Syndrome#SYN_CONTACT|contact syndromes]].
|-
| {{text anchor|TRAILING_VAPOR_FLOW}}
| MATERIAL
| Shoots a trail of liquid mist at the target. Creatures caught in the vapor will be [[contaminant|covered]] with the condensed liquid; this will trigger any associated [[Syndrome#SYN_CONTACT|contact syndromes]].
|-
| {{text anchor|TRAILING_GAS_FLOW}}
| MATERIAL
| Shoots a trail of gaseous substance at the target. This can be inhaled, triggering any associated [[Syndrome#SYN_INHALED|inhalation syndromes]].
|-
| {{text anchor|TRAILING_ITEM_FLOW}}:[[item token]]
| MATERIAL
| Shoots a "cloud" of items at the target, leaving piles of this item on the floor. Note that this does ''not'' create the actual items or use falling item mechanics (meaning no flying daggers or Touhou-style barrages, unfortunately). Instead, this token acts as [[Interaction_token#TRAILING_GAS_FLOW|TRAILING_GAS_FLOW]], except that the material will use its ''normal'' temperature - for example, a breath attack of steel anvils will envelop the target in a "burst of steel".
|-
| {{text anchor|UNDIRECTED_DUST}}
| MATERIAL
| The creature releases a cloud of solid dust which spreads and dissipates. Similar to [[Interaction_token#TRAILING_DUST_FLOW|TRAILING_DUST_FLOW]], but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|-
| {{text anchor|UNDIRECTED_VAPOR}}
| MATERIAL
| The creature releases a cloud of liquid mist which spreads and dissipates. Similar to [[Interaction_token#TRAILING_VAPOR_FLOW|TRAILING_VAPOR_FLOW]], but undirected, thus affecting a larger area but losing the distance.
|-
| {{text anchor|UNDIRECTED_GAS}}
| MATERIAL
| The creature releases a cloud of gaseous material which spreads and dissipates. Similar to [[Interaction_token#TRAILING_GAS_FLOW|TRAILING_GAS_FLOW]], but undirected, thus affecting a larger area but losing the distance.
|-
| {{text anchor|UNDIRECTED_ITEM_CLOUD}}:[[item token]]
| MATERIAL
| The creature releases a "cloud" of items at the target, leaving piles of this item on the floor. The same comments apply as [[Interaction_token#TRAILING_ITEM_FLOW|TRAILING_ITEM_FLOW]].
|-
| {{text anchor|WEATHER_CREEPING_DUST}}
| MATERIAL
| Creates a cloud of creeping dust. Not usable by creatures.
|-
| {{text anchor|WEATHER_CREEPING_VAPOR}}
| MATERIAL
| Creates a cloud of creeping vapor. Not usable by creatures.
|-
| {{text anchor|WEATHER_CREEPING_GAS}}
| MATERIAL
| Creates a cloud of gas that appears at the edge of the map and slowly creeps across the map. Not usable by creatures.
|-
| {{text anchor|WEATHER_FALLING_MATERIAL}}
| MATERIAL
| Causes it to start raining a particular material. If the material is solid at the outdoor temperatures, it will snow the material instead. Can transfer [[Syndrome#SYN_CONTACT|contact syndromes]]. Regardless of the nature of the material, being caught in it will give dwarves the negative [[thought]] of being 'caught in freakish weather lately'. Not usable by creatures.
|-
| {{text anchor|SOLID_GLOB}}
| MATERIAL
| Shoots a [[Item_token#GLOB|solid glob]] of spinning substance at the target, leaving a symbol similar to broken arrows, if it misses. Essentially a projectile weapon. If the [[Interaction_token#WAIT_PERIOD|cooldown rate]] is short enough, some creatures with this breath attack will not move, preferring instead to hold position and shoot globs at their enemies, even when they are right next to them.
|-
| {{text anchor|SHARP_ROCK}}
| MATERIAL
| Just like [[Interaction_token#SOLID_GLOB|SOLID_GLOB]], but more harmful, as it shoots a sharpened [[Item_token#ROCK|solid chunk]] of material instead.
|-
| {{text anchor|LIQUID_GLOB}}
| MATERIAL
| Shoots a [[Item_token#LIQUID_MISC|liquid glob]] of substance at the target. [[Syndrome#SYN_CONTACT|Contact syndromes]] will take effect if the glob hits the target's exposed skin.
|-
| {{text anchor|SPATTER_POWDER}}
| MATERIAL
| Creates a [[contaminant|pile of powder]] at the specified location.
|-
| {{text anchor|SPATTER_LIQUID}}
| MATERIAL
| Creates a [[contaminant|pool of liquid]] at the specified location.
|-
| {{text anchor|WEB_SPRAY}}
| MATERIAL
| Emits a burst of [[web]]s that entangle target creatures.
|-
| {{text anchor|DRAGONFIRE}}
| FLOW
| Emits a wide cone of [[dragon]] [[fire]] that burns target creatures at a scorching {{ct|50000}}.
|-
| {{text anchor|FIREJET}}
| FLOW
| Emits a narrow cone of [[fire]] that burns target creatures at {{ct|11000}}.
|-
| {{text anchor|FIREBALL}}
| FLOW
| Emits a fireball that burns the target creature.
|}

Keep in mind that you can give a creature multiple breath attacks, which appears to make the creature choose between them at random. Creatures cannot use the WEATHER effects, these being reserved for regional interactions.

One major difference between GAS, VAPOR, and DUST is that if the material cannot exist in the specified state at the current temperature, it will automatically be created at a temperature allowing it to exist. So if you create a vapor spray that uses rock or metal as a material, that spray will be created at the material's melting point, setting everything it touches on fire. You can also create a freezing spray by using a custom material that has extremely low melting and/or boiling points.

If you give a creature a material breath attack, be aware that it will be caught in the attack more frequently than its targets. Make sure to make your creatures immune to their own breath weapons!

==Creature and Caste Flags==

Certain interaction and syndrome effects (currently limited to [[Interaction_token#I_EFFECT|[IE_SUMMON_UNIT]]] and [[Syndrome#CE_BODY_TRANSFORMATION|[CE_BODY_TRANSFORMATION]]]) permit modders to specify the required/forbidden creature and caste flags of the desired creature(s). These are a collection of internal flags which are derived from [[Creature_token|creature tokens]] but are not necessarily identical to them. The following lists contain creature and caste flag names as provided by Toady One in a FotF reply [http://www.bay12forums.com/smf//index.php?topic=169696.msg8099138#msg8099138] (valid as of 0.47.04).

{{gamedata|title=Creature Flags|
ALL_CASTES_ALIVE
ARTIFICIAL_HIVEABLE
BIOME_DESERT_BADLAND
BIOME_DESERT_ROCK
BIOME_DESERT_SAND
BIOME_FOREST_TAIGA
BIOME_FOREST_TEMPERATE_BROADLEAF
BIOME_FOREST_TEMPERATE_CONIFER
BIOME_FOREST_TROPICAL_CONIFER
BIOME_FOREST_TROPICAL_DRY_BROADLEAF
BIOME_FOREST_TROPICAL_MOIST_BROADLEAF
BIOME_GLACIER
BIOME_GRASSLAND_TEMPERATE
BIOME_GRASSLAND_TROPICAL
BIOME_LAKE_TEMPERATE_BRACKISHWATER
BIOME_LAKE_TEMPERATE_FRESHWATER
BIOME_LAKE_TEMPERATE_SALTWATER
BIOME_LAKE_TROPICAL_BRACKISHWATER
BIOME_LAKE_TROPICAL_FRESHWATER
BIOME_LAKE_TROPICAL_SALTWATER
BIOME_MARSH_TEMPERATE_FRESHWATER
BIOME_MARSH_TEMPERATE_SALTWATER
BIOME_MARSH_TROPICAL_FRESHWATER
BIOME_MARSH_TROPICAL_SALTWATER
BIOME_MOUNTAIN
BIOME_OCEAN_ARCTIC
BIOME_OCEAN_TEMPERATE
BIOME_OCEAN_TROPICAL
BIOME_POOL_TEMPERATE_BRACKISHWATER
BIOME_POOL_TEMPERATE_FRESHWATER
BIOME_POOL_TEMPERATE_SALTWATER
BIOME_POOL_TROPICAL_BRACKISHWATER
BIOME_POOL_TROPICAL_FRESHWATER
BIOME_POOL_TROPICAL_SALTWATER
BIOME_RIVER_TEMPERATE_BRACKISHWATER
BIOME_RIVER_TEMPERATE_FRESHWATER
BIOME_RIVER_TEMPERATE_SALTWATER
BIOME_RIVER_TROPICAL_BRACKISHWATER
BIOME_RIVER_TROPICAL_FRESHWATER
BIOME_RIVER_TROPICAL_SALTWATER
BIOME_SAVANNA_TEMPERATE
BIOME_SAVANNA_TROPICAL
BIOME_SHRUBLAND_TEMPERATE
BIOME_SHRUBLAND_TROPICAL
BIOME_SUBTERRANEAN_CHASM
BIOME_SUBTERRANEAN_LAVA
BIOME_SUBTERRANEAN_WATER
BIOME_SWAMP_MANGROVE
BIOME_SWAMP_TEMPERATE_FRESHWATER
BIOME_SWAMP_TEMPERATE_SALTWATER
BIOME_SWAMP_TROPICAL_FRESHWATER
BIOME_SWAMP_TROPICAL_SALTWATER
BIOME_TUNDRA
DOES_NOT_EXIST
EQUIPMENT
EQUIPMENT_WAGON
EVIL
FANCIFUL
GENERATED
GOOD
HAS_ANY_BENIGN
HAS_ANY_CANNOT_BREATHE_AIR
HAS_ANY_CANNOT_BREATHE_WATER
HAS_ANY_CAN_SWIM
HAS_ANY_CARNIVORE
HAS_ANY_COMMON_DOMESTIC
HAS_ANY_CURIOUS_BEAST
HAS_ANY_DEMON
HAS_ANY_FEATURE_BEAST
HAS_ANY_FLIER
HAS_ANY_FLY_RACE_GAIT
HAS_ANY_GRASP
HAS_ANY_GRAZER
HAS_ANY_HAS_BLOOD
HAS_ANY_IMMOBILE
HAS_ANY_INTELLIGENT_LEARNS
HAS_ANY_INTELLIGENT_SPEAKS
HAS_ANY_LARGE_PREDATOR
HAS_ANY_LOCAL_POPS_CONTROLLABLE
HAS_ANY_LOCAL_POPS_PRODUCE_HEROES
HAS_ANY_MEGABEAST
HAS_ANY_MISCHIEVIOUS
HAS_ANY_NATURAL_ANIMAL
HAS_ANY_NIGHT_CREATURE
HAS_ANY_NIGHT_CREATURE_BOGEYMAN
HAS_ANY_NIGHT_CREATURE_EXPERIMENTER
HAS_ANY_NIGHT_CREATURE_HUNTER
HAS_ANY_NIGHT_CREATURE_NIGHTMARE
HAS_ANY_NOT_FIREIMMUNE
HAS_ANY_NOT_FLIER
HAS_ANY_NOT_LIVING
HAS_ANY_OUTSIDER_CONTROLLABLE
HAS_ANY_POWER
HAS_ANY_RACE_GAIT
HAS_ANY_SEMIMEGABEAST
HAS_ANY_SLOW_LEARNER
HAS_ANY_SUPERNATURAL
HAS_ANY_TITAN
HAS_ANY_UNIQUE_DEMON
HAS_ANY_UTTERANCES
HAS_ANY_VERMIN_HATEABLE
HAS_ANY_VERMIN_MICRO
HAS_FEMALE
HAS_MALE
LARGE_ROAMING
LOOSE_CLUSTERS
MATES_TO_BREED
MUNDANE
OCCURS_AS_ENTITY_RACE
SAVAGE
SMALL_RACE - applies to any vermin creature
TWO_GENDERS
UBIQUITOUS
VERMIN_EATER
VERMIN_FISH
VERMIN_GROUNDER
VERMIN_ROTTER
VERMIN_SOIL
VERMIN_SOIL_COLONY
}}

{{gamedata|title=Caste Flags|
ADOPTS_OWNER
ALCOHOL_DEPENDENT
ALL_ACTIVE
AMBUSHPREDATOR
AQUATIC_UNDERSWIM
ARENA_RESTRICTED
AT_PEACE_WITH_WILDLIFE
BENIGN
BLOODSUCKER
BONECARN
CANNOT_BREATHE_AIR
CANNOT_CLIMB
CANNOT_JUMP
CANOPENDOORS
CAN_BREATHE_WATER
CAN_LEARN / INTELLIGENT_LEARNS
CAN_SPEAK / INTELLIGENT_SPEAKS
CAN_SWIM
CAN_SWIM_INNATE
CARNIVORE
CAVE_ADAPT
COLONY_EXTERNAL
COMMON_DOMESTIC
CONVERTED_SPOUSE
COOKABLE_LIVE
CRAZED
CREPUSCULAR
CURIOUS_BEAST
CURIOUS_BEAST_EATER
CURIOUS_BEAST_GUZZLER
CURIOUS_BEAST_ITEM
DEMON
DIE_WHEN_VERMIN_BITE
DIURNAL
DIVE_HUNTS_VERMIN
EQUIPS
EXTRAVISION
FEATURE_ATTACK_GROUP
FEATURE_BEAST
FIREIMMUNE
FIREIMMUNE_SUPER
FISHITEM
FLEEQUICK
FLIER
GELDABLE
GETS_INFECTIONS_FROM_ROT
GETS_WOUND_INFECTIONS
GNAWER
GRAZER
HASSHELL
HAS_BABYSTATE
HAS_BLOOD
HAS_CHILDSTATE
HAS_COLOR
HAS_FLY_RACE_GAIT
HAS_GLOW_COLOR
HAS_GLOW_TILE
HAS_GRASP
HAS_NERVES
HAS_PUS
HAS_RACE_GAIT
HAS_ROTTABLE
HAS_SECRETION
HAS_SOLDIER_TILE
HAS_SOUND_ALERT
HAS_SOUND_PEACEFUL_INTERMITTENT
HAS_TILE
HUNTS_VERMIN
IMMOBILE
IMMOBILE_LAND
IMMOLATE
ITEMCORPSE
LAIR_HUNTER
LARGE_PREDATOR
LAYS_EGGS
LAYS_UNUSUAL_EGGS
LIGAMENTS
LIGHT_GEN
LISP
LOCAL_POPS_CONTROLLABLE
LOCAL_POPS_PRODUCE_HEROES
LOCKPICKER
MAGICAL
MAGMA_VISION
MANNERISM_BREATH
MANNERISM_EYELIDS
MANNERISM_LAUGH
MANNERISM_POSTURE
MANNERISM_SIT
MANNERISM_SMILE
MANNERISM_STRETCH
MANNERISM_WALK
MATUTINAL
MEANDERER
MEGABEAST
MILKABLE
MISCHIEVIOUS
MOUNT
MOUNT_EXOTIC
MULTIPART_FULL_VISION
MULTIPLE_LITTER_RARE
NATURAL_ANIMAL
NIGHT_CREATURE
NIGHT_CREATURE_BOGEYMAN
NIGHT_CREATURE_EXPERIMENTER
NIGHT_CREATURE_HUNTER
NIGHT_CREATURE_NIGHTMARE
NOBONES
NOBREATHE
NOCTURNAL
NOEMOTION
NOEXERT
NOFEAR
NOMEAT
NONAUSEA
NOPAIN
NOSKIN
NOSKULL
NOSMELLYROT
NOSTUCKINS
NOSTUN
NOTHOUGHT
NOT_BUTCHERABLE
NOT_LIVING
NO_AUTUMN
NO_CONNECTIONS_FOR_MOVEMENT
NO_DIZZINESS
NO_DRINK
NO_EAT
NO_FEVERS
NO_PHYS_ATT_GAIN
NO_PHYS_ATT_RUST
NO_SLEEP
NO_SPRING
NO_SUMMER
NO_THOUGHT_CENTER_FOR_MOVEMENT
NO_UNIT_TYPE_COLOR
NO_VEGETATION_PERTURB
NO_WINTER
OPPOSED_TO_LIFE
OUTSIDER_CONTROLLABLE
PACK_ANIMAL
PARALYZEIMMUNE
PATTERNFLIER
PEARL
PET
PET_EXOTIC
POWER
REMAINS_ON_VERMIN_BITE_DEATH
REMAINS_UNDETERMINED
RETURNS_VERMIN_KILLS_TO_OWNER
SEMIMEGABEAST
SLOW_LEARNER
SPOUSE_CONVERSION_TARGET
SPOUSE_CONVERTER
SPREAD_EVIL_SPHERES_IF_RULER
STANCE_CLIMBER
STRANGE_MOODS
SUPERNATURAL
TENDONS
THICKWEB
TITAN
TRAINABLE_HUNTING
TRAINABLE_WAR
TRANCES
TRAPAVOID
UNIQUE_DEMON
UTTERANCES
VEGETATION
VERMIN_GOBBLER
VERMIN_HATEABLE
VERMIN_MICRO
VERMIN_NOFISH
VERMIN_NOROAM
VERMIN_NOTRAP
VESPERTINE
WAGON_PULLER
WEBBER
WEBIMMUNE
}}

==See Also==
* [[Syndrome]]
* [[Interaction examples]]

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

Graphics

2025-03-15T20:37:23Z

Qeveren: /* Basic Graphics */ Added CDI_LIST_ICON, actual usage is unclear, related to icons in interaction menus in Adventure Mode?

{{Quality|Superior}}{{av}}
[[File:graphics_v50_preview.png|209px|right]]
:{{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 '''graphics''' system in v50 is [https://github.com/Putnam3145/Dwarf-Fortress--libgraphics-- open-source]. 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 the game will resize other resolutions into a 32x32 tile. Depending on your zoom and interpolation settings, rescaled tiles can be subject to [Wikipedia:Artifact (error)|artefacting]].
* 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 ==
{{for/see|a list of all known creature graphics tokens|[[Graphics token#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 ===
[[File:Graphics_template_xy_positions.png|thumb|320px|right|An example of how X and Y positions are read, starting from the top left.]]
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.

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

|-
| {{token|CDI_LIST_ICON|g}} || Yes || Displayed in interaction menus in Adventure Mode{{verify}}. Seems to reference CDI:TOKEN:''token_name'' in CAN_DO_INTERACTION in creature definitions.

|}

=== Caste Graphics ===
Creature caste graphics allow a simple alternative to [[#Layered Graphics|Layered Graphics]] to represent males and females (or other castes) 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]].

=== Large Graphics ===
[[File:Graphics_template_large_3x2.png|right|thumb|A 3x2 large image is rendered in the top center, with the central tile in red.]]
[[File:Graphics_template_large_2x1.png|right|thumb|A 2x1 large image is left-justified.]]
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 ===
[[File:Graphics_template_statues.png|right|thumb]]
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:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

[STATUE_CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
[DEFAULT:<tile page identifier>:<x1>:<y1>:<x2>:<y2>]

* ''creature id'': The [[Creature token|Creature ID]] the graphics represent.
* ''caste id'': The [[Caste|Caste ID]] of the caste whose graphics are being defined.
* ''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.

Statue graphics will be automatically recolored based on how their [[Color#Color tokens|Color]] would appear in the default [[Graphics token#Palettes|palette]], like an item. The image (right) is an example of how a graphic would be aligned within the 1x2 grid. Vanilla statues customarily place the bottom row of pixels on the white line, with the gold box delineating where a 32px tall (exactly) sprite would fit.

=== 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#LAYER_SET|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. Does not need to be unique. 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.

====Portraits====

96x96 portraits{{version|50.13}} are shown in [[Adventure mode]] and when viewing a creature's sheet. They use the same tokens as layered graphics to display a more detailed view of a creature.

A single-layer portrait can be added to a [CREATURE_GRAPHICS] entry with this format:

[LAYER_SET:PORTRAIT]
[LAYER_GROUP]
[LAYER:MAIN:<tile page id>:<x position>:<y position>]
[END_LAYER_GROUP]

See above for the explanation of each argument.

=== Procedural Creature Graphics ===
Procedural graphics define layered graphics based on which body parts are present in each [[Creature token#GENERATED|procedurally-generated]] forgotten beast, titan, or otherwise.

[TILE_GRAPHICS_RECTANGLE:<tile page id>:<x>:<y>:<width>:<height>:<PCG layering token>]

* ''[[#Tile Page|tile page identifier]]'': Internal ID of the image defined in Tile Page.
* ''x'': The x position of the upper left tile counting from 0 from the left of the tile page.
* ''y'': The y position of the upper left tile counting from 0 from the top of the tile page.
* ''width'': How many tiles right the graphic spans. Usually this is 3.
* ''height'': How many tiles down the graphic spans. Usually this is 2.
* ''[[Creature token#PCG_LAYERING|PCG layering token]]'': The internal ID of a [[procedural graphics layer]], representing 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 <x>, <y> and the size defined by <width>, <height>. The PCG layering 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.

Humanoid [[experiment]]s use <code>TILE_GRAPHICS</code> instead of <code>TILE_GRAPHICS_RECTANGLE</code>, which omits the <width> and <height> parameters.

The {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} token allows a creature to use the generation system for a given [[Graphics token#Basic creature sprite types|sprite type]] (which can be caste-specific), and each {{token|PCG_LAYERING|c}} entry will add that part to the assembled sprite.

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

== Workshop Graphics ==
Workshop graphics are displayed during each stage of construction and when it is completed. There are two layers, the base layer and an OVERLAY layer. The base layer shows the floor, tables, chairs and other basic features. The overlay shows various decorations that give the workshop its unique appearance.

base layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]
overlay layer:
[TILE_GRAPHICS:<tile page identifier>:<graphic tile x position>:<graphic tile y position>:WORKSHOP_CUSTOM_OVERLAY:<workshop id>:<building stage>:<workshop tile x position>:<workshop tile y position>]

* ''[[#Tile Page|tile page identifier]]'': The Internal ID of the image defined in the Tile Page.
* ''graphic tile x position'': The x position of the graphic in tiles counting from 0 (left→right).
* ''graphic tile y position'': The y position of the graphic in tiles counting from 0 (top→bottom).
* ''WORKSHOP_CUSTOM'' and ''WORKSHOP_CUSTOM_OVERLAY'': These tokens define the graphics as belonging to a custom workshop. These tokens do not exist in vanilla workshops except for the Soap maker and Screw press, which are used as examples for custom workshops.
* ''workshop id'': The ID of the workshop defined in its raws.
* ''building stage'': What building stage this graphic is displayed during.
* ''workshop tile x position'': The x position of the workshop tile where the graphic is displayed counting from 0 (left→right).
* ''workshop tile y position'': The y position of the workshop tile where the graphic is displayed counting from 0(top→bottom).

Note that an extra Y row is defined above the workshop. This allows for graphics that extend into the tile above the workshop.

Also note that currently custom furnaces do not properly work with premium graphics. The WORKSHOP_CUSTOM and WORKSHOP_CUSTOM_OVERLAY tokens ONLY work with custom workshops. If used with a custom furnace they give an error and the graphics will not appear in game. Custom furnaces can still be made to use graphics if they are defined as workshops in their raws.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_buildings_graphics\graphics\graphics_workshops.txt</code>

== World Map Graphics ==
World map graphics come in two variations:

[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>]
[TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>:<variation {1 - 5}>]

* ''[[#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).
* ''graphic id'': The [[Graphics_token#World_Map_Graphics|Graphic Token]] of the world map tile the graphics represent.
* ''variation {1 - 5}'': For Graphic IDs that allow variants.

These values can be validated by checking the RAW vanilla file <code>[DF Installion]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt</code>

== Palettes ==
[[File:palettes_v50.png|right]]

[[Palette]]s are used by [[graphics]] to render colorized objects. This is usually based on [[Material definition token#STATE_COLOR|material colors]], though arbitrary palettes{{version|50.13}} can be created and applied with {{token|USE_PALETTE|g}}.

[PALETTE:<palette identifier>]
[FILE:images/imagename.png]
[PALETTE_DEFAULT:<row>] this is the one used in the images themselves
[PALETTE_COLOR:<color>:<row>]

* ''name'': The Internal ID being created for the image. DEFAULT is used by most objects and requires a PALETTE_COLOR entry for each [[Descriptor color token|raw-defined color]] that exists.
* ''imagename.png'': The file name of the 8bit RGBA (sometimes called 32bit) in the <code>\graphics\images</code> folder of the mod.
* ''row'': The y position of the graphic to be displayed in pixels counting from 0 (top→bottom). It is customary to place the default palette at 0.
* ''color'': A [[Color#Color tokens|color]] token.

Each row of the vanilla palettes.png file is a palette. The PALETTE_DEFAULT row is the row of colors (aka palette) used to in the internal graphics (which are loaded by a tile page) and get replaced by the colors of one of the other rows as specified in the palette_default.txt file. It isn't shown in-game, but the exact RGB values are replaced by the row specified by <code>[PALETTE_COLOR]</code> or {{token|USE_PALETTE|g}}. Each palette supports up to 18 colors.

Below is a set of color ramps used for vanilla graphics. The colors in the '''Metal''' and '''Wood''' columns will be replaced by the palette corresponding to the object's [[Material definition token#STATE_COLOR|material color]], and all other colors are off-palette and will not be colorized. '''Fake Metal''' is used for metallic details on non-metal objects, like the gray trim of a wooden buckler, and other ramps are used for workshop overlays. '''Handle''' is used throughout the game to represent brown materials, and wooden weapons are an example of how to convert it into the main palette.

<center>'''PALETTE_DEFAULT source colors'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |

{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 0px solid black"
|- style="background: #fff"
| '''Metal'''
|- style="color: black; background: #ffffff"
| #FFFFFF
|- style="color: black; background: #C7C4B4"
| #C7C4B4
|- style="color: black; background: #A5A6A5"
| #A5A6A5
|- style="color: black; background: #8A9091"
| #8A9091
|- style="color: white; background: #6B7076"
| #6B7076
|- style="color: white; background: #5A5E65"
| #5A5E65
|- style="color: white; background: #494C54"
| #494C54
|- style="color: white; background: #3C3E46"
| #3C3E46
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Wood'''
|- style="color: black; background: #D7D3D2"
| #D7D3D2
|- style="color: black; background: #B3A59E"
| #B3A59E
|- style="color: black; background: #94877E"
| #94877E
|- style="color: black; background: #746A63"
| #746A63
|- style="color: white; background: #605852"
| #605852
|- style="color: white; background: #564F49"
| #564F49
|- style="color: white; background: #4E4743"
| #4E4743
|- style="color: white; background: #463E3D"
| #463E3D
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

<center>'''Off-palette color ramps'''</center>
{| style="margin: 0 auto; border-spacing: 0"
|-
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 1px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Metal'''
|- style="color: black; background: #FFFEFF"
| #FFFEFF
|- style="color: black; background: #CECAB9"
| #CECAB9
|- style="color: black; background: #A9AAA9"
| #A9AAA9
|- style="color: black; background: #8B9293"
| #8B9293
|- style="color: white; background: #696F75"
| #696F75
|- style="color: white; background: #565B62"
| #565B62
|- style="color: white; background: #464951"
| #464951
|- style="color: white; background: #3F434C"
| #3F434C
|- style="color: white; background: #393B44"
| #393B44
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Fake Wood'''
|- style="color: black; background: #D8B796"
| #D8B796
|- style="color: black; background: #B7926C"
| #B7926C
|- style="color: black; background: #A57D5E"
| #A57D5E
|- style="color: black; background: #936850"
| #936850
|- style="color: white; background: #815E50"
| #815E50
|- style="color: white; background: #6F5450"
| #6F5450
|- style="color: white; background: #5B4749"
| #5B4749
|- style="color: white; background: #473941"
| #473941
|- style="color: white; background: #2F3038"
| #2F3038
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Handle'''
|- style="color: black; background: #E1CEAF"
| #E1CEAF
|- style="color: black; background: #CDAC85"
| #CDAC85
|- style="color: black; background: #B98B5B"
| #B98B5B
|- style="color: black; background: #9E674A"
| #9E674A
|- style="color: white; background: #775653"
| #775653
|- style="color: white; background: #60474B"
| #60474B
|- style="color: black; background: white"
| n/a
|- style="color: white; background: #483743"
| #483743
|- style="color: white; background: #2E2A38"
| #2E2A38
|}
| style="vertical-align: top; padding: 0" |
{| style="text-align: center; border-spacing: 0 1px; margin: 0 auto; background: black; border-left: 0px solid black; border-right: 1px solid black"
|- style="background: #fff"
| '''Still'''
|- style="color: black; background: #E5B076"
| #E5B076
|- style="color: black; background: #D1894A"
| #D1894A
|- style="color: black; background: #BF703C"
| #BF703C
|- style="color: black; background: #A35D3A"
| #A35D3A
|- style="color: white; background: #85534B"
| #85534B
|- style="color: white; background: #644249"
| #644249
|- style="color: white; background: #4B4047"
| #4B4047
|- style="color: white; background: #293945"
| #293945
|- style="color: white; background: #2F3038"
| #2F3038
|}
|}

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

Inorganic material definition token

2025-03-15T00:31:07Z

Qeveren: Added brief description INORGANIC raw function and format

{{Quality|Superior}}
{{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.

When creating inorganic material definitions, the <code>[OBJECT:INORGANIC]</code> [[token]] begins the definition of an inorganic [[raw file]]. Following this, each new inorganic material definition begins with the <code>[INORGANIC:material_name]</code> token, where <code>material_name</code> is a unique identifier for the material; and that material's properties are then defined using the tokens listed below, in addition to the tokens listed under [[Material definition token]].
{{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.
|-
| {{text anchor|MYTHICAL}}{{version|51.01-beta26}}|| ||Implied by {{token|MYTHICAL_REMNANT|Inorganic}} and {{token|MYTHICAL_SUBSTANCE|Inorganic}}, all usable in written raws.
|-
| {{text anchor|MYTHICAL_REMNANT}}{{version|51.01-beta26}}|| ||Found on [[primordial remnant]]s.
|-
| {{text anchor|MYTHICAL_SUBSTANCE}}{{version|51.01-beta26}}|| ||Found on [[mythical substance]]s. If a creature has a [[liquid]] or a [[glob]] of this in their inventory, they will consume it in the ``COMBAT`` (aka ``DEFEND``) and ``FLEEING``[[Interaction token#USAGE_HINT|contexts]] after suffering a major injury.
|}

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

Material definition token

2025-03-15T00:31:02Z

Qeveren: Added brief description of MATERIAL_TEMPLATE raw function and format

{{Quality|Fine}}
{{av}}
{{Modding}}

The following [[token]]s can be used in creating new [[:Category:material template raw pages|material templates]], as well as in [[material]] definitions (whether for inorganics or those within plants and creatures).

Material templates are used to define broad classes of materials (eg. "stone", or "milk"), the properties of which can be imported into other more specific material definitions (eg. "granite", or "llama milk") using the <code>[USE_MATERIAL_TEMPLATE:template_name]</code> token. When creating material templates, the <code>[OBJECT:MATERIAL_TEMPLATE]</code> [[token]] begins the definition of a material template [[raw file]]. Following this, each new material template definition begins with the <code>[MATERIAL_TEMPLATE:template_name]</code> token, where <code>template_name</code> is a unique identifier for the template, and that material's properties are then defined using the tokens listed below.

{{Urist asks|q=Materials use specific, often bespoke, units. Are there any tools to help convert from real-world values?|a=
Here are some web-based [[utilities]] designed for raw authoring.

For [[material science|yield]] and [[strain at yield|elasticity]]: https://putnam3145.github.io/helper

For [[temperature]]: https://jose96xd.github.io/DF_Tools/Modules/TemperatureConverter.html
}}

__TOC__
{{clear}}

==Material properties==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| {{text_anchor|USE_MATERIAL_TEMPLATE}}
|
* <template name>
| Resets all material tokens back to their default values, then imports the tokens of the specified preexisting material template (overriding any tokens defined prior to itself in the material). This means USE_MATERIAL_TEMPLATE should be the first token present in any material using it. It cannot be used inside of a [MATERIAL_TEMPLATE:X] which prevents the creation of nested material template structures.

|-
| {{text_anchor|PREFIX}}
|
* <prefix> or NONE
| Applies a prefix to all items made from the material. For PLANT and CREATURE materials, this defaults to the plant/creature name. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|STONE_NAME}}
|
* <name>
| Overrides the name of [[Item_token#BOULDER|BOULDER]] items (i.e. mined-out stones) made of the material (used for native copper/silver/gold/platinum to make them be called "nuggets" instead of "boulders").

|-
| {{text_anchor|IS_GEM}}
|
* <name>
* <plural>
* OVERWRITE_SOLID (optional)
| Used to indicate that said material is a gemstone - when tiles are mined out, rough gems will be yielded instead of boulders. Plural can be "STP" to automatically append an "s" to the singular form, and OVERWRITE_SOLID will override the relevant STATE_NAME and STATE_ADJ values.

|-
| {{text_anchor|TEMP_DIET_INFO}}
|
* <type>
| Specifies what the material should be treated as when drinking water contaminated by it, for generating unhappy [[thought]]s. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, and FILTH.

|-
| {{text_anchor|POWDER_DYE}}
|
*<[[Color#Color_tokens|color token]]>
| Allows the material to be used as [[dye]], and defines color of dyed items.

|-
| {{text_anchor|TILE}}
|
*<[[Main:Character table|tile value or character]]>
| Specifies the tile that will be used to represent unmined tiles made of this material. Generally only used with stones. Defaults to 219 ('█').

|-
| {{text_anchor|ITEM_SYMBOL}}
|
*<[[Main:Character table|tile value or character]]>
| Specifies the tile that will be used to represent [[Item_token#BOULDER|BOULDER]] items made of this material. Generally only used with stones. Defaults to 7 ('•').

|-
| {{text_anchor|DISPLAY_COLOR}}
|
*<[[Color#Color_values|foreground color]]>
*<[[Color#Color_values|background color]]>
*<[[Color#Color_values|foreground brightness]]>
| The on-screen color of the material. Uses a standard 3-digit [[Color|color token]]. Equivalent to [TILE_COLOR:a:b:c], [BUILD_COLOR:b:a:X] (X = 1 if 'a' equals 'b', 0 otherwise), and [BASIC_COLOR:a:c]

|-
| {{text_anchor|BUILD_COLOR}}
|
*<[[Color#Color_values|foreground color]]>
*<[[Color#Color_values|background color]]>
*<[[Color#Color_values|foreground brightness]]>
| The color of objects made of this material which use both the foreground and background color: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[cage]]s. Defaults to 7:7:1 (white).

|-
| {{text_anchor|TILE_COLOR}}
|
*<[[Color#Color_values|foreground color]]>
*<[[Color#Color_values|background color]]>
*<[[Color#Color_values|foreground brightness]]>
| The color of unmined tiles containing this material (for stone and soil), as well as [[engraving]]s in this material. Defaults to 7:7:1 (white).

|-
| {{text_anchor|BASIC_COLOR}}
|
*<[[Color#Color_values|foreground color]]>
*<[[Color#Color_values|foreground brightness]]>
| The color of objects made of this material which use only the foreground color, including workshops, floors and boulders, and smoothed walls. Defaults to 7:1 (white).

|-
| {{text_anchor|STATE_COLOR}}
|
*<[[Material_definition_token#Material States|material state]]>
*<[[Color#Color_tokens|color token]]>
| Determines the color of the material at the specified state. See [[Material_definition_token#Material states|below]] for a list of valid material states. Color comes from descriptor_color_standard.txt. The nearest color value is used to display contaminants and body parts made of this material in ASCII and to color items and constructions made from this material with graphics. Example:
[STATE_COLOR:ALL_SOLID:GRAY]

|-
| {{text_anchor|STATE_NAME}}
|
*<[[Material_definition_token#Material States|material state]]>
*<name>
| Determines the name of the material at the specified state, as displayed in-game.
[STATE_NAME:ALL_SOLID:stone]

|-
| {{text_anchor|STATE_ADJ}}
|
*<[[Material_definition_token#Material States|material state]]>
*<adjective>
| Like [[Material_definition_token#STATE_NAME|STATE_NAME]], but used in different situations. Equipment made from the material uses the state adjective and not the state name.

|-
| {{text_anchor|STATE_NAME_ADJ}}
|
*<[[Material_definition_token#Material States|material state]]>
*<name>
*<adjective>
| Sets both [[Material_definition_token#STATE_NAME|STATE_NAME]] and [[Material_definition_token#STATE_ADJ|STATE_ADJ]] at the same time.

|-
| {{text_anchor|ABSORPTION}}
|
*<value>
| The material's tendency to absorb liquids. Containers made of materials with nonzero absorption cannot hold liquids unless they have been [[glaze]]d. Defaults to 0.

|-
| {{text_anchor|IMPACT_YIELD}}
|
*<pressure>
| Specifies how hard of an impact (in kPa) the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.

|-
| {{text_anchor|IMPACT_FRACTURE}}
|
*<pressure>
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.

|-
| {{text_anchor|IMPACT_STRAIN_AT_YIELD}} or {{text_anchor|IMPACT_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given (in parts-per-100000) when the yield point is reached. Used for blunt-force combat. Defaults to 0. Apparently affects in combat whether the corresponding tissue is bruised (value >= 50000), torn (value between 25000 and 49999), or fractured (value <= 24999)

|-
| {{text_anchor|COMPRESSIVE_YIELD}}
|
*<pressure>
| Specifies how hard the material can be compressed before it will start deforming permanently. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.

|-
| {{text_anchor|COMPRESSIVE_FRACTURE}}
|
*<pressure>
| Specifies how hard the material can be compressed before it will fail entirely. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.

|-
| {{text_anchor|COMPRESSIVE_STRAIN_AT_YIELD}} or {{text_anchor|COMPRESSIVE_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given when it has been compressed to its yield point. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 0.

|-
| {{text_anchor|TENSILE_YIELD}}
|
*<pressure>
| Specifies how hard the material can be stretched before it will start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| {{text_anchor|TENSILE_FRACTURE}}
|
*<pressure>
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| {{text_anchor|TENSILE_STRAIN_AT_YIELD}} or {{text_anchor|TENSILE_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given when it is stretched to its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.

|-
| {{text_anchor|TORSION_YIELD}}
|
*<pressure>
| Specifies how hard the material can be twisted before it will start deforming permanently. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 10000.

|-
| {{text_anchor|TORSION_FRACTURE}}
|
*<pressure>
| Specifies how hard the material can be twisted before it will fail entirely. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 10000.

|-
| {{text_anchor|TORSION_STRAIN_AT_YIELD}} or {{text_anchor|TORSION_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given when it is twisted to its yield point. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 0.

|-
| {{text_anchor|SHEAR_YIELD}}
|
*<pressure>
| Specifies how hard the material can be sheared before it will start deforming permanently. Used for cutting calculations. Defaults to 10000.

|-
| {{text_anchor|SHEAR_FRACTURE}}
|
*<pressure>
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.

|-
| {{text_anchor|SHEAR_STRAIN_AT_YIELD}} or {{text_anchor|SHEAR_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given when sheared to its yield point. Used for cutting calculations. Defaults to 0.

|-
| {{text_anchor|BENDING_YIELD}}
|
*<pressure>
| Specifies how hard the material can be bent before it will start deforming permanently. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.

|-
| {{text_anchor|BENDING_FRACTURE}}
|
*<pressure>
| Specifies how hard the material can be bent before it will fail entirely. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.

|-
| {{text_anchor|BENDING_STRAIN_AT_YIELD}} or {{text_anchor|BENDING_ELASTICITY}}
|
*<[[Strain at yield|strain]]>
| Specifies how much the material will have given when bent to its yield point. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 0.

|-
| {{text_anchor|MAX_EDGE}}
|
*<value>
| How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.

|-
| {{text_anchor|MATERIAL_VALUE}}
|
*<[[item value]]>
| Value modifier for the material. Defaults to 1. This number can be made negative by placing a "-" in front, resulting in things that you are paid to buy and must pay to sell.

|-
| {{text_anchor|MULTIPLY_VALUE}}
|
*<[[item value]]>
| Multiplies the value of the material. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|SPEC_HEAT}}
|
*<specific heat capacity>
| Rate at which the material heats up or cools down (in J⋅kg−1⋅K−1.). If set to NONE, the temperature will be fixed at its initial value. See [[Temperature]] for more information. Defaults to NONE.

|-
| {{text_anchor|HEATDAM_POINT}}
|
*<[[temperature]]>
| Temperature above which the material takes damage from heat. May be set to NONE. If the material has an ignite point but no heatdam point, it will burn for a very long time (9 months and 16.8 days). Defaults to NONE.

|-
| {{text_anchor|COLDDAM_POINT}}
|
*<[[temperature]]>
| Temperature below which the material takes damage from cold. Defaults to NONE.

|-
| {{text_anchor|IGNITE_POINT}}
|
*<[[temperature]]>
| Temperature at which the material will catch fire. Defaults to NONE.

|-
| {{text_anchor|MELTING_POINT}}
|
*<[[temperature]]>
| Temperature at which the material melts. Defaults to NONE.

|-
| {{text_anchor|BOILING_POINT}}
|
*<[[temperature]]>
| Temperature at which the material boils. Defaults to NONE.

|-
| {{text_anchor|MAT_FIXED_TEMP}}
|
*<[[temperature]]>
| Items composed of this material will initially have this temperature. Used in conjunction with <code>[SPEC_HEAT:NONE]</code> to make material's temperature fixed at the specified value. Defaults to NONE.

|-
| {{text_anchor|IF_EXISTS_SET_HEATDAM_POINT}}
|
*<[[temperature]]>
| Changes a material's HEATDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|IF_EXISTS_SET_COLDDAM_POINT}}
|
*<[[temperature]]>
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|IF_EXISTS_SET_IGNITE_POINT}}
|
*<[[temperature]]>
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|IF_EXISTS_SET_MELTING_POINT}}
|
*<[[temperature]]>
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|IF_EXISTS_SET_BOILING_POINT}}
|
*<[[temperature]]>
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|IF_EXISTS_SET_MAT_FIXED_TEMP}}
|
*<[[temperature]]>
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| {{text_anchor|SOLID_DENSITY}}
|
*<[[density]]>
| Specifies the density (in kg/m³) of the material when in solid form. Also affects combat calculations; affects blunt-force damage and ability of weak-in-impact-yield blunt attacks to pierce armor. Defaults to NONE.

|-
| {{text_anchor|LIQUID_DENSITY}}
|
*<[[density]]>
| Specifies the density of the material when in liquid form. Defaults to NONE. Also affects combat calculations; affects blunt force damage like SOLID_DENSITY, but only for attacks made by liquids (e.g. forgotten beasts made of water).

|-
| {{text_anchor|MOLAR_MASS}}
|
*<value>
| Specifies (in kg/mol) the molar mass of the material in gaseous form. Only affects combat calculations like the densities, and only for attacks made by gases (e.g. forgotten beasts made of steam).

|-
| {{text_anchor|EXTRACT_STORAGE}}
| * BARREL or FLASK
| Specifies the type of container used to store the material. Used in conjunction with the [EXTRACT_BARREL], [EXTRACT_VIAL], or [EXTRACT_STILL_VIAL] [[plant token]]s. Defaults to BARREL.

|-
| {{text_anchor|BUTCHER_SPECIAL}}
|
*<[[item token]]>
| Specifies the item type used for butchering results made of this material. Stock raws use GLOB:NONE for fat and MEAT:NONE for other meat materials.

|-
| {{text_anchor|MEAT_NAME}}
|
*<prefix>
*<name>
*<adjective>
| When a creature is butchered, meat yielded from organs made from this material will be named via this token.

|-
| {{text_anchor|BLOCK_NAME}}
|
*<singular>
*<plural>
| Specifies the name of [[block]]s made from this material.

|-
| {{text_anchor|WAFERS}}
|
| The material forms "wafers" instead of "[[bar]]s".

|-
| {{text_anchor|MATERIAL_REACTION_PRODUCT}}
|
*<reaction reference>
*<[[material token]]>
| Used with reaction raws to associate a reagent material with a product material. The first argument is used by HAS_MATERIAL_REACTION_PRODUCT and GET_MATERIAL_FROM_REAGENT in reaction raws. The remainder is a material reference, generally LOCAL_CREATURE_MAT:SUBTYPE or LOCAL_PLANT_MAT:SUBTYPE or INORGANIC:STONETYPE.
[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]

|-
| {{text_anchor|ITEM_REACTION_PRODUCT}}
|
*<item reference>
*<[[item token]]>
*<[[material token]]>
| Used with reaction raws to associate a reagent material with a complete item. The first argument is used by HAS_ITEM_REACTION_PRODUCT and GET_ITEM_DATA_FROM_REAGENT in reaction raws. The rest refers to the type of item, then its material.
[ITEM_REACTION_PRODUCT:BAG_ITEM:PLANT_GROWTH:LEAVES:LOCAL_PLANT_MAT:LEAF]

|-
| {{text_anchor|REACTION_CLASS}}
|
*<reaction class name>
| Used to classify all items made of the material, so that reactions can use them as generic reagents.
In default raws, the following are used:
* FAT, TALLOW, SOAP, PARCHMENT, PAPER_PLANT, PAPER_SLURRY, MILK, CHEESE, WAX
* CAN_GLAZE - items made from this material can be glazed.
* FLUX - can be used as [[flux]] in pig iron and steel making.
* GYPSUM - can be processed into [[gypsum plaster]].
* CALCIUM_CARBONATE - can be used in production of [[quicklime]].

|-
| {{text_anchor|METAL_ORE}}
|
* <inorganic material name e.g. [[lead|LEAD]]>
* <value>
| Makes BOULDER acceptable as a [[Reactions#Reagents|reagent]] in reactions that require [[Item_token#Related_Tokens|"METAL_ORE:MATERIAL_NAME"]], as well as [[Smelter|smelting]] directly into metal [[bar]]s. Places the material under "Metal Ores" in Stone stockpiles. The specified value determines the probability for this product (see [[Tetrahedrite]] or [[Galena]] for details).

|-
| {{text_anchor|THREAD_METAL}}
|
* <inorganic material name e.g. [[Raw_adamantine|RAW_ADAMANTINE]]>
* <value>
| Makes BOULDER items made of the material acceptable for [[Strand extractor|strand extraction]] into threads; see also STOCKPILE_THREAD_METAL. Value presumably determines the probability of this product extracted.{{verify}}

|-
| {{text_anchor|HARDENS_WITH_WATER}}
|
* <[[material token]]>
| Allows the material to be used to make [[healthcare|casts]].

|-
| {{text_anchor|SOAP_LEVEL}}
|
*<value>
| Determines effectiveness of soap - if the amount of grime on a body part is more than 3-SOAP_LEVEL, it sets it to 3-SOAP_LEVEL; as such setting it above 3 is bad. [[Soap]] has [SOAP_LEVEL:2]. Defaults to 0.

|-
| {{text_anchor|SYNDROME}}
|
| Begins defining a [[syndrome]] applied by the material. Multiple syndromes can be specified. See [[Syndrome token]].

|-
| {{text_anchor|ANTLER}}
|
| Found in the raws of several antler-wielding animals. It is used to show an antler as bodypart.
|

|-
| {{text_anchor|HAIR}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|FEATHER}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|SCALE}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|HOOF}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|CHITIN}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|CARTILAGE}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|NERVOUS_TISSUE}}
|
| Probably used in graphics.
|

|-
| {{text_anchor|MEAT_CATEGORY}}
| category
| Probably used in graphics. The following values for "category" are used in the vanilla raws: STANDARD, EYE, BRIAN, LUNG, HEART, LIVER, INTESTINES, STOMACH, GIZZARD, PANCREAS, SPLEEN, KIDNEY.
|}

===Material states===

The following is a list of valid material states:

{| {{prettytable}}
|-
|'''SOLID'''
|-
|'''LIQUID'''
|-
|'''GAS'''
|-
|'''POWDER''' (or '''SOLID_POWDER''')
|-
|'''PASTE''' (or '''SOLID_PASTE''')
|-
|'''PRESSED''' (or '''SOLID_PRESSED''')
|}

The following can be specified within tokens such as [[Material_definition_token#STATE_NAME|STATE_NAME]], [[Material_definition_token#STATE_NAME_ADJ|STATE_NAME_ADJ]] and [[Material_definition_token#STATE_ADJ|STATE_ADJ]] to make them apply to several of the above material states simultaneously:

{| {{prettytable}}
|- bgcolor="#C0C0C0"
!Value
!Description
|-
|'''ALL'''
|Denotes all possible material states.
|-
|'''ALL_SOLID'''
|Denotes 'SOLID', 'POWDER', 'PASTE' and 'PRESSED'.
|}

==Material usage tokens==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| {{text_anchor|IMPLIES_ANIMAL_KILL}}
|
| Lets the game know that an animal was likely killed in the production of this item. Entities opposed to killing animals ([[elf|Elves]] in vanilla) will refuse to accept these items in trade.

|-
| {{text_anchor|ALCOHOL_PLANT}}
|
| Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".

|-
| {{text_anchor|ALCOHOL_CREATURE}}
|
| Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".

|-
| {{text_anchor|ALCOHOL}}
|
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| {{text_anchor|CHEESE_PLANT}}
|
| Classifies the material as plant-based cheese, allowing its storage in food stockpiles under "Cheese (Plant)".

|-
| {{text_anchor|CHEESE_CREATURE}}
|
| Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".

|-
| {{text_anchor|CHEESE}}
|
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| {{text_anchor|POWDER_MISC_PLANT}}
|
| Classifies the material as plant powder, allowing its storage in food stockpiles under "Milled Plant".

|-
| {{text_anchor|POWDER_MISC_CREATURE}}
|
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal". Unlike milled plants, such as sugar and flour, "Bone Meal" barrels or pots may not contain bags. Custom reactions using this product better use buckets or jugs instead.

|-
| {{text_anchor|POWDER_MISC}}
|
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| {{text_anchor|STOCKPILE_GLOB}} or {{text_anchor|STOCKPILE_GLOB_SOLID}}
|
| Permits globs of the material in solid form to be stored in food stockpiles under "Fat" - without it, dwarves will come by and "clean" the items, destroying them (unless [DO_NOT_CLEAN_GLOB] is also included).

|-
| {{text_anchor|STOCKPILE_GLOB_PASTE}}
|
| Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".

|-
| {{text_anchor|STOCKPILE_GLOB_PRESSED}}
|
| Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".

|-
| {{text_anchor|STOCKPILE_PLANT_GROWTH}}
|
| Classifies the material as a plant growth (e.g. fruits, leaves), allowing its storage in food stockpiles under Plant Growth/Fruit.

|-
| {{text_anchor|LIQUID_MISC_PLANT}}
|
| Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".

|-
| {{text_anchor|LIQUID_MISC_CREATURE}}
|
| Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".

|-
| {{text_anchor|LIQUID_MISC_OTHER}}
|
| Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.

|-
| {{text_anchor|LIQUID_MISC}}
|
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown, possibly vestigial.

|-
| {{text_anchor|STRUCTURAL_PLANT_MAT}}
|
| Classifies the material as a plant, allowing its storage in food stockpiles under "Plants".

|-
| {{text_anchor|SEED_MAT}}
|
| Classifies the material as a plant seed, allowing its storage in food stockpiles under "Seeds".

|-
| {{text_anchor|BONE}}
|
| Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| {{text_anchor|WOOD}}
|
| Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.

|-
| {{text_anchor|THREAD_PLANT}}
|
| Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".

|-
| {{text_anchor|TOOTH}}
|
| Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| {{text_anchor|HORN}}
|
| Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| {{text_anchor|HAIR}}
|
| Classifies the material as hair, allowing for its use for spinners and restriction from refuse stockpiles by material.

|-
| {{text_anchor|PEARL}}
|
| Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| {{text_anchor|SHELL}}
|
| Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| {{text_anchor|LEATHER}}
|
| Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.

|-
| {{text_anchor|SILK}}
|
| Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".

|-
| {{text_anchor|SOAP}}
|
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{verify}}

|-
| {{text_anchor|GENERATES_MIASMA}}
|
| Material generates miasma when it rots.

|-
| {{text_anchor|MEAT}}
|
| Classifies the material as edible meat.{{verify}}

|-
| {{text_anchor|ROTS}}
|
| Material will rot if not stockpiled appropriately. Currently only affects [[food]] and [[refuse]], other items made of this material will not rot.

|-
| {{text_anchor|NERVOUS_TISSUE}}
|
| In most living creatures, it controls many bodily functions and movements by sending signals around the body. See: [[Nervous tissue]]

|-
| {{text_anchor|BLOOD_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "blood" in Adventurer mode tile descriptions ("Here we have a Dwarf in a slurry of blood.").

|-
| {{text_anchor|ICHOR_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "ichor".

|-
| {{text_anchor|GOO_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "goo".

|-
| {{text_anchor|SLIME_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "slime".

|-
| {{text_anchor|PUS_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "pus".

|-
| {{text_anchor|SWEAT_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "sweat".

|-
| {{text_anchor|TEARS_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "tears".

|-
| {{text_anchor|SPIT_MAP_DESCRIPTOR}}
|
| Tells the game to classify contaminants of this material as being "spit".

|-
| {{text_anchor|EVAPORATES}}
|
| Contaminants composed of this material evaporate over time, slowly disappearing from the map. Used internally by water.

|-
| {{text_anchor|ENTERS_BLOOD}}
|
| Used for materials which cause [[syndrome]]s, causes it to enter the creature's blood instead of simply spattering on the surface.

|-
| {{text_anchor|EDIBLE_VERMIN}}
|
| Can be eaten by vermin.

|-
| {{text_anchor|EDIBLE_RAW}}
|
| Can be eaten raw.

|-
| {{text_anchor|EDIBLE_COOKED}}
|
| Can be cooked and then eaten.

|-
| {{text_anchor|DO_NOT_CLEAN_GLOB}}
|
| Prevents globs made of this material from being cleaned up and destroyed.

|-
| {{text_anchor|NO_STONE_STOCKPILE}}
|
| Prevents the material from showing up in Stone stockpile settings.

|-
| {{text_anchor|ITEMS_METAL}}
|
| The material can be made into minecarts, wheelbarrows, and stepladders at the metalsmith's forge.

|-
| {{text_anchor|ITEMS_BARRED}}
|
| Equivalent to ITEMS_HARD. Given to [[bone]].

|-
| {{text_anchor|ITEMS_SCALED}}
|
| Equivalent to ITEMS_HARD. Given to [[shell]].

|-
| {{text_anchor|ITEMS_LEATHER}}
|
| Equivalent to ITEMS_SOFT. Given to [[leather]].

|-
| {{text_anchor|ITEMS_SOFT}}
|
| The material can be made into clothing, amulets, bracelets, earrings, backpacks, and quivers, contingent on which workshops accept the material. Given to [[plant fiber]], [[silk]] and [[wool]].

|-
| {{text_anchor|ITEMS_HARD}}
|
| The material can be made into furniture, crafts, mechanisms, and blocks, contingent on which workshops accept the material. Random [[finished goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[horn|hooves]] and [[wax|beeswax]]. [[Hair]], [[pearl|pearls]] and eggshells also have the tag.

|-
| {{text_anchor|IS_STONE}}
|
| Used to define that the material is a stone. Allows its usage in [[masonry]] and [[stonecrafting]] and storage in stone stockpiles, among other effects.

|-
| {{text_anchor|UNDIGGABLE}}
|
| Used for a stone that cannot be dug into.

|-
| {{text_anchor|DISPLAY_UNGLAZED}}
|
| Causes containers made of this material to be prefixed with "unglazed" if they have not yet been [[glaze]]d.

|-
| {{text_anchor|YARN}}
|
| Classifies the material as yarn, allowing its use for clothiers and its storage in cloth stockpiles under "Thread (Yarn)" and "Cloth (Yarn)".

|-
| {{text_anchor|STOCKPILE_THREAD_METAL}}
|
| Classifies the material as metal thread, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Metal)" and "Cloth (Metal)".

|-
| {{text_anchor|IS_METAL}}
|
| Defines the material as being metal, allowing it to be used at forges.

|-
| {{text_anchor|IS_GLASS}}
|
| Used internally by green glass, clear glass, and crystal glass. Appears to only affect the [[Reaction#GLASS_MATERIAL|[GLASS_MATERIAL]]] reaction token. Does not cause the game to treat the material like glass, i.e being referred to as "raw" instead of "rough" in its raw form or being displayed in the "glass" trade/embark category.

|-
| {{text_anchor|IS_CERAMIC}}
|
| Defines the material as a ceramic. Examples include CERAMIC_EARTHENWARE, CERAMIC_STONEWARE and CERAMIC_PORCELAIN.

|-
| {{text_anchor|CRYSTAL_GLASSABLE}}
|
| Can be used in the production of crystal glass.

|-
| {{text_anchor|ITEMS_WEAPON}}
|
| Melee [[Weapon#Manufactured weapons|weapons]] can be made out of this material.

|-
| {{text_anchor|ITEMS_WEAPON_RANGED}}
|
| Ranged weapons can be made out of this material.

|-
| {{text_anchor|ITEMS_ANVIL}}
|
| [[Anvil]]s can be made out of this material.

|-
| {{text_anchor|ITEMS_AMMO}}
|
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.

|-
| {{text_anchor|ITEMS_DIGGER}}
|
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.

|-
| {{text_anchor|ITEMS_ARMOR}}
|
| [[Armor]] can be made out of this material.

|-
| {{text_anchor|ITEMS_DELICATE}}
|
| Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.

|-
| {{text_anchor|ITEMS_SIEGE_ENGINE}}
|
| Siege engine parts can be made out of this material. Does not appear to work.

|-
| {{text_anchor|ITEMS_QUERN}}
|
| Querns and millstones can be made out of this material. Does not appear to work.
|}

==Syndrome tokens==
Below is a table with some of the tokens you can use when declaring a [SYNDROME] token. For all the tokens you can use, see the [[Syndrome token]] page.

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

|-
| {{text_anchor|SYN_NAME
|
* text
| Defines the name of the syndrome

|-
| {{text_anchor|SYN_INJECTED}}
|
| Syndrome can be contracted by injection (by a creature)

|-
| {{text_anchor|SYN_CONTACT}}
|
| Syndrome can be contracted on contact (e.g. poison dust or liquid)

|-
| {{text_anchor|SYN_INHALED}}
|
| Syndrome can be contracted by inhalation (e.g. poison vapor or gas)

|-
| {{text_anchor|SYN_INGESTED}}
|
| Syndrome can be contracted by ingestion (when the material is eaten in solid or liquid form)

|-
| {{text_anchor|SYN_AFFECTED_CLASS}}
|
* creature class name
| Adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON

|-
| {{text_anchor|SYN_IMMUNE_CLASS}}
|
* creature class name
| Makes the class of creatures immune to the syndrome

|-
| {{text_anchor|SYN_AFFECTED_CREATURE}}
|
* creature name
* caste name or ALL
| Adds a specific creature to those affected.

|-
| {{text_anchor|SYN_IMMUNE_CREATURE}}
|
* creature name
* caste name or ALL
| Makes the creature immune to the syndrome

|-
| CE_PAIN CE_SWELLING CE_OOZING CE_BRUISING CE_BLISTERS CE_NUMBNESS CE_PARALYSIS CE_FEVER CE_BLEEDING CE_COUGH_BLOOD CE_VOMIT_BLOOD CE_NAUSEA CE_UNCONSCIOUSNESS CE_NECROSIS CE_IMPAIR_FUNCTION CE_DROWSINESS CE_DIZZINESS
|
*SEV:<value> (severity, higher is worse)
*PROB:<value(1-100)> (probability)
*RESISTABLE (optional) allows resistance
*SIZE_DILUTES (optional) lessens effect based on size
Place affected:
*LOCALIZED (optional)
*VASCULAR_ONLY (optional)
*MUSCULAR_ONLY (optional)
*BP:BY_CATEGORY:category:tissue (optional)
*BP:BY_TYPE:type:tissue (optional)
*BP:BY_TOKEN:token:tissue (optional)
Timeline:
*Start:effect start time
*Peak:effect peak time
*End:effect end time
| Specifies the way that a syndrome affects a creature -- more detail can be found on the [[Syndrome#Creature effect tokens|Syndromes page]]

|}

==See also==
* [[Inorganic material definition token]]
* [[Syndrome]]
* [[Hardcoded material]]

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Material definition token]]

Creature token

2025-03-12T20:16:22Z

Qeveren: /* Tokens */ Linked BY_CATEGORY, BY_TYPE, BY_TOKEN to body token entries for clarity

{{Quality|Exceptional}}
{{av}}
{{Modding}}

The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.

The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)

__NOTOC__
{{clear}}
{{alphabetical TOC|style=margin: 1em auto;}}

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Makes the creature need [[alcohol]] to get through the working day; it will choose to drink booze instead of [[water]] if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| When set, the creature will appear at any time of day. Overrides {{token|DIURNAL|c}}, {{token|NOCTURNAL|c}}, {{token|CREPUSCULAR|c}}, {{token|MATUTINAL|c}}, and {{token|VESPERTINE|c}}.

|-
| {{text anchor|ALTTILE}}
| Creature
|
*'character' or tile number
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Found on {{token|LARGE_PREDATOR|c}}s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures. {{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Appearance Modifier
|
*Range (6 values, low to high)
| Based on info from [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Wannabehero on the forums]: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.

The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range. If this is not specified it uses the numbers 10:50:95:105:150:190.

|-
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Appearance Modifier
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| {{text anchor|APP_MOD_IMPORTANCE}}
| Appearance Modifier
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| {{text anchor|APP_MOD_NOUN}}
| Appearance Modifier
|
*noun
*SINGULAR or PLURAL
| Creates a noun for the appearance, and whether it is singular or plural.

|-
| {{text anchor|APP_MOD_RATE}}
| Appearance Modifier
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min (growth)
*max (growth)
*start year
*start day
*end year
*end day
| Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| {{text anchor|APPLY_CREATURE_VARIATION}}
| Caste
|
*creature variation ID
*(optional) any amount of arbitrary arguments
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.

|-
| {{text anchor|APPLY_CURRENT_CREATURE_VARIATION}}
| Special
|
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Enables the creature to breathe in water, but causes it to air-drown on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list. Typically applied to spoileriffic creatures.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.

|-
| {{text anchor|ATTACK}}
| Caste
|
*token
*selection criteria (it's complicated)
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:''' 
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code> 
''GORE'' = name of the attack 
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
|
*population
*exported wealth
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occurring when all of the requirements are met. Setting a value to 0 disables the trigger.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|BABY}}
| Caste
|
*integer
| Age at which creature is considered a child, the default is zero. One can think of this as the duration of the baby stage.

|-
| {{text anchor|BABYNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
|
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.

This and {{token|TRADE_CAPACITY|c}} are required for {{token|PACK_ANIMAL|c}} to function properly, if an animal contains the aforementioned requirements without this tag: items loaded by the merchants will be dropped upon departure.

|-
| {{text anchor|BIOME}}
| Creature
|
* [[biome token]]
| Select a [[biome]] the creature may appear in.

|-
| {{text anchor|BLOOD}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|thirst for blood]] grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) as a creature of the night.

|-
| {{text anchor|BODY}}
| Caste
|
*body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.

The body parts need to be listed in an order such that any parent part appears before its connected children. For example [BODY:HEART:BODY_WITH_HEAD_FLAG] produces a "Body Token Recognized But Could Not Connect: HEART" error because HEART can't find any UPPERBODY(s) to connect to. Switching the order to [BODY:BODY_WITH_HEAD_FLAG:HEART] fixes the problem because now the UPPERBODY is created before the HEART tries to connect to it.

'''If the body is left undefined, the creature (or caste) will be tagged as [DOES_NOT_EXIST].''' {{verify}}

|-
| {{text anchor|BODY_APPEARANCE_MODIFIER}}
| Caste
|
*ATTRIBUTE
*lowest
*lower
*low
*median
*high
*higher
*highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| {{text anchor|BODY_DETAIL_PLAN}}
| Caste
|
*PlanName
*Arguments
| Loads a plan from listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| {{text anchor|BODY_SIZE}}
| Caste
|
*years
*days
*size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials, is roughly equal to the creature's average weight in grams.
'''Example:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it would be 220,000 cm3 and weigh roughly 220 kg.

|-
| {{text anchor|BODYGLOSS}}
| Caste
|
*gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| {{text anchor|BONECARN}}
| Caste
|
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].

|-
| {{text anchor|BP_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| {{text anchor|BP_REMOVE_TYPE}}
| Caste
|
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|BUILDINGDESTROYER}}
| Caste
|
*1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the {{k|b}} + {{k|C}} commands.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|CAN_DO_INTERACTION}}
| Caste
|
*interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| {{text anchor|CAN_LEARN}}
| Caste
|
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten by an adventurer, so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. Skills allocated will disappear on start. A creature with at least this token or the {{token|CAN_SPEAK|c}} token will be able to have [[Personality value|values]] and [[Personality goal|goals]].

|-
| {{text anchor|CAN_SPEAK}}
| Caste
|
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills but to make friends in fortress mode. A creature with at least this token or the {{token|CAN_LEARN|c}} token will be able to have [[Personality value|values]] and [[Personality goal|goals]].

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste
|
| Creature cannot [[climber|climb]], even if it has free grasp parts.

|-
| {{text anchor|CANNOT_JUMP}}
| Caste
|
| Creature cannot [[jump]].

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Defunct, as doors cannot be set as tightly closed anymore.

|-
| {{text anchor|CARNIVORE}}
| Caste
|
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills.

|-
| {{text anchor|CASTE}}
| Creature
|
*name
| Defines a [[caste]].

|-
| {{text anchor|CASTE_ALTTILE}}
| Caste
|
*tile number or "letter"
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.

|-
| {{text anchor|CASTE_COLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|COLOR|c}}.

|-
| {{text anchor|CASTE_GLOWCOLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|GLOWCOLOR|c}}.

|-
| {{text anchor|CASTE_GLOWTILE}}
| Caste
|
*tile value or "letter"
| Caste-specific {{token|GLOWTILE|c}}.

|-
| {{text anchor|CASTE_NAME}}
| Caste
|
*singular
*plural
*adjective
| While {{token|NAME|c}} describes the name of the species, {{token|CASTE_NAME|c}} names individuals of the species. Unlike other caste-specific descriptions, this token is required, even for creatures without separate castes. If left undefined, the creature will not show up in the [[arena]] and members of the species will be labeled as "nothing".

|-
| {{text anchor|CASTE_PROFESSION_NAME}}
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| Caste-specific {{token|PROFESSION_NAME|c}}.

|-
| {{text anchor|CASTE_SOLDIER_ALTTILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SOLDIER_TILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_TILE}}
| Caste
|
* tile number or "letter"
| Caste-specific {{token|CREATURE_TILE|c}}.

|-
| {{text anchor|CAVE_ADAPT}}
| Caste
|
| Causes [[cave adaptation]].
Allows for creature's race to be involved in jokes that end in "And the [race] saw the sun and vomited on the spot!"

|-
| {{text anchor|CDI}}
| Caste
|
*Varies
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].

|-
| {{text anchor|CHANGE_BODY_SIZE_PERC}}
| Caste
|
*integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| {{text anchor|CHANGE_FREQUENCY_PERC}}
| Creature
|
*integer
| Multiplies frequency by a factor of (integer)%.

|-
| {{text anchor|CHILD}}
| Caste
|
*integer
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.

|-
| {{text anchor|CHILDNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.

|-
| {{text anchor|CLUSTER_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of [[egg]]s laid in one sitting.

|-
| {{text anchor|COLONY_EXTERNAL}}
| Caste
|
| Caste hovers around colony.

|-
| {{text anchor|COLOR}}
| Creature
|
*foreground
*background
*brightness
| Color of the creature's tile. See [[Color]] for usage.

|-
| {{text anchor|COMMON_DOMESTIC}}
| Caste
|
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}}, {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| {{text anchor|COOKABLE_LIVE}}
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered/cleaned. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*creature ID
| Copies another specified creature. This will override any definitions made before it; essentially, it makes this creature identical to the other one, which can then be modified. Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. The vanilla [[giant animal]]s and [[animal person|animal people]]s are examples of this token combination.

|-
| {{text anchor|CREATURE}}
| Creature
|
*creature ID
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for {{token|GOBBLE_VERMIN_CLASS|c}}), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

* Creature tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
|-
| {{text anchor|CREATURE_SOLDIER_TILE}}
| Creature
|
*'character' or tile number
| Creatures active in their civilization's [[military]] will use this tile instead.

|-
| {{text anchor|CREATURE_TILE}}
| Creature
|
*'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| {{text anchor|CREPUSCULAR}}
| Caste
|
| When set, the creature will appear at dawn (between 4:30 AM and 6:00 AM) and in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to [[Steals food|steal and eat edible items]] from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) [[Steals drink|drink your alcohol]]. Or spill the barrel to the ground. Also affects undead versions of the creature. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.

|-
| {{text anchor|CV_ADD_TAG}}
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| {{text anchor|CV_REMOVE_TAG}}
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|DEMON}}
| Caste
|
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.

|-
| {{text anchor|DESCRIPTION}}
| Caste
|
*text
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.

|-
| {{text anchor|DIFFICULTY}}
| Caste
|
*integer
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| When set, the creature will only appear during the day (between 6:00 AM and 8:00 PM) in Adventurer mode.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s will lead to worlds being generated without dogs in them. Also removes the creature from the [[object testing arena]]'s spawn list. If combined with {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|EBO_ITEM}}
| Caste
|
*[[item token]]
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
|
*gem shape
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|Egg-laying]] creatures in the default game define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| {{text anchor|EGG_SIZE}}
| Caste
|
*size
| Determines the size of laid [[egg]]s. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature appear as a large 3×3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* [[Body token#CATEGORY|BY_CATEGORY]] or [[Body token#CONTYPE|BY_TYPE]] or [[Body token#BP|BY_TOKEN]]
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat. Invisible creatures will also be seen, namely [[intelligent undead]] using a "vanish" power.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|FANCIFUL}}
| Creature
|
| The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.

|-
| {{text anchor|FEMALE}}
| Caste
|
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|FIREJET]] attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in [[fire]], and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|FISH]] item) at a [[fishery]] to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|fished]] vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

|-
| {{text anchor|FIXED_TEMP}}
| Caste
|
*temperature
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from. Corpses and body parts of creatures with a fixed temperature maintain their temperature even after death.

Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| If engaged in combat, the creature will flee at the first sign of resistance. Used by [[kobold]]s in the vanilla game.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own [[Body_token#FLIER|FLIER]] token).

|-
| {{text anchor|FREQUENCY}}
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading.
This value is used multiply to determine the rarity of animal populations. A creature with [FREQUENCY:50] will appear in 50% of valid biomes, and be present in 50% of the area within those biomes.
When a [[Creature token#CLUSTER_NUMBER|cluster]] spawns, the game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|GAIT}}
| Caste
|
* <gait type>
* <gait name>
* <max [[Gait#Speed|speed]]>
* <build up time>
* <max turning [[Gait#Speed|speed]]>
* <start [[Gait#Speed|speed]]>
* <energy expenditure>
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information. Specifically, you likely want to use one of the existing STANDARD_X_GAITS creature variations, as described in [[Gait#Gaits_and_Modding|this subsection]].

* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
* <start speed> indicates the creature's speed when it starts moving using this gait
* <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 [[tile]]s in a straight line over even terrain.
* <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
* <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and [[Status_icon#Non-flashing|collapse]].

'''NO_BUILD_UP''' can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are '''both''' omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.

'''valid gait types:'''
*'''WALK''' 
Used for moving normally over ground tiles.

*'''CRAWL''' 
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].

*'''SWIM''' 
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.

*'''FLY''' 
Used for moving through [[open space]].

*'''CLIMB''' 
Used for moving whilst [[Climber|climbing]].

'''valid gait flags:'''
* '''AGILITY''' 
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.

* '''STRENGTH''' 
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.

* '''LAYERS_SLOW''' 
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|THICKENS_ON_STRENGTH]] tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

* '''STEALTH_SLOWS:'''<percentage> 
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
|
*singular
*plural
| Like {{token|BABYNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
|
*singular
*plural
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*value A
*value B
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's {{token|GLOWTILE|c}}.

|-
| {{text anchor|GLOWTILE}}
| Creature
|
*ascii character
| If present, the being glows in the dark (generally used for Adventurer Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use {{token|CASTE_GLOWTILE|c}} instead.

|-
| {{text anchor|GNAWER}}
| Caste
|
*verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made (normally wood).

|-
| {{text anchor|GOBBLE_VERMIN_CLASS}}
| Caste
|
*class
| The creature eats vermin of the specified class.

|-
| {{text anchor|GOBBLE_VERMIN_CREATURE}}
| Caste
|
*creature
*caste
| The creature eats a specified [[vermin]].

|-
| {{text anchor|GO_TO_END}}
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| {{text anchor|GO_TO_START}}
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| {{text anchor|GO_TO_TAG}}
| Special
|
| When using tags from an existing creature, inserts new tags ''before'' the specified tag.

|-
| {{text anchor|GOOD}}
| Creature
|
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.

|-
| {{text anchor|GRASSTRAMPLE}}
| Caste
|
*value
| The value determines how rapidly [[grass]] is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| {{text anchor|GRAVITATE_BODY_SIZE}}
| Caste
|
*target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| {{text anchor|GRAZER}}
| Caste
|
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|HABIT}}
| Caste
|
*type
*probability
| Defines certain behaviors for the creature. The habit types are:
*COLLECT_TROPHIES
*COOK_PEOPLE
*COOK_VERMIN
*GRIND_VERMIN
*COOK_BLOOD
*GRIND_BONE_MEAL
*EAT_BONE_PORRIDGE
*USE_ANY_MELEE_WEAPON
*GIANT_NEST
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.

|-
| {{text anchor|HABIT_NUM}}
| Caste
|
*number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".{{cite forum|60554/1719248}} All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| {{text anchor|HAS_NERVES}}
| Caste
|
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.

|-
| {{text anchor|HASSHELL}}
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
*number or NONE
| Default 'NONE'. The creature's normal body [[temperature]]. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby [[vermin]], randomly walking between places with food laying on the ground or in stockpiles, to check for possible [VERMIN_EATER] vermin, but they'll kill any other vermin too. Do not include this creature token on an intelligent entity that you intend to play as in fortress mode because it will prevent them from feeding themselves.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|IMMOBILE}}
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE; no breeding will happen).

|-
| {{text anchor|IMMOBILE_LAND}}
| Caste
|
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.

|-
| {{text anchor|IMMOLATE}}
| Caste
|
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
* number
| The [[quality]] of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|LAIR}}
| Caste
|
*type
*probability
| Found on megabeasts, semimegabeasts, and night creatures. The creature will seek out sites of this type and take them as lairs. The lair types are:
*SIMPLE_BURROW
*SIMPLE_MOUND
*WILDERNESS_LOCATION
*SHRINE
*LABYRINTH

|-
| {{text anchor|LAIR_CHARACTERISTIC}}
| Caste
|
*characteristic
*probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| {{text anchor|LAIR_HUNTER}}
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| {{text anchor|LAIR_HUNTER_SPEECH}}
| Caste
|
*speech file
| What this creature says while hunting adventurers in its lair.

|-
| {{text anchor|LARGE_PREDATOR}}
| Caste
|
| Will attack other creatures that are smaller than it. Tamed large predators will still attack wildlife. In [[fortress mode]], only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In [[adventurer mode]], large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."
A single biome supports 7 large predator species, picking randomly and rolling a d100 under its {{token|FREQUENCY|c}} to add it until all 7 slots are filled.

Incompatible with {{token|PACK_ANIMAL|c}} on a technicality, if included: hauled items are likely to be dropped upon entering the map (even if {{token|TRADE_CAPACITY|c}} is present) in contrast to when the merchants depart.

|-
| {{text anchor|LARGE_ROAMING}}
| Creature
|
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is unaffected by {{token|DEMON|c}}.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays [[egg]]s instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays the specified item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has ligaments in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.

|-
| {{text anchor|LIGHT_GEN}}
| Caste
|
| A vermin featuring this tag will remain visible to an adventurer even at night.

Subterranean vermin which feature this token will flicker in unexposed and unrevealed cavern layers while playing in Fortress Mode.

|-
| {{text anchor|LIKES_FIGHTING}}
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of {{token|LARGE_PREDATOR|c}}.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by [[Serpent man|serpent men]] and [[Reptile man|reptile men]] in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the number of offspring per one birth; default 1-3, not used in vanilla raws. See also {{token|MULTIPLE_LITTER_RARE|c}}.

|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
| Creature
|
| Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
| Creature
|
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open [[door]]s that are set to forbidden in fortress mode.

|-
| {{text anchor|LOOSE_CLUSTERS}}
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.

|-
| {{text anchor|LOW_LIGHT_VISION}}
| Caste
|
*number
| Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|MAGICAL}}
| Caste
|
| According to Toady One, this is completely interchangeable with {{token|AT_PEACE_WITH_WILDLIFE|c}} and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954]

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| The creature is able to see while submerged in [[magma]].

|-
| {{text anchor|MALE}}
| Caste
|
| Makes the creature biologically male. Usually declared inside a caste.

|-
| {{text anchor|MANNERISM|MANNERISM_*}}
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile. See [[creature mannerism token]] for further info.

|-
| {{text anchor|MATERIAL}}
| Creature
|
*material id
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.

|-
| {{text anchor|MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*[[Material token]]
*value A
*value B
| When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c}}, which can be used to make this sort of effect applicable to all materials.

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| When set, the creature will only appear at dawn (between 4:30 AM and 6:00 AM) in Adventurer mode.

|-
| {{text anchor|MAXAGE}}
| Caste
|
*min
*max
| Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact [[time|tick]]!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [http://i.imgur.com/A1A4aA9.png].
Creatures which lack this token are naturally immortal. The [[Syndrome#CE_ADD_TAG|NO_AGING]] syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creatures are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in fortress mode, they will have a pop-up message announcing their arrival. They will remain hostile to military even after being tamed.{{bug|10731}} See [[megabeast]] page for more details.

Requires specifying a {{token|BIOME|c}} in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical bosses and as wild animals.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|MENT_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Soul_attributes|mental attribute]]'s range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| {{text anchor|MENT_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Soul_attributes|Mental attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be [[milk]]ed in the [[farmer's workshop]]. The frequency is the amount of [[time|ticks]] the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on [[#CAN_LEARN|sentient]] creatures, regardless of [[ethics]].

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for {{token|MISCHIEVOUS|c}}.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| The creature spawns [[stealth]]ed and will attempt to path into the fortress, pulling any [[lever]]s it comes across. It will be invisible on the map and [[unit list]] until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by [[gremlin]]s in the vanilla game. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| {{text anchor|MODVALUE}}
| Caste
|
| Seemingly no longer used.

|-
| {{text anchor|MOUNT}}
| Caste
|
| Creature may be used as a [[mount]]. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.

|-
| {{text anchor|MOUNT_EXOTIC}}
| Caste
|
| Creature may be used as a [[mount]], but civilizations cannot domesticate it in worldgen without certain exceptions.

|-
| {{text anchor|MULTIPART_FULL_VISION}}
| Caste
|
| Allows the creature to have all-around vision, as long as it has multiple heads that can see.

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual. Requires {{token|FEMALE|c}}.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|NAME}}
| Creature
|
*singular
*plural
*adjective
| The generic name for any creature of this type - will be used for referring to the species in the abstract, such as the default material prefix. For labeling individual creatures, {{token|CASTE_NAME|c}} is necessary. If left undefined, the creature will be labeled as "nothing" by the game.

Some examples of adjective use:
* "super''dwarven'' strength"
* "the ''dwarven'' hillocks of X"
* Deity species as in "''feline'' deity"
* Megabeast attacks in worldgen. One with multiple dragons being a "''draconic'' rampage"

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. NATURAL animals will not engage creatures tagged with {{token|AT_PEACE_WITH_WILDLIFE|c}} in combat unless they are members of a hostile entity and vice-versa.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of {{token|NATURAL|c}}.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
|
*[[Skill_token|Skill token]]
*value
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.

|-
| {{text anchor|NIGHT_CREATURE}}
| Caste
|
| Creatures with this token can appear as [[experiment|experiments]].
Prevents {{token|LOCAL_POPS_PRODUCE_HEROES|c}} from functioning. Causes the creature to count as {{token|NOT_LIVING|c}}. Killing a creature featuring this token provides one point of "hero" reputation. Adds the creature's description as part of the initial summary of their historical figure in legends mode. Prevents creature behavior enabled by {{token|LARGE_PREDATOR|c}}. People will react to creatures with this token as a night creature (natch). In adventure mode, ambushes involving these units will say "Night creature!" instead of "Ambush!"

Prevents the AI from using ANIMATE interactions, unless the newly-animated{{token|OPPOSED_TO_LIFE|c}}undead will not attack them. The check for this is specifically whether the unit is:
*a ghost
*an animated unit
*a unit with the {{token|NO_AGING|c}} token added via {{token|CE_ADD_TAG|c}}. (This allows for the default exclusion of elves and goblins, unless raised as intelligent undead.)

''This token should not be confused with other NIGHT_CREATURE_X tokens.''
''This token is not well understood at the present time.''

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Creatures with this token can appear in [[bogeyman|bogeyman ambushes]] in [[adventure mode]], where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into [[smoke]] after a short while. Note that setting the "Number of Bogeyman Types" in [[advanced world generation]] to 0 will only remove randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
| Caste
|
| Found on some [[necromancer]]s. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an <code>[[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]]</code> tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into [[Infected_ghoul|ghouls]] and [[Experiment|other experimental creatures]], and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| Found on [[night troll]]s and [[werebeast]]s. Implies that the creature is a [[night creature]], and shows its description in [[legends mode]] entry. The creature is always hostile and will start [[no quarter]] combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in [[fortress mode]] except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a {{token|BIOME|c}} in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s. When paired with SPOUSE_CONVERTER, a very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
| Caste
|
| Found on [[nightmare]]s. Corpses and severed body parts derived from creatures with this token turn into [[smoke]] after a short while.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| The creature caste does not appear in [[Calendar|autumn]].

|-
| {{text anchor|NO_CONNECTIONS_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| {{text anchor|NO_DIZZINESS}}
| Caste
|
| Creature cannot become [[Symptom#Dizziness|dizzy]].

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to [[food|eat]].

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer [[Symptom#Fever|fevers]].

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| The creature is biologically sexless, making it unable to [[breeding|breed]].

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The creature cannot raise any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The creature cannot lose any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep, but can still be rendered unconscious by other means.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| The creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| The creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| The bodyparts of this creature don't need to be connected to an organ with the {{token|THOUGHT|body}} tag in order to have motor function. Generally used on creatures that don't have brains. If a creature doesn't have a thought part and doesn't have this token, it will be unable to grasp or stand. Nautilus men experience this issue in vanilla.

|-
| {{text anchor|NO_UNIT_TYPE_COLOR}}
| Caste
|
| Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).

|-
| {{text anchor|NO_VEGETATION_PERTURB}}
| Caste{{Verify}}
|
| Likely prevents the creature from leaving broken vegetation tracks.{{Verify}}

|-
| {{text anchor|NO_WINTER}}
| Caste
|
| The creature caste does not appear in [[Calendar|winter]].

|-
| {{text anchor|NOBONES}}
| Caste
|
| Creature has no bones.

|-
| {{text anchor|NOBREATHE}}
| Caste
|
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| When set, the creature will only appear at night (after 10:05 PM and before 4:30 AM) in Adventurer mode.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions, or moving at full speed for extended periods of time.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never flee from battle, and will be immune to [[ghost]]s' attempts to 'scare it to death'. Additionally, it causes [[bogeyman|bogeymen]] and [[nightmare]]s to become friendly towards the creature.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not be hunted or fed to wild beasts.

|-
| {{text anchor|NONAUSEA}}
| Caste
|
| Creature isn't nauseated by gut hits and cannot vomit.

|-
| {{text anchor|NOPAIN}}
| Caste
|
| Creature doesn't feel pain.

|-
| {{text anchor|NOSKIN}}
| Caste
|
| Creature will not drop a hide when [[butcher|butchered]].

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butchering, rot, or decay of severed head.

|-
| {{text anchor|NOSMELLYROT}}
| Caste
|
| Does not produce [[miasma]] when rotting.

|-
| {{text anchor|NOSTUCKINS}}
| Caste
|
| Weapons can't get stuck in the creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Corpses from this creature cannot be [[butcher|butchered]]. Does not prevent the creature from being slaughtered while alive, however.

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by [[vampire]]s, [[Mummy|mummies]] and inorganic creatures like the [[amethyst man]] and [[bronze colossus]]. Creatures who are {{token|OPPOSED_TO_LIFE|c}} (undead) will be docile towards creatures with this token.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a {{token|THOUGHT|body}} body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ODOR_LEVEL}}
| Caste
|
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).

|-
| {{text anchor|ODOR_STRING}}
| Caste
|
*string
| What the creature [[smell]]s like. If no odor string is defined, the creature name (not the caste name) is used.

|-
| {{text anchor|OPPOSED_TO_LIFE}}
| Caste
|
| Is hostile to all creatures except undead and other non-living ones and will show {{DFtext|Opposed to life|0:1}} in the [[unit list]]. Used by [[undead]] in the vanilla game. Functions without the {{token|NOT_LIVING|c}} token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.

|-
| {{text anchor|ORIENTATION}}
| Caste
|
*MALE/FEMALE
*disinterested chance
*casual chance
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.

|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}
| Caste
|
| Lets you play as an [[Adventurer_mode_character_creation#Outsider|outsider]] of this species in adventure mode.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|PACK_ANIMAL}}
| Caste
|
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures! May lead to the creature being domesticated during worldgen, even if it doesn't have {{token|COMMON_DOMESTIC|c}}.

Creatures with this tag but without {{token|BENIGN|c}}, and/or with {{token|LARGE_PREDATOR|c}} leads to hauled items being dropped.

|-
| {{text anchor|PARALYZEIMMUNE}}
| Caste
|
| The creature is immune to all [[Syndrome#CE_PARALYSIS|paralyzing]] special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.

|-
| {{text anchor|PCG_LAYERING}}
| Creature
|
*[[Procedural graphics layer|Layering type]]
| Adds a layer to the current {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} definition.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate [[pearl]]s. Does nothing in the current version.{{verify}}

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
|
*value
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.

|-
| {{text anchor|PERSONALITY}}
| Caste
|
*ATTRIBUTE
*lowest
*median
*highest
| Determines the range and chance of personality facets. Standard is 0:50:100. See [[personality facet]] for more info.

|-
| {{text anchor|PET}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. However, you can solve these problems using the popular plugin [https://dffd.bay12games.com/file.php?id=13095| Dwarf Therapist], which is completely unaffected by the tag.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?{{verify}} Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. ([[Gremlin|Example]]).

|-
| {{text anchor|PETVALUE}}
| Caste
|
*value
| How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.

|-
| {{text anchor|PETVALUE_DIVISOR}}
| Caste
|
*value
| Divides the creature's {{token|PETVALUE|c}} by the specified number. Used by [[honey bee]]s to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|PHYS_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Body_attributes|physical attribute]]'s range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| {{text anchor|PHYS_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Body_attributes|Physical attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| {{text anchor|PLUS_BP_GROUP}}
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after {{token|SELECT_MATERIAL|c}}.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
*number (max 100000)
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}. A weight of 0 will{{version|51.06 experimental}} prevent a caste from spawning naturally. Regardless of pop ratio, [[Position token|Position]]s that only allow a certain caste can force it to spawn.

|-
| {{text anchor|POPULATION_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region. Defaults to 1:1 if not specified.

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Not used by any creatures in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.).

|-
| {{text anchor|PREFSTRING}}
| Creature
|
*string
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.

|-
| {{text anchor|PROCEDURAL_CREATURE_GRAPHICS}}
| Creature
|
* [[Graphics_token#Basic_creature_sprite_types|Sprite type]] or Caste then sprite type
| Makes the creature have procedural graphics built for it, like forgotten beasts/demons/titans/experiments. Must be associated with PCG_LAYERING tokens.

|-
| {{text anchor|PROFESSION_NAME}}
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use {{token|CASTE_PROFESSION_NAME|c}} instead.

|-
| {{text anchor|PRONE_TO_RAGE}}
| Caste
|
*Chance
| Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes [[badger]]s so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| The creature has pus. Specifies the stuff secreted by [[Health_care#Infection|infected wounds]].
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|RELSIZE}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, dwarves have larger livers.

|-
| {{text anchor|REMAINS}}
| Caste
|
*singular
*plural
| What the creature's [[remains]] are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color the creature's [[remains]] are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with {{token|VERMIN_BITE|c}} and {{token|DIE_WHEN_VERMIN_BITE|c}}, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| {{text anchor|REMAINS_UNDETERMINED}}
| Caste
|
| Nothing.

|-
| {{text anchor|REMOVE_MATERIAL}}
| Creature
|
*material token
| Removes a material from the creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*tissue token
| Removes a tissue from the creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") retract verb text
*Third person ("The giant snail") retract verb text
*Second person cancel retract text
*Third person cancel retract text
| The creature will retract into the specified body part(s) when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part(s). When one of the specified body part is severed off, the creature automatically unretracts and cannot retract anymore. More than one body part can be selected by using BY_TYPE or BY_CATEGORY.

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy, specifically those that retract into their upper bodies: [[echidna]]s, [[hedgehog]]s and [[pangolin]]s.{{bug|11463}}{{bug|10519}} The upper body is prevented from collapsing by a separate body part (the middle spine), which cannot be attacked when the creature is retracted. See {{token|PREVENTS_PARENT_COLLAPSE|bo}}. Living creatures eventually succumb to blood loss, but undead creatures do not. Giant creatures also take a very long time to bleed out.
|-
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
| Creature
|
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") verb text
*Third person ("The hen") verb text
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SAVAGE}}
| Creature
|
| The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with {{token|GOOD|c}} or {{token|EVIL|c}}.

|-
| {{text anchor|SECRETION}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*BY_TOKEN / BY_CATEGORY / BY_TYPE
*<[[Body_token#BP|body part ID]]> / <[[Body_token#CATEGORY|category]]> or ALL / <type (e.g. [[Body_token#GRASP|GRASP]])>
*<[[Body_detail_plan_token#BP_LAYERS|tissue layer]]> or ALL
*<trigger>
| Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') [[contaminant]] is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
*'''CONTINUOUS'''
Secretion occurs once every 40 [[time|ticks]] in [[fortress mode]], and every tick in [[adventurer mode]].
*'''EXERTION'''
Secretion occurs continuously (at the rate described above) whilst the creature is at minimum {{Tile|Tired|6:1}} following physical exertion. Note that this cannot occur if the creature has {{token|NOEXERT|c}}.
*'''EXTREME_EMOTION'''
Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with {{token|NOEMOTION|c}}.

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*<caste>
| Adds an additional previously defined caste to the selection. Used after {{token|SELECT_CASTE|c}}.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*<caste> or ALL
| Selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*<[[material token]]>
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as {{token|MEGABEAST|c}}, but more of them are created during worldgen. See the [[semi-megabeast]] page for details.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* <[[Creature_token#CREATURE_CLASS|creature class]]>
* [[Tilesets|<tile value or character>]]
* [[Color#Color_values|<foreground color>:<background color>:<foreground brightness>]]
| Gives the creature the ability to sense creatures belonging to the specified [[Creature_token#CREATURE_CLASS|creature class]] even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of [[Wound#Blindness|blind]] units when fighting creatures they can sense. In [[adventure mode]], the specified tile will be used to represent sensed creatures when they cannot be seen directly.

|-
| {{text anchor|SET_BP_GROUP}}
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
|
*<[[skill_token]]>
*<percentage>
| The rate at which this creature learns this skill. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
|
*<percentage>
| The rate at which this creature learns all skills. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
|
*[[skill_token]]
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Like {{token|SKILL_RATES|c}}, but applies to individual skills instead. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATE}}
| Caste
|
*[[skill_token]]
*value
*value
*value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATES}}
| Caste
|
*value
*value
*value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SLAIN_CASTE_SPEECH}}
| Caste
|
*[[Speech file|text set]]
| Caste-specific {{token|SLAIN_SPEECH|c}}.

|-
| {{text anchor|SLAIN_SPEECH}}
| Creature
|
*[[Speech file|text set]]
| Boasting speeches relating to killing this creature. Examples include [[text_dwarf.txt/raw|text_dwarf.txt]] (<code>[SLAIN_SPEECH:SLAIN_DWARF]</code>) and text_elf.txt (<code>[SLAIN_SPEECH:SLAIN_ELF]</code>) in data\vanilla\vanilla_creatures\objects.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves "[[item token#REMAINS|remains]]" instead of a corpse. Used by [[vermin]].

|-
| {{text anchor|SMELL_TRIGGER}}
| Caste
|
*value
| Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.

|-
| {{text anchor|SOLDIER_ALTTILE}}
| Creature
|
*'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| {{text anchor|SOUND}}
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.
* First-person reads "You '''bark'''"
* Third-person reads "The [[capybara]] '''barks'''"
* Out of sight reads "You hear '''a loud bark'''"
with the text in bold being the description arguments of the token.

|-
| {{text anchor|SOURCE_HFID}}
| Creature
|
*Integer
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.

|-
| {{text anchor|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.

|-
| {{text anchor|SPHERE}}
| Creature
|
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the creature's name.

|-
| {{text anchor|SPOUSE_CONVERSION_TARGET}}
| Caste
|
| This creature can be converted by a night creature with {{token|SPOUSE_CONVERTER|c}}.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the {{token|NIGHT_CREATURE_HUNTER|c}} tag, it will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s and transform them into the caste of its species with the {{token|CONVERTED_SPOUSE|c}} tag during worldgen. It may also start families this way.

|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
| Caste
|
| If the creature rules over a [[site]], it will cause the local landscape to be corrupted into [[Surroundings#Evil|evil surroundings]] associated with the creature's [[Creature_token#SPHERE|sphere]]s. The creature must have at least one of the following [[sphere]]s for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get [[Plant_token#EVIL|evil plants]] and [[Creature_token#EVIL|evil animals]] sometimes. NIGHTMARES gets [[bogeyman|bogeymen]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8162224#msg8162224] Used by [[demon]]s in the vanilla game.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste
|
| Caste does not require <code>[[Body_token#GRASP|[GRASP]]]</code> body parts to climb -- it can climb with <code>[[Body_token#STANCE|[STANCE]]]</code> parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as {{token|GRAZER|c}} but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.

|-
| {{text anchor|STRANGE_MOODS}}
| Caste
|
| The creature will get [[strange mood]]s in fortress mode and can produce artifacts.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with <code>[[Interaction_token#IS_SECRET|[SUPERNATURAL_LEARNING_POSSIBLE]]]</code> that match its [[Creature_token#SPHERE|spheres]] and also prevents it from becoming a [[vampire]] or [[werebeast]]. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim perfectly and does not use the [[swimmer]] skill, as opposed to {{token|SWIMS_LEARNED|c}} below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature swims only as well as their present [[Swimmer|swimming skill]] allows them to.

|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
| Caste
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
| Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|TENDONS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has tendons in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's [[web]]s can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
|
*name
| Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.

|-
| {{text anchor|TISSUE_LAYER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| {{text anchor|TISSUE_LAYER_OVER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Alias for TISSUE_LAYER

|-
| {{text anchor|TISSUE_LAYER_UNDER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example, an [[iron man]] has a gaseous poison within, and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS, so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER; here is an example Tissue from the Iron Man: 
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
*number
| How much the creature can carry when used by merchants. 1000 by default. Completely ignored if the animal does not also have PACK_ANIMAL or WAGON, instead using BODY_SIZE^(2/3)/20, even if they're a pack animal due to ANIMAL_ALWAYS_PACK_ANIMAL.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for {{token|TRAINABLE_HUNTING|c}} + {{token|TRAINABLE_WAR|c}}.

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be [[Animal trainer|trained]] as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be [[Animal trainer|trained]] as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into [[martial trance]]s. Used by dwarves in the vanilla game.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature will never trigger [[trap]]s it steps on. Used by a [[Trapavoid|number of creatures]]. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
|
*min
*max
| A large swarm of vermin can be disturbed, usually in adventurer mode.

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the {{token|TISSUE_STYLE_UNIT|c}}, used in the description of the tissue layer's style.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|UBIQUITOUS}}
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags. Supersedes {{token|FREQUENCY|c}} for the purposes of distributing populations through the map, they are present in every part of the valid biome. Respects {{token|FREQUENCY|c}} for the frequency of unit [[Creature token#CLUSTER_NUMBER|cluster]] spawns being of this species.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth that the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. Values from 1-3 are the respective [[cavern]] levels, 4 is the [[magma sea]] and 5 is the [[HFS]]. A single argument may be used instead of min and max. [[Demon]]s use only 5:5; user-defined creatures with both this depth and {{token|FLIER}} will take part in the initial wave from the HFS alongside generated demons, but without {{token|FLIER}} they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| The creature is displayed as blue when in [[Water#Depth|7/7 water]]. Used on fish and amphibious creatures which swim under the water.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.

|-
| {{text anchor|USE_CASTE}}
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."
Roostre: "When DF detects duplicate tokens in the raws of the same object, a failsafe seems to kick in; it takes the bottom-most of the duplicates, and disregards the others. In the case of tokens added by a mod, it prioritizes the duplicate in the mod." This means that if a tag is defined in the base-caste and redefined in the derived caste, the derived tag overwrites the base tag.

|-
| {{text anchor|USE_MATERIAL}}
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| {{text anchor|USE_MATERIAL_TEMPLATE}}
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].

|-
| {{text anchor|USE_TISSUE}}
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| {{text anchor|USE_TISSUE_TEMPLATE}}
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| {{text anchor|UTTERANCES}}
| Creature
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|VEGETATION}}
| Caste
|
| Like {{token|AT_PEACE_WITH_WILDLIFE}}, but also makes the creature more valued in artwork by civilisations with the PLANT [[sphere]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954] Used by [[grimeling]]s in the vanilla game.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
* [[Material_definition_token#Material_States|material state]]
| Enables vermin to bite other creatures, injecting the specified material. See {{token|SPECIALATTACK_INJECT_EXTRACT|c}} for details about injection - this token presumably works in a similar manner.{{verify}}

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See {{token|PENETRATEPOWER|c}}. Distinct from {{token|VERMIN_ROTTER|c}}.

|-
| {{text anchor|VERMIN_FISH}}
| Creature
|
| The vermin appears in [[water]] and will attempt to swim around.

|-
| {{text anchor|VERMIN_GROUNDER}}
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| {{text anchor|VERMIN_HATEABLE}}
| Caste
|
| Some dwarves will [[Preferences|hate]] the creature and get unhappy thoughts when around it. See the [[Hateable|list of hateable vermin]] for details.

|-
| {{text anchor|VERMIN_MICRO}}
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).

|-
| {{text anchor|VERMIN_NOFISH}}
| Caste
|
| The creature cannot be caught by [[fishing]].

|-
| {{text anchor|VERMIN_NOROAM}}
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| {{text anchor|VERMIN_NOTRAP}}
| Caste
|
| The creature cannot be caught in baited [[animal trap]]s; however, a "[[Trapper|catch live land animal]]" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the {{token|ROOT_AROUND|c}} interaction such as [[goose|geese]] and [[chicken]]s. Dwarves will ignore the creature when given the "Capture live land animal" task.

|-
| {{text anchor|VERMIN_SOIL_COLONY}}
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| {{text anchor|VERMINHUNTER}}
| Caste
|
| Old shorthand for "does cat stuff". Contains {{token|AT_PEACE_WITH_WILDLIFE|c}} + {{token|RETURNS_VERMIN_KILLS_TO_OWNER|c}} + {{token|HUNTS_VERMIN|c}} + {{token|ADOPTS_OWNER|c}}.

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| When set, the creature will only appear in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.

|-
| {{text anchor|VIEWRANGE}}
| Caste
|
*value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.

|-
| {{text anchor|VISION_ARC}}
| Caste
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|WAGON_PULLER}}
| Caste
|
| Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.

|-
| {{text anchor|WEBBER}}
| Caste
|
* [[material token]]
| Allows the creature to create [[web]]s, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick [[web]]s. Used by creatures who can shoot thick webs (such as [[giant cave spider]]s) in order to make them immune to their own attacks.
|}

==Attack Tokens==

Attacks can use four different part selection criteria. Except for TISSUE_LAYER, the base game makes use of all of these in its attacks.

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Part type token
! width="30%" | Arguments
! width="60%" | Description

|-
| {{text anchor|BODYPART}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| This attack uses a particular body part; for example, ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP will make it use any part that can hold onto an object.

|-
| {{text anchor|TISSUE_LAYER}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| This attack uses a specific tissue layer on a specific body part; ATTACK:SCRATCH:TISSUE_LAYER:BY_TYPE:GRASP:BONE will make it use the bone of the hands.

|-
| {{text anchor|CHILD_BODYPART_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| Uses a body part that is subordinate to another; ATTACK:SLAP:CHILD_BODYPART_GROUP:BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm).

|-
| {{text anchor|CHILD_TISSUE_LAYER_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| As CHILD_BODYPART_GROUP, but specifying a tissue, too; ATTACK:BITE:CHILD_BODYPART_GROUP:BY_CATEGORY:HEAD:BY_CATEGORY:TOOTH

|}

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ATTACK_SKILL}}
| Caste
|
*[[Skill token]]
| Defines the skill used by the attack.

|-
| {{text anchor|ATTACK_VERB}}
| Caste
|
*2nd person
*3rd person
| Descriptive text for the attack.

|-
| {{text anchor|ATTACK_CONTACT_PERC}}
| Caste
|
*% value
| The contact area of the attack, measured in % of the body part's volume. Note that all attack percentages can be more than 100%.

|-
| {{text anchor|ATTACK_PENETRATION_PERC}}
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.

|-
| {{text anchor|ATTACK_PRIORITY}}
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| {{text anchor|ATTACK_VELOCITY_MODIFIER}}
| Caste
|
*number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| {{text anchor|ATTACK_FLAG_CANLATCH}}
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| {{text anchor|ATTACK_FLAG_WITH}}
| Caste
|
| Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".

|-
| {{text anchor|ATTACK_FLAG_EDGE}}
| Caste
|
| The attack is edged, with all the effects on physical resistance and contact area that it entails.

|-
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
| Caste
|
* Preparation time
* Recovery time
| Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.

|-
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack cannot be performed effectively.

|-
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*<min quantity>
*<max quantity>
| When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in [[temperature|thermal]] exchange within the creature - injecting something like molten [[iron]] (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also [[contaminant|splatters]] over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated [[syndrome]] with the [[Syndrome#SYN_INJECTED|[SYN_INJECTED]]] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [[Material definition token#ENTERS_BLOOD|[ENTERS_BLOOD]]] token, the attacked bodypart has no [[Tissue_definition_token#VASCULAR|[VASCULAR]]] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
|
*interaction
| When this attack lands successfully, a specified interaction will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well. If the attack would break skin, the interaction will occur '''before the attack actually lands'''.

|-
| {{text anchor|SPECIALATTACK_SUCK_BLOOD}}
| Caste
|
*min
*max
| Successful attack draws out an amount of blood randomized between the min and max value. Beware that this '''will''' trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.
|}

==Tissue Layer Tokens==
Tissue layers are added to a creature's body parts by the creature tokens [[#TISSUE_LAYER|TISSUE_LAYER]], [[#TISSUE_LAYER_OVER|TISSUE_LAYER_OVER]], [[#TISSUE_LAYER_UNDER|TISSUE_LAYER_UNDER]], and the body detail plan token [[#TL_LAYERS|TL_LAYERS]].

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. [[#TL_CONNECTS|TL_CONNECTS]] to [[tissue_definition_token#CONNECTS|CONNECTS]].

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SELECT_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Begins a selection of tissue layers.
[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds tissue layers to those selected.

|-
| {{text anchor|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
*TISSUE
| Sets a selected tissue layer to be made of a different tissue.

|-
| {{text anchor|SHEARABLE_TISSUE_LAYER}}
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (for example, a [[llama]]'s wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|TISSUE_LAYER_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| {{text anchor|TISSUE_STYLE_UNIT}}
| Caste
|
*tissue style unit ID
*shaping
| Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
|
*COLOR
*freq
*COLOR
*freq etc.
| Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".

|-
| {{text anchor|TLCM_GENETIC_MODEL}}
| Caste
|
| The way the color modifier is passed on to offspring. May or may not work right now.{{verify}}

|-
| {{text anchor|TLCM_IMPORTANCE}}
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| {{text anchor|TLCM_NOUN}}
| Caste
|
*name
*SINGULAR or PLURAL
| Names the tissue layer color modifier, and determines the noun. Also used by [[Utility:Stonesense|Stonesense]] for colouring body parts.

|-
| {{text anchor|TLCM_TIMING}}
| Caste
|
*ROOT
*start change window years
*days
*end change window years
*days
| Determines the point in the creature's life when the color change begins and ends.

|-
| {{text anchor|TL_CONNECTS}}
| Caste
|
| Gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
*value
| Changes the HEALING_RATE of the selected tissue layers.

|-
| {{text anchor|TL_MAJOR_ARTERIES}}
| Caste
|
| Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.

|-
| {{text anchor|TL_PAIN_RECEPTORS}}
| Caste
|
*value
| Changes the number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
*value
| Changes the relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
*value
| Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

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

Body detail plan token

2025-03-12T20:13:33Z

Qeveren: /* Tokens */

{{Quality|Superior}}
{{av}}
{{Modding}}

{{clear}}

==Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|BODY_DETAIL_PLAN}}
|
* identifier
| Create a new body detail plan with the specified identifier. The rest of the tokens in this table are then used to define this body detail plan's properties.

|-
| {{text anchor|ADD_MATERIAL}}
|
* identifier
* material template
| Adds a new material to the creature based on the specified template and assigned to the specified identifier.

|-
| {{text anchor|ADD_TISSUE}}
|
* identifier
* tissue template
| Adds a new tissue to the creature based on the specified template and assigned to the specified identifier.

|-
| {{text anchor|BP_LAYERS}}
|
*[[Body token#CATEGORY|BY_CATEGORY]] or [[Body token#CONTYPE|BY_TYPE]] or [[Body token#BP|BY_TOKEN]]
*body part
*tissue name or tissue ARG# for innermost tissue
*tissue thickness
*tissue name or tissue ARG# for second innermost tissue
*tissue thickness
*tissue name or tissue ARG# for third innermost tissue
*tissue thickness
etc...
| Defines a series of tissue layers. Alternatively to specifying a tissue, variable arguments can be entered (numbered arbitrarily to a max of 5) to be filled with tissues when the plan is called in the creature entry. The SELECT_TISSUE creature token with TL_RELATIVE_THICKNESS can change tissue thickness, but tissue ''layering'' is hard to do without a new detail plan.

|-
| {{text anchor|BP_LAYERS_OVER}}
|
| Works like BP_LAYERS, but defines layers over existing layers.

|-
| {{text anchor|BP_LAYERS_UNDER}}
|
| Works like BP_LAYERS, but defines layers under existing layers.

|-
| {{text anchor|BP_POSITION}}
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part
*position token
| Defines a position for the specified body part relative to its parent part (the nose is assigned the position FRONT, as it's on the front of the face). This has some effects on combat, attacks and the like. Valid position tokens are FRONT, BACK, LEFT, RIGHT, TOP and BOTTOM. The position token SIDES is of unverified validity.

|-
| {{text anchor|BP_RELATION}}
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part to be affected
*relation token
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*parent body part
*coverage
| Defines a positional relationship between one body part and another (the right eyelid is AROUND the right eye with coverage 50, as it only partially covers the eye). This has some effects on combat, attacks and the like. Valid relation tokens are AROUND, SURROUNDED_BY, ABOVE, BELOW, IN_FRONT, BEHIND, CLEANS, and CLEANED_BY. The lattermost two tokens are used when specifying parts that clean each other (such as eyelids to eyes).

|-
| {{text anchor|BP_RELSIZE}}
|
*BY_CATEGORY (or, presumably, BY_TYPE or BY_TOKEN)
*body part
*relsize
| Defines a relsize for the selected body part for the current body detail plan
|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Body detail plan token]]

Body detail plan token

2025-03-12T20:10:44Z

Qeveren: /* Tokens */ Linked BY_CATEGORY, BY_TYPE, BY_TOKEN to body token entries for clarity

{{Quality|Superior}}
{{av}}
{{Modding}}

{{clear}}

==Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|BODY_DETAIL_PLAN}}
|
* identifier
| Create a new body detail plan with the specified identifier. The rest of the tokens in this table are then used to define this body detail plan's properties.

|-
| {{text anchor|ADD_MATERIAL}}
|
* identifier
* material template
| Adds a new material to the creature based on the specified template and assigned to the specified identifier.

|-
| {{text anchor|ADD_TISSUE}}
|
* identifier
* tissue template
| Adds a new tissue to the creature based on the specified template and assigned to the specified identifier.

|-
| {{text anchor|BP_LAYERS}}
|
*[[Body token#CATEGORY|BY_CATEGORY]] or [[Body token#CONTYPE|BY_TYPE]] or [[Body token#BP|BY_TOKEN]] (ID of a specific body part)
*body part
*tissue name or tissue ARG# for innermost tissue
*tissue thickness
*tissue name or tissue ARG# for second innermost tissue
*tissue thickness
*tissue name or tissue ARG# for third innermost tissue
*tissue thickness
etc...
| Defines a series of tissue layers. Alternatively to specifying a tissue, variable arguments can be entered (numbered arbitrarily to a max of 5) to be filled with tissues when the plan is called in the creature entry. The SELECT_TISSUE creature token with TL_RELATIVE_THICKNESS can change tissue thickness, but tissue ''layering'' is hard to do without a new detail plan.

|-
| {{text anchor|BP_LAYERS_OVER}}
|
| Works like BP_LAYERS, but defines layers over existing layers.

|-
| {{text anchor|BP_LAYERS_UNDER}}
|
| Works like BP_LAYERS, but defines layers under existing layers.

|-
| {{text anchor|BP_POSITION}}
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part
*position token
| Defines a position for the specified body part relative to its parent part (the nose is assigned the position FRONT, as it's on the front of the face). This has some effects on combat, attacks and the like. Valid position tokens are FRONT, BACK, LEFT, RIGHT, TOP and BOTTOM. The position token SIDES is of unverified validity.

|-
| {{text anchor|BP_RELATION}}
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part to be affected
*relation token
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*parent body part
*coverage
| Defines a positional relationship between one body part and another (the right eyelid is AROUND the right eye with coverage 50, as it only partially covers the eye). This has some effects on combat, attacks and the like. Valid relation tokens are AROUND, SURROUNDED_BY, ABOVE, BELOW, IN_FRONT, BEHIND, CLEANS, and CLEANED_BY. The lattermost two tokens are used when specifying parts that clean each other (such as eyelids to eyes).

|-
| {{text anchor|BP_RELSIZE}}
|
*BY_CATEGORY (or, presumably, BY_TYPE or BY_TOKEN)
*body part
*relsize
| Defines a relsize for the selected body part for the current body detail plan
|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Body detail plan token]]

Building

2025-01-07T17:48:48Z

Qeveren: /* Notes */

{{Quality|Superior|02:57, 9 April 2023 (CST)}}
{{av}}

[[File:Building menu v50.png|right|thumb|500px|The building menu, now with a mouse interface!]]

The '''Building menu''' can be accessed from the main menu by pressing the {{Menu icon|b}} key. This allows your dwarves to build anything listed within the menu, provided you have access to the proper materials. This list also contains several sub-menus which expand to show further building options.

Any item within this list, once built, can then be interacted with by clicking on it. All buildings can be disassembled into their original parts and removed by clicking on them, then clicking on the button near the top-right of the pop-up that shows a house that is crossed out. The same pop-up window gives you all of the building's details, and allows you to look at the items currently stored within an individual building as well as which items were used to construct that particular building.

The exception to this rule are items located under the {{Menu icon|b|n|sep=-}} Constructions sub-menu. These items are considered [[Construction|constructions]], and as such, have no interactions available. These items are removed using the {{Menu icon|m|x|sep=-}} Remove Construction option in the mining menu. For more detail on how buildings and constructions interact, please see the [[Construction]] article.

Graphically, each building's color palette will match that of the material used to construct the building. For example, a workshop made of [[copper]] will appear as a reddish-brown, a kiln made from [[adamantine]] will appear as light blue, etc.
==List of buildings==
{| class = "wikitable sortable"
!Building !!Hotkey
|-style="background-color:darkgray"
|[[Workshop]]s
|{{Menu icon|b|o|sep=-}}
|--style="background-color:lightgray"
|Clothing and leather
|{{Menu icon|b|o|l|sep=-}}
|-
|[[leather works|Leather]]
|{{Menu icon|b|o|l|l|sep=-}}
|-
|[[Loom]]
|{{Menu icon|b|o|l|o|sep=-}}
|-
|[[Clothier's shop|Clothes]]
|{{Menu icon|b|o|l|k|sep=-}}
|-
|[[Dyer's shop|Dyer]]
|{{Menu icon|b|o|l|y|sep=-}}
|-style="background-color:lightgray"
|[[Farming]]
|{{Menu icon|b|o|f|sep=-}}
|-
|[[Farm plot]]
|{{Menu icon|b|o|f|p|sep=-}}
|-
|[[Still]]
|{{Menu icon|b|o|f|l|sep=-}}
|-
|[[Butcher's shop|Butcher]]
|{{Menu icon|b|o|f|b|sep=-}}
|-
|[[Tanner's shop|Tanner]]
|{{Menu icon|b|o|f|t|sep=-}}
|-
|[[Fishery]]
|{{Menu icon|b|o|f|y|sep=-}}
|-
|[[Kitchen]]
|{{Menu icon|b|o|f|k|sep=-}}
|-
|[[Farmer's workshop|Farmer]]
|{{Menu icon|b|o|f|f|sep=-}}
|-
|[[Quern]]
|{{Menu icon|b|o|f|q|sep=-}}
|-
|[[Vermin catcher's shop|Vermin Catcher's Shop]]
|{{Menu icon|b|o|f|v|sep=-}}
|-
|[[Nest box]]
|{{Menu icon|b|o|f|n|sep=-}}
|-
|[[Hive]]
|{{Menu icon|b|o|f|h|sep=-}}
|-style="background-color:lightgray"
|[[Furnace]]s
|{{Menu icon|b|o|u|sep=-}}
|-
|[[Glass furnace]]
|{{Menu icon|b|o|u|g|sep=-}}
|-
|[[Kiln]]
|{{Menu icon|b|o|u|k|sep=-}}
|-
|[[Magma glass furnace]]
|{{Menu icon|b|o|u|G|sep=-}}
|-
|[[Magma kiln]]
|{{Menu icon|b|o|u|K|sep=-}}
|-
|[[Magma smelter]]
|{{Menu icon|b|o|u|L|sep=-}}
|-
|[[Smelter]]
|{{Menu icon|b|o|u|l|sep=-}}
|-
|[[Wood furnace]]
|{{Menu icon|b|o|u|f|sep=-}}
|-
|[[Ashery]]
|{{Menu icon|b|o|y|sep=-}}
|-
|[[Bowyer's workshop|Bowyer]]
|{{Menu icon|b|o|b|sep=-}}
|-
|[[Carpenter's workshop|Carpenter]]
|{{Menu icon|b|o|p|sep=-}}
|-
|[[Craftsdwarf's workshop|Crafts]]
|{{Menu icon|b|o|r|sep=-}}
|-
|[[Jeweler's workshop|Jeweler]]
|{{Menu icon|b|o|j|sep=-}}
|-
|[[Magma Forge]]
|{{Menu icon|b|o|I|sep=-}}
|-
|[[Mechanic's workshop|Mechanic]]
|{{Menu icon|b|o|h|sep=-}}
|-
|[[Metalsmith's forge|Metalsmith]]
|{{Menu icon|b|o|i|sep=-}}
|-
|[[Screw press]]
|{{Menu icon|b|o|R|sep=-}}
|-
|[[Siege workshop|Siege]]
|{{Menu icon|b|o|g|sep=-}}
|-
|[[Soap maker's workshop|Soap Maker's Workshop]]
|{{Menu icon|b|o|P|sep=-}}
|-
|[[Stoneworker's workshop|Stoneworker]]
|{{Menu icon|b|o|t|sep=-}}
|-style="background-color:darkgray"
|[[Furniture]]
|{{Menu icon|b|f|sep=-}}
|-
|[[Bed]]
|{{Menu icon|b|f|b|sep=-}}
|-
|[[Chair]]
|{{Menu icon|b|f|r|sep=-}}
|-
|[[Table]]
|{{Menu icon|b|f|t|sep=-}}
|-
|[[Chest]]
|{{Menu icon|b|f|h|sep=-}}
|-
|[[Cabinet]]
|{{Menu icon|b|f|n|sep=-}}
|-
|[[Coffin|Burial]]
|{{Menu icon|b|f|x|sep=-}}
|-
|[[Slab]]
|{{Menu icon|b|f|l|sep=-}}
|-
|[[Statue]]
|{{Menu icon|b|f|u|sep=-}}
|-
|[[Traction bench]]
|{{Menu icon|b|f|T|sep=-}}
|-
|[[Bookcase]]
|{{Menu icon|b|f|o|sep=-}}
|-
|[[Display case|Display]]
|{{Menu icon|b|f|y|sep=-}}
|-
|[[Altar|Offering place]]
|{{Menu icon|b|f|p|sep=-}}
|-
|[[Instruments]]
|{{Menu icon|b|f|i|sep=-}}
|-style="background-color:darkgray"
|Doors/hatches
|{{Menu icon|b|p|sep=-}}
|-
|[[Door]]
|{{Menu icon|b|p|r|sep=-}}
|-
|[[Floor hatch]]
|{{Menu icon|b|p|h|sep=-}}
|-style="background-color:darkgray"
|[[Constructions]]
|{{Menu icon|b|n|sep=-}}
|-
|[[Wall]]
|{{Menu icon|b|n|l|sep=-}}
|-
|[[Floor]]
|{{Menu icon|b|n|f|sep=-}}
|-
|[[Ramp]]
|{{Menu icon|b|n|r|sep=-}}
|-
|[[Stair]]s
|{{Menu icon|b|n|t|sep=-}}
|-
|[[Bridge]]
|{{Menu icon|b|n|b|sep=-}}
|-
|[[Paved road]]
|{{Menu icon|b|n|o|sep=-}}
|-
|[[Dirt road]]
|{{Menu icon|b|n|O|sep=-}}
|-
|[[Fortification]]
|{{Menu icon|b|n|F|sep=-}}
|-
|[[Wall grate]]
|{{Menu icon|b|n|G|sep=-}}
|-
|[[Floor grate]]
|{{Menu icon|b|n|g|sep=-}}
|-
|[[Vertical bars]]
|{{Menu icon|b|n|M|sep=-}}
|-
|[[Floor bars]]
|{{Menu icon|b|n|m|sep=-}}
|-
|[[Glass window]]
|{{Menu icon|b|n|y|sep=-}}
|-
|[[Gem window]]
|{{Menu icon|b|n|Y|sep=-}}
|-
|[[Support]]
|{{Menu icon|b|n|p|sep=-}}
|-
|[[Track]]
|{{Menu icon|b|n|k|sep=-}}
|-
|[[Minecart#Track_Stops|Track stop]]
|{{Menu icon|b|n|K|sep=-}}
|-style="background-color:darkgray"
|[[Machine component|Machine]]s and [[Fluid]]s
|{{Menu icon|b|m|sep=-}}
|-
|[[Lever]]
|{{Menu icon|b|m|l|sep=-}}
|-
|[[Well]]
|{{Menu icon|b|m|L|sep=-}}
|-
|[[Floodgate]]
|{{Menu icon|b|m|f|sep=-}}
|-
|[[Screw pump]]
|{{Menu icon|b|m|p|sep=-}}
|-
|[[Water wheel]]
|{{Menu icon|b|m|h|sep=-}}
|-
|[[Windmill]]
|{{Menu icon|b|m|m|sep=-}}
|-
|[[Gear assembly]]
|{{Menu icon|b|m|g|sep=-}}
|-
|[[Horizontal Axle]]
|{{Menu icon|b|m|a|sep=-}}
|-
|[[Vertical axle]]
|{{Menu icon|b|m|A|sep=-}}
|-
|[[Millstone]]
|{{Menu icon|b|m|n|sep=-}}
|-
|[[Roller]]s
|{{Menu icon|b|m|r|sep=-}}
|-style="background-color:darkgray"
|Cages/restraints
|{{Menu icon|b|r|sep=-}}
|-
|[[Restraint|Rope/chain]]
|{{Menu icon|b|r|h|sep=-}}
|-
|[[Cage]]
|{{Menu icon|b|r|g|sep=-}}
|-
|[[Animal trap]]
|{{Menu icon|b|r|t|sep=-}}
|-style="background-color:darkgray"
|[[Trap]]s
|{{Menu icon|b|t|sep=-}}
|-
|[[Pressure plate]]
|{{Menu icon|b|t|p|sep=-}}
|-
|[[Stone-fall trap|Stone-fall]]
|{{Menu icon|b|t|t|sep=-}}
|-
|[[Weapon trap|Weapon]]
|{{Menu icon|b|t|o|sep=-}}
|-
|[[Cage trap|Cage]]
|{{Menu icon|b|t|g|sep=-}}
|-
|[[Trap#Upright spear/spike|Upright weapon/spike]]
|{{Menu icon|b|t|u|sep=-}}
|-style="background-color:darkgray"
|[[Military]]
|{{Menu icon|b|y|sep=-}}
|-
|[[Archery target]]
|{{Menu icon|b|y|t|sep=-}}
|-
|[[Weapon rack]]
|{{Menu icon|b|y|r|sep=-}}
|-
|[[Armor stand]]
|{{Menu icon|b|y|n|sep=-}}
|-
|[[Siege engine|Ballista]]
|{{Menu icon|b|y|b|sep=-}}
|-
|[[Siege engine|Catapult]]
|{{Menu icon|b|y|p|sep=-}}
|-
|[[Trade depot]]
|{{Menu icon|b|T|sep=-}}
|}

==Notes==
* When a building gets designated for construction, the items designated to be used in the construction will be reserved for that building, meaning that other dwarves will not haul or use that specific item for something else.
* A [[Stockpile]] is considered a building for the purposes of construction. A stockpile must be removed or repainted to allow the construction of things such as floors, stairs, and workshops.

==See Also==
*[[Building token]]
{{Category|Interface}}
{{Category|Buildings| }}
[[ru:Building]]

Creature token

2023-09-27T18:49:38Z

Qeveren: /* G */ GO_TO_TAG inserts before indicated tag

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

The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.

The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)

__NOTOC__
{{clear}}
{{alphabetical TOC|style=margin: 1em auto;}}

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Makes the creature need [[alcohol]] to get through the working day; it will choose to drink booze instead of [[water]] if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| Sets the creature to be active during the day, night, and twilight in Adventurer Mode. Seems to be a separate value from {{token|DIURNAL|c}}/{{token|NOCTURNAL|c}}/{{token|CREPUSCULAR|c}}, rather than implying them.{{verify|code}}

|-
| {{text anchor|ALTTILE}}
| Creature
|
*'character' or tile number
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Found on {{token|LARGE_PREDATOR|c}}s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures. {{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Appearance Modifier
|
*Range (6 values, low to high)
| Based on info from [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Wannabehero on the forums]: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.

The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range.

|-
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Appearance Modifier
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| {{text anchor|APP_MOD_IMPORTANCE}}
| Appearance Modifier
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| {{text anchor|APP_MOD_NOUN}}
| Appearance Modifier
|
*noun
*SINGULAR or PLURAL
| Creates a noun for the appearance, and whether it is singular or plural.

|-
| {{text anchor|APP_MOD_RATE}}
| Appearance Modifier
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min (growth)
*max (growth)
*start year
*start day
*end year
*end day
| Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| {{text anchor|APPLY_CREATURE_VARIATION}}
| Caste
|
*creature variation ID
*(optional) any amount of arbitrary arguments
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.

|-
| {{text anchor|APPLY_CURRENT_CREATURE_VARIATION}}
| Special
|
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Enables the creature to breathe in water, but causes it to air-drown on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list. Typically applied to spoileriffic creatures.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.

|-
| {{text anchor|ATTACK}}
| Caste
|
*token
*selection criteria (it's complicated)
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:''' 
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code> 
''GORE'' = name of the attack 
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
|
*population
*exported wealth
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occurring when at least one of the requirements is met. Setting a value to 0 disables the trigger.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|BABY}}
| Caste
|
*integer
| Age at which creature is considered a child, the default is zero. One can think of this as the duration of the baby stage.

|-
| {{text anchor|BABYNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
|
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.

|-
| {{text anchor|BIOME}}
| Creature
|
* [[biome token]]
| Select a [[biome]] the creature may appear in.

|-
| {{text anchor|BLOOD}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|thirst for blood]] grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) as a creature of the night.

|-
| {{text anchor|BODY}}
| Caste
|
*body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.

'''If the body is left undefined, the creature (or caste) will be tagged as [DOES_NOT_EXIST].''' {{verify}}

|-
| {{text anchor|BODY_APPEARANCE_MODIFIER}}
| Caste
|
*ATTRIBUTE
*lowest
*lower
*low
*median
*high
*higher
*highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| {{text anchor|BODY_DETAIL_PLAN}}
| Caste
|
*PlanName
*Arguments
| Loads a plan from listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| {{text anchor|BODY_SIZE}}
| Caste
|
*years
*days
*size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials, is roughly equal to the creature's average weight in grams.
'''Example:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it would be 220,000 cm3 and weigh roughly 220 kg.

|-
| {{text anchor|BODYGLOSS}}
| Caste
|
*gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| {{text anchor|BONECARN}}
| Caste
|
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].

|-
| {{text anchor|BP_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| {{text anchor|BP_REMOVE_TYPE}}
| Caste
|
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|BUILDINGDESTROYER}}
| Caste
|
*1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the {{k|b}} + {{k|C}} commands.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|CAN_DO_INTERACTION}}
| Caste
|
*interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| {{text anchor|CAN_LEARN}}
| Caste
|
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten by an adventurer, so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. Skills allocated will disappear on start.

|-
| {{text anchor|CAN_SPEAK}}
| Caste
|
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills.

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste
|
| Creature cannot [[climber|climb]], even if it has free grasp parts.

|-
| {{text anchor|CANNOT_JUMP}}
| Caste
|
| Creature cannot [[jump]].

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}}

|-
| {{text anchor|CARNIVORE}}
| Caste
|
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills. Does not seem to affect the diet of the adventurer in adventure mode.

|-
| {{text anchor|CASTE}}
| Creature
|
*name
| Defines a [[caste]].

|-
| {{text anchor|CASTE_ALTTILE}}
| Caste
|
*tile number or "letter"
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.

|-
| {{text anchor|CASTE_COLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|COLOR|c}}.

|-
| {{text anchor|CASTE_GLOWCOLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|GLOWCOLOR|c}}.

|-
| {{text anchor|CASTE_GLOWTILE}}
| Caste
|
*tile value or "letter"
| Caste-specific {{token|GLOWTILE|c}}.

|-
| {{text anchor|CASTE_NAME}}
| Caste
|
*singular
*plural
*adjective
| Caste-specific {{token|NAME|c}}.

|-
| {{text anchor|CASTE_PROFESSION_NAME}}
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| Caste-specific {{token|PROFESSION_NAME|c}}.

|-
| {{text anchor|CASTE_SOLDIER_ALTTILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SOLDIER_TILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_TILE}}
| Caste
|
* tile number or "letter"
| Caste-specific {{token|CREATURE_TILE|c}}.

|-
| {{text anchor|CAVE_ADAPT}}
| Caste
|
| Gives the creature a bonus in caves. Also causes [[cave adaptation]].

|-
| {{text anchor|CDI}}
| Caste
|
*Varies
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].

|-
| {{text anchor|CHANGE_BODY_SIZE_PERC}}
| Caste
|
*integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| {{text anchor|CHANGE_FREQUENCY_PERC}}
| Creature
|
*integer
| Multiplies frequency by a factor of (integer)%.

|-
| {{text anchor|CHILD}}
| Caste
|
*integer
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.

|-
| {{text anchor|CHILDNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.

|-
| {{text anchor|CLUSTER_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of [[egg]]s laid in one sitting.

|-
| {{text anchor|COLONY_EXTERNAL}}
| Caste
|
| Caste hovers around colony.

|-
| {{text anchor|COLOR}}
| Creature
|
*foreground
*background
*brightness
| Color of the creature's tile. See [[Color]] for usage.

|-
| {{text anchor|COMMON_DOMESTIC}}
| Caste
|
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}}, {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| {{text anchor|COOKABLE_LIVE}}
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered/cleaned. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*creature ID
| Copies another specified creature. This will override any definitions made before it; essentially, it makes this creature identical to the other one, which can then be modified. Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. The vanilla [[giant animal]]s and [[animal person|animal people]]s are examples of this token combination.

|-
| {{text anchor|CREATURE}}
| Creature
|
*creature ID
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for {{token|GOBBLE_VERMIN_CLASS|c}}), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

* Creature tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
|-
| {{text anchor|CREATURE_SOLDIER_TILE}}
| Creature
|
*'character' or tile number
| Creatures active in their civilization's [[military]] will use this tile instead.

|-
| {{text anchor|CREATURE_TILE}}
| Creature
|
*'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| {{text anchor|CREPUSCULAR}}
| Caste
|
| Sets the creature to be active at twilight in adventurer mode.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to [[Steals food|steal and eat edible items]] from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) [[Steals drink|drink your alcohol]]. Or spill the barrel to the ground. Also affects undead versions of the creature. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.

|-
| {{text anchor|CV_ADD_TAG}}
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| {{text anchor|CV_REMOVE_TAG}}
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|DEMON}}
| Caste
|
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.

|-
| {{text anchor|DESCRIPTION}}
| Caste
|
*text
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.

|-
| {{text anchor|DIFFICULTY}}
| Caste
|
*integer
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| Sets the creature to be active during the day in Adventurer Mode.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s will lead to worlds being generated without dogs in them. Also removes the creature from the [[object testing arena]]'s spawn list. If combined with {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|EBO_ITEM}}
| Caste
|
*[[item token]]
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
|
*gem shape
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|Egg-laying]] creatures in the default game define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| {{text anchor|EGG_SIZE}}
| Caste
|
*size
| Determines the size of laid [[egg]]s. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature appear as a large 3x3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat. Invisible creatures will also be seen, namely [[intelligent undead]] using a "vanish" power.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|FANCIFUL}}
| Creature
|
| The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.

|-
| {{text anchor|FEMALE}}
| Caste
|
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|FIREJET]] attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in [[fire]], and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|FISH]] item) at a [[fishery]] to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|fished]] vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

|-
| {{text anchor|FIXED_TEMP}}
| Caste
|
*temperature
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from.

Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| If engaged in combat, the creature will flee at the first sign of resistance. Used by [[kobold]]s in the vanilla game.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own [[Body_token#FLIER|FLIER]] token).

|-
| {{text anchor|FREQUENCY}}
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|GAIT}}
| Caste
|
* <gait type>
* <gait name>
* <max [[Gait#Speed|speed]]>
* <build up time>
* <max turning [[Gait#Speed|speed]]>
* <start [[Gait#Speed|speed]]>
* <energy expenditure>
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information. Specifically, you likely want to use one of the existing STANDARD_X_GAITS creature variations, as described in [[Gait#Gaits_and_Modding|this subsection]].

* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
* <start speed> indicates the creature's speed when it starts moving using this gait
* <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 [[tile]]s in a straight line over even terrain.
* <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
* <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and [[Status_icon#Non-flashing|collapse]].

'''NO_BUILD_UP''' can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are '''both''' omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.

'''valid gait types:'''
*'''WALK''' 
Used for moving normally over ground tiles.

*'''CRAWL''' 
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].

*'''SWIM''' 
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.

*'''FLY''' 
Used for moving through [[open space]].

*'''CLIMB''' 
Used for moving whilst [[Climber|climbing]].

'''valid gait flags:'''
* '''AGILITY''' 
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.

* '''STRENGTH''' 
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.

* '''LAYERS_SLOW''' 
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|THICKENS_ON_STRENGTH]] tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

* '''STEALTH_SLOWS:'''<percentage> 
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
|
*singular
*plural
| Like {{token|BABYNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
|
*singular
*plural
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*value A
*value B
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's {{token|GLOWTILE|c}}.

|-
| {{text anchor|GLOWTILE}}
| Creature
|
*ascii character
| If present, the being glows in the dark (generally used for Adventurer Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use {{token|CASTE_GLOWTILE|c}} instead.

|-
| {{text anchor|GNAWER}}
| Caste
|
*verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made (normally wood).

|-
| {{text anchor|GOBBLE_VERMIN_CLASS}}
| Caste
|
*class
| The creature eats vermin of the specified class.

|-
| {{text anchor|GOBBLE_VERMIN_CREATURE}}
| Caste
|
*creature
*caste
| The creature eats a specified [[vermin]].

|-
| {{text anchor|GO_TO_END}}
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| {{text anchor|GO_TO_START}}
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| {{text anchor|GO_TO_TAG}}
| Special
|
| When using tags from an existing creature, inserts new tags ''before'' the specified tag.

|-
| {{text anchor|GOOD}}
| Creature
|
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.

|-
| {{text anchor|GRASSTRAMPLE}}
| Caste
|
*value
| The value determines how rapidly [[grass]] is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| {{text anchor|GRAVITATE_BODY_SIZE}}
| Caste
|
*target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| {{text anchor|GRAZER}}
| Caste
|
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|HABIT}}
| Caste
|
*type
*probability
| Defines certain behaviors for the creature. The habit types are:
*COLLECT_TROPHIES
*COOK_PEOPLE
*COOK_VERMIN
*GRIND_VERMIN
*COOK_BLOOD
*GRIND_BONE_MEAL
*EAT_BONE_PORRIDGE
*USE_ANY_MELEE_WEAPON
*GIANT_NEST
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.

|-
| {{text anchor|HABIT_NUM}}
| Caste
|
*number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".{{cite forum|60554/1719248}} All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| {{text anchor|HAS_NERVES}}
| Caste
|
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.

|-
| {{text anchor|HASSHELL}}
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
*number or NONE
| Default 'NONE'. The creature's normal body [[temperature]]. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby [[vermin]].

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|IMMOBILE}}
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE no breeding will happen).

|-
| {{text anchor|IMMOBILE_LAND}}
| Caste
|
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.

|-
| {{text anchor|IMMOLATE}}
| Caste
|
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
* number
| The [[quality]] of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|LAIR}}
| Caste
|
*type
*probability
| Found on megabeasts, semimegabeasts, and night creatures. The creature will seek out sites of this type and take them as lairs. The lair types are:
*SIMPLE_BURROW
*SIMPLE_MOUND
*WILDERNESS_LOCATION
*SHRINE
*LABYRINTH

|-
| {{text anchor|LAIR_CHARACTERISTIC}}
| Caste
|
*characteristic
*probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| {{text anchor|LAIR_HUNTER}}
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| {{text anchor|LAIR_HUNTER_SPEECH}}
| Caste
|
*speech file
| What this creature says while hunting adventurers in its lair.

|-
| {{text anchor|LARGE_PREDATOR}}
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| {{text anchor|LARGE_ROAMING}}
| Creature
|
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is unaffected by {{token|DEMON|c}}.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays [[egg]]s instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays the specified item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has ligaments in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.

|-
| {{text anchor|LIGHT_GEN}}
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| {{text anchor|LIKES_FIGHTING}}
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of {{token|LARGE_PREDATOR|c}}.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by [[Serpent man|serpent men]] and [[Reptile man|reptile men]] in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the number of offspring per one birth.

|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
| Creature
|
| Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
|
|
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open [[door]]s that are set to forbidden in fortress mode.

|-
| {{text anchor|LOOSE_CLUSTERS}}
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.

|-
| {{text anchor|LOW_LIGHT_VISION}}
| Caste
|
*number
| Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|MAGICAL}}
| Caste
|
| According to Toady One, this is completely interchangeable with {{token|AT_PEACE_WITH_WILDLIFE|c}} and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954]

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| The creature is able to see while submerged in [[magma]].

|-
| {{text anchor|MALE}}
| Caste
|
| Makes the creature biologically male. Usually declared inside a caste.

|-
| {{text anchor|MANNERISM|MANNERISM_*}}
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile. See [[creature mannerism token]] for further info.

|-
| {{text anchor|MATERIAL}}
| Creature
|
*material id
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.

|-
| {{text anchor|MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*[[Material token]]
*value A
*value B
| When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c}}, which can be used to make this sort of effect applicable to all materials.

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| Sets the creature to be active at dawn in adventurer mode.

|-
| {{text anchor|MAXAGE}}
| Caste
|
*min
*max
| Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact [[time|tick]]!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [http://i.imgur.com/A1A4aA9.png].
Creatures which lack this token are naturally immortal. The [[Syndrome#CE_ADD_TAG|NO_AGING]] syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creatures are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in fortress mode, they will have a pop-up message announcing their arrival. They will remain hostile to military even after being tamed.{{bug|10731}} See [[megabeast]] page for more details.

Requires specifying a {{token|BIOME|c}} in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical bosses and as wild animals.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|MENT_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Soul_attributes|mental attribute]]'s range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| {{text anchor|MENT_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Soul_attributes|Mental attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be [[milk]]ed in the [[farmer's workshop]]. The frequency is the amount of [[time|ticks]] the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on [[#CAN_LEARN|sentient]] creatures, regardless of [[ethics]].

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for {{token|MISCHIEVOUS|c}}.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| The creature spawns [[stealth]]ed and will attempt to path into the fortress, pulling any [[lever]]s it comes across. It will be invisible on the map and [[unit list]] until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by [[gremlin]]s in the vanilla game. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| {{text anchor|MODVALUE}}
| Caste
|
| Seemingly no longer used.

|-
| {{text anchor|MOUNT}}
| Caste
|
| Creature may be used as a [[mount]]. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.

|-
| {{text anchor|MOUNT_EXOTIC}}
| Caste
|
| Creature may be used as a [[mount]], but civilizations cannot domesticate it in worldgen without certain exceptions.

|-
| {{text anchor|MULTIPART_FULL_VISION}}
| Caste
|
| Allows the creature to have all-around vision as long as it has multiple heads that can see.

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual. Requires {{token|FEMALE|c}}.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|NAME}}
| Creature
|
*singular
*plural
*adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use {{token|CASTE_NAME|c}} instead. If left undefined, the creature will be labeled as "nothing" by the game.

Some examples of adjective use:
* "super''dwarven'' strength"
* "the ''dwarven'' hillocks of X"
* Deity species as in "''feline'' deity"
* Megabeast attacks in worldgen. One with multiple dragons being a "''draconic'' rampage"

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. NATURAL animals will not engage creatures tagged with {{token|AT_PEACE_WITH_WILDLIFE|c}} in combat unless they are members of a hostile entity and vice-versa.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of {{token|NATURAL|c}}.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
|
*[[Skill_token|Skill token]]
*value
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Creatures with this token can appear in [[bogeyman|bogeyman ambushes]] in [[adventure mode]], where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into [[smoke]] after a short while. Note that setting the "Number of Bogeyman Types" in [[advanced world generation]] to 0 will only remove randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
| Caste
|
| Found on some [[necromancer]]s. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an <code>[[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]]</code> tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into [[Infected_ghoul|ghouls]] and [[Experiment|other experimental creatures]], and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| Found on [[night troll]]s and [[werebeast]]s. Implies that the creature is a [[night creature]], and shows its description in [[legends mode]] entry. The creature is always hostile and will start [[no quarter]] combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in [[fortress mode]] except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a {{token|BIOME|c}} in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s. When paired with SPOUSE_CONVERTER, a very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
| Caste
|
| Found on [[nightmare]]s. Corpses and severed body parts derived from creatures with this token turn into [[smoke]] after a short while.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| The creature caste does not appear in [[Calendar|autumn]].

|-
| {{text anchor|NO_CONNECTIONS_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| {{text anchor|NO_DIZZINESS}}
| Caste
|
| Creature cannot become [[Symptom#Dizziness|dizzy]].

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to [[food|eat]]. Seems to cause worldgen crashes if it is part of an entity with [[entity_token#PERMITTED_JOB|[PERMITTED_JOB:FISHERMAN]]]{{verify}}

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer [[Symptom#Fever|fevers]].

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| The creature is biologically sexless. Makes the creature unable to [[breeding|breed]].

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The creature cannot raise any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The creature cannot lose any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep. Can still be rendered unconscious by other means.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| The creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| The creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require an organ with the {{token|THOUGHT|body}} tag to survive or attack; generally used on creatures that don't have brains.

|-
| {{text anchor|NO_UNIT_TYPE_COLOR}}
| Caste
|
| Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).

|-
| {{text anchor|NO_VEGETATION_PERTURB}}
| Caste{{Verify}}
|
| Likely prevents the creature from leaving broken vegetation tracks.{{Verify}}

|-
| {{text anchor|NO_WINTER}}
| Caste
|
| The creature caste does not appear in [[Calendar|winter]].

|-
| {{text anchor|NOBONES}}
| Caste
|
| Creature has no bones.

|-
| {{text anchor|NOBREATHE}}
| Caste
|
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| Sets the creature to be active at night in adventure mode.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions or moving at full speed for extended periods of time.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never flee from battle, and will be immune to [[ghost]]s' attempts to 'scare it to death'. Additionally, it causes [[bogeyman|bogeymen]] and [[nightmare]]s to become friendly towards the creature.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not be hunted or fed to wild beasts.

|-
| {{text anchor|NONAUSEA}}
| Caste
|
| Creature isn't nauseated by gut hits and cannot vomit.

|-
| {{text anchor|NOPAIN}}
| Caste
|
| Creature doesn't feel pain.

|-
| {{text anchor|NOSKIN}}
| Caste
|
| Creature will not drop a hide when [[butcher|butchered]].

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butchering, rot, or decay of severed head.

|-
| {{text anchor|NOSMELLYROT}}
| Caste
|
| Does not produce [[miasma]] when rotting.

|-
| {{text anchor|NOSTUCKINS}}
| Caste
|
| Weapons can't get stuck in the creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Cannot be [[butcher|butchered]].

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by [[vampire]]s, [[Mummy|mummies]] and inorganic creatures like the [[amethyst man]] and [[bronze colossus]]. Creatures who are {{token|OPPOSED_TO_LIFE|c}} (undead) will be docile towards creatures with this token.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a {{token|THOUGHT|body}} body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ODOR_LEVEL}}
| Caste
|
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).

|-
| {{text anchor|ODOR_STRING}}
| Caste
|
*string
| What the creature [[smell]]s like. If no odor string is defined, the creature name (not the caste name) is used.

|-
| {{text anchor|OPPOSED_TO_LIFE}}
| Caste
|
| Is hostile to all creatures except undead and other non-living ones and will show {{DFtext|Opposed to life|0:1}} in the [[unit list]]. Used by [[undead]] in the vanilla game. Functions without the {{token|NOT_LIVING|c}} token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.

|-
| {{text anchor|ORIENTATION}}
| Caste
|
*MALE/FEMALE
*disinterested chance
*casual chance
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.

|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}
| Caste
|
| Lets you play as an [[Adventurer_mode_character_creation#Outsider|outsider]] of this species in adventure mode.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|PACK_ANIMAL}}
| Caste
|
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures!

|-
| {{text anchor|PARALYZEIMMUNE}}
| Caste
|
| The creature is immune to all [[Syndrome#CE_PARALYSIS|paralyzing]] special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate [[pearl]]s. Does nothing in the current version.{{verify}}

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
|
*value
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.

|-
| {{text anchor|PERSONALITY}}
| Caste
|
*ATTRIBUTE
*lowest
*median
*highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| {{text anchor|PET}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. However, you can solve these problems using the popular plugin [https://dffd.bay12games.com/file.php?id=13095| Dwarf Therapist], which is completely unaffected by the tag.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?{{verify}} Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. ([[Gremlin|Example]]).

|-
| {{text anchor|PETVALUE}}
| Caste
|
*value
| How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.

|-
| {{text anchor|PETVALUE_DIVISOR}}
| Caste
|
*value
| Divides the creature's {{token|PETVALUE|c}} by the specified number. Used by [[honey bee]]s to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|PHYS_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Body_attributes|physical attribute]]'s range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| {{text anchor|PHYS_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Body_attributes|Physical attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| {{text anchor|PLUS_BP_GROUP}}
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after {{token|SELECT_MATERIAL|c}}.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
*number
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}.

|-
| {{text anchor|POPULATION_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region. Defaults to 1:1 if not specified.

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.).

|-
| {{text anchor|PREFSTRING}}
| Creature
|
*string
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.

|-
| {{text anchor|PROFESSION_NAME}}
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use {{token|CASTE_PROFESSION_NAME|c}} instead.

|-
| {{text anchor|PRONE_TO_RAGE}}
| Caste
|
*Chance
| Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes [[badger]]s so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| The creature has pus. Specifies the stuff secreted by [[Health_care#Infection|infected wounds]].
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|RELSIZE}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, dwarves have larger livers.

|-
| {{text anchor|REMAINS}}
| Caste
|
*singular
*plural
| What the creature's [[remains]] are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color the creature's [[remains]] are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with {{token|VERMIN_BITE|c}} and {{token|DIE_WHEN_VERMIN_BITE|c}}, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| {{text anchor|REMAINS_UNDETERMINED}}
| Caste
|
| Unknown.

|-
| {{text anchor|REMOVE_MATERIAL}}
| Creature
|
*material token
| Removes a material from the creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*tissue token
| Removes a tissue from the creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") retract verb text
*Third person ("The giant snail") retract verb text
*Second person cancel retract text
*Third person cancel retract text
| The creature will retract into the specified body part(s) when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part(s). When one of the specified body part is severed off, the creature automatically unretracts and cannot retract anymore. More than one body part can be selected by using BY_TYPE or BY_CATEGORY.

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy, specifically those that retract into their upper bodies: [[echidna]]s, [[hedgehog]]s and [[pangolin]]s.{{bug|11463}}{{bug|10519}} The upper body is prevented from collapsing by a separate body part (the middle spine), which cannot be attacked when the creature is retracted. See {{token|PREVENTS_PARENT_COLLAPSE|bo}}. Living creatures eventually succumb to blood loss, but undead creatures do not. Giant creatures also take a very long time to bleed out.
|-
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
|
|
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") verb text
*Third person ("The hen") verb text
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SAVAGE}}
| Creature
|
| The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with {{token|GOOD|c}} or {{token|EVIL|c}}.

|-
| {{text anchor|SECRETION}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*BY_TOKEN / BY_CATEGORY / BY_TYPE
*<[[Body_token#BP|body part ID]]> / <[[Body_token#CATEGORY|category]]> or ALL / <type (e.g. [[Body_token#GRASP|GRASP]])>
*<[[Body_detail_plan_token#BP_LAYERS|tissue layer]]> or ALL
*<trigger>
| Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') [[contaminant]] is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
*'''CONTINUOUS'''
Secretion occurs once every 40 [[time|ticks]] in [[fortress mode]], and every tick in [[adventurer mode]].
*'''EXERTION'''
Secretion occurs continuously (at the rate described above) whilst the creature is at minimum {{Tile|Tired|6:1}} following physical exertion. Note that this cannot occur if the creature has {{token|NOEXERT|c}}.
*'''EXTREME_EMOTION'''
Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with {{token|NOEMOTION|c}}.

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*<caste>
| Adds an additional previously defined caste to the selection. Used after {{token|SELECT_CASTE|c}}.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*<caste> or ALL
| Selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*<[[material token]]>
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as {{token|MEGABEAST|c}}, but more of them are created during worldgen. See the [[semi-megabeast]] page for details.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* <[[Creature_token#CREATURE_CLASS|creature class]]>
* [[Tilesets|<tile value or character>]]
* [[Color#Color_values|<foreground color>:<background color>:<foreground brightness>]]
| Gives the creature the ability to sense creatures belonging to the specified [[Creature_token#CREATURE_CLASS|creature class]] even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of [[Wound#Blindness|blind]] units when fighting creatures they can sense. In [[adventure mode]], the specified tile will be used to represent sensed creatures when they cannot be seen directly.

|-
| {{text anchor|SET_BP_GROUP}}
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
|
*<[[skill_token]]>
*<percentage>
| The rate at which this creature learns this skill. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
|
*<percentage>
| The rate at which this creature learns all skills. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
|
*[[skill_token]]
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Like {{token|SKILL_RATES|c}}, but applies to individual skills instead. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATE}}
| Caste
|
*[[skill_token]]
*value
*value
*value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATES}}
| Caste
|
*value
*value
*value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SLAIN_CASTE_SPEECH}}
| Caste
|
*text set
| Caste-specific {{token|SLAIN_SPEECH|c}}.

|-
| {{text anchor|SLAIN_SPEECH}}
| Creature
|
*text set
| Boasting speeches relating to killing this creature. Examples include text_dwarf.txt and text_elf.txt in data\vanilla\vanilla_creatures\objects.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves "[[item token#REMAINS|remains]]" instead of a corpse. Used by [[vermin]].

|-
| {{text anchor|SMELL_TRIGGER}}
| Creature
|
*value
| Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.

|-
| {{text anchor|SOLDIER_ALTTILE}}
| Creature
|
*'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| {{text anchor|SOUND}}
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.
* First-person reads "You '''bark'''"
* Third-person reads "The [[capybara]] '''barks'''"
* Out of sight reads "You hear '''a loud bark'''"
with the text in bold being the description arguments of the token.

|-
| {{text anchor|SOURCE_HFID}}
| Creature
|
*Integer
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.

|-
| {{text anchor|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.

|-
| {{text anchor|SPHERE}}
| Creature
|
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| {{text anchor|SPOUSE_CONVERSION_TARGET}}
| Caste
|
| This creature can be converted by a night creature with {{token|SPOUSE_CONVERTER|c}}.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the {{token|NIGHT_CREATURE_HUNTER|c}} tag, it will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s and transform them into the caste of its species with the {{token|CONVERTED_SPOUSE|c}} tag during worldgen. It may also start families this way.

|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
| Caste
|
| If the creature rules over a [[site]], it will cause the local landscape to be corrupted into [[Surroundings#Evil|evil surroundings]] associated with the creature's [[Creature_token#SPHERE|sphere]]s. The creature must have at least one of the following [[sphere]]s for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get [[Plant_token#EVIL|evil plants]] and [[Creature_token#EVIL|evil animals]] sometimes. NIGHTMARES gets [[bogeyman|bogeymen]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8162224#msg8162224] Used by [[demon]]s in the vanilla game.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste
|
| Caste does not require <code>[[Body_token#GRASP|[GRASP]]]</code> body parts to climb -- it can climb with <code>[[Body_token#STANCE|[STANCE]]]</code> parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as {{token|GRAZER|c}} but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.

|-
| {{text anchor|STRANGE_MOODS}}
| Caste
|
| The creature will get [[strange mood]]s in fortress mode and can produce artifacts.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with <code>[[Interaction_token#IS_SECRET|[SUPERNATURAL_LEARNING_POSSIBLE]]]</code> that match its [[Creature_token#SPHERE|spheres]] and also prevents it from becoming a [[vampire]] or [[werebeast]]. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim perfectly and does not use the [[swimmer]] skill, as opposed to {{token|SWIMS_LEARNED|c}} below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature swims only as well as their present [[Swimmer|swimming skill]] allows them to.

|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
| Caste
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
| Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|TENDONS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has tendons in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's [[web]]s can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
|
*name
| Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.

|-
| {{text anchor|TISSUE_LAYER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| {{text anchor|TISSUE_LAYER_OVER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Alias for TISSUE_LAYER

|-
| {{text anchor|TISSUE_LAYER_UNDER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example, an [[iron man]] has a gaseous poison within, and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS, so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER; here is an example Tissue from the Iron Man: 
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
*number
| How much the creature can carry when used by merchants. 1000 by default.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for {{token|TRAINABLE_HUNTING|c}} + {{token|TRAINABLE_WAR|c}}.

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be [[Animal trainer|trained]] as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be [[Animal trainer|trained]] as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into [[martial trance]]s. Used by dwarves in the vanilla game.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature will never trigger [[trap]]s it steps on. Used by a [[Trapavoid|number of creatures]]. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
|
*min
*max
| A large swarm of vermin can be disturbed, usually in adventurer mode.{{verify}}

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the {{token|TISSUE_STYLE_UNIT|c}}, used in the description of the tissue layer's style.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|UBIQUITOUS}}
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth that the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. Values from 1-3 are the respective [[cavern]] levels, 4 is the [[magma sea]] and 5 is the [[HFS]]. A single argument may be used instead of min and max. [[Demon]]s use only 5:5; user-defined creatures with both this depth and {{token|FLIER}} will take part in the initial wave from the HFS alongside generated demons, but without {{token|FLIER}} they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| The creature is displayed as blue when in [[Water#Depth|7/7 water]]. Used on fish and amphibious creatures which swim under the water.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.

|-
| {{text anchor|USE_CASTE}}
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."
Roostre: "When DF detects duplicate tokens in the raws of the same object, a failsafe seems to kick in; it takes the bottom-most of the duplicates, and disregards the others. In the case of tokens added by a mod, it prioritizes the duplicate in the mod." This means that if a tag is defined in the base-caste and redefined in the derived caste, the derived tag overwrites the base tag.

|-
| {{text anchor|USE_MATERIAL}}
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| {{text anchor|USE_MATERIAL_TEMPLATE}}
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].

|-
| {{text anchor|USE_TISSUE}}
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| {{text anchor|USE_TISSUE_TEMPLATE}}
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| {{text anchor|UTTERANCES}}
| Creature
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|VEGETATION}}
| Caste
|
| Like {{token|AT_PEACE_WITH_WILDLIFE}}, but also makes the creature more valued in artwork by civilisations with the PLANT [[sphere]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954] Used by [[grimeling]]s in the vanilla game.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
* [[Material_definition_token#Material_States|material state]]
| Enables vermin to bite other creatures, injecting the specified material. See {{token|SPECIALATTACK_INJECT_EXTRACT|c}} for details about injection - this token presumably works in a similar manner.{{verify}}

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See {{token|PENETRATEPOWER|c}}. Distinct from {{token|VERMIN_ROTTER|c}}.

|-
| {{text anchor|VERMIN_FISH}}
| Creature
|
| The vermin appears in [[water]] and will attempt to swim around.

|-
| {{text anchor|VERMIN_GROUNDER}}
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| {{text anchor|VERMIN_HATEABLE}}
| Caste
|
| Some dwarves will [[Preferences|hate]] the creature and get unhappy thoughts when around it. See the [[Hateable|list of hateable vermin]] for details.

|-
| {{text anchor|VERMIN_MICRO}}
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).

|-
| {{text anchor|VERMIN_NOFISH}}
| Caste
|
| The creature cannot be caught by [[fishing]].

|-
| {{text anchor|VERMIN_NOROAM}}
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| {{text anchor|VERMIN_NOTRAP}}
| Caste
|
| The creature cannot be caught in baited [[animal trap]]s; however, a "[[Trapper|catch live land animal]]" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the {{token|ROOT_AROUND|c}} interaction such as [[goose|geese]] and [[chicken]]s. Dwarves will ignore the creature when given the "Capture live land animal" task.

|-
| {{text anchor|VERMIN_SOIL_COLONY}}
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| {{text anchor|VERMINHUNTER}}
| Caste
|
| Old shorthand for "does cat stuff". Contains {{token|AT_PEACE_WITH_WILDLIFE|c}} + {{token|RETURNS_VERMIN_KILLS_TO_OWNER|c}} + {{token|HUNTS_VERMIN|c}} + {{token|ADOPTS_OWNER|c}}.

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| Sets the creature to be active during the evening in adventurer mode.

|-
| {{text anchor|VIEWRANGE}}
| Caste
|
*value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.

|-
| {{text anchor|VISION_ARC}}
| Caste
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|WAGON_PULLER}}
| Caste
|
| Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.

|-
| {{text anchor|WEBBER}}
| Caste
|
* [[material token]]
| Allows the creature to create [[web]]s, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick [[web]]s. Used by creatures who can shoot thick webs (such as [[giant cave spider]]s) in order to make them immune to their own attacks.
|}

==Attack Tokens==

Attacks can use four different part selection criteria; while all vanilla attacks use only BODYPART (e.g. ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP), there are other options available.

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Part type token
! width="30%" | Arguments
! width="60%" | Description

|-
| {{text anchor|BODYPART}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| This attack uses a particular body part; for example, BY_TYPE:GRASP will make it use any part that can hold onto an object.

|-
| {{text anchor|TISSUE_LAYER}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| This attack uses a specific tissue layer on a specific body part; BY_TYPE:GRASP:BONE will make it use the bone of the hands.

|-
| {{text anchor|CHILD_BODYPART_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| Uses a body part that is subordinate to another; BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm).

|-
| {{text anchor|CHILD_TISSUE_LAYER_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| As CHILD_BODYPART_GROUP, but specifying a tissue, too.

|}

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ATTACK_SKILL}}
| Caste
|
*[[Skill token]]
| Defines the skill used by the attack.

|-
| {{text anchor|ATTACK_VERB}}
| Caste
|
*2nd person
*3rd person
| Descriptive text for the attack.

|-
| {{text anchor|ATTACK_CONTACT_PERC}}
| Caste
|
*% value
| The contact area of the attack, measured in % of the body part's volume. Note that all attack percentages can be more than 100%.

|-
| {{text anchor|ATTACK_PENETRATION_PERC}}
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.

|-
| {{text anchor|ATTACK_PRIORITY}}
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| {{text anchor|ATTACK_VELOCITY_MODIFIER}}
| Caste
|
*number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| {{text anchor|ATTACK_FLAG_CANLATCH}}
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| {{text anchor|ATTACK_FLAG_WITH}}
| Caste
|
| Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".

|-
| {{text anchor|ATTACK_FLAG_EDGE}}
| Caste
|
| The attack is edged, with all the effects on physical resistance and contact area that it entails.

|-
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
| Caste
|
* Preparation time
* Recovery time
| Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.

|-
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack cannot be performed effectively.

|-
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*<min quantity>
*<max quantity>
| When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in [[temperature|thermal]] exchange within the creature - injecting something like molten [[iron]] (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also [[contaminant|splatters]] over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated [[syndrome]] with the [[Syndrome#SYN_INJECTED|[SYN_INJECTED]]] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [[Material definition token#ENTERS_BLOOD|[ENTERS_BLOOD]]] token, the attacked bodypart has no [[Tissue_definition_token#VASCULAR|[VASCULAR]]] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
|
*interaction
| When this attack lands successfully, a specified interaction will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well. If the attack would break skin, the interaction will occur '''before the attack actually lands'''.

|-
| {{text anchor|SPECIALATTACK_SUCK_BLOOD}}
| Caste
|
*min
*max
| Successful attack draws out an amount of blood randomized between the min and max value. Beware that this '''will''' trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.
|}

==Tissue Layer Tokens==
Tissue layers are added to a creature's body parts by the creature tokens [[#TISSUE_LAYER|TISSUE_LAYER]], [[#TISSUE_LAYER_OVER|TISSUE_LAYER_OVER]], [[#TISSUE_LAYER_UNDER|TISSUE_LAYER_UNDER]], and the body detail plan token [[#TL_LAYERS|TL_LAYERS]].

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. [[#TL_CONNECTS|TL_CONNECTS]] to [[tissue_definition_token#CONNECTS|CONNECTS]].

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SELECT_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Begins a selection of tissue layers.
[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds tissue layers to those selected.

|-
| {{text anchor|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
*TISSUE
| Sets a selected tissue layer to be made of a different tissue.

|-
| {{text anchor|SHEARABLE_TISSUE_LAYER}}
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (for example, a [[llama]]'s wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|TISSUE_LAYER_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| {{text anchor|TISSUE_STYLE_UNIT}}
| Caste
|
*tissue style unit ID
*shaping
| Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
|
*COLOR
*freq
*COLOR
*freq etc.
| Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".

|-
| {{text anchor|TLCM_GENETIC_MODEL}}
| Caste
|
| The way the color modifier is passed on to offspring. May or may not work right now.{{verify}}

|-
| {{text anchor|TLCM_IMPORTANCE}}
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| {{text anchor|TLCM_NOUN}}
| Caste
|
*name
*SINGULAR or PLURAL
| Names the tissue layer color modifier, and determines the noun. Also used by [[Utility:Stonesense|Stonesense]] for colouring body parts.

|-
| {{text anchor|TLCM_TIMING}}
| Caste
|
*ROOT
*start change window years
*days
*end change window years
*days
| Determines the point in the creature's life when the color change begins and ends.

|-
| {{text anchor|TL_CONNECTS}}
| Caste
|
| Gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
*value
| Changes the HEALING_RATE of the selected tissue layers.

|-
| {{text anchor|TL_MAJOR_ARTERIES}}
| Caste
|
| Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.

|-
| {{text anchor|TL_PAIN_RECEPTORS}}
| Caste
|
*value
| Changes the number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
*value
| Changes the relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
*value
| Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

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

Creature token

2023-05-04T21:10:49Z

Qeveren: /* G */ GO_TO_TAG needs verification - may add tags *before* specified tag

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

The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.

The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)

__NOTOC__
{{clear}}
{{alphabetical TOC|style=margin: 1em auto;}}

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Makes the creature need [[alcohol]] to get through the working day; it will choose to drink booze instead of [[water]] if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| Sets the creature to be active during the day, night, and twilight in Adventurer Mode. Seems to be a separate value from {{token|DIURNAL|c}}/{{token|NOCTURNAL|c}}/{{token|CREPUSCULAR|c}}, rather than implying them.{{verify|code}}

|-
| {{text anchor|ALTTILE}}
| Creature
|
*'character' or tile number
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Found on {{token|LARGE_PREDATOR|c}}s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures. {{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Appearance Modifier
|
*Range (6 values, low to high)
| Based on info from [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Wannabehero on the forums]: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.

The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range.

|-
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Appearance Modifier
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| {{text anchor|APP_MOD_IMPORTANCE}}
| Appearance Modifier
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| {{text anchor|APP_MOD_NOUN}}
| Appearance Modifier
|
*noun
*SINGULAR or PLURAL
| Creates a noun for the appearance, and whether it is singular or plural.

|-
| {{text anchor|APP_MOD_RATE}}
| Appearance Modifier
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min (growth)
*max (growth)
*start year
*start day
*end year
*end day
| Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| {{text anchor|APPLY_CREATURE_VARIATION}}
| Caste
|
*creature variation ID
*(optional) any amount of arbitrary arguments
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.

|-
| {{text anchor|APPLY_CURRENT_CREATURE_VARIATION}}
| Special
|
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Enables the creature to breathe in water, but causes it to air-drown on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list. Typically applied to spoileriffic creatures.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.

|-
| {{text anchor|ATTACK}}
| Caste
|
*token
*selection criteria (it's complicated)
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:''' 
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code> 
''GORE'' = name of the attack 
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
|
*population
*exported wealth
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occurring when at least one of the requirements is met. Setting a value to 0 disables the trigger.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|BABY}}
| Caste
|
*integer
| Age at which creature is considered a child, the default is zero. One can think of this as the duration of the baby stage.

|-
| {{text anchor|BABYNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
|
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.

|-
| {{text anchor|BIOME}}
| Creature
|
* [[biome token]]
| Select a [[biome]] the creature may appear in.

|-
| {{text anchor|BLOOD}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|thirst for blood]] grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) as a creature of the night.

|-
| {{text anchor|BODY}}
| Caste
|
*body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.

'''If the body is left undefined, the creature (or caste) will be tagged as [DOES_NOT_EXIST].''' {{verify}}

|-
| {{text anchor|BODY_APPEARANCE_MODIFIER}}
| Caste
|
*ATTRIBUTE
*lowest
*lower
*low
*median
*high
*higher
*highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| {{text anchor|BODY_DETAIL_PLAN}}
| Caste
|
*PlanName
*Arguments
| Loads a plan from listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| {{text anchor|BODY_SIZE}}
| Caste
|
*years
*days
*size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials, is roughly equal to the creature's average weight in grams.
'''Example:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it would be 220,000 cm3 and weigh roughly 220 kg.

|-
| {{text anchor|BODYGLOSS}}
| Caste
|
*gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| {{text anchor|BONECARN}}
| Caste
|
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].

|-
| {{text anchor|BP_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| {{text anchor|BP_REMOVE_TYPE}}
| Caste
|
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|BUILDINGDESTROYER}}
| Caste
|
*1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the {{k|b}} + {{k|C}} commands.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|CAN_DO_INTERACTION}}
| Caste
|
*interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| {{text anchor|CAN_LEARN}}
| Caste
|
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten by an adventurer, so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. Skills allocated will disappear on start.

|-
| {{text anchor|CAN_SPEAK}}
| Caste
|
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills.

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste
|
| Creature cannot [[climber|climb]], even if it has free grasp parts.

|-
| {{text anchor|CANNOT_JUMP}}
| Caste
|
| Creature cannot [[jump]].

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}}

|-
| {{text anchor|CARNIVORE}}
| Caste
|
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills. Does not seem to affect the diet of the adventurer in adventure mode.

|-
| {{text anchor|CASTE}}
| Creature
|
*name
| Defines a [[caste]].

|-
| {{text anchor|CASTE_ALTTILE}}
| Caste
|
*tile number or "letter"
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.

|-
| {{text anchor|CASTE_COLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|COLOR|c}}.

|-
| {{text anchor|CASTE_GLOWCOLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|GLOWCOLOR|c}}.

|-
| {{text anchor|CASTE_GLOWTILE}}
| Caste
|
*tile value or "letter"
| Caste-specific {{token|GLOWTILE|c}}.

|-
| {{text anchor|CASTE_NAME}}
| Caste
|
*singular
*plural
*adjective
| Caste-specific {{token|NAME|c}}.

|-
| {{text anchor|CASTE_PROFESSION_NAME}}
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| Caste-specific {{token|PROFESSION_NAME|c}}.

|-
| {{text anchor|CASTE_SOLDIER_ALTTILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SOLDIER_TILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_TILE}}
| Caste
|
* tile number or "letter"
| Caste-specific {{token|CREATURE_TILE|c}}.

|-
| {{text anchor|CAVE_ADAPT}}
| Caste
|
| Gives the creature a bonus in caves. Also causes [[cave adaptation]].

|-
| {{text anchor|CDI}}
| Caste
|
*Varies
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].

|-
| {{text anchor|CHANGE_BODY_SIZE_PERC}}
| Caste
|
*integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| {{text anchor|CHANGE_FREQUENCY_PERC}}
| Creature
|
*integer
| Multiplies frequency by a factor of (integer)%.

|-
| {{text anchor|CHILD}}
| Caste
|
*integer
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.

|-
| {{text anchor|CHILDNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.

|-
| {{text anchor|CLUSTER_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of [[egg]]s laid in one sitting.

|-
| {{text anchor|COLONY_EXTERNAL}}
| Caste
|
| Caste hovers around colony.

|-
| {{text anchor|COLOR}}
| Creature
|
*foreground
*background
*brightness
| Color of the creature's tile. See [[Color]] for usage.

|-
| {{text anchor|COMMON_DOMESTIC}}
| Caste
|
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}}, {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| {{text anchor|COOKABLE_LIVE}}
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered/cleaned. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*creature ID
| Copies another specified creature. This will override any definitions made before it; essentially, it makes this creature identical to the other one, which can then be modified. Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. The vanilla [[giant animal]]s and [[animal person|animal people]]s are examples of this token combination.

|-
| {{text anchor|CREATURE}}
| Creature
|
*creature ID
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for {{token|GOBBLE_VERMIN_CLASS|c}}), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

* Creature tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
|-
| {{text anchor|CREATURE_SOLDIER_TILE}}
| Creature
|
*'character' or tile number
| Creatures active in their civilization's [[military]] will use this tile instead.

|-
| {{text anchor|CREATURE_TILE}}
| Creature
|
*'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| {{text anchor|CREPUSCULAR}}
| Caste
|
| Sets the creature to be active at twilight in adventurer mode.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to [[Steals food|steal and eat edible items]] from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) [[Steals drink|drink your alcohol]]. Or spill the barrel to the ground. Also affects undead versions of the creature. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.

|-
| {{text anchor|CV_ADD_TAG}}
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| {{text anchor|CV_REMOVE_TAG}}
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|DEMON}}
| Caste
|
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.

|-
| {{text anchor|DESCRIPTION}}
| Caste
|
*text
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.

|-
| {{text anchor|DIFFICULTY}}
| Caste
|
*integer
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| Sets the creature to be active during the day in Adventurer Mode.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s will lead to worlds being generated without dogs in them. Also removes the creature from the [[object testing arena]]'s spawn list. If combined with {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|EBO_ITEM}}
| Caste
|
*[[item token]]
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
|
*gem shape
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|Egg-laying]] creatures in the default game define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| {{text anchor|EGG_SIZE}}
| Caste
|
*size
| Determines the size of laid [[egg]]s. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature appear as a large 3x3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|FANCIFUL}}
| Creature
|
| The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.

|-
| {{text anchor|FEMALE}}
| Caste
|
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|FIREJET]] attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in [[fire]], and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|FISH]] item) at a [[fishery]] to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|fished]] vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

|-
| {{text anchor|FIXED_TEMP}}
| Caste
|
*temperature
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from.

Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| If engaged in combat, the creature will flee at the first sign of resistance. Used by [[kobold]]s in the vanilla game.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own [[Body_token#FLIER|FLIER]] token).

|-
| {{text anchor|FREQUENCY}}
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|GAIT}}
| Caste
|
* <gait type>
* <gait name>
* <max [[Gait#Speed|speed]]>
* <build up time>
* <max turning [[Gait#Speed|speed]]>
* <start [[Gait#Speed|speed]]>
* <energy expenditure>
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information. Specifically, you likely want to use one of the existing STANDARD_X_GAITS creature variations, as described in [[Gait#Gaits_and_Modding|this subsection]].

* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
* <start speed> indicates the creature's speed when it starts moving using this gait
* <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 [[tile]]s in a straight line over even terrain.
* <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
* <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and [[Status_icon#Non-flashing|collapse]].

'''NO_BUILD_UP''' can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are '''both''' omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.

'''valid gait types:'''
*'''WALK''' 
Used for moving normally over ground tiles.

*'''CRAWL''' 
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].

*'''SWIM''' 
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.

*'''FLY''' 
Used for moving through [[open space]].

*'''CLIMB''' 
Used for moving whilst [[Climber|climbing]].

'''valid gait flags:'''
* '''AGILITY''' 
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.

* '''STRENGTH''' 
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.

* '''LAYERS_SLOW''' 
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|THICKENS_ON_STRENGTH]] tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

* '''STEALTH_SLOWS:'''<percentage> 
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
|
*singular
*plural
| Like {{token|BABYNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
|
*singular
*plural
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*value A
*value B
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's {{token|GLOWTILE|c}}.

|-
| {{text anchor|GLOWTILE}}
| Creature
|
*ascii character
| If present, the being glows in the dark (generally used for Adventurer Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use {{token|CASTE_GLOWTILE|c}} instead.

|-
| {{text anchor|GNAWER}}
| Caste
|
*verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made (normally wood).

|-
| {{text anchor|GOBBLE_VERMIN_CLASS}}
| Caste
|
*class
| The creature eats vermin of the specified class.

|-
| {{text anchor|GOBBLE_VERMIN_CREATURE}}
| Caste
|
*creature
*caste
| The creature eats a specified [[vermin]].

|-
| {{text anchor|GO_TO_END}}
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| {{text anchor|GO_TO_START}}
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| {{text anchor|GO_TO_TAG}}
| Special
|
| When using tags from an existing creature, inserts new tags after{{verify}} the specified tag.

|-
| {{text anchor|GOOD}}
| Creature
|
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.

|-
| {{text anchor|GRASSTRAMPLE}}
| Caste
|
*value
| The value determines how rapidly [[grass]] is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| {{text anchor|GRAVITATE_BODY_SIZE}}
| Caste
|
*target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| {{text anchor|GRAZER}}
| Caste
|
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|HABIT}}
| Caste
|
*type
*probability
| Defines certain behaviors for the creature. The habit types are:
*COLLECT_TROPHIES
*COOK_PEOPLE
*COOK_VERMIN
*GRIND_VERMIN
*COOK_BLOOD
*GRIND_BONE_MEAL
*EAT_BONE_PORRIDGE
*USE_ANY_MELEE_WEAPON
*GIANT_NEST
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.

|-
| {{text anchor|HABIT_NUM}}
| Caste
|
*number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".{{cite forum|60554/1719248}} All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| {{text anchor|HAS_NERVES}}
| Caste
|
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.

|-
| {{text anchor|HASSHELL}}
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
*number or NONE
| Default 'NONE'. The creature's normal body [[temperature]]. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby [[vermin]].

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|IMMOBILE}}
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE no breeding will happen).

|-
| {{text anchor|IMMOBILE_LAND}}
| Caste
|
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.

|-
| {{text anchor|IMMOLATE}}
| Caste
|
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
* number
| The [[quality]] of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|LAIR}}
| Caste
|
*type
*probability
| Found on megabeasts, semimegabeasts, and night creatures. The creature will seek out sites of this type and take them as lairs. The lair types are:
*SIMPLE_BURROW
*SIMPLE_MOUND
*WILDERNESS_LOCATION
*SHRINE
*LABYRINTH

|-
| {{text anchor|LAIR_CHARACTERISTIC}}
| Caste
|
*characteristic
*probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| {{text anchor|LAIR_HUNTER}}
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| {{text anchor|LAIR_HUNTER_SPEECH}}
| Caste
|
*speech file
| What this creature says while hunting adventurers in its lair.

|-
| {{text anchor|LARGE_PREDATOR}}
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| {{text anchor|LARGE_ROAMING}}
| Creature
|
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is unaffected by {{token|DEMON|c}}.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays [[egg]]s instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays the specified item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has ligaments in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.

|-
| {{text anchor|LIGHT_GEN}}
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| {{text anchor|LIKES_FIGHTING}}
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of {{token|LARGE_PREDATOR|c}}.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by [[Serpent man|serpent men]] and [[Reptile man|reptile men]] in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the number of offspring per one birth.

|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
| Creature
|
| Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
|
|
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open [[door]]s that are set to forbidden in fortress mode.

|-
| {{text anchor|LOOSE_CLUSTERS}}
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.

|-
| {{text anchor|LOW_LIGHT_VISION}}
| Caste
|
*number
| Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|MAGICAL}}
| Caste
|
| According to Toady One, this is completely interchangeable with {{token|AT_PEACE_WITH_WILDLIFE|c}} and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954]

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| The creature is able to see while submerged in [[magma]].

|-
| {{text anchor|MALE}}
| Caste
|
| Makes the creature biologically male. Usually declared inside a caste.

|-
| {{text anchor|MANNERISM|MANNERISM_*}}
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile. See [[creature mannerism token]] for further info.

|-
| {{text anchor|MATERIAL}}
| Creature
|
*material id
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.

|-
| {{text anchor|MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*[[Material token]]
*value A
*value B
| When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c}}, which can be used to make this sort of effect applicable to all materials.

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| Sets the creature to be active at dawn in adventurer mode.

|-
| {{text anchor|MAXAGE}}
| Caste
|
*min
*max
| Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact [[time|tick]]!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [http://i.imgur.com/A1A4aA9.png].
Creatures which lack this token are naturally immortal. The [[Syndrome#CE_ADD_TAG|NO_AGING]] syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creatures are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in fortress mode, they will have a pop-up message announcing their arrival. They will remain hostile to military even after being tamed.{{bug|10731}} See [[megabeast]] page for more details.

Requires specifying a {{token|BIOME|c}} in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical bosses and as wild animals.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|MENT_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Soul_attributes|mental attribute]]'s range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| {{text anchor|MENT_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Soul_attributes|Mental attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be [[milk]]ed in the [[farmer's workshop]]. The frequency is the amount of [[time|ticks]] the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on [[#CAN_LEARN|sentient]] creatures, regardless of [[ethics]].

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for {{token|MISCHIEVOUS|c}}.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| The creature spawns [[stealth]]ed and will attempt to path into the fortress, pulling any [[lever]]s it comes across. It will be invisible on the map and [[unit list]] until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by [[gremlin]]s in the vanilla game. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| {{text anchor|MODVALUE}}
| Caste
|
| Seemingly no longer used.

|-
| {{text anchor|MOUNT}}
| Caste
|
| Creature may be used as a [[mount]]. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.

|-
| {{text anchor|MOUNT_EXOTIC}}
| Caste
|
| Creature may be used as a [[mount]], but civilizations cannot domesticate it in worldgen without certain exceptions.

|-
| {{text anchor|MULTIPART_FULL_VISION}}
| Caste
|
| Allows the creature to have all-around vision as long as it has multiple heads that can see.

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual. Requires {{token|FEMALE|c}}.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|NAME}}
| Creature
|
*singular
*plural
*adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use {{token|CASTE_NAME|c}} instead. If left undefined, the creature will be labeled as "nothing" by the game.

Some examples of adjective use:
* "super''dwarven'' strength"
* "the ''dwarven'' hillocks of X"
* Deity species as in "''feline'' deity"
* Megabeast attacks in worldgen. One with multiple dragons being a "''draconic'' rampage"

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. NATURAL animals will not engage creatures tagged with {{token|AT_PEACE_WITH_WILDLIFE|c}} in combat unless they are members of a hostile entity and vice-versa.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of {{token|NATURAL|c}}.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
|
*[[Skill_token|Skill token]]
*value
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Creatures with this token can appear in [[bogeyman|bogeyman ambushes]] in [[adventure mode]], where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into [[smoke]] after a short while. Note that setting the "Number of Bogeyman Types" in [[advanced world generation]] to 0 will only remove randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
| Caste
|
| Found on some [[necromancer]]s. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an <code>[[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]]</code> tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into [[Infected_ghoul|ghouls]] and [[Experiment|other experimental creatures]], and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| Found on [[night troll]]s and [[werebeast]]s. Implies that the creature is a [[night creature]], and shows its description in [[legends mode]] entry. The creature is always hostile and will start [[no quarter]] combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in [[fortress mode]] except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a {{token|BIOME|c}} in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s. When paired with SPOUSE_CONVERTER, a very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
| Caste
|
| Found on [[nightmare]]s. Corpses and severed body parts derived from creatures with this token turn into [[smoke]] after a short while.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| The creature caste does not appear in [[Calendar|autumn]].

|-
| {{text anchor|NO_CONNECTIONS_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| {{text anchor|NO_DIZZINESS}}
| Caste
|
| Creature cannot become [[Symptom#Dizziness|dizzy]].

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to [[food|eat]]. Seems to cause worldgen crashes if it is part of an entity with [[entity_token#PERMITTED_JOB|[PERMITTED_JOB:FISHERMAN]]]{{verify}}

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer [[Symptom#Fever|fevers]].

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| The creature is biologically sexless. Makes the creature unable to [[breeding|breed]].

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The creature cannot raise any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The creature cannot lose any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep. Can still be rendered unconscious by other means.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| The creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| The creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require an organ with the {{token|THOUGHT|body}} tag to survive or attack; generally used on creatures that don't have brains.

|-
| {{text anchor|NO_UNIT_TYPE_COLOR}}
| Caste
|
| Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).

|-
| {{text anchor|NO_VEGETATION_PERTURB}}
| Caste{{Verify}}
|
| Likely prevents the creature from leaving broken vegetation tracks.{{Verify}}

|-
| {{text anchor|NO_WINTER}}
| Caste
|
| The creature caste does not appear in [[Calendar|winter]].

|-
| {{text anchor|NOBONES}}
| Caste
|
| Creature has no bones.

|-
| {{text anchor|NOBREATHE}}
| Caste
|
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| Sets the creature to be active at night in adventure mode.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions or moving at full speed for extended periods of time.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never flee from battle, and will be immune to [[ghost]]s' attempts to 'scare it to death'. Additionally, it causes [[bogeyman|bogeymen]] and [[nightmare]]s to become friendly towards the creature.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not be hunted or fed to wild beasts.

|-
| {{text anchor|NONAUSEA}}
| Caste
|
| Creature isn't nauseated by gut hits and cannot vomit.

|-
| {{text anchor|NOPAIN}}
| Caste
|
| Creature doesn't feel pain.

|-
| {{text anchor|NOSKIN}}
| Caste
|
| Creature will not drop a hide when [[butcher|butchered]].

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butchering, rot, or decay of severed head.

|-
| {{text anchor|NOSMELLYROT}}
| Caste
|
| Does not produce [[miasma]] when rotting.

|-
| {{text anchor|NOSTUCKINS}}
| Caste
|
| Weapons can't get stuck in the creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Cannot be [[butcher|butchered]].

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by [[vampire]]s, [[Mummy|mummies]] and inorganic creatures like the [[amethyst man]] and [[bronze colossus]]. Creatures who are {{token|OPPOSED_TO_LIFE|c}} (undead) will be docile towards creatures with this token.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a {{token|THOUGHT|body}} body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ODOR_LEVEL}}
| Caste
|
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).

|-
| {{text anchor|ODOR_STRING}}
| Caste
|
*string
| What the creature [[smell]]s like. If no odor string is defined, the creature name (not the caste name) is used.

|-
| {{text anchor|OPPOSED_TO_LIFE}}
| Caste
|
| Is hostile to all creatures except undead and other non-living ones and will show {{DFtext|Opposed to life|0:1}} in the [[unit list]]. Used by [[undead]] in the vanilla game. Functions without the {{token|NOT_LIVING|c}} token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.

|-
| {{text anchor|ORIENTATION}}
| Caste
|
*MALE/FEMALE
*disinterested chance
*casual chance
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.

|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}
| Caste
|
| Lets you play as an [[Adventurer_mode_character_creation#Outsider|outsider]] of this species in adventure mode.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|PACK_ANIMAL}}
| Caste
|
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures!

|-
| {{text anchor|PARALYZEIMMUNE}}
| Caste
|
| The creature is immune to all [[Syndrome#CE_PARALYSIS|paralyzing]] special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate [[pearl]]s. Does nothing in the current version.{{verify}}

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
|
*value
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.

|-
| {{text anchor|PERSONALITY}}
| Caste
|
*ATTRIBUTE
*lowest
*median
*highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| {{text anchor|PET}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. However, you can solve these problems using the popular plugin [https://dffd.bay12games.com/file.php?id=13095| Dwarf Therapist], which is completely unaffected by the tag.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?{{verify}} Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. ([[Gremlin|Example]]).

|-
| {{text anchor|PETVALUE}}
| Caste
|
*value
| How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.

|-
| {{text anchor|PETVALUE_DIVISOR}}
| Caste
|
*value
| Divides the creature's {{token|PETVALUE|c}} by the specified number. Used by [[honey bee]]s to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|PHYS_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Body_attributes|physical attribute]]'s range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| {{text anchor|PHYS_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Body_attributes|Physical attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| {{text anchor|PLUS_BP_GROUP}}
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after {{token|SELECT_MATERIAL|c}}.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
*number
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}.

|-
| {{text anchor|POPULATION_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region. Defaults to 1:1 if not specified.

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.).

|-
| {{text anchor|PREFSTRING}}
| Creature
|
*string
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.

|-
| {{text anchor|PROFESSION_NAME}}
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use {{token|CASTE_PROFESSION_NAME|c}} instead.

|-
| {{text anchor|PRONE_TO_RAGE}}
| Caste
|
*Chance
| Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes [[badger]]s so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| The creature has pus. Specifies the stuff secreted by [[Health_care#Infection|infected wounds]].
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|RELSIZE}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, dwarves have larger livers.

|-
| {{text anchor|REMAINS}}
| Caste
|
*singular
*plural
| What the creature's [[remains]] are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color the creature's [[remains]] are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with {{token|VERMIN_BITE|c}} and {{token|DIE_WHEN_VERMIN_BITE|c}}, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| {{text anchor|REMAINS_UNDETERMINED}}
| Caste
|
| Unknown.

|-
| {{text anchor|REMOVE_MATERIAL}}
| Creature
|
*material token
| Removes a material from the creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*tissue token
| Removes a tissue from the creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") retract verb text
*Third person ("The giant snail") retract verb text
*Second person cancel retract text
*Third person cancel retract text
| The creature will retract into a body part when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part. (e.g. Turtle, Hedgehog)

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy{{bug|11463}}{{bug|10519}}.
|-
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
|
|
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}, obviously.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") verb text
*Third person ("The hen") verb text
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SAVAGE}}
| Creature
|
| The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with {{token|GOOD|c}} or {{token|EVIL|c}}.

|-
| {{text anchor|SECRETION}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*BY_TOKEN / BY_CATEGORY / BY_TYPE
*<[[Body_token#BP|body part ID]]> / <[[Body_token#CATEGORY|category]]> or ALL / <type (e.g. [[Body_token#GRASP|GRASP]])>
*<[[Body_detail_plan_token#BP_LAYERS|tissue layer]]> or ALL
*<trigger>
| Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') [[contaminant]] is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
*'''CONTINUOUS'''
Secretion occurs once every 40 [[time|ticks]] in [[fortress mode]], and every tick in [[adventurer mode]].
*'''EXERTION'''
Secretion occurs continuously (at the rate described above) whilst the creature is at minimum {{Tile|Tired|6:1}} following physical exertion. Note that this cannot occur if the creature has {{token|NOEXERT|c}}.
*'''EXTREME_EMOTION'''
Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with {{token|NOEMOTION|c}}.

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*<caste>
| Adds an additional previously defined caste to the selection. Used after {{token|SELECT_CASTE|c}}.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*<caste> or ALL
| Selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*<[[material token]]>
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as {{token|MEGABEAST|c}}, but more of them are created during worldgen. See the [[semi-megabeast]] page for details.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* <[[Creature_token#CREATURE_CLASS|creature class]]>
* [[Tilesets|<tile value or character>]]
* [[Color#Color_values|<foreground color>:<background color>:<foreground brightness>]]
| Gives the creature the ability to sense creatures belonging to the specified [[Creature_token#CREATURE_CLASS|creature class]] even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of [[Wound#Blindness|blind]] units when fighting creatures they can sense. In [[adventure mode]], the specified tile will be used to represent sensed creatures when they cannot be seen directly.

|-
| {{text anchor|SET_BP_GROUP}}
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
|
*<[[skill_token]]>
*<percentage>
| The rate at which this creature learns this skill. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
|
*<percentage>
| The rate at which this creature learns all skills. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
|
*[[skill_token]]
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Like {{token|SKILL_RATES|c}}, but applies to individual skills instead. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATE}}
| Caste
|
*[[skill_token]]
*value
*value
*value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATES}}
| Caste
|
*value
*value
*value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SLAIN_CASTE_SPEECH}}
| Caste
|
*text set
| Caste-specific {{token|SLAIN_SPEECH|c}}.

|-
| {{text anchor|SLAIN_SPEECH}}
| Creature
|
*text set
| Boasting speeches relating to killing this creature. Examples include text_dwarf.txt and text_elf.txt in data\vanilla\vanilla_creatures\objects.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves "[[item token#REMAINS|remains]]" instead of a corpse. Used by [[vermin]].

|-
| {{text anchor|SMELL_TRIGGER}}
| Creature
|
*value
| Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.

|-
| {{text anchor|SOLDIER_ALTTILE}}
| Creature
|
*'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| {{text anchor|SOUND}}
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.
* First-person reads "You '''bark'''"
* Third-person reads "The [[capybara]] '''barks'''"
* Out of sight reads "You hear '''a loud bark'''"
with the text in bold being the description arguments of the token.

|-
| {{text anchor|SOURCE_HFID}}
| Creature
|
*Integer
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.

|-
| {{text anchor|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.

|-
| {{text anchor|SPHERE}}
| Creature
|
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| {{text anchor|SPOUSE_CONVERSION_TARGET}}
| Caste
|
| This creature can be converted by a night creature with {{token|SPOUSE_CONVERTER|c}}.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the {{token|NIGHT_CREATURE_HUNTER|c}} tag, it will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s and transform them into the caste of its species with the {{token|CONVERTED_SPOUSE|c}} tag during worldgen. It may also start families this way.

|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
| Caste
|
| If the creature rules over a [[site]], it will cause the local landscape to be corrupted into [[Surroundings#Evil|evil surroundings]] associated with the creature's [[Creature_token#SPHERE|sphere]]s. The creature must have at least one of the following [[sphere]]s for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get [[Plant_token#EVIL|evil plants]] and [[Creature_token#EVIL|evil animals]] sometimes. NIGHTMARES gets [[bogeyman|bogeymen]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8162224#msg8162224] Used by [[demon]]s in the vanilla game.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste
|
| Caste does not require <code>[[Body_token#GRASP|[GRASP]]]</code> body parts to climb -- it can climb with <code>[[Body_token#STANCE|[STANCE]]]</code> parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as {{token|GRAZER|c}} but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.

|-
| {{text anchor|STRANGE_MOODS}}
| Caste
|
| The creature will get [[strange mood]]s in fortress mode and can produce artifacts.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with <code>[[Interaction_token#IS_SECRET|[SUPERNATURAL_LEARNING_POSSIBLE]]]</code> that match its [[Creature_token#SPHERE|spheres]] and also prevents it from becoming a [[vampire]] or [[werebeast]]. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim perfectly and does not use the [[swimmer]] skill, as opposed to {{token|SWIMS_LEARNED|c}} below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature swims only as well as their present [[Swimmer|swimming skill]] allows them to.

|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
| Caste
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
| Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|TENDONS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has tendons in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's [[web]]s can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
|
*name
| Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.

|-
| {{text anchor|TISSUE_LAYER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| {{text anchor|TISSUE_LAYER_OVER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Alias for TISSUE_LAYER

|-
| {{text anchor|TISSUE_LAYER_UNDER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example, an [[iron man]] has a gaseous poison within, and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS, so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER; here is an example Tissue from the Iron Man: 
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
*number
| How much the creature can carry when used by merchants. 1000 by default.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for {{token|TRAINABLE_HUNTING|c}} + {{token|TRAINABLE_WAR|c}}.

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be [[Animal trainer|trained]] as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be [[Animal trainer|trained]] as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into [[martial trance]]s. Used by dwarves in the vanilla game.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature will never trigger [[trap]]s it steps on. Used by a [[Trapavoid|number of creatures]]. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
|
*min
*max
| A large swarm of vermin can be disturbed, usually in adventurer mode.{{verify}}

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the {{token|TISSUE_STYLE_UNIT|c}}, used in the description of the tissue layer's style.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|UBIQUITOUS}}
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth that the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. Values from 1-3 are the respective [[cavern]] levels, 4 is the [[magma sea]] and 5 is the [[HFS]]. A single argument may be used instead of min and max. [[Demon]]s use only 5:5; user-defined creatures with both this depth and {{token|FLIER}} will take part in the initial wave from the HFS alongside generated demons, but without {{token|FLIER}} they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| The creature is displayed as blue when in [[Water#Depth|7/7 water]]. Used on fish and amphibious creatures which swim under the water.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.

|-
| {{text anchor|USE_CASTE}}
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| {{text anchor|USE_MATERIAL}}
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| {{text anchor|USE_MATERIAL_TEMPLATE}}
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].

|-
| {{text anchor|USE_TISSUE}}
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| {{text anchor|USE_TISSUE_TEMPLATE}}
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| {{text anchor|UTTERANCES}}
| Creature
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|VEGETATION}}
| Caste
|
| Like {{token|AT_PEACE_WITH_WILDLIFE}}, but also makes the creature more valued in artwork by civilisations with the PLANT [[sphere]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954] Used by [[grimeling]]s in the vanilla game.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
* [[Material_definition_token#Material_States|material state]]
| Enables vermin to bite other creatures, injecting the specified material. See {{token|SPECIALATTACK_INJECT_EXTRACT|c}} for details about injection - this token presumably works in a similar manner.{{verify}}

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See {{token|PENETRATEPOWER|c}}. Distinct from {{token|VERMIN_ROTTER|c}}.

|-
| {{text anchor|VERMIN_FISH}}
| Creature
|
| The vermin appears in [[water]] and will attempt to swim around.

|-
| {{text anchor|VERMIN_GROUNDER}}
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| {{text anchor|VERMIN_HATEABLE}}
| Caste
|
| Some dwarves will [[Preferences|hate]] the creature and get unhappy thoughts when around it. See the [[Hateable|list of hateable vermin]] for details.

|-
| {{text anchor|VERMIN_MICRO}}
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).

|-
| {{text anchor|VERMIN_NOFISH}}
| Caste
|
| The creature cannot be caught by [[fishing]].

|-
| {{text anchor|VERMIN_NOROAM}}
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| {{text anchor|VERMIN_NOTRAP}}
| Caste
|
| The creature cannot be caught in baited [[animal trap]]s; however, a "[[Trapper|catch live land animal]]" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the {{token|ROOT_AROUND|c}} interaction such as [[goose|geese]] and [[chicken]]s. Dwarves will ignore the creature when given the "Capture live land animal" task.

|-
| {{text anchor|VERMIN_SOIL_COLONY}}
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| {{text anchor|VERMINHUNTER}}
| Caste
|
| Old shorthand for "does cat stuff". Contains {{token|AT_PEACE_WITH_WILDLIFE|c}} + {{token|RETURNS_VERMIN_KILLS_TO_OWNER|c}} + {{token|HUNTS_VERMIN|c}} + {{token|ADOPTS_OWNER|c}}.

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| Sets the creature to be active during the evening in adventurer mode.

|-
| {{text anchor|VIEWRANGE}}
| Caste
|
*value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.

|-
| {{text anchor|VISION_ARC}}
| Caste
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|WAGON_PULLER}}
| Caste
|
| Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.

|-
| {{text anchor|WEBBER}}
| Caste
|
* [[material token]]
| Allows the creature to create [[web]]s, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick [[web]]s. Used by creatures who can shoot thick webs (such as [[giant cave spider]]s) in order to make them immune to their own attacks.
|}

==Attack Tokens==

Attacks can use four different part selection criteria; while all vanilla attacks use only BODYPART (e.g. ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP), there are other options available.

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Part type token
! width="30%" | Arguments
! width="60%" | Description

|-
| {{text anchor|BODYPART}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| This attack uses a particular body part; for example, BY_TYPE:GRASP will make it use any part that can hold onto an object.

|-
| {{text anchor|TISSUE_LAYER}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| This attack uses a specific tissue layer on a specific body part; BY_TYPE:GRASP:BONE will make it use the bone of the hands.

|-
| {{text anchor|CHILD_BODYPART_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
| Uses a body part that is subordinate to another; BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm).

|-
| {{text anchor|CHILD_TISSUE_LAYER_GROUP}}
|
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* BY_TYPE/BY_TOKEN/BY_CATEGORY
* type/token/category
* tissue layer
| As CHILD_BODYPART_GROUP, but specifying a tissue, too.

|}

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ATTACK_SKILL}}
| Caste
|
*[[Skill token]]
| Defines the skill used by the attack.

|-
| {{text anchor|ATTACK_VERB}}
| Caste
|
*2nd person
*3rd person
| Descriptive text for the attack.

|-
| {{text anchor|ATTACK_CONTACT_PERC}}
| Caste
|
*% value
| The contact area of the attack, measured in % of the body part's volume. Note that all attack percentages can be more than 100%.

|-
| {{text anchor|ATTACK_PENETRATION_PERC}}
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.

|-
| {{text anchor|ATTACK_PRIORITY}}
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| {{text anchor|ATTACK_VELOCITY_MODIFIER}}
| Caste
|
*number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| {{text anchor|ATTACK_FLAG_CANLATCH}}
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| {{text anchor|ATTACK_FLAG_WITH}}
| Caste
|
| Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".

|-
| {{text anchor|ATTACK_FLAG_EDGE}}
| Caste
|
| The attack is edged, with all the effects on physical resistance and contact area that it entails.

|-
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
| Caste
|
* Preparation time
* Recovery time
| Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.

|-
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack cannot be performed effectively.

|-
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*<min quantity>
*<max quantity>
| When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in [[temperature|thermal]] exchange within the creature - injecting something like molten [[iron]] (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also [[contaminant|splatters]] over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated [[syndrome]] with the [[Syndrome#SYN_INJECTED|[SYN_INJECTED]]] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [[Material definition token#ENTERS_BLOOD|[ENTERS_BLOOD]]] token, the attacked bodypart has no [[Tissue_definition_token#VASCULAR|[VASCULAR]]] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
|
*interaction
| When this attack lands successfully, a specified interaction will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well. If the attack would break skin, the interaction will occur '''before the attack actually lands'''.

|-
| {{text anchor|SPECIALATTACK_SUCK_BLOOD}}
| Caste
|
*min
*max
| Successful attack draws out an amount of blood randomized between the min and max value. Beware that this '''will''' trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.
|}

==Tissue Layer Tokens==
Tissue layers are added to a creature's body parts by the creature tokens [[#TISSUE_LAYER|TISSUE_LAYER]], [[#TISSUE_LAYER_OVER|TISSUE_LAYER_OVER]], [[#TISSUE_LAYER_UNDER|TISSUE_LAYER_UNDER]], and the body detail plan token [[#TL_LAYERS|TL_LAYERS]].

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. [[#TL_CONNECTS|TL_CONNECTS]] to [[tissue_definition_token#CONNECTS|CONNECTS]].

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SELECT_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Begins a selection of tissue layers.
[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds tissue layers to those selected.

|-
| {{text anchor|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
*TISSUE
| Sets a selected tissue layer to be made of a different tissue.

|-
| {{text anchor|SHEARABLE_TISSUE_LAYER}}
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (for example, a [[llama]]'s wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|TISSUE_LAYER_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| {{text anchor|TISSUE_STYLE_UNIT}}
| Caste
|
*tissue style unit ID
*shaping
| Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
|
*COLOR
*freq
*COLOR
*freq etc.
| Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".

|-
| {{text anchor|TLCM_GENETIC_MODEL}}
| Caste
|
| The way the color modifier is passed on to offspring. May or may not work right now.{{verify}}

|-
| {{text anchor|TLCM_IMPORTANCE}}
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| {{text anchor|TLCM_NOUN}}
| Caste
|
*name
*SINGULAR or PLURAL
| Names the tissue layer color modifier, and determines the noun. Also used by [[Utility:Stonesense|Stonesense]] for colouring body parts.

|-
| {{text anchor|TLCM_TIMING}}
| Caste
|
*ROOT
*start change window years
*days
*end change window years
*days
| Determines the point in the creature's life when the color change begins and ends.

|-
| {{text anchor|TL_CONNECTS}}
| Caste
|
| Gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
*value
| Changes the HEALING_RATE of the selected tissue layers.

|-
| {{text anchor|TL_MAJOR_ARTERIES}}
| Caste
|
| Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.

|-
| {{text anchor|TL_PAIN_RECEPTORS}}
| Caste
|
*value
| Changes the number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
*value
| Changes the relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
*value
| Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

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

Work orders

2023-03-27T21:40:16Z

Qeveren: /* Shearing animals */

{{av}}
[[File:Work order premium.png|thumb|300px|right|A busy fortress' work order menu.]]

Work orders are an advanced feature of [[Workshop#Management|Workshop Management]] that becomes available with a [[Manager]]. It allows easier management, automation and/or fine control of the various activities needed to maintain a well-oiled fort. The work order screen lists all work orders in the fortress, shows their status and allows to modify them and place new general orders. It is accessed from the main screen through the work order menubutton (the clipboard icon in the bottom left). Keyboard shortcut : {{k|o}}

==Work Order Conditions==

Work Order Conditions are incredibly versatile and equal parts daunting. There are various options that can be selected as conditions:
===Frequency Condition===
This decides how often (if any) the work order will repeat. If there are no other conditions, the options are:

* One-time order
* Restarts if completed, checked daily
* Restarts if completed, checked monthly
* Restarts if completed, checked seasonally
* Restarts if completed, checked yearly

If there are other conditions, the options are:
* One-time order, conditions checked daily
* One-time order, conditions checked monthly
* One-time order, conditions checked seasonally
* One-time order, conditions checked yearly
* Restarts if completed, conditions checked daily
* Restarts if completed, conditions checked monthly
* Restarts if completed, conditions checked seasonally
* Restarts if completed, conditions checked yearly

===Item Condition===

By far the most complex condition, and the most common one used.

Each Item condition has a set of parameters:

* Amount
* Equality
* Type
* Material
* Adjective

Unless specifically stated, the Type, Materials and Adjectives default to 'Any'

====Amount and Equality====
The part of the condition that states when it is true or false. Amount is the number it activates on, equality is one of the following:

* At Least (At Least 5 will activate on 5 or more)
* At Most (At Most 5 will activate on 5 or less)
* Greater Than (Greater Than 5 will activate on 6 or more)
* Less Than (Less Than 5 will activate on 4 or less)
* Exactly (Exactly 5 will activate on only 5)
* Not (Not 5 will activate on any number other than 5)

====Type====

The type of object. Examples include Thread, Bar, Cloth, Breastplate, Stone, Fish, Plants.

====Material====

The exact material an object is made from. Examples include Yak Tallow, Cat Soap, Hide Root Plant, Hide Root Seed, Steel, Hematite.

====Adjectives====

A bunch of definitions for items that range from the 'type' of material (e.g. Yarn, which includes Sheep, Alpaca and Llama wool) to the state of the object (e.g. Empty, for an Empty bag or Empty Barrel). An Item can have multiple adjectives. Adjectives can be very powerful, but are also not entirely obvious what they are. Some useful Adjectives, examples of items with said adjectives, and uses of said adjectives are listed below.
{| class="wikitable"
|-
! Adjective !! Example !! Usage
|-
| Aluminium-bearing items || Native Aluminium || Same as using 'Native Aluminium' material
|-
| Bag-processable items || || For the "Process plant to bag" order
|-
| Bismuth-bearing items|| Bismuthinite || Same as using 'Bismuthinite' material
|-
| Bone items || Yak Bone, Elf Bone, Horse Bone || For checking you have bones before doing bone crafts or making bone bolts. Can also be used to set a minimum number of bone bolts you want
|-
| Clay items || Fire Clay stone, Clay Loam Mug || Useful in combination with 'Stone' type to check how much Clay you have available
|-
| Cookable items || Turkey Egg, Pig Meat, Plump Helmet || Used for checking if you have enough items to make roasts
|-
| Copper-bearing items || Tetrahedrite, Malachite || Used for checking if you have copper ores for making alloy metals out of ores
|-
|Dye Items || Dimple Cup Dye, Hide Root Dye || Used for checking for dye for dye jobs, can be used to set a condition on 'mill plants' jobs
|-
|Dyable items || Pig Tail Cloth, Cave Spider Silk Thread || Used for checking for items to dye with dye jobs
|-
|Dyed items || Pig Tail Cloth, Cave Spider Silk Thread || Used for checking how much dyed items exist
|-
|Empty items || Leather Bag, Large Green Glass Pot || Useful for checking for barrels for brew jobs, and checking for empty bags for jobs that require bags to store objects in
|-
|Fat items || Pig Fat, Yak Fat, Crundle Fat || The adjective for fat that gets turned into Tallow
|-
|Flux items || Chalk Stone, Limestone Stone || Used in Steel and Pig Iron creation
|-
|Food Storage items || Large Gabbro Pot, Oak Barrel || Listed twice in adjectives, unknown why or what difference there is between the two
|-
|Glass items || Green Glass Goblet, Raw Clear Glass || Can be used when cutting raw glass into gems to get a set number of glass gems
|-
|Glazable items || Stoneware Large Pot || Used for checking if there's items to glaze
|-
|Glaze items || || Used for checking there's items to glaze clay items with
|-
|Gold-bearing items || Gold Nuggets || Same as using 'Gold Nugget' material
|-
|Hair/wool items || Yak Thread, Horse Thread || Not the same as Yarn items. Can be used for suturing, but not turned into cloth
|-
|Horn items || Yak Horn || Used for checking items required to make horn crafts
|-
|Iron-bearing items || Hematite, Magnetite || Better to use the specific ores, unless you want to make rock objects out of iron containing ore.
|-
|Ivory/tooth items || || Used for ivory crafts and decorating items with teeth.
|-
|Lead bearing items || Galena || Same as using Galena material
|-
|Lye-bearing items || || Used for checking amount of lye for soap and potash creation
|-
|Lye/milk-free items || Willow Bucket || Used for getting milk and lye, can also use Empty adjective
|-
|Melt-designated items || || Used for checking if there's enough melt-designated objects for 'melt a metal object' order
|-
|Milk items || Yak Milk || Used for making cheese, can check how much milk you have for milk jobs
|-
| Milkable items || Purring Maggots || Only for milking Purring Maggots. Cows are not milkable items.
|-
| Millable items || Hide root plant, Cave Wheat plant || For milling at a quern
|-
| Nickel-bearing items || Garnierite || Same as using material Garnierite
|-
| Non-pressed || Pig Tail Paper Slurry Glob || Used on Plant Slurry to Sheet jobs, can be added to Mash Plant jobs to limit how many Plant Slurry Globs are made
|-
| Oil-bearing items || || Used in soap making from oil
|-
| Paper-slurry || Pig Tail Paper Slurry Glob || Used on Plant Slurry to Sheet jobs, can be added to Mash Plant jobs to limit how many Plant Slurry Globs are made
|-
| Paper-slurryable || Pig Tail, Rope Reed || Used in Mash plant into slurry order, for checking if plants are available for making slurry
|-
| Plant items || Hemp, Hide Root, Sweet Pod, Pig Tail Cloth || Useful for cloth orders. Can check if an item is made of plant cloth through this adjective
|-
| Processable (to barrel) items || || Used for the Process to Barrel order
|-
| Processable (to vial) items || || Used for the Process to vial items
|-
| Renderable items || ||
|-
| Sand-bearing items || Red Sand Bag || Not to be confused with Sand items, which only selects the sand in a bag. For jobs to collect Sand, Sand-bearing items is the one that works
|-
| Shell items || ||
|-
| Silk items || || Useful for cloth orders. Can check if an item is made of silk cloth through this adjective
|-
| Silver-bearing items || Galena Ore || Used for making alloys with Silver
|-
| Soap items || || Can be added to type Bars to check for amount of soap
|-
| Tallow items || || Used for checking if there's enough tallow for soap making jobs
|-
| Tin-bearing items || Cassiterite Ore || same as Cassiterite Material
|-
| Unimproved items || Any item without encrusting || In theory could be used for checking if there's items available to be encrusted
|-
| Written-on items || Written on Quire || Used for checking a quire is ready to be bound into a codex
|-
| Yarn items || Alpaca Wool Bag, Sheep wool thread || Useful for cloth orders. Can check if an item is made of yarn cloth through this adjective
|}

===Work Order Dependency===
This creates a condition where the second work order (the one being created) will only activate if the first work order (the one selected as a condition) either is completed or activated.

==Work Order Examples==

Most work orders that a fortress will need are simple to create, but certain options that a fortress may want are more finicky to create. A set of example work orders for common needs are collated below.

===Process Plants (Plant Thread) with a maximum Plant Thread condition===

This work order will keep a minimum of 20 plant thread, and activate when there are greater than 5 processable plants available.

# Create a 'Process Plants' work order. Set the number of times the task will be performed to 5.
# Ingredients Condition:
## In conditions, add the suggested condition 'unrotten processable plants'.
## adjust the number to be how many plants minimum you want available - in this case, 5 plants minimum will mean this activates only when all 5 process plants tasks can be accomplished.
# Plant Thread Condition:
## Add a Condition to the Work Order.
## Change Type to 'Thread'.
## Change Adj to 'Plant items'.
## Set the number to the maximum Plant Thread you want from this order - in this case, 20.
## Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'less than 20'.

===Collect Sand if there is not enough sand===

This work order will activate if there are at least 5 empty bags, and if there are less than 20 bags of sand.

#Create a 'Collect Sand' work order. Set the number of times the task will be performed to 5.
#Empty Bags condition:
##Add a Condition to the Work Order.
##Set the Type of the item to Bag (specifically 'Bag', not any other sort of bag that has been procedurally generated for instruments).
##Set the Adjective of the item to 'Empty items'.
##Set the amount on the bag condition to 5.
#Sand Bags condition:
##Add a Condition to the Work Order.
##Set the Adjective of the item to 'Sand-Bearing Item'.
##Set the amount on the sand bearing item condition to 20.
##Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'greater than 20'.

===Collect Clay if there is not enough clay===

A work order that will collect clay if there's less than 20 clay available.

#Create a 'Collect Clay' work order.
#Clay Condition:
##Add a Condition to the Work Order.
##Set the Type of the item to 'Stones'.
##Set the Adjective of the item to 'Clay items'.
##Set the amount on the Clay Stones item condition to 20.
##Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'greater than 20'.

===Make Steel Bars automatically===

Using two repeating work orders, steel can be set to automatically be created. In this case the order will make 20 steel bars if there are less than 40 steel bars.

#Create a 'Make Pig Iron Bars' work order. Leave the amount at 10.
#Pig Iron Bars Conditions:
##Under suggested Conditions, select Pig Iron Bars, Iron Bars, Flux Stones, and Refined Coal conditions.
##For Pig Iron Bars, change the Material to 'Steel'. This will change this condition to be based on how much Steel the fortress has. Set the amount on this to 40.
##Set Iron Bars, Flux Stones, and Refined Coal conditions to be '''20'''. This will be the amount of ingredients needed to do 10 Pig Iron bar orders, and then 10 Steel bar orders.
#Create a 'Make Steel Bars' work order. Leave the amount at 10.
#Steel Bars Conditions:
##Select 'Make the activation of the work order depend on the status of another work order'. From this list, select the Pig Iron Bars work order that was already created.
##Press 'Change the frequency that the conditions are checked' once, to make the steel bars order repeat upon completion.
#(Optional, makes things smoother) When the pig iron bars work order activates, add a 'Make the activation of the work order depend on the status of another work order' condition to the Pig Iron Bars work order, to require the Steel bars order to be completed. This will make the two orders loop on each other.

===Make Full Suits of Armor===
Using a repeating order and some clever dependencies, metals can be automatically turned into full suits of armor without an excess number of *«+steel greaves+»*:

#Create a 'Forge' work order, such as 'Forge Steel Breastplate'. Set the amount to 1. This will be the first job used to activate the others
##Under the suggested conditions, select the Bars condition, such as Steel Bars for the above Forge Steel Breastplate. Set the amount at 'at least 13'. You'll have to catch this job while it's running, below, so it's recommended to start with an amount you already have. You'll be revisiting this number later, but 13 should cover any viable kit and then some.
#For each other armor piece, Create a 'Forge' job. Set the amount to 1. Boots and gauntlets are made in pairs, so don't worry about adjusting for those jobs
##Under the conditions, make the job depend on the first. Set to 'When Activated'. This will ensure that multiple forges can make each item in parallel
##Set the job to repeat, since depending on another work order does ''not'' automatically make the job repeatable.
##Not all civilizations have access to all pieces of armor, such as High Boots, so you may have to adjust your ideal suit accordingly. See [[Armor]] for a full list of recommended coverage and bar costs.
#Optionally, add a job for Forging a weapon to go with the suit of armor. '''This is not recommended to leave up indefinitely''', as [[Weapon|weapon usefulness varies so greatly as to make it more viable to have squadrons outfitted with differing weaponry]]. If you must do it this way, use Steel Battleaxes
#While the first set of armour is being made, '''before any of them complete''', edit the first job.
##Make it depend on each other job in the suit. Leave these conditions 'When Completed.' This will ensure the first job does not continue running because there's "enough" metal when that metal is going towards other pieces in the same suit.
##Adjust the trigger amount at least cover a full kit. This will avoid cancellation spam.
##Adjust the trigger amount higher if you want to keep some material in reserve or keep weapons on a separate set of jobs.
##Add further conditions if you're mixing materials, such as leather caps or bronze greaves.

===Shearing animals===

Animals with wool can be sheared roughly every 300 days. Creating a work order that runs each year will mean the animals get sheared whenever they are able to be sheared.

#Create a 'Shear Animal' work order. Set the number to the number of shearable adults in the fortress.
#On the Shear Animal Order, go into conditions and press 'Change the frequency that the conditions are checked' until the order is set to 'Restarts if completed, checked yearly'.
#(Optional) Shear Animal Conditions:
##Add an item condition.
##Set the type to 'Thread'.
##Set the Adjective to 'Yarn items'.
##Set the amount to the maximum yarn thread wanted (<x>).
##Press 'Change the inequality of the condition' until the condition says 'at most <x>' or 'greater than <x>'.
#Create a 'Spin Thread' work order. Set the amount to 5.
#Spin Thread Conditions:
##Under Spin Thread Suggested Conditions, select 'Amount of unrotten hair/wool body part'.
##Set the amount to 5.
##Press 'Change the inequality of the condition' until the condition says 'at least <x>'. This will mean if there are exactly 5 wool body parts it will activate, whereas if the condition is left on 'greater than' it will not.

===Make Soap bars===

Creating Soap if there is not enough soap. In this case, the minimum soap required is 20, and uses Tallow. The same applies to Oil based soap.

#Create a 'Make soap from tallow' work order. Set the amount to 5.
#From suggested conditions, select 'amount of bars', and 'unrotten tallow fatty glob'.
#Set 'amount of bars' to be 20, and 'unrotten tallow fatty glob' to 5.
#Select the adjective of 'amount of bars' to be 'Soap items'.
#Create a new Item condition, set the amount to 5.
#Set the Material of the new item condition to 'Lye'.
#Set the Type of the new item condition to 'Liquid'.

===Make bone bolts===

Creating bone bolts if you do not have 50 bone bolts, and have at least 5 bones.

#Create a 'Make bone bolts' work order. Set the amount to 5.
#From suggested conditions, select 'bolts' and 'unrotten bone body part'.
#Set the amount on 'unrotten bone body part' to 5.
#Set the amount on 'bolts' to 50.
#Add the adjective 'Bone items' to the 'bolts' condition.

===Make wooden furniture based on amount of wooden furniture available===

For creating a variety of wooden furniture not of a specific material, the Plant adjective can be used to check that a certain amount of wood furniture has been created. This example talks about Tables, but this can be applied to any wooden item.

#Create a 'Make wooden table' work order.
#From suggested conditions, select 'Amount of tables'.
#On the 'Amount of Tables' condition, add the 'Plant items' adjective.

==Bugs/Finicky UI==
===Adjectives===
When changing the adjective of an item condition in a work order, because you can select multiple adjectives there is no automatic return to the work order conditions. To leave, you will want to Right-Click, which'll take you back to the Work Order menu, and then select the work order you're working on again.

===Materials===
A new bug with v.50 is when selecting a material type for a job. If you select a material type but do not do it fast enough or pause the game and the job is confirmed by the manager before you change it then any material will be used for the job instead of the restricted material. An example is when setting up a job to make only rock salt doors but you do not select rock salt before the job is confirmed or you go back later and decide you only want rock salt doors, the material type is not respected and any stone will continue to be used until you cancel the order.

==See also==
* [[Manager]]

Work orders

2023-03-27T21:39:49Z

Qeveren: /* Work Order Examples */ Punctuation corrections

{{av}}
[[File:Work order premium.png|thumb|300px|right|A busy fortress' work order menu.]]

Work orders are an advanced feature of [[Workshop#Management|Workshop Management]] that becomes available with a [[Manager]]. It allows easier management, automation and/or fine control of the various activities needed to maintain a well-oiled fort. The work order screen lists all work orders in the fortress, shows their status and allows to modify them and place new general orders. It is accessed from the main screen through the work order menubutton (the clipboard icon in the bottom left). Keyboard shortcut : {{k|o}}

==Work Order Conditions==

Work Order Conditions are incredibly versatile and equal parts daunting. There are various options that can be selected as conditions:
===Frequency Condition===
This decides how often (if any) the work order will repeat. If there are no other conditions, the options are:

* One-time order
* Restarts if completed, checked daily
* Restarts if completed, checked monthly
* Restarts if completed, checked seasonally
* Restarts if completed, checked yearly

If there are other conditions, the options are:
* One-time order, conditions checked daily
* One-time order, conditions checked monthly
* One-time order, conditions checked seasonally
* One-time order, conditions checked yearly
* Restarts if completed, conditions checked daily
* Restarts if completed, conditions checked monthly
* Restarts if completed, conditions checked seasonally
* Restarts if completed, conditions checked yearly

===Item Condition===

By far the most complex condition, and the most common one used.

Each Item condition has a set of parameters:

* Amount
* Equality
* Type
* Material
* Adjective

Unless specifically stated, the Type, Materials and Adjectives default to 'Any'

====Amount and Equality====
The part of the condition that states when it is true or false. Amount is the number it activates on, equality is one of the following:

* At Least (At Least 5 will activate on 5 or more)
* At Most (At Most 5 will activate on 5 or less)
* Greater Than (Greater Than 5 will activate on 6 or more)
* Less Than (Less Than 5 will activate on 4 or less)
* Exactly (Exactly 5 will activate on only 5)
* Not (Not 5 will activate on any number other than 5)

====Type====

The type of object. Examples include Thread, Bar, Cloth, Breastplate, Stone, Fish, Plants.

====Material====

The exact material an object is made from. Examples include Yak Tallow, Cat Soap, Hide Root Plant, Hide Root Seed, Steel, Hematite.

====Adjectives====

A bunch of definitions for items that range from the 'type' of material (e.g. Yarn, which includes Sheep, Alpaca and Llama wool) to the state of the object (e.g. Empty, for an Empty bag or Empty Barrel). An Item can have multiple adjectives. Adjectives can be very powerful, but are also not entirely obvious what they are. Some useful Adjectives, examples of items with said adjectives, and uses of said adjectives are listed below.
{| class="wikitable"
|-
! Adjective !! Example !! Usage
|-
| Aluminium-bearing items || Native Aluminium || Same as using 'Native Aluminium' material
|-
| Bag-processable items || || For the "Process plant to bag" order
|-
| Bismuth-bearing items|| Bismuthinite || Same as using 'Bismuthinite' material
|-
| Bone items || Yak Bone, Elf Bone, Horse Bone || For checking you have bones before doing bone crafts or making bone bolts. Can also be used to set a minimum number of bone bolts you want
|-
| Clay items || Fire Clay stone, Clay Loam Mug || Useful in combination with 'Stone' type to check how much Clay you have available
|-
| Cookable items || Turkey Egg, Pig Meat, Plump Helmet || Used for checking if you have enough items to make roasts
|-
| Copper-bearing items || Tetrahedrite, Malachite || Used for checking if you have copper ores for making alloy metals out of ores
|-
|Dye Items || Dimple Cup Dye, Hide Root Dye || Used for checking for dye for dye jobs, can be used to set a condition on 'mill plants' jobs
|-
|Dyable items || Pig Tail Cloth, Cave Spider Silk Thread || Used for checking for items to dye with dye jobs
|-
|Dyed items || Pig Tail Cloth, Cave Spider Silk Thread || Used for checking how much dyed items exist
|-
|Empty items || Leather Bag, Large Green Glass Pot || Useful for checking for barrels for brew jobs, and checking for empty bags for jobs that require bags to store objects in
|-
|Fat items || Pig Fat, Yak Fat, Crundle Fat || The adjective for fat that gets turned into Tallow
|-
|Flux items || Chalk Stone, Limestone Stone || Used in Steel and Pig Iron creation
|-
|Food Storage items || Large Gabbro Pot, Oak Barrel || Listed twice in adjectives, unknown why or what difference there is between the two
|-
|Glass items || Green Glass Goblet, Raw Clear Glass || Can be used when cutting raw glass into gems to get a set number of glass gems
|-
|Glazable items || Stoneware Large Pot || Used for checking if there's items to glaze
|-
|Glaze items || || Used for checking there's items to glaze clay items with
|-
|Gold-bearing items || Gold Nuggets || Same as using 'Gold Nugget' material
|-
|Hair/wool items || Yak Thread, Horse Thread || Not the same as Yarn items. Can be used for suturing, but not turned into cloth
|-
|Horn items || Yak Horn || Used for checking items required to make horn crafts
|-
|Iron-bearing items || Hematite, Magnetite || Better to use the specific ores, unless you want to make rock objects out of iron containing ore.
|-
|Ivory/tooth items || || Used for ivory crafts and decorating items with teeth.
|-
|Lead bearing items || Galena || Same as using Galena material
|-
|Lye-bearing items || || Used for checking amount of lye for soap and potash creation
|-
|Lye/milk-free items || Willow Bucket || Used for getting milk and lye, can also use Empty adjective
|-
|Melt-designated items || || Used for checking if there's enough melt-designated objects for 'melt a metal object' order
|-
|Milk items || Yak Milk || Used for making cheese, can check how much milk you have for milk jobs
|-
| Milkable items || Purring Maggots || Only for milking Purring Maggots. Cows are not milkable items.
|-
| Millable items || Hide root plant, Cave Wheat plant || For milling at a quern
|-
| Nickel-bearing items || Garnierite || Same as using material Garnierite
|-
| Non-pressed || Pig Tail Paper Slurry Glob || Used on Plant Slurry to Sheet jobs, can be added to Mash Plant jobs to limit how many Plant Slurry Globs are made
|-
| Oil-bearing items || || Used in soap making from oil
|-
| Paper-slurry || Pig Tail Paper Slurry Glob || Used on Plant Slurry to Sheet jobs, can be added to Mash Plant jobs to limit how many Plant Slurry Globs are made
|-
| Paper-slurryable || Pig Tail, Rope Reed || Used in Mash plant into slurry order, for checking if plants are available for making slurry
|-
| Plant items || Hemp, Hide Root, Sweet Pod, Pig Tail Cloth || Useful for cloth orders. Can check if an item is made of plant cloth through this adjective
|-
| Processable (to barrel) items || || Used for the Process to Barrel order
|-
| Processable (to vial) items || || Used for the Process to vial items
|-
| Renderable items || ||
|-
| Sand-bearing items || Red Sand Bag || Not to be confused with Sand items, which only selects the sand in a bag. For jobs to collect Sand, Sand-bearing items is the one that works
|-
| Shell items || ||
|-
| Silk items || || Useful for cloth orders. Can check if an item is made of silk cloth through this adjective
|-
| Silver-bearing items || Galena Ore || Used for making alloys with Silver
|-
| Soap items || || Can be added to type Bars to check for amount of soap
|-
| Tallow items || || Used for checking if there's enough tallow for soap making jobs
|-
| Tin-bearing items || Cassiterite Ore || same as Cassiterite Material
|-
| Unimproved items || Any item without encrusting || In theory could be used for checking if there's items available to be encrusted
|-
| Written-on items || Written on Quire || Used for checking a quire is ready to be bound into a codex
|-
| Yarn items || Alpaca Wool Bag, Sheep wool thread || Useful for cloth orders. Can check if an item is made of yarn cloth through this adjective
|}

===Work Order Dependency===
This creates a condition where the second work order (the one being created) will only activate if the first work order (the one selected as a condition) either is completed or activated.

==Work Order Examples==

Most work orders that a fortress will need are simple to create, but certain options that a fortress may want are more finicky to create. A set of example work orders for common needs are collated below.

===Process Plants (Plant Thread) with a maximum Plant Thread condition===

This work order will keep a minimum of 20 plant thread, and activate when there are greater than 5 processable plants available.

# Create a 'Process Plants' work order. Set the number of times the task will be performed to 5.
# Ingredients Condition:
## In conditions, add the suggested condition 'unrotten processable plants'.
## adjust the number to be how many plants minimum you want available - in this case, 5 plants minimum will mean this activates only when all 5 process plants tasks can be accomplished.
# Plant Thread Condition:
## Add a Condition to the Work Order.
## Change Type to 'Thread'.
## Change Adj to 'Plant items'.
## Set the number to the maximum Plant Thread you want from this order - in this case, 20.
## Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'less than 20'.

===Collect Sand if there is not enough sand===

This work order will activate if there are at least 5 empty bags, and if there are less than 20 bags of sand.

#Create a 'Collect Sand' work order. Set the number of times the task will be performed to 5.
#Empty Bags condition:
##Add a Condition to the Work Order.
##Set the Type of the item to Bag (specifically 'Bag', not any other sort of bag that has been procedurally generated for instruments).
##Set the Adjective of the item to 'Empty items'.
##Set the amount on the bag condition to 5.
#Sand Bags condition:
##Add a Condition to the Work Order.
##Set the Adjective of the item to 'Sand-Bearing Item'.
##Set the amount on the sand bearing item condition to 20.
##Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'greater than 20'.

===Collect Clay if there is not enough clay===

A work order that will collect clay if there's less than 20 clay available.

#Create a 'Collect Clay' work order.
#Clay Condition:
##Add a Condition to the Work Order.
##Set the Type of the item to 'Stones'.
##Set the Adjective of the item to 'Clay items'.
##Set the amount on the Clay Stones item condition to 20.
##Press 'Change the inequality of the condition' until the condition says 'at most 20' or 'greater than 20'.

===Make Steel Bars automatically===

Using two repeating work orders, steel can be set to automatically be created. In this case the order will make 20 steel bars if there are less than 40 steel bars.

#Create a 'Make Pig Iron Bars' work order. Leave the amount at 10.
#Pig Iron Bars Conditions:
##Under suggested Conditions, select Pig Iron Bars, Iron Bars, Flux Stones, and Refined Coal conditions.
##For Pig Iron Bars, change the Material to 'Steel'. This will change this condition to be based on how much Steel the fortress has. Set the amount on this to 40.
##Set Iron Bars, Flux Stones, and Refined Coal conditions to be '''20'''. This will be the amount of ingredients needed to do 10 Pig Iron bar orders, and then 10 Steel bar orders.
#Create a 'Make Steel Bars' work order. Leave the amount at 10.
#Steel Bars Conditions:
##Select 'Make the activation of the work order depend on the status of another work order'. From this list, select the Pig Iron Bars work order that was already created.
##Press 'Change the frequency that the conditions are checked' once, to make the steel bars order repeat upon completion.
#(Optional, makes things smoother) When the pig iron bars work order activates, add a 'Make the activation of the work order depend on the status of another work order' condition to the Pig Iron Bars work order, to require the Steel bars order to be completed. This will make the two orders loop on each other.

===Make Full Suits of Armor===
Using a repeating order and some clever dependencies, metals can be automatically turned into full suits of armor without an excess number of *«+steel greaves+»*:

#Create a 'Forge' work order, such as 'Forge Steel Breastplate'. Set the amount to 1. This will be the first job used to activate the others
##Under the suggested conditions, select the Bars condition, such as Steel Bars for the above Forge Steel Breastplate. Set the amount at 'at least 13'. You'll have to catch this job while it's running, below, so it's recommended to start with an amount you already have. You'll be revisiting this number later, but 13 should cover any viable kit and then some.
#For each other armor piece, Create a 'Forge' job. Set the amount to 1. Boots and gauntlets are made in pairs, so don't worry about adjusting for those jobs
##Under the conditions, make the job depend on the first. Set to 'When Activated'. This will ensure that multiple forges can make each item in parallel
##Set the job to repeat, since depending on another work order does ''not'' automatically make the job repeatable.
##Not all civilizations have access to all pieces of armor, such as High Boots, so you may have to adjust your ideal suit accordingly. See [[Armor]] for a full list of recommended coverage and bar costs.
#Optionally, add a job for Forging a weapon to go with the suit of armor. '''This is not recommended to leave up indefinitely''', as [[Weapon|weapon usefulness varies so greatly as to make it more viable to have squadrons outfitted with differing weaponry]]. If you must do it this way, use Steel Battleaxes
#While the first set of armour is being made, '''before any of them complete''', edit the first job.
##Make it depend on each other job in the suit. Leave these conditions 'When Completed.' This will ensure the first job does not continue running because there's "enough" metal when that metal is going towards other pieces in the same suit.
##Adjust the trigger amount at least cover a full kit. This will avoid cancellation spam.
##Adjust the trigger amount higher if you want to keep some material in reserve or keep weapons on a separate set of jobs.
##Add further conditions if you're mixing materials, such as leather caps or bronze greaves.

===Shearing animals===

Animals with wool can be sheared roughly every 300 days. Creating a work order that runs each year will mean the animals get sheared whenever they are able to be sheared.

#Create a 'Shear Animal' work order. Set the number to the number of shearable adults in the fortress.
#On the Shear Animal Order, go into conditions and press 'Change the frequency that the conditions are checked' until the order is set to 'Restarts if completed, checked yearly'.
#(Optional) Shear Animal Conditions
##Add an item condition.
##Set the type to 'Thread'.
##Set the Adjective to 'Yarn items'.
##Set the amount to the maximum yarn thread wanted (<x>).
##Press 'Change the inequality of the condition' until the condition says 'at most <x>' or 'greater than <x>'.
#Create a 'Spin Thread' work order. Set the amount to 5.
#Spin Thread Conditions:
##Under Spin Thread Suggested Conditions, select 'Amount of unrotten hair/wool body part'.
##Set the amount to 5.
##Press 'Change the inequality of the condition' until the condition says 'at least <x>'. This will mean if there are exactly 5 wool body parts it will activate, whereas if the condition is left on 'greater than' it will not.

===Make Soap bars===

Creating Soap if there is not enough soap. In this case, the minimum soap required is 20, and uses Tallow. The same applies to Oil based soap.

#Create a 'Make soap from tallow' work order. Set the amount to 5.
#From suggested conditions, select 'amount of bars', and 'unrotten tallow fatty glob'.
#Set 'amount of bars' to be 20, and 'unrotten tallow fatty glob' to 5.
#Select the adjective of 'amount of bars' to be 'Soap items'.
#Create a new Item condition, set the amount to 5.
#Set the Material of the new item condition to 'Lye'.
#Set the Type of the new item condition to 'Liquid'.

===Make bone bolts===

Creating bone bolts if you do not have 50 bone bolts, and have at least 5 bones.

#Create a 'Make bone bolts' work order. Set the amount to 5.
#From suggested conditions, select 'bolts' and 'unrotten bone body part'.
#Set the amount on 'unrotten bone body part' to 5.
#Set the amount on 'bolts' to 50.
#Add the adjective 'Bone items' to the 'bolts' condition.

===Make wooden furniture based on amount of wooden furniture available===

For creating a variety of wooden furniture not of a specific material, the Plant adjective can be used to check that a certain amount of wood furniture has been created. This example talks about Tables, but this can be applied to any wooden item.

#Create a 'Make wooden table' work order.
#From suggested conditions, select 'Amount of tables'.
#On the 'Amount of Tables' condition, add the 'Plant items' adjective.

==Bugs/Finicky UI==
===Adjectives===
When changing the adjective of an item condition in a work order, because you can select multiple adjectives there is no automatic return to the work order conditions. To leave, you will want to Right-Click, which'll take you back to the Work Order menu, and then select the work order you're working on again.

===Materials===
A new bug with v.50 is when selecting a material type for a job. If you select a material type but do not do it fast enough or pause the game and the job is confirmed by the manager before you change it then any material will be used for the job instead of the restricted material. An example is when setting up a job to make only rock salt doors but you do not select rock salt before the job is confirmed or you go back later and decide you only want rock salt doors, the material type is not respected and any stone will continue to be used until you cancel the order.

==See also==
* [[Manager]]

Caravan

2023-03-05T21:50:06Z

Qeveren: /* Movement & Access to Depot */ Added info about stairs/traps blocking wagon access.

{{av}}

[[File:Oregon trail.png|thumb|Illustration of a caravan]]
'''Caravans''' facilitate the transfer of goods between [[site]]s. Merchant caravans from the Mountainhome and neighboring friendly civilizations will arrive throughout the year, looking to [[trade]], and if you "make contact" with other civilizations by sending a [[raid]] to "demand tribute", those civilizations' sites might be convinced to send a caravan of their own afterwards, *on top* of [[tribute]] 'caravans' and even if your demand fails. This means you could have multiple caravans in the same season for a given race, possibly at the same time.

Merchant caravans often use pack animals and [[wagon]]s to carry their goods, accompanied by guards for protection. An arrival of a caravan will trigger an announcement message (at the bottom of your screen) informing you that a caravan has arrived. They will appear on the edge of the map and proceed to move towards the [[trade depot]] where they will unload their goods. If caravans are unable to find a path to your trade depot (or if you have not built a depot at all), they will bypass your site. They may also turn around if they become spooked by wildlife or corpses, ambushed by [[goblin]]s or any other [[siege|enemy forces]], or if it takes too long to reach the trade depot (though that would require weeks of travel while on the map).

Caravans will embark on their journey back exactly one month (28 days) after their arrival, whether they have succeeded in reaching the depot or not. Note that if the caravan team or their animals are delayed and prevented from leaving, they will eventually go [[insane]]. Merchants and diplomats go insane if they are unable to reach the map edge within 25 days of having finished their business at your fortress; for diplomats, this is when they end the meeting and try to leave, and with merchants it's when they've finished packing everything up.

== Types of Caravans ==
=== Trade ===
: ''Further: [[Trade]]''

Trading caravans are useful for getting supplies not available in the player's fortress area. A caravan from the mountainhome and various friendly civilization you are in contact with will visit the fortress on a yearly basis, linked to one season, which is spring for elves, summer for humans, and autumn for dwarves - no race trades in winter by default.

Caravans will only show up if that race considers the fortress site both accessible (as denoted on the embark screen) and "worth the effort" (as determined by the [PROGRESS_TRIGGER_*] tokens in the entity definition), with the exception of dwarves, who always arrive unless they are extinct.

=== Tribute ===
: ''Further: [[Mission#Tribute]]''

If your fortress performs a successful [[Mission]] to "demand tribute", whether it be one-time or annual, that site will also send a caravan, once a year. They usually arrive at the start of a season, and that season can be specified by you (including Winter) at the time of the mission. No actual "trading" or [[broker]] is involved, they simply drop off the goods at your depot and then leave, without speaking to any of your dwarves. [[Tribute]] caravans tend to be relatively small, but they are guarded. You don't have any control over the content of the tribute. What they bring depends on the civilization's available materials, the site's size and tracked items and so forth, and may range from excessively mundane (like a bunch of average quality clothing) to extremely useful (like exotic animals). Notably, tributes are one of the few ways to obtain evil animals tamed by goblins such as [[beak dog]]s for instance.

As stated above, tributes are also one of the few ways to "contact" another civilization without triggering an outright war and therefore ensure that it will send out regular caravans afterwards, *on top* of the tribute caravans it'll be sending and even if your tribute demand failed.

: (* "Tribute" caravans do not Trade - they simply arrive, drop their tribute off at your depot and leave, no Broker or conversation involved or possible.)

== Mechanic ==
=== Movement & Access to Depot===
Caravans appear to enter the map from a random direction, one which does not necessarily coincide with the relative direction of the originating [[civilization]] on the world map, and they may appear from different directions and z-levels each year. However, they will always arrive at a location with a wagon-navigable path to the [[Trade depot|Trade Depot]] when one is available. Site-bisecting features like rivers will limit them to appear on a specific side, if only one side has an accessible path to your Depot. While caravan traders and pack animals may use stairs and cross traps in order to access your depot, wagons cannot do so and will not spawn if a clear path without stairs or traps is not available.

Caravans can usually be restricted to show up in a specific spot on the map edge, but under some circumstances they will insist on showing up on one particular side of the map. The current theory is that this is caused by major rivers on the world map (i.e. the caravan can't cross the river outside your embark region, so it always shows up on one side).

Also worth mentioning is the [[path]]ing behavior of the entire caravan. If one member of the caravan reaches an obstacle in their chosen path (i.e. a raised drawbridge that was lowered when they entered the map) the entire caravan will re-path, instead of encountering the obstacle one by one. This behavior can be useful when attempting to free "stuck" wagons - a trader on foot encountering a locked door will cause the stuck wagons to turn around and path to a different entrance/exit, if available.

=== Destruction ===
If caravans are destroyed (intentionally or unintentionally), the items may remain for use. Caravans caught in a [[cave-in]] will flee as if they were attacked, but will leave all the items dropped by the caravan behind. Pack animals carrying items are affected just like a normal tamed [[mule]] and must be killed in the cave-in for them to drop items on the ground. It is however much more likely that the pack animals will only be stunned or rendered unconscious, and flee shortly after recovering from the hit.

While caravans can defend themselves, they don't like being ambushed. If a caravan becomes terrified by wildlife or horrified by corpses it will turn around and flee the map. Any event resulting in the death of any merchant or pack animal will also cause them to retreat and forget about trading with you for the season. Repeated caravan destruction (intentional or unintentional) will strain diplomatic relations and may result in a [[siege]].

Ambushing or seizing a caravan and letting a survivor escape seems to have a more detrimental effect than simply annihilating the whole caravan. (Presumably because you've left a witness to report what happened.)

Overall, a given caravan visit can have a number of "problems" which will affect your relations with their civilization:
#"never seen again" - The entire caravan was destroyed and nobody left the map.
#"suffered hardships" - One or more merchants were killed, but some of them survived long enough to leave the map.
#"seized goods" - You seized goods from the caravan and they left.
#"offended" - You tried to trade wooden items to the Elves.
#"missing goods" - The value of the caravan's goods when they left was less than what it was when they arrived (i.e. they had a net loss).

All of these will make the parent civilization unhappy, though some more than others. They take offence to both accidents and hostile acts - accidents just annoy them slightly less. In the case of elven merchants, they will take offence to your actions and bring fewer goods next year, do it too many times and they will declare war on you.

=== Caravan Delay ===
If a caravan has arrived at your trade depot and is unable to leave for about two months after they finished packing up their goods, the merchants and animals will go insane. This can result in a bunch of merchants attacking your dwarves, or just standing around moping until they starve to death. It is not known for certain if this hurts diplomatic relations, but most likely it's the same as any case where the entire caravan fails to return home.

If you have locked the caravan into your fortress to hold out against a siege, it's a good idea to station a squad of soldiers near the trade depot in case the merchants [[Insanity#Types|go berserk]]. You may also want to make the depot a restricted area to encourage civilians to go around it. Alternatively, you can design the trade depot using drawbridges, so that it can be sealed off from the rest of the fortress during a siege.

If you want the merchants to leave safely, you can build four or more tunnels to each corner of the map, connected to your fortress only by drawbridges. As long as there is no other way to enter and exit your fortress, invaders and merchants will both go towards any tunnel that you activate. You can lock the merchants into the trade depot, and then open a tunnel entrance on one side of the map to make the invaders head towards that tunnel. When they get close to it, you can close it, and then open the entrance on the other side of the map, and let the merchants out of the depot. If your fortress and depot are in the middle of the map, this will give the merchants quite a head-start to get away.

Merchants can leave the map from any map edge-- including underground and aboveground map edges. If an unobstructed path through your fortress reaches a cavern edge, then blocking all overland paths will cause the merchants to depart underground. This can be useful, if you're suffering a prolonged siege; it can also be dangerous, if your underground regions are less secure than your surface. While it requires more preparation, an elevated bridge to a map edge can also allow merchants to depart in peace.

Caravan guards cannot be starved, dehydrated, or driven to insanity if prevented from leaving, their employers and animals can, however.

If a large amount of items is sold / offered to the caravan, it may take a while to load it all, especially if you chose to keep your precious bins and traded your items individually.

== Bugs ==

*Caravans become terrified/horrified very easily, abandon their wagons, and flee. {{bug|7185}}
*Wagons can occasionally become "stuck" on other wagons, walls, etc. Stuck wagons eventually deconstruct, leaving their merchandise behind. {{Bug|5687}}
*If a caravan attempts to leave in late Winter/early Spring, they may try to path over any large frozen body of water. If the water thaws while the caravan is on it, the caravan will become magically stuck in mid-air until either the water refreezes or a floor is built underneath it. At this point, if they are still alive, they will leave the map normally.
*When merchants leave with an animal, the merchants seem to be dragging their beast of burden instead of leading it. If the animal is incapacitated but not dead, the merchant will continue to walk at the same speed, dragging the unconscious beast.
*If a merchant's chosen map edge exit is guarded by a hostile creature (including those on a [[restraint]]), the merchant will wander back and forth repeatedly and eventually go insane rather than path to an alternate exit.

{{Category|Trade| }}

Exploit

2023-02-17T01:58:29Z

Qeveren: /* Dwarven rocket elevator */ Corrected minecart link to v50 version

{{migrated article}}
{{Quality|Unrated}}
{{av}}

An '''exploit''' is a quirk of a game that allows players to gain what other players may consider an unfair advantage, usually by making use of a feature that is not working properly or which defies logic. 'Exploiting the game' is distinct from '[[cheating]]' because exploits occur within the game as written and do not need any external [[utilities]] or [[modding]]. Whether a player chooses to make use of an exploit or not depends on their personal taste; given that ''[[Dwarf Fortress]]'' is a single-player game, the user alone can decide what liberties to take and what options to shun. Among DF players, there is much discussion about what actually should be considered an exploit, ranging from making [[dwarven syrup]] instead of [[dwarven sugar]], growing crops in winter, or even underground, at the one extreme, to justifying 'water wheel batteries' at the other. This page takes a rather relaxed approach in that you considering it an exploit is basically enough to add it, if you don't get too much opposition.

= Fortress mode exploits =

== Atom smasher ==
{{main|Dwarven atom smasher}}
Lowering a raised [[drawbridge]] can be used to obliterate most creatures or items beneath it, with some exceptions:

* Atom smashing a creature with a size over 1200000 will destroy the drawbridge.
* [[Contaminant]]s are unaffected.
* Smashing a bag of something will destroy the bag, but spill its contents.
* [[Artifact]]s have a special exception; whereby upon being atom-smashed, they will be "hidden" and inaccessible for the rest of the playthrough. See the main article for further details.

==Manager exercise program==
As a [[manager]], skill is gained as tasks are ''approved'', not completed. Simply by queuing lots of jobs ({{key|j}} {{key|m}} {{key|q}}) and providing a meager office, the manager will quickly level to [[legendary]] as an [[Organizer]]. The tasks can then be removed once approved.

==Merchant swindles==
There are a variety of ways to steal cargo from [[merchant]]s. All amount to naked theft, and the civilization responsible for the caravan will recognize this. Merchants will consider any lost goods to be stolen goods regardless of the method used to take possession of or destroy them (Verification: See [[40d:Trading#Note_that_the_civ|the 40d page]] and [http://www.bay12forums.com/smf/index.php?topic=43771.msg829692#msg829692 This forum post]). So unless you specifically want to take the clothing off the backs of the merchants or steal from your own civ, you might as well just seize the goods anyway.

* [[DF2014:Trading#Seizing_items|Seizing goods via the trade dialog]] is most straightforward way to select specific items to steal; but there are more entertaining methods detailed below.

* Tearing down the [[trade depot]] while the merchants are there is the easiest way to seize all merchant goods at once.

* Marking items for [[dump]]ing, using view creature mode ({{key|v}}), the stocks menu ({{key|z}}), items in room mode ({{key|t}}), or mass dump mode ({{key|d}})-({{key|b}})-({{key|d}}) then marking the entire depot, lets you relieve merchants of their goods. Just reclaim the items from your garbage dump [[zone]] later. You can even take clothing and equipment off merchant and guards this way.

* You can make a wall around the merchants (and even the poor animals) and let them starve to death, letting you take whatever you want. Wait quite a while for them to starve. They will become [[Insanity|very angry]] if you do, so never open the door once they are on the brink of death.

== Quantum stockpiles ==
{{main|Quantum stockpile}}
A quantum stockpile (QSP) allows you to store an infinite number of items in a single tile. QSPs can make for super efficient storage, allowing more compact fortresses, shorter hauling routes, more efficient manufacturing flows, and stocktaking at a glance with look {{K|k}}.

== Building destroyer door ==
Forbid something a dwarf is carrying as he goes through a door, and he'll drop it. The door won't close and won't stop any normal creature from going through, but building destroyers seem to stop in their tracks, waiting for it to close before moving on. Note: your civilians can pass the creature safely, but attacking it cancels your protection. {{Verify}}

== HFS's back door ==
{{main|Semi-molten rock#Tunnelling down through multiple layers of Semi-molten rock|l1=Semi-molten rock § Tunnelling down through multiple layers of Semi-molten rock}}
There's a convoluted way to dig down through [[semi-molten rock]] and evade the head-on encounter with [[hidden fun stuff]]. Doing this can enable you to, among other things, mine undiggable [[slade]] and duplicate rare minerals. See the page [[semi-molten rock]] for details.

== Forgotten beast zoo ==
Wall off all the passageways into your lowest level at the outermost square of the map - except one, which leads to a little vestibule surrounded by fortifications. Wave hello to the various ungainly "[[forgotten beast]]s" which accumulate inside.

Alternatively, by using a [[giant cave spider]] or web-spewing forgotten beast to place [[web]]s on cage traps you can capture and display non-web-spewing forgotten beasts, titans, and more.

== Dwarven water reactor ==
{{main|Water wheel#Perpetual motion|l1=Water wheel § Perpetual motion}}
A [[screw pump]] requires 10 power to move water; a [[water wheel]] supplies 100 power if it's got water moving it. Arrange the former to feed the latter, while the latter powers the former, and you can get [[Water wheel#Perpetual motion|perpetual motion]] going - with a surplus of [[power]] available.

== And we'll throw in the barrel or bag for free ==
On [[embark]], buying things which are stored in [[barrel]]s gets the barrel for free, with at most 10 items per barrel, so, for example, the 15 units of randomly chosen [[meat]] which come with the default supplies will get you two free barrels, one completely filled with 10 units of meat and one half filled with 5 units of meat; you get another two free barrels from the 15 units of randomly chosen [[Creature#Aquatic|fish]]. You can get rid of all of that food, then for the same cost select one unit each of meat from 30 different kinds of animals, giving you 30 free barrels instead of only 4, since each different kind of animal meat is put in its own barrel. Note that different types of meat from the same kind of animal goes into a single barrel, so choosing 1 yak brain + 1 yak eye + 1 yak spleen will get you only one free barrel instead of three.

The same thing goes for things stored in [[bag]]s. Each unit of [[sand]] comes in its own bag, and since each unit of sand costs only 1 embark point while bags cost a minimum of 10 embark points each, you can get bags for ten times cheaper by buying sand, then [[dumping]] out the sand after embark.

One down side is that all those containers then need to be individually hauled from the wagon to where ever you want them.

== Infinite metal ==
Because one bar of metal produces 25 bolts, and a single bolt can be melted to 0.1 bars of metal, you can create unlimited adamantine wafers in your fortress using a [[Stupid_dwarf_trick#Bolt_Splitting_Operation|clever setup]] with marksdwarves to separate the stacks of adamantine bolts into single bolts. See this [http://www.bay12forums.com/smf/index.php?topic=51423.0 forum thread] for more details.

Weapon traps filled with crossbows will be loaded with individual bolts (10 per crossbow). Bolts cannot be designated to melt while loaded in the trap. It requires deconstruction of the trap. The components will scatter on deconstruction so surrounding the trap with an ammo stockpile set to links only and using dfhack automelt can semi-automate the process. Any metal components of the trap may also be melted.

Coins may also be split at a [[trade depot]] and melted down individually for up to a 50x return. Mint a stack of coins, then trade it to a caravan. You can then buy the stack back in pieces, and each individual smaller stack will melt and produce .1 bars. One bar produces 500 coins, but splitting it into stacks of 1 coin each would create 500 melt jobs, producing 50 bars in return. The process is discussed in greater detail, both with and without use of macros on this [http://www.bay12forums.com/smf/index.php?topic=111680.0 forum thread]. While potentially time-consuming, this new method both results in far more bars produced per stack (potentially a net profit of 49 bars instead of 1.5), and can duplicate any metal, not just military ones while simultaneously training your broker. Combined with a magma smelter and properly written macros, this method turns a smelter into a free metal generator. Those who are less patient may instead opt to simply melt the coin stacks immediately after they are minted - while this yields only a 10% gain, it is far less time-consuming.

Recent dwarven !!SCIENCE!! has shown that certain visitors react badly to being trapped in a vault of treasure and can be used to [https://www.reddit.com/r/dwarffortress/comments/fql316/infinite_adamantine_using_elf_labor/ rapidly split stacks of coins]. Be careful what you wish for.

For multiplying weapons/armor-grade metals, forging and melting giant axe blades, enormous corkscrews, menacing spikes, and leggings will yield a 50% gain per item; note that this does ''not'' work with adamantine, since adamantine goods require 3 times as many wafers, instead leading to a 70% loss per item.

See the [[Melt item]] article for the best yields when melting down items made of mundane metals for the current version.

== Quick trade goods ==
[[Bolt|Bolts]], having a high stack size and being affected by quality modifiers, make excellent trade goods when made by a highly trained woodcrafter or metalsmith. This is because quality adds a flat amount to ''each bolt'''s value, going as high as 375☼ on exceptional, and 750☼ on masterwork bolts, making even cheap wooden bolts a quick way of buying out caravans.

[[Prepared meal]]s can be quick and valuable trade goods - purchase an abundance of raw food when the traders arrive, and set your [[kitchen]] to work cooking that food into lavish meals, then haul the stacks of meals back to the depot and trade them for whatever supplies you really want. The caravan will buy back meals composed of their own ingredients at 25x to 100x their initial value.

Single task [[instruments]] can also be a very lucrative business, although glass instruments have lower gains.

== Silk farm ==
{{main|Silk farming}}
A silk farm can serve as a safe and endless source of silk thread from [[giant cave spider]]s or other [[forgotten beast|web-spewing beasts]]. Its essence is a room with a "bait" creature separated from a web-spewing creature by fortifications. The webber will attempt to attack the "bait" by shooting [[web]]s through the fortifications. Weavers can collect the webs as silk thread and create silk cloth.

== Dwarven road-dar ==
Dwarven radar is a handy way of checking for caverns and other special features using the [[farm plot]]s, paved [[road]]s, and [[activity zone]]s. Know where the caverns are before you designate your carefully planned, fully symmetric living quarters!

For more details, see the [http://www.bay12forums.com/smf/index.php?topic=93694.0 forum thread].

== Danger room ==
{{Main|Danger room}}
An [[Trap#Upright Spear/Spike|upright spike trap]] full of non-masterwork training spears (''not'' menacing spikes or metal spears, or even [[elf|elven]] wooden spears) is linked to a [[lever]], which is pulled repeatedly, and dwarves are stationed on the trap. The dwarves quickly learn how to dodge, block and parry these "attacks", gaining [[combat skill]]s much more quickly than through normal [[training]], unless they die.

This exploit does not work in newer versions due to changes to damage propagation.{{version|0.43.04}}

== Coinstar room ==
{{Main|Danger room#Coinstar room|l1=Danger room § Coinstar room}}
A coinstar or popcorn room trains [[armor user]] skills via repeated (unblockable/undodgeable) impacts of various small objects such as [[coin]]s, [[seed]]s, [[sock]]s, [[leaves]], or other small, light objects. Channel a 1x2 trench (leaving ramps), and build two 1x1 '''retracting''' bridges on the bottom of the trench. Connect the bridges to a lever. Add coins (stacks of 15 or smaller are 100% safe) and dwarves.

This exploit does not work in newer versions due to changes to damage propagation.{{version|0.43.04}}

== Wildlife control ==
Wild animals will not spawn when a certain number of them are still present on the map (2 for default 4x4 embark, for larger sites it's higher). This works also for cavern creatures (each cavern independently), or even for roaming [[HFS]] denizens, and can be exploited to prevent new creatures from a particular layer from spawning. Capture enough wild creatures in [[cage trap]]s, and release them somewhere they couldn't escape from. As long as they're there, no more beasts will show up. Note that thieving and [[gremlin|mischievous]] creatures are an exception to this, as their arrival is timed and unaffected by the number of other wildlife.

== Portable drain ==
Due to buggy [[minecart]] interactions, a minecart on a [[Minecart#Track_Stops|track stop]] set to dump into a wall tile will constantly fill and empty, removing large amounts of liquid from the game. This is generally much more convenient than digging a tunnel and carving a fortification at the edge of the map. The effect can be controlled by linking a [[lever]] to the track stop (or by adding/removing the minecart in some manner). The portable drain will only reduce the fluid in its tile to below the minimum necessary to fill the cart (6/7); the remaining fluid will need to be dealt with in some other fashion.

([http://www.bay12forums.com/smf/index.php?topic=154537.msg6657752#msg6657752 original forum post])

== Dwarven rocket elevator ==
By exploiting quirks in dwarven physics, minecarts can be accelerated without an external power source (beyond an initial push) to travel independently, or to ascend dozens of Z levels upwards very quickly. Details at [[Minecart#Impulse_ramps]].

== Infinite layer stone without magma ==

Constructed walls can be designated for both fortification carving and deconstruction. When the latter designation is completed, the former is kept. When the former is completed after that, stone floor becomes a natural stone fortification. This makes a cycle for infinite stone:

Stone floor → Build Constructed Wall → Designate for removal and fortification carving → Deconstruct → Stone Floor (still designated as fortification) → Stone fortification → Dug out, stone floor + free stone boulder. (Disable engraving on all dwarves to delay the fortification carving.)

The material used to construct the wall is reclaimed when it is deconstructed. Since mining doesn't always drop stone there is only a chance of getting stone from the fortification.

Using this, one can also retrieve stone from surface boulders, though as deconstruction leaves behind layer stone it will not duplicate adamantine or anything else. Soil gets carved, but remains as a floor, thus providing no gain.

([http://www.bay12forums.com/smf/index.php?topic=145317.msg8091746#msg8091746 Original forum post])

== Alternate water purification methods ==

Contamination in the form of salty or stagnant water is apparently unable to climb stairs. Lacking the materials to build a screw pump, you can instead purify water by forcing it to pass through a vertical u-bend made of stairs.

Flowing fresh water destroys stagnant water on contact, converting it into fresh water. Oddly enough, flowing salt water also destroys stagnant water on contact, converting it to fresh water, so connecting your murky pools to the sea paradoxically provides clean drinking water.

= Adventure mode exploits =

== Urist McAdventurer the shield-wall ==
Adventurers are not limited in the number of items they can hold in their hands, allowing them to equip a virtually unlimited number of shields or bucklers with little effect to the adventurer's performance. This offers multiple chances to block attacks (vastly reducing the number that cause damage) and quickly trains up the shield user skill, further increasing the effectiveness of those shields. There is an indirect limit on how many shields you can equip based on how the total weight of your adventurer's items affects your speed, but the tradeoff between wearing a dozen (or more) shields is well worth the minor reduction in speed.

This exploit was made more complicated due to the addition of the ability to holster/draw weapons and shields, which is needed for [[climber|climbing]] and to avoid hostility from local guards. While an infinite number of weapons or shields can be strapped to your body, only the first two such items will be drawn, requiring a free hand for each. Retrieving multiple shields after unequipping them requires manually drawing each individual shield.

== Infinite drink ==
One's thirst can be quenched indefinitely by emptying a waterskin when you only have 1 unit of liquid left, and refilling it from the pool that forms; giving you 3 units of drink. This is especially useful if you managed to find alcohol and fill the waterskin with some, as alcohol never freezes in cold weather. One can also make a potable pool of water, by emptying a waterskin containing saltwater.

== Backpack of holding ==
In adventurer mode, if you try to pick something up while both your hands are already holding something, it'll go straight in your backpack, even if it would not have fit had you first picked it up and then tried to put it inside. That means you can stuff as much as you want into your backpack - it will still affect your weight and speed, however.

== Pack adventurer ==
You could hold items of any weight, but they affect your speed - except when you're riding a mount.

{{Category|Game}}
[[ru:Exploit]]

Silk farming

2023-02-14T01:54:43Z

Qeveren: /* Passive cave spider silk farm */ Typo correction

{{migrated article}}
{{Quality|Unrated}}
{{projects}}{{av}}
'''Silk farming''' is the process of harvesting large quantities of [[Silk|silk]] from [[web]]slinging creatures like [[giant cave spider]]s. Several setups have been devised to farm silk quickly and safely, but successful silk farms have a few traits in common:

# The webslinging creature must be aggressive toward the bait, and willing to web it. Tame giant cave spiders are not willing to web invaders{{verify}}, while wild spiders appear to only be willing to web ''active military'' dwarves or invaders{{verify}}. [[forgotten beast|Various other untamable creatures]] remain willing to web most tame animals (with [[cat]]s being a possible exception). Tame spiders are not aggressive toward animals on restraints.
# The webslinging creature must not be able to reach its bait; if it can, the bait (or creature) will die and no further silk will be generated. Spiders can destroy wooden doors but not stone or metal doors. They cannot pass through forbidden doors. Other silk-spewing creatures can destroy all non-[[artifact]] doors, requiring drawbridges or walls for containment
# Web collection cannot occur in sight of wild webslingers or invaders serving as bait; either will cause dwarves to interrupt collection. Drawbridges work well to block line of sight in either case, as webs will not prevent them from raising.

==Cave spider silk farm==

Cave spider silk farms are probably the easiest silk farms to set up since the spiders are so small that they don't represent a serious danger to your dwarves.

# Trap a dozen or more cave spiders via kennel.
# Release them into an enclosed area - mined out vein does the job - with access through a hatch from above. Precaution is necessary to prevent vermin hunters like cats from entering the area.
# Place a loom close to the access and assign it to a single weaver. Let it collect webs on repeat.

Since occasional bites are unavoidable, assigning the loom to a single weaver is important. Best use a dwarf already bitten by a cave spider and affected by the resulting dizziness. Despite the slowing effect of cave spider dizziness this farm will produce a steady stream of silk.

===Passive cave spider silk farm===
All cavern layers spawn webs ([http://www.bay12forums.com/smf/index.php?topic=176521.msg8147034#msg8147034 1]). All that is needed for a modest but very safe supply of silk, is to mine out vast areas of the cavern layers. These don't need physical connection to the cavern, it suffices that they are in the same layer as the cavern. Silk webs will start to appear in them as well - that makes it very easy and safe to collect silk. If mined soon after embark, this can significantly boost the early supply of silk.

==Simple silk farm==
{{diagram|spaces=yes|color=#888|\
╔═════════╗
║+++++++++║
║+++++++++╠═╗
║+++++++++┼+║
┼++++++++[#080]╥║[#0F0]^║
║++++++++[#080]║[#F00]╬┼╣
║++++++++[#080]║[#F00]╬S║
║++++++++[#080]║[#F00]╬═╝
┼++++++++[#080]╨║
║+++++++++║
║+++++++++║
║+++++++++║
╚═════════╝
}}
# Dig out (and optionally smooth) a sufficiently large room (example shown is 9x11)
# Build a [[cage]] containing an '''untamed''' spider at the gray "S", and link it to a lever
# Build a '''non-wooden''' [[door]] above the spider cage, and mark it forbidden and pet-inaccessible
# Recommended: build a [[cage trap]] on the green "^" to recapture your spider later
# [[Construction|Construct]] all of the red [[fortification]]s
# Build the green [[bridge]], raising lengthwise to form a long wall.
# Build a [[lever]] somewhere convenient in your fortress and link it to the green bridge
# Pull the lever linked to the cage to release the spider
# Order a '''non-ranged''' military dwarf to station or patrol in the room (but '''not''' on the green bridge)
# Raise the green bridge periodically to allow your bait dwarf to escape, then lower it again to resume production
# Your weavers ''may'' collect webs during production if they have sufficient discipline; if not, leave the green bridge raised while they collect the webs
# Set pull lever on repeat to have automatic production and collection

There is a small chance of injury if the creature gets hit by the projectile silk, but having the creature stand more than 3 tiles away from your spider seems to prevent this.

==High-volume silk farm==

{{diagram|spaces=yes|color=#888|\
z z-1 z-2
╔═════╦┼══╗ ╔═════╗ ╔═════╗
║[#080]╔[#080]═[#080]═[#080]═[#080]╗┼+++║ ║[#0AA]╔[#0AA]═[#0AA]═[#0AA]═[#0AA]╗┼ ║+++++┼
║[#080]║[#080]+[#080]+[#080]+[#080]║[#F00]╬+║[#0F0]^║ ║[#0AA]║[#0AA]+[#0AA]+[#0AA]+[#0AA]║╠═┼╗ ║+++++║
║[#080]║[#080]+[#080]+[#080]+[#080]║[#F00]╬+╠[#888]┼╣ ║[#0AA]║[#0AA]+[#0AA]+[#0AA]+[#0AA]║║++║ ║+++++║
║[#080]║[#080]+[#080]+[#080]+[#080]║[#F00]╬[#FF0]H[#F00]╬[#CCC]S║ ║[#0AA]║[#0AA]+[#0AA]+[#0AA]+[#0AA]║║++║ ║+++++║
║[#080]║[#080]+[#080]+[#080]+[#080]║[#F00]╬+╠═╝ ║[#0AA]║[#0AA]+[#0AA]+[#0AA]+[#0AA]║║++║ ║+++++║
║[#080]║[#080]+[#080]+[#080]+[#080]║[#F00]╬+║ ║[#0AA]║[#0AA]+[#0AA]+[#0AA]+[#0AA]║╠══╝ ║+++++║
║[#080]╚[#080]═[#080]═[#080]═[#080]╝║[#59F]!║ ║[#0AA]╚[#0AA]═[#0AA]═[#0AA]═[#0AA]╝║ ║+++++║
╚═════╩═╝ ╚═════╝ ╚═════╝

}}

# Dig out the three chambers as shown.
# Smooth and carve the red [[fortification]]s.
# [[Channel]] out the areas in green and cyan, linking all three levels
# Build the large green [[bridge]] (retracting) and large cyan bridge (retracting)
# Construct a [[pressure plate]] in a well-traveled area (or a [[repeater]]) and link it to the green bridge
# Build a [[lever]] and link it to the cyan bridge
# Build a [[cage]] containing an '''untamed''' spider at the gray "S", and link it to a lever
# Build a '''non-wooden''' [[door]] above the spider cage, and mark it forbidden.
# Channel the yellow "H", build a [[hatch cover]] there, and link it to a lever. This will allow you to remove the bait dwarf and stop production.
# Recommended: build a [[cage trap]] on the green "^" to recapture your spider later
# Evacuate the upper two chambers and forbid the bridge-access doors
# Pull the lever linked to the cage to release the spider
# Station or order a melee dwarf to patrol to the blue '!'; lock the door after he enters the chamber
# The spider will blast the bait with webs. When the green bridge automatically retracts, the webs will fall and stack on the cyan bridge
# Pull the lever linked to the cyan bridge to drop the stacked webs to the bottom level for collection
# Remember to release your bait dwarf periodically

Note that a simple pit in the harvesting chamber will not work--the bridge is required to cause the "web objects" to drop to the next level (and stack). Because falling items are deadly, it is necessary to collect the webs on the "holding" bridge and only drop them into the collection chamber when your weavers are clear. Also, webs "tossed" by the retracting bridge can injure anything they hit, so your bait dwarf may require occasional replacement. One spider can easily keep several weavers busy, and collecting all the webs provides a great opportunity for [[cross-training]].

'''Extra automation of the silk farm'''
#Station a weredwarf or vampire as spiderbait. Now your melee dwarf does not need to be replaced and can be totally locked in.
#Use an enemy invader instead of a dwarf as the web target{{verify}}. Recapture it with a cage, similarly to how the spider is recaptured.

==Notes on exotic webslingers==

Farming silk from other [[forgotten beast|procedurally]] [[titan|generated]] creatures is somewhat more difficult and less rewarding. As level 2 [[building destroyer]]s, these creatures can only be contained by [[bridge]]s or [[artifact]] [[door]]ways. They are also immune to [[trap]]s, making positioning in the farm rather more complicated. Finally, without a value modifier, the collected silk will be equivalent in [[value]] to common [[cave spider]] silk. They do still provide a nearly-inexhaustible source of silk thread, and with some effort their webs can also be used to [[cage trap|cage]] other trap immune creatures. Also, webslingers with modified material properties (e.g. IGNITE_POINT) can produce webs that retain those properties (e.g. fire-safe or magma-safe silk).

[[File:silk_farming_preview.jpg|thumb|400px|center|Silk farming in China, 1700s.]]

{{Translation| dwarven = nesteth ivom | elvish = yarare tòbafí | goblin = egod gotåm | human = sushsath ab}}

{{Category|Fortress mode}}
[[ru:Silk farming]]

Trade depot

2023-02-13T21:25:57Z

Qeveren: Removed migrated article template

{{Quality|Unrated}}

{{Building|name=Trade depot|key=T
|job=
* [[Broker]] noble (optional)
|construction=
* 3 [[Building material]]s (non-[[economic]])
|construction_job=
Depending on material:
* [[Metalsmithing]]
* [[Masonry]]
* [[Carpentry]]
|purpose=
Trade goods with [[caravan|merchants]].
}}{{av}}{{buggy}}

A '''trade depot''' is a [[building]] that allows you to engage in [[trading]] with [[caravan]]s that arrive at your fortress. Trade depots can be created from almost any building material. Three materials must be used to build the trade depot, with the oldest* material chosen serving as the main material to determine color and "material" as labeled; the color is visible immediately upon confirming the construction order.

(* i.e. the first material created or imported on your map, by chronological order.{{cite forum|134816/4867108}})

There must be at least 10 spaces between the depot and the edge of the map. They can be built on top of [[construction|constructed]] floors and walls, allowing you to make a trade depot which is elevated above the surrounding land. Should they be deconstructed, the depot itself generates an implied walkable floor.

The visiting merchant(s) always stands at the upper side of the center table of the depot, while the player's [[broker]] stands at the opposide lower side. Graphically, the left side of the depot will show the visitor merchants' trade goods, while the right side shows items the player is setting up to trade.
== Depot accessibility ==

In v50, there is no visual indicator of wagon accessibility. For a tile to be “Wagon accessible” it must be navigable between both the tile and the depot *and* the tile and the map edge. If you are trying to constrain wagons to a certain path, ''only'' the desired path should be accessible. ''Warning:'' If the map has an extremely large amount of [[tree]]s (Heavily Forested) there may not be any way for the caravan to get to your depot, unless you chop down a path for the wagons.

Also note that [[trap]]s will block [[wagon]] access (although not merchants with pack animals), so you cannot easily use them to defend your depot.

[[Boulder]]s (the natural kind) and [[minecart|track]]s also block wagons. Boulders can be removed by [[engraving|smooth]]ing ({{k|v}}-{{k|m}}) or constructing and removing a [[wall]]. [[Bridge]]s can serve as an alternative for tracks.

In v50, wagons park next to the trade depot and need a parking space of 3×4 adjacent to the depot.

Forbidding the trade depot (by forbidding any material used to construct it) will make it inaccessible to traders. If inaccessible during the arrival of the caravan, it will cause the wagons to bypass your location.

== Depot building UI options ==

Press {{Menu icon|b|T}} to build a depot. Depots occupy a 5x5 area. Click on the depot to gain access to the following options:

=== Move Goods to/from Depot ===
{{K|g}}: This command becomes active when a caravan arrives on your map. This screen menu is similar to the [[stocks]] menu ({{K|z}} - Stocks). This is where you select what items you want to trade with the caravan. If you have particular items you want to sell to the caravan, you can {{K|s}}earch for it. This is convenient if you want to export all your prepared meals or finished goods. Also shown is the culling on {{K|m}}andate option. The move to depot screen will not show things that violate an export [[mandate]]. By pressing {{K|m}}, it will change to Ignoring {{K|m}}andates, and you can select banned items for export. For example, if your [[mayor]] has a mandate banning the export of iron, this screen will hide bins that contain iron items. By changing this option, all iron items will be shown.

Items stored in [[bin]]s, [[bag]]s or [[barrel]]s will be shown under the category of their respective containers, not under the category of the items themselves. For instance, if all of your [[gem]]s are stored in a wooden bin, no "gem" category will appear in the move goods menu; the gems will be found under "bins." It is not possible to move these items individually. To bring them to the trading depot, you must select the entire container.

Items stored in bins can be traded individually once they have been brought to the trading depot. Items stored in bags/barrels can only be traded as a whole. This is also true of the merchant's wares.

After selecting items and exiting the screen, [[job]]s will be queued to move the items to the depot. All adult dwarves, regardless of [[labor]] settings, can move goods to the depot. Items that have not been moved will show [PENDING], while those that have been brought to the depot and are ready for trade and will be marked as [TRADING].

Items selected for trading will remain at the depot until the caravan leaves. Alternatively you can select the item again. Once no longer required at the depot, items will be available for use or hauling to stockpiles as normal. If you don't want all the items to be returned to their stockpiles, you can optionally {{K|f}}orbid them by looking at the [[Controls_guide#View_items_in_buildings.2C_t|i{{K|t}}ems]] in the depot.

(Note that the "Move goods to depot" screen allows mouse controls, including controls like right-clicking on a list to scroll down, and double-clicking on a tab to select all items in that tab.)

=== No trader needed at depot ''or'' Trader requested at depot ===
{{K|r}}: This requests a dwarf to come to the depot. To conduct trades with caravans, a trader must be present at the Trade Depot. Once requested, a job will be created for a dwarf to make their way to the depot and remain there until released with this setting, or the job is interrupted, such as by the dwarf deciding to drink, sleep, or eat. The Trade at Depot job is fairly low-priority, so [[labor]]s may have to be disabled in order to get the broker to begin the job, or the broker can be temporarily added to a burrow which covers only the depot.

=== Only broker may trade ''or'' Anyone may trade ===
{{K|b}}: This setting determines who will perform the trade. If '''Only broker may trade''' is active, then only the broker [[noble]] will respond to the trader request. This can become a problem when the broker is sleeping or otherwise occupied, but dwarves with low [[appraisal]] skill will receive poorer deals when trading. If '''anyone may trade''' is selected, and someone other than the broker becomes a better appraiser than the broker, the broker's appraisal skill is still used.

=== Trade ===
{{K|t}}: This option becomes available once the caravan unloading their goods at the depot and your trader is at the depot; it begins [[trading]]. If more than one set of merchants is using the trade depot, you will be given the option of who you want to trade with.

== Bugs ==
* Setting a [[Activity zone#Meeting area|meeting area]] over a depot, then removing it, will cause dwarves to act as though it were still a meeting area. This is irreversible.
* Merchants in a trade depot who are accosted by hostile creatures may then refuse to trade. If any merchant is unable to make it to the depot, all the other merchants will similarly refuse to trade.
* Dumping items belonging to the merchants will result in the depot thinking the merchants are gone, when they are actually hanging around.
* [[Forbid]]ding a depot, or slating it for removal immediately after causing the caravan trader to be unwilling to do business with your dwarves (e.g. trading wood to the elves) will cause the caravan to leave all their items and embark on their journey, leaving you to claim the items for yourself. This is treated by the game as seizing the items and will incur diplomatic penalties on the player, unless done to a dwarven caravan (as you cannot have bad relations with your own civilization).
* The game behaves poorly when multiple trade depots are available. Merchants with wagons may path to one depot, while those with pack animals path to the other; then both groups will insist on waiting for the rest of their party to arrive. One of the wagons will scuttle upon arriving at a trade depot if there are multiple depots, causing the caravan to leave immediately. For this reason, it is recommended to build only one trade depot.
* If you slate a depot for removal while merchants are in the process of leaving, the wagons will never leave and eventually the animals and remaining traders will go mad.

{{Buildings}}
{{Workshops}}

DF2014 Talk:Syndrome

2023-02-11T03:42:14Z

Qeveren: /* Multi-caste/multi-creature body transformations */ new section

I'm not quite sure where to add the new syndrome tokens into here, file changes in v0.42.01 list the following as new syndrome tokens (direct copy/past from file changes):

"
new syndrome tokens
[SYN_CONCENTRATION_ADDED:<amount>:<max>]
each 100 of amount will contribute SEV in general to each effect (before dilution), max goes up to 1000
the concentration does not decrease, but will stay at the maximum attained until the syndrome wears off
[SYN_IDENTIFIER:<token>]
causes these syndromes to use the same concentration pool, first one in wins (the rest just stack)
would be better to make syndromes their own raw at this point to needing this, will happen later
[SYN_NO_HOSPITAL]
affected creature will not go to the hospital for effects no matter how bad they get
base effect tokens
ABRUPT_START, ABRUPT_END -- without these, effects will generally build toward the peak and then drop off
DWF_STRETCH:<factor> -- this makes effects last longer in dwarf mode
new effects
[CE_CHANGE_PERSONALITY:FACET:<facet token>:<amount>:<base effect tokens>]
can have multiple facets in one effect by listing them as FACET:<token>:<amount> over and over -- see inebriation
[CE_FEEL_EMOTION:EMOTION:<emotion token>:SEV:<amount>:<base effect tokens>]
due to the way emotions work, you'll need additional effects for each emotion you want to stack
[CE_ERRATIC_BEHAVIOR:SEV:<amount>:<base effect tokens>]
"

Briefish summery of above (I can't recall the formatting to make it more neat to read, edit mode looks nicer):
* Increases severity in general based to each effect, prior to dilution, on concentration amount (I think?) until syndrome wears off
* Setting syndromes to use same concentration pool, 1st one in wins rest stack
* Make creatures not go to hospital for it at all
* Making effects start/stop suddenly, rather than building up to a peak and dropping off.
* make effects last longer in dwarf mode
* Personality/Emotion changes (This looks interesting)
* Erratic Behavior
[[User:Aranna|Aranna]] ([[User talk:Aranna|talk]]) 08:17, 4 December 2015 (UTC)

== CAN_BE_HIDDEN ==

Some of the generated Rawfiles for vampire curses seem to suggest that there's a CAN_BE_HIDDEN syndrome token for some CE_X tags - more exploration is needed, but the two CE_X tags in the "deity vampire curse" generated interaction raw using this syndrome are as follows:

<pre>
[CE_DISPLAY_TILE:TILE:165:4:0:0:START:0:CAN_BE_HIDDEN:ABRUPT]

[CE_DISPLAY_NAME:NAME:vampire:vampires:vampiric:START:0:CAN_BE_HIDDEN:ABRUPT]
</pre>

Additionally, as mentioned (partially) above, ABRUPT is another token that seemingly needs a little more love.

--[[User:CalmBit|CalmBit]] ([[User talk:CalmBit|talk]]) 04:39, 21 May 2016 (UTC)

== NEEDS HELP! ==

I'm trying to make ogresses both milkable and learnable. So I add continuous blood on heart secretions and try to add syndrome. But how make syndrome that remove CAN_LEARN when MILK_COUNTER become 0 and give CAN_LEARN back only if MILK_COUNTER become 20000 (when ogress milked)? [[Special:Contributions/35.191.3.167|35.191.3.167]] 00:52, 30 April 2020 (UTC)

== Multi-caste/multi-creature body transformations ==

Shouldn't the probabilities in this all be 25, except for the last one? [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 03:42, 11 February 2023 (UTC)

Talk:Gear assembly

2023-02-08T02:54:09Z

Qeveren: /* Disconnected gears */

=== Disconnected gears ===

As far as I can tell, windmills and waterwheels supported solely by a gear assembly do NOT deconstruct when the gear assemblies are disabled. I've hung a waterwheel off of a gear assembly, built a windmill supported from below by a gear assembly, and hung vertical axles from a gear assembly. This applies to 47.05 and 50.05. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 10:46, 3 February 2023 (UTC)
: Looks like you can't construct machinery to be suspended from a disabled gear assembly, but disabling it after construction does not cause it to deconstruct. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 20:10, 3 February 2023 (UTC)
:: Looks like machines hanging from disconnected gears do deconstruct, but only on map load or when another machine component is forced to update by being deconstructed. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 02:21, 8 February 2023 (UTC)

Talk:Gear assembly

2023-02-08T02:21:04Z

Qeveren: /* Disconnected gears */

=== Disconnected gears ===

As far as I can tell, windmills and waterwheels supported solely by a gear assembly do NOT deconstruct when the gear assemblies are disabled. I've hung a waterwheel off of a gear assembly, built a windmill supported from below by a gear assembly, and hung vertical axles from a gear assembly. This applies to 47.05 and 50.05. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 10:46, 3 February 2023 (UTC)
: Looks like you can't construct machinery to be suspended from a disabled gear assembly, but disabling it after construction does not cause it to deconstruct. [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 20:10, 3 February 2023 (UTC)
:: Looks like machines hanging from disconnected gears do deconstruct, but only on map load? [[User:Qeveren|Qeveren]] ([[User talk:Qeveren|talk]]) 02:21, 8 February 2023 (UTC)

Talk:Gear assembly

2023-02-03T20:10:15Z

Qeveren:

Graphics token

2023-02-03T19:08:45Z

Qeveren: /* Layered Conditions */ Added LAYER_SET

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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]]

Talk:Gear assembly

2023-02-03T10:52:28Z

Qeveren: /* Disconnected gears */

Talk:Gear assembly

2023-02-03T10:46:56Z

Qeveren: Hanging machines don't deconstruct?

Gear assembly

2023-02-03T10:46:36Z

Qeveren: /* Disconnected gears */ marked verify; hanging machines do not seem to deconstruct

{{migrated article}}
{{av}}
{{Quality|Unrated}}

{{V50 machine|name=Gear assembly|key=g
|construction=
* [[Mechanism]]
|construction_job=
* [[Mechanic]]s
|power=Needs 5 power.
}}

A '''gear assembly''' is a [[machine component]] that is used to transmit [[power]] from one adjacent machine component to another, such as [[water wheel]]s, [[windmill]]s, [[axle]]s, [[screw pump]]s, [[millstone]]s and other gear assemblies. Gear assemblies are required to change the direction of power flow, whether a horizontal '''x'''- and '''y'''-axis change on the same [[z-level]], or a change between vertical ('''z'''-axis) and horizontal (either '''x'''- ''or'' '''y'''-axis) to/from a different z-level – that is, any change of 90°. A gear assembly is constructed from a single [[mechanism]]. A [[screw pump]] can be used to change the direction of power flow without using a mechanism (for instance when [[metal]] and [[stone]] are unavailable).

Gear assemblies require 5 units of power each.

Gear assemblies do not block unit movement and can be crossed by dwarves without danger. However, digging a channel to transfer the power (such as for an axle or a pump) below a gear assembly can result in a hole that cannot be crossed.

''For a basic overview of how the different machine parts work and work together, see [[machinery]].''

==Construction==
Gears can be constructed from the {{K|b}}uild menu under {{K|m}}achines/fluids and {{K|g}}ear. They require one [[mechanism]] to construct.

After the gear assembly has been constructed, it will automatically draw power from an adjacent power source. Further components can then be connected to the other available sides (East, West, North, South, Above, Below) of the gear assembly, and will automatically draw power from the power source via the assembly. Note that gear assemblies do not transfer power diagonally; they only work orthogonally (N–S, E–W, up–down).

In order to transfer power between [[z-level]]s with a gear assembly, you must first dig a channel, and then place the gear over the opening. Then place either another gear assembly, a vertical axle, or a machine (screw pump, etc.) on the z-level below in the same square, and power will be routed to it. They can also be built on [[stair]] tiles, however they will not transfer power through z-levels when placed like that.

==Disconnected gears==

Gears can be "disconnected" by being connected to a [[lever]], and then pulling that lever. However, be warned that if a device is supported entirely by a gear, it may collapse when the gear is disconnected. The same is true of a horizontally connected hanging device. An example is a windmill built directly on top of a gear with no floor: in this case, disconnecting the gear via the lever will cause the windmill construction to collapse.{{verify}} In order to avoid this, create a second gear adjacent to the linked gear but not otherwise connected to the system; this gear will support the windmill if the linked gear is disconnected, but will not transfer power, since it only draws it from the now-disconnected gear.

Note that the above is only necessary if the machine component is entirely unsupported outside of the gear on which it rests. Components which have "Stable foundation" in their {{K|q}} view should not collapse if a gear beneath them is disconnected.

{{Translation| dwarven = olon fidgam | elvish = fathala wemathè | goblin = sosleng ngod | human = ago corust}}

{{buildings}}

{{Category|Machine components}}

Reaction

2023-02-03T05:48:55Z

Qeveren: Missed one anchor

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

'''Reactions''' are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded—building beds or creating glass, for example—but a few are freely editable, and it's (sometimes) quite simple to add additional ones. There is a separate page with custom [[reaction examples]].

== Reaction differences between modes ==
{{migrated section}}

In [[fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[entity token|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction — so that if you give your custom civilization a reaction to produce "star metal" or some other custom material, only they will be able to use it.

In [[adventure mode]], reactions are freely available in the {{k|x}} menu via the {{DFtext|create}} option, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. There are several bugs with adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

== Anatomy of a reaction ==
Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). All reaction files must begin with the file name, followed by the <code>[OBJECT:REACTION]</code> token that tells the game that the file contains reaction definitions.

The reactions themselves generally adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[MAX_MULTIPLIER:<multiplier>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
[DESCRIPTION:<description>]

* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#Fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#Skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#Max multiplier|multiplier]]'': (optional) If present, the reaction will only be done the specified number of times per job; used to limit the output of reactions that accept stacks of items as reagents.
* ''[[#Automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#Adventure mode enabled|adventure mode enabled]]'': (optional) If present, the reaction can be used by the player in Adventure mode.
* ''[[#Description|description]]'': (optional) If present, shows pop-up description when the reaction is selected in workshop (not working in v50).

=== Reaction identifier ===
The REACTION token assigns a unique ID to your reaction.
[REACTION:<reaction identifier>]

The ''reaction identifier'' may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours. This is referenced in an entity definition via [[Entity_token#PERMITTED_REACTION|PERMITTED_REACTION]] to allow that entity to use the reaction.

=== Reaction name ===
The REACTION_NAME token assigns a descriptive name to your reaction in-game.
[REACTION_NAME:<name>]

==== Name ====
This can be anything at all, and is how the reaction will appear in the job list of the building it is assigned to, and so should describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===
The BUILDING token assigns the reaction to a building. Adding multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings. Omitting the BUILDING token entirely will make the reaction unusable in Fortress mode (often used to restrict certain reactions to [[Reaction#Adventure_Mode_enabled|Adventure mode]]).

[BUILDING:<building name>:<building key>]
* [[#Building name|''building name:'']] The ID of the building the reaction appears in.
* [[#Building key|''building key:'']] The hotkey to queue up the reaction in the specified building.

==== Building name ====
This is the ID of the building where the reaction will be carried out. Valid building names are as follows:

* ASHERY - [[Ashery]]
* BOWYER - [[Bowyer's workshop]]
* CARPENTER - [[Carpenter's workshop]]
* CLOTHES - [[Clothier's shop]]
* CRAFTSMAN - [[Craftsdwarf's workshop]]
* FARMER - [[Farmer's workshop]]
* GLASS - [[Glass furnace]]
* KILN - [[Kiln]] and [[Magma kiln]]
* KITCHEN - [[Kitchen]]
* LEATHER - [[Leather works]]
* MASON - [[Stoneworker's workshop]]
* METALSMITH - [[Metalsmith's forge]]
* MILLSTONE - [[Millstone]]
* QUERN - [[Quern]]
* SIEGE - [[Siege workshop]]
* SMELTER - [[Smelter]] and [[Magma smelter]]
* STILL - [[Still]]
* TANNER - [[Tanner's shop]]
* WOOD - [[Wood furnace]]
* Any custom (raw-defined) building, such as:
** SOAP_MAKER - [[Soap maker's workshop]]
** SCREW_PRESS - [[Screw press]]

==== Building key ====
This defines the shortcut key(s) used to queue up the reaction in the workshop during gameplay in Classic mode only. It can be NONE for no shortcut, or take the format of CUSTOM_X, where X can be: any uppercase letter, which shows as a lowercase letter in the building UI, eg. "CUSTOM_A" creates the shortcut {{k|a}}; or a valid modifier key (ALT, CTRL, or SHIFT) followed by an uppercase letter, eg. CUSTOM_SHIFT_A.

=== Category ===

Categories are custom submenus for buildings' reaction menus. A reaction doesn't require a category, but if you have a lot of reactions, categories can be invaluable for organizing and presenting those reactions to players.

Categories can be nested indefinitely—you can have a category within a category within a category within a category within a category within... but as a practical matter, nesting categories more than 2 deep is not recommended.

Categories will be displayed in alphabetical order, first off the file name and then off the category name.

Categories currently have no effect on adventure mode reactions.

==== Defining a category ====

Each category needs to be defined within a reaction, usually one which should appear within its menu. Categories only need to be defined once.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| CATEGORY || style="vertical-align: top"| Category ID || The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.
|-
| style="vertical-align: top"| CATEGORY_NAME || style="vertical-align: top"| String || The name of the category as displayed in-game.
|-
| style="vertical-align: top"| CATEGORY_DESCRIPTION || style="vertical-align: top"| String || Optional. If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.
|-
| style="vertical-align: top"| CATEGORY_PARENT || style="vertical-align: top"| Category ID || Optional. If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.
|-
| style="vertical-align: top"| CATEGORY_KEY || style="vertical-align: top"| Hotkey token || Optional. If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey. Uses the same format as the BUILDING KEY described above.
|}

==== Adding reactions to an existing category ====

Just include the tag [CATEGORY:<category_id>] within your reaction definition, and if the category exists, your reaction will be added to its menu. You can only add reactions to custom categories.

Each reaction can belong to only one category.

=== Reagents ===

REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#Reagent name|name]]'': The name of the reagent, local to the reaction.
* ''[[#Quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#Item_token|item token]]'': The type (and subtype) of the item you require.
* ''[[#Material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== Name ====

The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reagents are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''', '''FLUX''', or '''seeds''' will also work equally well. The PRODUCT may make reference to this name – for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== Quantity ====

How many or how much of this reagent the reaction requires. For most item types this is just the number of them required. However, some other item types─specifically bars, cloth, thread, globs, liquids, powder, and sheets of paper or parchment─instead use numbers representing the size of the material within one (or more) of these items. For example, while REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items, REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE is an extremely tiny portion of a random spool of thread. One can see which items have what size quantities in the description of the [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] token.

If one of the reagents is in a stack, or the reaction is only using a fraction of the amount of a sized item, the reaction will consume the entire stack, or as much of the sized item as possible, and multiply the product accordingly. This behaviour can be controlled using the [[Reaction#MAX_MULTIPLIER|MAX_MULTIPLIER]] token.

==== Item token ====

[[Item token]]s are of the form ITEM_TYPE:ITEM_SUBTYPE.

The ITEM_TYPE is the category of item you require; WEAPON, TOY or SKIN_TANNED, for example.

The ITEM_SUBTYPE is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, have no subtype and only require the item token to be filled in; so if you're asking for those you should set the subtype to NONE. Subtypes are defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT])—they cannot be used in any other context.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens—this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

==== Material token ====

[[Material token]]s come in several forms. For most reagents, this will typically be INORGANIC:MATERIAL_ID or NONE:NONE (to allow multiple materials using other modifier tokens).

Some reactions will allow the player to select specific materials after creating the job (or in [[Reaction#material_token_2|some cases]], armor size from the product), by clicking on the magnifying glass icon next to the job in the workshop queue. To permit this behaviour in your reaction, the reagent materials must be specified as follows:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Item Type
! Material
! Notes
|-
| style="vertical-align: top"| BAR BLOCKS BOULDER ROUGH SMALLGEM || style="vertical-align: top"| INORGANIC:NONE || style="vertical-align: top"| These all appear as "stone" in the material selection menu, and list all inorganic materials regardless of any material modifier tokens, eg. [ITEMS_METAL]. BAR and BLOCKS made of organic materials, and BOULDER made of clay, are excluded.
|-
| style="vertical-align: top"| SKIN_TANNED or WOOD || style="vertical-align: top"| NONE:NONE ||
|-
| style="vertical-align: top"| Other Item Types || style="vertical-align: top"| NONE:NONE || style="vertical-align: top"| These will appear if a material modifier token other than [ANY_LEATHER_MATERIAL] is included.
|}

==== Modifiers ====

Reagents may also have extra tokens added on, following the REAGENT token, in order to modify their behaviour.

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material. Modifiers can then be used to restrict this to only certain broad classes of materials.

The following is a list of all known reagent modifiers:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.
|-
| style="vertical-align: top"| ANY_GEM_MATERIAL
|
| Reagent material must have the [IS_GEM] token.
|-
| style="vertical-align: top"| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.
|-
| style="vertical-align: top"| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.
|-
| style="vertical-align: top"| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.
|-
| style="vertical-align: top"| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.
|-
| style="vertical-align: top"| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.
|-
| style="vertical-align: top"| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.
|-
| style="vertical-align: top"| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.
|-
| style="vertical-align: top"| ANY_STONE_MATERIAL
|
| Reagent material must have the [IS_STONE] token.
|-
| style="vertical-align: top"| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having TISSUE_SHAPE:STRANDS, intended for matching hair and wool. Must be used with USE_BODY_COMPONENT.
|-
| style="vertical-align: top"| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.
|-
| style="vertical-align: top"| ANY_WOOD_MATERIAL
|
| Reagent material must have the [WOOD] token.
|-
| style="vertical-align: top"| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.
|-
| style="vertical-align: top"| BUILDMAT
|
| Reagent must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| style="vertical-align: top"| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| style="vertical-align: top"| CONTAINS
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| Reagent is a container that holds the specified reagent (where ''Reagent name'' is the locally-defined name of the reagent).
|-
| style="vertical-align: top"| CONTAINS_LYE
|
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| style="vertical-align: top"| DOES_NOT_ABSORB
|
| Reagent material must have ABSORPTION:0
|-
| style="vertical-align: top"| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that [[stack]]s of reagents will correctly produce additional outputs.
|-
| style="vertical-align: top"| EMPTY
|
| If the reagent is a container, it must be empty.
|-
| style="vertical-align: top"| FIRE_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| FOOD_STORAGE_CONTAINER
|
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| style="vertical-align: top"| GLASS_MATERIAL
|
| Reagent material must have the IS_GLASS token. All 3 types of [[glass]] have this token hardcoded.
|-
| style="vertical-align: top"| HARD_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_HARD] token.
|-
| style="vertical-align: top"| HAS_EDGE
|
| Reagent must have an edge.
|-
| style="vertical-align: top"| HAS_ITEM_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the item reaction product specified by PRODUCT_ID - [[Reaction#Item_reaction_products|see below]] for more details. This can be used interchangeably with HAS_MATERIAL_REACTION_PRODUCT.
|-
| style="vertical-align: top"| HAS_MATERIAL_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the material reaction product specified by PRODUCT_ID - [[Reaction#Material_reaction_products|see below]] for more details.
|-
| style="vertical-align: top"| HAS_TOOL_USE
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE]] value
| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| style="vertical-align: top"| IS_CRAFTED_ARTIFACT{{verify}}
|
| Reagent item must be an artifact.
|-
| style="vertical-align: top"| IS_DIVINE_MATERIAL
|
| Reagent material must have the [DIVINE] token.
|-
| style="vertical-align: top"| IS_SAND_MATERIAL
|
| Reagent material must have the [SOIL_SAND] token.
|-
| style="vertical-align: top"| MAGMA_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| METAL_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_METAL] token.
|-
| style="vertical-align: top"| METAL_ORE
| style="vertical-align: top"|
* Metal ID
| Reagent material must be an ore of the specified metal.
|-
| style="vertical-align: top"| MIN_DIMENSION
| style="vertical-align: top"|
* Integer
| Reagent's item size must be at least as large as ''Integer''. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, or GLOB for this to work. See [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] below.
|-
| style="vertical-align: top"| NO_EDGE_ALLOWED
|
| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
|-
| style="vertical-align: top"| NOT_ARTIFACT{{verify}}
|
| Reagent item must not be an artifact.
|-
| style="vertical-align: top"| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
|-
| style="vertical-align: top"| NOT_ENGRAVED
|
| Reagent can not be engraved. For example, a memorial slab can not be engraved.
|-
| style="vertical-align: top"| NOT_IMPROVED
|
| Reagent has not been decorated.
|-
| style="vertical-align: top"| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| NOT_WEB
|
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| ON_GROUND
|
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from inventories (workshops, wagon) and causes infinite gathering for reactions in workshop.
|-
| style="vertical-align: top"| POTASHABLE (Deprecated)
|
| Alias for [CONTAINS_LYE].
|-
| style="vertical-align: top"| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| style="vertical-align: top"| REACTION_CLASS
| style="vertical-align: top"|
* CLASS_ID
| Reagent material must have the reaction class specified by CLASS_ID - [[Reaction#Reaction_classes|see below]] for more details.
|-
| style="vertical-align: top"| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| USE_BODY_COMPONENT
|
| Reagent must be a body part (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| style="vertical-align: top"| WEB_ONLY
|
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| WORTHLESS_STONE_ONLY
|
| Reagent material must be non-[[economic]].
|-
| style="vertical-align: top"| WOVEN_ITEM
|
| Reagent must be a clothing item made of a woven material, ie. plant, silk, or yarn cloth.
|}

=== Products ===

Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token [PRODUCT_DIMENSION:X] is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:''name''] token, where the ''name'' is the [[#Reagent name|name]] of a reagent. This requires the reagent to have the [PRESERVE_REAGENT] token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...]

==== Probability ====

The percentage chance the product will be produced when the reaction is completed.

==== Quantity ====

Determines how many of the product will be produced. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, PLANT_GROWTH, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can—for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

==== Item token ====

The [[item token]] and subtype of the item you produce.

If your item has an [[Reaction#Item reaction products|item reaction product]] and you want the item type and material to be derived from one of the reagents, you can use GET_ITEM_DATA_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of both the item token ''and'' the material token (see next section). You can also specify GET_ITEM_DATA_FROM_REAGENT:reagent:NONE in order to make a direct copy of the source item, though this will not work for complex items such as corpses or prepared meals.

For products, this can also be set to CRAFTS:NONE to produce up to three random [[craft]] items. This value cannot be used in any other context.

==== Material token ====

A [[material token]] describing what the product will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

Similarly to choosing material types for a reagent, if the item product is armor/clothing, and has the appropriate [[Entity_token#Available_resources|armor token]] in the entity file, you will be able to choose the armor/clothing size for different creatures by clicking the magnifying glass of the workshop task. However, this will only work if the product material is [[Modding pitfalls#My_custom_armor.2Fclothing_reaction_won.27t_let_user_choose_size|cloth leather or certain metals]], and the item is also recognized by the related vanilla workshop reaction{{verify}}.

==== Product modifiers ====

Zero or more tokens which further set the properties or disposition of the resulting product item.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.
|-
| style="vertical-align: top"| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.
|-
| style="vertical-align: top"| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| PRODUCT_DIMENSION
| style="vertical-align: top"|
* Integer
| Specifies the dimension of the product for those items that use dimensions. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.
|-
| style="vertical-align: top"| PRODUCT_TO_CONTAINER
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Places the product in a container; ''Name'' must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.
|-
| style="vertical-align: top"| PRODUCT_TOKEN
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Allows the product to be referred to by the given name for the purpose of being passed down as and argument in other tokens, in the same fashion as reagent names.
|-
| style="vertical-align: top"| TRANSFER_ARTIFACT_STATUS
|
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.
|}

=== Improvements ===

Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

==== Probability ====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

==== Reagent name ====
The [[#Reagent name|name]] of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

==== Improvement type ====
The following improvement types can be used:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|-
| PAGES
| Adds pages to a [[book]].
|-
| SPECIFIC
| With subtype ROLLERS, adds rollers of <material> to a [[scroll]]; with subtype HANDLE, adds a handle of <material> to an item; with subtype TRACTION_BENCH_CHAIN or TRACTION_BENCH_ROPE adds a chain or rope of <material> to an item.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

==== Material token ====

A [[material token]] describing what the decoration will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

=== Other tokens ===

==== Fuel ====

The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== Skill ====

The [[Skill token|skill tokens]] determine what skill the reaction requires and trains; also how quickly skill is gained, how quickly those skill gains raise attributes, and how skill level affects the quality of the reaction product.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| SKILL
| style="vertical-align: top"|
* [[Skill token]]
| (Optional) This identifies the skill required to carry out the reaction and is trained when the reaction is performed. Only one skill may be specified; if multiple skill tokens are defined only the last will be used. A reaction with no product will yield no experience gain. A reaction with no SKILL token will complete in a default amount of time.
|-
| style="vertical-align: top"| SKILL_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of skill gained each time the reaction is carried out. The default value is 30; higher values increase the amount of skill gain.
|-
| style="vertical-align: top"| ATTRIBUTE_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of [[Attribute|attribute]] gain that skill gain from this reaction results in. The default value is 10; higher values increase the amount of attribute gain.
|-
| style="vertical-align: top"| SKILL_ROLL_RANGE
| style="vertical-align: top"|
* Range
* Multiplier
| (Optional, requires SKILL token) This changes how much skill level affects the quality of the reaction product. The default is [SKILL_ROLL_RANGE:11:5]. The ''range'' is the base "die roll" and the ''multiplier'' determines how much the dwarf's skill can affect the reaction; the skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1), where random(x) gives a random number from 0 to x-1, inclusive (which also means that the minimum for the range is 1). The higher result on the roll, the better. Both numbers can be lowered to make the skill check harder. For example, with the default values a dwarf who is proficient in a skill has a skill level of 5; their roll will be random(11)+random(13)+random(13), meaning this dwarf can roll anywhere from 0 to 34; similarly, unskilled dwarves can roll 0 to 10 while legendary+0 (skill 15) dwarves can roll 0 to 84. If this is changed to [SKILL_ROLL_RANGE:1:8], then instead a proficient dwarf will have random(1)+random(21)+random(21), giving a roll of 0 to 40, with unskilled dwarves always rolling 0 and legendary dwarves going all the way up to 120.

As a consequence, increasing the multiplier will always make legendary dwarves more effective, even if base roll is reduced to its minimum of 1, with the default going up to 84 for default and 90 for [SKILL_ROLL_RANGE:1:6].
|}

==== Max multiplier ====

The [MAX_MULTIPLIER:<#>] token specifies how many times to do the reaction. This can be used to limit stacked reagent use to the specified quantity instead of the whole stack.

==== Automatic ====

The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== Adventure mode enabled ====

The ADVENTURE_MODE_ENABLED token means that this version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage assuming the reaction also has a usable building assigned and is a {{token|PERMITTED_REACTION|entity}} within the entity file.

==== Description ====

This feature is exclusive to Classic Mode, as no description window pops up when mousing over reactions in workshops in Premium.

The [DESCRIPTION:<string>] token provides a text description of the reaction when it is highlighted in the building UI. Multiple DESCRIPTION tokens can be defined in a reaction, and each will appear on a new line. The pop-up box that contains the description is limited to 325 characters total. Alternatively, this token can reference a DESCRIPTION token in an existing tool definition by replacing ''string'' with USE_TOOL:<ITEM_SUBTYPE>; or an existing instrument definition with USE_INSTRUMENT:<ITEM_SUBTYPE>.

== Reaction classes and products ==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

=== Reaction classes ===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there are a half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with six nearly identical reactions that all take in either dolomite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B asks for "NONE:NONE" as its material. This means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like calcite, here:

[INORGANIC:CALCITE]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:calcite][DISPLAY_COLOR:7:7:1][TILE:'"']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:LIMESTONE:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:MARBLE:CLUSTER_SMALL:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:12902]
[SOLID_DENSITY:2930]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction. Note that some reaction classes have special meanings to the game itself—notably, the [[site finder]] knows that "FLUX" should be connected to the "Flux stone" filter.

=== Material reaction products ===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:TAN_MAT]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:TAN_MAT''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the TAN_MAT reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, the spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named TAN_MAT) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the TAN_MAT hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). For example, skin taken from a butchered dog would be turned into dog leather. Change the SKIN_TEMPLATE MATERIAL_REACTION_PRODUCT to TAN_MAT:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

As with reaction classes, some MATERIAL_REACTION_PRODUCT identifiers have special meanings to the game itself - notably, the [[site finder]] knows that "FIRED_MAT" should be connected to the "Clay" filter, and "CHEESE_MAT" is used when making [[cheese]] from [[milk]].

=== Item reaction products ===

Item reaction products are an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA_FROM_REAGENT:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

Do note that MATERIAL_REACTION_PRODUCT and ITEM_REACTION_PRODUCT use the same IDs, so you cannot have both a material and item reaction product of the same name. Also, though you cannot use GET_ITEM_DATA_FROM_REAGENT with a MATERIAL_REACTION_PRODUCT (there'd be no item type information), you ''can'' use GET_MATERIAL_FROM_REAGENT on an ITEM_REACTION_PRODUCT (in case you want to force your own item type).

== Reactions and world generation ==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

== Full token list ==

For the sake of convenience and readability, this is a complete compilation of the previously listed reaction tokens in alphabetical order:

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

|-
| style="vertical-align: top"| {{text anchor|ADVENTURE_MODE_ENABLED}}
|
|
| style="vertical-align: top"| This version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage.

|-
| style="vertical-align: top"| {{text anchor|ANY_BONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [BONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_GEM_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_GEM] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_HORN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [HORN] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_LEATHER_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [LEATHER] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PEARL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [PEARL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PLANT_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be subordinate to a PLANT object.

|-
| style="vertical-align: top"| {{text anchor|ANY_SHELL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SHELL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SILK_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SILK] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SOAP_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SOAP] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_STONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STRAND_TISSUE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| style="vertical-align: top"| {{text anchor|ANY_TOOTH_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [TOOTH] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_WOOD_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [WOOD] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_YARN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [YARN] token.

|-
| style="vertical-align: top"| {{text anchor|ATTRIBUTE_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of attribute gain given per skill improvement. Default is 10.

|-
| style="vertical-align: top"| {{text anchor|AUTOMATIC}}
|
|
| style="vertical-align: top"| The reaction will be queued automatically if the reaction reagents are all present.

|-
| style="vertical-align: top"| {{text anchor|BAG}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead. Deprecated as of Version 0.50.01 in favor of BAG:NONE [[item token]].

|-
| style="vertical-align: top"| {{text anchor|BUILDING}}
| style="vertical-align: top"|
* [[#building name|Building name]]
* [[#building key|In-building reaction hotkey]]
|
| style="vertical-align: top"| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game.

|-
| style="vertical-align: top"| {{text anchor|BUILDMAT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is able to be used to build structures (Boulders, Wood, Blocks, Bars).

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_ARTIFACT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_HOSPITAL_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[healthcare|hospital]].

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_LOCATION_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[locations|location]].

|-
| style="vertical-align: top"| {{text anchor|CATEGORY}}
| style="vertical-align: top"|
* Category ID
|
| style="vertical-align: top"| Puts the reaction in a category. Categories are custom submenus for reaction menus. The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_NAME}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| The name of the category as displayed in-game.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_DESCRIPTION}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_PARENT}}
| style="vertical-align: top"|
* Category ID
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_KEY}}
| style="vertical-align: top"|
* Hotkey
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey while playing in Classic mode.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is a container that holds the specified reagent.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS_LYE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| style="vertical-align: top"| {{text anchor|DESCRIPTION}}
| style="vertical-align: top"|
* String
|
| style="vertical-align: top"| A description of the reaction that appears when it is highlighted in the building UI. ''String'' can also be replaced with a reference to existing DESCRIPTION tokens in tools (using USE_TOOL:<tool_id>) or musical instruments (using USE_TOOL:<instrument_id>).

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_ABSORB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have [ABSORPTION:0].

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_DETERMINE_PRODUCT_AMOUNT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| style="vertical-align: top"| {{text anchor|EMPTY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must be empty.

|-
| style="vertical-align: top"| {{text anchor|FIRE_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be considered [[fire-safe]] (stable [[temperature]] below {{ct|11000}}) - i.e. not wood, and not coal.

|-
| style="vertical-align: top"| {{text anchor|FORCE_EDGE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is given a sharp edge. Used for knapping.

|-
| style="vertical-align: top"| {{text anchor|FOOD_STORAGE_CONTAINER}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a barrel or any non-absorbing tool with [TOOL_USE:FOOD_STORAGE].

|-
| style="vertical-align: top"| {{text anchor|FUEL}}
|
|
| style="vertical-align: top"| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop.

|-
| style="vertical-align: top"| {{text anchor|GLASS_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material has [IS_GLASS].

|-
| style="vertical-align: top"| {{text anchor|HAS_EDGE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be sharpened (used for carving).

|-
| style="vertical-align: top"| {{text anchor|HAS_ITEM_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to HAS_MATERIAL_REACTION_PRODUCT, but requires the reagents material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| style="vertical-align: top"| {{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to REACTION_CLASS, but requires the reagents material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| style="vertical-align: top"| {{text anchor|HAS_TOOL_USE}}
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE value]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagents item type must be TOOL:NONE for this to make any sense.

|-
| style="vertical-align: top"| {{text anchor|HAS_WRITING_IMPROVEMENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must contain writing.

|-
| style="vertical-align: top"| {{text anchor|IMPROVEMENT}}
| style="vertical-align: top"|
* Probability
* [[#Reagent name|Reagent name]]
* Improvement type
* Material Token
|
| style="vertical-align: top"| Applies an improvement to the named reagent. Only meaningful if said reagent has [PRESERVE_REAGENT]. Improvement types include BANDS, COVERED, GLAZED, PAGES, RINGS_HANGING, and SPIKES

|-
| style="vertical-align: top"| {{text anchor|IS_CRAFTED_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must be an artifact.

|-
| style="vertical-align: top"| {{text anchor|IS_DIVINE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [DIVINE] token.

|-
| style="vertical-align: top"| {{text anchor|MAGMA_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Currently broken - Reagent must be considered [[magma-safe]] (stable [[temperature]] below {{ct|12000}}).

|-
| style="vertical-align: top"| {{text anchor|MAX_MULTIPLIER}}
| style="vertical-align: top"|
* Integer
|
| style="vertical-align: top"| Sets the maximum number of times a reaction is allowed to run when using stacked reagents. This can be used to ensure that the reaction doesn't repeat until the entire stack is depleted.

|-
| style="vertical-align: top"| {{text anchor|METAL_ORE}}
| style="vertical-align: top"|
* Inorganic material
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be an ore of the specified metal.

|-
| style="vertical-align: top"| {{text anchor|MIN_DIMENSION}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires that the reagent have a size of at least ''integer''. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, and GLOB items.

|-
| style="vertical-align: top"| {{text anchor|NAME}}
| style="vertical-align: top"|
* [[#name|Name]]
|
| style="vertical-align: top"| Defines the name used by the reaction in-game.

|-
| style="vertical-align: top"| {{text anchor|NO_EDGE_ALLOWED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.

|-
| style="vertical-align: top"| {{text anchor|NOT_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must not be an artifact.

|-
| style="vertical-align: top"| {{text anchor|NOT_CONTAIN_BARREL_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| style="vertical-align: top"| {{text anchor|NOT_ENGRAVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been engraved i.e. a blank memorial slab.
|-
| style="vertical-align: top"| {{text anchor|NOT_IMPROVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been decorated.

|-
| style="vertical-align: top"| {{text anchor|NOT_PRESSED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|NOT_WEB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| style="vertical-align: top"| {{text anchor|ON_GROUND}}
|
| style="vertical-align: top"| Reagent modifier
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from bins in stockpiles, nor inventories (workshops, wagon). Causes infinite collection of items if reaction is in workshop, as reagents are no longer on ground when brought to workshop. Untested in adventure mode; possibly more useful for adv. mode reactions.

|-
| style="vertical-align: top"| {{text anchor|POTASHABLE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Alias for [CONTAINS_LYE].

|-
| style="vertical-align: top"| {{text anchor|PRESERVE_REAGENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT}}
| style="vertical-align: top"|
*Probability of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
|
| style="vertical-align: top"| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA_FROM_REAGENT can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_DIMENSION}}
| style="vertical-align: top"|
* Size
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Specifies the amount of the product for those items that use dimension. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PASTE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PASTE state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PRESSED}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TO_CONTAINER}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Places the product in a container; reagent name must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TOKEN}}
| style="vertical-align: top"|
* Name
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Allows the product to be referred to by the given name, for the purpose of being passed down as argument in other tokens in the same fashion as reagent names.

|-
| style="vertical-align: top"| {{text anchor|REACTION}}
| style="vertical-align: top"|
* Identifier
|
| style="vertical-align: top"| Defines a new reaction.

|-
| style="vertical-align: top"| {{text anchor|REACTION_CLASS}}
| style="vertical-align: top"|
* CLASS_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
| style="vertical-align: top"| {{text anchor|REAGENT}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
* [[#quantity|Quantity]]
* [[Item token]]
* [[Material token]]
|
| style="vertical-align: top"| Specifies a given reagent as an input for a reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL}}
| style="vertical-align: top"|
* [[Skill token]]
|
| style="vertical-align: top"| Skill used by the reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of skill given per product made. Default is 30.

|-
| style="vertical-align: top"| {{text anchor|SKILL_ROLL_RANGE}}
| style="vertical-align: top"|
* Range
* Multiplier
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Determines how [[skill]] level affects [[quality]] of the reaction product. The skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1). random(x) returns a number between 0 and x-1, so range is always 1 or more. The default is 11. The default multiplier is 5. Higher skill rolls give better results.

|-
| style="vertical-align: top"| {{text anchor|TRANSFER_ARTIFACT_STATUS}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.

|-
| style="vertical-align: top"| {{text anchor|UNROTTEN}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be rotten, mainly for organic materials.

|-
| style="vertical-align: top"| {{text anchor|USE_BODY_COMPONENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must come off a creature's body.

|-
| style="vertical-align: top"| {{text anchor|WEB_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| style="vertical-align: top"| {{text anchor|WORTHLESS_STONE_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not made of an economic stone.

|-
| style="vertical-align: top"| {{text anchor|WOVEN_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be a woven material, eg. plant cloth, silk, yarn. This ''excludes'' CLOTH or THREAD items.

|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Reaction]]

Reaction

2023-02-03T05:47:06Z

Qeveren: Repaired anchor links, added max_multiplier and description to "Anatomy of a reaction"

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

'''Reactions''' are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded—building beds or creating glass, for example—but a few are freely editable, and it's (sometimes) quite simple to add additional ones. There is a separate page with custom [[reaction examples]].

== Reaction differences between modes ==
{{migrated section}}

In [[fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[entity token|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction — so that if you give your custom civilization a reaction to produce "star metal" or some other custom material, only they will be able to use it.

In [[adventure mode]], reactions are freely available in the {{k|x}} menu via the {{DFtext|create}} option, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. There are several bugs with adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

== Anatomy of a reaction ==
Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). All reaction files must begin with the file name, followed by the <code>[OBJECT:REACTION]</code> token that tells the game that the file contains reaction definitions.

The reactions themselves generally adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[MAX_MULTIPLIER:<multiplier>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
[DESCRIPTION:<description>]

* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#Fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#Skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#Max multiplier|multiplier]]'': (optional) If present, the reaction will only be done the specified number of times per job; used to limit the output of reactions that accept stacks of items as reagents.
* ''[[#Automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#Adventure mode enabled|adventure mode enabled]]'': (optional) If present, the reaction can be used by the player in Adventure mode.
* ''[[#Description|description]]'': (optional) If present, shows pop-up description when the reaction is selected in workshop (not working in v50).

=== Reaction identifier ===
The REACTION token assigns a unique ID to your reaction.
[REACTION:<reaction identifier>]

The ''reaction identifier'' may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours. This is referenced in an entity definition via [[Entity_token#PERMITTED_REACTION|PERMITTED_REACTION]] to allow that entity to use the reaction.

=== Reaction name ===
The REACTION_NAME token assigns a descriptive name to your reaction in-game.
[REACTION_NAME:<name>]

==== Name ====
This can be anything at all, and is how the reaction will appear in the job list of the building it is assigned to, and so should describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===
The BUILDING token assigns the reaction to a building. Adding multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings. Omitting the BUILDING token entirely will make the reaction unusable in Fortress mode (often used to restrict certain reactions to [[Reaction#Adventure_Mode_enabled|Adventure mode]]).

[BUILDING:<building name>:<building key>]
* [[#Building name|''building name:'']] The ID of the building the reaction appears in.
* [[#Building key|''building key:'']] The hotkey to queue up the reaction in the specified building.

==== Building name ====
This is the ID of the building where the reaction will be carried out. Valid building names are as follows:

* ASHERY - [[Ashery]]
* BOWYER - [[Bowyer's workshop]]
* CARPENTER - [[Carpenter's workshop]]
* CLOTHES - [[Clothier's shop]]
* CRAFTSMAN - [[Craftsdwarf's workshop]]
* FARMER - [[Farmer's workshop]]
* GLASS - [[Glass furnace]]
* KILN - [[Kiln]] and [[Magma kiln]]
* KITCHEN - [[Kitchen]]
* LEATHER - [[Leather works]]
* MASON - [[Stoneworker's workshop]]
* METALSMITH - [[Metalsmith's forge]]
* MILLSTONE - [[Millstone]]
* QUERN - [[Quern]]
* SIEGE - [[Siege workshop]]
* SMELTER - [[Smelter]] and [[Magma smelter]]
* STILL - [[Still]]
* TANNER - [[Tanner's shop]]
* WOOD - [[Wood furnace]]
* Any custom (raw-defined) building, such as:
** SOAP_MAKER - [[Soap maker's workshop]]
** SCREW_PRESS - [[Screw press]]

==== Building key ====
This defines the shortcut key(s) used to queue up the reaction in the workshop during gameplay in Classic mode only. It can be NONE for no shortcut, or take the format of CUSTOM_X, where X can be: any uppercase letter, which shows as a lowercase letter in the building UI, eg. "CUSTOM_A" creates the shortcut {{k|a}}; or a valid modifier key (ALT, CTRL, or SHIFT) followed by an uppercase letter, eg. CUSTOM_SHIFT_A.

=== Category ===

Categories are custom submenus for buildings' reaction menus. A reaction doesn't require a category, but if you have a lot of reactions, categories can be invaluable for organizing and presenting those reactions to players.

Categories can be nested indefinitely—you can have a category within a category within a category within a category within a category within... but as a practical matter, nesting categories more than 2 deep is not recommended.

Categories will be displayed in alphabetical order, first off the file name and then off the category name.

Categories currently have no effect on adventure mode reactions.

==== Defining a category ====

Each category needs to be defined within a reaction, usually one which should appear within its menu. Categories only need to be defined once.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| CATEGORY || style="vertical-align: top"| Category ID || The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.
|-
| style="vertical-align: top"| CATEGORY_NAME || style="vertical-align: top"| String || The name of the category as displayed in-game.
|-
| style="vertical-align: top"| CATEGORY_DESCRIPTION || style="vertical-align: top"| String || Optional. If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.
|-
| style="vertical-align: top"| CATEGORY_PARENT || style="vertical-align: top"| Category ID || Optional. If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.
|-
| style="vertical-align: top"| CATEGORY_KEY || style="vertical-align: top"| Hotkey token || Optional. If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey. Uses the same format as the BUILDING KEY described above.
|}

==== Adding reactions to an existing category ====

Just include the tag [CATEGORY:<category_id>] within your reaction definition, and if the category exists, your reaction will be added to its menu. You can only add reactions to custom categories.

Each reaction can belong to only one category.

=== Reagents ===

REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#Reagent name|name]]'': The name of the reagent, local to the reaction.
* ''[[#Quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#Item_token|item token]]'': The type (and subtype) of the item you require.
* ''[[#Material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== Name ====

The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reagents are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''', '''FLUX''', or '''seeds''' will also work equally well. The PRODUCT may make reference to this name – for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== Quantity ====

How many or how much of this reagent the reaction requires. For most item types this is just the number of them required. However, some other item types─specifically bars, cloth, thread, globs, liquids, powder, and sheets of paper or parchment─instead use numbers representing the size of the material within one (or more) of these items. For example, while REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items, REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE is an extremely tiny portion of a random spool of thread. One can see which items have what size quantities in the description of the [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] token.

If one of the reagents is in a stack, or the reaction is only using a fraction of the amount of a sized item, the reaction will consume the entire stack, or as much of the sized item as possible, and multiply the product accordingly. This behaviour can be controlled using the [[Reaction#MAX_MULTIPLIER|MAX_MULTIPLIER]] token.

==== Item token ====

[[Item token]]s are of the form ITEM_TYPE:ITEM_SUBTYPE.

The ITEM_TYPE is the category of item you require; WEAPON, TOY or SKIN_TANNED, for example.

The ITEM_SUBTYPE is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, have no subtype and only require the item token to be filled in; so if you're asking for those you should set the subtype to NONE. Subtypes are defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT])—they cannot be used in any other context.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens—this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

==== Material token ====

[[Material token]]s come in several forms. For most reagents, this will typically be INORGANIC:MATERIAL_ID or NONE:NONE (to allow multiple materials using other modifier tokens).

Some reactions will allow the player to select specific materials after creating the job (or in [[Reaction#material_token_2|some cases]], armor size from the product), by clicking on the magnifying glass icon next to the job in the workshop queue. To permit this behaviour in your reaction, the reagent materials must be specified as follows:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Item Type
! Material
! Notes
|-
| style="vertical-align: top"| BAR BLOCKS BOULDER ROUGH SMALLGEM || style="vertical-align: top"| INORGANIC:NONE || style="vertical-align: top"| These all appear as "stone" in the material selection menu, and list all inorganic materials regardless of any material modifier tokens, eg. [ITEMS_METAL]. BAR and BLOCKS made of organic materials, and BOULDER made of clay, are excluded.
|-
| style="vertical-align: top"| SKIN_TANNED or WOOD || style="vertical-align: top"| NONE:NONE ||
|-
| style="vertical-align: top"| Other Item Types || style="vertical-align: top"| NONE:NONE || style="vertical-align: top"| These will appear if a material modifier token other than [ANY_LEATHER_MATERIAL] is included.
|}

==== Modifiers ====

Reagents may also have extra tokens added on, following the REAGENT token, in order to modify their behaviour.

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material. Modifiers can then be used to restrict this to only certain broad classes of materials.

The following is a list of all known reagent modifiers:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.
|-
| style="vertical-align: top"| ANY_GEM_MATERIAL
|
| Reagent material must have the [IS_GEM] token.
|-
| style="vertical-align: top"| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.
|-
| style="vertical-align: top"| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.
|-
| style="vertical-align: top"| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.
|-
| style="vertical-align: top"| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.
|-
| style="vertical-align: top"| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.
|-
| style="vertical-align: top"| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.
|-
| style="vertical-align: top"| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.
|-
| style="vertical-align: top"| ANY_STONE_MATERIAL
|
| Reagent material must have the [IS_STONE] token.
|-
| style="vertical-align: top"| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having TISSUE_SHAPE:STRANDS, intended for matching hair and wool. Must be used with USE_BODY_COMPONENT.
|-
| style="vertical-align: top"| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.
|-
| style="vertical-align: top"| ANY_WOOD_MATERIAL
|
| Reagent material must have the [WOOD] token.
|-
| style="vertical-align: top"| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.
|-
| style="vertical-align: top"| BUILDMAT
|
| Reagent must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| style="vertical-align: top"| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| style="vertical-align: top"| CONTAINS
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| Reagent is a container that holds the specified reagent (where ''Reagent name'' is the locally-defined name of the reagent).
|-
| style="vertical-align: top"| CONTAINS_LYE
|
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| style="vertical-align: top"| DOES_NOT_ABSORB
|
| Reagent material must have ABSORPTION:0
|-
| style="vertical-align: top"| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that [[stack]]s of reagents will correctly produce additional outputs.
|-
| style="vertical-align: top"| EMPTY
|
| If the reagent is a container, it must be empty.
|-
| style="vertical-align: top"| FIRE_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| FOOD_STORAGE_CONTAINER
|
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| style="vertical-align: top"| GLASS_MATERIAL
|
| Reagent material must have the IS_GLASS token. All 3 types of [[glass]] have this token hardcoded.
|-
| style="vertical-align: top"| HARD_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_HARD] token.
|-
| style="vertical-align: top"| HAS_EDGE
|
| Reagent must have an edge.
|-
| style="vertical-align: top"| HAS_ITEM_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the item reaction product specified by PRODUCT_ID - [[Reaction#Item_reaction_products|see below]] for more details. This can be used interchangeably with HAS_MATERIAL_REACTION_PRODUCT.
|-
| style="vertical-align: top"| HAS_MATERIAL_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the material reaction product specified by PRODUCT_ID - [[Reaction#Material_reaction_products|see below]] for more details.
|-
| style="vertical-align: top"| HAS_TOOL_USE
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE]] value
| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| style="vertical-align: top"| IS_CRAFTED_ARTIFACT{{verify}}
|
| Reagent item must be an artifact.
|-
| style="vertical-align: top"| IS_DIVINE_MATERIAL
|
| Reagent material must have the [DIVINE] token.
|-
| style="vertical-align: top"| IS_SAND_MATERIAL
|
| Reagent material must have the [SOIL_SAND] token.
|-
| style="vertical-align: top"| MAGMA_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| METAL_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_METAL] token.
|-
| style="vertical-align: top"| METAL_ORE
| style="vertical-align: top"|
* Metal ID
| Reagent material must be an ore of the specified metal.
|-
| style="vertical-align: top"| MIN_DIMENSION
| style="vertical-align: top"|
* Integer
| Reagent's item size must be at least as large as ''Integer''. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, or GLOB for this to work. See [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] below.
|-
| style="vertical-align: top"| NO_EDGE_ALLOWED
|
| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
|-
| style="vertical-align: top"| NOT_ARTIFACT{{verify}}
|
| Reagent item must not be an artifact.
|-
| style="vertical-align: top"| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
|-
| style="vertical-align: top"| NOT_ENGRAVED
|
| Reagent can not be engraved. For example, a memorial slab can not be engraved.
|-
| style="vertical-align: top"| NOT_IMPROVED
|
| Reagent has not been decorated.
|-
| style="vertical-align: top"| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| NOT_WEB
|
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| ON_GROUND
|
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from inventories (workshops, wagon) and causes infinite gathering for reactions in workshop.
|-
| style="vertical-align: top"| POTASHABLE (Deprecated)
|
| Alias for [CONTAINS_LYE].
|-
| style="vertical-align: top"| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| style="vertical-align: top"| REACTION_CLASS
| style="vertical-align: top"|
* CLASS_ID
| Reagent material must have the reaction class specified by CLASS_ID - [[Reaction#Reaction_classes|see below]] for more details.
|-
| style="vertical-align: top"| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| USE_BODY_COMPONENT
|
| Reagent must be a body part (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| style="vertical-align: top"| WEB_ONLY
|
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| WORTHLESS_STONE_ONLY
|
| Reagent material must be non-[[economic]].
|-
| style="vertical-align: top"| WOVEN_ITEM
|
| Reagent must be a clothing item made of a woven material, ie. plant, silk, or yarn cloth.
|}

=== Products ===

Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token [PRODUCT_DIMENSION:X] is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:''name''] token, where the ''name'' is the [[#Reagent name|name]] of a reagent. This requires the reagent to have the [PRESERVE_REAGENT] token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...]

==== Probability ====

The percentage chance the product will be produced when the reaction is completed.

==== Quantity ====

Determines how many of the product will be produced. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, PLANT_GROWTH, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can—for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

==== Item token ====

The [[item token]] and subtype of the item you produce.

If your item has an [[Reaction#Item reaction products|item reaction product]] and you want the item type and material to be derived from one of the reagents, you can use GET_ITEM_DATA_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of both the item token ''and'' the material token (see next section). You can also specify GET_ITEM_DATA_FROM_REAGENT:reagent:NONE in order to make a direct copy of the source item, though this will not work for complex items such as corpses or prepared meals.

For products, this can also be set to CRAFTS:NONE to produce up to three random [[craft]] items. This value cannot be used in any other context.

==== Material token ====

A [[material token]] describing what the product will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

Similarly to choosing material types for a reagent, if the item product is armor/clothing, and has the appropriate [[Entity_token#Available_resources|armor token]] in the entity file, you will be able to choose the armor/clothing size for different creatures by clicking the magnifying glass of the workshop task. However, this will only work if the product material is [[Modding pitfalls#My_custom_armor.2Fclothing_reaction_won.27t_let_user_choose_size|cloth leather or certain metals]], and the item is also recognized by the related vanilla workshop reaction{{verify}}.

==== Product modifiers ====

Zero or more tokens which further set the properties or disposition of the resulting product item.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.
|-
| style="vertical-align: top"| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.
|-
| style="vertical-align: top"| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| PRODUCT_DIMENSION
| style="vertical-align: top"|
* Integer
| Specifies the dimension of the product for those items that use dimensions. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.
|-
| style="vertical-align: top"| PRODUCT_TO_CONTAINER
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Places the product in a container; ''Name'' must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.
|-
| style="vertical-align: top"| PRODUCT_TOKEN
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Allows the product to be referred to by the given name for the purpose of being passed down as and argument in other tokens, in the same fashion as reagent names.
|-
| style="vertical-align: top"| TRANSFER_ARTIFACT_STATUS
|
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.
|}

=== Improvements ===

Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

==== Probability ====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

==== Reagent name ====
The [[#Reagent name|name]] of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

==== Improvement type ====
The following improvement types can be used:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|-
| PAGES
| Adds pages to a [[book]].
|-
| SPECIFIC
| With subtype ROLLERS, adds rollers of <material> to a [[scroll]]; with subtype HANDLE, adds a handle of <material> to an item; with subtype TRACTION_BENCH_CHAIN or TRACTION_BENCH_ROPE adds a chain or rope of <material> to an item.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

==== Material token ====

A [[material token]] describing what the decoration will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

=== Other tokens ===

==== Fuel ====

The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== Skill ====

The [[Skill token|skill tokens]] determine what skill the reaction requires and trains; also how quickly skill is gained, how quickly those skill gains raise attributes, and how skill level affects the quality of the reaction product.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| SKILL
| style="vertical-align: top"|
* [[Skill token]]
| (Optional) This identifies the skill required to carry out the reaction and is trained when the reaction is performed. Only one skill may be specified; if multiple skill tokens are defined only the last will be used. A reaction with no product will yield no experience gain. A reaction with no SKILL token will complete in a default amount of time.
|-
| style="vertical-align: top"| SKILL_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of skill gained each time the reaction is carried out. The default value is 30; higher values increase the amount of skill gain.
|-
| style="vertical-align: top"| ATTRIBUTE_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of [[Attribute|attribute]] gain that skill gain from this reaction results in. The default value is 10; higher values increase the amount of attribute gain.
|-
| style="vertical-align: top"| SKILL_ROLL_RANGE
| style="vertical-align: top"|
* Range
* Multiplier
| (Optional, requires SKILL token) This changes how much skill level affects the quality of the reaction product. The default is [SKILL_ROLL_RANGE:11:5]. The ''range'' is the base "die roll" and the ''multiplier'' determines how much the dwarf's skill can affect the reaction; the skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1), where random(x) gives a random number from 0 to x-1, inclusive (which also means that the minimum for the range is 1). The higher result on the roll, the better. Both numbers can be lowered to make the skill check harder. For example, with the default values a dwarf who is proficient in a skill has a skill level of 5; their roll will be random(11)+random(13)+random(13), meaning this dwarf can roll anywhere from 0 to 34; similarly, unskilled dwarves can roll 0 to 10 while legendary+0 (skill 15) dwarves can roll 0 to 84. If this is changed to [SKILL_ROLL_RANGE:1:8], then instead a proficient dwarf will have random(1)+random(21)+random(21), giving a roll of 0 to 40, with unskilled dwarves always rolling 0 and legendary dwarves going all the way up to 120.

As a consequence, increasing the multiplier will always make legendary dwarves more effective, even if base roll is reduced to its minimum of 1, with the default going up to 84 for default and 90 for [SKILL_ROLL_RANGE:1:6].
|}

==== Max multiplier ====

The [MAX_MULTIPLIER:<#>] token specifies how many times to do the reaction. This can be used to limit stacked reagent use to the specified quantity instead of the whole stack.

==== Automatic ====

The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== Adventure Mode enabled ====

The ADVENTURE_MODE_ENABLED token means that this version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage assuming the reaction also has a usable building assigned and is a {{token|PERMITTED_REACTION|entity}} within the entity file.

==== Description ====

This feature is exclusive to Classic Mode, as no description window pops up when mousing over reactions in workshops in Premium.

The [DESCRIPTION:<string>] token provides a text description of the reaction when it is highlighted in the building UI. Multiple DESCRIPTION tokens can be defined in a reaction, and each will appear on a new line. The pop-up box that contains the description is limited to 325 characters total. Alternatively, this token can reference a DESCRIPTION token in an existing tool definition by replacing ''string'' with USE_TOOL:<ITEM_SUBTYPE>; or an existing instrument definition with USE_INSTRUMENT:<ITEM_SUBTYPE>.

== Reaction classes and products ==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

=== Reaction classes ===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there are a half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with six nearly identical reactions that all take in either dolomite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B asks for "NONE:NONE" as its material. This means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like calcite, here:

[INORGANIC:CALCITE]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:calcite][DISPLAY_COLOR:7:7:1][TILE:'"']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:LIMESTONE:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:MARBLE:CLUSTER_SMALL:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:12902]
[SOLID_DENSITY:2930]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction. Note that some reaction classes have special meanings to the game itself—notably, the [[site finder]] knows that "FLUX" should be connected to the "Flux stone" filter.

=== Material reaction products ===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:TAN_MAT]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:TAN_MAT''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the TAN_MAT reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, the spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named TAN_MAT) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the TAN_MAT hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). For example, skin taken from a butchered dog would be turned into dog leather. Change the SKIN_TEMPLATE MATERIAL_REACTION_PRODUCT to TAN_MAT:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

As with reaction classes, some MATERIAL_REACTION_PRODUCT identifiers have special meanings to the game itself - notably, the [[site finder]] knows that "FIRED_MAT" should be connected to the "Clay" filter, and "CHEESE_MAT" is used when making [[cheese]] from [[milk]].

=== Item reaction products ===

Item reaction products are an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA_FROM_REAGENT:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

Do note that MATERIAL_REACTION_PRODUCT and ITEM_REACTION_PRODUCT use the same IDs, so you cannot have both a material and item reaction product of the same name. Also, though you cannot use GET_ITEM_DATA_FROM_REAGENT with a MATERIAL_REACTION_PRODUCT (there'd be no item type information), you ''can'' use GET_MATERIAL_FROM_REAGENT on an ITEM_REACTION_PRODUCT (in case you want to force your own item type).

== Reactions and world generation ==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

== Full token list ==

For the sake of convenience and readability, this is a complete compilation of the previously listed reaction tokens in alphabetical order:

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

|-
| style="vertical-align: top"| {{text anchor|ADVENTURE_MODE_ENABLED}}
|
|
| style="vertical-align: top"| This version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage.

|-
| style="vertical-align: top"| {{text anchor|ANY_BONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [BONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_GEM_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_GEM] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_HORN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [HORN] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_LEATHER_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [LEATHER] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PEARL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [PEARL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PLANT_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be subordinate to a PLANT object.

|-
| style="vertical-align: top"| {{text anchor|ANY_SHELL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SHELL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SILK_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SILK] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SOAP_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SOAP] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_STONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STRAND_TISSUE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| style="vertical-align: top"| {{text anchor|ANY_TOOTH_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [TOOTH] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_WOOD_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [WOOD] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_YARN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [YARN] token.

|-
| style="vertical-align: top"| {{text anchor|ATTRIBUTE_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of attribute gain given per skill improvement. Default is 10.

|-
| style="vertical-align: top"| {{text anchor|AUTOMATIC}}
|
|
| style="vertical-align: top"| The reaction will be queued automatically if the reaction reagents are all present.

|-
| style="vertical-align: top"| {{text anchor|BAG}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead. Deprecated as of Version 0.50.01 in favor of BAG:NONE [[item token]].

|-
| style="vertical-align: top"| {{text anchor|BUILDING}}
| style="vertical-align: top"|
* [[#building name|Building name]]
* [[#building key|In-building reaction hotkey]]
|
| style="vertical-align: top"| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game.

|-
| style="vertical-align: top"| {{text anchor|BUILDMAT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is able to be used to build structures (Boulders, Wood, Blocks, Bars).

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_ARTIFACT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_HOSPITAL_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[healthcare|hospital]].

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_LOCATION_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[locations|location]].

|-
| style="vertical-align: top"| {{text anchor|CATEGORY}}
| style="vertical-align: top"|
* Category ID
|
| style="vertical-align: top"| Puts the reaction in a category. Categories are custom submenus for reaction menus. The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_NAME}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| The name of the category as displayed in-game.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_DESCRIPTION}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_PARENT}}
| style="vertical-align: top"|
* Category ID
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_KEY}}
| style="vertical-align: top"|
* Hotkey
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey while playing in Classic mode.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is a container that holds the specified reagent.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS_LYE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| style="vertical-align: top"| {{text anchor|DESCRIPTION}}
| style="vertical-align: top"|
* String
|
| style="vertical-align: top"| A description of the reaction that appears when it is highlighted in the building UI. ''String'' can also be replaced with a reference to existing DESCRIPTION tokens in tools (using USE_TOOL:<tool_id>) or musical instruments (using USE_TOOL:<instrument_id>).

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_ABSORB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have [ABSORPTION:0].

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_DETERMINE_PRODUCT_AMOUNT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| style="vertical-align: top"| {{text anchor|EMPTY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must be empty.

|-
| style="vertical-align: top"| {{text anchor|FIRE_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be considered [[fire-safe]] (stable [[temperature]] below {{ct|11000}}) - i.e. not wood, and not coal.

|-
| style="vertical-align: top"| {{text anchor|FORCE_EDGE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is given a sharp edge. Used for knapping.

|-
| style="vertical-align: top"| {{text anchor|FOOD_STORAGE_CONTAINER}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a barrel or any non-absorbing tool with [TOOL_USE:FOOD_STORAGE].

|-
| style="vertical-align: top"| {{text anchor|FUEL}}
|
|
| style="vertical-align: top"| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop.

|-
| style="vertical-align: top"| {{text anchor|GLASS_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material has [IS_GLASS].

|-
| style="vertical-align: top"| {{text anchor|HAS_EDGE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be sharpened (used for carving).

|-
| style="vertical-align: top"| {{text anchor|HAS_ITEM_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to HAS_MATERIAL_REACTION_PRODUCT, but requires the reagents material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| style="vertical-align: top"| {{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to REACTION_CLASS, but requires the reagents material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| style="vertical-align: top"| {{text anchor|HAS_TOOL_USE}}
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE value]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagents item type must be TOOL:NONE for this to make any sense.

|-
| style="vertical-align: top"| {{text anchor|HAS_WRITING_IMPROVEMENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must contain writing.

|-
| style="vertical-align: top"| {{text anchor|IMPROVEMENT}}
| style="vertical-align: top"|
* Probability
* [[#Reagent name|Reagent name]]
* Improvement type
* Material Token
|
| style="vertical-align: top"| Applies an improvement to the named reagent. Only meaningful if said reagent has [PRESERVE_REAGENT]. Improvement types include BANDS, COVERED, GLAZED, PAGES, RINGS_HANGING, and SPIKES

|-
| style="vertical-align: top"| {{text anchor|IS_CRAFTED_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must be an artifact.

|-
| style="vertical-align: top"| {{text anchor|IS_DIVINE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [DIVINE] token.

|-
| style="vertical-align: top"| {{text anchor|MAGMA_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Currently broken - Reagent must be considered [[magma-safe]] (stable [[temperature]] below {{ct|12000}}).

|-
| style="vertical-align: top"| {{text anchor|MAX_MULTIPLIER}}
| style="vertical-align: top"|
* Integer
|
| style="vertical-align: top"| Sets the maximum number of times a reaction is allowed to run when using stacked reagents. This can be used to ensure that the reaction doesn't repeat until the entire stack is depleted.

|-
| style="vertical-align: top"| {{text anchor|METAL_ORE}}
| style="vertical-align: top"|
* Inorganic material
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be an ore of the specified metal.

|-
| style="vertical-align: top"| {{text anchor|MIN_DIMENSION}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires that the reagent have a size of at least ''integer''. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, and GLOB items.

|-
| style="vertical-align: top"| {{text anchor|NAME}}
| style="vertical-align: top"|
* [[#name|Name]]
|
| style="vertical-align: top"| Defines the name used by the reaction in-game.

|-
| style="vertical-align: top"| {{text anchor|NO_EDGE_ALLOWED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.

|-
| style="vertical-align: top"| {{text anchor|NOT_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must not be an artifact.

|-
| style="vertical-align: top"| {{text anchor|NOT_CONTAIN_BARREL_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| style="vertical-align: top"| {{text anchor|NOT_ENGRAVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been engraved i.e. a blank memorial slab.
|-
| style="vertical-align: top"| {{text anchor|NOT_IMPROVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been decorated.

|-
| style="vertical-align: top"| {{text anchor|NOT_PRESSED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|NOT_WEB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| style="vertical-align: top"| {{text anchor|ON_GROUND}}
|
| style="vertical-align: top"| Reagent modifier
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from bins in stockpiles, nor inventories (workshops, wagon). Causes infinite collection of items if reaction is in workshop, as reagents are no longer on ground when brought to workshop. Untested in adventure mode; possibly more useful for adv. mode reactions.

|-
| style="vertical-align: top"| {{text anchor|POTASHABLE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Alias for [CONTAINS_LYE].

|-
| style="vertical-align: top"| {{text anchor|PRESERVE_REAGENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT}}
| style="vertical-align: top"|
*Probability of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
|
| style="vertical-align: top"| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA_FROM_REAGENT can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_DIMENSION}}
| style="vertical-align: top"|
* Size
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Specifies the amount of the product for those items that use dimension. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PASTE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PASTE state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PRESSED}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TO_CONTAINER}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Places the product in a container; reagent name must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TOKEN}}
| style="vertical-align: top"|
* Name
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Allows the product to be referred to by the given name, for the purpose of being passed down as argument in other tokens in the same fashion as reagent names.

|-
| style="vertical-align: top"| {{text anchor|REACTION}}
| style="vertical-align: top"|
* Identifier
|
| style="vertical-align: top"| Defines a new reaction.

|-
| style="vertical-align: top"| {{text anchor|REACTION_CLASS}}
| style="vertical-align: top"|
* CLASS_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
| style="vertical-align: top"| {{text anchor|REAGENT}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
* [[#quantity|Quantity]]
* [[Item token]]
* [[Material token]]
|
| style="vertical-align: top"| Specifies a given reagent as an input for a reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL}}
| style="vertical-align: top"|
* [[Skill token]]
|
| style="vertical-align: top"| Skill used by the reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of skill given per product made. Default is 30.

|-
| style="vertical-align: top"| {{text anchor|SKILL_ROLL_RANGE}}
| style="vertical-align: top"|
* Range
* Multiplier
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Determines how [[skill]] level affects [[quality]] of the reaction product. The skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1). random(x) returns a number between 0 and x-1, so range is always 1 or more. The default is 11. The default multiplier is 5. Higher skill rolls give better results.

|-
| style="vertical-align: top"| {{text anchor|TRANSFER_ARTIFACT_STATUS}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.

|-
| style="vertical-align: top"| {{text anchor|UNROTTEN}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be rotten, mainly for organic materials.

|-
| style="vertical-align: top"| {{text anchor|USE_BODY_COMPONENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must come off a creature's body.

|-
| style="vertical-align: top"| {{text anchor|WEB_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| style="vertical-align: top"| {{text anchor|WORTHLESS_STONE_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not made of an economic stone.

|-
| style="vertical-align: top"| {{text anchor|WOVEN_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be a woven material, eg. plant cloth, silk, yarn. This ''excludes'' CLOTH or THREAD items.

|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Reaction]]

Tree

2023-02-02T05:04:12Z

Qeveren: /* Fruit */ edited list of fruit and nut producing trees

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{Translation
| dwarven = dák
| elvish = thelire
| goblin = tonspe
| human = akan
}}

{{buggy}}

'''Trees''' are a multi-[[tile]] feature that can be found aboveground on all but the most arid or mountainous of maps, and below ground in the [[cavern]]s. The types of trees that grow in a given location depend on that location's [[biome]], as different species prefer different conditions. For example, tropical areas often have palm trees, while colder areas feature pines. Underground trees such as [[nether-cap]]s are an exception, as they will grow anywhere underground. The species of a tree in turn determines its properties, including its structure, the color and density of its wood and what kind of growths it produces. Note also that "trees" in ''Dwarf Fortress'' also covers things that are not actually trees, such as palms, cacti, large herbaceous plants (e.g. [[banana]]s), and large mushrooms (underground trees).

Trees are used as a source of [[wood]], an essential resource in the game, irreplaceable (or hard to replace) for some applications. Thus, the amount of local trees greatly affects fortress development, as without a ready source of wood, the player will be forced to rely on [[trade]] to get it. Tree growth density on the [[embark]] site is determined by its [[biome]], so it is displayed with the rest of the biome properties (temperature, etc.) on the "Choose Fortress Location" screen at embark.

[[File:trees_many.jpg|thumb|320px|right|Beautiful, until turned into [[table]]s. Then they are even more beautiful. OTOH, the forgoing being a [[dwarf|dwarven]] [[elf|opinion]]... ]]

== Structure ==
[[File:Tree animated.gif|thumb|Animation of all z-levels of an [[Apricot]] tree]]
Trees consist of several types of tiles - '''roots''', '''trunk''' sections, '''thick branches''', '''branches''', and '''twigs''', that may be covered in a number of "growths" (leaves, needles, flowers, fruit, cones, etc.), depending on species and season. A single tree is a structure that can span multiple tiles of each type in both horizontal and vertical directions. For example, a typical deciduous tree will have a single tile-wide trunk at ground level supporting a multiple-level crown of intertwined trunk sections, branches and twigs covered with leaves. Not all species follow the same scheme, though - palms have a high, naked trunk that doesn't branch and just a tuft of leaves on top of it, and some species can have trunks that are thicker than a single tile at ground level. Trees also have an underground system of roots, but there is only one kind of root tile and the extent of the root system doesn't seem to vary with species.

Graphically, vertical 1×1 trunk sections resemble wooden columns {{tile|O|6:0}}. The thicker trunks (2×2 and 3×3) are represented by rounded double-line structures. Above the first ground level the trunk may branch out, producing horizontal trunk sections that resemble wooden [[wall]]s {{tile|║|6:0}}. These can peter out into thick branches {{tile|│|6:0}} or end directly with branches {{tile|¼|2:0}}. The branches can extend further out, ending with twigs {{tile|;|2:0}}. A vertical trunk end, if not covered with a branch, is represented by a pointed cap {{tile|⌂|6:0}}.

Root tiles ({{tile|¼|6:0}}) overlap a number of underground tiles below each tree. They can be designated for digging, but because they usually use the same brown color as the mining designation rectangle, the designation is not evident (the only exceptions are trees with white roots). Some trees can have multiple tiles of roots, others just the one{{verify}}.

Dug-away roots of a tree can spawn twigs and fruits of the tree around them if there is space and grass/cave moss there. You can in principle access fruit trees from below the tree, without putting a dwarf in danger or walling off the tree.

There are exceptions to the description above. [[Saguaro]]s don't have any leafy branches or twigs, just a trunk and thick branches. Mushroom cap trees that grow in the caverns underground don't have branches - instead they have a '''cap''' consisting of ramps that can be walked upon.

Trees can be [[climb]]ed in both fortress and [[adventurer mode]]. In densely wooded areas, the overlapping tree crowns can form a continuous canopy that can be traversed by walking, climbing and/or jumping. Both thick and regular branches provide a floor-like support for walking. Twigs are too frail to support the weight of a dwarf, but they can be climbed through and jumped over. All kinds of trunk tiles are treated as solid barriers, except trunk tips - they can be climbed through and jumped over like twigs.

On ground level, tree trunks are obstacles that prevent [[channel]]ing or the creation of [[wall]]s and other [[construction]]s on their tiles. This is problematic for caravan [[wagon]]s, which require a path at least three tiles wide in order to access your fortress; on heavily forested maps it may be necessary to check [[trade depot|depot]] access ({{k|D}}) every once in a while as trees continue to grow to make sure wagons can get through, and chop down ({{k|d}}-{{k|t}}) the impeding forest if they can't. Later on this can actually become a blessing, as if there is only one or a few pathways to the fortress it makes it easier to route incoming caravans down certain well-defended pathways, instead of allowing them to choose their own way across the map, where they may fall foul of ambushers or worse. It also makes building above-ground constructions more challenging, as any trees in the way must be chopped down first.

A tree's branches and leaves will result in the tiles below them being considered "inside", leading to the formation of [[miasma]] if corpse and body parts decay while under them. It is therefore advisable to ensure no trees grow in the immediate vicinity of your corpse stockpiles.

<gallery caption="Heights of a tree" widths="90px" heights="90px" perrow="5">
File:Tree-1.png|1 level below ground: roots in a [[Red sand]] wall on the side of a hill
File:Tree0.png|Ground level: trunk
File:Tree+1.png|1 level above ground, trunk, branches and twigs
File:Tree+2.png|2 levels above ground
File:Tree+3.png|3 levels above ground, includes some Open Space
File:Tree+4.png|4 levels above ground
File:Tree+5.png|5 levels above ground
File:Tree+6.png|6 levels above ground
File:Tree+7.png|7 levels above ground, only Open Space
</gallery>

=== Growths ===
Growths are the things that grow ''on'' a tree, i.e: they are not an essential part of the tree's structure and can be shed or picked without destroying the tree. This includes leaves, needles, flowers, fruit, seed pods, catkins, cones, etc. Each tree species has at least one type of growth, the most common one, unsurprisingly, being leaves.

The leaves of deciduous trees change color in the autumn, fall before the winter and grow back in the spring. Fallen leaves will color the tiles beneath their trees, turning the forest floor into a colorful patchwork.

Trees of fruit-producing species usually grow flowers in spring and fruit later in the year. Flowers will fall in a cloud during the transition from flowers to fruit; the cloud is shown falling, and examining the ground after that will show "<tree> flowers" in addition to other tile contents. Both flowers and fruit appear and fall at set times through the year, so it is possible that a young tree that has never flowered will give fruit.

Fruit can be picked from trees in Adventure mode. Fortress mode harvesting is done with a [[stepladder]] (as long as the fruit-bearing tree is within a plant gathering zone) or by collecting fallen fruits. Fruit can be brewed at a [[still]]. Cutting down a tree with fruit causes the fruit to vanish{{verify}}.

If a tree is set on fire in fortress mode and is described as 'dead' when examined, it will eventually rejuvenate itself and come back to life after a few years, starting from the trunk and leading out into the branches if left alone.

== Chopping down trees ==
{{main|Woodcutting}}

Trees can be cut down by dwarves to produce [[wood]]. It is enough to [[designations menu|designate]] only one trunk tile for cutting to chop down the whole tree it belongs to. Any trunk tile will do, even those that are above ground, or even a single tile of a multi-tile trunk. As a result, it is impossible to "prune" trees by chopping down only parts of them.

Once a woodcutter is done with the first tile, the tree instantly converts to a number of free-floating logs that fall to the ground in a direction away from the cutter. Cutting a tree from a trunk section above ground level may result in the woodcutter losing their footing and crashing to the ground (similar to having a tile deconstructed under their feet).

If you dug the tile below the trunk before cutting the tree, it will leave a hole to the surface, potentially allowing dangerous creatures to path into your underground fort. Avoid digging directly below one z-level in wooded areas before clearing out the trees, and make sure to check for open floor spaces {{Tile|·|0:1}} on the surface afterwards. If holes are present, construct [[floor]] tiles over the holes, which will prevent creatures from moving below. Constructing a wall below the open floor will work as well. Unexplained underground logs can alert you to the presence of these "guest entrances". Moving a building preview all around the surface (kennels are good for their size) and inspecting any non-ramp or tree invalid tiles can sweep large areas.

If you had [[smoothing|smoothed]] the wall below the trunk and then cut down the tree, it will leave an open floor above the smoothed wall, unlike constructed walls (see this [[tile#Walls|diagram]] for a visual illustration). If there is an open space adjacent to the smoothed wall, creatures can diagonally move below the adjacent space (by swimming, flying, or climbing) from the open floor above. Such occurrences should be uncommon, as it requires the tile below the tree to be made of stone (so it can be smoothed), and occur mainly in [[mountain]] biomes and areas affected by erosion.

=== Objects and tiles in trees ===

Some trees have been found to have objects or tiles contained within the branches. Cutting down these trees can be hazardous to your dwarves. You can check all the z-levels of every tree you wish to cut, or you can just take the risk and experience occasional fun!

== Products ==
=== Wood ===
{{main|Wood}}

One of the variations between the different tree species is in the weight and color of their wood. Weight is often a minor concern but when using wood to create objects that will be moved, such as bins or buckets, choosing lighter wood is an advantage as it will be hauled faster. Heavier wood will make wooden weapons and siege engine projectiles more effective, while lighter wooden shields reduce penalties to speed while blocking just as well as heavier shields.

Nonetheless, all types of wood have the same (low) value (beyond the [[preference]]s of individual dwarves), although the [[color]] of the wood may matter for aesthetic purposes.

=== Fruit ===
Various kinds of tree produce fruit. In [[dwarf fortress mode]], they can be gathered with a [[stepladder]] in a designated [[zone#Gather/pick Fruit|plant gathering zone]], and [[Elf|elves]] will also bring fruit to [[trading|trade]]. Fruit can be eaten, producing [[seed]]s. The following trees produce usable fruit in vanilla: apple, apricot, avocado, banana, bayberry, bitter orange, carambola, cashew, cherry, citron, coconut palm, coffee, custard-apple, date palm, desert lime, durian, finger lime, guava, kumquat, lime, lychee, mango, olive, orange, papaya, paradise nut, peach, pear, persimmon, plum, pomegranate, pomelo, rambutan, round lime, saguaro, and sand pear. Not all of these can be brewed; see [[alcohol]] for a list of brewable fruit.

Instead of fruit some trees will produce nuts, which are actually seeds. Since tree seeds currently can't be planted, feel free to allow cooking of these. The nut-producing trees in vanilla are: almond, candlenut, chestnut, hazel, macadamia, oak, pecan, and walnut.

== Growing trees ==
Trees grow from '''saplings''', which start growing randomly on non-occupied tiles of a suitable biome; thus chopping down a forest may create a clearing, but within a couple of years a new forest will have grown. Saplings will not grow to maturity if their tile contains an item or building (including stockpile designations), though removing the item may cause the tree to spontaneously grow up. Saplings will block the construction of farm plots unless there is also a dusting or pile of mud beneath them.

Saplings can be killed by heavy [[traffic|foot traffic]] and removed by building a road on them, but not by flooding — they can survive submergence for extended periods of time and will still grow to maturity once the water level drops to 4/7{{verify}} or lower. Dead saplings will remain for some seasons, and then disappear, more quickly if heavy traffic tramples them away. Many underground trees are called "young <tree>" instead of sapling, but the concept is the same. Paved [[road]]s and (even unbuilt) [[farm plot]]s periodically purge all terrain features below them, preventing trees (or shrubs) from growing in unwanted areas. Trees cannot grow on stairs or ramps, making it possible to keep trees out of your plumbing by using {{K|u}}p stairs instead of {{K|d}}igging (this does not reveal the tile above). Above-ground trees will only grow in areas where there is sufficient soil one z-level beneath them (currently observed to be at least one unmined tile within a two-tile radius); underground trees not only ignore this restriction for dry subterranean soil but will also grow on muddy subterranean stone.

Trees ''cannot'' be specifically "planted" ([http://www.bay12games.com/dwarves/dev.html as of yet]); even if a map is stripped of all trees, new saplings will regrow, randomly and in their own time. (Sadly, the [[elf|elves]] do not seem to comprehend this.) It is possible to [[tree farming|farm]] trees by walling off or engineering a patch of soil and locking it away so your dwarves don't trample all over it, but it will take a long time for the farm to yield results. After you expose the caverns, subterranean flora (including trees) will begin to grow on any exposed, previously-bare soil within your fortress; this can be annoying when a copse of [[blood thorn]]s suddenly appears in your [[sand#Glass|sand collection]] area, but allows you to easily mine out large subterranean [[Tree farming|tree farms]] full of colorful subterranean trees.

If a sapling grows into a tree, it can block off narrow areas, such as one-tile-long hallways in a muddy cavern layer. This can cause dwarves to take longer alternate routes to perform their jobs, or entrap them entirely.
{{clear}}

One can grow additional tree branches by digging away parts of tree roots and replacing them with grass or cave moss. Afterwards, when tree grows, it may spread (fruit-bearing) branches there.

== Growth rate & wood yield ==

From the time a sapling appears, it takes about three years for a tree to grow. Trees make a growth check once every year, and then grow randomly - it's possible for a tree to reach eight z-levels of height in a decade, not have gone past five in three or avoid growing branches at all initially.

Most tree raws currently specify exactly the same canopies. They'll yield more wood overall with sparser cutting, though the breakeven point is unknown presently. Each "tree trunk" tile will yield exactly one log, while light branches, twigs and (brown) heavy branches will give nothing. The size of aboveground trees at embark depends heavily on unknown factors beyond age and species; possibly temperature, latitude or biome?{{Verify}}

For wood, branching trees with nonbranching trunks (Papayas, Ginkgos, Saguaros, Pines, Cedars, Fungiwoods, Alders, and Birches) should be cut down preferentially, as their branches will obscure saplings and their trunks grow slower. They will not yield any more wood past reaching their maximum trunk height (4-9 depending on species). Vice-versa, Glumprong trees are near-ideal for forestry, as they're all trunk, though their max height is limited to 8.

Palm trees don't obscure other ones with canopies, so should be cut when wood is needed or when they reach their maximum height of 9.

Mushroom caps of subterranean 'trees' don't contribute to their wood yield, and thus will never yield additional wood past their sprouting.

== Aboveground trees ==

Most of them bear fruits and nuts, which can be [[Activity zone#Gather/Pick Fruit|harvested]] for food and drinks.


{{multi-tile tree table head}}
{{multi-tile tree table row|name=Abaca|super=3|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:1}} flower
}}
{{multi-tile tree table row|name=Acacia|symbol=♠|color=2:0|decid=No|biome=Tropical Dry Broadleaf Forest|biome2=Tropical Grassland|biome3=Tropical Savanna|biome4=Tropical Shrubland|dry=y|dense=0.600
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} seed pod
}}
{{multi-tile tree table row|name=Avocado|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.540
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|2:0}} fruit
}}
{{multi-tile tree table row|name=Banana|super=3|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|¼|6:0}} roots
|drink=Banana beer|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:0}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Bitter orange|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Cacao tree|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.430
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:0}} fruit
}}
{{multi-tile tree table row|name=Candlenut|symbol=Γ|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.140
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|6:0}} nut
}}
{{multi-tile tree table row|name=Carambola|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.550
|drink=Carambola wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|3:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Cashew|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.450
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Citron|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.700
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Coconut palm|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.680
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|6:0}} roots
|eat=y|cook=y
|grow1={{tile|*|2:0}} leaf
|grow2={{tile|♣|2:0}} spathe
|grow3={{tile|•|6:0}} fruit
}}
{{multi-tile tree table row|name=Coffee|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.620
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Custard-apple|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.360
|drink=Custard-apple cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Date palm|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=b|dense=0.820
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|6:0}} roots
|drink=Date wine|drinkv=10|eat=y|cook=y
|grow1={{tile|*|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Desert lime|symbol=♠|color=2:0|decid=No|biome=Tropical Grassland|biome2=Tropical Savanna|biome3=Tropical Shrubland|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Durian|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.520
|drink=Durian wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:0}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Finger lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Guava|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.610
|drink=Guava wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Kapok|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.260
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|2:1}} fruit
}}
{{multi-tile tree table row|name=Kumquat|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Lychee|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.880
|drink=Lychee wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|5:1}} fruit
}}
{{multi-tile tree table row|name=Macadamia|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.705
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Mahogany|symbol=♠|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.600
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|6:1}} flower
|grow3={{tile|•|6:0}} fruit
}}
{{multi-tile tree table row|name=Mango tree|symbol=Γ|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.520
|drink=Mango wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:1}} flower
|grow3={{tile|•|6:1}} fruit
}}
{{multi-tile tree table row|name=Olive|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.990
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|0:1}} fruit
}}
{{multi-tile tree table row|name=Orange|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Papaya|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.130
|drink=Papaya wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Paradise nut|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.820
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|6:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Pomelo|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Rambutan|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.620
|drink=Rambutan wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Round lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Rubber tree|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.490
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
}}
{{multi-tile tree table row|name=Tea|symbol=♣|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.560
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Pomegranate|symbol=Γ|color=2:0|decid=Yes|biome=Any Tropical|dry=y|dense=0.770
|drink=Pomegranate wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|4:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Mangrove|symbol=♣|color=2:0|decid=No|biome=Mangrove Swamp|dry=n|dense=0.830
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|4:1}} fruit
}}
{{multi-tile tree table row|name=Cedar|symbol=↨|color=2:0|decid=No|biome=Temperate Coniferous Forest|biome2=Tropical Coniferous Forest|dry=y|dense=0.570
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|*|2:0}} scale-leaf
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|5:0}} pollen cone
}}
{{multi-tile tree table row|name=Feather tree|symbol=♣|color=7:1|decid=No|biome=Not Freezing|dry=y|align=Good|dense=0.100
|tile1={{tile|O|7:1}}{{tile|═|7:1}}{{tile|⌂|7:1}} trunk
|tile2={{tile|─|7:1}} thick branches
|tile3={{tile|¼|7:1}} branches
|tile4={{tile|;|7:1}} twigs
|tile5={{tile|¼|7:1}} roots
|eat=n|cook=y
|grow1={{tile|♠|7:1}} down
|grow2={{tile|%|7:1}} egg
}}
{{multi-tile tree table row|name=Glumprong|symbol=┤|color=5:0|decid=No|biome=Not Freezing|dry=y|align=Evil|dense=1.200
|tile1={{tile|O|5:0}}{{tile|═|5:0}}{{tile|⌂|5:0}} trunk
|tile2={{tile|¼|5:0}} roots
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Highwood|symbol=¶|color=2:0|decid=No|biome=Not Freezing|dry=y|align=Savage|dense=0.500
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|3:1}} flower
}}
{{multi-tile tree table row|name=Saguaro|symbol=╞|color=2:0|decid=No|biome=Any Desert|dry=y|dense=0.430
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|─|2:0}} thick branches
|tile3={{tile|¼|2:0}} roots
|eat=y|cook=y
|grow1={{tile|♣|7:1}} flower
|grow2={{tile|•|4:1}} fruit
}}
{{multi-tile tree table row|name=Willow|symbol=⌠|color=2:0|decid=No|biome=Any Temperate|biome2=Any Tropical Forest|biome3=Tropical Grassland|biome4=Tropical Savanna|biome5=Tropical Shrubland|biome6=Tropical Freshwater Swamp|biome7=Tropical Saltwater Swamp|biome8=Tropical Freshwater Marsh|biome9=Tropical Saltwater Marsh|dry=n|dense=0.390
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|*|7:1}} pollen catkin
|grow3={{tile|*|7:1}} seed catkin
|grow4={{tile|*|6:0}} fruit
}}
{{multi-tile tree table row|name=Alder|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.410
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|4:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
|grow4={{tile|*|6:0}} cone
}}
{{multi-tile tree table row|name=Almond|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|eat=Seed|super=4||cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Apple|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.745
|drink=Apple cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:0}} fruit
}}
{{multi-tile tree table row|name=Apricot|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.745
|drink=Apricot wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Ash (tree)|alt=Ash|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.600
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Birch|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.650
|tile1={{tile|O|7:1}}{{tile|⌂|7:1}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|7:1}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
}}
{{multi-tile tree table row|name=Cherry|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.425
|drink=Cherry wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Chestnut|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.430
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|7:1}} pollen catkin
|grow3={{tile|*|7:1}} seed catkin
|grow4={{tile|*|2:0}} burr
}}
{{multi-tile tree table row|name=Ginkgo|symbol=↑|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.450
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|%|7:1}} seed
}}
{{multi-tile tree table row|name=Hazel|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.500
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:1}} pollen catkin
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Maple|symbol=♣|color=2:0|decid=Yes|biome=Temperate Broadleaf Forest|biome2=Temperate Grassland|biome3=Temperate Savanna|biome4=Temperate Shrubland|dry=y|dense=0.540
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Oak|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.700
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|2:0}} flower
|grow3={{tile|•|6:0}} acorn
}}
{{multi-tile tree table row|name=Peach|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|drink=Peach cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Pear|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.600
|drink=Perry|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Pecan|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.735
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|2:1}} pollen catkin
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Persimmon|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.835
|drink=Persimmon wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Plum|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|drink=Plum wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Sand pear|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.690
|drink=Sand pear cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Walnut|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.562
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|♣|2:1}} flower
|grow4={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Bayberry|symbol=♠|color=2:0|decid=No|biome=Any Temperate|biome2=Taiga|dry=y|dense=0.700
|drink=Bayberry wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
|grow4={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Larch|symbol=↑|color=2:0|decid=Yes|biome=Taiga|biome2=Temperate Coniferous Forest|dry=y|dense=0.590
|eat=n|cook=n
|grow1={{tile|*|2:0}}{{tile|*|6:1}}{{tile|*|4:1}}{{tile|*|4:0}} needle
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|2:0}} pollen cone
}}
{{multi-tile tree table row|name=Pine|symbol=↑|color=2:0|decid=No|biome=Taiga|biome2=Temperate Coniferous Forest|biome3=Tropical Coniferous Forest|dry=y|dense=0.510
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|*|2:0}} branches
|tile3={{tile|*|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|*|2:0}} needle
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|4:0}} pollen cone
}}
|}

'''Notes:'''
:1 This is the value for a stack of 5 units, which is the number rendered from a single fruit.
:2 Anything that can be cooked is edible afterwards.
:3 These trees do not produce wood when cut.
:4 These trees only edible raw product is seed, which dwarves will not currently eat raw despite the tag.

== Underground trees ==

These are the trees that can grow in subterranean caverns. None of them produce growths.

{{multi-tile tree table head}}
{{multi-tile tree table row|name=Fungiwood|symbol=♣|color=6:1|decid=No|biome=Subterranean Water/Layers 1-2|dry=b|dense=0.600
|tile1={{tile|O|6:1}}{{tile|⌂|6:1}} trunk
|tile2={{tile|¼|6:1}} branches
|tile3={{tile|;|6:1}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Tower-cap|symbol=♠|color=7:1|decid=No|biome=Subterranean Water/Layers 1-2|dry=b|dense=0.600
|tile1={{tile|O|7:1}} trunk
|tile2={{tile|O|7:1}}{{tile|║|7:1}}{{tile|▲|7:1}}{{tile|∙|7:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Black-cap|symbol=♠|color=0:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.650
|tile1={{tile|O|0:1}} trunk
|tile2={{tile|O|0:1}}{{tile|║|0:1}}{{tile|▲|0:1}}{{tile|∙|0:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Goblin-cap|symbol=♠|color=4:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.600
|tile1={{tile|O|4:1}} trunk
|tile2={{tile|O|4:1}}{{tile|║|4:1}}{{tile|▲|4:1}}{{tile|∙|4:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Spore tree|symbol=♣|color=3:0|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.600
|tile1={{tile|O|3:0}}{{tile|═|3:0}}{{tile|⌂|3:0}} trunk
|tile2={{tile|─|3:0}} thick branches
|tile3={{tile|¼|3:0}} branches
|tile4={{tile|;|3:0}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Tunnel tube|symbol=│|color=5:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.500
|tile1={{tile|O|5:1}}{{tile|═|5:1}}{{tile|⌂|5:1}} trunk
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Blood thorn|symbol=╡|color=4:0|decid=No|biome=Subterranean Water|biome2=Subterranean Chasm/Layer 3|dry=b|dense=1.250
|tile1={{tile|O|4:0}}{{tile|═|4:0}}{{tile|⌂|4:0}} trunk
|tile2={{tile|─|4:0}} thick branches
|tile3={{tile|¼|4:0}} branches
|tile4={{tile|;|4:0}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Nether-cap|symbol=♠|color=1:0|decid=No|biome=Subterranean Water/Layer 3|dry=b|dense=0.550
|tile1={{tile|O|1:0}} trunk
|tile2={{tile|O|1:0}}{{tile|║|1:0}}{{tile|▲|1:0}}{{tile|∙|1:0}} cap
|eat=n|cook=n
}}
|}

==Bugs==
* Trees grow through bridges. {{bug|7872}}
* Cutting down trees will leave a hole in the floor if the layer below has been mined (which has the potential for lots of fun, especially considering invaders). {{bug|8469}}
* Trees not yielding wood will not be generated. {{bug|10581}}
* Some underground trees will only give one log. {{bug|7313}}

==Trivia==
*It is possible for animals to be stuck up in trees at the moment of embarking. This will cause them to starve to death after a while as they have no means of getting down. So the player should check higher z-levels above the wagon once the playing area is generated, and immediately cutting down any trees animals are stuck in.
{{Plants}}

[[Category:Map tiles]]
{{Category|Trees}}
[[ru:Tree]]

Tree

2023-02-02T04:19:47Z

Qeveren: /* Growths */ Removed reference to prev. version "look" keybind.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{Translation
| dwarven = dák
| elvish = thelire
| goblin = tonspe
| human = akan
}}

{{buggy}}

'''Trees''' are a multi-[[tile]] feature that can be found aboveground on all but the most arid or mountainous of maps, and below ground in the [[cavern]]s. The types of trees that grow in a given location depend on that location's [[biome]], as different species prefer different conditions. For example, tropical areas often have palm trees, while colder areas feature pines. Underground trees such as [[nether-cap]]s are an exception, as they will grow anywhere underground. The species of a tree in turn determines its properties, including its structure, the color and density of its wood and what kind of growths it produces. Note also that "trees" in ''Dwarf Fortress'' also covers things that are not actually trees, such as palms, cacti, large herbaceous plants (e.g. [[banana]]s), and large mushrooms (underground trees).

Trees are used as a source of [[wood]], an essential resource in the game, irreplaceable (or hard to replace) for some applications. Thus, the amount of local trees greatly affects fortress development, as without a ready source of wood, the player will be forced to rely on [[trade]] to get it. Tree growth density on the [[embark]] site is determined by its [[biome]], so it is displayed with the rest of the biome properties (temperature, etc.) on the "Choose Fortress Location" screen at embark.

[[File:trees_many.jpg|thumb|320px|right|Beautiful, until turned into [[table]]s. Then they are even more beautiful. OTOH, the forgoing being a [[dwarf|dwarven]] [[elf|opinion]]... ]]

== Structure ==
[[File:Tree animated.gif|thumb|Animation of all z-levels of an [[Apricot]] tree]]
Trees consist of several types of tiles - '''roots''', '''trunk''' sections, '''thick branches''', '''branches''', and '''twigs''', that may be covered in a number of "growths" (leaves, needles, flowers, fruit, cones, etc.), depending on species and season. A single tree is a structure that can span multiple tiles of each type in both horizontal and vertical directions. For example, a typical deciduous tree will have a single tile-wide trunk at ground level supporting a multiple-level crown of intertwined trunk sections, branches and twigs covered with leaves. Not all species follow the same scheme, though - palms have a high, naked trunk that doesn't branch and just a tuft of leaves on top of it, and some species can have trunks that are thicker than a single tile at ground level. Trees also have an underground system of roots, but there is only one kind of root tile and the extent of the root system doesn't seem to vary with species.

Graphically, vertical 1×1 trunk sections resemble wooden columns {{tile|O|6:0}}. The thicker trunks (2×2 and 3×3) are represented by rounded double-line structures. Above the first ground level the trunk may branch out, producing horizontal trunk sections that resemble wooden [[wall]]s {{tile|║|6:0}}. These can peter out into thick branches {{tile|│|6:0}} or end directly with branches {{tile|¼|2:0}}. The branches can extend further out, ending with twigs {{tile|;|2:0}}. A vertical trunk end, if not covered with a branch, is represented by a pointed cap {{tile|⌂|6:0}}.

Root tiles ({{tile|¼|6:0}}) overlap a number of underground tiles below each tree. They can be designated for digging, but because they usually use the same brown color as the mining designation rectangle, the designation is not evident (the only exceptions are trees with white roots). Some trees can have multiple tiles of roots, others just the one{{verify}}.

Dug-away roots of a tree can spawn twigs and fruits of the tree around them if there is space and grass/cave moss there. You can in principle access fruit trees from below the tree, without putting a dwarf in danger or walling off the tree.

There are exceptions to the description above. [[Saguaro]]s don't have any leafy branches or twigs, just a trunk and thick branches. Mushroom cap trees that grow in the caverns underground don't have branches - instead they have a '''cap''' consisting of ramps that can be walked upon.

Trees can be [[climb]]ed in both fortress and [[adventurer mode]]. In densely wooded areas, the overlapping tree crowns can form a continuous canopy that can be traversed by walking, climbing and/or jumping. Both thick and regular branches provide a floor-like support for walking. Twigs are too frail to support the weight of a dwarf, but they can be climbed through and jumped over. All kinds of trunk tiles are treated as solid barriers, except trunk tips - they can be climbed through and jumped over like twigs.

On ground level, tree trunks are obstacles that prevent [[channel]]ing or the creation of [[wall]]s and other [[construction]]s on their tiles. This is problematic for caravan [[wagon]]s, which require a path at least three tiles wide in order to access your fortress; on heavily forested maps it may be necessary to check [[trade depot|depot]] access ({{k|D}}) every once in a while as trees continue to grow to make sure wagons can get through, and chop down ({{k|d}}-{{k|t}}) the impeding forest if they can't. Later on this can actually become a blessing, as if there is only one or a few pathways to the fortress it makes it easier to route incoming caravans down certain well-defended pathways, instead of allowing them to choose their own way across the map, where they may fall foul of ambushers or worse. It also makes building above-ground constructions more challenging, as any trees in the way must be chopped down first.

A tree's branches and leaves will result in the tiles below them being considered "inside", leading to the formation of [[miasma]] if corpse and body parts decay while under them. It is therefore advisable to ensure no trees grow in the immediate vicinity of your corpse stockpiles.

<gallery caption="Heights of a tree" widths="90px" heights="90px" perrow="5">
File:Tree-1.png|1 level below ground: roots in a [[Red sand]] wall on the side of a hill
File:Tree0.png|Ground level: trunk
File:Tree+1.png|1 level above ground, trunk, branches and twigs
File:Tree+2.png|2 levels above ground
File:Tree+3.png|3 levels above ground, includes some Open Space
File:Tree+4.png|4 levels above ground
File:Tree+5.png|5 levels above ground
File:Tree+6.png|6 levels above ground
File:Tree+7.png|7 levels above ground, only Open Space
</gallery>

=== Growths ===
Growths are the things that grow ''on'' a tree, i.e: they are not an essential part of the tree's structure and can be shed or picked without destroying the tree. This includes leaves, needles, flowers, fruit, seed pods, catkins, cones, etc. Each tree species has at least one type of growth, the most common one, unsurprisingly, being leaves.

The leaves of deciduous trees change color in the autumn, fall before the winter and grow back in the spring. Fallen leaves will color the tiles beneath their trees, turning the forest floor into a colorful patchwork.

Trees of fruit-producing species usually grow flowers in spring and fruit later in the year. Flowers will fall in a cloud during the transition from flowers to fruit; the cloud is shown falling, and examining the ground after that will show "<tree> flowers" in addition to other tile contents. Both flowers and fruit appear and fall at set times through the year, so it is possible that a young tree that has never flowered will give fruit.

Fruit can be picked from trees in Adventure mode. Fortress mode harvesting is done with a [[stepladder]] (as long as the fruit-bearing tree is within a plant gathering zone) or by collecting fallen fruits. Fruit can be brewed at a [[still]]. Cutting down a tree with fruit causes the fruit to vanish{{verify}}.

If a tree is set on fire in fortress mode and is described as 'dead' when examined, it will eventually rejuvenate itself and come back to life after a few years, starting from the trunk and leading out into the branches if left alone.

== Chopping down trees ==
{{main|Woodcutting}}

Trees can be cut down by dwarves to produce [[wood]]. It is enough to [[designations menu|designate]] only one trunk tile for cutting to chop down the whole tree it belongs to. Any trunk tile will do, even those that are above ground, or even a single tile of a multi-tile trunk. As a result, it is impossible to "prune" trees by chopping down only parts of them.

Once a woodcutter is done with the first tile, the tree instantly converts to a number of free-floating logs that fall to the ground in a direction away from the cutter. Cutting a tree from a trunk section above ground level may result in the woodcutter losing their footing and crashing to the ground (similar to having a tile deconstructed under their feet).

If you dug the tile below the trunk before cutting the tree, it will leave a hole to the surface, potentially allowing dangerous creatures to path into your underground fort. Avoid digging directly below one z-level in wooded areas before clearing out the trees, and make sure to check for open floor spaces {{Tile|·|0:1}} on the surface afterwards. If holes are present, construct [[floor]] tiles over the holes, which will prevent creatures from moving below. Constructing a wall below the open floor will work as well. Unexplained underground logs can alert you to the presence of these "guest entrances". Moving a building preview all around the surface (kennels are good for their size) and inspecting any non-ramp or tree invalid tiles can sweep large areas.

If you had [[smoothing|smoothed]] the wall below the trunk and then cut down the tree, it will leave an open floor above the smoothed wall, unlike constructed walls (see this [[tile#Walls|diagram]] for a visual illustration). If there is an open space adjacent to the smoothed wall, creatures can diagonally move below the adjacent space (by swimming, flying, or climbing) from the open floor above. Such occurrences should be uncommon, as it requires the tile below the tree to be made of stone (so it can be smoothed), and occur mainly in [[mountain]] biomes and areas affected by erosion.

=== Objects and tiles in trees ===

Some trees have been found to have objects or tiles contained within the branches. Cutting down these trees can be hazardous to your dwarves. You can check all the z-levels of every tree you wish to cut, or you can just take the risk and experience occasional fun!

== Products ==
=== Wood ===
{{main|Wood}}

One of the variations between the different tree species is in the weight and color of their wood. Weight is often a minor concern but when using wood to create objects that will be moved, such as bins or buckets, choosing lighter wood is an advantage as it will be hauled faster. Heavier wood will make wooden weapons and siege engine projectiles more effective, while lighter wooden shields reduce penalties to speed while blocking just as well as heavier shields.

Nonetheless, all types of wood have the same (low) value (beyond the [[preference]]s of individual dwarves), although the [[color]] of the wood may matter for aesthetic purposes.

=== Fruit ===
Various kinds of tree produce fruit. In [[dwarf fortress mode]], they can be gathered with a [[stepladder]] in a designated [[zone#Gather/pick Fruit|plant gathering zone]], and [[Elf|elves]] will also bring fruit to [[trading|trade]]. Fruit can be eaten, producing [[seed]]s.
list of 37 fruit trees: APPLE,APRICOT,AVOCADO,BANANA,BAYBERRY,BITTER_ORANGE,CARAMBOLA,CASHEW,CHERRY,CITRON,COFFEE,CUSTARD-APPLE,DATE_PALM,DESERT_LIME,DURIAN,FINGER_LIME,GUAVA,KAPOK,KUMQUAT,LIME,LYCHEE,MAHOGANY,MANGO,MANGROVE,OLIVE,ORANGE,PAPAYA,PARADISE_NUT,PEACH,PEAR,PERSIMMON,PLUM,POMEGRANATE,POMELO,RAMBUTAN,ROUND_LIME,SAND_PEAR (from graphics_individual_trees.txt)

== Growing trees ==
Trees grow from '''saplings''', which start growing randomly on non-occupied tiles of a suitable biome; thus chopping down a forest may create a clearing, but within a couple of years a new forest will have grown. Saplings will not grow to maturity if their tile contains an item or building (including stockpile designations), though removing the item may cause the tree to spontaneously grow up. Saplings will block the construction of farm plots unless there is also a dusting or pile of mud beneath them.

Saplings can be killed by heavy [[traffic|foot traffic]] and removed by building a road on them, but not by flooding — they can survive submergence for extended periods of time and will still grow to maturity once the water level drops to 4/7{{verify}} or lower. Dead saplings will remain for some seasons, and then disappear, more quickly if heavy traffic tramples them away. Many underground trees are called "young <tree>" instead of sapling, but the concept is the same. Paved [[road]]s and (even unbuilt) [[farm plot]]s periodically purge all terrain features below them, preventing trees (or shrubs) from growing in unwanted areas. Trees cannot grow on stairs or ramps, making it possible to keep trees out of your plumbing by using {{K|u}}p stairs instead of {{K|d}}igging (this does not reveal the tile above). Above-ground trees will only grow in areas where there is sufficient soil one z-level beneath them (currently observed to be at least one unmined tile within a two-tile radius); underground trees not only ignore this restriction for dry subterranean soil but will also grow on muddy subterranean stone.

Trees ''cannot'' be specifically "planted" ([http://www.bay12games.com/dwarves/dev.html as of yet]); even if a map is stripped of all trees, new saplings will regrow, randomly and in their own time. (Sadly, the [[elf|elves]] do not seem to comprehend this.) It is possible to [[tree farming|farm]] trees by walling off or engineering a patch of soil and locking it away so your dwarves don't trample all over it, but it will take a long time for the farm to yield results. After you expose the caverns, subterranean flora (including trees) will begin to grow on any exposed, previously-bare soil within your fortress; this can be annoying when a copse of [[blood thorn]]s suddenly appears in your [[sand#Glass|sand collection]] area, but allows you to easily mine out large subterranean [[Tree farming|tree farms]] full of colorful subterranean trees.

If a sapling grows into a tree, it can block off narrow areas, such as one-tile-long hallways in a muddy cavern layer. This can cause dwarves to take longer alternate routes to perform their jobs, or entrap them entirely.
{{clear}}

One can grow additional tree branches by digging away parts of tree roots and replacing them with grass or cave moss. Afterwards, when tree grows, it may spread (fruit-bearing) branches there.

== Growth rate & wood yield ==

From the time a sapling appears, it takes about three years for a tree to grow. Trees make a growth check once every year, and then grow randomly - it's possible for a tree to reach eight z-levels of height in a decade, not have gone past five in three or avoid growing branches at all initially.

Most tree raws currently specify exactly the same canopies. They'll yield more wood overall with sparser cutting, though the breakeven point is unknown presently. Each "tree trunk" tile will yield exactly one log, while light branches, twigs and (brown) heavy branches will give nothing. The size of aboveground trees at embark depends heavily on unknown factors beyond age and species; possibly temperature, latitude or biome?{{Verify}}

For wood, branching trees with nonbranching trunks (Papayas, Ginkgos, Saguaros, Pines, Cedars, Fungiwoods, Alders, and Birches) should be cut down preferentially, as their branches will obscure saplings and their trunks grow slower. They will not yield any more wood past reaching their maximum trunk height (4-9 depending on species). Vice-versa, Glumprong trees are near-ideal for forestry, as they're all trunk, though their max height is limited to 8.

Palm trees don't obscure other ones with canopies, so should be cut when wood is needed or when they reach their maximum height of 9.

Mushroom caps of subterranean 'trees' don't contribute to their wood yield, and thus will never yield additional wood past their sprouting.

== Aboveground trees ==

Most of them bear fruits and nuts, which can be [[Activity zone#Gather/Pick Fruit|harvested]] for food and drinks.


{{multi-tile tree table head}}
{{multi-tile tree table row|name=Abaca|super=3|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:1}} flower
}}
{{multi-tile tree table row|name=Acacia|symbol=♠|color=2:0|decid=No|biome=Tropical Dry Broadleaf Forest|biome2=Tropical Grassland|biome3=Tropical Savanna|biome4=Tropical Shrubland|dry=y|dense=0.600
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} seed pod
}}
{{multi-tile tree table row|name=Avocado|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.540
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|2:0}} fruit
}}
{{multi-tile tree table row|name=Banana|super=3|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|¼|6:0}} roots
|drink=Banana beer|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:0}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Bitter orange|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Cacao tree|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.430
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:0}} fruit
}}
{{multi-tile tree table row|name=Candlenut|symbol=Γ|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.140
|eat=n|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|6:0}} nut
}}
{{multi-tile tree table row|name=Carambola|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.550
|drink=Carambola wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|3:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Cashew|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.450
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Citron|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.700
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Coconut palm|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.680
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|6:0}} roots
|eat=y|cook=y
|grow1={{tile|*|2:0}} leaf
|grow2={{tile|♣|2:0}} spathe
|grow3={{tile|•|6:0}} fruit
}}
{{multi-tile tree table row|name=Coffee|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.620
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Custard-apple|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.360
|drink=Custard-apple cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Date palm|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=b|dense=0.820
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|6:0}} roots
|drink=Date wine|drinkv=10|eat=y|cook=y
|grow1={{tile|*|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Desert lime|symbol=♠|color=2:0|decid=No|biome=Tropical Grassland|biome2=Tropical Savanna|biome3=Tropical Shrubland|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Durian|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.520
|drink=Durian wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:0}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Finger lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Guava|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.610
|drink=Guava wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Kapok|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.260
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|2:1}} fruit
}}
{{multi-tile tree table row|name=Kumquat|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Lychee|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.880
|drink=Lychee wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|5:1}} fruit
}}
{{multi-tile tree table row|name=Macadamia|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.705
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Mahogany|symbol=♠|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.600
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|6:1}} flower
|grow3={{tile|•|6:0}} fruit
}}
{{multi-tile tree table row|name=Mango tree|symbol=Γ|color=2:0|decid=No|biome=Any Tropical Forest|dry=y|dense=0.520
|drink=Mango wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|4:1}} flower
|grow3={{tile|•|6:1}} fruit
}}
{{multi-tile tree table row|name=Olive|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.990
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|0:1}} fruit
}}
{{multi-tile tree table row|name=Orange|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Papaya|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.130
|drink=Papaya wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:1}} fruit
}}
{{multi-tile tree table row|name=Paradise nut|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.820
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|6:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Pomelo|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Rambutan|symbol=Γ|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.620
|drink=Rambutan wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Round lime|symbol=♠|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.590
|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Rubber tree|symbol=Γ|color=2:0|decid=No|biome=Tropical Moist Broadleaf Forest|dry=y|dense=0.490
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
}}
{{multi-tile tree table row|name=Tea|symbol=♣|color=2:0|decid=No|biome=Any Tropical|dry=y|dense=0.560
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Pomegranate|symbol=Γ|color=2:0|decid=Yes|biome=Any Tropical|dry=y|dense=0.770
|drink=Pomegranate wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|4:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Mangrove|symbol=♣|color=2:0|decid=No|biome=Mangrove Swamp|dry=n|dense=0.830
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|•|4:1}} fruit
}}
{{multi-tile tree table row|name=Cedar|symbol=↨|color=2:0|decid=No|biome=Temperate Coniferous Forest|biome2=Tropical Coniferous Forest|dry=y|dense=0.570
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|*|2:0}} scale-leaf
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|5:0}} pollen cone
}}
{{multi-tile tree table row|name=Feather tree|symbol=♣|color=7:1|decid=No|biome=Not Freezing|dry=y|align=Good|dense=0.100
|tile1={{tile|O|7:1}}{{tile|═|7:1}}{{tile|⌂|7:1}} trunk
|tile2={{tile|─|7:1}} thick branches
|tile3={{tile|¼|7:1}} branches
|tile4={{tile|;|7:1}} twigs
|tile5={{tile|¼|7:1}} roots
|eat=n|cook=y
|grow1={{tile|♠|7:1}} down
|grow2={{tile|%|7:1}} egg
}}
{{multi-tile tree table row|name=Glumprong|symbol=┤|color=5:0|decid=No|biome=Not Freezing|dry=y|align=Evil|dense=1.200
|tile1={{tile|O|5:0}}{{tile|═|5:0}}{{tile|⌂|5:0}} trunk
|tile2={{tile|¼|5:0}} roots
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Highwood|symbol=¶|color=2:0|decid=No|biome=Not Freezing|dry=y|align=Savage|dense=0.500
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|♣|3:1}} flower
}}
{{multi-tile tree table row|name=Saguaro|symbol=╞|color=2:0|decid=No|biome=Any Desert|dry=y|dense=0.430
|tile1={{tile|O|2:0}}{{tile|⌂|2:0}} trunk
|tile2={{tile|─|2:0}} thick branches
|tile3={{tile|¼|2:0}} roots
|eat=y|cook=y
|grow1={{tile|♣|7:1}} flower
|grow2={{tile|•|4:1}} fruit
}}
{{multi-tile tree table row|name=Willow|symbol=⌠|color=2:0|decid=No|biome=Any Temperate|biome2=Any Tropical Forest|biome3=Tropical Grassland|biome4=Tropical Savanna|biome5=Tropical Shrubland|biome6=Tropical Freshwater Swamp|biome7=Tropical Saltwater Swamp|biome8=Tropical Freshwater Marsh|biome9=Tropical Saltwater Marsh|dry=n|dense=0.390
|eat=n|cook=n
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|*|7:1}} pollen catkin
|grow3={{tile|*|7:1}} seed catkin
|grow4={{tile|*|6:0}} fruit
}}
{{multi-tile tree table row|name=Alder|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.410
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|4:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
|grow4={{tile|*|6:0}} cone
}}
{{multi-tile tree table row|name=Almond|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|eat=Seed|super=4||cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Apple|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.745
|drink=Apple cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:0}} fruit
}}
{{multi-tile tree table row|name=Apricot|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.745
|drink=Apricot wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Ash (tree)|alt=Ash|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.600
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Birch|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.650
|tile1={{tile|O|7:1}}{{tile|⌂|7:1}} trunk
|tile2={{tile|¼|2:0}} branches
|tile3={{tile|;|2:0}} twigs
|tile4={{tile|¼|7:1}} roots
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
}}
{{multi-tile tree table row|name=Cherry|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.425
|drink=Cherry wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Chestnut|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.430
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|7:1}} pollen catkin
|grow3={{tile|*|7:1}} seed catkin
|grow4={{tile|*|2:0}} burr
}}
{{multi-tile tree table row|name=Ginkgo|symbol=↑|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.450
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|%|7:1}} seed
}}
{{multi-tile tree table row|name=Hazel|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.500
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:1}} pollen catkin
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Maple|symbol=♣|color=2:0|decid=Yes|biome=Temperate Broadleaf Forest|biome2=Temperate Grassland|biome3=Temperate Savanna|biome4=Temperate Shrubland|dry=y|dense=0.540
|eat=n|cook=n
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|2:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Oak|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate Broadleaf|dry=y|dense=0.700
|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|2:0}} flower
|grow3={{tile|•|6:0}} acorn
}}
{{multi-tile tree table row|name=Peach|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|drink=Peach cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|5:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Pear|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.600
|drink=Perry|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|2:1}} fruit
}}
{{multi-tile tree table row|name=Pecan|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.735
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|2:1}} pollen catkin
|grow3={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Persimmon|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.835
|drink=Persimmon wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|4:1}} fruit
}}
{{multi-tile tree table row|name=Plum|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.795
|drink=Plum wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Sand pear|symbol=♣|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.690
|drink=Sand pear cider|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|♣|7:1}} flower
|grow3={{tile|%|6:0}} fruit
}}
{{multi-tile tree table row|name=Walnut|symbol=♠|color=2:0|decid=Yes|biome=Any Temperate|dry=y|dense=0.562
|eat=Seed|super=4|cook=y
|grow1={{tile|♠|2:0}}{{tile|♠|6:1}}{{tile|♠|4:1}}{{tile|♠|4:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|♣|2:1}} flower
|grow4={{tile|%|6:0}} nut
}}
{{multi-tile tree table row|name=Bayberry|symbol=♠|color=2:0|decid=No|biome=Any Temperate|biome2=Taiga|dry=y|dense=0.700
|drink=Bayberry wine|drinkv=10|eat=y|cook=y
|grow1={{tile|♠|2:0}} leaf
|grow2={{tile|*|6:0}} pollen catkin
|grow3={{tile|*|6:0}} seed catkin
|grow4={{tile|%|5:0}} fruit
}}
{{multi-tile tree table row|name=Larch|symbol=↑|color=2:0|decid=Yes|biome=Taiga|biome2=Temperate Coniferous Forest|dry=y|dense=0.590
|eat=n|cook=n
|grow1={{tile|*|2:0}}{{tile|*|6:1}}{{tile|*|4:1}}{{tile|*|4:0}} needle
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|2:0}} pollen cone
}}
{{multi-tile tree table row|name=Pine|symbol=↑|color=2:0|decid=No|biome=Taiga|biome2=Temperate Coniferous Forest|biome3=Tropical Coniferous Forest|dry=y|dense=0.510
|tile1={{tile|O|6:0}}{{tile|⌂|6:0}} trunk
|tile2={{tile|*|2:0}} branches
|tile3={{tile|*|2:0}} twigs
|tile4={{tile|¼|6:0}} roots
|eat=n|cook=n
|grow1={{tile|*|2:0}} needle
|grow2={{tile|*|6:0}} seed cone
|grow3={{tile|*|4:0}} pollen cone
}}
|}

'''Notes:'''
:1 This is the value for a stack of 5 units, which is the number rendered from a single fruit.
:2 Anything that can be cooked is edible afterwards.
:3 These trees do not produce wood when cut.
:4 These trees only edible raw product is seed, which dwarves will not currently eat raw despite the tag.

== Underground trees ==

These are the trees that can grow in subterranean caverns. None of them produce growths.

{{multi-tile tree table head}}
{{multi-tile tree table row|name=Fungiwood|symbol=♣|color=6:1|decid=No|biome=Subterranean Water/Layers 1-2|dry=b|dense=0.600
|tile1={{tile|O|6:1}}{{tile|⌂|6:1}} trunk
|tile2={{tile|¼|6:1}} branches
|tile3={{tile|;|6:1}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Tower-cap|symbol=♠|color=7:1|decid=No|biome=Subterranean Water/Layers 1-2|dry=b|dense=0.600
|tile1={{tile|O|7:1}} trunk
|tile2={{tile|O|7:1}}{{tile|║|7:1}}{{tile|▲|7:1}}{{tile|∙|7:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Black-cap|symbol=♠|color=0:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.650
|tile1={{tile|O|0:1}} trunk
|tile2={{tile|O|0:1}}{{tile|║|0:1}}{{tile|▲|0:1}}{{tile|∙|0:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Goblin-cap|symbol=♠|color=4:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.600
|tile1={{tile|O|4:1}} trunk
|tile2={{tile|O|4:1}}{{tile|║|4:1}}{{tile|▲|4:1}}{{tile|∙|4:1}} cap
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Spore tree|symbol=♣|color=3:0|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.600
|tile1={{tile|O|3:0}}{{tile|═|3:0}}{{tile|⌂|3:0}} trunk
|tile2={{tile|─|3:0}} thick branches
|tile3={{tile|¼|3:0}} branches
|tile4={{tile|;|3:0}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Tunnel tube|symbol=│|color=5:1|decid=No|biome=Subterranean Water/Layers 2-3|dry=b|dense=0.500
|tile1={{tile|O|5:1}}{{tile|═|5:1}}{{tile|⌂|5:1}} trunk
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Blood thorn|symbol=╡|color=4:0|decid=No|biome=Subterranean Water|biome2=Subterranean Chasm/Layer 3|dry=b|dense=1.250
|tile1={{tile|O|4:0}}{{tile|═|4:0}}{{tile|⌂|4:0}} trunk
|tile2={{tile|─|4:0}} thick branches
|tile3={{tile|¼|4:0}} branches
|tile4={{tile|;|4:0}} twigs
|eat=n|cook=n
}}
{{multi-tile tree table row|name=Nether-cap|symbol=♠|color=1:0|decid=No|biome=Subterranean Water/Layer 3|dry=b|dense=0.550
|tile1={{tile|O|1:0}} trunk
|tile2={{tile|O|1:0}}{{tile|║|1:0}}{{tile|▲|1:0}}{{tile|∙|1:0}} cap
|eat=n|cook=n
}}
|}

==Bugs==
* Trees grow through bridges. {{bug|7872}}
* Cutting down trees will leave a hole in the floor if the layer below has been mined (which has the potential for lots of fun, especially considering invaders). {{bug|8469}}
* Trees not yielding wood will not be generated. {{bug|10581}}
* Some underground trees will only give one log. {{bug|7313}}

==Trivia==
*It is possible for animals to be stuck up in trees at the moment of embarking. This will cause them to starve to death after a while as they have no means of getting down. So the player should check higher z-levels above the wagon once the playing area is generated, and immediately cutting down any trees animals are stuck in.
{{Plants}}

[[Category:Map tiles]]
{{Category|Trees}}
[[ru:Tree]]

Graphics token

2023-01-31T08:07:11Z

Qeveren: /* Item Graphics */ Note about lack of LARGE_IMAGE support

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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-01-30T07:07:26Z

Qeveren: /* Item Graphics */ Corrected ADD_TOOL_GRAPHICS description.

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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.

{| {{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-01-30T06:02:02Z

Qeveren: /* Item Graphics */ updated TOOL_GRAPHICS variants

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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.

{| {{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 when followed by the tool graphics material tokens below.

|-
| {{text_anchor|ADD_TOOL_GRAPHICS}}
|
* Item ID
| Alternate method to using TOOL_GRAPHICS; does not set a default graphic, uses the tool graphics material tokens below to define graphics for each material. Player-added tools that use the built-in reactions (ie. included as a TOOL in the entity definition) can use this method to define the graphics for HARD_MAT tools.

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

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

|}

== 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-01-30T05:55:45Z

Qeveren: /* Item Graphics */ Confirmed use of variants in TOOL_GRAPHICS_<material>

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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.

{| {{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 when followed by the tool graphics material tokens below.

|-
| {{text_anchor|ADD_TOOL_GRAPHICS}}
|
* Item ID
| Alternate method to using TOOL_GRAPHICS; does not set a default graphic, uses the tool graphics material tokens below to define graphics for each material. Player-added tools that use the built-in reactions (ie. included as a TOOL in the entity definition) can use this method to define the graphics for HARD_MAT tools.

|-
| {{text_anchor|TOOL_GRAPHICS_WOOD}}
|
* Variant number{{verify}}
* 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. Can accept up to seven variants; the resulting tool graphic is selected randomly from these.

|-
| {{text_anchor|TOOL_GRAPHICS_STONE}}
|
* Variant number{{verify}}
* 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. Can accept up to seven variants; the resulting tool graphic is selected randomly from these.

|-
| {{text_anchor|TOOL_GRAPHICS_METAL}}
|
* Variant number{{verify}}
* 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. Can accept up to seven variants; the resulting tool graphic is selected randomly from these.

|-
| {{text_anchor|TOOL_GRAPHICS_GLASS}}
|
* Variant number{{verify}}
* 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. Can accept up to seven variants; the resulting tool graphic is selected randomly from these.

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

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

|}

== 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-01-30T04:16:02Z

Qeveren: /* Item Graphics */ Added basic table of item graphics tokens. Descriptions may not be 100% accurate.

{{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 {{token|MALE|c}} and {{token|FEMALE|c}} castes.
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}} 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}}
|}

=== 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_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}} ||
* [[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.

{| {{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 when followed by the tool graphics material tokens below.

|-
| {{text_anchor|ADD_TOOL_GRAPHICS}}
|
* Item ID
| Alternate method to using TOOL_GRAPHICS; does not set a default graphic, uses the tool graphics material tokens below to define graphics for each material. Player-added tools that use the built-in reactions (ie. included as a TOOL in the entity definition) can use this method to define the graphics for HARD_MAT tools.

|-
| {{text_anchor|TOOL_GRAPHICS_WOOD}}
|
* Variant number{{verify}}
* 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. Seems to require seven variants.{{verify}}

|-
| {{text_anchor|TOOL_GRAPHICS_STONE}}
|
* Variant number{{verify}}
* 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. Seems to require seven variants.{{verify}}

|-
| {{text_anchor|TOOL_GRAPHICS_METAL}}
|
* Variant number{{verify}}
* 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. Seems to require seven variants.{{verify}}

|-
| {{text_anchor|TOOL_GRAPHICS_GLASS}}
|
* Variant number{{verify}}
* 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. Seems to require seven variants.{{verify}}

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

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

|}

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

Creature token

2023-01-28T07:12:39Z

Qeveren: /* T */ edited desc of TISSUE token

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

The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.

The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)

__NOTOC__
{{clear}}
{{alphabetical TOC|style=margin: 1em auto;}}

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Makes the creature need [[alcohol]] to get through the working day; it will choose to drink booze instead of [[water]] if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| Sets the creature to be active during the day, night, and twilight in Adventurer Mode. Seems to be a separate value from {{token|DIURNAL|c}}/{{token|NOCTURNAL|c}}/{{token|CREPUSCULAR|c}}, rather than implying them.{{verify|code}}

|-
| {{text anchor|ALTTILE}}
| Creature
|
*'character' or tile number
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Found on {{token|LARGE_PREDATOR|c}}s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures. {{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Caste
|
*Range (6 values, low to high)
| [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Forum post describing how description ranges work]

|-
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Caste
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| {{text anchor|APP_MOD_IMPORTANCE}}
| Caste
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| {{text anchor|APP_MOD_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Creates a noun for the appearance, and whether it is singular or plural.

|-
| {{text anchor|APP_MOD_RATE}}
| Caste
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min (growth)
*max (growth)
*start year
*start day
*end year
*end day
| Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| {{text anchor|APPLY_CREATURE_VARIATION}}
| Caste
|
*creature variation ID
*(optional) any amount of arbitrary arguments
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.

|-
| {{text anchor|APPLY_CURRENT_CREATURE_VARIATION}}
| Special
|
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Enables the creature to breathe in water, but causes it to air-drown on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list. Typically applied to spoileriffic creatures.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.

|-
| {{text anchor|ATTACK}}
| Caste
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:''' 
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code> 
''GORE'' = name of the attack 
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
|
*population
*exported wealth
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occuring when at least one of the requirements is met. Setting a value to 0 disables the trigger.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|BABY}}
| Caste
|
*integer
| Age at which creature is considered a child, the default is zero. One can think of this as the duration of the baby stage.

|-
| {{text anchor|BABYNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
|
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.

|-
| {{text anchor|BIOME}}
| Creature
|
* [[biome token]]
| Select a [[biome]] the creature may appear in.

|-
| {{text anchor|BLOOD}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|thirst for blood]] grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) as a creature of the night.

|-
| {{text anchor|BODY}}
| Caste
|
*body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.

'''If the body is left undefined, the creature will cause a crash whenever it spawns.''' {{verify}}

|-
| {{text anchor|BODY_APPEARANCE_MODIFIER}}
| Caste
|
*ATTRIBUTE
*lowest
*lower
*low
*median
*high
*higher
*highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| {{text anchor|BODY_DETAIL_PLAN}}
| Caste
|
*PlanName
*Arguments
| Loads a plan from listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| {{text anchor|BODY_SIZE}}
| Caste
|
*years
*days
*size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials, is roughly equal to the creature's average weight in grams.
'''Example:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it would be 220,000 cm3 and weigh roughly 220 kg.

|-
| {{text anchor|BODYGLOSS}}
| Caste
|
*gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| {{text anchor|BONECARN}}
| Caste
|
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].

|-
| {{text anchor|BP_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| {{text anchor|BP_REMOVE_TYPE}}
| Caste
|
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|BUILDINGDESTROYER}}
| Caste
|
*1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the {{k|b}} + {{k|C}} commands.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|CAN_DO_INTERACTION}}
| Caste
|
*interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| {{text anchor|CAN_LEARN}}
| Caste
|
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten by an adventurer, so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. Skills allocated will disappear on start.

|-
| {{text anchor|CAN_SPEAK}}
| Caste
|
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills.

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste
|
| Creature cannot [[climber|climb]], even if it has free grasp parts.

|-
| {{text anchor|CANNOT_JUMP}}
| Caste
|
| Creature cannot [[jump]].

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}}

|-
| {{text anchor|CARNIVORE}}
| Caste
|
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills. Does not seem to affect the diet of the adventurer in adventure mode.

|-
| {{text anchor|CASTE}}
| Creature
|
*name
| Defines a [[caste]].

|-
| {{text anchor|CASTE_ALTTILE}}
| Caste
|
*tile number or "letter"
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.

|-
| {{text anchor|CASTE_COLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|COLOR|c}}.

|-
| {{text anchor|CASTE_GLOWCOLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|GLOWCOLOR|c}}.

|-
| {{text anchor|CASTE_GLOWTILE}}
| Caste
|
*tile value or "letter"
| Caste-specific {{token|GLOWTILE|c}}.

|-
| {{text anchor|CASTE_NAME}}
| Caste
|
*singular
*plural
*adjective
| Caste-specific {{token|NAME|c}}.

|-
| {{text anchor|CASTE_PROFESSION_NAME}}
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| Caste-specific {{token|PROFESSION_NAME|c}}.

|-
| {{text anchor|CASTE_SOLDIER_ALTTILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SOLDIER_TILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SPEECH}}
| Caste
|
*speech file
| Caste-specific {{token|SPEECH|c}}.

|-
| {{text anchor|CASTE_TILE}}
| Caste
|
* tile number or "letter"
| Caste-specific {{token|CREATURE_TILE|c}}.

|-
| {{text anchor|CAVE_ADAPT}}
| Caste
|
| Gives the creature a bonus in caves. Also causes [[cave adaptation]].

|-
| {{text anchor|CDI}}
| Caste
|
*Varies
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].

|-
| {{text anchor|CHANGE_BODY_SIZE_PERC}}
| Caste
|
*integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| {{text anchor|CHANGE_FREQUENCY_PERC}}
| Creature
|
*integer
| Multiplies frequency by a factor of (integer)%.

|-
| {{text anchor|CHILD}}
| Caste
|
*integer
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.

|-
| {{text anchor|CHILDNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.

|-
| {{text anchor|CLUSTER_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of [[egg]]s laid in one sitting.

|-
| {{text anchor|COLONY_EXTERNAL}}
| Caste
|
| Caste hovers around colony.

|-
| {{text anchor|COLOR}}
| Creature
|
*foreground
*background
*brightness
| Color of the creature's tile. See [[Color]] for usage.

|-
| {{text anchor|COMMON_DOMESTIC}}
| Caste
|
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}}, {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| {{text anchor|COOKABLE_LIVE}}
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered/cleaned. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*creature ID
| Copies creature tags, but not caste tags, from another specified creature. Used when making creature variations (i.e. giant animals and [[animal people]]). Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. Variations are documented in c_variation_default.txt, which also contains the code for giant animals and animal people.

|-
| {{text anchor|CREATURE}}
| Creature
|
*creature ID
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for {{token|GOBBLE_VERMIN_CLASS|c}}), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

* Creature tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
|-
| {{text anchor|CREATURE_SOLDIER_TILE}}
| Creature
|
*'character' or tile number
| Creatures active in their civilization's [[military]] will use this tile instead.

|-
| {{text anchor|CREATURE_TILE}}
| Creature
|
*'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| {{text anchor|CREPUSCULAR}}
| Caste
|
| Sets the creature to be active at twilight in adventurer mode.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to [[Steals food|steal and eat edible items]] from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) [[Steals drink|drink your alcohol]]. Or spill the barrel to the ground. Also affects undead versions of the creature. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.

|-
| {{text anchor|CV_ADD_TAG}}
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| {{text anchor|CV_REMOVE_TAG}}
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|DEMON}}
| Caste
|
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.

|-
| {{text anchor|DESCRIPTION}}
| Caste
|
*text
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.

|-
| {{text anchor|DIFFICULTY}}
| Caste
|
*integer
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| Sets the creature to be active during the day in Adventurer Mode.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s will lead to worlds being generated without dogs in them. Also removes the creature from the [[object testing arena]]'s spawn list. If combined with {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|EBO_ITEM}}
| Caste
|
*[[item token]]
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
|
*gem shape
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|Egg-laying]] creatures in the default game define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| {{text anchor|EGG_SIZE}}
| Caste
|
*size
| Determines the size of laid [[egg]]s. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature appear as a large 3x3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|FANCIFUL}}
| Creature
|
| The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.

|-
| {{text anchor|FEMALE}}
| Caste
|
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|FIREJET]] attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in [[fire]], and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|FISH]] item) at a [[fishery]] to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|fished]] vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

|-
| {{text anchor|FIXED_TEMP}}
| Caste
|
*temperature
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from.

Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| If engaged in combat, the creature will flee at the first sign of resistance. Used by [[kobold]]s in the vanilla game.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own [[Body_token#FLIER|FLIER]] token).

|-
| {{text anchor|FREQUENCY}}
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|GAIT}}
| Caste
|
* <gait type>
* <gait name>
* <max [[Gait#Speed|speed]]>
* <build up time>
* <max turning [[Gait#Speed|speed]]>
* <start [[Gait#Speed|speed]]>
* <energy expenditure>
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information.

* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
* <start speed> indicates the creature's speed when it starts moving using this gait
* <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 [[tile]]s in a straight line over even terrain.
* <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
* <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and [[Status_icon#Non-flashing|collapse]].

'''NO_BUILD_UP''' can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are '''both''' omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.

'''valid gait types:'''
*'''WALK''' 
Used for moving normally over ground tiles.

*'''CRAWL''' 
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].

*'''SWIM''' 
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.

*'''FLY''' 
Used for moving through [[open space]].

*'''CLIMB''' 
Used for moving whilst [[Climber|climbing]].

'''valid gait flags:'''
* '''AGILITY''' 
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.

* '''STRENGTH''' 
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.

* '''LAYERS_SLOW''' 
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|THICKENS_ON_STRENGTH]] tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

* '''STEALTH_SLOWS:'''<percentage> 
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
|
*singular
*plural
| Like {{token|BABYNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
|
*singular
*plural
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*value A
*value B
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's {{token|GLOWTILE|c}}.

|-
| {{text anchor|GLOWTILE}}
| Creature
|
*ascii character
| If present, the being glows in the dark (generally used for Adventurer Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use {{token|CASTE_GLOWTILE|c}} instead.

|-
| {{text anchor|GNAWER}}
| Caste
|
*verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made (normally wood).

|-
| {{text anchor|GOBBLE_VERMIN_CLASS}}
| Caste
|
*class
| The creature eats vermin of the specified class.

|-
| {{text anchor|GOBBLE_VERMIN_CREATURE}}
| Caste
|
*creature
*caste
| The creature eats a specified [[vermin]].

|-
| {{text anchor|GO_TO_END}}
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| {{text anchor|GO_TO_START}}
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| {{text anchor|GO_TO_TAG}}
| Special
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| {{text anchor|GOOD}}
| Creature
|
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.

|-
| {{text anchor|GRASSTRAMPLE}}
| Caste
|
*value
| The value determines how rapidly [[grass]] is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| {{text anchor|GRAVITATE_BODY_SIZE}}
| Caste
|
*target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| {{text anchor|GRAZER}}
| Caste
|
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|HABIT}}
| Caste
|
*type
*probability
| Defines certain behaviors for the creature. The habit types are:
*COLLECT_TROPHIES
*COOK_PEOPLE
*COOK_VERMIN
*GRIND_VERMIN
*COOK_BLOOD
*GRIND_BONE_MEAL
*EAT_BONE_PORRIDGE
*USE_ANY_MELEE_WEAPON
*GIANT_NEST
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.

|-
| {{text anchor|HABIT_NUM}}
| Caste
|
*number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".{{cite forum|60554/1719248}} All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| {{text anchor|HAS_NERVES}}
| Caste
|
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.

|-
| {{text anchor|HASSHELL}}
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
*number or NONE
| Default 'NONE'. The creature's normal body [[temperature]]. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby [[vermin]].

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|IMMOBILE}}
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE no breeding will happen).

|-
| {{text anchor|IMMOBILE_LAND}}
| Caste
|
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.

|-
| {{text anchor|IMMOLATE}}
| Caste
|
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
* number
| The [[quality]] of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|LAIR}}
| Caste
|
*type
*probability
| Found on megabeasts, semimegabeasts, and night creatures. The creature will seek out sites of this type and take them as lairs. The lair types are:
*SIMPLE_BURROW
*SIMPLE_MOUND
*WILDERNESS_LOCATION
*SHRINE
*LABYRINTH

|-
| {{text anchor|LAIR_CHARACTERISTIC}}
| Caste
|
*characteristic
*probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| {{text anchor|LAIR_HUNTER}}
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| {{text anchor|LAIR_HUNTER_SPEECH}}
| Caste
|
*speech file
| What this creature says while hunting adventurers in its lair.

|-
| {{text anchor|LARGE_PREDATOR}}
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| {{text anchor|LARGE_ROAMING}}
| Creature
|
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is uneffected by {{token|DEMON|c}}.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays [[egg]]s instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays the specified item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has ligaments in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.

|-
| {{text anchor|LIGHT_GEN}}
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| {{text anchor|LIKES_FIGHTING}}
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of {{token|LARGE_PREDATOR|c}}.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by [[Serpent man|serpent men]] and [[Reptile man|reptile men]] in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the number of offspring per one birth.

|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
| Creature
|
| Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
|
|
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open [[door]]s that are set to forbidden in fortress mode.

|-
| {{text anchor|LOOSE_CLUSTERS}}
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.

|-
| {{text anchor|LOW_LIGHT_VISION}}
| Caste
|
*number
| Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|MAGICAL}}
| Caste
|
| According to Toady One, this is completely interchangeable with {{token|AT_PEACE_WITH_WILDLIFE|c}} and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954]

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| The creature is able to see while submerged in [[magma]].

|-
| {{text anchor|MALE}}
| Caste
|
| Makes the creature biologically male. Usually declared inside a caste.

|-
| {{text anchor|MANNERISM|MANNERISM_*}}
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile. See [[creature mannerism token]] for further info.

|-
| {{text anchor|MATERIAL}}
| Creature
|
*material id
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.

|-
| {{text anchor|MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*[[Material token]]
*value A
*value B
| When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c}}, which can be used to make this sort of effect applicable to all materials.

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| Sets the creature to be active at dawn in adventurer mode.

|-
| {{text anchor|MAXAGE}}
| Caste
|
*min
*max
| Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact [[time|tick]]!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [http://i.imgur.com/A1A4aA9.png].
Creatures which lack this token are naturally immortal. The [[Syndrome#CE_ADD_TAG|NO_AGING]] syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creatures are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in fortress mode, they will have a pop-up message announcing their arrival. They will remain hostile to military even after being tamed.{{bug|10731}} See [[megabeast]] page for more details.

Requires specifying a {{token|BIOME|c}} in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical bosses and as wild animals.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|MENT_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Soul_attributes|mental attribute]]'s range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| {{text anchor|MENT_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Soul_attributes|Mental attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be [[milk]]ed in the [[farmer's workshop]]. The frequency is the amount of [[time|ticks]] the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on [[#CAN_LEARN|sentient]] creatures, regardless of [[ethics]].

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for {{token|MISCHIEVOUS|c}}.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| The creature spawns [[stealth]]ed and will attempt to path into the fortress, pulling any [[lever]]s it comes across. It will be invisible on the map and [[unit list]] until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by [[gremlin]]s in the vanilla game. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| {{text anchor|MODVALUE}}
| Caste
|
| Seemingly no longer used.

|-
| {{text anchor|MOUNT}}
| Caste
|
| Creature may be used as a [[mount]]. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.

|-
| {{text anchor|MOUNT_EXOTIC}}
| Caste
|
| Creature may be used as a [[mount]], but civilizations cannot domesticate it in worldgen without certain exceptions.

|-
| {{text anchor|MULTIPART_FULL_VISION}}
| Caste
|
| Allows the creature to have all-around vision as long as it has multiple heads that can see.

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual. Requires {{token|FEMALE|c}}.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|NAME}}
| Creature
|
*singular
*plural
*adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use {{token|CASTE_NAME|c}} instead. If left undefined, the creature will be labeled as "nothing" by the game.

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. NATURAL animals will not engage creatures tagged with {{token|AT_PEACE_WITH_WILDLIFE|c}} in combat unless they are members of a hostile entity and vice-versa.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of {{token|NATURAL|c}}.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
|
*[[Skill_token|Skill token]]
*value
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Creatures with this token can appear in [[bogeyman|bogeyman ambushes]] in [[adventure mode]], where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into [[smoke]] after a short while. Note that setting the "Number of Bogeyman Types" in [[advanced world generation]] to 0 will only remove randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
| Caste
|
| Found on some [[necromancer]]s. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an <code>[[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]]</code> tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into [[Infected_ghoul|ghouls]] and [[Experiment|other experimental creatures]], and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| Found on [[night troll]]s and [[werebeast]]s. Implies that the creature is a [[night creature]], and shows its description in [[legends mode]] entry. The creature is always hostile and will start [[no quarter]] combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in [[fortress mode]] except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a {{token|BIOME|c}} in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s. When paired with SPOUSE_CONVERTER, a very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
| Caste
|
| Found on [[nightmare]]s. Corpses and severed body parts derived from creatures with this token turn into [[smoke]] after a short while.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| The creature caste does not appear in [[Calendar|autumn]].

|-
| {{text anchor|NO_CONNECTIONS_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| {{text anchor|NO_DIZZINESS}}
| Caste
|
| Creature cannot become [[Symptom#Dizziness|dizzy]].

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to [[food|eat]]. Seems to cause worldgen crashes if it is part of an entity with [[entity_token#PERMITTED_JOB|[PERMITTED_JOB:FISHERMAN]]]{{verify}}

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer [[Symptom#Fever|fevers]].

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| The creature is biologically sexless. Makes the creature unable to [[breeding|breed]].

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The creature cannot raise any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The creature cannot lose any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep. Can still be rendered unconscious by other means.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| The creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| The creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require an organ with the {{token|THOUGHT|body}} tag to survive or attack; generally used on creatures that don't have brains.

|-
| {{text anchor|NO_UNIT_TYPE_COLOR}}
| Caste
|
| Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).

|-
| {{text anchor|NO_VEGETATION_PERTURB}}
| Caste{{Verify}}
|
| Likely prevents the creature from leaving broken vegetation tracks.{{Verify}}

|-
| {{text anchor|NO_WINTER}}
| Caste
|
| The creature caste does not appear in [[Calendar|winter]].

|-
| {{text anchor|NOBONES}}
| Caste
|
| Creature has no bones.

|-
| {{text anchor|NOBREATHE}}
| Caste
|
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| Sets the creature to be active at night in adventure mode.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions or moving at full speed for extended periods of time.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never flee from battle, and will be immune to [[ghost]]s' attempts to 'scare it to death'. Additionally, it causes [[bogeyman|bogeymen]] and [[nightmare]]s to become friendly towards the creature.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not be hunted or fed to wild beasts.

|-
| {{text anchor|NONAUSEA}}
| Caste
|
| Creature isn't nauseated by gut hits and cannot vomit.

|-
| {{text anchor|NOPAIN}}
| Caste
|
| Creature doesn't feel pain.

|-
| {{text anchor|NOSKIN}}
| Caste
|
| Creature will not drop a hide when [[butcher|butchered]].

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butchering, rot, or decay of severed head.

|-
| {{text anchor|NOSMELLYROT}}
| Caste
|
| Does not produce [[miasma]] when rotting.

|-
| {{text anchor|NOSTUCKINS}}
| Caste
|
| Weapons can't get stuck in the creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Cannot be [[butcher|butchered]].

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by [[vampire]]s, [[Mummy|mummies]] and inorganic creatures like the [[amethyst man]] and [[bronze colossus]]. Creatures who are {{token|OPPOSED_TO_LIFE|c}} (undead) will be docile towards creatures with this token.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a {{token|THOUGHT|body}} body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ODOR_LEVEL}}
| Caste
|
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).

|-
| {{text anchor|ODOR_STRING}}
| Caste
|
*string
| What the creature [[smell]]s like. If no odor string is defined, the creature name (not the caste name) is used.

|-
| {{text anchor|OPPOSED_TO_LIFE}}
| Caste
|
| Is hostile to all creatures except undead and other non-living ones and will show {{DFtext|Opposed to life|0:1}} in the [[unit list]]. Used by [[undead]] in the vanilla game. Functions without the {{token|NOT_LIVING|c}} token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.

|-
| {{text anchor|ORIENTATION}}
| Caste
|
*MALE/FEMALE
*disinterested chance
*casual chance
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.

|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}
| Caste
|
| Lets you play as an [[Adventurer_mode_character_creation#Outsider|outsider]] of this species in adventure mode.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|PACK_ANIMAL}}
| Caste
|
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures!

|-
| {{text anchor|PARALYZEIMMUNE}}
| Caste
|
| The creature is immune to all [[Syndrome#CE_PARALYSIS|paralyzing]] special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate [[pearl]]s. Does nothing in the current version.{{verify}}

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
|
*value
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.

|-
| {{text anchor|PERSONALITY}}
| Caste
|
*ATTRIBUTE
*lowest
*median
*highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| {{text anchor|PET}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. However, you can solve these problems using the popular plugin [https://dffd.bay12games.com/file.php?id=13095| Dwarf Therapist], which is completely unaffected by the tag.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?{{verify}} Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. ([[Gremlin|Example]]).

|-
| {{text anchor|PETVALUE}}
| Caste
|
*value
| How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.

|-
| {{text anchor|PETVALUE_DIVISOR}}
| Caste
|
*value
| Divides the creature's {{token|PETVALUE|c}} by the specified number. Used by [[honey bee]]s to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|PHYS_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Body_attributes|physical attribute]]'s range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| {{text anchor|PHYS_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Body_attributes|Physical attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| {{text anchor|PLUS_BP_GROUP}}
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after {{token|SELECT_MATERIAL|c}}.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
*number
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}.

|-
| {{text anchor|POPULATION_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region. Defaults to 1:1 if not specified.

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc).

|-
| {{text anchor|PREFSTRING}}
| Creature
|
*string
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.

|-
| {{text anchor|PROFESSION_NAME}}
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use {{token|CASTE_PROFESSION_NAME|c}} instead.

|-
| {{text anchor|PRONE_TO_RAGE}}
| Caste
|
*Chance
| Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes [[badger]]s so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| The creature has pus. Specifies the stuff secreted by [[Health_care#Infection|infected wounds]].
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|RELSIZE}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, dwarves have larger livers.

|-
| {{text anchor|REMAINS}}
| Caste
|
*singular
*plural
| What the creature's [[remains]] are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color the creature's [[remains]] are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with {{token|VERMIN_BITE|c}} and {{token|DIE_WHEN_VERMIN_BITE|c}}, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| {{text anchor|REMAINS_UNDETERMINED}}
| Caste
|
| Unknown.

|-
| {{text anchor|REMOVE_MATERIAL}}
| Creature
|
*material token
| Removes a material from the creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*tissue token
| Removes a tissue from the creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") retract verb text
*Third person ("The giant snail") retract verb text
*Second person cancel retract text
*Third person cancel retract text
| The creature will retract into a body part when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part. (eg. Turtle, Hedgehog)

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy{{bug|11463}}{{bug|10519}}.
|-
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
|
|
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}, obviously.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") verb text
*Third person ("The hen") verb text
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SAVAGE}}
| Creature
|
| The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with {{token|GOOD|c}} or {{token|EVIL|c}}.

|-
| {{text anchor|SECRETION}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*BY_TOKEN / BY_CATEGORY / BY_TYPE
*<[[Body_token#BP|body part ID]]> / <[[Body_token#CATEGORY|category]]> or ALL / <type (e.g. [[Body_token#GRASP|GRASP]])>
*<[[Body_detail_plan_token#BP_LAYERS|tissue layer]]> or ALL
*<trigger>
| Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') [[contaminant]] is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
*'''CONTINUOUS'''
Secretion occurs once every 40 [[time|ticks]] in [[fortress mode]], and every tick in [[adventurer mode]].
*'''EXERTION'''
Secretion occurs continuously (at the rate described above) whilst the creature is at minimum {{Tile|Tired|6:1}} following physical exertion. Note that this cannot occur if the creature has {{token|NOEXERT|c}}.
*'''EXTREME_EMOTION'''
Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with {{token|NOEMOTION|c}}.

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*<caste>
| Adds an additional previously defined caste to the selection. Used after {{token|SELECT_CASTE|c}}.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*<caste> or ALL
| Selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*<[[material token]]>
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as {{token|MEGABEAST|c}}, but more of them are created during worldgen. See the [[semi-megabeast]] page for details.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* <[[Creature_token#CREATURE_CLASS|creature class]]>
* [[Tilesets|<tile value or character>]]
* [[Color#Color_values|<foreground color>:<background color>:<foreground brightness>]]
| Gives the creature the ability to sense creatures belonging to the specified [[Creature_token#CREATURE_CLASS|creature class]] even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of [[Wound#Blindness|blind]] units when fighting creatures they can sense. In [[adventure mode]], the specified tile will be used to represent sensed creatures when they cannot be seen directly.

|-
| {{text anchor|SET_BP_GROUP}}
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
|
*<[[skill_token]]>
*<percentage>
| The rate at which this creature learns this skill. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
|
*<percentage>
| The rate at which this creature learns all skills. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
|
*[[skill_token]]
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Like {{token|SKILL_RATES|c}}, but applies to individual skills instead. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATE}}
| Caste
|
*[[skill_token]]
*value
*value
*value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATES}}
| Caste
|
*value
*value
*value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves "[[item token#REMAINS|remains]]" instead of a corpse. Used by [[vermin]].

|-
| {{text anchor|SMELL_TRIGGER}}
| Creature
|
*value
| Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.

|-
| {{text anchor|SOLDIER_ALTTILE}}
| Creature
|
*'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| {{text anchor|SOUND}}
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.
* First-person reads "You '''bark'''"
* Third-person reads "The [[capybara]] '''barks'''"
* Out of sight reads "You hear '''a loud bark'''"
with the text in bold being the description arguments of the token.

|-
| {{text anchor|SOURCE_HFID}}
| Creature
|
*Integer
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.

|-
| {{text anchor|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.

|-
| {{text anchor|SPEECH}}
| Creature
|
*speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| {{text anchor|SPEECH_FEMALE}}
| Creature
|
*speech file
| Boasting speeches relating to killing females of this creature.

|-
| {{text anchor|SPEECH_MALE}}
| Creature
|
*speech file
| Boasting speeches relating to killing males of this creature.

|-
| {{text anchor|SPHERE}}
| Creature
|
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| {{text anchor|SPOUSE_CONVERSION_TARGET}}
| Caste
|
| This creature can be converted by a night creature with {{token|SPOUSE_CONVERTER|c}}.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the {{token|NIGHT_CREATURE_HUNTER|c}} tag, it will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s and transform them into the caste of its species with the {{token|CONVERTED_SPOUSE|c}} tag during worldgen. It may also start families this way.

|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
| Caste
|
| If the creature rules over a [[site]], it will cause the local landscape to be corrupted into [[Surroundings#Evil|evil surroundings]] associated with the creature's [[Creature_token#SPHERE|sphere]]s. The creature must have at least one of the following [[sphere]]s for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get [[Plant_token#EVIL|evil plants]] and [[Creature_token#EVIL|evil animals]] sometimes. NIGHTMARES gets [[bogeyman|bogeymen]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8162224#msg8162224] Used by [[demon]]s in the vanilla game.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste
|
| Caste does not require <code>[[Body_token#GRASP|[GRASP]]]</code> body parts to climb -- it can climb with <code>[[Body_token#STANCE|[STANCE]]]</code> parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as {{token|GRAZER|c}} but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.

|-
| {{text anchor|STRANGE_MOODS}}
| Caste
|
| The creature will get [[strange mood]]s in fortress mode and can produce artifacts.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with <code>[[Interaction_token#IS_SECRET|[SUPERNATURAL_LEARNING_POSSIBLE]]]</code> that match its [[Creature_token#SPHERE|spheres]] and also prevents it from becoming a [[vampire]] or [[werebeast]]. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim perfectly and does not use the [[swimmer]] skill, as opposed to {{token|SWIMS_LEARNED|c}} below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature swims only as well as their present [[Swimmer|swimming skill]] allows them to.

|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
| Caste
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
| Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|TENDONS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has tendons in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's [[web]]s can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
|
*name
| Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.

|-
| {{text anchor|TISSUE_LAYER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| {{text anchor|TISSUE_LAYER_OVER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| {{text anchor|TISSUE_LAYER_UNDER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example, an [[iron man]] has a gaseous poison within, and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS, so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER; here is an example Tissue from the Iron Man: 
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
*number
| How much the creature can carry when used by merchants.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for {{token|TRAINABLE_HUNTING|c}} + {{token|TRAINABLE_WAR|c}}.

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be [[Animal trainer|trained]] as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be [[Animal trainer|trained]] as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into [[martial trance]]s. Used by dwarves in the vanilla game.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature will never trigger [[trap]]s it steps on. Used by a [[Trapavoid|number of creatures]]. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
|
*min
*max
| A large swarm of vermin can be disturbed, usually in adventurer mode.{{verify}}

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the {{token|TISSUE_STYLE_UNIT|c}}, used in the description of the tissue layer's style.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|UBIQUITOUS}}
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth that the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. Values from 1-3 are the respective [[cavern]] levels, 4 is the [[magma sea]] and 5 is the [[HFS]]. A single argument may be used instead of min and max. [[Demon]]s use only 5:5; user-defined creatures with both this depth and {{token|FLIER}} will take part in the initial wave from the HFS alongside generated demons, but without {{token|FLIER}} they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| The creature is displayed as blue when in [[Water#Depth|7/7 water]]. Used on fish and amphibious creatures which swim under the water.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.

|-
| {{text anchor|USE_CASTE}}
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| {{text anchor|USE_MATERIAL}}
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| {{text anchor|USE_MATERIAL_TEMPLATE}}
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].

|-
| {{text anchor|USE_TISSUE}}
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| {{text anchor|USE_TISSUE_TEMPLATE}}
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| {{text anchor|UTTERANCES}}
| Caste
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|VEGETATION}}
| Caste
|
| Like {{token|AT_PEACE_WITH_WILDLIFE}}, but also makes the creature more valued in artwork by civilisations with the PLANT [[sphere]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954] Used by [[grimeling]]s in the vanilla game.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
* [[Material_definition_token#Material_States|material state]]
| Enables vermin to bite other creatures, injecting the specified material. See {{token|SPECIALATTACK_INJECT_EXTRACT|c}} for details about injection - this token presumably works in a similar manner.{{verify}}

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See {{token|PENETRATEPOWER|c}}. Distinct from {{token|VERMIN_ROTTER|c}}.

|-
| {{text anchor|VERMIN_FISH}}
| Creature
|
| The vermin appears in [[water]] and will attempt to swim around.

|-
| {{text anchor|VERMIN_GROUNDER}}
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| {{text anchor|VERMIN_HATEABLE}}
| Caste
|
| Some dwarves will [[Preferences|hate]] the creature and get unhappy thoughts when around it. See the [[Hateable|list of hateable vermin]] for details.

|-
| {{text anchor|VERMIN_MICRO}}
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).

|-
| {{text anchor|VERMIN_NOFISH}}
| Caste
|
| The creature cannot be caught by [[fishing]].

|-
| {{text anchor|VERMIN_NOROAM}}
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| {{text anchor|VERMIN_NOTRAP}}
| Caste
|
| The creature cannot be caught in baited [[animal trap]]s; however, a "[[Trapper|catch live land animal]]" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the {{token|ROOT_AROUND|c}} interaction such as [[goose|geese]] and [[chicken]]s. Dwarves will ignore the creature when given the "Capture live land animal" task.

|-
| {{text anchor|VERMIN_SOIL_COLONY}}
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| {{text anchor|VERMINHUNTER}}
| Caste
|
| Old shorthand for "does cat stuff". Contains {{token|AT_PEACE_WITH_WILDLIFE|c}} + {{token|RETURNS_VERMIN_KILLS_TO_OWNER|c}} + {{token|HUNTS_VERMIN|c}} + {{token|ADOPTS_OWNER|c}}.

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| Sets the creature to be active during the evening in adventurer mode.

|-
| {{text anchor|VIEWRANGE}}
| Caste
|
*value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.

|-
| {{text anchor|VISION_ARC}}
| Caste
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|WAGON_PULLER}}
| Caste
|
| Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.

|-
| {{text anchor|WEBBER}}
| Caste
|
* [[material token]]
| Allows the creature to create [[web]]s, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick [[web]]s. Used by creatures who can shoot thick webs (such as [[giant cave spider]]s) in order to make them immune to their own attacks.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ATTACK_SKILL}}
| Caste
|
*[[Skill token]]
| Defines the skill used by the attack.

|-
| {{text anchor|ATTACK_VERB}}
| Caste
|
*2nd person
*3rd person
| Descriptive text for the attack.

|-
| {{text anchor|ATTACK_CONTACT_PERC}}
| Caste
|
*% value
| The contact area of the attack, measured in % of the body part's volume. Note that all attack percentages can be more than 100%.

|-
| {{text anchor|ATTACK_PENETRATION_PERC}}
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.

|-
| {{text anchor|ATTACK_PRIORITY}}
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| {{text anchor|ATTACK_VELOCITY_MODIFIER}}
| Caste
|
*number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| {{text anchor|ATTACK_FLAG_CANLATCH}}
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| {{text anchor|ATTACK_FLAG_WITH}}
| Caste
|
| Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".

|-
| {{text anchor|ATTACK_FLAG_EDGE}}
| Caste
|
| The attack is edged, with all the effects on physical resistance and contact area that it entails.

|-
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
| Caste
|
* Preparation time
* Recovery time
| Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.

|-
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack cannot be performed effectively.

|-
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*<min quantity>
*<max quantity>
| When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in [[temperature|thermal]] exchange within the creature - injecting something like molten [[iron]] (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also [[contaminant|splatters]] over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated [[syndrome]] with the [[Syndrome#SYN_INJECTED|[SYN_INJECTED]]] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [[Material definition token#ENTERS_BLOOD|[ENTERS_BLOOD]]] token, the attacked bodypart has no [[Tissue_definition_token#VASCULAR|[VASCULAR]]] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
|
*interaction
| When this attack lands successfully, a specified interaction will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well. If the attack would break skin, the interaction will occur '''before the attack actually lands'''.

|-
| {{text anchor|SPECIALATTACK_SUCK_BLOOD}}
| Caste
|
*min
*max
| Successful attack draws out an amount of blood randomized between the min and max value. Beware that this '''will''' trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.
|}

==Tissue Layer Tokens==
Tissue layers are added to a creature's body parts by the creature tokens [[#TISSUE_LAYER|TISSUE_LAYER]], [[#TISSUE_LAYER_OVER|TISSUE_LAYER_OVER]], [[#TISSUE_LAYER_UNDER|TISSUE_LAYER_UNDER]], and the body detail plan token [[#TL_LAYERS|TL_LAYERS]].

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. [[#TL_CONNECTS|TL_CONNECTS]] to [[tissue_definition_token#CONNECTS|CONNECTS]].

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SELECT_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Begins a selection of tissue layers.
[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds tissue layers to those selected.

|-
| {{text anchor|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
*TISSUE
| Sets a selected tissue layer to be made of a different tissue.

|-
| {{text anchor|SHEARABLE_TISSUE_LAYER}}
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (for example, a [[llama]]'s wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|TISSUE_LAYER_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| {{text anchor|TISSUE_STYLE_UNIT}}
| Caste
|
*tissue style unit ID
*shaping
| Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
|
*COLOR
*freq
*COLOR
*freq etc.
| Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".

|-
| {{text anchor|TLCM_GENETIC_MODEL}}
| Caste
|
| The way the color modifier is passed on to offspring. May or may not work right now.{{verify}}

|-
| {{text anchor|TLCM_IMPORTANCE}}
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| {{text anchor|TLCM_NOUN}}
| Caste
|
*name
*SINGULAR or PLURAL
| Names the tissue layer color modifier, and determines the noun. Also used by [[Utility:Stonesense|Stonesense]] for colouring body parts.

|-
| {{text anchor|TLCM_TIMING}}
| Caste
|
*ROOT
*start change window years
*days
*end change window years
*days
| Determines the point in the creature's life when the color change begins and ends.

|-
| {{text anchor|TL_CONNECTS}}
| Caste
|
| Gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
*value
| Changes the HEALING_RATE of the selected tissue layers.

|-
| {{text anchor|TL_MAJOR_ARTERIES}}
| Caste
|
| Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.

|-
| {{text anchor|TL_PAIN_RECEPTORS}}
| Caste
|
*value
| Changes the number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
*value
| Changes the relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
*value
| Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

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

Creature token

2023-01-28T07:11:04Z

Qeveren: /* M */ edited desc of MATERIAL token

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

The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.

The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)

__NOTOC__
{{clear}}
{{alphabetical TOC|style=margin: 1em auto;}}

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Makes the creature need [[alcohol]] to get through the working day; it will choose to drink booze instead of [[water]] if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| Sets the creature to be active during the day, night, and twilight in Adventurer Mode. Seems to be a separate value from {{token|DIURNAL|c}}/{{token|NOCTURNAL|c}}/{{token|CREPUSCULAR|c}}, rather than implying them.{{verify|code}}

|-
| {{text anchor|ALTTILE}}
| Creature
|
*'character' or tile number
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Found on {{token|LARGE_PREDATOR|c}}s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures. {{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Caste
|
*Range (6 values, low to high)
| [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Forum post describing how description ranges work]

|-
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Caste
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| {{text anchor|APP_MOD_IMPORTANCE}}
| Caste
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| {{text anchor|APP_MOD_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Creates a noun for the appearance, and whether it is singular or plural.

|-
| {{text anchor|APP_MOD_RATE}}
| Caste
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min (growth)
*max (growth)
*start year
*start day
*end year
*end day
| Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| {{text anchor|APPLY_CREATURE_VARIATION}}
| Caste
|
*creature variation ID
*(optional) any amount of arbitrary arguments
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.

|-
| {{text anchor|APPLY_CURRENT_CREATURE_VARIATION}}
| Special
|
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Enables the creature to breathe in water, but causes it to air-drown on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list. Typically applied to spoileriffic creatures.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.

|-
| {{text anchor|ATTACK}}
| Caste
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:''' 
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code> 
''GORE'' = name of the attack 
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
|
*population
*exported wealth
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occuring when at least one of the requirements is met. Setting a value to 0 disables the trigger.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|BABY}}
| Caste
|
*integer
| Age at which creature is considered a child, the default is zero. One can think of this as the duration of the baby stage.

|-
| {{text anchor|BABYNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
|
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.

|-
| {{text anchor|BIOME}}
| Creature
|
* [[biome token]]
| Select a [[biome]] the creature may appear in.

|-
| {{text anchor|BLOOD}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|thirst for blood]] grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) as a creature of the night.

|-
| {{text anchor|BODY}}
| Caste
|
*body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.

'''If the body is left undefined, the creature will cause a crash whenever it spawns.''' {{verify}}

|-
| {{text anchor|BODY_APPEARANCE_MODIFIER}}
| Caste
|
*ATTRIBUTE
*lowest
*lower
*low
*median
*high
*higher
*highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| {{text anchor|BODY_DETAIL_PLAN}}
| Caste
|
*PlanName
*Arguments
| Loads a plan from listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| {{text anchor|BODY_SIZE}}
| Caste
|
*years
*days
*size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials, is roughly equal to the creature's average weight in grams.
'''Example:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it would be 220,000 cm3 and weigh roughly 220 kg.

|-
| {{text anchor|BODYGLOSS}}
| Caste
|
*gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| {{text anchor|BONECARN}}
| Caste
|
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].

|-
| {{text anchor|BP_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| {{text anchor|BP_REMOVE_TYPE}}
| Caste
|
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|BUILDINGDESTROYER}}
| Caste
|
*1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the {{k|b}} + {{k|C}} commands.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|CAN_DO_INTERACTION}}
| Caste
|
*interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| {{text anchor|CAN_LEARN}}
| Caste
|
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten by an adventurer, so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. Skills allocated will disappear on start.

|-
| {{text anchor|CAN_SPEAK}}
| Caste
|
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills.

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste
|
| Creature cannot [[climber|climb]], even if it has free grasp parts.

|-
| {{text anchor|CANNOT_JUMP}}
| Caste
|
| Creature cannot [[jump]].

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}}

|-
| {{text anchor|CARNIVORE}}
| Caste
|
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills. Does not seem to affect the diet of the adventurer in adventure mode.

|-
| {{text anchor|CASTE}}
| Creature
|
*name
| Defines a [[caste]].

|-
| {{text anchor|CASTE_ALTTILE}}
| Caste
|
*tile number or "letter"
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.

|-
| {{text anchor|CASTE_COLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|COLOR|c}}.

|-
| {{text anchor|CASTE_GLOWCOLOR}}
| Caste
|
*fg
*bg
*brightness
| Caste-specific {{token|GLOWCOLOR|c}}.

|-
| {{text anchor|CASTE_GLOWTILE}}
| Caste
|
*tile value or "letter"
| Caste-specific {{token|GLOWTILE|c}}.

|-
| {{text anchor|CASTE_NAME}}
| Caste
|
*singular
*plural
*adjective
| Caste-specific {{token|NAME|c}}.

|-
| {{text anchor|CASTE_PROFESSION_NAME}}
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| Caste-specific {{token|PROFESSION_NAME|c}}.

|-
| {{text anchor|CASTE_SOLDIER_ALTTILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SOLDIER_TILE}}
| Caste
|
*'character' or tile number
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.

|-
| {{text anchor|CASTE_SPEECH}}
| Caste
|
*speech file
| Caste-specific {{token|SPEECH|c}}.

|-
| {{text anchor|CASTE_TILE}}
| Caste
|
* tile number or "letter"
| Caste-specific {{token|CREATURE_TILE|c}}.

|-
| {{text anchor|CAVE_ADAPT}}
| Caste
|
| Gives the creature a bonus in caves. Also causes [[cave adaptation]].

|-
| {{text anchor|CDI}}
| Caste
|
*Varies
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].

|-
| {{text anchor|CHANGE_BODY_SIZE_PERC}}
| Caste
|
*integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| {{text anchor|CHANGE_FREQUENCY_PERC}}
| Creature
|
*integer
| Multiplies frequency by a factor of (integer)%.

|-
| {{text anchor|CHILD}}
| Caste
|
*integer
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.

|-
| {{text anchor|CHILDNAME}}
| Caste
|
*singular
*plural
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.

|-
| {{text anchor|CLUSTER_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of [[egg]]s laid in one sitting.

|-
| {{text anchor|COLONY_EXTERNAL}}
| Caste
|
| Caste hovers around colony.

|-
| {{text anchor|COLOR}}
| Creature
|
*foreground
*background
*brightness
| Color of the creature's tile. See [[Color]] for usage.

|-
| {{text anchor|COMMON_DOMESTIC}}
| Caste
|
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}}, {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| {{text anchor|COOKABLE_LIVE}}
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered/cleaned. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*creature ID
| Copies creature tags, but not caste tags, from another specified creature. Used when making creature variations (i.e. giant animals and [[animal people]]). Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. Variations are documented in c_variation_default.txt, which also contains the code for giant animals and animal people.

|-
| {{text anchor|CREATURE}}
| Creature
|
*creature ID
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for {{token|GOBBLE_VERMIN_CLASS|c}}), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

* Creature tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
|-
| {{text anchor|CREATURE_SOLDIER_TILE}}
| Creature
|
*'character' or tile number
| Creatures active in their civilization's [[military]] will use this tile instead.

|-
| {{text anchor|CREATURE_TILE}}
| Creature
|
*'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| {{text anchor|CREPUSCULAR}}
| Caste
|
| Sets the creature to be active at twilight in adventurer mode.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to [[Steals food|steal and eat edible items]] from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) [[Steals drink|drink your alcohol]]. Or spill the barrel to the ground. Also affects undead versions of the creature. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.

|-
| {{text anchor|CV_ADD_TAG}}
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| {{text anchor|CV_REMOVE_TAG}}
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|DEMON}}
| Caste
|
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.

|-
| {{text anchor|DESCRIPTION}}
| Caste
|
*text
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.

|-
| {{text anchor|DIFFICULTY}}
| Caste
|
*integer
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| Sets the creature to be active during the day in Adventurer Mode.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s will lead to worlds being generated without dogs in them. Also removes the creature from the [[object testing arena]]'s spawn list. If combined with {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|EBO_ITEM}}
| Caste
|
*[[item token]]
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
|
*gem shape
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|Egg-laying]] creatures in the default game define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| {{text anchor|EGG_SIZE}}
| Caste
|
*size
| Determines the size of laid [[egg]]s. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature appear as a large 3x3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|FANCIFUL}}
| Creature
|
| The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.

|-
| {{text anchor|FEMALE}}
| Caste
|
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|FIREJET]] attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in [[fire]], and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|FISH]] item) at a [[fishery]] to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|fished]] vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

|-
| {{text anchor|FIXED_TEMP}}
| Caste
|
*temperature
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from.

Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| If engaged in combat, the creature will flee at the first sign of resistance. Used by [[kobold]]s in the vanilla game.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own [[Body_token#FLIER|FLIER]] token).

|-
| {{text anchor|FREQUENCY}}
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|GAIT}}
| Caste
|
* <gait type>
* <gait name>
* <max [[Gait#Speed|speed]]>
* <build up time>
* <max turning [[Gait#Speed|speed]]>
* <start [[Gait#Speed|speed]]>
* <energy expenditure>
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information.

* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
* <start speed> indicates the creature's speed when it starts moving using this gait
* <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 [[tile]]s in a straight line over even terrain.
* <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
* <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and [[Status_icon#Non-flashing|collapse]].

'''NO_BUILD_UP''' can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are '''both''' omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.

'''valid gait types:'''
*'''WALK''' 
Used for moving normally over ground tiles.

*'''CRAWL''' 
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].

*'''SWIM''' 
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.

*'''FLY''' 
Used for moving through [[open space]].

*'''CLIMB''' 
Used for moving whilst [[Climber|climbing]].

'''valid gait flags:'''
* '''AGILITY''' 
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.

* '''STRENGTH''' 
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.

* '''LAYERS_SLOW''' 
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|THICKENS_ON_STRENGTH]] tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

* '''STEALTH_SLOWS:'''<percentage> 
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
|
*singular
*plural
| Like {{token|BABYNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
|
*singular
*plural
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*value A
*value B
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's {{token|GLOWTILE|c}}.

|-
| {{text anchor|GLOWTILE}}
| Creature
|
*ascii character
| If present, the being glows in the dark (generally used for Adventurer Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use {{token|CASTE_GLOWTILE|c}} instead.

|-
| {{text anchor|GNAWER}}
| Caste
|
*verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made (normally wood).

|-
| {{text anchor|GOBBLE_VERMIN_CLASS}}
| Caste
|
*class
| The creature eats vermin of the specified class.

|-
| {{text anchor|GOBBLE_VERMIN_CREATURE}}
| Caste
|
*creature
*caste
| The creature eats a specified [[vermin]].

|-
| {{text anchor|GO_TO_END}}
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| {{text anchor|GO_TO_START}}
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| {{text anchor|GO_TO_TAG}}
| Special
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| {{text anchor|GOOD}}
| Creature
|
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.

|-
| {{text anchor|GRASSTRAMPLE}}
| Caste
|
*value
| The value determines how rapidly [[grass]] is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| {{text anchor|GRAVITATE_BODY_SIZE}}
| Caste
|
*target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| {{text anchor|GRAZER}}
| Caste
|
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|HABIT}}
| Caste
|
*type
*probability
| Defines certain behaviors for the creature. The habit types are:
*COLLECT_TROPHIES
*COOK_PEOPLE
*COOK_VERMIN
*GRIND_VERMIN
*COOK_BLOOD
*GRIND_BONE_MEAL
*EAT_BONE_PORRIDGE
*USE_ANY_MELEE_WEAPON
*GIANT_NEST
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.

|-
| {{text anchor|HABIT_NUM}}
| Caste
|
*number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".{{cite forum|60554/1719248}} All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| {{text anchor|HAS_NERVES}}
| Caste
|
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.

|-
| {{text anchor|HASSHELL}}
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
*number or NONE
| Default 'NONE'. The creature's normal body [[temperature]]. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby [[vermin]].

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|IMMOBILE}}
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE no breeding will happen).

|-
| {{text anchor|IMMOBILE_LAND}}
| Caste
|
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.

|-
| {{text anchor|IMMOLATE}}
| Caste
|
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
* number
| The [[quality]] of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|LAIR}}
| Caste
|
*type
*probability
| Found on megabeasts, semimegabeasts, and night creatures. The creature will seek out sites of this type and take them as lairs. The lair types are:
*SIMPLE_BURROW
*SIMPLE_MOUND
*WILDERNESS_LOCATION
*SHRINE
*LABYRINTH

|-
| {{text anchor|LAIR_CHARACTERISTIC}}
| Caste
|
*characteristic
*probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| {{text anchor|LAIR_HUNTER}}
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| {{text anchor|LAIR_HUNTER_SPEECH}}
| Caste
|
*speech file
| What this creature says while hunting adventurers in its lair.

|-
| {{text anchor|LARGE_PREDATOR}}
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| {{text anchor|LARGE_ROAMING}}
| Creature
|
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is uneffected by {{token|DEMON|c}}.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays [[egg]]s instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays the specified item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has ligaments in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.

|-
| {{text anchor|LIGHT_GEN}}
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| {{text anchor|LIKES_FIGHTING}}
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of {{token|LARGE_PREDATOR|c}}.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by [[Serpent man|serpent men]] and [[Reptile man|reptile men]] in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the number of offspring per one birth.

|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
| Creature
|
| Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
|
|
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open [[door]]s that are set to forbidden in fortress mode.

|-
| {{text anchor|LOOSE_CLUSTERS}}
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.

|-
| {{text anchor|LOW_LIGHT_VISION}}
| Caste
|
*number
| Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|MAGICAL}}
| Caste
|
| According to Toady One, this is completely interchangeable with {{token|AT_PEACE_WITH_WILDLIFE|c}} and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954]

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| The creature is able to see while submerged in [[magma]].

|-
| {{text anchor|MALE}}
| Caste
|
| Makes the creature biologically male. Usually declared inside a caste.

|-
| {{text anchor|MANNERISM|MANNERISM_*}}
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile. See [[creature mannerism token]] for further info.

|-
| {{text anchor|MATERIAL}}
| Creature
|
*material id
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.

|-
| {{text anchor|MATERIAL_FORCE_MULTIPLIER}}
| Caste
|
*[[Material token]]
*value A
*value B
| When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c}}, which can be used to make this sort of effect applicable to all materials.

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| Sets the creature to be active at dawn in adventurer mode.

|-
| {{text anchor|MAXAGE}}
| Caste
|
*min
*max
| Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact [[time|tick]]!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [http://i.imgur.com/A1A4aA9.png].
Creatures which lack this token are naturally immortal. The [[Syndrome#CE_ADD_TAG|NO_AGING]] syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creatures are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in fortress mode, they will have a pop-up message announcing their arrival. They will remain hostile to military even after being tamed.{{bug|10731}} See [[megabeast]] page for more details.

Requires specifying a {{token|BIOME|c}} in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical bosses and as wild animals.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|MENT_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Soul_attributes|mental attribute]]'s range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| {{text anchor|MENT_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Soul_attributes|Mental attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be [[milk]]ed in the [[farmer's workshop]]. The frequency is the amount of [[time|ticks]] the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on [[#CAN_LEARN|sentient]] creatures, regardless of [[ethics]].

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for {{token|MISCHIEVOUS|c}}.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| The creature spawns [[stealth]]ed and will attempt to path into the fortress, pulling any [[lever]]s it comes across. It will be invisible on the map and [[unit list]] until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by [[gremlin]]s in the vanilla game. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| {{text anchor|MODVALUE}}
| Caste
|
| Seemingly no longer used.

|-
| {{text anchor|MOUNT}}
| Caste
|
| Creature may be used as a [[mount]]. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.

|-
| {{text anchor|MOUNT_EXOTIC}}
| Caste
|
| Creature may be used as a [[mount]], but civilizations cannot domesticate it in worldgen without certain exceptions.

|-
| {{text anchor|MULTIPART_FULL_VISION}}
| Caste
|
| Allows the creature to have all-around vision as long as it has multiple heads that can see.

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual. Requires {{token|FEMALE|c}}.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|NAME}}
| Creature
|
*singular
*plural
*adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use {{token|CASTE_NAME|c}} instead. If left undefined, the creature will be labeled as "nothing" by the game.

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. NATURAL animals will not engage creatures tagged with {{token|AT_PEACE_WITH_WILDLIFE|c}} in combat unless they are members of a hostile entity and vice-versa.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of {{token|NATURAL|c}}.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
|
*[[Skill_token|Skill token]]
*value
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Creatures with this token can appear in [[bogeyman|bogeyman ambushes]] in [[adventure mode]], where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into [[smoke]] after a short while. Note that setting the "Number of Bogeyman Types" in [[advanced world generation]] to 0 will only remove randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
| Caste
|
| Found on some [[necromancer]]s. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an <code>[[Interaction_token#I_SOURCE|[I_SOURCE:EXPERIMENT]]]</code> tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into [[Infected_ghoul|ghouls]] and [[Experiment|other experimental creatures]], and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| Found on [[night troll]]s and [[werebeast]]s. Implies that the creature is a [[night creature]], and shows its description in [[legends mode]] entry. The creature is always hostile and will start [[no quarter]] combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in [[fortress mode]] except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a {{token|BIOME|c}} in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s. When paired with SPOUSE_CONVERTER, a very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
| Caste
|
| Found on [[nightmare]]s. Corpses and severed body parts derived from creatures with this token turn into [[smoke]] after a short while.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| The creature caste does not appear in [[Calendar|autumn]].

|-
| {{text anchor|NO_CONNECTIONS_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| {{text anchor|NO_DIZZINESS}}
| Caste
|
| Creature cannot become [[Symptom#Dizziness|dizzy]].

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to [[food|eat]]. Seems to cause worldgen crashes if it is part of an entity with [[entity_token#PERMITTED_JOB|[PERMITTED_JOB:FISHERMAN]]]{{verify}}

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer [[Symptom#Fever|fevers]].

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| The creature is biologically sexless. Makes the creature unable to [[breeding|breed]].

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The creature cannot raise any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The creature cannot lose any [[Attribute#Body_attributes|physical attributes]].

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep. Can still be rendered unconscious by other means.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| The creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| The creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require an organ with the {{token|THOUGHT|body}} tag to survive or attack; generally used on creatures that don't have brains.

|-
| {{text anchor|NO_UNIT_TYPE_COLOR}}
| Caste
|
| Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).

|-
| {{text anchor|NO_VEGETATION_PERTURB}}
| Caste{{Verify}}
|
| Likely prevents the creature from leaving broken vegetation tracks.{{Verify}}

|-
| {{text anchor|NO_WINTER}}
| Caste
|
| The creature caste does not appear in [[Calendar|winter]].

|-
| {{text anchor|NOBONES}}
| Caste
|
| Creature has no bones.

|-
| {{text anchor|NOBREATHE}}
| Caste
|
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| Sets the creature to be active at night in adventure mode.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions or moving at full speed for extended periods of time.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never flee from battle, and will be immune to [[ghost]]s' attempts to 'scare it to death'. Additionally, it causes [[bogeyman|bogeymen]] and [[nightmare]]s to become friendly towards the creature.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not be hunted or fed to wild beasts.

|-
| {{text anchor|NONAUSEA}}
| Caste
|
| Creature isn't nauseated by gut hits and cannot vomit.

|-
| {{text anchor|NOPAIN}}
| Caste
|
| Creature doesn't feel pain.

|-
| {{text anchor|NOSKIN}}
| Caste
|
| Creature will not drop a hide when [[butcher|butchered]].

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butchering, rot, or decay of severed head.

|-
| {{text anchor|NOSMELLYROT}}
| Caste
|
| Does not produce [[miasma]] when rotting.

|-
| {{text anchor|NOSTUCKINS}}
| Caste
|
| Weapons can't get stuck in the creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Cannot be [[butcher|butchered]].

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by [[vampire]]s, [[Mummy|mummies]] and inorganic creatures like the [[amethyst man]] and [[bronze colossus]]. Creatures who are {{token|OPPOSED_TO_LIFE|c}} (undead) will be docile towards creatures with this token.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a {{token|THOUGHT|body}} body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ODOR_LEVEL}}
| Caste
|
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).

|-
| {{text anchor|ODOR_STRING}}
| Caste
|
*string
| What the creature [[smell]]s like. If no odor string is defined, the creature name (not the caste name) is used.

|-
| {{text anchor|OPPOSED_TO_LIFE}}
| Caste
|
| Is hostile to all creatures except undead and other non-living ones and will show {{DFtext|Opposed to life|0:1}} in the [[unit list]]. Used by [[undead]] in the vanilla game. Functions without the {{token|NOT_LIVING|c}} token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.

|-
| {{text anchor|ORIENTATION}}
| Caste
|
*MALE/FEMALE
*disinterested chance
*casual chance
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.

|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}
| Caste
|
| Lets you play as an [[Adventurer_mode_character_creation#Outsider|outsider]] of this species in adventure mode.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|PACK_ANIMAL}}
| Caste
|
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures!

|-
| {{text anchor|PARALYZEIMMUNE}}
| Caste
|
| The creature is immune to all [[Syndrome#CE_PARALYSIS|paralyzing]] special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate [[pearl]]s. Does nothing in the current version.{{verify}}

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
|
*value
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.

|-
| {{text anchor|PERSONALITY}}
| Caste
|
*ATTRIBUTE
*lowest
*median
*highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| {{text anchor|PET}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. However, you can solve these problems using the popular plugin [https://dffd.bay12games.com/file.php?id=13095| Dwarf Therapist], which is completely unaffected by the tag.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be [[Animal_trainer|tamed]] in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?{{verify}} Adding this to civilization members will classify them as pets instead of citizens, with all the [[Fun|problems]] that entails. ([[Gremlin|Example]]).

|-
| {{text anchor|PETVALUE}}
| Caste
|
*value
| How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.

|-
| {{text anchor|PETVALUE_DIVISOR}}
| Caste
|
*value
| Divides the creature's {{token|PETVALUE|c}} by the specified number. Used by [[honey bee]]s to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| {{text anchor|PHYS_ATT_RANGE}}
| Caste
|
*[[Attribute|ATTRIBUTE]]
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets up a [[Attribute#Body_attributes|physical attribute]]'s range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| {{text anchor|PHYS_ATT_RATES}}
| Caste
|
*[[Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| [[Attribute#Body_attributes|Physical attribute]] gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| {{text anchor|PLUS_BP_GROUP}}
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after {{token|SET_BP_GROUP|c}}.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after {{token|SELECT_MATERIAL|c}}.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
*number
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}.

|-
| {{text anchor|POPULATION_NUMBER}}
| Creature
|
*min
*max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region. Defaults to 1:1 if not specified.

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc).

|-
| {{text anchor|PREFSTRING}}
| Creature
|
*string
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.

|-
| {{text anchor|PROFESSION_NAME}}
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use {{token|CASTE_PROFESSION_NAME|c}} instead.

|-
| {{text anchor|PRONE_TO_RAGE}}
| Caste
|
*Chance
| Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes [[badger]]s so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* <[[material token]]>
* <[[Material_definition_token#Material_States|material state]]>
| The creature has pus. Specifies the stuff secreted by [[Health_care#Infection|infected wounds]].
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|RELSIZE}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, dwarves have larger livers.

|-
| {{text anchor|REMAINS}}
| Caste
|
*singular
*plural
| What the creature's [[remains]] are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color the creature's [[remains]] are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with {{token|VERMIN_BITE|c}} and {{token|DIE_WHEN_VERMIN_BITE|c}}, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| {{text anchor|REMAINS_UNDETERMINED}}
| Caste
|
| Unknown.

|-
| {{text anchor|REMOVE_MATERIAL}}
| Creature
|
*material token
| Removes a material from the creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*tissue token
| Removes a tissue from the creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") retract verb text
*Third person ("The giant snail") retract verb text
*Second person cancel retract text
*Third person cancel retract text
| The creature will retract into a body part when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part. (eg. Turtle, Hedgehog)

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy{{bug|11463}}{{bug|10519}}.
|-
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
|
|
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}, obviously.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*body type, [[Body_token#CATEGORY|category]], or [[Body_token#BP|token]]
*Second person ("You") verb text
*Third person ("The hen") verb text
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

|}

{{alphabetical TOC|style=margin: 1em auto;}}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SAVAGE}}
| Creature
|
| The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with {{token|GOOD|c}} or {{token|EVIL|c}}.

|-
| {{text anchor|SECRETION}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*BY_TOKEN / BY_CATEGORY / BY_TYPE
*<[[Body_token#BP|body part ID]]> / <[[Body_token#CATEGORY|category]]> or ALL / <type (e.g. [[Body_token#GRASP|GRASP]])>
*<[[Body_detail_plan_token#BP_LAYERS|tissue layer]]> or ALL
*<trigger>
| Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') [[contaminant]] is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
*'''CONTINUOUS'''
Secretion occurs once every 40 [[time|ticks]] in [[fortress mode]], and every tick in [[adventurer mode]].
*'''EXERTION'''
Secretion occurs continuously (at the rate described above) whilst the creature is at minimum {{Tile|Tired|6:1}} following physical exertion. Note that this cannot occur if the creature has {{token|NOEXERT|c}}.
*'''EXTREME_EMOTION'''
Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with {{token|NOEMOTION|c}}.

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*<caste>
| Adds an additional previously defined caste to the selection. Used after {{token|SELECT_CASTE|c}}.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*<caste> or ALL
| Selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*<[[material token]]>
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as {{token|MEGABEAST|c}}, but more of them are created during worldgen. See the [[semi-megabeast]] page for details.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* <[[Creature_token#CREATURE_CLASS|creature class]]>
* [[Tilesets|<tile value or character>]]
* [[Color#Color_values|<foreground color>:<background color>:<foreground brightness>]]
| Gives the creature the ability to sense creatures belonging to the specified [[Creature_token#CREATURE_CLASS|creature class]] even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of [[Wound#Blindness|blind]] units when fighting creatures they can sense. In [[adventure mode]], the specified tile will be used to represent sensed creatures when they cannot be seen directly.

|-
| {{text anchor|SET_BP_GROUP}}
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
|
*<[[skill_token]]>
*<percentage>
| The rate at which this creature learns this skill. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
|
*<percentage>
| The rate at which this creature learns all skills. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
|
*[[skill_token]]
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Like {{token|SKILL_RATES|c}}, but applies to individual skills instead. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*<% of improvement points gained>
*<unused counter rate>
*<rust counter rate>
*<demotion counter rate>
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATE}}
| Caste
|
*[[skill_token]]
*value
*value
*value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SKILL_RUST_RATES}}
| Caste
|
*value
*value
*value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves "[[item token#REMAINS|remains]]" instead of a corpse. Used by [[vermin]].

|-
| {{text anchor|SMELL_TRIGGER}}
| Creature
|
*value
| Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.

|-
| {{text anchor|SOLDIER_ALTTILE}}
| Creature
|
*'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| {{text anchor|SOUND}}
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.
* First-person reads "You '''bark'''"
* Third-person reads "The [[capybara]] '''barks'''"
* Out of sight reads "You hear '''a loud bark'''"
with the text in bold being the description arguments of the token.

|-
| {{text anchor|SOURCE_HFID}}
| Creature
|
*Integer
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.

|-
| {{text anchor|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.

|-
| {{text anchor|SPEECH}}
| Creature
|
*speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| {{text anchor|SPEECH_FEMALE}}
| Creature
|
*speech file
| Boasting speeches relating to killing females of this creature.

|-
| {{text anchor|SPEECH_MALE}}
| Creature
|
*speech file
| Boasting speeches relating to killing males of this creature.

|-
| {{text anchor|SPHERE}}
| Creature
|
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| {{text anchor|SPOUSE_CONVERSION_TARGET}}
| Caste
|
| This creature can be converted by a night creature with {{token|SPOUSE_CONVERTER|c}}.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the {{token|NIGHT_CREATURE_HUNTER|c}} tag, it will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s and transform them into the caste of its species with the {{token|CONVERTED_SPOUSE|c}} tag during worldgen. It may also start families this way.

|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
| Caste
|
| If the creature rules over a [[site]], it will cause the local landscape to be corrupted into [[Surroundings#Evil|evil surroundings]] associated with the creature's [[Creature_token#SPHERE|sphere]]s. The creature must have at least one of the following [[sphere]]s for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get [[Plant_token#EVIL|evil plants]] and [[Creature_token#EVIL|evil animals]] sometimes. NIGHTMARES gets [[bogeyman|bogeymen]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8162224#msg8162224] Used by [[demon]]s in the vanilla game.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste
|
| Caste does not require <code>[[Body_token#GRASP|[GRASP]]]</code> body parts to climb -- it can climb with <code>[[Body_token#STANCE|[STANCE]]]</code> parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as {{token|GRAZER|c}} but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.

|-
| {{text anchor|STRANGE_MOODS}}
| Caste
|
| The creature will get [[strange mood]]s in fortress mode and can produce artifacts.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with <code>[[Interaction_token#IS_SECRET|[SUPERNATURAL_LEARNING_POSSIBLE]]]</code> that match its [[Creature_token#SPHERE|spheres]] and also prevents it from becoming a [[vampire]] or [[werebeast]]. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim perfectly and does not use the [[swimmer]] skill, as opposed to {{token|SWIMS_LEARNED|c}} below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature swims only as well as their present [[Swimmer|swimming skill]] allows them to.

|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
| Caste
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
| Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|TENDONS}}
| Caste
|
* [[material token]]
*healing rate
| The creature has tendons in its {{token|CONNECTIVE_TISSUE_ANCHOR|td}} tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's [[web]]s can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
|
*name
| Begins defining a tissue in the creature file.

|-
| {{text anchor|TISSUE_LAYER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| {{text anchor|TISSUE_LAYER_OVER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| {{text anchor|TISSUE_LAYER_UNDER}}
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example, an [[iron man]] has a gaseous poison within, and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS, so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER; here is an example Tissue from the Iron Man: 
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
*number
| How much the creature can carry when used by merchants.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for {{token|TRAINABLE_HUNTING|c}} + {{token|TRAINABLE_WAR|c}}.

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be [[Animal trainer|trained]] as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be [[Animal trainer|trained]] as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into [[martial trance]]s. Used by dwarves in the vanilla game.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature will never trigger [[trap]]s it steps on. Used by a [[Trapavoid|number of creatures]]. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
|
*min
*max
| A large swarm of vermin can be disturbed, usually in adventurer mode.{{verify}}

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the {{token|TISSUE_STYLE_UNIT|c}}, used in the description of the tissue layer's style.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|UBIQUITOUS}}
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth that the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. Values from 1-3 are the respective [[cavern]] levels, 4 is the [[magma sea]] and 5 is the [[HFS]]. A single argument may be used instead of min and max. [[Demon]]s use only 5:5; user-defined creatures with both this depth and {{token|FLIER}} will take part in the initial wave from the HFS alongside generated demons, but without {{token|FLIER}} they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| The creature is displayed as blue when in [[Water#Depth|7/7 water]]. Used on fish and amphibious creatures which swim under the water.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.

|-
| {{text anchor|USE_CASTE}}
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| {{text anchor|USE_MATERIAL}}
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| {{text anchor|USE_MATERIAL_TEMPLATE}}
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].

|-
| {{text anchor|USE_TISSUE}}
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| {{text anchor|USE_TISSUE_TEMPLATE}}
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| {{text anchor|UTTERANCES}}
| Caste
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|VEGETATION}}
| Caste
|
| Like {{token|AT_PEACE_WITH_WILDLIFE}}, but also makes the creature more valued in artwork by civilisations with the PLANT [[sphere]]. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8316954#msg8316954] Used by [[grimeling]]s in the vanilla game.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
* [[Material_definition_token#Material_States|material state]]
| Enables vermin to bite other creatures, injecting the specified material. See {{token|SPECIALATTACK_INJECT_EXTRACT|c}} for details about injection - this token presumably works in a similar manner.{{verify}}

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See {{token|PENETRATEPOWER|c}}. Distinct from {{token|VERMIN_ROTTER|c}}.

|-
| {{text anchor|VERMIN_FISH}}
| Creature
|
| The vermin appears in [[water]] and will attempt to swim around.

|-
| {{text anchor|VERMIN_GROUNDER}}
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| {{text anchor|VERMIN_HATEABLE}}
| Caste
|
| Some dwarves will [[Preferences|hate]] the creature and get unhappy thoughts when around it. See the [[Hateable|list of hateable vermin]] for details.

|-
| {{text anchor|VERMIN_MICRO}}
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).

|-
| {{text anchor|VERMIN_NOFISH}}
| Caste
|
| The creature cannot be caught by [[fishing]].

|-
| {{text anchor|VERMIN_NOROAM}}
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| {{text anchor|VERMIN_NOTRAP}}
| Caste
|
| The creature cannot be caught in baited [[animal trap]]s; however, a "[[Trapper|catch live land animal]]" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the {{token|ROOT_AROUND|c}} interaction such as [[goose|geese]] and [[chicken]]s. Dwarves will ignore the creature when given the "Capture live land animal" task.

|-
| {{text anchor|VERMIN_SOIL_COLONY}}
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| {{text anchor|VERMINHUNTER}}
| Caste
|
| Old shorthand for "does cat stuff". Contains {{token|AT_PEACE_WITH_WILDLIFE|c}} + {{token|RETURNS_VERMIN_KILLS_TO_OWNER|c}} + {{token|HUNTS_VERMIN|c}} + {{token|ADOPTS_OWNER|c}}.

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| Sets the creature to be active during the evening in adventurer mode.

|-
| {{text anchor|VIEWRANGE}}
| Caste
|
*value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.

|-
| {{text anchor|VISION_ARC}}
| Caste
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively.
|}

{{alphabetical TOC|style=margin: 1em auto;}}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|WAGON_PULLER}}
| Caste
|
| Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.

|-
| {{text anchor|WEBBER}}
| Caste
|
* [[material token]]
| Allows the creature to create [[web]]s, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick [[web]]s. Used by creatures who can shoot thick webs (such as [[giant cave spider]]s) in order to make them immune to their own attacks.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|ATTACK_SKILL}}
| Caste
|
*[[Skill token]]
| Defines the skill used by the attack.

|-
| {{text anchor|ATTACK_VERB}}
| Caste
|
*2nd person
*3rd person
| Descriptive text for the attack.

|-
| {{text anchor|ATTACK_CONTACT_PERC}}
| Caste
|
*% value
| The contact area of the attack, measured in % of the body part's volume. Note that all attack percentages can be more than 100%.

|-
| {{text anchor|ATTACK_PENETRATION_PERC}}
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.

|-
| {{text anchor|ATTACK_PRIORITY}}
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| {{text anchor|ATTACK_VELOCITY_MODIFIER}}
| Caste
|
*number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| {{text anchor|ATTACK_FLAG_CANLATCH}}
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| {{text anchor|ATTACK_FLAG_WITH}}
| Caste
|
| Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".

|-
| {{text anchor|ATTACK_FLAG_EDGE}}
| Caste
|
| The attack is edged, with all the effects on physical resistance and contact area that it entails.

|-
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
| Caste
|
* Preparation time
* Recovery time
| Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.

|-
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack cannot be performed effectively.

|-
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
| Caste
|
| Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
*<[[material token]]>
*<[[Material_definition_token#Material_States|material state]]>
*<min quantity>
*<max quantity>
| When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in [[temperature|thermal]] exchange within the creature - injecting something like molten [[iron]] (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also [[contaminant|splatters]] over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated [[syndrome]] with the [[Syndrome#SYN_INJECTED|[SYN_INJECTED]]] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [[Material definition token#ENTERS_BLOOD|[ENTERS_BLOOD]]] token, the attacked bodypart has no [[Tissue_definition_token#VASCULAR|[VASCULAR]]] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
|
*interaction
| When this attack lands successfully, a specified interaction will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well. If the attack would break skin, the interaction will occur '''before the attack actually lands'''.

|-
| {{text anchor|SPECIALATTACK_SUCK_BLOOD}}
| Caste
|
*min
*max
| Successful attack draws out an amount of blood randomized between the min and max value. Beware that this '''will''' trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.
|}

==Tissue Layer Tokens==
Tissue layers are added to a creature's body parts by the creature tokens [[#TISSUE_LAYER|TISSUE_LAYER]], [[#TISSUE_LAYER_OVER|TISSUE_LAYER_OVER]], [[#TISSUE_LAYER_UNDER|TISSUE_LAYER_UNDER]], and the body detail plan token [[#TL_LAYERS|TL_LAYERS]].

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. [[#TL_CONNECTS|TL_CONNECTS]] to [[tissue_definition_token#CONNECTS|CONNECTS]].

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| {{text anchor|SELECT_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Begins a selection of tissue layers.
[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds tissue layers to those selected.

|-
| {{text anchor|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
*TISSUE
| Sets a selected tissue layer to be made of a different tissue.

|-
| {{text anchor|SHEARABLE_TISSUE_LAYER}}
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (for example, a [[llama]]'s wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|TISSUE_LAYER_APPEARANCE_MODIFIER}}
| Caste
|
*QUALITY
*lowest
*lower
*low
*median
*high
*higher
*highest
| Sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| {{text anchor|TISSUE_STYLE_UNIT}}
| Caste
|
*tissue style unit ID
*shaping
| Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
|
*COLOR
*freq
*COLOR
*freq etc.
| Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".

|-
| {{text anchor|TLCM_GENETIC_MODEL}}
| Caste
|
| The way the color modifier is passed on to offspring. May or may not work right now.{{verify}}

|-
| {{text anchor|TLCM_IMPORTANCE}}
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| {{text anchor|TLCM_NOUN}}
| Caste
|
*name
*SINGULAR or PLURAL
| Names the tissue layer color modifier, and determines the noun. Also used by [[Utility:Stonesense|Stonesense]] for colouring body parts.

|-
| {{text anchor|TLCM_TIMING}}
| Caste
|
*ROOT
*start change window years
*days
*end change window years
*days
| Determines the point in the creature's life when the color change begins and ends.

|-
| {{text anchor|TL_CONNECTS}}
| Caste
|
| Gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
*value
| Changes the HEALING_RATE of the selected tissue layers.

|-
| {{text anchor|TL_MAJOR_ARTERIES}}
| Caste
|
| Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.

|-
| {{text anchor|TL_PAIN_RECEPTORS}}
| Caste
|
*value
| Changes the number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
*value
| Changes the relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
*value
| Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]
*[[Creature examples]]

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

Modding

2023-01-28T04:00:43Z

Qeveren: /* See also */ See also: modding pitfalls

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{For/see|a list of Dwarf Fortress mods|[[List of mods]]}}
{{Modding}}
'''Modding''', or creating [[mod]]s, refers to modifying the behavior of the base game (vanilla). ''Dwarf Fortress'' is remarkably moddable.

== Resource Overview==
[[File:modding_icon.png|120px|right]]This section serves as a portal to all modding-related pages on the wiki.

; Using Mods:
* [[Mod#Installing Mods|Installing mods]]
* [[Mod#Enabling Mods|Enabling mods in-game]]

; Guides and references:
* [[Modding guide|Modding Guide]]
* [[Modding pitfalls]] for troubleshooting

* [[Mod#Mod Format|Mod Format]] and [[Game folders and files]]
* [[Mod#Publish on Steam Workshop|Publish on Steam Workshop]]
* [[Memory hacking]], [[Main:Offset Finding Methods|Offset Finding Methods]]
* [[Character table]]

; Where to get help?
* This [http://www.bay12games.com/forum/index.php?board=13.0 forum] is the official DF subforum dedicated to discussions about modding.
* [https://discord.com/channels/329272032778780672/629902895138996264 Kitfox modding discord]
* [https://docs.dfhack.org/en/stable/docs/Introduction.html#getting-help DFhack questions]

; Modding tools
There are several [[Utilities#Modding_tools|utilities]] that assist in modding efforts. There is [http://www.bay12forums.com/smf/index.php?topic=28829.0 a list of them] on the [[Bay 12 Forums]].
* Text Editors are used in all areas of modding. Use a good text editor to edit files and search into multiple files (like th/e free [https://notepad-plus-plus.org/ Notepad++] for example) or more advanced editors capable of highlighting and formatting the displayed text (like [[Utilities#DF_RAW_Language_server|DF RAW Language server]])
* Image Editor will be needed for doing custom graphics. [https://www.getpaint.net/ Paint.NET], Photoshop and GIMP are the most used, but whatever supports the .png format will work.

=== Documentation===
; [[Raw file]]s

These object files, stored in <code>/data/vanilla/*/objects/</code>, define various specifics of game items, materials, and creatures, and can be changed using mods to alter how the game behaves. These are text based and can be edited with any text editor, however, editing the vanilla raw files is now discouraged.

See [[Token|Token reference]] - It's always good to refer to tokens on the wiki. Even experienced modders have to look up tokens! A list of articles about tokens can be found here.

; [[Graphics|Graphics Files]]:

The `/data/art/` subfolder of Dwarf Fortress is used to store user-customizable graphics sets.

; [[Reaction]]s:

; [[Language token|Language]] and [[Speech file]]:

; [[Audio|Sound and Music files]]:

All sound and music files used by ''Dwarf Fortress'' are stored in the [https://en.wikipedia.org/wiki/Ogg .ogg] format within the <code>/data/sound/</code> subfolders. You can replace the existing ogg files with different ones. That has to be performed manually and isn't actually supported by the game. You can also change some of the definitions of when certain musical cues are played, using available [[music token]]s and [[sound token]]s in the raw files. However, you can't add new music or sounds other than replacing what's already there.

=== Best practice ===
The current best practice is to not modify the original raw files, since most modifications can be made via mods. Mods can add new objects, add tokens to existing objects, and cut objects entirely.

== Guide ==
This is intended to be a guide to inform those new to ''Dwarf Fortress'' modding on what elements of the game can be modified, and how. After reading through this guide, a user should be capable of editing creatures, entities, materials ''et al'', and creating their own.

Generally, breaking stuff is fine - nothing that can be changed will affect the DF executable, and new additions can be easily removed.

This guide is based on [[40d:Modding guide|Teldin's guide]], originally created for version 0.27.176.39c. Per wiki tradition, it has been updated through all the major releases since then; hopefully it reflects current knowledge.

=== Token reference ===
It's always good to refer to tokens on the wiki. Even experienced modders have to look up tokens! A list of articles about tokens can be found [[Token|here]].

=== Basics of DF modding ===
To make a mod, one must put a folder into the <code>/mods/</code> folder. The vast majority of modifications to the game can be done via this method. This folder should contain a file named "info.txt" and two subfolders: "graphics" (where you insert [[Graphics set repository|graphics sets]]), and "objects", which contains all the data for, generally, everything in the game that is not hardcoded.

The info.txt is formatted like so:

{{code|
[ID:my_first_mod]
[NUMERIC_VERSION:1]
[DISPLAYED_VERSION:1.0.0]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:1.0.0]
[AUTHOR:Your Name Here]
[NAME:My First Mod]
[DESCRIPTION:A cool mod I made!]
}}

A mod should have all of these. There are a [[mod info token|few more tokens]], but the above are the important ones.

Most of the game's vanilla content is in the same format as mods. Many text files can be found in the subfolders of the <code>/data/vanilla</code> folder - these are the [[raw file|raw files]], and using them as a basis for modification is quite easy. For now, we will take a look at one of the existing files. For example, if you open <code>/data/vanilla/vanilla_creatures/creature_standard.txt</code>, it should look something like this:

{{code|
creature_standard

[OBJECT:CREATURE]

[CREATURE:DWARF]
[DESCRIPTION:A short, sturdy creature fond of drink and industry.]
[NAME:dwarf:dwarves:dwarven]
[CASTE_NAME:dwarf:dwarves:dwarven]
[CREATURE_TILE:1][COLOR:3:0:0]
[CREATURE_SOLDIER_TILE:2]
...
}}

As you can see, each file comprises a header string stating the file name, a second header stating the type of object data it contains, followed by the contents of the file itself. These are all necessary elements of the file, and without them, the file will be ignored by the game.

'''In other words, to be recognized by the game, a raw file must have all of the following:'''

# A filename that refers to the type of objects contained therein. '''Creature files must start with creature_, entity files must start with entity_, and so on.'''
# The filename on the first line of the file.
# [OBJECT:type], where "type" is replaced with the relevant object type.

Below the headers, there begins a list of entries. Each entry is made up of its own header (in this case, "[CREATURE:DWARF]"), again stating the type of object, and then the object's unique identifier - if an identifier isn't unique, the game will mess up and you'll get some serious, and potentially very trippy, errors. ([[Duplicated raws|For example...]]) Below that, we have the body of the entry, which determines the entry's specific properties.

The body of an entry is made up of a series of "tokens", which are essentially flags that can be added or removed to affect the entry's attributes. Most of these effects are hardcoded: for example, it's possible to make a creature only eat meat with the [CARNIVOROUS] token, but it's impossible to create your own token detailing a specific diet for the creature.

Before we continue, a few key things to remember when modding the raw files:

* Try to avoid modifying the existing raw files when possible. You should make a mod instead!
* When adding files, token identifiers are all you need to include to ensure proper references are maintained. The game searches through all loaded raw files by tokens. For example, you can add a new pair of leather boots and not even have to add it to a file named item_shoes.txt, but rather your own file, say item_shoes_new.txt and ensure you have the token listed, ex. [ITEM_SHOES:ITEM_SHOES_BOOTS_NEW].

* When a new world is generated, the mods included are "baked in" and cannot be modified except to be updated--for this, the game checks that the mod used by the save is of a compatible NUMERIC_VERSION.
* There's nothing stopping you from just copying an existing creature/entity/whatever, changing the identifier, and modifying it. This can save you a lot of time, especially when it comes to entities.

=== Modifying the vanilla objects ===

You should not modify the vanilla raws where they originally are if you can help it. Instead, patch them using the patching functions now provided with ''Dwarf Fortress'' since v50.01.

There are two patching functions: SELECT and CUT. When SELECT is used, it lets you make changes to an object without needing the entire entry to be present in your mod file. When CUT is used, it forces the game to not use that object, even though it is still found in the vanilla raws. Both of these functions take the form of tokens. These functions are not universally applicable to any token found in any entry, just the following list of objects:

CREATURE, ENTITY, INTERACTION, ITEM, WORD, TRANSLATION, SYMBOL, INORGANIC, PLANT, MUSIC, REACTION, SOUND

The syntax required for these functions is: '''['''<function>'''_'''<object>''':'''<specific object being affected>''']'''. For instance, [CUT_PLANT:MUSHROOM_HELMET_PLUMP] cuts the plump helmet object in the vanilla file plant_standard.txt, so the game will not use that object at all. However, [SELECT_ITEM_HELM:ITEM_HELM_HELM] does not select the helm object from the vanilla file item_helm.txt, even though that's how the object appears in that file, because there is no [SELECT_ITEM_HELM] token. Instead, the helm would be selected with [SELECT_ITEM:ITEM_HELM_HELM].

For example, if you wanted to mod beards onto dwarven women while also removing elephants from the game:

{{code|
creature_mypatch

[OBJECT:CREATURE]

[SELECT_CREATURE:DWARF] starts editing DWARF from the end of the entry
[SELECT_CASTE:FEMALE]
[BODY_DETAIL_PLAN:FACIAL_HAIR_TISSUE_LAYERS]

[CUT_CREATURE:ELEPHANT] removes the ELEPHANT creature
}}

Or, say, add your own reaction and building to dwarves:

{{code|
entity_mypatch

[OBJECT:ENTITY]

[SELECT_ENTITY:MOUNTAIN]
[PERMITTED_REACTION:MY_REACTION]
[PERMITTED_BUILDING:MY_BUILDING]
}}

And in any of these, one can add the token [LOG_CURRENT_ENTRY] somewhere under one of the objects of the file, which logs the full contents of the object in question to logs\current_entry.txt. This can be useful to make sure that the patch is doing what you think it is. For instance if [LOG_CURRENT_ENTRY] were added on the next line after [CREATURE:DWARF] in your mod file, then the dwarf object would be the object detailed in the log entry.

...Speaking of, let's move on to modifying and adding entities.

=== Modding civilizations (entities) ===

Entities - the objects that determine how civilizations work - are stored in <code>vanilla_entities/entity_default.txt</code> (though, like all other files, you may add more). They follow the same format as any other raw file:

{{code|
entity_default

[OBJECT:ENTITY]

[ENTITY:ENTITYNAME]
[CREATURE:CREATURETYPE]
[TRANSLATION:LANGUAGETYPE]
[BIOME_SUPPORT:BIOMETOKEN:FREQUENCY]
...[OTHER TAGS]...
}}

Most of the time, it doesn't matter which order these tokens are in or where they're placed so long as they're below the "ENTITY:" identifier, but there are some important exceptions in the case of other files, especially creatures, which can contain a lot of "nested" tokens.

"[CREATURE:]" links the civilization with a specific creature defined in a creature file. This is the creature that'll be making up the entity's population, and, therefore, the creature you'll be playing as in fortress or adventure mode if the entity is a playable one. For example, if you wanted to do something silly, you could switch the "CREATURE:DWARF" entry in entity_default.txt with "CREATURE:ELF" and you would be marching elves around in fortress mode, although they would still use dwarven technology, language and names and so forth. Oh, and before you get any funny ideas - it ''is'' possible to define more than one creature for a civ, but that won't work in quite the way you probably expect; it will pick only one of the defined creatures at random to use for the civ. Later on, in the creature section, you'll learn about castes, which will provide a much more viable alternative, so try to bear with us until then.

"[TRANSLATION:]" defines the language file that the entity will be using, which will determine what their untranslated words are for things. This doesn't determine which words they use for naming things, only the way those words are spelled. The default language files are HUMAN, DWARF, ELF, and GOBLIN.

"[BIOME_SUPPORT:]" defines the biomes that civs will attempt to settle in. The "FREQUENCY" value determines the likelihood of them building there, but also raises an important point: most of the values you'll be setting for things are relative to each other. If one were to type:

{{code|
[BIOME_SUPPORT:ANY_FOREST:1]
[BIOME_SUPPORT:SAVANNA:2]
}}

This would have very much the same effect as:

{{code|
[BIOME_SUPPORT:ANY_FOREST:5]
[BIOME_SUPPORT:SAVANNA:10]
}}

This holds true for a lot of values throughout the files, excluding when it simply doesn't make sense, such as in materials.

You can find many details about the rest of the civilization tokens [[entity token|here]].

Besides those mentioned, some fundamental ones are the <code>[SITE_CONTROLLABLE]</code> token, which lets you control the civ in fortress mode, the <code>[OUTSIDER_CONTROLLABLE]</code> token, which allows you to play in adventure mode as an outsider, and the <code>[ALL_MAIN_POPS_CONTROLLABLE]</code> token, which allows you to play a civ native (non-outsider) in adventure mode. Other tokens that you should pay attention to are START_BIOME and the ones regarding sites, but in general, you can just run through the aforementioned list and add or remove what you want.

If you have more than one civ with the <code>[SITE_CONTROLLABLE]</code> token, all the available civs from those entities will appear in the group selection section on the embark screen. It may not be immediately obvious from which species each civ may be - while this can be determined from legends mode, the topmost species in the "neighbors" display in the embark screen is always the same as the currently selected species; if your group is dwarven, dwarves will be topmost, whilst (say) elves will be topmost if your chosen group is elven. By default, the game seems to choose a civ (and therefore a species if there is more than one) at random.

You can also attempt to discern the civ yourself by the names it uses - this is the realm of "symbols", collections of words centered around a specific concept. The civ will use the words comprising whatever symbols are applicable to it for various things. This association might be a little confusing at first, so, let's refer to the DWARF entity:

{{code|
[SELECT_SYMBOL:WAR:NAME_WAR]
[SUBSELECT_SYMBOL:WAR:VIOLENT]
[SELECT_SYMBOL:BATTLE:NAME_BATTLE]
[SUBSELECT_SYMBOL:BATTLE:VIOLENT]
[SELECT_SYMBOL:SIEGE:NAME_SIEGE]
[SUBSELECT_SYMBOL:SIEGE:VIOLENT]
}}

Here, we can see that dwarves will generally name their wars first after words in the "NAME_WAR" symbol group, and then, after words in the "VIOLENT" symbol group. This might, for example, result in a war being named "The War of Carnage". The symbols used for the other types of conflict are arrayed in a similar fashion. It would be trivial to replace the instances of VIOLENT with, say, PEACE and end up with a battle called "The Clash of Calm" or something.

{{code|
[SELECT_SYMBOL:ROAD:NAME_ROAD]
[SELECT_SYMBOL:TUNNEL:NAME_TUNNEL]
[SELECT_SYMBOL:BRIDGE:NAME_BRIDGE]
[SELECT_SYMBOL:WALL:NAME_WALL]
}}

The above applies here. Dwarves are fond of naming their roads and tunnels after... roads and tunnels.

{{code|
[SELECT_SYMBOL:REMAINING:ARTIFICE]
[SELECT_SYMBOL:REMAINING:EARTH]
[CULL_SYMBOL:ALL:DOMESTIC]
[CULL_SYMBOL:ALL:SUBORDINATE]
[CULL_SYMBOL:ALL:EVIL]
[CULL_SYMBOL:ALL:UNTOWARD]
[CULL_SYMBOL:ALL:FLOWERY]
[CULL_SYMBOL:ALL:NEGATIVE]
[CULL_SYMBOL:ALL:UGLY]
[CULL_SYMBOL:ALL:NEGATOR]
}}

This section deals with everything else. The things that haven't already been dealt with (hence the "REMAINING") - such as site names, kingdom names, the names of individuals, and such - will have names from the ARTIFICE and EARTH symbol groups. After that, the dwarf entity is told to cull all inappropriate symbols - this applies to everything (hence the "ALL") so if the game happens to choose a symbol associated with, say, EVIL for one of the battles, it'll scrap that name and try again. This sort of thing adds a lot of flavour to DF's entities and can account for a lot of a civ's perceived personality.

Another basic thing to note: any entity token that's dealing with weapons, armor, clothing, etc., will state the items that the civ can build natively, not necessarily the ones they can wear or use. For example, you could create a species with no clothes specified, but then rob a clothes shop in adventurer mode and wear everything you want, or give them weapons that are too large to wield and they could sell them, but not use them.

An easy method of creating a civilization is just to copy-paste a similar one to the bottom of the entity_default.txt file and edit things to your liking. Remember to always change the civ's "ENTITY:" identifier! This can be anything, so long as it's not already existing.

At the end of some of the default entries you'll find a list of positions, both ones that'll directly affect you in fort mode (such as nobles) and ones that'll primarily affect worldgen and adventure mode. A list of the tokens applicable to positions can be found [[position token|here]]; they don't require a great deal of explanation.

==== Trade ====
The following [[entity token]]s affect the appearance of [[trading]] [[caravan]]s:

* [[Entity token#ACTIVE_SEASON|[ACTIVE_SEASON]]] - Defines the seasons when an entity may visit your fortress.
* [[Entity token#PROGRESS_TRIGGER_POPULATION|[PROGRESS_TRIGGER_*]]] - Defines the triggers which control when an entity will become interested in your fortress.
* [[Entity token#COMMON_DOMESTIC_PACK|[COMMON_DOMESTIC_PACK]]] - Allows the civilization to use domestic pack animals. If an entity lacks pack animals (or ability to pull wagons), it will be unable to send caravans (showing as {{DFtext|No Trade|6:1}} at the [[embark]] screen), unless it has domesticated any suitable animal species or is forced to use a non-suitable creature by the [ANIMAL] definition [ALWAYS_WAGON-PULLER] on creature, caste or class.
* [[Entity token#COMMON_DOMESTIC_PULL|[COMMON_DOMESTIC_PULL]]] - Allows the civilization to use domestic animals to pull [[wagon]]s, assuming their [[Ethic#KILL_PLANT|KILL_PLANT ethic]] permits them to use wagons in the first place.
* [[Entity token#MERCHANT_BODYGUARDS|[MERCHANT_BODYGUARDS]]] - Caravan will be guarded by [[soldier]]s.

=== Modding creatures ===

Creature modding is great fun – you can change nearly any aspect of a creature, or make your own completely from scratch.

Modding creatures is very similar to modding civs: it's just a matter of editing, adding, or removing tokens, enclosed in square brackets underneath the creature's [CREATURE:] header. The creature entries contain all of the information about each and every non-random creature in the game, from animals to dwarves to goblins to even caravan wagons. A lot of the creature tokens are fairly self-explanatory; you can find a list of such tokens [[creature token|here]]. But before you start creating your own creatures, you'll want to learn how the tissues system works.

==== Creature materials and tissues ====

In the most basic sense, a creature is a series of body parts. These parts are defined in their own file, and we'll talk about them later, as a specific aspect of how creatures work, which throws off a lot of prospective modders, is the relationship between body parts, tissues, and materials. We're going to show you part of the creature entry for a bronze colossus (bear with us):

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:HUMANOID_JOINTS:5FINGERS:5TOES]
[NO_THOUGHT_CENTER_FOR_MOVEMENT]
[TISSUE:BRONZE]
[TISSUE_NAME:bronze:bronze]
[TISSUE_MATERIAL:INORGANIC:BRONZE]
[MUSCULAR]
[FUNCTIONAL]
[STRUCTURAL]
[RELATIVE_THICKNESS:1]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[TISSUE_LAYER:BY_CATEGORY:ALL:BRONZE]
...
}}

At the top, we can see the "BODY:" token, followed by a list of body parts. As you've probably guessed, these parts make up the physical form of the colossus. But the colossus has to be made out of something - it has to have tissues, and those tissues also have to be made out of something - in this case, bronze.

Below the BODY token you'll see a TISSUE token, followed by an identifier, much like the others we've seen. The TISSUE block is determining how the tissue works, and which purposes it'll serve. As the colossus is just going to be made out of this one tissue, this tissue needs to act like bone, muscle, and everything else combined, hence the MUSCULAR, FUNCTIONAL and STRUCTURAL tokens. The tissue also references a material - INORGANIC:BRONZE - the properties of which are declared in the inorganic materials file, and the tissue is subsequently made out of this material. With us so far?

Below the tissue definition is the TISSUE_LAYER line. TISSUE_LAYER allows you to control where each tissue is applied. Its first argument defines if it's to search by body part category (BY_CATEGORY), body part type (BY_TYPE), or look for a specific part (BY_TOKEN). That's followed by the parts argument itself, which is in this case ALL (so the game's looking for parts in all categories, which is to say, every body part). This is followed by the tissue to be applied, BRONZE. So the TISSUE_LAYER token is telling the game to select all body parts in every category and make them out of the tissue "BRONZE". The colossus is now made of bronze.

By now you're probably thinking "Wow, if this was for a creature made out of however many tissues, this would be amazingly longwinded" and you're right. Luckily, there are two methods by which we can speed things up a lot.

Firstly, there are material and tissue templates. Let's say you were going to make a lot of creatures out of bronze, and you didn't want to have to copy and paste the bronze tissue all over the place. Instead, you create a tissue template. This goes, as you've probably guessed, in a tissue template file.

{{code|
[TISSUE_TEMPLATE:BRONZE_TEMPLATE]
[TISSUE_NAME:bronze:bronze]
[TISSUE_MATERIAL:INORGANIC:BRONZE]
[MUSCULAR]
[FUNCTIONAL]
[STRUCTURAL]
[RELATIVE_THICKNESS:1]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
}}

Now, instead of applying the tissue to each and every bronze creature you're making, you can just refer to the template:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:HUMANOID_JOINTS:5FINGERS:5TOES]
[NO_THOUGHT_CENTER_FOR_MOVEMENT]
[USE_TISSUE_TEMPLATE:BRONZE:BRONZE_TEMPLATE]
[TISSUE_LAYER:BY_CATEGORY:ALL:BRONZE]
...
}}

Material templates work in the same way, but refer to materials instead of tissues.

However, if we're looking at something like a dwarf, even with the templates, editing can get very slow indeed:

{{code|
...
[USE_MATERIAL_TEMPLATE:SKIN:SKIN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:FAT:FAT_TEMPLATE]
[USE_MATERIAL_TEMPLATE:MUSCLE:MUSCLE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:BONE:BONE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:CARTILAGE:CARTILAGE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:HAIR:HAIR_TEMPLATE]
[USE_MATERIAL_TEMPLATE:TOOTH:TOOTH_TEMPLATE]
[USE_MATERIAL_TEMPLATE:EYE:EYE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:NERVE:NERVE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:BRAIN:BRAIN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:LUNG:LUNG_TEMPLATE]
[USE_MATERIAL_TEMPLATE:HEART:HEART_TEMPLATE]
[USE_MATERIAL_TEMPLATE:LIVER:LIVER_TEMPLATE]
[USE_MATERIAL_TEMPLATE:GUT:GUT_TEMPLATE]
[USE_MATERIAL_TEMPLATE:STOMACH:STOMACH_TEMPLATE]
[USE_MATERIAL_TEMPLATE:PANCREAS:PANCREAS_TEMPLATE]
[USE_MATERIAL_TEMPLATE:SPLEEN:SPLEEN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:KIDNEY:KIDNEY_TEMPLATE]
[USE_TISSUE_TEMPLATE:SKIN:SKIN_TEMPLATE]
[USE_TISSUE_TEMPLATE:FAT:FAT_TEMPLATE]
[USE_TISSUE_TEMPLATE:MUSCLE:MUSCLE_TEMPLATE]
...
}}

This is where body detail plans, which have their own file, and are designed to help automate some of the more common processes in creature creation, come in. The first entry in b_detail_plan_default.txt does exactly what we've been trying to do above: it takes all the common materials and shoves them into one plan, which can be referenced with a single token.

{{code|
...
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
...
}}

Much easier. But what about the TISSUE_LAYER tokens? Will we have to type out all of those manually?

Nope, detail plans have that covered as well. It's possible to place variable arguments into a detail plan. For example:

{{code|
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS]
[BP_LAYERS:BY_CATEGORY:BODY:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:BODY_UPPER:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:BODY_LOWER:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:ARM:ARG4:25:ARG3:25:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:ARM_UPPER:ARG4:25:ARG3:25:ARG2:5:ARG1:1]
...
[BP_LAYERS:BY_CATEGORY:NOSE:ARG5:4:ARG1:1]
...
}}

First an argument is placed in the plan (ARG1, ARG2 etc.), followed by the thickness of the tissue that will be inserted in place of the argument. So when we reference the VERTEBRATE_TISSUE_LAYERS plan, we'll be able to do something like this:

{{code|
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
}}

ARG1 in the detail plan is replaced by SKIN, the first tissue we entered. ARG2 is replaced by FAT, ARG3 by MUSCLE, ARG4 by BONE, and ARG5 by CARTILAGE. Hence, our creature's body part designated as BODY is made up of SKIN with thickness 1, FAT with thickness 5, and MUSCLE with thickness 50. Its nose is made up of SKIN (thickness 1) and CARTILAGE (thickness 4).

Things left out of the body plans aside, our dwarf's entire body, material, tissue and tissue layer tokens have been boiled down to this:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:2LUNGS:HEART:GUTS:ORGANS:HUMANOID_JOINTS:
THROAT:NECK:SPINE:BRAIN:SKULL:5FINGERS:5TOES:MOUTH:FACIAL_FEATURES:TEETH:RIBCAGE]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
...
}}

This can save you a lot of time and space if you're making lots of changes common to many creatures. In general, if you're making a creature that's fleshy or chitinous, there are detail plans already included in the game to help you out. You should only have to resort to declaring tissues individually (like our bronze colossus) if you're doing something really out-of-the-ordinary.

Another great thing about templates (and so, detail plans) is that they can be modified after being declared. Let's say we wanted our dwarves to be perpetually on fire (don't ask). We leave the body stuff declared normally:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:2LUNGS:HEART:GUTS:ORGANS:HUMANOID_JOINTS:
THROAT:NECK:SPINE:BRAIN:SKULL:5FINGERS:5TOES:MOUTH:FACIAL_FEATURES:TEETH:RIBCAGE]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
...
}}

We then, in our own mod, select the appropriate material:

{{code|
[SELECT_CREATURE:DWARF]
[SELECT_MATERIAL:SKIN]
[MAT_FIXED_TEMP:10600]
...
}}

We don't want them burning to death, so we'll need to stop that from happening:

{{code|
[SELECT_CREATURE:DWARF]
[SELECT_MATERIAL:SKIN]
[MAT_FIXED_TEMP:10600]
[SELECT_MATERIAL:ALL]
[HEATDAM_POINT:NONE]
...
}}

Note that this makes use of DF's built-in temperature scale. You can read more about that [[Temperature|on this page]]. We're also referencing material tokens, which we haven't gone over yet - we'll talk about making your own materials later.

==== Creature castes ====

Another potentially extremely powerful part of the creature raws is the caste system. The caste system handles both true biological castes and lesser variations, such as sexes.

To understand the true potential of the caste system, we only need to take a look at the raws for antmen, found in creature_subterrenean.txt:

{{code|
...
[CASTE:WORKER]
[CASTE_NAME:worker ant woman:worker ant women:worker ant woman]
Female, but non-breeding.
[POP_RATIO:10000]
[CASTE:SOLDIER]
[CASTE_NAME:soldier ant woman:soldier ant women:soldier ant woman]
Female, but non-breeding.
[POP_RATIO:1000]
[CASTE:DRONE]
[MALE]
[CASTE_NAME:drone ant man:drone ant men:drone ant man]
[POP_RATIO:5]
[CASTE:QUEEN]
[FEMALE]
[CASTE_NAME:queen ant woman:queen ant women:queen ant woman]
[POP_RATIO:1]
[SELECT_CASTE:WORKER]
[SELECT_ADDITIONAL_CASTE:SOLDIER]
[SELECT_ADDITIONAL_CASTE:QUEEN]
[BODY:HUMANOID_4ARMS:2EYES:HEART:GUTS:BRAIN:MOUTH]
[BODYGLOSS:INSECT_UPPERBODY:INSECT_LOWERBODY]
[SELECT_CASTE:DRONE]
[BODY:HUMANOID_4ARMS:2EYES:HEART:GUTS:BRAIN:MOUTH:2WINGS]
[BODYGLOSS:INSECT_UPPERBODY:INSECT_LOWERBODY]
[FLIER]
[SELECT_CASTE:ALL]
[BODY_DETAIL_PLAN:CHITIN_MATERIALS]
[BODY_DETAIL_PLAN:CHITIN_TISSUES]
[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:CHITIN:FAT:MUSCLE]
[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS]
[ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP]
[ATTACK_SKILL:GRASP_STRIKE]
[ATTACK_VERB:punch:punches]
...
}}

It's evident that the process of creating and editing castes is comparable to the modifications we were making to tissues and materials earlier: A caste is declared, and modifications to the base creature are made. Declared castes can be selected and subsequently modified, again, just like tissues and materials.

In this case, each caste is declared, given its own name, and a POP_RATIO, which determines how commonly a birth results in that caste - for every 10000 workers born, there'll be an average of 1000 soldiers, 5 drones and one queen. You've probably also noticed that the DRONE and QUEEN castes have the MALE and FEMALE tokens respectively - these tokens determine how breeding works. A creature without both a MALE caste and a FEMALE caste will be unable to breed (no asexually reproducing creatures yet, unfortunately). As they lack FEMALE, the workers and soldiers are unable to breed with the male drones.

After this, there are some modifications to bodyparts. In this case, the drones have wings and the FLIER token, which the other castes lack. It's entirely possible for creatures of different castes to have completely different body structures, even to the extent that they don't resemble each other at all. If you read the section of this guide that dealt with entities, you may remember a passing mention of multi-creature civilisations and how they don't quite work as you may think they would. The castes system is your workaround. You could create a caste that is, for all intents and purposes, a human, and another caste of the same creature that acts exactly like a giant cave spider, put the creature in a civ, and get a human-spider civ. The only flaw in this approach is that the castes will interbreed.

That's the most complex components of creature creation out of the way. You should find the rest trivial by comparison.

=== Modding items ===

Items are fairly simple to deal with. By default, each item type is contained in its own file; this may help make browsing for a specific item easier, but from a purely technical point of view, it's possible to throw all items into one file. Unfortunately, [[Item definition token|item definition tokens]] don't seem to be especially well-documented (at least not as well as the other object types), but you should be able to figure out most things by way of our explanations and your assumptions.

Let's look at the entry for, of course, the thong:

{{code|
[ITEM_PANTS:ITEM_PANTS_THONG]
[NAME:thong:thongs]
[LAYER:UNDER]
[COVERAGE:25]
[LAYER_SIZE:10]
[LAYER_PERMIT:30]
[MATERIAL_SIZE:1]
[SOFT]
[LEATHER]
[STRUCTURAL_ELASTICITY_WOVEN_THREAD]
}}

Most of these are pretty obvious if one compares them to the other entries in the file. There's a layer for the item, determining where it's worn; a coverage value to determine how well it protects you from cold and other things; a size token to determine how much it counts for when it's under something else; a layer permit token to determine how much can be worn under it; and a material size token to determine how much raw material it takes to make it.

Now, if you wanted to mod these to turn them into metal thongs (ouch!), you would simply have to add [METAL] to it somewhere. Simple! These tokens work by tying into material properties - some materials are designated as suitable for making hard items, some for soft, etc..

Weapons involve a little more detail:

{{code|
[ITEM_WEAPON:ITEM_WEAPON_SWORD_2H]
[NAME:two-handed sword:two-handed swords]
[SIZE:900]
[SKILL:SWORD]
[TWO_HANDED:67500]
[MINIMUM_SIZE:62500]
[MATERIAL_SIZE:5]
[ATTACK:EDGE:100000:8000:slash:slashes:NO_SUB:1250]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
[ATTACK_PREPARE_AND_RECOVER:3:3]
}}

SIZE determines how heavy the weapon is. This has a substantial effect on weapon effectiveness. SKILL determines which skill is used in using the weapon; a list of skills can be found [[skill token|on this page]]. MINIMUM_SIZE determines the minimum size a creature must be before the weapon can be wielded, while TWO_HANDED determines how large a creature must be in order to wield the weapon with one hand.

Attacks take a little more explanation. The first value determines the contact area of the weapon's attack; this should be high for slashing weapons and low for bludgeoning, piercing and poking ones. The second value determines how deep the weapon penetrates - for BLUNT attacks this value is ignored as they're not supposed to penetrate anyway, but in the case of EDGE attacks it should generally be lower for slashing attacks and higher for stabbing attacks.

Following these are the nouns and verb used; they should be self-explanatory. Finally, we have the velocity modifier, which has a multiplying effect on the weapon's size for the purposes of determining how powerful it is in combat. But more accurate it describe distribution of momentum across length of weapon. So STAB perfomed with only muscular power and modifier is x1 (1000). SLASH performed with some rotating momentum of cutting edge, but sword is pretty balanced thru it's length and modifier is just x1.25 (1250). Axes, hammers and maces have more unbalanced mass distribution and weapon mass concentrated far from grasp, so higher modifiers.

ATTACK_PREPARE_AND_RECOVER determine number of game frames to perform these actions. In vanilla almost not varies for different weapons.

Other, more miscellaneous items are generally simple and shouldn't require any further explanation.

Once you've made an item, you just add it to the civ entry so a civilization can actually craft it, and it's done.

=== Modding language files ===
{{main|Language token}}

Let's say you added a whole new species. Sure, you could just swipe one of the existing translation files and steal their language for your species, but that's the lazy way! If you want to create a whole new language, it is very simple.

First, you'd need a whole new language_RACE file, such as language_LIZARDMAN.txt, along with "language_LIZARDMAN" at the top of the file proceeded by [OBJECT:LANGUAGE] and [TRANSLATION:LIZARDMAN]. After that, it's just a matter of copy-pasting one of the existing language lists and editing the finished 'translated' word. That's it! Then just add the translation link to your civ in entity_default.txt and it'll be added to the game on worldgen.

All raw files use Code Page 437 encoding, and you should make sure you are editing these files in that format. As many text editors default to UTF-8, some characters with diacritical marks may fail to show properly. Saving one of the default language raw files in this state will overwrite these characters with the unicode question mark, which will corrupt the file. To fix this replace the file with a clean one downloaded from the distributed version of DF.

(Note that the name of the file doesn't actually matter; however, it's good form to name the file after a creature if only that creature speaks the language.)

=== Modding body parts ===

Imagine you have this fantastic idea for a multi-tentacled winged spider-monster. Sounds great! But in order to make this a reality you may need to create a new set of body parts for it. That's no problem! Making body parts is easy, though it may look complicated at first.

All of the default body definitions are located in body_default.txt and then linked to a creature in the creature's entry. We've talked about how bodyparts make up creatures earlier, in the creature section. You can mix and match them in the creature entry and it makes no difference, as long as they're there: each body part will link itself to the appropriate connection automatically when the creature is first created.

Body parts work by sections: you can add as many sections as you want to a body part definition, but generally you should keep it fairly low for ease of use. Each body section entry is in the, very simple, format:

{{code|
[BODY:BODYNAME]
[BP:TOKENID:name][TOKENSGOHERE][DEFAULT_RELSIZE:][CATEGORY:WHATEVER]
}}

The most important tokens are "CONTYPE" and "CON": CONTYPE means the body part in question is connected to a certain ''type'' of body part, while CON means it's connected to a ''specific'' one. TOKENID is yet another identifier, which should be unique, as it's referenced every time something uses CON or BY_TOKEN. DEFAULT_RELSIZE defines, of course, what the body part's size is in relation to the other parts. CATEGORY defines a category for the part, which can be unique or shared with other parts. This is referenced whenever BY_CATEGORY is used.

A list of body part tokens can be found [[body token|here]].

Let's take a simple example, a head:

{{code|
[BODY:BASIC_HEAD]
[BP:HD:head:STP][CONTYPE:UPPERBODY][HEAD][CATEGORY:HEAD]
[DEFAULT_RELSIZE:300]
}}

It connects directly to an upper body.

{{code|
[BODY:2EYES]
[BP:REYE:right eye:STP][CONTYPE:HEAD][SIGHT][EMBEDDED][SMALL][RIGHT][CATEGORY:EYE]
[DEFAULT_RELSIZE:5]
[BP:LEYE:left eye:STP][CONTYPE:HEAD][SIGHT][EMBEDDED][SMALL][LEFT][CATEGORY:EYE]
[DEFAULT_RELSIZE:5]
}}

These are a pair of eyes, connecting to the head.

{{code|
[BODY:HUMANOID]
[BP:UB:upper body:upper bodies][UPPERBODY][CATEGORY:BODY_UPPER]
[DEFAULT_RELSIZE:1000]
[BP:LB:lower body:lower bodies][CON:UB][LOWERBODY][CATEGORY:BODY_LOWER]
[DEFAULT_RELSIZE:1000]
[BP:HD:head:STP][CON:UB][HEAD][CATEGORY:HEAD]
[DEFAULT_RELSIZE:300]
[BP:RUA:right upper arm:STP][CON:UB][LIMB][RIGHT][CATEGORY:ARM_UPPER]
[DEFAULT_RELSIZE:200]
[BP:LUA:left upper arm:STP][CON:UB][LIMB][LEFT][CATEGORY:ARM_UPPER]
[DEFAULT_RELSIZE:200]
[BP:RLA:right lower arm:STP][CON:RUA][LIMB][RIGHT][CATEGORY:ARM_LOWER]
[DEFAULT_RELSIZE:200]
[BP:LLA:left lower arm:STP][CON:LUA][LIMB][LEFT][CATEGORY:ARM_LOWER]
[DEFAULT_RELSIZE:200]
[BP:RH:right hand:STP][CON:RLA][GRASP][RIGHT][CATEGORY:HAND]
[DEFAULT_RELSIZE:80]
[BP:LH:left hand:STP][CON:LLA][GRASP][LEFT][CATEGORY:HAND]
[DEFAULT_RELSIZE:80]
[BP:RUL:right upper leg:STP][CON:LB][LIMB][RIGHT][CATEGORY:LEG_UPPER]
[DEFAULT_RELSIZE:500]
[BP:LUL:left upper leg:STP][CON:LB][LIMB][LEFT][CATEGORY:LEG_UPPER]
[DEFAULT_RELSIZE:500]
[BP:RLL:right lower leg:STP][CON:RUL][LIMB][RIGHT][CATEGORY:LEG_LOWER]
[DEFAULT_RELSIZE:400]
[BP:LLL:left lower leg:STP][CON:LUL][LIMB][LEFT][CATEGORY:LEG_LOWER]
[DEFAULT_RELSIZE:400]
[BP:RF:right foot:right feet][CON:RLL][STANCE][RIGHT][CATEGORY:FOOT]
[DEFAULT_RELSIZE:120]
[BP:LF:left foot:left feet][CON:LLL][STANCE][LEFT][CATEGORY:FOOT]
[DEFAULT_RELSIZE:120]
}}

An entire humanoid body. The foot bone's connected to the ankle bone...

"BODYGLOSS" entries, which you can sometimes find applied to creature entries, are simply replacement words for specific part name strings in a creature. For example, you'll find the bodygloss [BODYGLOSS:CLAW_HAND:hand:claw] in body_default.txt; you can then use this in a creature via "[BODYGLOSS:CLAW_HAND]" and it'll replace all instances of "hand" with "claw" in that creature. Be warned, however—if you were to, say make a bodygloss [BODYGLOSS:EARSTALK:ear:stalk:ears:stalk], it would not only change "ear" and "ears" to "stalk" and "stalks", it would also change "h'''ear'''t" to "h'''stalk'''t"! For all intents and purposes the body part will still function as the proper part, though.

=== Modding plants ===

Plants are, again, not unlike creatures. With what you've learned so far in regard to tokens and the materials system, running through the notes included in plant_standard.txt should explain most things. [[Plant token|Here's the list of plant-specific tokens]].

Below is the [[plump helmet]] raw description:

{{code|
[PLANT:MUSHROOM_HELMET_PLUMP]
[NAME:plump helmet][NAME_PLURAL:plump helmets][ADJ:plump helmet]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PICKED_TILE:161][PICKED_COLOR:6:13:0]
[GROWDUR:300][VALUE:2]
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen dwarven wine]
[STATE_NAME_ADJ:LIQUID:dwarven wine]
[STATE_NAME_ADJ:GAS:boiling dwarven wine]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:5:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]

[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[EDIBLE_COOKED]
[SEED:plump helmet spawn:plump helmet spawn:4:0:1:LOCAL_PLANT_MAT:SEED]
[SPRING][SUMMER][AUTUMN][WINTER]
[FREQUENCY:100]
[CLUSTERSIZE:5]
[PREFSTRING:rounded tops]
[WET][DRY]
[BIOME:SUBTERRANEAN_WATER]
[UNDERGROUND_DEPTH:1:3]
[SHRUB_TILE:142]
[DEAD_SHRUB_TILE:28]
[SHRUB_COLOR:5:13:0]
[DEAD_SHRUB_COLOR:5:6:0]
}}

Let's look at this line by line: 
First, we define its file name. In this case it's MUSHROOM_HELMET_PLUMP. Next we define its in-game name (plump helmet) and its adjective for if you were to craft with it (e.g. plump helmet earrings).

{{code|
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

This defines the structure and material of the plant. It references STRUCTURAL_PLANT_TEMPLATE in the first line, so if you were to say, add wings to the template, the plump helmet plant would be winged. This is for the plant itself, not the end plump helmets.

After that we get our edible tokens. These say that vermin can eat the plant, and it can be eaten raw or cooked by your dwarves. So if you wanted a plant vermin would leave alone, you'd remove the [EDIBLE_VERMIN] token.

{{code|
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
}}

Next, [PICKED_TILE:161] is the character (161 in this case) shown when the crop is harvested. See [[Main:Character table|character table]] for a table of usable tiles. [PICKED_COLOR:6:13:0] is the color used for the crop's tile when harvested. It's in a foreground:background:brightness format. See [[color]] for the colors usable.

{{code|
[PICKED_TILE:161][PICKED_COLOR:6:13:0]
}}

[GROWDUR:300] is how long it takes for your crop to grow. There are 1008 growdur units in a season. 
[VALUE:2] Is the value of the harvested plant (default 1).

{{code|
[GROWDUR:300][VALUE:2]
}}

This defines the plant's alcohol states. [STATE_NAME_ADJ:ALL_SOLID:] is the frozen name, followed is the actual drink name, and then its boiling name. These are achieved by either Scorching or Freezing climates. [DISPLAY_COLOR] is, of course, color, and [EDIBLE_RAW] and [EDIBLE_COOKED] are saying you can drink the alcohol raw or cooked.

{{code|
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen dwarven wine]
[STATE_NAME_ADJ:LIQUID:dwarven wine]
[STATE_NAME_ADJ:GAS:boiling dwarven wine]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:5:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
}}

After that we get our seed template:

{{code|
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[EDIBLE_COOKED]
[SEED:plump helmet spawn:plump helmet spawn:4:0:1:LOCAL_PLANT_MAT:SEED]
}}

And all this says is that the seeds may be eaten by vermin or cooked. Then it gives the name of our plant's seed, its plural name, its foreground, background, and brightness colors, followed by its seed material; said material should have [SEED_MAT] to permit proper stockpiling.

And finally for the last chunk we have this:

{{code|
[SPRING][SUMMER][AUTUMN][WINTER]
[FREQUENCY:100]
[CLUSTERSIZE:5]
[PREFSTRING:rounded tops]
[WET][DRY]
[BIOME:SUBTERRANEAN_WATER]
[UNDERGROUND_DEPTH:1:3]
[SHRUB_TILE:142]
[DEAD_SHRUB_TILE:28]
[SHRUB_COLOR:5:13:0]
[DEAD_SHRUB_COLOR:5:6:0]
}}

First we define what season(s) the plant may grow in, then we define how frequently this plant is generated in a particular area, followed by how many harvested crop items may come from 1 plant. [PREFSTRING:] is what your dwarves like about the plant, which in this case is the rounded tops. [WET][DRY] are the conditions under which the plant can grow. Wet means it can grow close to water, dry means it can grow away from water. This does not mean you can grow the plant on dry stone however. It is just for natural spawning of the plant. 
[BIOME] Is what biome the plant grows in. [UNDERGROUND_DEPTH:Minimum:Maximum] Is the highest and lowest cavern levels that the plant can appear in if its biome is subterranean. Dwarven civilizations will only export (via the embark screen or caravans) things that are available at depth 1. Defaults to 0:0 (surface only). 
Lastly, [SHRUB_TILE] is the character used for the naturally spawning shrub of this plant, [DEAD_SHRUB] is the dead shrub character. [SHRUB_COLOR] Is the shrub's color, and [DEAD_SHRUB_COLOR] is, of course, the dead shrub's color.

While this may or may not look like a lot of tokens, it's very easy. Just copy an existing plant and edit it to your new plant. 
For the rest of the tokens, see [[plant token]].

==== Trees ====

Trees are another kind of plant that can be modded. Being plants, they use many of the same tokens as edible crops, but differ in having a few tree-specific tokens.

Below is the [[apple|apple tree]] raw description:

{{code|
[PLANT:APPLE] malus sieversii
[NAME:apple tree][NAME_PLURAL:apple trees][ADJ:apple tree]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[USE_MATERIAL_TEMPLATE:WOOD:WOOD_TEMPLATE]
[STATE_NAME:ALL_SOLID:apple wood]
[STATE_ADJ:ALL_SOLID:apple wood]
[PREFIX:NONE]
[SOLID_DENSITY:745] *** http://www.csudh.edu/oliver/chemdata/woods.htm
[STATE_COLOR:ALL_SOLID:CHOCOLATE] *** http://www.forestryforum.com/board/index.php/topic,61009.0.html
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen apple cider]
[STATE_NAME_ADJ:LIQUID:apple cider]
[STATE_NAME_ADJ:GAS:boiling apple cider]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:6:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
[USE_MATERIAL_TEMPLATE:LEAF:LEAF_TEMPLATE]
[STATE_COLOR:ALL:GREEN]
[DISPLAY_COLOR:2:0:0]
[USE_MATERIAL_TEMPLATE:FLOWER:FLOWER_TEMPLATE]
[STATE_COLOR:ALL:ROSE]
[DISPLAY_COLOR:5:0:1]
[USE_MATERIAL_TEMPLATE:FRUIT:FRUIT_TEMPLATE]
[STATE_COLOR:ALL:RUST]
[DISPLAY_COLOR:4:0:0]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[STOCKPILE_PLANT_GROWTH]
[MATERIAL_REACTION_PRODUCT:DRINK_MAT:LOCAL_PLANT_MAT:DRINK]
[MATERIAL_REACTION_PRODUCT:SEED_MAT:LOCAL_PLANT_MAT:SEED]
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[SEED:apple seed:apple seeds:0:0:1:LOCAL_PLANT_MAT:SEED]
[TREE:LOCAL_PLANT_MAT:WOOD][TREE_TILE:5]
[TRUNK_PERIOD:10]
[HEAVY_BRANCH_DENSITY:25]
[BRANCH_DENSITY:50]
[MAX_TRUNK_HEIGHT:3]
[HEAVY_BRANCH_RADIUS:1]
[BRANCH_RADIUS:2]
[TRUNK_BRANCHING:2]
[MAX_TRUNK_DIAMETER:1]
[TRUNK_WIDTH_PERIOD:200]
[ROOT_DENSITY:5]
[ROOT_RADIUS:3]
[STANDARD_TILE_NAMES]
[PREFSTRING:fruit]
[DRY]
[BIOME:ANY_TEMPERATE]
[SAPLING]
[GROWTH:LEAVES]
[GROWTH_NAME:apple leaf:apple leaves]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:LEAF]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_HOST_TILE:SAPLING]
[GROWTH_TIMING:0:300000]
[GROWTH_PRINT:0:6:2:0:0:0:209999:1]
[GROWTH_PRINT:0:6:6:0:1:210000:239999:1] autumn color
[GROWTH_PRINT:0:6:4:0:1:240000:269999:1]
[GROWTH_PRINT:0:6:4:0:0:270000:300000:1]
[GROWTH_DROPS_OFF]
[GROWTH:FLOWERS]
[GROWTH_NAME:apple flower:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FLOWER]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:60000:119999]
[GROWTH_PRINT:5:5:5:0:1:60000:119999:2]
[GROWTH:FRUIT]
[GROWTH_NAME:apple:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FRUIT]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:120000:200000]
[GROWTH_DROPS_OFF_NO_CLOUD]
[GROWTH_PRINT:'%':'%':4:0:0:120000:200000:3]
[GROWTH_HAS_SEED]
}}

The first lines are the same as the ones we saw being used in the plump helmets, defining the plant object, giving it a name, and deciding that it should use the standard STRUCTURAL_PLANT material for its structure.

{{code|
[PLANT:APPLE] malus sieversii
[NAME:apple tree][NAME_PLURAL:apple trees][ADJ:apple tree]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

Adding the token [[DF2014:Material_definition_token#DISPLAY_COLOR|DISPLAY_COLOR]] directly after [USE_MATERIAL_TEMPLATE] would allow us to change the color of the tree.

{{code|
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[DISPLAY_COLOR:1:0:0]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

would give us a dark blue apple tree. This method is used by the game in [[birch|birches]] and [[spore tree|various]] [[nether-cap|underground]] [[blood thorn|trees]].

Next come the definitions of various other materials used by the tree:

{{code|
[USE_MATERIAL_TEMPLATE:WOOD:WOOD_TEMPLATE]
[STATE_NAME:ALL_SOLID:apple wood]
[STATE_ADJ:ALL_SOLID:apple wood]
[PREFIX:NONE]
[SOLID_DENSITY:745] *** http://www.csudh.edu/oliver/chemdata/woods.htm
[STATE_COLOR:ALL_SOLID:CHOCOLATE] *** http://www.forestryforum.com/board/index.php/topic,61009.0.html
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen apple cider]
[STATE_NAME_ADJ:LIQUID:apple cider]
[STATE_NAME_ADJ:GAS:boiling apple cider]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:6:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
[USE_MATERIAL_TEMPLATE:LEAF:LEAF_TEMPLATE]
[STATE_COLOR:ALL:GREEN]
[DISPLAY_COLOR:2:0:0]
[USE_MATERIAL_TEMPLATE:FLOWER:FLOWER_TEMPLATE]
[STATE_COLOR:ALL:ROSE]
[DISPLAY_COLOR:5:0:1]
[USE_MATERIAL_TEMPLATE:FRUIT:FRUIT_TEMPLATE]
[STATE_COLOR:ALL:RUST]
[DISPLAY_COLOR:4:0:0]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[STOCKPILE_PLANT_GROWTH]
[MATERIAL_REACTION_PRODUCT:DRINK_MAT:LOCAL_PLANT_MAT:DRINK]
[MATERIAL_REACTION_PRODUCT:SEED_MAT:LOCAL_PLANT_MAT:SEED]
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[SEED:apple seed:apple seeds:0:0:1:LOCAL_PLANT_MAT:SEED]
}}

From them, we get to know what the parts of the tree can be used for, as well as how they will appear when separated from the tree. Any alterations that can be done to materials normally can be done here, such as changing the value or adding a [[syndrome]].

[TREE:LOCAL_PLANT_MAT:WOOD][TREE_TILE:5]

[TREE] is what turns your plant object into an actual tree. The following argument describes what material the harvested logs should be made of. If NONE, the felled tree will give no logs. [TREE_TILE] is the tile the tree shows up as on the world map.

Note that all vanilla trees (that give logs) use the WOOD material defined above as the argument for [TREE], as opposed to the STRUCTURAL material. Thus, any changes to the properties of the wood harvested should be done to the WOOD material.

The following tokens decide the dimensions of the tree, and how it grows.

{{code|
[TRUNK_PERIOD:10]
[HEAVY_BRANCH_DENSITY:25]
[BRANCH_DENSITY:50]
[MAX_TRUNK_HEIGHT:3]
[HEAVY_BRANCH_RADIUS:1]
[BRANCH_RADIUS:2]
[TRUNK_BRANCHING:2]
[MAX_TRUNK_DIAMETER:1]
[TRUNK_WIDTH_PERIOD:200]
[ROOT_DENSITY:5]
[ROOT_RADIUS:3]
}}

[TRUNK_PERIOD] and [TRUNK_WIDTH_PERIOD] determine how long it takes for the trunk to grow one tile taller respectively wider, in years. [MAX_TRUNK_HEIGHT:3] and [MAX_TRUNK_DIAMETER:1] determine the maximum value the above can reach. [TRUNK_BRANCHING] decides how "curvy" the tree is, with [TRUNK_BRANCHING:0] meaning the tree is entirely straight.

[HEAVY_BRANCH_DENSITY:25], [HEAVY_BRANCH_RADIUS:1], [BRANCH_DENSITY:50], [BRANCH_RADIUS:2], [ROOT_DENSITY:5], and [ROOT_RADIUS:3] determine the density (how many are there, integer ranging 0-100) and radius (in tiles) away from the trunk, of heavy branches, normal branches and roots respectively.

[STANDARD_TILE_NAMES] makes the tree use standard names for the trunk, branches etc. Otherwise custom ones can be used. (see [[Plant_token|full plant token list]])

[SAPLING] ensures saplings of this tree are called "[tree name] sapling", instead of the standard "young [tree name]".

Lastly, we are introduced to the [GROWTH] token. [GROWTH] defines growths growing on a plant, in this case our apple tree. Apple trees have three growths: leaves, flowers and fruits.

{{code|
[GROWTH:FRUIT]
[GROWTH_NAME:apple:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FRUIT]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:120000:200000]
[GROWTH_DROPS_OFF_NO_CLOUD]
[GROWTH_PRINT:'%':'%':4:0:0:120000:200000:3]
[GROWTH_HAS_SEED]
}}

First comes the name of the growth. Then, with [GROWTH_ITEM], what kind of growth it is, in this case a PLANT_GROWTH made out of the local FRUIT material. [GROWTH_DENSITY] says how densely the growth grows, and [GROWTH_HOST_TILE] where on the tree it grows. [GROWTH_TIMING] decides when the growth appears, in annual ticks. The growth then drops off, leaving no clouds (items to be picked up by your dwarves). [GROWTH_PRINT] sets it to look like a red '%', and [GROWTH_HAS_SEED] implies that eating this growth will leave you with a seed.

=== Workshops ===

Workshops are raw-designed pretty differently from everything else in the game, being buildable structures rather than items or methods to gain items. However, they are fairly simple. For example, here's the raw for the [[soap maker's workshop]]:

{{code|code=
[BUILDING_WORKSHOP:SOAP_MAKER]
[NAME:Soap Maker's Workshop]
[NAME_COLOR:7:0:1]
[DIM:3:3]
[WORK_LOCATION:2:2]
[BUILD_LABOR:SOAP_MAKER]
[BUILD_KEY:CUSTOM_SHIFT_P]
[BLOCK:1:0:0:0] workbenches no longer block
[BLOCK:2:0:0:0]
[BLOCK:3:0:0:0]
[TILE:0:1:' ':' ':150]
[TILE:0:2:' ':' ':'/']
[TILE:0:3:'-':' ':' ']
[COLOR:0:1:0:0:0:0:0:0:6:0:0]
[COLOR:0:2:0:0:0:0:0:0:6:0:0]
[COLOR:0:3:6:0:0:0:0:0:0:0:0]
[TILE:1:1:' ':' ':'=']
[TILE:1:2:'-':' ':8]
[TILE:1:3:' ':' ':150]
[COLOR:1:1:0:0:0:0:0:0:6:0:0]
[COLOR:1:2:6:0:0:0:0:0:6:0:0]
[COLOR:1:3:0:0:0:0:0:0:6:0:0]
[TILE:2:1:'-':' ':8]
[TILE:2:2:' ':' ':8]
[TILE:2:3:' ':150:' ']
[COLOR:2:1:6:0:0:0:0:0:6:0:0]
[COLOR:2:2:0:0:0:0:0:0:6:0:0]
[COLOR:2:3:0:0:0:6:0:0:0:0:0]
[TILE:3:1:150:' ':8]
[TILE:3:2:' ':' ':8]
[TILE:3:3:' ':240:' ']
[COLOR:3:1:6:0:0:0:0:0:6:7:0]
[COLOR:3:2:0:0:0:0:0:0:6:7:0]
[COLOR:3:3:0:0:0:7:0:1:0:0:0]
[BUILD_ITEM:1:BUCKET:NONE:NONE:NONE][EMPTY][CAN_USE_ARTIFACT]
[BUILD_ITEM:1:NONE:NONE:NONE:NONE][BUILDMAT][WORTHLESS_STONE_ONLY][CAN_USE_ARTIFACT]
[TOOLTIP:Use tallow (rendered fat) or oil here with lye to make soap.]
}}

A line-by-line breakdown:

{{code|
[NAME:Soap Maker's Workshop]
[NAME_COLOR:7:0:1]
}}

These are the name of the workshop ("Soap Maker's Workshop") and [[color]] of the workshop's name when examined with 'q' (White with a black background).

{{code|
[DIM:3:3]
[WORK_LOCATION:2:2]
}}

DIM refers to how large the workshop will be, in this case 3 wide, 3 tall. WORK_LOCATION tells where the creature using it (usually a dwarf) will work, numbered from the top right--in this case, 2:2, or the middle. Multiple work locations can be defined, even outside the dim.

{{code|
[BUILD_LABOR:SOAP_MAKER]
[BUILD_KEY:CUSTOM_SHIFT_S]
}}

These refer to the worker required to build it (soap maker) and the key used to build it in the workshop menu (capital S).

{{code|
[BLOCK:1:0:0:0]
...
}}
This is a bit more complex, and is where we get to the meaty part of workshop making--the tiles' properties. BLOCK refers to which tiles will be untraversable--1 means blocked, 0 means unblocked. The first number refers to row, and the next 3 refer to column, so 1:0:0:0 means that, on the first row, all tiles will be unblocked. This is the case for all vanilla workshops, as of now.

{{code|
[TILE:0:1:' ':' ':150]
...
}}
The TILE token tells which tile will go where. note, however, that there are 5 entries here instead of 4. The first number, in this case, refers to build stage, numbered from 0 to 3; 3 or 1 is fully built (depending on whether there are stages), 0 is just placed, and 2 is always an intermediate stage, while 1 is usually an intermediate stage. Whether 1 is an intermediate stage or not depends on if there are a 2 and 3 stage; if 2 and 3 exist, 1 will be intermediate. The second number and beyond are similar to BLOCK; however, instead of 1s and 0s, you must input tiles. The tiles themselves can be given in quotes (as in ' ') or given as a number, which can be looked up [[Tilesets|here]]. Here, we have 150, which is û.

{{code|
[COLOR:1:1:0:0:0:0:0:0:6:0:0]
...
}}
Color is as TILE, but with colors instead of tiles; however, colors are made up of 3 numbers each or MAT. MAT refers to the color of the material used to make it; the 3 numbers refer to foreground:background:foreground brightness, and can be looked up [[Color|here]]. For example, 4:2:1 will give you bright red with a dark green background.

{{code|
[BUILD_ITEM:1:BUCKET:NONE:NONE:NONE][EMPTY][CAN_USE_ARTIFACT]
[BUILD_ITEM:1:NONE:NONE:NONE:NONE][BUILDMAT][WORTHLESS_STONE_ONLY][CAN_USE_ARTIFACT]
}}
These refer to items required to build the building. These are in the same format as [[Reaction|reaction reagents and products]]--quantity:[[Item token|item]]:[[Material token|material]]. You'll learn more about those on the article about [[Reaction|reactions]], though. The second BUILD_ITEM is special-- it uses modifiers exclusively to determine its requirements. BUILDMAT refers to wood logs, wood blocks, stone boulders, and stone blocks; WORTHLESS_STONE_ONLY means it can't use economic stone; CAN_USE_ARTIFACT means that it... can use artifacts. EMPTY, in the bucket's case, means that the bucket must be empty.

{{code|
[TOOLTIP:Use tallow (rendered fat) or oil here with lye to make soap.]
}}

This is the text in the tooltip shown when the building is highlighted by the mouse in the workshops list.

More can be seen at the [[Building token|building tokens]] article.

=== Reactions ===

Reactions are the crafting recipes used in [[workshop]]s, and by the [[adventurer mode|adventurer]]. By adding new reactions you can make new items available, or enable you to get items or materials in new ways. The reactions can also be given to entities, in which case they will make use of them during both world gen and play; making a reaction that creates [[steel]] directly from [[plant fiber]]s, would allow the elves to craft steel and arrive clad in it in a [[siege]].

Not all crafting reactions are defined in the raws, but some are, such as those for [[ceramic industry|pottery]] and [[Metal#Alloys_2|alloy]] making.

An in-depth guide for reactions is available [[Reactions|here]].

=== Materials ===

As we've seen when talking about creatures, materials are vital. Materials show up in two forms: material templates, which generally show up in creatures, and specific materials (designated as "inorganic"), which are (by default, at least) consigned purely to metal and stone types.

Let's take a look at METAL_TEMPLATE in material_template_default.txt. It's evident that most of the basic properties of metals are already defined in the template - it goes red and melts at a high enough temperature, it's heavy, and (as noted by the very bottom token) is a metal. We already know just how useful templates can be to creatures, and the same applies to other materials.

Now let's take a look at inorganic_metal.txt. You can see that the metals here refer to the templates, and, just like we did with creatures, then modify the properties of that template and expand upon it.

Finally, let's look at inorganic_stone_mineral.txt. Here we can see that in addition to the changes made to the template, there are also ENVIRONMENT tokens - these tell the game where to place these minerals during worldgen.

[[material definition token|Here's a list of material tokens]]. It should also help you out with any modifications you want to make regarding those creature modifications we were making a while back. See, it all ties together in the end. The beauty of the current materials system is that there's actually very little difference between, say, leather and iron - they're fundamentally the same thing, just with different properties, which is how things really should be.

== Selecting and Cutting ==

[[Modding#Modifying_the_vanilla_objects|As explained above]], existing raws can be altered with the use of SELECT, and can also be culled with CUT for more granular control,compared to simply unloading vanilla content in the mod loader. Token behavior when multiple tokens are added is dependent on the individual token. Removing tags from an object without cutting and recreating the object in question is typically impossible. Creatures can have tags removed without being removed and replaced by way of creature variations.

The syntax for selecting and cutting objects is as follows:

{{code|code=
Substitute X for the desired object.

[SELECT_CREATURE:X]
[CUT_CREATURE:X]

[SELECT_ENTITY:X]
[CUT_ENTITY:X]

[SELECT_INTERACTION:X]
[CUT_INTERACTION:X]

[SELECT_ITEM:X]
[CUT_ITEM:X]

[SELECT_WORD:X]
[CUT_WORD:X]

[SELECT_TRANSLATION:X]
[CUT_TRANSLATION:X]

[SELECT_SYMBOL:X]
[CUT_SYMBOL:X]

[SELECT_INORGANIC:X]
[CUT_INORGANIC:X]

[SELECT_PLANT:X]
[CUT_PLANT:X]

[SELECT_MUSIC:X]
[CUT_MUSIC:X]

[SELECT_REACTION:X]
[CUT_REACTION:X]

[SELECT_SOUND:X]
[CUT_SOUND:X]

}}

== Examples ==
:''Main articles: [[:Category:Modding_Examples]]''

The Hydling below was made by Mysteryguye (and annotated, updated and separated into blocks by Putnam), to act as an example creature.

{{code|code=
[CREATURE:HYDLING]
[DESCRIPTION:A seven-headed small hairy thing, about the size of a dog. It is very loyal to its masters, and will promptly disembowel any enemy straying too close.]
This is the description that shows up in-game when viewing the creature.

[NAME:hydling:hydlings:hydlish] If there were a civ made of hydlings, it would appear as "hydlings" in the neighbors screen.

[CASTE_NAME:hydling:hydlings:hydlish]

[CREATURE_TILE:'='][COLOR:2:0:1] Will appear as a light green "=".

[PETVALUE:40][NATURAL] Creature is known to be naturally occurring by the game. Will cost 40 embark points to buy.

[LARGE_ROAMING] Will spawn outdoors, wandering around.

[COMMON_DOMESTIC][TRAINABLE][PET] Can be bought on embark as a pet, war animal, or hunting animal.

[BONECARN] Can eat meat and bones only--no vegetables.

[PREFSTRING:loyalty] Dwarves will like it for its loyalty.

[LARGE_PREDATOR] Will attack rather than flee.

[BODY:BASIC_2PARTBODY:7HEADNECKS:BASIC_FRONTLEGS:BASIC_REARLEGS:TAIL:2EYES:NOSE:2LUNGS:HEART:GUTS:ORGANS:THROAT:SPINE:BRAIN:SKULL:3TOES_FQ_REG:3TOES_RQ_REG:MOUTH:TONGUE:GENERIC_TEETH_WITH_FANGS:RIBCAGE]

Has a lower body, upper body, 4 legs, a tail, fourteen eyes, fourteen ears, seven noses, two lungs, a heart, guts, a pancreas etc., and 7 heads with all that goes with those.

[BODYGLOSS:PAW] Feet will be called "paws"

[BODY_DETAIL_PLAN:STANDARD_MATERIALS] Declares the standard materials that most creatures' tissues are made of.

[BODY_DETAIL_PLAN:STANDARD_TISSUES] This declares the tissues that the creature's tissue layers are made of.

[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] And this describes the tissue layers that the creature is made of.

[BODY_DETAIL_PLAN:BODY_HAIR_TISSUE_LAYERS:HAIR] Creature will be covered with a layer of fur.

[USE_MATERIAL_TEMPLATE:NAIL:NAIL_TEMPLATE] And it'll have nails.

[USE_TISSUE_TEMPLATE:NAIL:NAIL_TEMPLATE]

[TISSUE_LAYER:BY_CATEGORY:TOE:NAIL:FRONT] On the toe, specifically.

[SELECT_TISSUE_LAYER:HEART:BY_CATEGORY:HEART]
[PLUS_TISSUE_LAYER:SKIN:BY_CATEGORY:THROAT]
[TL_MAJOR_ARTERIES] Heart and throat--called above--will cause heavy bleeding if ruptured.

[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS] Places eyes, ears and what-have-you into their correct placement, so that you don't have people punching out eyes from behind.

[BODY_DETAIL_PLAN:HUMANOID_RIBCAGE_POSITIONS] Sets the ribcage as being around lungs and heart.

[USE_MATERIAL_TEMPLATE:SINEW:SINEW_TEMPLATE] Defines sinew so that...
[TENDONS:LOCAL_CREATURE_MAT:SINEW:200] Tendons...
[LIGAMENTS:LOCAL_CREATURE_MAT:SINEW:200] ...And ligaments can be defined.

[HAS_NERVES] Creature has nerves, and as such can be disabled by severing them.

[USE_MATERIAL_TEMPLATE:BLOOD:BLOOD_TEMPLATE] Defines the material BLOOD using the template BLOOD_TEMPLATE.
[BLOOD:LOCAL_CREATURE_MAT:BLOOD:LIQUID] Defines the creature's BLOOD as being made of the above-defined BLOOD material in a LIQUID state.

[CREATURE_CLASS:GENERAL_POISON] Creature can be affected by syndromes that affect GENERAL_POISON.

[GETS_WOUND_INFECTIONS] Pretty much self-explanatory. Creature can get infected from wounds.
[GETS_INFECTIONS_FROM_ROT] And from necrosis.

[USE_MATERIAL_TEMPLATE:PUS:PUS_TEMPLATE] Defines PUS using PUS_TEMPLATE.
[PUS:LOCAL_CREATURE_MAT:PUS:LIQUID] Defines PUS as being made of PUS.

[BODY_SIZE:0:0:1000] Creature will be 1000 cubic centimeters at birth...
[BODY_SIZE:1:0:12500] 12500 cubic centimeters at 1 year old...
[BODY_SIZE:2:0:30000] and 30000 cubic centimeters at 2.

[BODY_APPEARANCE_MODIFIER:LENGTH:90:95:98:100:102:105:110] Creature can be anywhere from 90% to 110% as long as others.
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] As above, but with height.
[BODY_APPEARANCE_MODIFIER:BROADNESS:90:95:98:100:102:105:110] As above, but with broadness. This puts the minimum size of the creature (when fully grown) at 21870 and the maximum size at 39930.

[MAXAGE:20:30] Creature will die of old age between the ages of 20 and 30, no later than 30, no sooner than 20.

[CAN_DO_INTERACTION:MATERIAL_EMISSION] Creature can use the MATERIAL_EMISSION interaction.
[CDI:ADV_NAME:Hurl fireball] In adventurer mode, the MATERIAL_EMISSION interaction will appear as "Hurl fireball".
[CDI:USAGE_HINT:ATTACK] Creature will use MATERIAL_EMISSION when it's attacking, on creatures that it's attacking.
[CDI:BP_REQUIRED:BY_CATEGORY:HEAD] Creature must have at least one HEAD to use MATERIAL_EMISSION.
[CDI:FLOW:FIREBALL] The MATERIAL_EMISSION will shoot a fireball.
[CDI:TARGET:C:LINE_OF_SIGHT] The target for the emission--a location--must be within the line of sight of the Hydling.
[CDI:TARGET_RANGE:C:15] And must be, at most, 15 tiles away.
[CDI:MAX_TARGET_NUMBER:C:1] The hydling can only shoot at one target at a time...
[CDI:WAIT_PERIOD:30] and only every 30 ticks (3 tenths of a second at 100 FPS)

[ATTACK:BITE:CHILD_BODYPART_GROUP:BY_CATEGORY:HEAD:BY_CATEGORY:TOOTH] Defines a BITE attack that uses teeth.
[ATTACK_SKILL:BITE] Attack uses the BITE skill.
[ATTACK_VERB:nom:noms] "The Hydling noms the Elf in the left first toe, tearing the muscle!"
[ATTACK_CONTACT_PERC:100] Will use all of the tooth. Note that this can be more than 100.
[ATTACK_PENETRATION_PERC:100] Will sink the tooth all the way in. This can also be more than 100.
[ATTACK_FLAG_EDGE] Attack is an EDGE attack.
[ATTACK_PRIORITY:MAIN] Attack is of priority MAIN. Other option is SECOND.
[ATTACK_FLAG_CANLATCH] Attack can latch on.
[ATTACK_PREPARE_AND_RECOVER:3:3] Takes 3 ticks to wind up attack and 3 to recover from it.
[ATTACK_FLAG_INDEPENDENT_MULTIATTACK] Can use each head independently.

[ATTACK:SCRATCH:CHILD_TISSUE_LAYER_GROUP:BY_TYPE:STANCE:BY_CATEGORY:ALL:NAIL] As above, but for nail instead of teeth.
[ATTACK_SKILL:STANCE_STRIKE] Uses the kicking skill.
[ATTACK_VERB:slice:slices] "You slice the Elf in the left foot and the severed part sails off in an arc!"
[ATTACK_CONTACT_PERC:100] Uses the whole nail.
[ATTACK_PENETRATION_PERC:100] The whole nail goes in.
[ATTACK_FLAG_EDGE] Attack is an edge attack.
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK_PRIORITY:SECOND]

[CHILD:1] Hydling will become an adult at 1 year old.

[GENERAL_CHILD_NAME:hydie:hydies] Children will appear as "hydies".

[DIURNAL] Is active during the daytime.

[HOMEOTHERM:10070] Has a body temperature of 102 Fahrenheit.

[APPLY_CREATURE_VARIATION:STANDARD_QUADRUPED_GAITS:900:730:561:351:1900:2900] Can run at 25 kph
[APPLY_CREATURE_VARIATION:STANDARD_SWIMMING_GAITS:3512:2634:1756:878:4900:6900] Can swim at 10 kph
[APPLY_CREATURE_VARIATION:STANDARD_CRAWLING_GAITS:6561:6115:5683:1755:7456:8567] Can crawl at 5 kph
[SWIMS_INNATE]Swims innately.

[CASTE:FEMALE] Defines a caste called FEMALE.
[FEMALE] FEMALE caste is female.

[CASTE:MALE] As above, but with male.
[MALE] See above.
}}

== See also ==
{{catbox|DF2014:Modding}}

* [[Raw file]]
* [[Token]]
* [[Modding pitfalls]]
* [[Cheating]]
* Bay 12 Guide: https://bay12games.com/dwarves/modding_guide.html

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Mod

2023-01-28T03:59:49Z

Qeveren: /* Modding */ added main:Modding

{{For/see|information on making mods|[[Modding]]}}

A '''mod''' (short for modification) is an alteration of the game and the objective of modding. Modifications can range from small tweaks to complete overhauls.

== Downloading Mods ==

Mods can be acquired using the [https://steamcommunity.com/app/975370/workshop/ Steam Workshop] (if using the Steam version), a manual download from [[Bay 12 Forums]] or third party websites (like [https://dffd.bay12games.com/ DFFD]), or by [[Modding|creating]] one yourself.

Users of the Steam version can subscribe to mods on the Steam Workshop, once the download is complete they will be available when creating a new world automatically. Otherwise, manually download the mod, then place the mod zip file or the unzipped mod folder into the ''Dwarf Fortress'' [[mod folder]] (if this folder doesn't exist, you can create it.) You can have more than one mod in the mod folder, including different versions of the same mod. The game will detect all mods that are properly made in this folder and let the user select which mods to play (see below.)

== Enabling/Installing Mods ==
[[File:Ui-p-mod-selection.png|thumb|world generation mod menu]]

Mods are enabled per per world. When [[World generation|creating a world]] and choosing its initial parameters, if you have a mod available, there should be a '''Mods''' button at the bottom of the screen. Pressing this will let you select which mods you'd like to enable and what the load order should be. You should put mods at the end of the mod list after the vanilla objects if you don't have any further information, so that they can reference vanilla objects after those are loaded.

Some mods might depend on other mods which have to be loaded before, refer to the mod description for information about that.

<div class="" style="padding: 0.8em 1em; margin: 0.5rem 0; background: #fcf8e3; border-left: 5px solid #aa6708;">
* Mods are enabled per world, and cannot be disabled afterwards, however, it is possibly to manually modify the game file, as we did in previous versions, by applying the mods directly to <code>[[Game folder|<Dwarf Fortress>]]/data/vanilla</code>. Be ware this method has the disadvantage of being a permanent change for all worlds and may break your game.

* Unlike the previous versions of ''Dwarf Fortress'', mods no longer live inside [[save]] and must be installed on every computer where saves using those mods are going to be loaded. Once a world is created that uses mods, the game will copy the relevant mods to the <code>[[Game folder|<Dwarf Fortress>]]/data/installed_mods</code> folder. That is the version that the game actually uses. Installed mods will now show in the main menu->mods screen as 'installed'.
</div>

== Updating/missing Mods ==
[[File:mod_version_v50_prompt.png|thumb|possible update message]]
If a [[save]] is using a mod that's been updated, and is currently using an older version of that mod, the player will be prompted about this when a save is loading. When this happens, you have the choice of simply updating the mod, updating ''all'' mods at once, continuing to use the older version of the mod in question without updating, selecting the previous task but not updating ''any'' possibly outdated mods or simply returning to the title screen.

If a save is using a mod that is missing, the player will be prompted about this when a save is loading. When this happens, try to reinstall the mods. Either by manually downloading them again or in case of Steam Workshop making sure you are subscribed and if you do by unsubscribing and subscribing again.

== Modding ==
{{main|Modding}}

''Dwarf Fortress'' supports mods in the form of new objects and tiles. Each mod is a zip file or unzipped folder with the required format (see below.)

=== Mod Format===

Mods contain an [[info.txt file]] and either an "objects" folder or a "graphics" folder (or both.) All of the vanilla objects in the game use this format too. Your mod folder should look something like this:

[[File:Folder-orange.svg|20px|link=]] Mod Name
├ [[File:Text-x-generic.svg|20px|link=]] info.txt
├ [[File:Text-x-generic.svg|20px|link=]] preview.png
├ [[File:Folder.svg|20px|link=]] objects
└ [[File:Folder.svg|20px|link=]] graphics

=== Mod info ===
{{main|Mod info token}}

Each mod must have a <code>info.txt</code> at the root of your mod folder. It has a few fields defining basic metadata information about the mod and can be edited using any text editor (like notepad++). See Example:

{{code|
[ID:wiki_example]
[NAME:Wiki Example Mod]
[NUMERIC_VERSION:5001]
[DISPLAYED_VERSION:50.01]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01]
[AUTHOR:Dwarf Fortress Wiki]
[DESCRIPTION:This is an example mod. This text shows up in-game.]

[STEAM_TITLE:Wiki Example Mod]
[STEAM_DESCRIPTION:This text shows up on Steam Workshop.]
[STEAM_TAG:mod]
[STEAM_KEY_VALUE_TAG:test:stuff]
[STEAM_METADATA:metadata test]
[STEAM_CHANGELOG:Made some changes. Shown in 'Change Notes' tab.]

[STEAM_FILE_ID:#########]
}}

Only <code>ID</code> and <code>NAME</code> are required to appear in the in-game mod menu.

STEAM tags are only used by Steam.
* The <code>STEAM_FILE_ID</code> used to identify the mod in the Workshop. This is automatically managed when uploading to Steam the first time. And required if you wish to update an existing Steam Workshop mod.
* The <code>STEAM_TAG</code> and <code>STEAM_KEY_VALUE_TAG</code> are used by Steams search engine and the categorization. You can use as many entries you want, use a separate tag for each one.
* You can also create a thumbnail for your mod by creating an image called <code>preview.png</code> in the same level as your info.txt file. This image will become the thumbnail when the mod is uploaded to steam workshop. The image should be less than 1MB in size.

=== Objects and graphics folder ===

At the root of your mod folder you can have a <code>objects\</code> and <code>graphics\</code> folder, this is where all the [[raw file]]s or [[graphics]] goes (exactly the same as objects from previous versions of Dwarf Fortress) allowing you to tweak or add new content for the game. It's beyond the scope of this short guide to go into what specific tags do, but the vanilla objects and previous mods by members of the community will give you plenty of examples to work with. See: [[modding]].

The graphics filenames are not important, furthermore they can be arbitrarily nested into other sub-folders to help you organize your mod content.

== Publishing mods ==

There are two official platforms for publishing ''Dwarf Fortress'' mods, recommended because it's easy for people to find them there. These are [https://steamcommunity.com/app/975370/workshop/ Steam Workshop] and [https://dffd.bay12games.com/ the Dwarf Fortress File Depot (DFFD)].

=== Publishing on Steam Workshop ===

To upload a mod to Steam Workshop, you need to add STEAM tags to the <code>info.txt</code> file (see above.) Afterward, you put the unzipped mod folder in the "<code>mods/mod_upload</code>" folder. Then select Mods from the title menu, and upload your mods using the button you'll see there. Other Steam users will be able to subscribe to your mod immediately once it is uploaded.

Once the upload process is completed successfully, you'll find a <code>[STEAM_FILE_ID:#########]</code> appended to your info.txt. Make sure this entry is included for future uploads if you want to make changes to your mod and have it overwrite the existing entry on the workshop. Otherwise you'll create a new entry every time you upload.

=== Publishing on DFFD ===

In addition to Steam Workshop, it is recommended you upload your mod to DFFD. This allows people who play ''[[Classic|Dwarf Fortress Classic]]'', or ''[[Premium]]'' via Itch.io, to also download and play your mod. To publish/upload a file to DFFD you first need to create an account.

For legal reasons, mods that contain graphics derived from the ''Premium'' graphics should not be uploaded outside Steam Workshop. For this reason, you might want to separate your mod into two parts: the first without graphics, which is uploaded to both DFFD and Steam Workshop, and the second with ''only'' the graphics, uploaded only to Workshop. Of course, this is not an issue if your graphics are not based off the ''Premium'' ones.

[[Category:Modding]]

Mod

2023-01-28T03:58:22Z

Qeveren: Changed for/see template info

{{For/see|information on making mods|[[Modding]]}}

A '''mod''' (short for modification) is an alteration of the game and the objective of modding. Modifications can range from small tweaks to complete overhauls.

== Downloading Mods ==

Mods can be acquired using the [https://steamcommunity.com/app/975370/workshop/ Steam Workshop] (if using the Steam version), a manual download from [[Bay 12 Forums]] or third party websites (like [https://dffd.bay12games.com/ DFFD]), or by [[Modding|creating]] one yourself.

Users of the Steam version can subscribe to mods on the Steam Workshop, once the download is complete they will be available when creating a new world automatically. Otherwise, manually download the mod, then place the mod zip file or the unzipped mod folder into the ''Dwarf Fortress'' [[mod folder]] (if this folder doesn't exist, you can create it.) You can have more than one mod in the mod folder, including different versions of the same mod. The game will detect all mods that are properly made in this folder and let the user select which mods to play (see below.)

== Enabling/Installing Mods ==
[[File:Ui-p-mod-selection.png|thumb|world generation mod menu]]

Mods are enabled per per world. When [[World generation|creating a world]] and choosing its initial parameters, if you have a mod available, there should be a '''Mods''' button at the bottom of the screen. Pressing this will let you select which mods you'd like to enable and what the load order should be. You should put mods at the end of the mod list after the vanilla objects if you don't have any further information, so that they can reference vanilla objects after those are loaded.

Some mods might depend on other mods which have to be loaded before, refer to the mod description for information about that.

<div class="" style="padding: 0.8em 1em; margin: 0.5rem 0; background: #fcf8e3; border-left: 5px solid #aa6708;">
* Mods are enabled per world, and cannot be disabled afterwards, however, it is possibly to manually modify the game file, as we did in previous versions, by applying the mods directly to <code>[[Game folder|<Dwarf Fortress>]]/data/vanilla</code>. Be ware this method has the disadvantage of being a permanent change for all worlds and may break your game.

* Unlike the previous versions of ''Dwarf Fortress'', mods no longer live inside [[save]] and must be installed on every computer where saves using those mods are going to be loaded. Once a world is created that uses mods, the game will copy the relevant mods to the <code>[[Game folder|<Dwarf Fortress>]]/data/installed_mods</code> folder. That is the version that the game actually uses. Installed mods will now show in the main menu->mods screen as 'installed'.
</div>

== Updating/missing Mods ==
[[File:mod_version_v50_prompt.png|thumb|possible update message]]
If a [[save]] is using a mod that's been updated, and is currently using an older version of that mod, the player will be prompted about this when a save is loading. When this happens, you have the choice of simply updating the mod, updating ''all'' mods at once, continuing to use the older version of the mod in question without updating, selecting the previous task but not updating ''any'' possibly outdated mods or simply returning to the title screen.

If a save is using a mod that is missing, the player will be prompted about this when a save is loading. When this happens, try to reinstall the mods. Either by manually downloading them again or in case of Steam Workshop making sure you are subscribed and if you do by unsubscribing and subscribing again.

== Modding ==

''Dwarf Fortress'' supports mods in the form of new objects and tiles. Each mod is a zip file or unzipped folder with the required format (see below.)

=== Mod Format===

Mods contain an [[info.txt file]] and either an "objects" folder or a "graphics" folder (or both.) All of the vanilla objects in the game use this format too. Your mod folder should look something like this:

[[File:Folder-orange.svg|20px|link=]] Mod Name
├ [[File:Text-x-generic.svg|20px|link=]] info.txt
├ [[File:Text-x-generic.svg|20px|link=]] preview.png
├ [[File:Folder.svg|20px|link=]] objects
└ [[File:Folder.svg|20px|link=]] graphics

=== Mod info ===
{{main|Mod info token}}

Each mod must have a <code>info.txt</code> at the root of your mod folder. It has a few fields defining basic metadata information about the mod and can be edited using any text editor (like notepad++). See Example:

{{code|
[ID:wiki_example]
[NAME:Wiki Example Mod]
[NUMERIC_VERSION:5001]
[DISPLAYED_VERSION:50.01]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:5001]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:50.01]
[AUTHOR:Dwarf Fortress Wiki]
[DESCRIPTION:This is an example mod. This text shows up in-game.]

[STEAM_TITLE:Wiki Example Mod]
[STEAM_DESCRIPTION:This text shows up on Steam Workshop.]
[STEAM_TAG:mod]
[STEAM_KEY_VALUE_TAG:test:stuff]
[STEAM_METADATA:metadata test]
[STEAM_CHANGELOG:Made some changes. Shown in 'Change Notes' tab.]

[STEAM_FILE_ID:#########]
}}

Only <code>ID</code> and <code>NAME</code> are required to appear in the in-game mod menu.

STEAM tags are only used by Steam.
* The <code>STEAM_FILE_ID</code> used to identify the mod in the Workshop. This is automatically managed when uploading to Steam the first time. And required if you wish to update an existing Steam Workshop mod.
* The <code>STEAM_TAG</code> and <code>STEAM_KEY_VALUE_TAG</code> are used by Steams search engine and the categorization. You can use as many entries you want, use a separate tag for each one.
* You can also create a thumbnail for your mod by creating an image called <code>preview.png</code> in the same level as your info.txt file. This image will become the thumbnail when the mod is uploaded to steam workshop. The image should be less than 1MB in size.

=== Objects and graphics folder ===

At the root of your mod folder you can have a <code>objects\</code> and <code>graphics\</code> folder, this is where all the [[raw file]]s or [[graphics]] goes (exactly the same as objects from previous versions of Dwarf Fortress) allowing you to tweak or add new content for the game. It's beyond the scope of this short guide to go into what specific tags do, but the vanilla objects and previous mods by members of the community will give you plenty of examples to work with. See: [[modding]].

The graphics filenames are not important, furthermore they can be arbitrarily nested into other sub-folders to help you organize your mod content.

== Publishing mods ==

There are two official platforms for publishing ''Dwarf Fortress'' mods, recommended because it's easy for people to find them there. These are [https://steamcommunity.com/app/975370/workshop/ Steam Workshop] and [https://dffd.bay12games.com/ the Dwarf Fortress File Depot (DFFD)].

=== Publishing on Steam Workshop ===

To upload a mod to Steam Workshop, you need to add STEAM tags to the <code>info.txt</code> file (see above.) Afterward, you put the unzipped mod folder in the "<code>mods/mod_upload</code>" folder. Then select Mods from the title menu, and upload your mods using the button you'll see there. Other Steam users will be able to subscribe to your mod immediately once it is uploaded.

Once the upload process is completed successfully, you'll find a <code>[STEAM_FILE_ID:#########]</code> appended to your info.txt. Make sure this entry is included for future uploads if you want to make changes to your mod and have it overwrite the existing entry on the workshop. Otherwise you'll create a new entry every time you upload.

=== Publishing on DFFD ===

In addition to Steam Workshop, it is recommended you upload your mod to DFFD. This allows people who play ''[[Classic|Dwarf Fortress Classic]]'', or ''[[Premium]]'' via Itch.io, to also download and play your mod. To publish/upload a file to DFFD you first need to create an account.

For legal reasons, mods that contain graphics derived from the ''Premium'' graphics should not be uploaded outside Steam Workshop. For this reason, you might want to separate your mod into two parts: the first without graphics, which is uploaded to both DFFD and Steam Workshop, and the second with ''only'' the graphics, uploaded only to Workshop. Of course, this is not an issue if your graphics are not based off the ''Premium'' ones.

[[Category:Modding]]

Modding pitfalls

2023-01-28T03:35:11Z

Qeveren: Added inability of custom reactions to allow choosing armor size.

{{Quality|Tattered}}
{{av}}
{{For/see|a guide to getting started with modding|[[Modding]]}}
{{Modding}}
When making a mod, there's a ''lot'' of things that can go wrong. Here's a bunch of common pitfalls that people might fall into.

== Errorlog ==
The errorlog is in a file called "errorlog.txt", living in the same folder as Dwarf Fortress's executable. Check that before you read on; your problem may in fact be in there.

== My mod won't load ==
Make sure you have an info.txt file and that your mod is in the ''base'' of the mods folder, ''not in the mod_upload folder''. Dwarf Fortress doesn't read that folder for using mods, only to publish them to the steam workshop.

Make sure you have '''every [[Mod info token#Tokens|required token in your info.txt!]]'''

Also make sure that the mod has a NUMERIC_VERSION which is an integer, and greater than or equal to EARLIEST_COMPATIBLE_NUMERIC_VERSION. So this is acceptable:

{{code|
[NUMERIC_VERSION:1]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1]
}}
But this isn't:
{{code|
[NUMERIC_VERSION:1.05]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1.0]
}}
Nor is this:
{{code|
[NUMERIC_VERSION:1]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:5005]
}}

== My mod loads, but my creature/plant/entity won't ==
Make sure the file contains all of the following:

# A filename that refers to the type of objects contained therein. '''Creature files must start with creature_, entity files must start with entity_, and so on.'''
# The filename on the first line of the file.
# [OBJECT:type], where "type" is replaced with the relevant object type, [OBJECT:CREATURE] etc

If it does have all those, ask in one of the [[Modding#Resource Overview|many places there are where one may get help.]]

== Creatures ==

=== My civilization lives in "Nothing hamlets", "Nothing fortresses" or similar ===
You forgot to add a NAME. These use NAME rather than CASTE_NAME, so if you have a CASTE_NAME but no NAME, you'll see the individuals having a correct species name but their sites not having one.

== Reactions ==

=== My custom armor/clothing reaction won't let user choose size ===

Currently only the internal make armor/clothing tasks can set the product size via the Details screen; custom reactions cannot do this. If you want to be able to size things when ordering them to be made, they have to be included in the entity as [ARMOR], which will prevent you from limiting the material choices to anything other than cloth, leather, or weapon-grade metal.

Reaction

2023-01-28T03:27:55Z

Qeveren: /* item token */

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

'''Reactions''' are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded—building beds or creating glass, for example—but a few are freely editable, and it's (sometimes) quite simple to add additional ones. There is a separate page with custom [[reaction examples]].

== Reaction differences between modes ==
{{migrated section}}

In [[fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[entity token|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction — so that if you give your custom civilization a reaction to produce "star metal" or some other custom material, only they will be able to use it.

In [[adventure mode]], reactions are freely available in the {{k|x}} menu via the {{DFtext|create}} option, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. There are several bugs with adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

== Anatomy of a reaction ==

Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). All reaction files must begin with the file name, followed by the <code>[OBJECT:REACTION]</code> token that tells the game that the file contains reaction definitions.

The reactions themselves generally adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#adventure mode|adventure mode]]'': (optional) If present, the reaction can be used by the player in Adventure mode.

=== Reaction identifier ===
The REACTION token assigns a unique ID to your reaction.
[REACTION:<reaction identifier>]

The ''reaction identifier'' may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours. This is referenced in an entity definition via [[Entity_token#PERMITTED_REACTION|PERMITTED_REACTION]] to allow that entity to use the reaction.

=== Reaction name ===
The REACTION_NAME token assigns a descriptive name to your reaction in-game.
[REACTION_NAME:<name>]

==== name ====
This can be anything at all, and is how the reaction will appear in the job list of the building it is assigned to, and so should describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===
The BUILDING token assigns the reaction to a building. Adding multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings. Omitting the BUILDING token entirely will make the reaction unusable in Fortress mode (often used to restrict certain reactions to [[Reaction#Adventure_Mode_enabled|Adventure mode]]).

[BUILDING:<building name>:<building key>]
* [[#building name|''building name:'']] The ID of the building the reaction appears in.
* [[#building key|''building key:'']] The hotkey to queue up the reaction in the specified building.

==== building name ====
This is the ID of the building where the reaction will be carried out. Valid building names are as follows:

* ASHERY - [[Ashery]]
* BOWYER - [[Bowyer's workshop]]
* CARPENTER - [[Carpenter's workshop]]
* CLOTHES - [[Clothier's shop]]
* CRAFTSMAN - [[Craftsdwarf's workshop]]
* FARMER - [[Farmer's workshop]]
* GLASS - [[Glass furnace]]
* KILN - [[Kiln]] and [[Magma kiln]]
* KITCHEN - [[Kitchen]]
* LEATHER - [[Leather works]]
* MASON - [[Stoneworker's workshop]]
* METALSMITH - [[Metalsmith's forge]]
* MILLSTONE - [[Millstone]]
* QUERN - [[Quern]]
* SIEGE - [[Siege workshop]]
* SMELTER - [[Smelter]] and [[Magma smelter]]
* STILL - [[Still]]
* TANNER - [[Tanner's shop]]
* WOOD - [[Wood furnace]]
* Any custom (raw-defined) building, such as:
** SOAP_MAKER - [[Soap maker's workshop]]
** SCREW_PRESS - [[Screw press]]

==== building key ====
This defines the shortcut key(s) used to queue up the reaction in the workshop during gameplay in Classic mode only. It can be NONE for no shortcut, or take the format of CUSTOM_X, where X can be: any uppercase letter, which shows as a lowercase letter in the building UI, eg. "CUSTOM_A" creates the shortcut {{k|a}}; or a valid modifier key (ALT, CTRL, or SHIFT) followed by an uppercase letter, eg. CUSTOM_SHIFT_A.

=== Category ===

Categories are custom submenus for buildings' reaction menus. A reaction doesn't require a category, but if you have a lot of reactions, categories can be invaluable for organizing and presenting those reactions to players.

Categories can be nested indefinitely—you can have a category within a category within a category within a category within a category within... but as a practical matter, nesting categories more than 2 deep is not recommended.

Categories will be displayed in alphabetical order, first off the file name and then off the category name.

Categories currently have no effect on adventure mode reactions.

==== Defining a category ====

Each category needs to be defined within a reaction, usually one which should appear within its menu. Categories only need to be defined once.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| CATEGORY || style="vertical-align: top"| Category ID || The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.
|-
| style="vertical-align: top"| CATEGORY_NAME || style="vertical-align: top"| String || The name of the category as displayed in-game.
|-
| style="vertical-align: top"| CATEGORY_DESCRIPTION || style="vertical-align: top"| String || Optional. If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.
|-
| style="vertical-align: top"| CATEGORY_PARENT || style="vertical-align: top"| Category ID || Optional. If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.
|-
| style="vertical-align: top"| CATEGORY_KEY || style="vertical-align: top"| Hotkey token || Optional. If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey. Uses the same format as the BUILDING KEY described above.
|}

==== Adding reactions to an existing category ====

Just include the tag [CATEGORY:<category_id>] within your reaction definition, and if the category exists, your reaction will be added to its menu. You can only add reactions to custom categories.

Each reaction can belong to only one category.

=== Reagents ===

REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#Reagent name|name]]'': The name of the reagent, local to the reaction.
* ''[[#quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#item_token|item token]]'': The type (and subtype) of the item you require.
* ''[[#material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== name ====

The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reagents are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''', '''FLUX''', or '''seeds''' will also work equally well. The PRODUCT may make reference to this name – for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== quantity ====

How many or how much of this reagent the reaction requires. For most item types this is just the number of them required. However, some other item types─specifically bars, cloth, thread, globs, liquids, powder, and sheets of paper or parchment─instead use numbers representing the size of the material within one (or more) of these items. For example, while REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items, REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE is an extremely tiny portion of a random spool of thread. One can see which items have what size quantities in the description of the [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] token.

If one of the reagents is in a stack, or the reaction is only using a fraction of the amount of a sized item, the reaction will consume the entire stack, or as much of the sized item as possible, and multiply the product accordingly. This behaviour can be controlled using the [[Reaction#MAX_MULTIPLIER|MAX_MULTIPLIER]] token.

==== item token ====

[[Item token]]s are of the form ITEM_TYPE:ITEM_SUBTYPE.

The ITEM_TYPE is the category of item you require; WEAPON, TOY or SKIN_TANNED, for example.

The ITEM_SUBTYPE is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, have no subtype and only require the item token to be filled in; so if you're asking for those you should set the subtype to NONE. Subtypes are defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT])—they cannot be used in any other context.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens—this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

A note on armor/clothing sizes: hard-coded tasks to make clothing and armor will allow the player to select what size to make it (ie. what species it will fit) via the details screen. Custom reactions currently have no way to do this, and such items will be produced based on the size of the unit performing the reaction.

==== material token ====

[[Material token]]s come in several forms. For most reagents, this will typically be INORGANIC:MATERIAL_ID or NONE:NONE (to allow multiple materials using other modifier tokens).

Some reactions will allow the player to select specific materials after creating the job, by clicking on the magnifying glass icon next to the job in the workshop queue. To permit this behaviour in your reaction, the reagent materials must be specified as follows:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Item Type
! Material
! Notes
|-
| style="vertical-align: top"| BAR BLOCKS BOULDER ROUGH SMALLGEM || style="vertical-align: top"| INORGANIC:NONE || style="vertical-align: top"| These all appear as "stone" in the material selection menu, and list all inorganic materials regardless of any material modifier tokens, eg. [ITEMS_METAL]. BAR and BLOCKS made of organic materials, and BOULDER made of clay, are excluded.
|-
| style="vertical-align: top"| SKIN_TANNED or WOOD || style="vertical-align: top"| NONE:NONE ||
|-
| style="vertical-align: top"| Other Item Types || style="vertical-align: top"| NONE:NONE || style="vertical-align: top"| These will appear if a material modifier token other than [ANY_LEATHER_MATERIAL] is included.
|}

==== Modifiers ====

Reagents may also have extra tokens added on, following the REAGENT token, in order to modify their behaviour.

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material. Modifiers can then be used to restrict this to only certain broad classes of materials.

The following is a list of all known reagent modifiers:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.
|-
| style="vertical-align: top"| ANY_GEM_MATERIAL
|
| Reagent material must have the [IS_GEM] token.
|-
| style="vertical-align: top"| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.
|-
| style="vertical-align: top"| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.
|-
| style="vertical-align: top"| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.
|-
| style="vertical-align: top"| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.
|-
| style="vertical-align: top"| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.
|-
| style="vertical-align: top"| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.
|-
| style="vertical-align: top"| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.
|-
| style="vertical-align: top"| ANY_STONE_MATERIAL
|
| Reagent material must have the [IS_STONE] token.
|-
| style="vertical-align: top"| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having TISSUE_SHAPE:STRANDS, intended for matching hair and wool. Must be used with USE_BODY_COMPONENT.
|-
| style="vertical-align: top"| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.
|-
| style="vertical-align: top"| ANY_WOOD_MATERIAL
|
| Reagent material must have the [WOOD] token.
|-
| style="vertical-align: top"| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.
|-
| style="vertical-align: top"| BUILDMAT
|
| Reagent must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| style="vertical-align: top"| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| style="vertical-align: top"| CONTAINS
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| Reagent is a container that holds the specified reagent (where ''Reagent name'' is the locally-defined name of the reagent).
|-
| style="vertical-align: top"| CONTAINS_LYE
|
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| style="vertical-align: top"| DOES_NOT_ABSORB
|
| Reagent material must have ABSORPTION:0
|-
| style="vertical-align: top"| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that [[stack]]s of reagents will correctly produce additional outputs.
|-
| style="vertical-align: top"| EMPTY
|
| If the reagent is a container, it must be empty.
|-
| style="vertical-align: top"| FIRE_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| FOOD_STORAGE_CONTAINER
|
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| style="vertical-align: top"| GLASS_MATERIAL
|
| Reagent material must have the IS_GLASS token. All 3 types of [[glass]] have this token hardcoded.
|-
| style="vertical-align: top"| HARD_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_HARD] token.
|-
| style="vertical-align: top"| HAS_EDGE
|
| Reagent must have an edge.
|-
| style="vertical-align: top"| HAS_ITEM_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the item reaction product specified by PRODUCT_ID - [[Reaction#Item_reaction_products|see below]] for more details. This can be used interchangeably with HAS_MATERIAL_REACTION_PRODUCT.
|-
| style="vertical-align: top"| HAS_MATERIAL_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the material reaction product specified by PRODUCT_ID - [[Reaction#Material_reaction_products|see below]] for more details.
|-
| style="vertical-align: top"| HAS_TOOL_USE
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE]] value
| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| style="vertical-align: top"| IS_CRAFTED_ARTIFACT{{verify}}
|
| Reagent item must be an artifact.
|-
| style="vertical-align: top"| IS_DIVINE_MATERIAL
|
| Reagent material must have the [DIVINE] token.
|-
| style="vertical-align: top"| IS_SAND_MATERIAL
|
| Reagent material must have the [SOIL_SAND] token.
|-
| style="vertical-align: top"| MAGMA_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| METAL_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_METAL] token.
|-
| style="vertical-align: top"| METAL_ORE
| style="vertical-align: top"|
* Metal ID
| Reagent material must be an ore of the specified metal.
|-
| style="vertical-align: top"| MIN_DIMENSION
| style="vertical-align: top"|
* Integer
| Reagent's item size must be at least as large as ''Integer''. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, or GLOB for this to work. See [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] below.
|-
| style="vertical-align: top"| NO_EDGE_ALLOWED
|
| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
|-
| style="vertical-align: top"| NOT_ARTIFACT{{verify}}
|
| Reagent item must not be an artifact.
|-
| style="vertical-align: top"| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
|-
| style="vertical-align: top"| NOT_ENGRAVED
|
| Reagent can not be engraved. For example, a memorial slab can not be engraved.
|-
| style="vertical-align: top"| NOT_IMPROVED
|
| Reagent has not been decorated.
|-
| style="vertical-align: top"| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| NOT_WEB
|
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| ON_GROUND
|
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from inventories (workshops, wagon) and causes infinite gathering for reactions in workshop.
|-
| style="vertical-align: top"| POTASHABLE (Deprecated)
|
| Alias for [CONTAINS_LYE].
|-
| style="vertical-align: top"| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| style="vertical-align: top"| REACTION_CLASS
| style="vertical-align: top"|
* CLASS_ID
| Reagent material must have the reaction class specified by CLASS_ID - [[Reaction#Reaction_classes|see below]] for more details.
|-
| style="vertical-align: top"| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| USE_BODY_COMPONENT
|
| Reagent must be a body part (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| style="vertical-align: top"| WEB_ONLY
|
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| WORTHLESS_STONE_ONLY
|
| Reagent material must be non-[[economic]].
|-
| style="vertical-align: top"| WOVEN_ITEM
|
| Reagent must be a clothing item made of a woven material, ie. plant, silk, or yarn cloth.
|}

=== Products ===

Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token [PRODUCT_DIMENSION:X] is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:''name''] token, where the ''name'' is the [[#Reagent name|name]] of a reagent. This requires the reagent to have the [PRESERVE_REAGENT] token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...]

==== probability ====

The percentage chance the product will be produced when the reaction is completed.

==== quantity ====

Determines how many of the product will be produced. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, PLANT_GROWTH, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can—for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

==== item token ====

The [[item token]] and subtype of the item you produce.

If your item has an [[Reaction#Item reaction products|item reaction product]] and you want the item type and material to be derived from one of the reagents, you can use GET_ITEM_DATA_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of both the item token ''and'' the material token (see next section). You can also specify GET_ITEM_DATA_FROM_REAGENT:reagent:NONE in order to make a direct copy of the source item, though this will not work for complex items such as corpses or prepared meals.

For products, this can also be set to CRAFTS:NONE to produce up to three random [[craft]] items. This value cannot be used in any other context.

==== material token ====

A [[material token]] describing what the product will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

==== Product modifiers ====

Zero or more tokens which further set the properties or disposition of the resulting product item.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.
|-
| style="vertical-align: top"| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.
|-
| style="vertical-align: top"| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| PRODUCT_DIMENSION
| style="vertical-align: top"|
* Integer
| Specifies the dimension of the product for those items that use dimensions. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.
|-
| style="vertical-align: top"| PRODUCT_TO_CONTAINER
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Places the product in a container; ''Name'' must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.
|-
| style="vertical-align: top"| PRODUCT_TOKEN
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Allows the product to be referred to by the given name for the purpose of being passed down as and argument in other tokens, in the same fashion as reagent names.
|-
| style="vertical-align: top"| TRANSFER_ARTIFACT_STATUS
|
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.
|}

=== Improvements ===

Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

==== probability ====

The percentage chance the improvement will be applied to the reagent when the reaction is completed.

==== reagent name ====

The [[#Reagent name|name]] of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

==== improvement type ====

The following improvement types can be used:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|-
| PAGES
| Adds pages to a [[book]].
|-
| SPECIFIC
| With subtype ROLLERS, adds rollers of <material> to a [[scroll]]; with subtype HANDLE, adds a handle of <material> to an item; with subtype TRACTION_BENCH_CHAIN or TRACTION_BENCH_ROPE adds a chain or rope of <material> to an item.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

==== material token ====

A [[material token]] describing what the decoration will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

=== Other tokens ===

==== fuel ====

The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== skill ====

The [[Skill token|skill tokens]] determine what skill the reaction requires and trains; also how quickly skill is gained, how quickly those skill gains raise attributes, and how skill level affects the quality of the reaction product.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| SKILL
| style="vertical-align: top"|
* [[Skill token]]
| (Optional) This identifies the skill required to carry out the reaction and is trained when the reaction is performed. Only one skill may be specified; if multiple skill tokens are defined only the last will be used. A reaction with no product will yield no experience gain. A reaction with no SKILL token will complete in a default amount of time.
|-
| style="vertical-align: top"| SKILL_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of skill gained each time the reaction is carried out. The default value is 30; higher values increase the amount of skill gain.
|-
| style="vertical-align: top"| ATTRIBUTE_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of [[Attribute|attribute]] gain that skill gain from this reaction results in. The default value is 10; higher values increase the amount of attribute gain.
|-
| style="vertical-align: top"| SKILL_ROLL_RANGE
| style="vertical-align: top"|
* Range
* Multiplier
| (Optional, requires SKILL token) This changes how much skill level affects the quality of the reaction product. The default is [SKILL_ROLL_RANGE:11:5]. The ''range'' is the base "die roll" and the ''multiplier'' determines how much the dwarf's skill can affect the reaction; the skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1), where random(x) gives a random number from 0 to x-1, inclusive (which also means that the minimum for the range is 1). The higher result on the roll, the better. Both numbers can be lowered to make the skill check harder. For example, with the default values a dwarf who is proficient in a skill has a skill level of 5; their roll will be random(11)+random(13)+random(13), meaning this dwarf can roll anywhere from 0 to 34; similarly, unskilled dwarves can roll 0 to 10 while legendary+0 (skill 15) dwarves can roll 0 to 84. If this is changed to [SKILL_ROLL_RANGE:1:8], then instead a proficient dwarf will have random(1)+random(21)+random(21), giving a roll of 0 to 40, with unskilled dwarves always rolling 0 and legendary dwarves going all the way up to 120.

As a consequence, increasing the multiplier will always make legendary dwarves more effective, even if base roll is reduced to its minimum of 1, with the default going up to 84 for default and 90 for [SKILL_ROLL_RANGE:1:6].
|}

==== automatic ====

The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== Adventure Mode enabled ====

The ADVENTURE_MODE_ENABLED token means that this version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage assuming the reaction also has a usable building assigned and is a {{token|PERMITTED_REACTION|entity}} within the entity file.

==== max multiplier ====

The [MAX_MULTIPLIER:<#>] token specifies how many times to do the reaction. This can be used to limit stacked reagent use to the specified quantity instead of the whole stack.

==== description ====

This feature is exclusive to Classic Mode, as no description window pops up when mousing over reactions in workshops in Premium.

The [DESCRIPTION:<string>] token provides a text description of the reaction when it is highlighted in the building UI. Multiple DESCRIPTION tokens can be defined in a reaction, and each will appear on a new line. The pop-up box that contains the description is limited to 325 characters total. Alternatively, this token can reference a DESCRIPTION token in an existing tool definition by replacing ''string'' with USE_TOOL:<ITEM_SUBTYPE>; or an existing instrument definition with USE_INSTRUMENT:<ITEM_SUBTYPE>.

== Reaction classes and products ==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

=== Reaction classes ===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there are a half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with six nearly identical reactions that all take in either dolomite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B asks for "NONE:NONE" as its material. This means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like calcite, here:

[INORGANIC:CALCITE]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:calcite][DISPLAY_COLOR:7:7:1][TILE:'"']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:LIMESTONE:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:MARBLE:CLUSTER_SMALL:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:12902]
[SOLID_DENSITY:2930]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction. Note that some reaction classes have special meanings to the game itself—notably, the [[site finder]] knows that "FLUX" should be connected to the "Flux stone" filter.

=== Material reaction products ===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:TAN_MAT]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:TAN_MAT''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the TAN_MAT reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, the spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named TAN_MAT) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the TAN_MAT hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). For example, skin taken from a butchered dog would be turned into dog leather. Change the SKIN_TEMPLATE MATERIAL_REACTION_PRODUCT to TAN_MAT:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

As with reaction classes, some MATERIAL_REACTION_PRODUCT identifiers have special meanings to the game itself - notably, the [[site finder]] knows that "FIRED_MAT" should be connected to the "Clay" filter, and "CHEESE_MAT" is used when making [[cheese]] from [[milk]].

=== Item reaction products ===

Item reaction products are an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA_FROM_REAGENT:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

Do note that MATERIAL_REACTION_PRODUCT and ITEM_REACTION_PRODUCT use the same IDs, so you cannot have both a material and item reaction product of the same name. Also, though you cannot use GET_ITEM_DATA_FROM_REAGENT with a MATERIAL_REACTION_PRODUCT (there'd be no item type information), you ''can'' use GET_MATERIAL_FROM_REAGENT on an ITEM_REACTION_PRODUCT (in case you want to force your own item type).

== Reactions and world generation ==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

== Full token list ==

For the sake of convenience and readability, this is a complete compilation of the previously listed reaction tokens in alphabetical order:

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

|-
| style="vertical-align: top"| {{text anchor|ADVENTURE_MODE_ENABLED}}
|
|
| style="vertical-align: top"| This version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage.

|-
| style="vertical-align: top"| {{text anchor|ANY_BONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [BONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_GEM_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_GEM] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_HORN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [HORN] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_LEATHER_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [LEATHER] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PEARL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [PEARL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PLANT_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be subordinate to a PLANT object.

|-
| style="vertical-align: top"| {{text anchor|ANY_SHELL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SHELL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SILK_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SILK] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SOAP_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SOAP] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_STONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STRAND_TISSUE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| style="vertical-align: top"| {{text anchor|ANY_TOOTH_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [TOOTH] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_WOOD_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [WOOD] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_YARN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [YARN] token.

|-
| style="vertical-align: top"| {{text anchor|ATTRIBUTE_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of attribute gain given per skill improvement. Default is 10.

|-
| style="vertical-align: top"| {{text anchor|AUTOMATIC}}
|
|
| style="vertical-align: top"| The reaction will be queued automatically if the reaction reagents are all present.

|-
| style="vertical-align: top"| {{text anchor|BAG}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead. Deprecated as of Version 0.50.01 in favor of BAG:NONE [[item token]].

|-
| style="vertical-align: top"| {{text anchor|BUILDING}}
| style="vertical-align: top"|
* [[#building name|Building name]]
* [[#building key|In-building reaction hotkey]]
|
| style="vertical-align: top"| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game.

|-
| style="vertical-align: top"| {{text anchor|BUILDMAT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is able to be used to build structures (Boulders, Wood, Blocks, Bars).

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_ARTIFACT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_HOSPITAL_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[healthcare|hospital]].

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_LOCATION_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[locations|location]].

|-
| style="vertical-align: top"| {{text anchor|CATEGORY}}
| style="vertical-align: top"|
* Category ID
|
| style="vertical-align: top"| Puts the reaction in a category. Categories are custom submenus for reaction menus. The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_NAME}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| The name of the category as displayed in-game.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_DESCRIPTION}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_PARENT}}
| style="vertical-align: top"|
* Category ID
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_KEY}}
| style="vertical-align: top"|
* Hotkey
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey while playing in Classic mode.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is a container that holds the specified reagent.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS_LYE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| style="vertical-align: top"| {{text anchor|DESCRIPTION}}
| style="vertical-align: top"|
* String
|
| style="vertical-align: top"| A description of the reaction that appears when it is highlighted in the building UI. ''String'' can also be replaced with a reference to existing DESCRIPTION tokens in tools (using USE_TOOL:<tool_id>) or musical instruments (using USE_TOOL:<instrument_id>).

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_ABSORB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have [ABSORPTION:0].

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_DETERMINE_PRODUCT_AMOUNT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| style="vertical-align: top"| {{text anchor|EMPTY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must be empty.

|-
| style="vertical-align: top"| {{text anchor|FIRE_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be considered [[fire-safe]] (stable [[temperature]] below {{ct|11000}}) - i.e. not wood, and not coal.

|-
| style="vertical-align: top"| {{text anchor|FORCE_EDGE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is given a sharp edge. Used for knapping.

|-
| style="vertical-align: top"| {{text anchor|FOOD_STORAGE_CONTAINER}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a barrel or any non-absorbing tool with [TOOL_USE:FOOD_STORAGE].

|-
| style="vertical-align: top"| {{text anchor|FUEL}}
|
|
| style="vertical-align: top"| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop.

|-
| style="vertical-align: top"| {{text anchor|GLASS_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material has [IS_GLASS].

|-
| style="vertical-align: top"| {{text anchor|HAS_EDGE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be sharpened (used for carving).

|-
| style="vertical-align: top"| {{text anchor|HAS_ITEM_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to HAS_MATERIAL_REACTION_PRODUCT, but requires the reagents material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| style="vertical-align: top"| {{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to REACTION_CLASS, but requires the reagents material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| style="vertical-align: top"| {{text anchor|HAS_TOOL_USE}}
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE value]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagents item type must be TOOL:NONE for this to make any sense.

|-
| style="vertical-align: top"| {{text anchor|HAS_WRITING_IMPROVEMENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must contain writing.

|-
| style="vertical-align: top"| {{text anchor|IMPROVEMENT}}
| style="vertical-align: top"|
* Probability
* [[#Reagent name|Reagent name]]
* Improvement type
* Material Token
|
| style="vertical-align: top"| Applies an improvement to the named reagent. Only meaningful if said reagent has [PRESERVE_REAGENT]. Improvement types include BANDS, COVERED, GLAZED, PAGES, RINGS_HANGING, and SPIKES

|-
| style="vertical-align: top"| {{text anchor|IS_CRAFTED_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must be an artifact.

|-
| style="vertical-align: top"| {{text anchor|IS_DIVINE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [DIVINE] token.

|-
| style="vertical-align: top"| {{text anchor|MAGMA_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Currently broken - Reagent must be considered [[magma-safe]] (stable [[temperature]] below {{ct|12000}}).

|-
| style="vertical-align: top"| {{text anchor|MAX_MULTIPLIER}}
| style="vertical-align: top"|
* Integer
|
| style="vertical-align: top"| Sets the maximum number of times a reaction is allowed to run when using stacked reagents. This can be used to ensure that the reaction doesn't repeat until the entire stack is depleted.

|-
| style="vertical-align: top"| {{text anchor|METAL_ORE}}
| style="vertical-align: top"|
* Inorganic material
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be an ore of the specified metal.

|-
| style="vertical-align: top"| {{text anchor|MIN_DIMENSION}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires that the reagent have a size of at least ''integer''. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, and GLOB items.

|-
| style="vertical-align: top"| {{text anchor|NAME}}
| style="vertical-align: top"|
* [[#name|Name]]
|
| style="vertical-align: top"| Defines the name used by the reaction in-game.

|-
| style="vertical-align: top"| {{text anchor|NO_EDGE_ALLOWED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.

|-
| style="vertical-align: top"| {{text anchor|NOT_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must not be an artifact.

|-
| style="vertical-align: top"| {{text anchor|NOT_CONTAIN_BARREL_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| style="vertical-align: top"| {{text anchor|NOT_ENGRAVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been engraved i.e. a blank memorial slab.
|-
| style="vertical-align: top"| {{text anchor|NOT_IMPROVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been decorated.

|-
| style="vertical-align: top"| {{text anchor|NOT_PRESSED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|NOT_WEB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| style="vertical-align: top"| {{text anchor|ON_GROUND}}
|
| style="vertical-align: top"| Reagent modifier
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from bins in stockpiles, nor inventories (workshops, wagon). Causes infinite collection of items if reaction is in workshop, as reagents are no longer on ground when brought to workshop. Untested in adventure mode; possibly more useful for adv. mode reactions.

|-
| style="vertical-align: top"| {{text anchor|POTASHABLE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Alias for [CONTAINS_LYE].

|-
| style="vertical-align: top"| {{text anchor|PRESERVE_REAGENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT}}
| style="vertical-align: top"|
*Probability of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
|
| style="vertical-align: top"| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA_FROM_REAGENT can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_DIMENSION}}
| style="vertical-align: top"|
* Size
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Specifies the amount of the product for those items that use dimension. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PASTE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PASTE state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PRESSED}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TO_CONTAINER}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Places the product in a container; reagent name must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TOKEN}}
| style="vertical-align: top"|
* Name
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Allows the product to be referred to by the given name, for the purpose of being passed down as argument in other tokens in the same fashion as reagent names.

|-
| style="vertical-align: top"| {{text anchor|REACTION}}
| style="vertical-align: top"|
* Identifier
|
| style="vertical-align: top"| Defines a new reaction.

|-
| style="vertical-align: top"| {{text anchor|REACTION_CLASS}}
| style="vertical-align: top"|
* CLASS_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
| style="vertical-align: top"| {{text anchor|REAGENT}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
* [[#quantity|Quantity]]
* [[Item token]]
* [[Material token]]
|
| style="vertical-align: top"| Specifies a given reagent as an input for a reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL}}
| style="vertical-align: top"|
* [[Skill token]]
|
| style="vertical-align: top"| Skill used by the reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of skill given per product made. Default is 30.

|-
| style="vertical-align: top"| {{text anchor|SKILL_ROLL_RANGE}}
| style="vertical-align: top"|
* Range
* Multiplier
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Determines how [[skill]] level affects [[quality]] of the reaction product. The skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1). random(x) returns a number between 0 and x-1, so range is always 1 or more. The default is 11. The default multiplier is 5. Higher skill rolls give better results.

|-
| style="vertical-align: top"| {{text anchor|TRANSFER_ARTIFACT_STATUS}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.

|-
| style="vertical-align: top"| {{text anchor|UNROTTEN}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be rotten, mainly for organic materials.

|-
| style="vertical-align: top"| {{text anchor|USE_BODY_COMPONENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must come off a creature's body.

|-
| style="vertical-align: top"| {{text anchor|WEB_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| style="vertical-align: top"| {{text anchor|WORTHLESS_STONE_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not made of an economic stone.

|-
| style="vertical-align: top"| {{text anchor|WOVEN_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be a woven material, eg. plant cloth, silk, yarn. This ''excludes'' CLOTH or THREAD items.

|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Reaction]]

Reaction

2023-01-28T03:26:57Z

Qeveren: /* item token */ Added note about armor size details being unavailable in custom reactions.

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

'''Reactions''' are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded—building beds or creating glass, for example—but a few are freely editable, and it's (sometimes) quite simple to add additional ones. There is a separate page with custom [[reaction examples]].

== Reaction differences between modes ==
{{migrated section}}

In [[fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[entity token|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction — so that if you give your custom civilization a reaction to produce "star metal" or some other custom material, only they will be able to use it.

In [[adventure mode]], reactions are freely available in the {{k|x}} menu via the {{DFtext|create}} option, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. There are several bugs with adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

== Anatomy of a reaction ==

Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). All reaction files must begin with the file name, followed by the <code>[OBJECT:REACTION]</code> token that tells the game that the file contains reaction definitions.

The reactions themselves generally adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#adventure mode|adventure mode]]'': (optional) If present, the reaction can be used by the player in Adventure mode.

=== Reaction identifier ===
The REACTION token assigns a unique ID to your reaction.
[REACTION:<reaction identifier>]

The ''reaction identifier'' may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours. This is referenced in an entity definition via [[Entity_token#PERMITTED_REACTION|PERMITTED_REACTION]] to allow that entity to use the reaction.

=== Reaction name ===
The REACTION_NAME token assigns a descriptive name to your reaction in-game.
[REACTION_NAME:<name>]

==== name ====
This can be anything at all, and is how the reaction will appear in the job list of the building it is assigned to, and so should describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===
The BUILDING token assigns the reaction to a building. Adding multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings. Omitting the BUILDING token entirely will make the reaction unusable in Fortress mode (often used to restrict certain reactions to [[Reaction#Adventure_Mode_enabled|Adventure mode]]).

[BUILDING:<building name>:<building key>]
* [[#building name|''building name:'']] The ID of the building the reaction appears in.
* [[#building key|''building key:'']] The hotkey to queue up the reaction in the specified building.

==== building name ====
This is the ID of the building where the reaction will be carried out. Valid building names are as follows:

* ASHERY - [[Ashery]]
* BOWYER - [[Bowyer's workshop]]
* CARPENTER - [[Carpenter's workshop]]
* CLOTHES - [[Clothier's shop]]
* CRAFTSMAN - [[Craftsdwarf's workshop]]
* FARMER - [[Farmer's workshop]]
* GLASS - [[Glass furnace]]
* KILN - [[Kiln]] and [[Magma kiln]]
* KITCHEN - [[Kitchen]]
* LEATHER - [[Leather works]]
* MASON - [[Stoneworker's workshop]]
* METALSMITH - [[Metalsmith's forge]]
* MILLSTONE - [[Millstone]]
* QUERN - [[Quern]]
* SIEGE - [[Siege workshop]]
* SMELTER - [[Smelter]] and [[Magma smelter]]
* STILL - [[Still]]
* TANNER - [[Tanner's shop]]
* WOOD - [[Wood furnace]]
* Any custom (raw-defined) building, such as:
** SOAP_MAKER - [[Soap maker's workshop]]
** SCREW_PRESS - [[Screw press]]

==== building key ====
This defines the shortcut key(s) used to queue up the reaction in the workshop during gameplay in Classic mode only. It can be NONE for no shortcut, or take the format of CUSTOM_X, where X can be: any uppercase letter, which shows as a lowercase letter in the building UI, eg. "CUSTOM_A" creates the shortcut {{k|a}}; or a valid modifier key (ALT, CTRL, or SHIFT) followed by an uppercase letter, eg. CUSTOM_SHIFT_A.

=== Category ===

Categories are custom submenus for buildings' reaction menus. A reaction doesn't require a category, but if you have a lot of reactions, categories can be invaluable for organizing and presenting those reactions to players.

Categories can be nested indefinitely—you can have a category within a category within a category within a category within a category within... but as a practical matter, nesting categories more than 2 deep is not recommended.

Categories will be displayed in alphabetical order, first off the file name and then off the category name.

Categories currently have no effect on adventure mode reactions.

==== Defining a category ====

Each category needs to be defined within a reaction, usually one which should appear within its menu. Categories only need to be defined once.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| CATEGORY || style="vertical-align: top"| Category ID || The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.
|-
| style="vertical-align: top"| CATEGORY_NAME || style="vertical-align: top"| String || The name of the category as displayed in-game.
|-
| style="vertical-align: top"| CATEGORY_DESCRIPTION || style="vertical-align: top"| String || Optional. If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.
|-
| style="vertical-align: top"| CATEGORY_PARENT || style="vertical-align: top"| Category ID || Optional. If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.
|-
| style="vertical-align: top"| CATEGORY_KEY || style="vertical-align: top"| Hotkey token || Optional. If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey. Uses the same format as the BUILDING KEY described above.
|}

==== Adding reactions to an existing category ====

Just include the tag [CATEGORY:<category_id>] within your reaction definition, and if the category exists, your reaction will be added to its menu. You can only add reactions to custom categories.

Each reaction can belong to only one category.

=== Reagents ===

REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#Reagent name|name]]'': The name of the reagent, local to the reaction.
* ''[[#quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#item_token|item token]]'': The type (and subtype) of the item you require.
* ''[[#material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== name ====

The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reagents are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''', '''FLUX''', or '''seeds''' will also work equally well. The PRODUCT may make reference to this name – for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== quantity ====

How many or how much of this reagent the reaction requires. For most item types this is just the number of them required. However, some other item types─specifically bars, cloth, thread, globs, liquids, powder, and sheets of paper or parchment─instead use numbers representing the size of the material within one (or more) of these items. For example, while REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items, REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE is an extremely tiny portion of a random spool of thread. One can see which items have what size quantities in the description of the [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] token.

If one of the reagents is in a stack, or the reaction is only using a fraction of the amount of a sized item, the reaction will consume the entire stack, or as much of the sized item as possible, and multiply the product accordingly. This behaviour can be controlled using the [[Reaction#MAX_MULTIPLIER|MAX_MULTIPLIER]] token.

==== item token ====

[[Item token]]s are of the form ITEM_TYPE:ITEM_SUBTYPE.

The ITEM_TYPE is the category of item you require; WEAPON, TOY or SKIN_TANNED, for example.

The ITEM_SUBTYPE is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, have no subtype and only require the item token to be filled in; so if you're asking for those you should set the subtype to NONE. Subtypes are defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT])—they cannot be used in any other context.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens—this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

A note on armor/clothing sizes: hard-coded tasks to make clothing and armor will allow the player to select what size to make it (ie. what species it will fit) via the details screen. Custom reactions currently have no way to do this.

==== material token ====

[[Material token]]s come in several forms. For most reagents, this will typically be INORGANIC:MATERIAL_ID or NONE:NONE (to allow multiple materials using other modifier tokens).

Some reactions will allow the player to select specific materials after creating the job, by clicking on the magnifying glass icon next to the job in the workshop queue. To permit this behaviour in your reaction, the reagent materials must be specified as follows:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Item Type
! Material
! Notes
|-
| style="vertical-align: top"| BAR BLOCKS BOULDER ROUGH SMALLGEM || style="vertical-align: top"| INORGANIC:NONE || style="vertical-align: top"| These all appear as "stone" in the material selection menu, and list all inorganic materials regardless of any material modifier tokens, eg. [ITEMS_METAL]. BAR and BLOCKS made of organic materials, and BOULDER made of clay, are excluded.
|-
| style="vertical-align: top"| SKIN_TANNED or WOOD || style="vertical-align: top"| NONE:NONE ||
|-
| style="vertical-align: top"| Other Item Types || style="vertical-align: top"| NONE:NONE || style="vertical-align: top"| These will appear if a material modifier token other than [ANY_LEATHER_MATERIAL] is included.
|}

==== Modifiers ====

Reagents may also have extra tokens added on, following the REAGENT token, in order to modify their behaviour.

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material. Modifiers can then be used to restrict this to only certain broad classes of materials.

The following is a list of all known reagent modifiers:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.
|-
| style="vertical-align: top"| ANY_GEM_MATERIAL
|
| Reagent material must have the [IS_GEM] token.
|-
| style="vertical-align: top"| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.
|-
| style="vertical-align: top"| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.
|-
| style="vertical-align: top"| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.
|-
| style="vertical-align: top"| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.
|-
| style="vertical-align: top"| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.
|-
| style="vertical-align: top"| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.
|-
| style="vertical-align: top"| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.
|-
| style="vertical-align: top"| ANY_STONE_MATERIAL
|
| Reagent material must have the [IS_STONE] token.
|-
| style="vertical-align: top"| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having TISSUE_SHAPE:STRANDS, intended for matching hair and wool. Must be used with USE_BODY_COMPONENT.
|-
| style="vertical-align: top"| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.
|-
| style="vertical-align: top"| ANY_WOOD_MATERIAL
|
| Reagent material must have the [WOOD] token.
|-
| style="vertical-align: top"| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.
|-
| style="vertical-align: top"| BUILDMAT
|
| Reagent must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| style="vertical-align: top"| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| style="vertical-align: top"| CONTAINS
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| Reagent is a container that holds the specified reagent (where ''Reagent name'' is the locally-defined name of the reagent).
|-
| style="vertical-align: top"| CONTAINS_LYE
|
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| style="vertical-align: top"| DOES_NOT_ABSORB
|
| Reagent material must have ABSORPTION:0
|-
| style="vertical-align: top"| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that [[stack]]s of reagents will correctly produce additional outputs.
|-
| style="vertical-align: top"| EMPTY
|
| If the reagent is a container, it must be empty.
|-
| style="vertical-align: top"| FIRE_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| FOOD_STORAGE_CONTAINER
|
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| style="vertical-align: top"| GLASS_MATERIAL
|
| Reagent material must have the IS_GLASS token. All 3 types of [[glass]] have this token hardcoded.
|-
| style="vertical-align: top"| HARD_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_HARD] token.
|-
| style="vertical-align: top"| HAS_EDGE
|
| Reagent must have an edge.
|-
| style="vertical-align: top"| HAS_ITEM_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the item reaction product specified by PRODUCT_ID - [[Reaction#Item_reaction_products|see below]] for more details. This can be used interchangeably with HAS_MATERIAL_REACTION_PRODUCT.
|-
| style="vertical-align: top"| HAS_MATERIAL_REACTION_PRODUCT
| style="vertical-align: top"|
* PRODUCT_ID
| Reagent material must have the material reaction product specified by PRODUCT_ID - [[Reaction#Material_reaction_products|see below]] for more details.
|-
| style="vertical-align: top"| HAS_TOOL_USE
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE]] value
| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| style="vertical-align: top"| IS_CRAFTED_ARTIFACT{{verify}}
|
| Reagent item must be an artifact.
|-
| style="vertical-align: top"| IS_DIVINE_MATERIAL
|
| Reagent material must have the [DIVINE] token.
|-
| style="vertical-align: top"| IS_SAND_MATERIAL
|
| Reagent material must have the [SOIL_SAND] token.
|-
| style="vertical-align: top"| MAGMA_BUILD_SAFE
|
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| style="vertical-align: top"| METAL_ITEM_MATERIAL
|
| Reagent material must have the [ITEMS_METAL] token.
|-
| style="vertical-align: top"| METAL_ORE
| style="vertical-align: top"|
* Metal ID
| Reagent material must be an ore of the specified metal.
|-
| style="vertical-align: top"| MIN_DIMENSION
| style="vertical-align: top"|
* Integer
| Reagent's item size must be at least as large as ''Integer''. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, or GLOB for this to work. See [[Reaction#PRODUCT_DIMENSION|PRODUCT_DIMENSION]] below.
|-
| style="vertical-align: top"| NO_EDGE_ALLOWED
|
| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
|-
| style="vertical-align: top"| NOT_ARTIFACT{{verify}}
|
| Reagent item must not be an artifact.
|-
| style="vertical-align: top"| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
|-
| style="vertical-align: top"| NOT_ENGRAVED
|
| Reagent can not be engraved. For example, a memorial slab can not be engraved.
|-
| style="vertical-align: top"| NOT_IMPROVED
|
| Reagent has not been decorated.
|-
| style="vertical-align: top"| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| NOT_WEB
|
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| ON_GROUND
|
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from inventories (workshops, wagon) and causes infinite gathering for reactions in workshop.
|-
| style="vertical-align: top"| POTASHABLE (Deprecated)
|
| Alias for [CONTAINS_LYE].
|-
| style="vertical-align: top"| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| style="vertical-align: top"| REACTION_CLASS
| style="vertical-align: top"|
* CLASS_ID
| Reagent material must have the reaction class specified by CLASS_ID - [[Reaction#Reaction_classes|see below]] for more details.
|-
| style="vertical-align: top"| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| USE_BODY_COMPONENT
|
| Reagent must be a body part (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| style="vertical-align: top"| WEB_ONLY
|
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| style="vertical-align: top"| WORTHLESS_STONE_ONLY
|
| Reagent material must be non-[[economic]].
|-
| style="vertical-align: top"| WOVEN_ITEM
|
| Reagent must be a clothing item made of a woven material, ie. plant, silk, or yarn cloth.
|}

=== Products ===

Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token [PRODUCT_DIMENSION:X] is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:''name''] token, where the ''name'' is the [[#Reagent name|name]] of a reagent. This requires the reagent to have the [PRESERVE_REAGENT] token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...]

==== probability ====

The percentage chance the product will be produced when the reaction is completed.

==== quantity ====

Determines how many of the product will be produced. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, PLANT_GROWTH, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can—for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

==== item token ====

The [[item token]] and subtype of the item you produce.

If your item has an [[Reaction#Item reaction products|item reaction product]] and you want the item type and material to be derived from one of the reagents, you can use GET_ITEM_DATA_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of both the item token ''and'' the material token (see next section). You can also specify GET_ITEM_DATA_FROM_REAGENT:reagent:NONE in order to make a direct copy of the source item, though this will not work for complex items such as corpses or prepared meals.

For products, this can also be set to CRAFTS:NONE to produce up to three random [[craft]] items. This value cannot be used in any other context.

==== material token ====

A [[material token]] describing what the product will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

==== Product modifiers ====

Zero or more tokens which further set the properties or disposition of the resulting product item.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.
|-
| style="vertical-align: top"| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.
|-
| style="vertical-align: top"| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.
|-
| style="vertical-align: top"| PRODUCT_DIMENSION
| style="vertical-align: top"|
* Integer
| Specifies the dimension of the product for those items that use dimensions. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.
|-
| style="vertical-align: top"| PRODUCT_TO_CONTAINER
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Places the product in a container; ''Name'' must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.
|-
| style="vertical-align: top"| PRODUCT_TOKEN
| style="vertical-align: top"|
* [[#Reagent name|Name]]
| Allows the product to be referred to by the given name for the purpose of being passed down as and argument in other tokens, in the same fashion as reagent names.
|-
| style="vertical-align: top"| TRANSFER_ARTIFACT_STATUS
|
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.
|}

=== Improvements ===

Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

==== probability ====

The percentage chance the improvement will be applied to the reagent when the reaction is completed.

==== reagent name ====

The [[#Reagent name|name]] of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

==== improvement type ====

The following improvement types can be used:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Description
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|-
| PAGES
| Adds pages to a [[book]].
|-
| SPECIFIC
| With subtype ROLLERS, adds rollers of <material> to a [[scroll]]; with subtype HANDLE, adds a handle of <material> to an item; with subtype TRACTION_BENCH_CHAIN or TRACTION_BENCH_ROPE adds a chain or rope of <material> to an item.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

==== material token ====

A [[material token]] describing what the decoration will be made of.

If you want the product's material to be derived from one of the reagents, and the reagent has a [[Reaction#Material_reaction_products|material reaction product]] defined, you can use GET_MATERIAL_FROM_REAGENT:reagent:REACTION_PRODUCT_ID in place of the material token. You can also specify GET_MATERIAL_FROM_REAGENT:reagent:NONE in order to directly use the reagent's own material.

=== Other tokens ===

==== fuel ====

The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== skill ====

The [[Skill token|skill tokens]] determine what skill the reaction requires and trains; also how quickly skill is gained, how quickly those skill gains raise attributes, and how skill level affects the quality of the reaction product.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description
|-
| style="vertical-align: top"| SKILL
| style="vertical-align: top"|
* [[Skill token]]
| (Optional) This identifies the skill required to carry out the reaction and is trained when the reaction is performed. Only one skill may be specified; if multiple skill tokens are defined only the last will be used. A reaction with no product will yield no experience gain. A reaction with no SKILL token will complete in a default amount of time.
|-
| style="vertical-align: top"| SKILL_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of skill gained each time the reaction is carried out. The default value is 30; higher values increase the amount of skill gain.
|-
| style="vertical-align: top"| ATTRIBUTE_IP
| style="vertical-align: top"|
* Integer
| (Optional, requires SKILL token) This adjusts the amount of [[Attribute|attribute]] gain that skill gain from this reaction results in. The default value is 10; higher values increase the amount of attribute gain.
|-
| style="vertical-align: top"| SKILL_ROLL_RANGE
| style="vertical-align: top"|
* Range
* Multiplier
| (Optional, requires SKILL token) This changes how much skill level affects the quality of the reaction product. The default is [SKILL_ROLL_RANGE:11:5]. The ''range'' is the base "die roll" and the ''multiplier'' determines how much the dwarf's skill can affect the reaction; the skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1), where random(x) gives a random number from 0 to x-1, inclusive (which also means that the minimum for the range is 1). The higher result on the roll, the better. Both numbers can be lowered to make the skill check harder. For example, with the default values a dwarf who is proficient in a skill has a skill level of 5; their roll will be random(11)+random(13)+random(13), meaning this dwarf can roll anywhere from 0 to 34; similarly, unskilled dwarves can roll 0 to 10 while legendary+0 (skill 15) dwarves can roll 0 to 84. If this is changed to [SKILL_ROLL_RANGE:1:8], then instead a proficient dwarf will have random(1)+random(21)+random(21), giving a roll of 0 to 40, with unskilled dwarves always rolling 0 and legendary dwarves going all the way up to 120.

As a consequence, increasing the multiplier will always make legendary dwarves more effective, even if base roll is reduced to its minimum of 1, with the default going up to 84 for default and 90 for [SKILL_ROLL_RANGE:1:6].
|}

==== automatic ====

The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== Adventure Mode enabled ====

The ADVENTURE_MODE_ENABLED token means that this version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage assuming the reaction also has a usable building assigned and is a {{token|PERMITTED_REACTION|entity}} within the entity file.

==== max multiplier ====

The [MAX_MULTIPLIER:<#>] token specifies how many times to do the reaction. This can be used to limit stacked reagent use to the specified quantity instead of the whole stack.

==== description ====

This feature is exclusive to Classic Mode, as no description window pops up when mousing over reactions in workshops in Premium.

The [DESCRIPTION:<string>] token provides a text description of the reaction when it is highlighted in the building UI. Multiple DESCRIPTION tokens can be defined in a reaction, and each will appear on a new line. The pop-up box that contains the description is limited to 325 characters total. Alternatively, this token can reference a DESCRIPTION token in an existing tool definition by replacing ''string'' with USE_TOOL:<ITEM_SUBTYPE>; or an existing instrument definition with USE_INSTRUMENT:<ITEM_SUBTYPE>.

== Reaction classes and products ==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

=== Reaction classes ===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there are a half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with six nearly identical reactions that all take in either dolomite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B asks for "NONE:NONE" as its material. This means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like calcite, here:

[INORGANIC:CALCITE]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:calcite][DISPLAY_COLOR:7:7:1][TILE:'"']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:LIMESTONE:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:MARBLE:CLUSTER_SMALL:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:12902]
[SOLID_DENSITY:2930]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction. Note that some reaction classes have special meanings to the game itself—notably, the [[site finder]] knows that "FLUX" should be connected to the "Flux stone" filter.

=== Material reaction products ===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:TAN_MAT]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:TAN_MAT''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the TAN_MAT reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, the spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named TAN_MAT) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the TAN_MAT hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). For example, skin taken from a butchered dog would be turned into dog leather. Change the SKIN_TEMPLATE MATERIAL_REACTION_PRODUCT to TAN_MAT:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

As with reaction classes, some MATERIAL_REACTION_PRODUCT identifiers have special meanings to the game itself - notably, the [[site finder]] knows that "FIRED_MAT" should be connected to the "Clay" filter, and "CHEESE_MAT" is used when making [[cheese]] from [[milk]].

=== Item reaction products ===

Item reaction products are an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA_FROM_REAGENT:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

Do note that MATERIAL_REACTION_PRODUCT and ITEM_REACTION_PRODUCT use the same IDs, so you cannot have both a material and item reaction product of the same name. Also, though you cannot use GET_ITEM_DATA_FROM_REAGENT with a MATERIAL_REACTION_PRODUCT (there'd be no item type information), you ''can'' use GET_MATERIAL_FROM_REAGENT on an ITEM_REACTION_PRODUCT (in case you want to force your own item type).

== Reactions and world generation ==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

== Full token list ==

For the sake of convenience and readability, this is a complete compilation of the previously listed reaction tokens in alphabetical order:

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

|-
| style="vertical-align: top"| {{text anchor|ADVENTURE_MODE_ENABLED}}
|
|
| style="vertical-align: top"| This version of the reaction can be used by the wanderers of Adventure Mode without needing to also give the dwarves at home in a fortress access to it. When using this token, it will be allowed for adventurers of any race, without editing entity files. This token does not prevent Fortress Mode usage.

|-
| style="vertical-align: top"| {{text anchor|ANY_BONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [BONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_GEM_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_GEM] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_HORN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [HORN] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_LEATHER_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [LEATHER] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PEARL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [PEARL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_PLANT_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be subordinate to a PLANT object.

|-
| style="vertical-align: top"| {{text anchor|ANY_SHELL_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SHELL] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SILK_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SILK] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_SOAP_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [SOAP] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STONE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [IS_STONE] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_STRAND_TISSUE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| style="vertical-align: top"| {{text anchor|ANY_TOOTH_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [TOOTH] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_WOOD_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [WOOD] token.

|-
| style="vertical-align: top"| {{text anchor|ANY_YARN_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [YARN] token.

|-
| style="vertical-align: top"| {{text anchor|ATTRIBUTE_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of attribute gain given per skill improvement. Default is 10.

|-
| style="vertical-align: top"| {{text anchor|AUTOMATIC}}
|
|
| style="vertical-align: top"| The reaction will be queued automatically if the reaction reagents are all present.

|-
| style="vertical-align: top"| {{text anchor|BAG}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead. Deprecated as of Version 0.50.01 in favor of BAG:NONE [[item token]].

|-
| style="vertical-align: top"| {{text anchor|BUILDING}}
| style="vertical-align: top"|
* [[#building name|Building name]]
* [[#building key|In-building reaction hotkey]]
|
| style="vertical-align: top"| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game.

|-
| style="vertical-align: top"| {{text anchor|BUILDMAT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is able to be used to build structures (Boulders, Wood, Blocks, Bars).

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_ARTIFACT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_HOSPITAL_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[healthcare|hospital]].

|-
| style="vertical-align: top"| {{text anchor|CAN_USE_LOCATION_RESERVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Allows the reagent to be an item that is otherwise reserved for use by a [[locations|location]].

|-
| style="vertical-align: top"| {{text anchor|CATEGORY}}
| style="vertical-align: top"|
* Category ID
|
| style="vertical-align: top"| Puts the reaction in a category. Categories are custom submenus for reaction menus. The category ID is a unique identifier for the category. It is only used in the raws, and will not appear in the game.

If you're defining multiple categories within the same reaction - for example, if you intend the reaction to be nested two deep, and haven't yet defined the super-category - the ''last'' CATEGORY token within the reaction definition is the one that the reaction will appear in.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_NAME}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| The name of the category as displayed in-game.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_DESCRIPTION}}
| style="vertical-align: top"|
* String
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, when the category is highlighted in a building menu, this string will be displayed in the Helpful Hint box.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_PARENT}}
| style="vertical-align: top"|
* Category ID
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category will be a submenu of the indicated category, rather than a submenu of the reaction's building.

|-
| style="vertical-align: top"| {{text anchor|CATEGORY_KEY}}
| style="vertical-align: top"|
* Hotkey
| style="vertical-align: top"| Category
| style="vertical-align: top"| If present, this category can be selected from its parent menu (whether a building or a parent category) using the given hotkey while playing in Classic mode.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is a container that holds the specified reagent.

|-
| style="vertical-align: top"| {{text anchor|CONTAINS_LYE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| style="vertical-align: top"| {{text anchor|DESCRIPTION}}
| style="vertical-align: top"|
* String
|
| style="vertical-align: top"| A description of the reaction that appears when it is highlighted in the building UI. ''String'' can also be replaced with a reference to existing DESCRIPTION tokens in tools (using USE_TOOL:<tool_id>) or musical instruments (using USE_TOOL:<instrument_id>).

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_ABSORB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have [ABSORPTION:0].

|-
| style="vertical-align: top"| {{text anchor|DOES_NOT_DETERMINE_PRODUCT_AMOUNT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| style="vertical-align: top"| {{text anchor|EMPTY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a container, it must be empty.

|-
| style="vertical-align: top"| {{text anchor|FIRE_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be considered [[fire-safe]] (stable [[temperature]] below {{ct|11000}}) - i.e. not wood, and not coal.

|-
| style="vertical-align: top"| {{text anchor|FORCE_EDGE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is given a sharp edge. Used for knapping.

|-
| style="vertical-align: top"| {{text anchor|FOOD_STORAGE_CONTAINER}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a barrel or any non-absorbing tool with [TOOL_USE:FOOD_STORAGE].

|-
| style="vertical-align: top"| {{text anchor|FUEL}}
|
|
| style="vertical-align: top"| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop.

|-
| style="vertical-align: top"| {{text anchor|GLASS_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material has [IS_GLASS].

|-
| style="vertical-align: top"| {{text anchor|HAS_EDGE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be sharpened (used for carving).

|-
| style="vertical-align: top"| {{text anchor|HAS_ITEM_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to HAS_MATERIAL_REACTION_PRODUCT, but requires the reagents material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| style="vertical-align: top"| {{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}
| style="vertical-align: top"|
* PRODUCT_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Similar to REACTION_CLASS, but requires the reagents material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| style="vertical-align: top"| {{text anchor|HAS_TOOL_USE}}
| style="vertical-align: top"|
* [[Tool token#TOOL_USE|TOOL_USE value]]
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be a [[tool]] with the specific TOOL_USE value. The reagents item type must be TOOL:NONE for this to make any sense.

|-
| style="vertical-align: top"| {{text anchor|HAS_WRITING_IMPROVEMENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must contain writing.

|-
| style="vertical-align: top"| {{text anchor|IMPROVEMENT}}
| style="vertical-align: top"|
* Probability
* [[#Reagent name|Reagent name]]
* Improvement type
* Material Token
|
| style="vertical-align: top"| Applies an improvement to the named reagent. Only meaningful if said reagent has [PRESERVE_REAGENT]. Improvement types include BANDS, COVERED, GLAZED, PAGES, RINGS_HANGING, and SPIKES

|-
| style="vertical-align: top"| {{text anchor|IS_CRAFTED_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must be an artifact.

|-
| style="vertical-align: top"| {{text anchor|IS_DIVINE_MATERIAL}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must have the [DIVINE] token.

|-
| style="vertical-align: top"| {{text anchor|MAGMA_BUILD_SAFE}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Currently broken - Reagent must be considered [[magma-safe]] (stable [[temperature]] below {{ct|12000}}).

|-
| style="vertical-align: top"| {{text anchor|MAX_MULTIPLIER}}
| style="vertical-align: top"|
* Integer
|
| style="vertical-align: top"| Sets the maximum number of times a reaction is allowed to run when using stacked reagents. This can be used to ensure that the reaction doesn't repeat until the entire stack is depleted.

|-
| style="vertical-align: top"| {{text anchor|METAL_ORE}}
| style="vertical-align: top"|
* Inorganic material
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be an ore of the specified metal.

|-
| style="vertical-align: top"| {{text anchor|MIN_DIMENSION}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires that the reagent have a size of at least ''integer''. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, CLOTH, and GLOB items.

|-
| style="vertical-align: top"| {{text anchor|NAME}}
| style="vertical-align: top"|
* [[#name|Name]]
|
| style="vertical-align: top"| Defines the name used by the reaction in-game.

|-
| style="vertical-align: top"| {{text anchor|NO_EDGE_ALLOWED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.

|-
| style="vertical-align: top"| {{text anchor|NOT_ARTIFACT}}{{verify}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent item must not be an artifact.

|-
| style="vertical-align: top"| {{text anchor|NOT_CONTAIN_BARREL_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| style="vertical-align: top"| {{text anchor|NOT_ENGRAVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been engraved i.e. a blank memorial slab.
|-
| style="vertical-align: top"| {{text anchor|NOT_IMPROVED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent has not been decorated.

|-
| style="vertical-align: top"| {{text anchor|NOT_PRESSED}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|NOT_WEB}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| style="vertical-align: top"| {{text anchor|ON_GROUND}}
|
| style="vertical-align: top"| Reagent modifier
| Reagent must be on the ground. Grabs from stockpiles. Does not grab from bins in stockpiles, nor inventories (workshops, wagon). Causes infinite collection of items if reaction is in workshop, as reagents are no longer on ground when brought to workshop. Untested in adventure mode; possibly more useful for adv. mode reactions.

|-
| style="vertical-align: top"| {{text anchor|POTASHABLE}} (Deprecated)
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Alias for [CONTAINS_LYE].

|-
| style="vertical-align: top"| {{text anchor|PRESERVE_REAGENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT}}
| style="vertical-align: top"|
*Probability of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
|
| style="vertical-align: top"| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA_FROM_REAGENT can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_DIMENSION}}
| style="vertical-align: top"|
* Size
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Specifies the amount of the product for those items that use dimension. For items of type BAR, DRINK, GLOB, LIQUID_MISC, and POWDER_MISC, one item is dimension 150; one item of CLOTH or SHEET is dimension 10000; and one item of THREAD is dimension 15000. Has no effect on any other item types. Note: this is not the actual [[storage]] volume of the product, which is hard-coded by the item token.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PASTE}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PASTE state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_PRESSED}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Product is created in the SOLID_PRESSED state.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TO_CONTAINER}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Places the product in a container; reagent name must be the name of a reagent with the [PRESERVE_REAGENT] token and a container item type.

|-
| style="vertical-align: top"| {{text anchor|PRODUCT_TOKEN}}
| style="vertical-align: top"|
* Name
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Allows the product to be referred to by the given name, for the purpose of being passed down as argument in other tokens in the same fashion as reagent names.

|-
| style="vertical-align: top"| {{text anchor|REACTION}}
| style="vertical-align: top"|
* Identifier
|
| style="vertical-align: top"| Defines a new reaction.

|-
| style="vertical-align: top"| {{text anchor|REACTION_CLASS}}
| style="vertical-align: top"|
* CLASS_ID (custom)
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
| style="vertical-align: top"| {{text anchor|REAGENT}}
| style="vertical-align: top"|
* [[#Reagent name|Reagent name]]
* [[#quantity|Quantity]]
* [[Item token]]
* [[Material token]]
|
| style="vertical-align: top"| Specifies a given reagent as an input for a reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL}}
| style="vertical-align: top"|
* [[Skill token]]
|
| style="vertical-align: top"| Skill used by the reaction.

|-
| style="vertical-align: top"| {{text anchor|SKILL_IP}}
| style="vertical-align: top"|
* Integer
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Amount of skill given per product made. Default is 30.

|-
| style="vertical-align: top"| {{text anchor|SKILL_ROLL_RANGE}}
| style="vertical-align: top"|
* Range
* Multiplier
| style="vertical-align: top"| Skill modifier
| style="vertical-align: top"| Determines how [[skill]] level affects [[quality]] of the reaction product. The skill roll is random(range) + random((skill level * multipler)/2 + 1) + random((skill level * multipler)/2 + 1). random(x) returns a number between 0 and x-1, so range is always 1 or more. The default is 11. The default multiplier is 5. Higher skill rolls give better results.

|-
| style="vertical-align: top"| {{text anchor|TRANSFER_ARTIFACT_STATUS}}
|
| style="vertical-align: top"| Product modifier
| style="vertical-align: top"| Transfers artifact status from the reagent to the product.

|-
| style="vertical-align: top"| {{text anchor|UNROTTEN}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must not be rotten, mainly for organic materials.

|-
| style="vertical-align: top"| {{text anchor|USE_BODY_COMPONENT}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must come off a creature's body.

|-
| style="vertical-align: top"| {{text anchor|WEB_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| style="vertical-align: top"| {{text anchor|WORTHLESS_STONE_ONLY}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent is not made of an economic stone.

|-
| style="vertical-align: top"| {{text anchor|WOVEN_ITEM}}
|
| style="vertical-align: top"| Reagent modifier
| style="vertical-align: top"| Reagent material must be a woven material, eg. plant cloth, silk, yarn. This ''excludes'' CLOTH or THREAD items.

|}

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Reaction]]