Dwarf Fortress Wiki - User contributions [en]

Creature token

2023-01-07T00:10:00Z

Bihlbo: /* C */

{{migrated article}}
{{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 also used with [[graphics token]] to make customizable [[graphics set]].

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.

|-
| {{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 details for the preceding {{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. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to 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 material.{{verify}}

|-
| {{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, occasionally producing twins or triplets with a 1/500 chance. 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 drop meat when [[butcher|butchered]].

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

|-
| {{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-07T00:09:01Z

Bihlbo: /* C */

{{migrated article}}
{{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 also used with [[graphics token]] to make customizable [[graphics set]].

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.

|-
| {{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 details for the preceding {{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. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to 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 this token 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 material.{{verify}}

|-
| {{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, occasionally producing twins or triplets with a 1/500 chance. 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 drop meat when [[butcher|butchered]].

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

|-
| {{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-03T22:02:31Z

Bihlbo: /* Selecting and Cutting */

{{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:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
}}

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.

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. Existing raws 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:DF2014: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]]
* [[Cheating]]

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Trap component

2023-01-03T03:38:30Z

Bihlbo: Values and menus have changed. Also cleaned up some wording.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
[[File:Trap, man (AM 1965.78.344-2).jpg|thumb|270px|right|A cruel trap made by a [[human]], for a human.]]Any [[weapon]] in [[fortress mode]] can be placed into a [[Trap#Weapon trap|weapon trap]]. However, there are five '''trap components''', or '''trap weapons''', that are ''specifically'' for weapon traps (and two also have additional uses). As with any weapon, a total of up to 10 of these can be put in a single weapon trap, creating a true "Indiana Jones" type of threat to beasts of any size, and potentially simply making a fine mince (or paste, depending on the weapons) of lesser creatures. However, trap components lack weapons' enhanced durability and can break after hitting only about 4 invaders (whereas a copper pick could hit thousands), with the exception of upright spike (which takes less than other components to zero wear, depending on material).

In the order they appear on the various menus, they are the '''enormous corkscrew''', the '''giant axe blade''', the '''large, serrated disc''', the '''menacing spike''', and the '''spiked ball'''.

All trap component weapons can be made out of [[metal]]s (by a [[weaponsmith]]) or [[glass]] (by a [[glassmaker]]), with appropriate damage. Three can also be made out of [[wood]] by a [[carpenter]] (as noted [[Trap_component#Data_ & comparison|below]]), which can be useful in getting some heavy weapons traps set up before you have a steady [[smelting]] operation going, or if you are short on metal. Each trap component takes one unit of the material that you are using (e.g. Each menacing iron spike will take one [[bar]] of [[iron]]). Note that although it is not possible to make giant axe blades or serrated disks out of wood, wooden ones can sometimes be bought from the embark screen. This is presumably a bug.

Trap weapons also provide the highest return of any weapon for [[melt]]ing, 120%–150%, compared to 90%–120% for conventional weapons, which can be [[exploit]]ed for generating metal and training [[weaponsmith]]s. Trap components are a separate sub-section of a [[forge]] menu (where metal [[mechanisms]] can also be found), but found within the menus for the various glass types in the [[glass furnace]], or in the main menu of the [[carpenter's workshop]].

==Trap Weapons==
===Menacing spike===

The '''menacing spike''' can be mounted in both traditional [[Trap#Weapon_trap|weapon traps]] and [[Trap#Upright_Spear/Spike|upright spike traps]], which act quite differently. Its small contact size and high penetration depth makes it a decent choice against enemies with impale-able internal organs.

Menacing spikes can also be made from [[wood]].

===Large, serrated disc===
'''Large, serrated discs''' deal large amounts of damage, and have a tendency to sever their victims' limbs. While amusing, this can create several [[hauling]] tasks for [[dwarves]] as they have to move each severed body part to a [[butcher's shop]] or [[stockpile|refuse pile]]. Large serrated discs attack three times, giving them a very high damage potential.

===Spiked ball===
The '''spiked ball''' doesn't deal a blunt attack at all, but it does do three attacks with its spikes. Like the menacing spike, it has only a small contact area, but has a very low penetration depth compared to the menacing spike.

Low penetration depth edged attacks can still break bones with impact damage, just like blunt attacks do. In addition, if an edged weapon is unable to cut the material of the target's armor, its attack is converted to blunt type. Because the small contact area concentrates the force, spiked balls should be more effective against targets in superior armor than either serrated discs or giant axes.

Spiked balls can also be made from [[wood]]. In previous versions, the high value of spiked balls made them a preferred trade item, but now they have a value no greater than small crafts.

===Enormous corkscrew===

'''Enormous corkscrews''' can be used as components in [[trap]]s as well as for [[screw pump]]s. As a result, the corkscrews from unneeded screw pumps can be used to make serviceable weapon traps.

The enormous corkscrew performs a deeply penetrating attack with a small contact area, much like the menacing spike. It is currently unknown which of these two trap components is the strongest overall.

Enormous corkscrews can also be made from [[wood]].

===Giant axe blade===

The '''giant axe blade''' is a very similar weapon to the large, serrated disc, but only strikes once, compared to the disc's three attacks. However, due to its larger size, its single attack is stronger than each of the large, serrated disc's. It is currently unknown which of these two trap components is the strongest overall.

However, if the variables behave like those of the wieldable weapons, size determines mass (along with material density) and mass determines impact (BLUNT) damage. An edged weapon, like the giant axe, only deals this type of damage when it is unable to penetrate armor, or if the target is large compared to its penetration depth.

This suggests that a steel serrated disc's multiple attacks will outweigh the giant axe blade's somewhat larger size in most cases. If only inferior materials are available, the giant axe '''might''' be better at hurting armored targets, but the disc's three attacks probably still outweigh this advantage.

==Data & comparison==

{|cellpadding="2" border="1" class="wikitable sortable" style="width:75%"
! Name !! Size !! Number of hits !! Contact Area !! Penetration Depth !! Wood? !! Base Value
|-
| Giant axe blade || 1600 || 1 || 100000 || 10000 || No || 10
|-
| Enormous corkscrew † || 1600 || 1 || 100 || 10000 || Yes || 10
|-
| Spiked ball || 1000 || 3 || 10 || 200 || Yes || 10
|-
| Large, serrated disc || 1000 || 3 || 100000 || 10000 || No || 10
|-
| Menacing spike ‡ || 1600 || 1 || 10 || 6000 || Yes || 10
|}
† ''This trap component can also be used in [[screw pump]]s.'' ‡ ''This trap component can also be used in [[Trap#Upright_Spear/Spike|upright spike traps]].''

:''(Most of this data has been compiled from raw/objects/item_trapcomp.txt)''

== Forging and Melting ==
=== Giant axe blades ===
* Metal giant axe blades cost '''one''' [[metal]] bar to [[forge]], or '''five''' [[adamantine]] wafers.
* When a non-adamantine metal giant axe blade is [[melt|melted down]], it will return '''1.5''' metal bars, for an '''efficiency of 150%'''.
* When an adamantine giant axe blade is melted down, it will produce '''1.5''' wafers, for an '''efficiency of 30%'''.

=== Enormous corkscrew ===
* Metal enormous corkscrews cost '''one''' [[metal]] bar to [[forge]], or '''five''' [[adamantine]] wafers.
* When a non-adamantine metal enormous corkscrews is [[melt|melted down]], it will return '''1.5''' metal bars, for an '''efficiency of 150%'''.
* When an adamantine enormous corkscrew is melted down, it will produce '''1.5''' wafers, for an '''efficiency of 30%'''.

=== Spiked ball ===
* Metal spiked balls cost '''one''' [[metal]] bar to [[forge]], or '''four''' [[adamantine]] wafers.
* When a non-adamantine metal spiked ball is [[melt|melted down]], it will return '''1.2''' metal bars, for an '''efficiency of 120%'''.
* When an adamantine spiked ball is melted down, it will produce '''1.2''' wafers, for an '''efficiency of 30%'''

=== Large, serrated disc ===
* Metal serrated discs cost '''one''' [[metal]] bar to [[forge]], or '''four''' [[adamantine]] wafers.
* When a non-adamantine metal serrated disc is [[melt|melted down]], it will return '''1.2''' metal bars, for an '''efficiency of 120%'''.
* When an adamantine serrated disc is melted down, it will produce '''1.2''' wafers, for an '''efficiency of 30%'''

=== Menacing spike ===
* Metal menacing spikes cost '''one''' [[metal]] bar to [[forge]], or '''five''' [[adamantine]] wafers.
* When a non-adamantine metal menacing spike is [[melt|melted down]], it will return '''1.5''' metal bars, for an '''efficiency of 150%'''.
* When an adamantine menacing spike is melted down, it will produce '''1.5''' wafers, for an '''efficiency of 30%'''.

==See also==
*[[Weapon]]
*[[Trap]]

{{Gamedata|{{raw|DF2012:item_trapcomp.txt|}}}}
{{Category|Weapons}}
{{Category|Traps}}
[[ru:Trap component]]

Token

2022-12-31T10:31:51Z

Bihlbo: The way it read before seemed like tokens could be modified. They are hard-coded, so it's worth making the distinction. Now it says raws can be modified.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{Modding}}
In ''Dwarf Fortress'', a '''token''' is a piece of text that defines the properties of an object. An "object" could be a material, a type of tissue, an organ, a piece of armor, a creature, a biome, a civilisation, or anything else in the game. A "property" could be how large something is, what it is made from, its melting temperature, its name, its biome preference (for civilisations) or anything else that makes it unique. All information associated with the properties of an object in the game is defined using tokens. Tokens are used in the [[raws]], which can be easily [[modding|modified]], allowing users to create (and distribute) new content.

:* [[Ammo token]]s define ammunition, such as arrows and bolts.
:* [[Armor token]]s define armor.
:* [[Biome token]]s define environments for creatures, plants and entities (entities being civilisations).
:* [[Building token]]s define buildings.
:* [[Body token]]s determine bodily structure and materials.
:* [[Body detail plan token]]s define some details of a body, similar to body tokens.
:* [[Bodygloss]] tokens perform a single-word substitution of a creature's body parts.
:* [[Creature token]]s determine the properties of creatures.
:* [[Creature variation token]]s are used to create creatures derived from other already-existing creatures, without duplicating every single token.
:* [[Descriptor color token]]s define colors used in text-based descriptions. Not to be confused with [[color scheme]]s.
:* [[Descriptor pattern token]]s define color patterns.
:* [[Descriptor shape token]]s define [[shape]]s.
:* [[Entity token]]s define entities, or [[civilization]]s.
:* [[Graphics token]] define tile-based [[graphics]].
:* [[Item token]]s define the most basic form of items (made specific by material tokens). Item tokens are mainly used in [[reactions]].
:* [[Item definition token]]s are used for actual definitions of items.
:* [[Instrument token]]s define instruments.
:* [[Interaction token]]s define interactions.
:* [[Labor token]]s define labors.
:* [[Language token]]s define a language's vocabulary. Since fictional languages in ''Dwarf Fortress'' are currently only used in names, language tokens do not define grammar.
:* [[Material token]]s are used to refer to materials, similar to item tokens.
:* [[Material definition token]]s are used to define materials, similar to item definition tokens.
:* [[Inorganic material definition token]]s are used to define inorganic materials, similar to material definition tokens.
:* [[Plant token]]s define plants.
:* [[Position token]]s define positions in entities.
:* [[Skill token]]s reference skills.
:* [[Syndrome token]]s define syndromes.
:* [[Tissue definition token]]s define tissues.
:* [[Tool token]]s define tools, similar to weapon tokens.
:* [[Trap component token]]s define traps.
:* [[Unit type token]]s are referred to by tilesets and entities, for purposes of nobility and the like.
:* [[Weapon token]]s define weapons.
:* [[World token]]s are used in custom world generation.
:* [[Music token]]s These are the triggers for the default music effects.
:* [[Sound token]]s These are the triggers for the default sound effects.

Also note [[reactions]], which are a little more complicated than simple tokens.

== See also ==
{{catbox|DF2014:Tokens}}

* [[Raw file]]
* [[Modding]]
* [[Dipscript]]
* [[Speech file]]

[[category:Modding]]
[[ru:Token]]

Modding

2022-12-31T10:12:49Z

Bihlbo: /* Modifying the vanilla objects */ Better to introduce the tools being used in the example before the example is given, so the example exemplifies something.

{{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:
* [[#Guide|Modding Guide]]
* [[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.

; [[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; 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:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
}}

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.

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

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.

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

Existing raws can be altered with the use of SELECT. Existing raws 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:DF2014: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, ten eyes, ten ears, five noses, two lungs, a heart, guts, a pancreas etc., and 5 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]]
* [[Cheating]]

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Modding

2022-12-31T10:09:39Z

Bihlbo: /* Modifying the vanilla objects */ Gave CUT and SELECT a full description, explaining use. Not sure if these are actually "functions" but that's what was being used already so I went with it.

{{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:
* [[#Guide|Modding Guide]]
* [[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.

; [[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. If you wanted to mod beards into dwarven women while also removing elephants from the game, for example:

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

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; 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:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
}}

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.

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

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.

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

Existing raws can be altered with the use of SELECT. Existing raws 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:DF2014: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, ten eyes, ten ears, five noses, two lungs, a heart, guts, a pancreas etc., and 5 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]]
* [[Cheating]]

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Modding

2022-12-31T09:39:58Z

Bihlbo: /* Basics of DF modding */ Changed word order to make the sentence easier to understand.

{{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:
* [[#Guide|Modding Guide]]
* [[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.

; [[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. If you wanted to mod beards into dwarven women while also removing elephants from the game, for example:

{{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]
}}
You can both SELECT and CUT for all of the following types of objects:

CREATURE, ENTITY, INTERACTION, ITEM, WORD, TRANSLATION, SYMBOL, INORGANIC, PLANT, MUSIC, REACTION, SOUND

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; 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:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
}}

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.

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

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.

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

Existing raws can be altered with the use of SELECT. Existing raws 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:DF2014: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, ten eyes, ten ears, five noses, two lungs, a heart, guts, a pancreas etc., and 5 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]]
* [[Cheating]]

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Modding

2022-12-31T08:43:41Z

Bihlbo: I did some guesswork and testing to find out how LOG_CURRENT_ENTRY works, since "one can use" tells you nothing. Hopefully this is right.

{{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:
* [[#Guide|Modding Guide]]
* [[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.

; [[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, all you need to include to ensure proper references are maintained is the token identifiers. 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. If you wanted to mod beards into dwarven women while also removing elephants from the game, for example:

{{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]
}}
You can both SELECT and CUT for all of the following types of objects:

CREATURE, ENTITY, INTERACTION, ITEM, WORD, TRANSLATION, SYMBOL, INORGANIC, PLANT, MUSIC, REACTION, SOUND

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; 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:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
}}

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.

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

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.

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

Existing raws can be altered with the use of SELECT. Existing raws 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:DF2014: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, ten eyes, ten ears, five noses, two lungs, a heart, guts, a pancreas etc., and 5 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]]
* [[Cheating]]

{{Category|Modding}}
{{Category|Guides}}
[[ru:Modding]]

Kitchen

2022-12-30T01:22:15Z

Bihlbo: /* Bugs */ After testing, waiting on dwarves to move food out of the kitchen is slow. Dumping is faster, so I mentioned it.

{{migrated article}}
{{Quality|Unrated}}
{{Workshop
|name=Kitchen
|key=z
|construction_job=
*[[Cooking]]
|construction=
* [[Building material]] (non-[[economic]])
|job=
*[[Cooking]]
|use=
* [[Alcohol]]
* [[Cheese]]
* [[Dwarven sugar]]
* [[Dwarven syrup]]
* [[Egg]]
* [[Fat]]
* [[Fish]]
* [[Flour]]
* [[Food]]
* [[Honey]]
* [[Meat]]
* [[Milk]]
* [[Plants]]
* [[Prepared organs]]
* [[Seed]]s
* [[Tallow]]
|production =
*[[Food|Prepared meals]]
*[[Tallow]]
}}{{av}}

A '''kitchen''' is operated by a dwarf with the [[Cook|cooking]] [[labor]] enabled. It is used to cook prepared meals and render fat from [[Butcher's shop|butchered]] animals into [[tallow]]. Cooking meals applies a [[quality]] modifier to each ingredient, which drastically increases the [[food]]'s value (up to 100×). Cooked meals count as each of their ingredients for the purpose of satisfying your dwarves' [[preference]]s, increasing the likelihood of happy [[thought]]s while eating. Finally, cooking spoilable foods such as [[meat]], [[fish]], and [[plants]] will deter [[rot]], but any [[seed]]s from cooked [[plant]]s are lost.

==Types of meals==
There are three different types of food to be cooked:
*An '''Easy meal''' uses two ingredients and will result in '''biscuits'''.
*A '''Fine meal''' uses three ingredients and will result in '''stews'''.
*A '''Lavish meal''' uses four ingredients and will result in '''roasts'''.

Lavish meals result in larger stacks of higher-value food. They take a bit longer to produce and result in less experience gained for your cook per ingredient. With a greater variety of materials in the prepared meal, there is a higher probability a dwarf will get something they [[Preferences|like]], giving the eater a happy [[thought]].

Easy meals will give more experience per ingredient and result in twice as much hauling ''after'' cooking.

==Using liquid ingredients==
At least one stack going into a prepared meal must be a solid item - if you have only [[Alcohol|booze]], [[milk]], and [[Dwarven syrup|syrup]], your cooking jobs will get canceled. However, a single [[plump helmet]] can be cooked with ten dwarven wine, ten dwarven milk, and ten dwarven syrup, to make 31 +Plump Helmet Roast+ without issue.

==What to cook==
You may want to adjust what your dwarves are allowed to cook. For example, your dwarves may happily cook away all the [[seed]]s you need for planting, or use all your [[drink|booze]] as ingredients, a good way to create [[fun]] in the early stages of the fortress. Additionally, cooks seem to prefer some of the worst ingredients (single units of low-value materials like [[tallow]]). To suppress the cooking of certain items (such as booze, seeds or tallow) go to the labor menu ({{k|y}} key) and then go to the ''Kitchen'' subtab. Every cookable and/or brewable item in your fortress will be listed. Once you allow or forbid the cooking or brewing of some kind of product, it will be used (or not) accordingly. Note that any cooking jobs in progress will be canceled if you disallow one of the cook's chosen ingredients.

Cooking with alcohol usually results in large stacks of prepared meals, because alcohol typically has large stack sizes. It is assumed that since all dwarves have a [[preference]] for at least one type of alcohol, cooking with alcohol improves the chance of happy [[thought]]s from eating. Of course, you then need to ensure that you have enough alcohol left for your dwarves to drink; cooked alcohol does not count as drink.

One (relatively safe) method to include a limited amount of alcohol in your meals is to create a small (one-or-two tile) food [[stockpile]] next to your kitchen that only allows types of alcohol that your fortress has in large quantity, and set it to "take" from your larger drink stockpile and "give" to your kitchen(s). You can then use work orders to limit the number of prepared meals that will be created to ensure this stock is not itself rapidly drained by experienced cooks.

Ideally, you want to combine four different ingredients in each meal to maximize the chance of a dwarf experiencing a happy [[thought]] due to a [[preference]]. Unfortunately, when left up to your cook, you'll likely end up with an endless string of [[tallow]] roasts. To enforce variety, you can create a series of single-tile, barrel-less "feeder" [[stockpile]]s, each of which allows a different type of (cookable) food, all set to "give" to your kitchen.

==Storage==
Individual types of prepared meals are not listed in the middle column or right column of the stockpile menu for the Food category. The switch for allowing or banning prepared meals in a [[stockpile]] is displayed underneath the right column and toggled by pressing the {{k|u}} key.

The size of a prepared food stack varies according to the sum of all ingredient stacks; with large input stacks your kitchen will create a stack of prepared meals that is too big to fit into a [[barrel]] or [[pot]] (capacity 60). If you want to designate a stockpile as the destination for your kitchen's output, be sure that the number of barrels allowed in the stockpile is lower than the number of squares in the stockpile. That way there will be a few non-barrel squares for your haulers to deposit overly large stacks of prepared meals. Given that food left in the open will attract [[Fly|flies]], causing unhappiness in dwarves who encounter them, it may be best to store prepared meals in an area of less traffic than the rest of a food stockpile. You can also "break" large stacks into smaller stacks (for a fee) by trading them to a [[caravan]] and then purchasing them back in smaller stacks.

Be aware that food that is not properly stored in a stockpile rots quite fast. Rotting is the worst possible fate for a masterfully prepared meal. The chef would have every right to be angry about it, since all of his effort spent preparing the meal literally went to waste. Prepared meals can also trigger masterwork destruction if they are eaten by vermin.

==Trade==

Prepared meals are excellent for [[trade]] since they are high-value, renewable/sustainable, easily transported, and easily sub-divided. A high-quality prepared meal stack can surpass all but [[artifact]], [[adamantine]], and heavily [[decoration|decorated]] items in total value.

Even a novice cook will greatly increase the value of raw ingredients. For example, cooking 10 plump helmets (total value 40) in a "Lavish Meal" will produce a stack of plump helmet roast with minimum value of 260. A modest cooking skill can easily double that value, while a legendary cook is theoretically capable of producing a total value of 3120, a 78x increase over the raw ingredients.

Because of the way meal value is calculated, cooking large stacks of common ingredients with small stacks of high-value ingredients results in a large stack of high-value meals. As an example, cooking three single unit stacks of [[whip vine]] [[flour]] with a stack of 7 plump helmets yields a theoretical maximum value of 10,680 from a raw ingredient value of 103.

The quality symbols shown in the name of a meal reflect the highest quality involved in its making, looking at the overall preparation as well as the mincing of each ingredient. With up to five jobs involved, monetary values of apparently same-quality meals can vary a lot, and a lower-quality meal can be more valuable than a higher-quality meal cooked from the same ingredients.
[[File:kitchen_preview.jpg|thumb|400px|center|A not-so-modern kitchen.]]

== Bugs ==

Cooks will only cook fluid ingredients as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}}

To force the kitchen to cook with fluids like [[alcohol|booze]], [[milk]], [[oil]], or [[dwarven syrup]], you can limit the possible ingredients used for cooking through [[stockpile]] linkage. If a [[kitchen]] is set to accept ingredients from a stockpile, it will not use any other ingredients unless they are already stored in the kitchen (which may be encountered if no one has yet hauled some recently-rendered [[tallow]]). Set up a tiny stockpile to only hold solid food ingredients, but no [[barrel|barrels]]. The size of this stockpile will determine how many solid ingredients the kitchen can easily use, so if it is 1x1, the cook will use just one solid ingredient before looking elsewhere. A speedy hauler might get another item into that space before the cook stops looking for ingredients, but this is uncommon. Set up another stockpile to hold the fluid ingredients. Set both of these stockpiles to give items to the kitchen. If there's nothing else left in the tiny stockpile when the cook is looking for ingredients, then the only other ingredients which can be used will be the fluid ingredients, and so they will be used even though they are not preferred by the cook.

Of course, the tiny solid ingredient stockpile will need to be refilled, so you will also need a larger stockpile that links to the tiny one. Unfortunately, once ingredients are in barrels, they will never be taken out of the barrels to be moved to the tiny stockpile, so the larger stockpile will also have to be limited to not use barrels. One way to get ingredients out of barrels is to set a barrel-using food stockpile to only accept from linked stockpiles, set the stockpile to give to the kitchen but not to take from anything, and queue up a lavish meal. Watch the kitchen, and once ingredients have been delivered so work can begin, cancel or pause the work. They will then need to empty the kitchen, and since your barrel-using stockpile is set to not accept from the kitchen, only your barrel-free stockpiles will be available. It might be quicker and less frustrating to [[Exploit#Quantum_stockpiles|dump]] ingredients from barrels into a barrel-free stockpile instead.

{{Workshops}}
{{Category|Food}}

Royal jelly

2022-12-30T01:19:13Z

Bihlbo: /* Bugs */ Added a minor note about cooking with jelly, linking to a larger note and instruction on the kitchen page.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
'''Royal jelly''' is a product of the [[beekeeping industry]] collected from an artificial bee [[hive]]. Royal jelly is stored in [[jug]]s, and can only be used as a liquid ingredient in [[prepared meal]]s. Due to a bug, dwarves may store royal jelly jugs as finished goods; combined with a [[cook]]'s aversion to liquid ingredients, it is very rare to see royal jelly cooked at all. That isn't necessarily a bad thing, though, since royal jelly is only available in single-unit stacks and has the same base value as most other foods.

The contents of a [[hive]] with a colony of [[honey bee]]s that is toggled to "gather any products" will be harvested as part of the [[beekeeping industry]]. In order to collect the royal jelly, you must have a dwarf with the [[beekeeper|beekeeping]] labor active and empty [[jug]]s. A [[honeycomb]] will also be produced.

Royal jelly and [[honey]] are the edible products of bees. In real life, it is used as a nutritional substance for larvae.

[[File:Bienenwabe mit Eiern und Brut 5 larva.png|thumb|310px|center|Nutrition for larvae.]]

==Bugs==
*Jugs of royal jelly may be stored in bins as finished goods, preventing its use in the food industry.
*Collecting royal jelly may require more than 1 jug in storage to begin.
* Cooks will only cook jelly and other fluids as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}} For more information, see the [[Kitchen#Bugs|kitchen]] page.

{{materials}}

{{Category|Food}}
[[ru:Royal jelly]]

Alcohol

2022-12-29T23:32:18Z

Bihlbo: Added a minor note about cooking with booze, linking to a larger note and instruction on the kitchen page.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
[[File:dwarf_alcohol_preview.png|170px|right]]
'''Alcohol''' is the favored drink of the [[dwarf|dwarves]]; a dwarf will drink booze an average of five times per [[calendar|season]] to satisfy their [[thirst]], and although they can subsist on [[water]], without booze, they will work increasingly slowly. Dwarves like to have some variety in what they drink, and will garner a bad thought if they are forced to drink the same variety of drink repeatedly ("has been tired of drinking the same old booze lately"). Every dwarf likewise has [[preferences]] for various types of drinks. Thus alcohol is important both for maintaining your fortress (at a minimum) and (with some investment in variety) for keeping your dwarves happy.

Alcohol can also be used as an ingredient for [[kitchen|prepared meals]]. However, meals made with alcohol no longer cause your dwarves to get drunk, and will not sate their thirst.

== Acquisition ==
[[File:Thirsty Dwarves.gif|thumb|right|A booze [[stockpile]] at work]]Most [[crop]]s and [[fruit]] [[tree]]s in the game can have their produce turned into drink, and, thus, most drink is sourced from dwarven [[farming]], both indoors and out. Most of the plants [[plant gathering|gathered]] from the wild can also be used for brewing, but the reduced yields relative to farming makes it a less ideal solution, though the added variety of drinks can make it worthwhile. Drinks can be sourced at [[embark#supplies|embarkation]], and taking at least a few barrels with you is recommended to hold your initial dwarves over until you can build a [[still]]. [[Caravan]]s always bring some drinks along as well, although not enough to support a reasonably large fortress. Finally, [[honey]] acquired through [[beekeeping industry|beekeeping]] can be brewed into alcoholic [[mead]], the only form of drink that is not derived from plants or fruit.

The most direct way to acquire the booze itself is through a [[still]]; large fortresses will usually have one or more dedicated [[brewer]]s keeping the dwarven drinks cellar well-stocked. To brew a drink, a dwarf will need an empty watertight container of some kind (either a [[barrel]] or [[large pot]]) and a [[stack]] of brewables. Each brewing job produces five units of alcohol per brewable item and deposits the alcohol in the container, recovering any plant [[seed]]s in the process. The size of a stack does not affect how long it takes to brew it, which is based entirely on the brewer's [[skill]], making brewing jobs performed on large stacks much more efficient than those done on individual consumables. Stacks of alcohol do not have quality levels, and the strength of a happy thought obtained by drinking alcohol is based entirely on the value of the drink (including the stack size) and the dwarf's personal preferences.

== Mechanics ==
[[File:alcohol_preview.jpg|thumb|250px|right|Secret ingredient: happiness]]Dwarven thirst is constrained by the important {{token|ALCOHOL_DEPENDENT|c}} [[creature token]], which causes them to suffer severe performance penalties when deprived of alcohol. "Dry" dwarves increasingly lose [[gait|walking speed]] and [[Combat#Attack_Speed|attack speed]]. Alcohol withdrawal appears in the dwarf's thoughts and preferences as "starting to work slowly due to its scarcity" after 3 months, "really wants a drink" after 6 months, "has gone without a drink for far, far too long" after 9 months, and finally "can't even remember the last time he/she had some" after an entire year. Precisely how much dwarves trudge their feet due to alcohol withdrawal is unknown.

Prior to version 0.44.06, creatures of ''any'' race (even including animals, due to a bug) who were exposed to enough combat to become fully hardened ("doesn't really care about anything anymore") would also become alcoholics.

All creatures can theoretically survive drinking nothing but alcohol for their entire lives, though they may be subject to [[#Alcohol poisoning|alcohol poisoning]] due to not having the same tolerance level as dwarves. Neither dwarves nor any race of creature will accept an alcohol ration if resting in a [[hospital]], and must instead be given fresh water until they recover. Water may also be given to busy dwarves that become thirsty.{{bug|2448}}

[[Vampire]] dwarves are just as alcohol-dependent as the mortal kind. Despite this, in [[fortress mode]], they will only ever drink [[blood]], ensuring they eventually suffer withdrawal even if your pantry is stocked to the brim with every beverage imaginable. This does not stop tavern keepers from giving them drink, if such is available inside the tavern.

Setting booze on [[fire]] will not cause it to explode, but exposing it to high [[temperature]]s ''will'' cause it to boil away. If the container is flammable, it (and, subsequently, the booze) will be consumed by fire; [[magma-safe]] containers would never be destroyed by [[magma]], but any booze inside will likely quickly perish due to heat transfer (unless the container is made of [[nether-cap]]).

Alcohol, like all other liquids, does not have a quality modifier. The level of happy [[thought]] generated by drinking a [[preferences|preferred]] alcohol is dependent upon the value of the entire stack of alcohol.{{cite forum|120870.msg3901346#msg3901346}})

Dwarves prefer drinking alcohol out of a [[Finished goods#Goblets|mug, cup, or goblet]] and will receive an unhappy [[thought]] for drinking alcohol without one of these three vessel types. These may be placed in [[coffer]]s in designated [[tavern]]s. Visitors will drink alcohol too.{{version|0.42.01}}

=== Alcohol poisoning ===

Over-consumption of alcohol can lead to harmful syndromes, progressing to inebriation, unconsciousness, and death. Each individual has their own tolerance level based on their size (with dwarves having 1.5× the resistance for their size) and each individual will consume more or less according to their [[need]] to drink. Mysterious deaths from suffocation in your taverns are most likely cases of acute alcohol poisoning. Note that the lethal effects of alcohol poisoning are caused by impairing the function of a creature's lungs, making creatures that lack lungs, or the need to breathe, immune to death from alcohol poisoning.

== List of alcohol ==

{| class="wikitable sortable"
|-
! Ingredient
! Beverage produced
! Beverage value
! Type
! Source
|-
| [[Plump helmet]] || data-sort-value="wine Dwarven"| Dwarven wine || 2 || rowspan="44" style="background-color:#cfc"| Plant-based || style="background-color:#aaa" | Indoors
|-
| [[Pig tail]] || data-sort-value="ale Dwarven"| Dwarven ale || 2 || style="background-color:#aaa" | Indoors
|-
| [[Cave wheat]] || data-sort-value="beer Dwarven"| Dwarven beer || 2 || style="background-color:#aaa" | Indoors
|-
| [[Sweet pod]] || data-sort-value="rum Dwarven"| Dwarven rum || 2 || style="background-color:#aaa" | Indoors
|-
| [[Muck root]] || data-sort-value="whiskey Swamp"| Swamp whiskey || 1 || Outdoors
|-
| [[Bloated tuber]] || data-sort-value="beer Tuber"| Tuber beer || 2 || Outdoors
|-
| [[Prickle berry]] || data-sort-value="wine Prickle"| Prickle berry wine || 1 || Outdoors
|-
| [[Longland grass]] || data-sort-value="beer Longland"| Longland beer || 2 || Outdoors
|-
| [[Rat weed]] || data-sort-value="brew Sewer"| Sewer brew || 1 || Outdoors
|-
| [[Fisher berry]] || data-sort-value="wine Fisher"| Fisher berry wine || 2 || Outdoors
|-
| [[Rope reed]] || data-sort-value="spirits River"| River spirits || 2 || Outdoors
|-
| [[Sliver barb]] || data-sort-value="cruor Gutter"| Gutter cruor || 1 || Outdoors
|-
| [[Sun berry]] || Sunshine || 5 || Outdoors
|-
| [[Whip vine]] || data-sort-value="wine Whip"| Whip wine || 3 || Outdoors
|-
| [[Beet]] || data-sort-value="wine Beetroot"| Beetroot wine || 2 || Outdoors
|-
| [[Wild carrot]] || data-sort-value="wine Carrot"| Carrot wine || 2 || Outdoors
|-
| [[Cassava]] || data-sort-value="beer Cassava"| Cassava beer || 2 || Outdoors
|-
| [[Parsnip]] || data-sort-value="wine Parsnip"| Parsnip wine || 2 || Outdoors
|-
| [[Potato]] || data-sort-value="wine Potato"| Potato wine || 2 || Outdoors
|-
| [[Radish]] || data-sort-value="wine Radish"| Radish wine || 2 || Outdoors
|-
| [[Sweet potato]] || data-sort-value="wine Sweet"| Sweet potato wine || 2 || Outdoors
|-
| [[Turnip]] || data-sort-value="wine Turnip"| Turnip wine || 2 || Outdoors
|-
| [[Single-grain wheat]] || data-sort-value="beer Single-grain"| Single-grain wheat beer || 2 || Outdoors
|-
| [[Two-grain wheat]] || data-sort-value="beer Two-grain"| Two-grain wheat beer || 2 || Outdoors
|-
| [[Soft wheat]] || data-sort-value="beer Soft"| Soft wheat beer || 2 || Outdoors
|-
| [[Hard wheat]] || data-sort-value="beer Hard"| Hard wheat beer || 2 || Outdoors
|-
| [[Spelt]] || data-sort-value="beer Spelt"| Spelt beer || 2 || Outdoors
|-
| [[Barley]] || data-sort-value="wine Barley"| Barley wine || 2 || Outdoors
|-
| [[Buckwheat]] || data-sort-value="beer Buckwheat"| Buckwheat beer || 2 || Outdoors
|-
| [[Rye]] || data-sort-value="beer Rye"| Rye beer || 2 || Outdoors
|-
| [[Sorghum]] || data-sort-value="beer Sorghum"| Sorghum beer || 2 || Outdoors
|-
| [[Rice]] || data-sort-value="beer Rice"| Rice beer || 2 || Outdoors
|-
| [[Maize]] || data-sort-value="beer Maize"| Maize beer || 2 || Outdoors
|-
| [[Quinoa]] || data-sort-value="beer Quinoa"| Quinoa beer || 2 || Outdoors
|-
| [[Kaniwa]] || data-sort-value="beer Kaniwa"| Kaniwa beer || 2 || Outdoors
|-
| [[Pendant amaranth]] || data-sort-value="amaranth Pendant"| Pendant amaranth beer || 2 || Outdoors
|-
| [[Blood amaranth]] || data-sort-value="amaranth Blood"| Blood amaranth beer || 2 || Outdoors
|-
| [[Purple amaranth]] || data-sort-value="amaranth Purple"| Purple amaranth beer || 2 || Outdoors
|-
| [[Pearl millet]] || data-sort-value="beer Pearl"| Pearl millet beer || 2 || Outdoors
|-
| [[White millet]] || data-sort-value="beer White"| White millet beer || 2 || Outdoors
|-
| [[Finger millet]] || data-sort-value="beer Finger"| Finger millet beer || 2 || Outdoors
|-
| [[Foxtail millet]] || data-sort-value="beer Foxtail"| Foxtail millet beer || 2 || Outdoors
|-
| [[Fonio]] || data-sort-value="beer Fonio"| Fonio beer || 2 || Outdoors
|-
| [[Teff]] || data-sort-value="beer Teff"| Teff beer || 2 || Outdoors
|-
| [[Apple]] || data-sort-value="cider Apple"| Apple cider || 2 || rowspan="32" style="background-color: #fcc"| Fruit-based
| Outdoors
|-
| [[Apricot]] || data-sort-value="wine Apricot"| Apricot wine || 2 || Outdoors
|-
| [[Banana]] || data-sort-value="beer Banana"| Banana beer || 2 || Outdoors
|-
| [[Bayberry]] || data-sort-value="wine Bayberry"| Bayberry wine || 2 || Outdoors
|-
| [[Carambola]] || data-sort-value="wine Carambola"| Carambola wine || 2 || Outdoors
|-
| [[Cherry]] || data-sort-value="wine Cherry"| Cherry wine || 2 || Outdoors
|-
| [[Custard-apple]] || data-sort-value="cider Custard-apple"| Custard-apple cider || 2 || Outdoors
|-
| [[Date]] || data-sort-value="wine Date"| Date wine || 2 || Outdoors
|-
| [[Durian]] || data-sort-value="wine Durian"| Durian wine || 2 || Outdoors
|-
| [[Guava]] || data-sort-value="wine Guava"| Guava wine || 2 || Outdoors
|-
| [[Lychee]] || data-sort-value="wine Lychee"| Lychee wine || 2 || Outdoors
|-
| [[Mango]] || data-sort-value="wine Mango"| Mango wine || 2 || Outdoors
|-
| [[Papaya]] || data-sort-value="wine Papaya"| Papaya wine || 2 || Outdoors
|-
| [[Peach]] || data-sort-value="cider Peach"| Peach cider || 2 || Outdoors
|-
| [[Pear]] || Perry || 2 || Outdoors
|-
| [[Persimmon]] || data-sort-value="wine Persimmon"| Persimmon wine || 2 || Outdoors
|-
| [[Plum]] || data-sort-value="wine Plum"| Plum wine || 2 || Outdoors
|-
| [[Pomegranate]] || data-sort-value="wine Pomegranate"| Pomegranate wine || 2 || Outdoors
|-
| [[Rambutan]] || data-sort-value="wine Rambutan"| Rambutan wine || 2 || Outdoors
|-
| [[Sand pear]] || data-sort-value="cider Sand"| Sand pear cider || 2 || Outdoors
|-
| [[Artichoke]] || data-sort-value="wine Artichoke"| Artichoke wine || 2 || Outdoors
|-
| [[Tomato]] || data-sort-value="wine Tomato"| Tomato wine || 2 || Outdoors
|-
| [[Tomatillo]] || data-sort-value="wine Tomatillo"| Tomatillo wine || 2 || Outdoors
|-
| [[Passion fruit]] || data-sort-value="wine Passion"| Passion fruit wine || 2 || Outdoors
|-
| [[Grape]] || Wine || 2 || Outdoors
|-
| [[Cranberry]] || data-sort-value="wine Cranberry"| Cranberry wine || 2 || Outdoors
|-
| [[Bilberry]] || data-sort-value="wine Bilberry"| Bilberry wine || 2 || Outdoors
|-
| [[Blueberry]] || data-sort-value="wine Blueberry"| Blueberry wine || 2 || Outdoors
|-
| [[Blackberry]] || data-sort-value="wine Blackberry"| Blackberry wine || 2 || Outdoors
|-
| [[Raspberry]] || data-sort-value="wine Raspberry"| Raspberry wine || 2 || Outdoors
|-
| [[Pineapple]] || data-sort-value="wine Pineapple"| Pineapple wine || 2 || Outdoors
|-
| [[Strawberry]] || data-sort-value="wine Strawberry"| Strawberry wine || 2 || Outdoors
|-
| [[Honey]] || Mead || 1 || style="background-color: #ddd"| Animal-based || Outdoors
|}

== Modding ==

{{mod}}

Any item of type [[Item_token#DRINK|DRINK]]:NONE is considered to be an alcoholic beverage as far as the game is concerned, regardless of the material used. Thus, if you were to make a [[reaction]] which produces drinks of, say, [[elf]] blood, your dwarves would happily chug them down, sating their alcohol dependency in the process. Note that DRINK items don't cause inebriation symptoms by themselves; these are dependent on a [[syndrome]] associated with the consumed substance (see the PLANT_ALCOHOL_TEMPLATE raws below for an example). However, you could always add this syndrome, or another one of your own design, to the material you want to use.

== Bugs ==

Cooks will only cook alcohol and other fluids as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}} For more information, see the [[Kitchen#Bugs|kitchen]] page.

== See also ==

* [[Alcohol plant stockpile]] — Brewery input stockpile helper page
* [[Brewer]]
* [[Beekeeping industry]]
* [[Crop]]
* [[Thirst]]

{{Gamedata|{{raw|DF2014:material_template_default.txt|MATERIAL_TEMPLATE|PLANT_ALCOHOL_TEMPLATE}}}}

{{Industry}}
{{materials}}

{{category|Dwarves}}
{{category|Food}}
[[ru:Alcohol]]

Dwarven syrup

2022-12-29T23:31:09Z

Bihlbo: Moved the large note with instruction to the kitchen page. Reduced this to the same minor note added to other fluids.

Milk

2022-12-29T23:29:42Z

Bihlbo: /* Bugs */ Added a minor note about cooking with milk, linking to a larger note and instruction on the kitchen page.

{{migrated article}}
{{Quality|Unrated}}
{{av}}

[[File:milk_bottles.jpg|thumb|282px|right|Got Dwarf?]]

{{buggy}}
'''Milk''' is a product [[extract]]ed from milkable [[creature]]s. Milk can be made into [[cheese]] or used in [[cook]]ing [[prepared meal]]s. It cannot be consumed "as is". Milk is found under "Liquid" in the {{k|z}}/Stocks screen.

Female versions of certain animals are milkable. In order to perform milking, you must have a dwarf with the [[milking]] labor active, a [[farmer's workshop]], an empty [[bucket]] and a mature, non-[[pet]], milkable animal.

==Milkable creatures==

The following creatures can be milked:

*[[Alpaca]]
* Camels, both [[one-humped camel]]† and [[two-humped camel]]†, [[one-humped camel man|one-humped camel women]] and [[two-humped camel man|two-humped camel women]] and the [[giant one-humped camel]]† and [[giant two-humped camel]]†
*[[Cow]]
*[[Donkey]]
*[[Goat]]
*[[Horse]]
*[[Kangaroo]]†, [[kangaroo man|kangaroo women]] and [[giant kangaroo]]†
*[[Llama]]
*[[Pig]]
*[[Purring maggot]]‡
*[[Reindeer]]
*[[Sheep]]
*[[Tapir]]†, [[tapir man|tapir women]] and [[giant tapir]]†
*[[Water buffalo]]
*[[Yak]]

: † These animals are not domesticated and can't be brought on [[embark]]. Savage giant and animal man versions grant the same milk as the normal-sized species, though animal people are not domesticable. 
: ‡ Purring maggots are an unusual case in that they are [[vermin]] and not livestock. They are currently bugged and can't be milked if tamed. {{Bug|3670}}. 

==Milking creatures==
{{catbox|DF2014:Milkable}}Queue a "Milk Creature" job at a [[farmer's workshop]]. The milker will not necessarily pick the closest animal available. Caging, pasturing or restraining the milkable creatures near the workshop might be a good idea, but is not mandatory. The animal must also have milk available. Once milked, the creature will be free to roam. If the creature was previously caged, pastured or restrained, some dwarf will be assigned the job of taking it back. You can avoid these pasture animal jobs if the [[farmer's workshop]] is in the animal's pasture.

Milk should eventually be transferred from its bucket into a [[barrel]] or [[large pot]] for long-term storage. If you plan to make [[cheese]], it's a good idea to let the milk accumulate so that you get stacks of cheese (up to size 5) instead of single (size 1) cheeses.

The frequency with which animals are able to be milked is defined in the raw files with the tag {{token|MILKABLE|creature|LOCAL_CREATURE_MAT:MILK:20000}}. All milkable creatures currently have this tag set to 20000 [[Time|ticks]], which, at 1200 ticks per day, means they all can be milked every 17 in-game days. Due to this time-out, using {{k|r}}epeating jobs to milk creatures is infeasible if only a few milkable animals are available. Alternating repeating "Milk Creature" and "Make Cheese" jobs tend to work poorly, since transfer of the milk to storage can interfere with continued work, so that sooner or later the cheesemaking job will be cancelled, eventually canceling the milking job as well.

An exploit to maximise embark point returns is to take 1 of each kind of milk - milk costs only 1 point at embark and comes with a separate barrel for each type, effectively giving you free barrels, and (after some work) stacks of 1 cheese from each unit of milk for your [[prepared meal]]s, worth 10 times what the milk is worth.

Milk from milkable animals domesticated by a [[civilization]] can be ordered in [[trade agreement]]s with that civilization. Each barrel of milk brought by a [[caravan]] contains 10 units of milk.

===Dwarven ice cream===

Milk has a [[temperature|freezing point]] of 10000 °U, the same as [[water]]. If milk is left in conditions below this temperature, even on a tile marked [[tile attributes|inside]], it will freeze, and become "frozen ''{animal}'''s milk". Frozen milk is treated as a cookable solid {{Bug|2787}}, and may show up as an ingredient in your roasts--at 1/10th of the value of cheese, if the roasts do not just melt entirely. There is no entry for frozen milk in stockpile menus, so dwarves will not haul a frozen milk barrel to any type of stockpile. {{Bug|3398}} Careless attempts to dump the barrel to an indoor [[garbage dump]] may result in dwarves hauling the frozen milk and the barrel separately, resulting in a puddle of milk when it thaws. Dwarves will not make cheese out of frozen milk. For these reasons, milking industries should be set up underground, as Armok intended.

If your [[trade depot]] is outdoors in freezing weather, any barrels of milk (or [[lye]]) brought by a caravan will be frozen and appear as empty barrels in the [[Trading]] screen. They can be distinguished from empty barrels by having a price 10☼ higher than the price of the barrel, or by {{k|v}}iewing their contents.

To move frozen milk to an indoor garbage dump without spilling it, do not use the [[Designations Menu]]. Instead, use {{k|k}}-{{k|d}} to mark just the barrel for dumping.

==Bugs==
* After finishing a milking job, the milker may generate a cancellation message if trying to take another job immediately: "Urist McMultitasking cancels job, handling dangerous animal". They will subsequently just leave the milked animal to wander away on its own and retask anyway.
* It is unclear why pets cannot be milked; this seems to be a bug because milking is a requirement for some animals and presumably the Animal Care dwarf would be aware of this and oversee their regular milking.
* Tamed purring maggots can't be milked. {{Bug|3670}}
* After being milked (or attempting to milk them?), purring maggots are left inside the workshop as an item. {{Bug|3668}}
* Cooks will only cook milk and other fluids as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}} For more information, see the [[Kitchen#Bugs|kitchen]] page.

{{D for Dwarf}}

Dwarven milk does not in fact come from dwarves. This is generally a relief to human caravans, until they find out where it really [[purring maggot|comes from]].

Because milk is not considered a drink, dwarves will not drink it, even if they are dying of [[thirst]]. Indeed, dwarves consider any drink that isn't alcoholic to be no better than water, and refuse to drink milk because it's of better use as cheese. Another theory is that dwarves refuse to imbibe milk because it would make them puny milk-drinkers. What is for certain, however, is that unlike in real life, dwarves have yet to discover how to make alcoholic fermented milk beverages, such as kumis or kefir.

{{gamedata|{{raw|DF2014:material_template_default.txt|MATERIAL_TEMPLATE|MILK_TEMPLATE}}}}
{{materials}}

{{Category|Food}}
{{Category|Extracts}}
{{Category|Creature attributes}}
[[ru:Milk]]

Oil

2022-12-29T23:28:33Z

Bihlbo: Added a minor note about cooking with oil, linking to a larger note and instruction on the kitchen page.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
'''Oil''' is an ingredient in [[cooking]] and [[soap]] making, made by [[pressing]] one of the several [[seed]] pastes or fruit at a [[screw press]]. The press squeezes the material, releasing the oil, which is stored in a [[liquid]]-capable [[jug]]. The oil can then be used to supplement a fortress's [[food]] supply, or can be combined with [[lye]] to make [[soap]].

== Oil-producing crops ==

The following crops produce seeds that can be milled and pressed into oil:

{| class="wikitable" cellspacing="0" border="1" cellpadding="5"
|-
! Plant Name
! Underground?
! Oil Name
! Oil Value
|-
|[[Quarry bush]]
|Yes
|Rock Nut oil
|5☼
|-
|[[Cotton]]
|No
|Cottonseed oil
|5☼
|-
|[[Flax]]
|No
|Linseed oil
|5☼
|-
|[[Hemp]]
|No
|Hempseed oil
|5☼
|-
|[[Kenaf]]
|No
|Kenaf seed oil
|5☼
|-
|[[Olive]] (fruit)
|No
|Olive oil
|5☼
|}

== Value ==
Oil will be used in the [[kitchen]] when 'prepare meal' tasks are queued if it is enabled in the [[Status#Kitchen_Status_Screen|Kitchen tab]] in the Status screen.

Most of the seeds can be cooked directly, but have a base value of 1☼. However, [[milling]] the seeds to a paste and pressing them into oil generates a [[press cake]] with a value of 1☼ and a unit of oil with a value of 5☼, a 500% value increase for only two [[labor]]s.

[[File:Oliven_V1.jpg|thumb|250px|center|Olive oil.]]

== Bugs ==

Cooks will only cook oil and other fluids as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}} For more information, see the [[Kitchen#Bugs|kitchen]] page.

{{Translation
| dwarven = uzol
| elvish = ÿivu
| goblin = smatspo
| human = konli
}}

{{gamedata|{{raw|DF2014:material_template_default.txt|MATERIAL_TEMPLATE|PLANT_OIL_TEMPLATE}}}}
{{materials}}

{{Category|Food}}
[[ru:Oil]]

Kitchen

2022-12-29T23:21:41Z

Bihlbo: Moved a note about cooking with fluids from the dwarven syrup page to here, since it applies to all fluids.

Alcohol

2022-12-29T23:09:47Z

Bihlbo: Added a note that booze can be cooked. Surprised it wasn't mentioned before.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
[[File:dwarf_alcohol_preview.png|170px|right]]
'''Alcohol''' is the favored drink of the [[dwarf|dwarves]]; a dwarf will drink booze an average of five times per [[calendar|season]] to satisfy their [[thirst]], and although they can subsist on [[water]], without booze, they will work increasingly slowly. Dwarves like to have some variety in what they drink, and will garner a bad thought if they are forced to drink the same variety of drink repeatedly ("has been tired of drinking the same old booze lately"). Every dwarf likewise has [[preferences]] for various types of drinks. Thus alcohol is important both for maintaining your fortress (at a minimum) and (with some investment in variety) for keeping your dwarves happy.

Alcohol can also be used as an ingredient for [[kitchen|prepared meals]]. However, meals made with alcohol no longer cause your dwarves to get drunk, and will not sate their thirst.

== Acquisition ==
[[File:Thirsty Dwarves.gif|thumb|right|A booze [[stockpile]] at work]]Most [[crop]]s and [[fruit]] [[tree]]s in the game can have their produce turned into drink, and, thus, most drink is sourced from dwarven [[farming]], both indoors and out. Most of the plants [[plant gathering|gathered]] from the wild can also be used for brewing, but the reduced yields relative to farming makes it a less ideal solution, though the added variety of drinks can make it worthwhile. Drinks can be sourced at [[embark#supplies|embarkation]], and taking at least a few barrels with you is recommended to hold your initial dwarves over until you can build a [[still]]. [[Caravan]]s always bring some drinks along as well, although not enough to support a reasonably large fortress. Finally, [[honey]] acquired through [[beekeeping industry|beekeeping]] can be brewed into alcoholic [[mead]], the only form of drink that is not derived from plants or fruit.

The most direct way to acquire the booze itself is through a [[still]]; large fortresses will usually have one or more dedicated [[brewer]]s keeping the dwarven drinks cellar well-stocked. To brew a drink, a dwarf will need an empty watertight container of some kind (either a [[barrel]] or [[large pot]]) and a [[stack]] of brewables. Each brewing job produces five units of alcohol per brewable item and deposits the alcohol in the container, recovering any plant [[seed]]s in the process. The size of a stack does not affect how long it takes to brew it, which is based entirely on the brewer's [[skill]], making brewing jobs performed on large stacks much more efficient than those done on individual consumables. Stacks of alcohol do not have quality levels, and the strength of a happy thought obtained by drinking alcohol is based entirely on the value of the drink (including the stack size) and the dwarf's personal preferences.

== Mechanics ==
[[File:alcohol_preview.jpg|thumb|250px|right|Secret ingredient: happiness]]Dwarven thirst is constrained by the important {{token|ALCOHOL_DEPENDENT|c}} [[creature token]], which causes them to suffer severe performance penalties when deprived of alcohol. "Dry" dwarves increasingly lose [[gait|walking speed]] and [[Combat#Attack_Speed|attack speed]]. Alcohol withdrawal appears in the dwarf's thoughts and preferences as "starting to work slowly due to its scarcity" after 3 months, "really wants a drink" after 6 months, "has gone without a drink for far, far too long" after 9 months, and finally "can't even remember the last time he/she had some" after an entire year. Precisely how much dwarves trudge their feet due to alcohol withdrawal is unknown.

Prior to version 0.44.06, creatures of ''any'' race (even including animals, due to a bug) who were exposed to enough combat to become fully hardened ("doesn't really care about anything anymore") would also become alcoholics.

All creatures can theoretically survive drinking nothing but alcohol for their entire lives, though they may be subject to [[#Alcohol poisoning|alcohol poisoning]] due to not having the same tolerance level as dwarves. Neither dwarves nor any race of creature will accept an alcohol ration if resting in a [[hospital]], and must instead be given fresh water until they recover. Water may also be given to busy dwarves that become thirsty.{{bug|2448}}

[[Vampire]] dwarves are just as alcohol-dependent as the mortal kind. Despite this, in [[fortress mode]], they will only ever drink [[blood]], ensuring they eventually suffer withdrawal even if your pantry is stocked to the brim with every beverage imaginable. This does not stop tavern keepers from giving them drink, if such is available inside the tavern.

Setting booze on [[fire]] will not cause it to explode, but exposing it to high [[temperature]]s ''will'' cause it to boil away. If the container is flammable, it (and, subsequently, the booze) will be consumed by fire; [[magma-safe]] containers would never be destroyed by [[magma]], but any booze inside will likely quickly perish due to heat transfer (unless the container is made of [[nether-cap]]).

Alcohol, like all other liquids, does not have a quality modifier. The level of happy [[thought]] generated by drinking a [[preferences|preferred]] alcohol is dependent upon the value of the entire stack of alcohol.{{cite forum|120870.msg3901346#msg3901346}})

Dwarves prefer drinking alcohol out of a [[Finished goods#Goblets|mug, cup, or goblet]] and will receive an unhappy [[thought]] for drinking alcohol without one of these three vessel types. These may be placed in [[coffer]]s in designated [[tavern]]s. Visitors will drink alcohol too.{{version|0.42.01}}

=== Alcohol poisoning ===

Over-consumption of alcohol can lead to harmful syndromes, progressing to inebriation, unconsciousness, and death. Each individual has their own tolerance level based on their size (with dwarves having 1.5× the resistance for their size) and each individual will consume more or less according to their [[need]] to drink. Mysterious deaths from suffocation in your taverns are most likely cases of acute alcohol poisoning. Note that the lethal effects of alcohol poisoning are caused by impairing the function of a creature's lungs, making creatures that lack lungs, or the need to breathe, immune to death from alcohol poisoning.

== List of alcohol ==

{| class="wikitable sortable"
|-
! Ingredient
! Beverage produced
! Beverage value
! Type
! Source
|-
| [[Plump helmet]] || data-sort-value="wine Dwarven"| Dwarven wine || 2 || rowspan="44" style="background-color:#cfc"| Plant-based || style="background-color:#aaa" | Indoors
|-
| [[Pig tail]] || data-sort-value="ale Dwarven"| Dwarven ale || 2 || style="background-color:#aaa" | Indoors
|-
| [[Cave wheat]] || data-sort-value="beer Dwarven"| Dwarven beer || 2 || style="background-color:#aaa" | Indoors
|-
| [[Sweet pod]] || data-sort-value="rum Dwarven"| Dwarven rum || 2 || style="background-color:#aaa" | Indoors
|-
| [[Muck root]] || data-sort-value="whiskey Swamp"| Swamp whiskey || 1 || Outdoors
|-
| [[Bloated tuber]] || data-sort-value="beer Tuber"| Tuber beer || 2 || Outdoors
|-
| [[Prickle berry]] || data-sort-value="wine Prickle"| Prickle berry wine || 1 || Outdoors
|-
| [[Longland grass]] || data-sort-value="beer Longland"| Longland beer || 2 || Outdoors
|-
| [[Rat weed]] || data-sort-value="brew Sewer"| Sewer brew || 1 || Outdoors
|-
| [[Fisher berry]] || data-sort-value="wine Fisher"| Fisher berry wine || 2 || Outdoors
|-
| [[Rope reed]] || data-sort-value="spirits River"| River spirits || 2 || Outdoors
|-
| [[Sliver barb]] || data-sort-value="cruor Gutter"| Gutter cruor || 1 || Outdoors
|-
| [[Sun berry]] || Sunshine || 5 || Outdoors
|-
| [[Whip vine]] || data-sort-value="wine Whip"| Whip wine || 3 || Outdoors
|-
| [[Beet]] || data-sort-value="wine Beetroot"| Beetroot wine || 2 || Outdoors
|-
| [[Wild carrot]] || data-sort-value="wine Carrot"| Carrot wine || 2 || Outdoors
|-
| [[Cassava]] || data-sort-value="beer Cassava"| Cassava beer || 2 || Outdoors
|-
| [[Parsnip]] || data-sort-value="wine Parsnip"| Parsnip wine || 2 || Outdoors
|-
| [[Potato]] || data-sort-value="wine Potato"| Potato wine || 2 || Outdoors
|-
| [[Radish]] || data-sort-value="wine Radish"| Radish wine || 2 || Outdoors
|-
| [[Sweet potato]] || data-sort-value="wine Sweet"| Sweet potato wine || 2 || Outdoors
|-
| [[Turnip]] || data-sort-value="wine Turnip"| Turnip wine || 2 || Outdoors
|-
| [[Single-grain wheat]] || data-sort-value="beer Single-grain"| Single-grain wheat beer || 2 || Outdoors
|-
| [[Two-grain wheat]] || data-sort-value="beer Two-grain"| Two-grain wheat beer || 2 || Outdoors
|-
| [[Soft wheat]] || data-sort-value="beer Soft"| Soft wheat beer || 2 || Outdoors
|-
| [[Hard wheat]] || data-sort-value="beer Hard"| Hard wheat beer || 2 || Outdoors
|-
| [[Spelt]] || data-sort-value="beer Spelt"| Spelt beer || 2 || Outdoors
|-
| [[Barley]] || data-sort-value="wine Barley"| Barley wine || 2 || Outdoors
|-
| [[Buckwheat]] || data-sort-value="beer Buckwheat"| Buckwheat beer || 2 || Outdoors
|-
| [[Rye]] || data-sort-value="beer Rye"| Rye beer || 2 || Outdoors
|-
| [[Sorghum]] || data-sort-value="beer Sorghum"| Sorghum beer || 2 || Outdoors
|-
| [[Rice]] || data-sort-value="beer Rice"| Rice beer || 2 || Outdoors
|-
| [[Maize]] || data-sort-value="beer Maize"| Maize beer || 2 || Outdoors
|-
| [[Quinoa]] || data-sort-value="beer Quinoa"| Quinoa beer || 2 || Outdoors
|-
| [[Kaniwa]] || data-sort-value="beer Kaniwa"| Kaniwa beer || 2 || Outdoors
|-
| [[Pendant amaranth]] || data-sort-value="amaranth Pendant"| Pendant amaranth beer || 2 || Outdoors
|-
| [[Blood amaranth]] || data-sort-value="amaranth Blood"| Blood amaranth beer || 2 || Outdoors
|-
| [[Purple amaranth]] || data-sort-value="amaranth Purple"| Purple amaranth beer || 2 || Outdoors
|-
| [[Pearl millet]] || data-sort-value="beer Pearl"| Pearl millet beer || 2 || Outdoors
|-
| [[White millet]] || data-sort-value="beer White"| White millet beer || 2 || Outdoors
|-
| [[Finger millet]] || data-sort-value="beer Finger"| Finger millet beer || 2 || Outdoors
|-
| [[Foxtail millet]] || data-sort-value="beer Foxtail"| Foxtail millet beer || 2 || Outdoors
|-
| [[Fonio]] || data-sort-value="beer Fonio"| Fonio beer || 2 || Outdoors
|-
| [[Teff]] || data-sort-value="beer Teff"| Teff beer || 2 || Outdoors
|-
| [[Apple]] || data-sort-value="cider Apple"| Apple cider || 2 || rowspan="32" style="background-color: #fcc"| Fruit-based
| Outdoors
|-
| [[Apricot]] || data-sort-value="wine Apricot"| Apricot wine || 2 || Outdoors
|-
| [[Banana]] || data-sort-value="beer Banana"| Banana beer || 2 || Outdoors
|-
| [[Bayberry]] || data-sort-value="wine Bayberry"| Bayberry wine || 2 || Outdoors
|-
| [[Carambola]] || data-sort-value="wine Carambola"| Carambola wine || 2 || Outdoors
|-
| [[Cherry]] || data-sort-value="wine Cherry"| Cherry wine || 2 || Outdoors
|-
| [[Custard-apple]] || data-sort-value="cider Custard-apple"| Custard-apple cider || 2 || Outdoors
|-
| [[Date]] || data-sort-value="wine Date"| Date wine || 2 || Outdoors
|-
| [[Durian]] || data-sort-value="wine Durian"| Durian wine || 2 || Outdoors
|-
| [[Guava]] || data-sort-value="wine Guava"| Guava wine || 2 || Outdoors
|-
| [[Lychee]] || data-sort-value="wine Lychee"| Lychee wine || 2 || Outdoors
|-
| [[Mango]] || data-sort-value="wine Mango"| Mango wine || 2 || Outdoors
|-
| [[Papaya]] || data-sort-value="wine Papaya"| Papaya wine || 2 || Outdoors
|-
| [[Peach]] || data-sort-value="cider Peach"| Peach cider || 2 || Outdoors
|-
| [[Pear]] || Perry || 2 || Outdoors
|-
| [[Persimmon]] || data-sort-value="wine Persimmon"| Persimmon wine || 2 || Outdoors
|-
| [[Plum]] || data-sort-value="wine Plum"| Plum wine || 2 || Outdoors
|-
| [[Pomegranate]] || data-sort-value="wine Pomegranate"| Pomegranate wine || 2 || Outdoors
|-
| [[Rambutan]] || data-sort-value="wine Rambutan"| Rambutan wine || 2 || Outdoors
|-
| [[Sand pear]] || data-sort-value="cider Sand"| Sand pear cider || 2 || Outdoors
|-
| [[Artichoke]] || data-sort-value="wine Artichoke"| Artichoke wine || 2 || Outdoors
|-
| [[Tomato]] || data-sort-value="wine Tomato"| Tomato wine || 2 || Outdoors
|-
| [[Tomatillo]] || data-sort-value="wine Tomatillo"| Tomatillo wine || 2 || Outdoors
|-
| [[Passion fruit]] || data-sort-value="wine Passion"| Passion fruit wine || 2 || Outdoors
|-
| [[Grape]] || Wine || 2 || Outdoors
|-
| [[Cranberry]] || data-sort-value="wine Cranberry"| Cranberry wine || 2 || Outdoors
|-
| [[Bilberry]] || data-sort-value="wine Bilberry"| Bilberry wine || 2 || Outdoors
|-
| [[Blueberry]] || data-sort-value="wine Blueberry"| Blueberry wine || 2 || Outdoors
|-
| [[Blackberry]] || data-sort-value="wine Blackberry"| Blackberry wine || 2 || Outdoors
|-
| [[Raspberry]] || data-sort-value="wine Raspberry"| Raspberry wine || 2 || Outdoors
|-
| [[Pineapple]] || data-sort-value="wine Pineapple"| Pineapple wine || 2 || Outdoors
|-
| [[Strawberry]] || data-sort-value="wine Strawberry"| Strawberry wine || 2 || Outdoors
|-
| [[Honey]] || Mead || 1 || style="background-color: #ddd"| Animal-based || Outdoors
|}

== Modding ==

{{mod}}

Any item of type [[Item_token#DRINK|DRINK]]:NONE is considered to be an alcoholic beverage as far as the game is concerned, regardless of the material used. Thus, if you were to make a [[reaction]] which produces drinks of, say, [[elf]] blood, your dwarves would happily chug them down, sating their alcohol dependency in the process. Note that DRINK items don't cause inebriation symptoms by themselves; these are dependent on a [[syndrome]] associated with the consumed substance (see the PLANT_ALCOHOL_TEMPLATE raws below for an example). However, you could always add this syndrome, or another one of your own design, to the material you want to use.

== See also ==

* [[Alcohol plant stockpile]] — Brewery input stockpile helper page
* [[Brewer]]
* [[Beekeeping industry]]
* [[Crop]]
* [[Thirst]]

{{Gamedata|{{raw|DF2014:material_template_default.txt|MATERIAL_TEMPLATE|PLANT_ALCOHOL_TEMPLATE}}}}

{{Industry}}
{{materials}}

{{category|Dwarves}}
{{category|Food}}
[[ru:Alcohol]]

Dwarven syrup

2022-12-29T22:56:03Z

Bihlbo: Solved a problem that a previous editor called "impossible." Also made the whole section easier to understand.

{{migrated article}}
{{av}}
{{Quality|Unrated}}
'''Dwarven syrup''' is a cooking ingredient made from [[sweet pod]]s at a [[farmer's workshop]] using the "process plants (barrel)" order and the [[plant processing]] labor. Five units of dwarven syrup are made from each sweet pod, and one seed per sweet pod will be left over. Dwarven syrup cannot be eaten in its raw state, but can be made into edible food using [[cooking]].

== Bugs ==

Cooks will only cook dwarven syrup as a last resort, instead preferring to cook solid foods with solid foods. {{Bug|2393}}

To force the kitchen to cook with fluids like dwarven syrup, you can limit the possible ingredients used for cooking through [[stockpile]] linkage. If a [[kitchen]] is set to accept ingredients from a stockpile, it will not use any other ingredients unless they are already stored in the kitchen (which may be encountered if no one has yet hauled some recently-rendered [[tallow]]). Set up a tiny stockpile to only hold solid food ingredients, but no [[barrel|barrels]]. The size of this stockpile will determine how many solid ingredients the kitchen can easily use, so if it is 1x1, the cook will use just one solid ingredient before looking elsewhere. A speedy hauler might get another item into that space before the cook stops looking for ingredients, but this is uncommon. Set up another stockpile to hold the fluid ingredients. Set both of these stockpiles to give items to the kitchen. If there's nothing else left in the tiny stockpile when the cook is looking for ingredients, then the only other ingredients which can be used will be the fluid ingredients, and so they will be used even though they are not preferred by the cook.

Of course, the tiny solid ingredient stockpile will need to be refilled, so you will also need a larger stockpile that links to the tiny one. Unfortunately, once ingredients are in barrels, they will never be taken out of the barrels to be moved to the tiny stockpile, so the larger stockpile will also have to be limited to not use barrels. One way to get ingredients out of barrels is to set a barrel-using food stockpile to only accept from linked stockpiles, set the stockpile to give to the kitchen but not to take from anything, and queue up a lavish meal. Watch the kitchen, and once ingredients have been delivered so work can begin, cancel or pause the work. They will then need to empty the kitchen, and since your barrel-using stockpile is set to not accept from the kitchen, only your barrel-free stockpiles will be available.
{{materials}}
{{Category|Food}}
{{Category|Extracts}}
[[ru:Dwarven syrup]]

Screw pump

2022-12-28T06:23:19Z

Bihlbo: Since a pump no longer has a "light" and "dark" side, I changed all of the terminology. Also, cleared up some wording to make things more clear and less repetative. Did some testing to ensure other details were still accurate, and clarified some things I noticed were missing.

{{migrated article}}
{{Quality|Unrated}}
{{av}}
{{Machine_component|name=Screw pump|key=p|job=[[Pump operator]]
|construction=
* [[Block]]
* [[Trap component#Enormous corkscrew|Enormous corkscrew]]
* [[Pipe section]]
|construction_job=
* [[Architecture]]
* 1 of
** [[Carpentry]]
** [[Masonry]]
** [[Metalsmithing]]
|power=Needs 10 power.
}}

A '''screw pump''' is a small [[building]] that can lift liquids ([[water]] or [[magma]]) from one level below onto the same [[Z-level]] as the pump. It is two tiles by one tile in size, and it can be either manually operated by a [[dwarf]] allowed to do the the [[pump operator|pump operating]] work (by default there is no [[work detail]] for this [[labor]], and everyone is allowed to do it) or by being [[power]]ed by [[water wheel]]s and/or [[windmill]]s. A screw pump both accepts and transfers power using either tile of the pump, in all orthogonal directions, including above and below.

A screw pump has two sides. One side is the "input" side which accepts dwarven labor from the [[pump operator]], and which obtains the fluid that the machine will pump. The other side is the "output" side, which outputs the fluid being pumped. In previous versions of Dwarf Fortress, the input side showed up as a light-colored tile, and the output side was a dark-colored tile, which will likely be a method of differentiating the two sides that you will encounter in descriptions and illustrations. In v50 a screw pump's orientation will be displayed by clicking on the pump. In the premium edition of v50 Dwarf Fortress, a pump has detailed graphics, which visually shows the orientation of the pump. The input side has many gears, and the output side has jutting pipes.

The direction you want the fluid to travel must be chosen at the time of construction. Pumping only occurs in a straight line, and involves a total of 4 tiles in a row - 1) the liquid source, two for the pump, and the output (details below, under Construction).

The "rise" in levels occurs on the first tile, the intake side, from one level below up to the level of the pump. Pumped fluids can and will flow immediately after being pumped, as normal for that fluid. Pumped fluids will have a [[pressure]] equal to the exit [[z-level]] - a pump never "forces" water to a higher [[z-level]] than the output tile.

[[Water#Salt Water|Salt water]] pumped through a pump will desalinate and become drinkable, but only if the [[cistern]] has never contained salty water. [[Water#Stagnant Water|Stagnant water]] pumped through a pump will become clean, letting dwarves drink it without getting an unhappy [[thought]] and letting [[doctor]]s clean [[wound]]s without causing an [[Health care#Infection|infection]]. As with desalination, this only works if the [[cistern]] has never contained stagnant water.

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

== Construction ==

Building a screw pump requires an [[Trap component#Enormous corkscrew|enormous corkscrew]], a [[block]], and a [[pipe section]]. These can be made of any material if the pump is intended to move water, but each component must be [[magma-safe]] if the pump is to be used to move [[magma]]. As with construction of other buildings, a dwarf first brings all materials to the planned site, then construction can begin. Both bringing the materials and the construction labor requires that the dwarf is allowed to do [[carpentry]], [[metalsmithing]], or [[masonry]], depending on the material of the block. The constructing dwarf will finish the labor by standing on the input side of the pump, and so will require access to that tile. Deconstructing a screw pump requires the same labor as it took to construct it.

[[Image:Small pump.jpg|thumb|right|300px|'''Basic Side View of a Pump'''. This pump "pumps from the west to east", flowing from left to right. The area to the right may fill to the top of that level, but no more (See [[pressure]]; see [[Screw pump#Pump stack|Pump stack]]). Note that the entire space required is 4 tiles long by 1 tile wide, not including any retaining walls for the outflow. If pumped manually, the [[pump operator]] stands in the input side, as the output tile is [[impassable tile|impassable]] to both fluid and movement. ''(Although the "liquid" is shown as blue, this can work for [[magma]] as well, with the [[magma-safe|appropriate precautions]].)'']]

Although the screw itself is only 2 tiles long by 1 tile wide, the entire system must be thought of as 4 tiles long (see diagram, "Basic Side View of a Pump", right). This consists of (left to right)... 1) a liquid-source tile (where the liquid is, -1 z-level below), 2) the input end of the pump itself, 3) the output end of the pump, and 4) the tile where the liquid will be deposited, which is on the same level as the pump.

It's easily possible to allow that output liquid to drain away to lower z-levels, but it ''starts'' on the same level as the pump, 1 z-level above where it started. It's also possible to use walls to prevent the liquid from spreading, and this is recommended if you do not have a reliable drain system.

To build a pump, open the {{k|b}}uild menu, select {{k|m}}achines/fluids and then Screw {{k|p}}ump. It's important to choose the proper orientation for your pump (to specify the source and destination tiles) using the sub-menu that appears in the upper-right of the screen. In Dwarf Fortress Classic v50, the arrows on this menu point in the direction of the source of the pump's fluid, not in the direction the fluid will be pumped (for instance, if you click on the →→ symbol, the machine will be built to pump from east to west). These same buttons in Dwarf Fortress Premium show an icon that more intuitively displays the movement of fluid by the machine, and are in an opposite layout. The default (as shown above in the sidebar), "pumps from the north", which is the center-bottom button in Dwarf Fortress Premium, and the center-top option in Dwarf Fortress Classic. When clicking the map to choose a location for a pump, the tile you select will be the output side of the pump.

If pumped manually, the pump operator stands on the input tile, as the output tile is [[impassable tile|impassable]]. After construction is complete, orientation of the pump will be displayed by clicking on the pump. Orientation of a pump cannot be changed after being constructed, but, as with any building, it can be deconstructed into its component parts and rebuilt with a new orientation, and/or a new location.

Having specified the direction of travel, you must ensure that the source side of the pump is placed adjacent to and above (in the [[z-axis]]) a liquid. That end of the pump is '''not''' directly over the source - it is one level above but adjacent to it. The screw pump will draw the liquid up from below its level, and distribute it out of the other side of the pump.

Construction of a screw pump can be prohibited with a "needs screw trap component" message if your enormous corkscrews are in a bin which has ''any'' current tasks attached to it (such as the relocation of a newly constructed corkscrew, or a military member moving a weapon). One workaround is to create a separate weapon stockpile for your corkscrews, and for best effectiveness, disallow the use of bins in that stockpile. This will force your corkscrew storage to work as smoothly (and space-consumingly) as a furniture stockpile.

== Notes ==
* Dwarves must be able to access and stand on the input tile of the pump in order to build the pump and then to be able to operate the pump manually.
* Liquids to be pumped must be 1 level below the (empty) area ''adjacent'' to the input tile.
* The space above the fluid source cannot be a floor, stairway or wall. Screw pumps can pull water through a [[grate]], floor [[bars]], or a [[construction|constructed]] [[fortification]] on the Z-level below.
* Liquids will appear in the tile adjacent to the output side of the pump.
* The output tile blocks liquid flow and creature movement, and can be built between wall segments to create a solid barrier. The input tile of the pump does not block flow or movement.
* Pumps can also be used in conjunction with a [[water wheel]] or a [[windmill]] to become powered by these machines, rather than by a dwarf.
* Actively-powered mechanisms connected to either pump tile will automatically start the pump; to prevent this, either restrict liquid flow using floodgates or hatches, or build a [[gear assembly]] linked to a [[lever]] to disconnect the [[power]].
* If a pump is powered, the pump will also output power to connected machines ([[gear assemblies]], [[axle|axles]], other pumps, etc.).
* Adjacent pumps ''automatically'' transfer mechanical power to any other adjacent pump(s); no [[axle]] or [[mechanism]] is required. If too many pumps are adjacent, there may be insufficient power to power them. In this case, ''all'' pumps (and other items) connected to that power network will fail to work. By clicking on a powered pump, axle, gear assembly, windmill, or water wheel you can see the "Total Power" and "Total Power Needed" in the system.
* Dwarves operating pumps do '''NOT''' generate power. Thus, one cannot use a single [[pump operator]] to power an entire [[pump stack]] or anything else that accepts or transfers power.
* In order to build pumps in a "hanging" state, as in the stacked screw pump example (below), one of its tiles must be able to connect to a nearby machine, either already existing or designated to be built. If, when the screw pump's construction is completed, the supporting mechanism has not yet been completed, it will promptly collapse into its component parts.
* Pumps do '''not''' push liquids '''up''' additional Z-levels above them. They only deliver water to their own level. That is, if you direct the output of a screw pump into a 1-square space surrounded by walls, the water will not "overflow" the walls. Consequently, a pump will refuse to move liquid if the level it is pumping to is completely filled. Higher levels can be achieved using a "pump stack" (below). (See [[Pressure]])
* In order to safely pump magma, you must use [[magma-safe]] materials, though magma-unsafe metals have been observed to be safe unless the input tile is going to be submerged in magma. Wooden parts (except for [[nether-cap]]s) will burst into flames the instant the pump is activated, and magma-unsafe stone [[block]]s melt after a short time. Despite the requirement for magma-safe materials, the exterior of the pump does not heat up, and dwarves do not mind operating a magma pump directly.
* Magma, which normally has no pressure, will behave as though pressurized when pumped. For example, when pumped into a U-turn, magma will come out at the other end. Normal (non-pumped) magma would just pool at the lowest level. This may be either very useful (can be used to build pressure towers for magma) or deadly (forge level flooded with magma, because someone tried to pump magma into a volcano).
* Pump's pseudo-pressure doesn't work across diagonals. If there is a diagonal-only passage in your tunnel, liquids will seep slowly through it, instead of bursting through above their normal maximal speed, like they would if there was a clear orthogonal passage.
* The liquid in a pump's intake tile must have a depth of at least 2/7 for the pump to be able to remove any amount of liquid from it.
* If a pump's intake tile on the z-level below the pump becomes blocked (e.g. cave-in, magma cooling into obsidian, or a sapling maturing into a [[tree]]) the pump will still run but not pump any fluid.
* If a pump's output tile contains magma and the pump is pumping water or vice versa, the output tile will be turned into [[obsidian]].
* Pumps operate in the reverse order in which they were built-- the most recently built will try to pump, then the next recent, and so on. You can use this to your advantage for [[mist]] generation, to maximize fluid throughput, or for advanced [[repeater]] design.
* Screw pumps continue to operate for a short period (49 ticks) after losing power-- that is, a screw pump supplied power for exactly 1 tick will actually pump for 50 ticks.
* Screw pumps attempt to pump everything from the inlet tile to the outlet tile on every turn (so long as there is more than 1/7 liquid in the square). Actual pump rate tends to be slower than this due to liquid needing to flow to the pump inlet, which can take a few turns depending on the source.
* In previous versions, in [[Adventure mode]], if you bring your adventurer to a site with working pumps, the pumps would run as long as you were close enough to the fortress, but once you moved far enough away, the site got offloaded, causing the pumps to stop.

====Common mistakes====
* Orienting a pump incorrectly, and/or not having a proper open liquid source.
* Pumping water into an area with a path to other parts of your fortress. (The pump may work perfectly - the fortress quickly [[flood]]s.)
* Expecting water to rise up above the level of a pump.
* Building a wall attached only to the input tile - this leaves a diagonal leak between the wall and the output tile unless sealed there. (If that's not a problem, don't worry about it.)
* Having stairs in the liquid of the intake tile. Stairs block the intake tile, thus rendering the pump useless, even though liquids usually ignore stairs. The liquid output tile can be any liquid-passable tile.
* Not channeling below the [[impassable tile]] of an individual pump in a pump stack. This is how power is transmitted to the pump below.
* Pumping magma into a lower z-level (same as the source) and then being surprised it is forced back up to the pump's z-level further down the line (where you were planning your magma forges, for example.)

== Example layouts ==
=== Single pump ===

[[Image:jt_screwpump.png|frame|left|This screw pump delivers water (or magma) from the lower level (on the right in this diagram) to the same z-level as the screw pump (on the left). When placing the screw pump to be built, the output tile would be on the left - that entire tile is impassible to movement and fluids.]] 

=== Pump stack ===
[[File:PumpStack2010.png|thumb|right|300px|'''Illustrated Side View of a Pump Stack.''']]
[[File:PumpStackTopView.png|thumb|right|300px|'''Illustrated Top View of a Pump Stack Layer.''']]
[[File:Pumpstack.gif|thumb|right|'''Animation showing the general construction using an isometric projection.''']]

A pump stack is a method used to draw water or magma vertically across multiple z-levels requiring a minimum of parts. The basic functionality is possible because the output side of the pump can be built over open space with a machine component located directly below, in this case another screw pump. Note that for power to properly transfer, the input side of the pump must line up with the output side of the pump on the floor above it through a space in the floor, as in the illustration. While pumps can transfer power to and from either tile, you need flooring below the pump's input side, because that's where the dwarf stands to construct the pump.

A pump stack minimizes the amount of machinery required to lift water or magma by allowing for power to be supplied directly to only the most accessible pump (typically the topmost) which in turn allows the player to operate a stack limited only by how many windmills/water wheels they can fit into the area. The price of optimal parts density is fragility: each pump relies on the pump below it for support. If [[forgotten beast|anything]] breaks a pump in your stack, every pump above it will be disassembled. This means that a single pump accidentally assembled with non-[[magma-safe]] parts can cause an entire magma pump stack to spontaneously disassemble.

To prevent such a disassembly cascade, you can "anchor" each pump with a mechanism or stable horizontal axle. For water applications, placing this axle on the output tile of the pump also conveniently prevents plant growth; for magma applications, the axle must be protected from the magma, unless you are using [[nether-cap]].

Typical applications for a pump stack include moving magma from a lower level (often the [[magma sea]]) up to a convenient level for forges and furnaces, extracting water from a flooded fort, raising water for a decorative [[waterfall]] (and extracting it afterwards), or any other purpose that requires water/magma on a z-level significantly above its current location.

The 'Illustrated Top View of a Pump Stack Layer' shows a basic section of a pump stack. Only the door (or a floodgate) on the containment side is strictly necessary in order to prevent flooding. Two doorways are used here, each lining up with the solid ground within the pump assembly, in order to prevent workers from trapping themselves after digging channels or assembling the pump.

Be warned: pump stacks move water '''fast.''' If you are pumping from a large reservoir into an open area, be prepared for a huge outflow, roughly akin to the kind of water dump you'd get if the whole reservoir was balanced above the pump output and then released. If you are using pumps to empty a large underground reservoir (or, say, a flooded fortress) onto open land, use an aqueduct or some other method to make sure the pump system outlet is a good distance away from anything you wouldn't want to get drenched.

As an alternative to a large reservoir, it is also possible to combine a [[Dwarven Atom Smasher]] with the top layer of the pump stack to create a "vacuum cleaner" of sorts.

====Tips====

* Ramps can be used in place of channeling. Liquids will transmit through ramps, unlike stairs, and when pumps are constructed they annihilate the ramp they're built on much as walls do. Power will still be transmitted, so they don't need to be removed by miners prior to pump construction. Ramps make it virtually impossible to strand your miners and allow the stack to be dug out using only access doorways on the input side of the pump, so no construction or doors are later needed to eliminate leaks. A pump stack can be very rapidly carved out with this method as even if a miner/builder is trapped on the containment side of a pump, they can walk up the ramp to the intake side of the pump above and walk out.
* Power can be transmitted to the stack by channeling out the tile directly above the topmost pump and mounting a gear assembly. If the gear assembly is supported by an adjacent gear assembly or horizontal axle on a stable floor (be careful to not have that adjacent gear assembly disengage via lever), this will allow the stack to hang from the gear assembly. If a lower pump needs to be removed, or should self-destruct, the problem of the entire pump stack disassembling described above is eliminated. Further, if the supported gear assembly is built first, the pump stack can be built both from the top and bottom simultaneously, halving construction time, assuming that sufficient attention is paid to make sure that the pumps will align with the proper orientation when the two partial stacks meet. Properly channeling/ramping out the stack should ensure this.
* While expensive in both power and mechanisms, it is also possible to power a pump stack horizontally with a gear assembly or power source connected directly to the side of the pump (preferably to the input side). This is most useful when you are building an above ground pump stack. You can attach an axle or gear assembly to the side or end of the screw pump's output tile, but it's generally not a good idea because they do not block fluids, which would allow the pump's outlet fluid to leak along a diagonal. Unless that's your plan.
* When pumping water, make sure all tiles on the containment side of the stack are covered with a [[ramp]], [[road]], or [[fortification]] to prevent subterranean trees from growing and blocking flow of the stack. Fortifications have the added advantage that, when used with water, they will never become muddy.
* When using pumps to empty a large body of liquid, make sure that the pump outlet is properly isolated from the intake, otherwise the liquid can flow backwards into the pump's walkable tile and cause problems (such as flushing the dwarf operating it into the body of liquid being drained).
* The order in which the screw pumps were constructed matters. If built from lowest to highest, they will be able to transfer liquids one z-level per tick. However, if built from highest to lowest, they will transport liquids all the way from the bottom to the top in just one tick.

===Improved magma pump stack===

Because a pump stack pumping magma is known to cause significant [[Maximizing_framerate|lag]], a [http://www.bay12forums.com/smf/index.php?topic=72296.0 new type of pump stack] was developed by [http://www.bay12forums.com/smf/index.php?action=profile;u=19835 NecroRebel] that causes a much smaller drop in [[FPS]]. Changing the single tile magma chamber at the output of every pump from a 1 by 1 to a 3 by 3 area reduces the lag to 1/15th of that caused by the original pump stack. The designer hypothesizes that the larger chamber requires many fewer temperature calculations when magma is pumped in or out; that also implies that there will be no FPS improvement for water pumps by using this design.

====Newer magma pump breakthroughs====

Newer breakthroughs in magma pump design have since made the 3x3 reservoir design obsolete.
Testing has found a [http://www.bay12forums.com/smf/index.php?topic=72296.msg1772802#msg1772802 1x3 head-over-tail variation] (which is very similar to [[Screw_pump#Pump_stack|the typical 1 by 1 pump stack]]) as well as a [http://www.bay12forums.com/smf/index.php?topic=72296.msg1795907#msg1795907 2x3 head-over-head variation]. Both of these new designs require less space and work as effectively as his original 3x3 reservoir head-over-head design, with no significant drop in FPS. The 1x3 head-over-tail design has the advantages of requiring the least amount of space and being simple to refit from the standard 1 by 1 water pump stack.

{{d for dwarf}}
:From the components used in construction, a DF pump can be imagined as a simple [http://en.wikipedia.org/wiki/Archimedes%27_screw archimedes screw]. However, given its effect on contaminated water, the lack of pump components *in* the water itself, and general dwarven mechanical aptitude, it seems more accurate - and more dwarfy - to infer the speed of rotation to be high enough that the building actually operates as a [http://en.wikipedia.org/wiki/Turbomolecular_pump turbopump] using the principle of [http://en.wikipedia.org/wiki/Vacuum_distillation vacuum distillation] to simultaneously transfer and purify water. Some Dwarven historians say that ancient screw pumps were also used as a torture device used to interrogate goblins and hippies.

[[File:Schroef van Archimedes.jpg|thumb|300px|center|A modern era screw pump, though still mechanically different than the game's.]]
{{buildings}}