Dwarf Fortress Wiki - User contributions [en]

Creature token

2015-09-02T23:46:25Z

Hikaruchu: /* Made ORIENTATION tag contain more detailed information */

{{Quality|Fine|18:45, 26 August 2014 (UTC)}}
{{av}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|ADOPTS_OWNER}}
| Caste
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| {{text anchor|ALCOHOL_DEPENDENT}}
| Caste
|
| Creature needs alcohol to get through the working day, choosing to drink booze instead of water if possible. Going sober for too long reduces speed.

|-
| {{text anchor|ALL_ACTIVE}}
| Caste
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| {{text anchor|ALTTILE}}
| Creature
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| {{text anchor|AMBUSHPREDATOR}}
| Caste
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| {{text anchor|AMPHIBIOUS}}
| Caste
|
| Allows a creature to breathe with or without [[water]].

|-
| {{text anchor|APP_MOD_DESC_RANGE}}
| Caste
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 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:max of 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}}
| Special
|
*CV TEMPLATE NAME
| Applies the specified [[creature variation token|creature variation]].

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

|-
| {{text anchor|AQUATIC}}
| Caste
|
| Creature can breathe in water, but air-drowns on dry land.

|-
| {{text anchor|ARENA_RESTRICTED}}
| Caste
|
| Does not appear in arena mode list.

|-
| {{text anchor|ARTIFICIAL_HIVEABLE}}
| Creature
|
| Can be kept in artificial hives by beekeepers.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
| Caste
|
| Does not attack or frighten creatures with the NATURAL 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:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| {{text anchor|ATTACK_TRIGGER}}
| Caste
| pop:exported wealth:created wealth
| Specifies when a [[megabeast]] will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|BEACH_FREQUENCY}}
| Caste
| integer
| [[Whale]]s and [[Sea nettle jellyfish|jellyfish]] have this. Controls the beaching frequency of the creature.

|-
| {{text anchor|BENIGN}}
| Caste
|
| The creature is non-aggressive by default and will never automatically be engaged by companions or soldiers. It will run away from any creatures that are not friendly to it.

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

|-
| {{text anchor|BLOOD}}
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| {{text anchor|BLOODSUCKER}}
| Caste
|
| Seems to be required to make the creature denouncable 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:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
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.

|-
| {{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:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''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, PlanName:type:type:type:etc.
| loads a plan 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:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A [[Purring maggot|maggot]] would only need:<br />
''[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:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a [[minotaur]]. His birth size would be 10,000 cm<sup>3</sup> (~10 kg). At 1 year and 168 days old he would be 50,000 cm<sup>3</sup> (~50 kg). And as an adult (at 12 years old) he would be 220,000 cm<sup>3</sup> 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 CARNIVORE.

|-
| {{text anchor|BP_ADD_TYPE}}
| Caste
|
|

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

<div align="center">
{{alphabetical TOC}}
</div>

==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 skills and can have professions. Note that this token makes the creature unable to be butchered 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 talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| {{text anchor|CANNOT_CLIMB}}
| Caste {{Verify}}
|
| Creature cannot climb, even if it has free grasps.

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

|-
| {{text anchor|CANNOT_UNDEAD}}
| Caste
|
| Acts as NOT_LIVING, except that [OPPOSED_TO_LIFE] creatures will attack them.

|-
| {{text anchor|CANOPENDOORS}}
| Caste
|
| Allows the creature to open doors that are set to be unpassable for pets.

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

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

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

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

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

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

|-
| {{text anchor|CASTE_NAME}}
| Caste
| singular:plural:adjective
| Caste-specific NAME.

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

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

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

|-
| {{text anchor|CASTE_SPEECH}}
| Caste
| speech file
| Caste-specific SPEECH.

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

|-
| {{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 CAN_DO_INTERACTION 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 child stage.

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

|-
| {{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.
e.g. [CLUSTER_NUMBER:1:3]

|-
| {{text anchor|CLUTCH_SIZE}}
| Caste
|
*min
*max
|Number of eggs 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
|
| Any civilization with USE_COMMON_DOMESTIC tag (humans, dwarves) has domesticated this creature by default and always has access to it, even without any wild populations. Useless without PET, PACK_ANIMAL, WAGON_PULLER or MOUNT tags and invalid on FANCIFUL creatures.

|-
| {{text anchor|CONVERTED_SPOUSE}}
| Caste
|
| Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs 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 for mussels, for one.

|-
| {{text anchor|CRAZED}}
| Caste
|
| Creature is 'berserk' and will attack all other creatures, except members of its own species that ALSO have the CRAZED tag.

|-
| {{text anchor|COPY_TAGS_FROM}}
| Special
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| {{text anchor|CREATURE_CLASS}}
| Caste
|
*classname
| An arbitrary creature classification. Can be set to anything, but only existing uses are GENERAL_POISON (used in syndromes) and EDIBLE_GROUND_BUG (valid targets for GOBBLE_VERMIN_x tokens). A single creature can have multiple classes. Eligibility for certain entity positions can also be permitted or restricted by this tag.

|-
| {{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 if the creature is active at twilight.

|-
| {{text anchor|CURIOUSBEAST_EATER}}
| Caste
|
| Allows a creature to steal and eat edible items from a site.

|-
| {{text anchor|CURIOUSBEAST_GUZZLER}}
| Caste
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| {{text anchor|CURIOUSBEAST_ITEM}}
| Caste
|
| Allows a creature to steal things (apparently the highest value it can find). If the creature goes on rampages in worldgen, it will often steal items instead of attacking. Kea birds are infamous for this.

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

<div align="center">
{{alphabetical TOC}}
</div>

==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. Cannot be specified in user-defined raws.

|-
| {{text anchor|DESCRIPTION}}
| Caste
| text
| A brief description of the creature type.

|-
| {{text anchor|DIE_WHEN_VERMIN_BITE}}
| Caste
|
| Dies upon attacking. Used for [[bee]] stings.

|-
| {{text anchor|DIFFICULTY}}
| Caste
| integer
| Increases experience gain during adventure mode. Creatures with 11 or higher are not assigned for quests in adventure mode.

|-
| {{text anchor|DIURNAL}}
| Caste
|
| Sets if the creature is active in day.

|-
| {{text anchor|DIVE_HUNTS_VERMIN}}
| Caste
|
| Found on [[peregrine falcon]]s. The creature hunts vermin by diving from the air. Does not seem to work on tame creatures.

|-
| {{text anchor|DOES_NOT_EXIST}}
| Creature
|
| Creature does not actually exist; used for a few [[fanciful]] creatures of myth.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 butchered. Used with EXTRA_BUTCHER_OBJECT.

|-
| {{text anchor|EBO_SHAPE}}
| Caste
| gem shape
| The shape of the extra item of the creature upon butchering. Used with EXTRA_BUTCHER_OBJECT.

|-
| {{text anchor|EGG_MATERIAL}}
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will 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 eggs.

|-
| {{text anchor|EQUIPMENT_WAGON}}
| Creature
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| {{text anchor|EQUIPS}}
| Caste
|
| Allows the creature to wear or wield items.

|-
| {{text anchor|EVIL}}
| Creature
|
| Creature is considered evil and will only show up in evil biomes. Civilizations with USE_EVIL_ANIMALS can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming.

|-
| {{text anchor|EXTRA_BUTCHER_OBJECT}}
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when butchered (typically a gizzard stone), defined by EBO_ITEM and EBO_SHAPE.

|-
| {{text anchor|EXTRACT}}
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| {{text anchor|EXTRAVISION}}
| Caste
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 for things like dragons and other legendary creatures. Conflicts with {{token|COMMON_DOMESTIC|c}}

|-
| {{text anchor|FEATURE_ATTACK_GROUP}}
| Caste
|
| Found on subterranean animal-man tribals.

|-
| {{text anchor|FEATURE_BEAST}}
| Caste
|
| Found on [[forgotten beast]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|FEMALE}}
| Caste
|
| The creature is female and can bear young. Usually determined inside a caste.

|-
| {{text anchor|FIREIMMUNE}}
| Caste
|
| The creature is immune to FIREBALL and FIREJET attacks.

|-
| {{text anchor|FIREIMMUNE_SUPER}}
| Caste
|
| The creature is immune to DRAGONFIRE attacks. Implies {{token|FIREIMMUNE|c}}.

|-
| {{text anchor|FISHITEM}}
| Caste
|
| Needs to be cleaned at a fishery

|-
| {{text anchor|FIXED_TEMP}}
| Caste
| temperature
| The natural heat generated by the creature.

|-
| {{text anchor|FLEEQUICK}}
| Caste
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| {{text anchor|FLIER}}
| Caste
|
| Allows a creature to fly. 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.

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

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|GAIT}}
| Caste
|
* type (WALK, CLIMB, SWIM, CRAWL, or FLY)
* gait name
* full speed
* build up time:max turning speed:start speed (or NO_BUILD_UP for instant use)
* energy use
* Optional flags:
** LAYERS_SLOW - if gait is slowed by increased weight
** STRENGTH - if gait is affected by strength stat
** AGILITY - if gait is affected by agility stat
** STEALTH_SLOWS:penalty - if gait is slowed by being stealthed
| Defines a gait at which the creature can move. See [[Gait]] for more information.

|-
| {{text anchor|GENERAL_BABY_NAME}}
| Creature
| singular:plural
| BABYNAME applied regardless of caste.

|-
| {{text anchor|GENERAL_CHILD_NAME}}
| Creature
| singular:plural
| CHILDNAME applied regardless of caste.

|-
| {{text anchor|GENERAL_MATERIAL_FORCE_MULTIPLIER}}
| Caste
| A:B
| Attacks against the creature have their force modified by A/B. For example, 1:2 will halve the force of an attack made against the creature. {{verify}}

|-
| {{text anchor|GENERATED}}
| Creature
|
| Found on procedurally generated creatures like [[Forgotten beast]]s, (biome name) [[titan]]s, [[Demon]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|GETS_INFECTIONS_FROM_ROT}}
| Caste
|
| Creature can get infections from necrotic tissue.

|-
| {{text anchor|GETS_WOUND_INFECTIONS}}
| Caste
|
| This creature's wounds can become infected if left untreated for too long.

|-
| {{text anchor|GLOWCOLOR}}
| Creature
|
*foreground
*background
*brightness
| The colour of the creature's GLOWTILE.

|-
| {{text anchor|GLOWTILE}}
| Creature
| ascii character
| If present, the being glows in the dark (generally used for Adventure 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 CASTE_GLOWTILE 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 USE_GOOD_ANIMALS 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. See [[Pasture]] for details on its issues.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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, and COLLECT_WEALTH. These require the creature to have a lair to work properly, and also don't seem to work on creatures who are not (SEMI)MEGABEASTs or NIGHT_CREATURE_HUNTERs.

|-
| {{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.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> 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|HFID}}
| Creature
| Integer (generic token?)
| Found on generated [[angel]]s. Seemingly identifies a historical figure with said hist figure ID, possibly to associate it with hist figure.

|-
| {{text anchor|HIVE_PRODUCT}}
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| {{text anchor|HOMEOTHERM}}
| Caste
|
| Default 'NONE'. The creature's normal body [[temperature]]

|-
| {{text anchor|HUNTS_VERMIN}}
| Caste
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 AQUATIC 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. Keep booze away from critters with this tag. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of certain materials.

|-
| {{text anchor|INTELLIGENT}}
| Caste
|
| Alias for [CAN_SPEAK] + [CAN_LEARN] but additionally keeps creatures from being butchered by the AI during World-Gen and Post-Gen. In Fortress Mode CAN_LEARN is enough.

|-
| {{text anchor|ITEMCORPSE}}
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc.).

|-
| {{text anchor|ITEMCORPSE_QUALITY}}
| Caste
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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, and 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" will appear on any given map (possibly two groups on "savage" maps). 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
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| {{text anchor|LAYS_EGGS}}
| Caste
|
| Creature lays eggs instead of giving birth to live young.

|-
| {{text anchor|LAYS_UNUSUAL_EGGS}}
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays a particular item instead of regular eggs.

|-
| {{text anchor|LIGAMENTS}}
| Caste
|
* [[material token]]
*healing rate
| Creature has ligaments in its bones. Cutting the bone tissue severs them, 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 - included modded dwarves. Retired as of v0.40.14.

|-
| {{text anchor|LISP}}
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| {{text anchor|LITTERSIZE}}
| Caste
|
* minimum
* maximum
| Determines the range of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| {{text anchor|LOCKPICKER}}
| Caste
|
| Lets a creature open doors 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.
|}

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|MAGICAL}}
| Caste
|
| Unknown.

|-
| {{text anchor|MAGMA_VISION}}
| Caste
|
| Creature's able to see while covered in magma.

|-
| {{text anchor|MALE}}
| Caste
|
| The creature is 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]]
*A:B
| Set the force multiplier of a specific material against the creature to A/B. For example, 10:1 multiplies the force by 10. {{verify}}

|-
| {{text anchor|MATUTINAL}}
| Caste
|
| Sets if the creature is active in dawn.

|-
| {{text anchor|MAXAGE}}
| Caste
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age. Note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

|-
| {{text anchor|MEANDERER}}
| Caste
|
| Gives a creature random movement.

|-
| {{text anchor|MEGABEAST}}
| Caste
|
| A 'boss' creature. A small number of the creature 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.

|-
| {{text anchor|MENT_ATT_CAP_PERC}}
| Caste
|
*[[DF2012: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
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a 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
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| {{text anchor|MILKABLE}}
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be milked in the farmer's workshop. The frequency is the amount of time units the creature needs to "recharge".

|-
| {{text anchor|MISCHIEVIOUS}}
| Caste
|
| Alias for MISCHIEVOUS.

|-
| {{text anchor|MISCHIEVOUS}}
| Caste
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "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, but enemy siegers may arrive with cavalry.

|-
| {{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 {{Verify}}
|
| Allows the creature to have all-around vision as long as it has multiple heads(?) that can see. {{Verify}}

|-
| {{text anchor|MULTIPLE_LITTER_RARE}}
| Caste
|
| Makes the species usually produce a single offspring per birth, occasionally producing twins or triplets using typical real-world human probabilities. Requires [[Creature_token#FEMALE|FEMALE]]. Compare with [[Creature_token#LITTERSIZE|LITTERSIZE]]. If LITTERSIZE and MULTIPLE_LITTER_RARE are both absent, one offspring is guaranteed per birth.

|-
| {{text anchor|MUNDANE}}
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 CASTE_NAME instead. If left undefined, the creature will be labeled as "nothing" by the game.

|-
| {{text anchor|NATURAL}}
| Caste
|
| Animal is considered to be natural. Creatures with AT_PEACE_WITH_WILDLIFE will not fight with them.

|-
| {{text anchor|NATURAL_ANIMAL}}
| Caste
|
| Alias of NATURAL.

|-
| {{text anchor|NATURAL_SKILL}}
| Caste
| [[Skill_token|Skill token]]:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. A value of 16 is legendary. Requires CAN_LEARN or INTELLIGENT to function in .25 or earlier.

|-
| {{text anchor|NIGHT_CREATURE_BOGEYMAN}}
| Caste
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. This does not affect the creature's presence elsewhere, such as for generated megabeasts, normal creatures, entity members, etc. Setting the number of bogeyman types to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| {{text anchor|NIGHT_CREATURE_HUNTER}}
| Caste
|
| 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. If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

This tag causes the usual behaviour of [[werebeast]]s 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.

|-
| {{text anchor|NO_AUTUMN}}
| Caste
|
| This 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 dizzy.

|-
| {{text anchor|NO_DRINK}}
| Caste
|
| Creature does not need to drink.

|-
| {{text anchor|NO_EAT}}
| Caste
|
| Creature does not need to eat.

|-
| {{text anchor|NO_FEVERS}}
| Caste
|
| Creature cannot suffer fevers.

|-
| {{text anchor|NO_GENDER}}
| Caste
|
| Creature has no gender.

|-
| {{text anchor|NO_PHYS_ATT_GAIN}}
| Caste
|
| The affected caste cannot gain any physical skills.

|-
| {{text anchor|NO_PHYS_ATT_RUST}}
| Caste
|
| The affected caste cannot lose any physical skills.

|-
| {{text anchor|NO_SLEEP}}
| Caste
|
| Creature does not need to sleep.

|-
| {{text anchor|NO_SPRING}}
| Caste
|
| This creature caste does not appear in [[Calendar|spring]].

|-
| {{text anchor|NO_SUMMER}}
| Caste
|
| This creature caste does not appear in [[Calendar|summer]].

|-
| {{text anchor|NO_THOUGHT_CENTER_FOR_MOVEMENT}}
| Caste
|
| Creature doesn't require an organ with the [THOUGHT] 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
|
| This 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 [BREATHE] parts in body. Cannot drown or be strangled.

|-
| {{text anchor|NOCTURNAL}}
| Caste
|
| Sets if the creature is active in night.

|-
| {{text anchor|NOEMOTION}}
| Caste
|
| The creature has no emotions, and does not rage.

|-
| {{text anchor|NOEXERT}}
| Caste
|
| Creature can't become tired or over-exerted from taking too many combat actions.

|-
| {{text anchor|NOFEAR}}
| Caste
|
| Creature doesn't feel fear and will never run away from battle.

|-
| {{text anchor|NOMEAT}}
| Caste
|
| Creature will not drop meat when 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 butchered.

|-
| {{text anchor|NOSKULL}}
| Caste
|
| Creature will not drop a skull on butcher, 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 creature.

|-
| {{text anchor|NOSTUN}}
| Caste
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy.{{verify}} If this creature must eat and drink while playing, it WILL die.

|-
| {{text anchor|NOT_BUTCHERABLE}}
| Caste
|
| Cannot be butchered

|-
| {{text anchor|NOT_LIVING}}
| Caste
|
| Cannot be raised from the dead.

|-
| {{text anchor|NOTHOUGHT}}
| Caste
|
| Creature doesn't require a [THOUGHT] body part to survive. If it does not have NO_THOUGHT_CENTER_FOR_MOVEMENT as well, it will be unable to use any attacks other than the default 'push'. Has the added effect of preventing speech.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 can be smelled. Zero is odorless. Default is 50.

|-
| {{text anchor|ODOR_STRING}}
| Caste
| string
| What the creature smells 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. Used for [[Undead]].

|-
| {{text anchor|ORIENTATION}}
| Caste
| MALE/FEMALE:disinterested chance:lover-possible chance:commitment-possible 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 become lovers but not marry, the third decides if the creature will marry this sex. The values themselves are simply ratios and do not need to add up to any particular value.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==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. Currently only used by merchants without wagons. 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 paralyzing special attacks.

|-
| {{text anchor|PATTERNFLIER}}
| Caste
|
| Unknown. No creatures currently have this token.

|-
| {{text anchor|PEARL}}
| Caste
|
| In earlier versions, creature would generate pearls. Does nothing in the current version.

|-
| {{text anchor|PENETRATEPOWER}}
| Caste
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles.

|-
| {{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 tamed in Fortress mode. Prequisite 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.

|-
| {{text anchor|PET_EXOTIC}}
| Caste
|
| Allows the creature to be tamed in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen without 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.

|-
| {{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 PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
| {{text anchor|PHYS_ATT_CAP_PERC}}
| Caste
|
*[[DF2012: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
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a 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
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. 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 SET_BP_GROUP.

|-
| {{text anchor|PLUS_MATERIAL}}
| Creature
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| {{text anchor|POP_RATIO}}
| Caste
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

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

|-
| {{text anchor|POWER}}
| Caste
|
| Allows the being to represent itself as a deity. Requires CAN_SPEAK 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.

|-
| {{text anchor|PREFSTRING}}
| Creature
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| {{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 CASTE_PROFESSION_NAME 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 badgers so hardcore.

|-
| {{text anchor|PUS}}
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| The creature has pus. Specifies the stuff secreted by infected wounds.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 creature's remains are called.

|-
| {{text anchor|REMAINS_COLOR}}
| Caste
|
| What color creature's remains are.

|-
| {{text anchor|REMAINS_ON_VERMIN_BITE_DEATH}}
| Caste
|
| Goes with VERMIN_BITE and DIE_WHEN_VERMIN_BITE, 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 a creature.

|-
| {{text anchor|REMOVE_TISSUE}}
| Creature
|
*material token
| Removes a tissue from a creature.

|-
| {{text anchor|RETRACT_INTO_BP}}
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*TYPE, CATEGORY or TOKEN
| 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.

|-
| {{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 his feet. Requires HUNTS_VERMIN, obviously.

|-
| {{text anchor|ROOT_AROUND}}
| Caste
|
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventure Mode, spawns vermin edible by this creature in Fortress Mode.

|}

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|SECRETION}}
| Caste
|
* [[material token]]
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
*trigger
| creates a secreted material on given tissue on a given part of the body. Valid triggers are:
*CONTINUOUS
*EXTREME_EMOTION
*EXERTION

|-
| {{text anchor|SELECT_ADDITIONAL_CASTE}}
| Creature
|
*caste name
| adds an additional previously defined caste to the selection. Used after SELECT_CASTE.

|-
| {{text anchor|SELECT_CASTE}}
| Creature
|
*caste name, or ALL
| selects a previously defined caste

|-
| {{text anchor|SELECT_MATERIAL}}
| Creature
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| {{text anchor|SEMIMEGABEAST}}
| Caste
|
| Essentially the same as MEGABEAST, but more of them are created during worldgen.

|-
| {{text anchor|SENSE_CREATURE_CLASS}}
| Caste
|
* Creature class
* [[Tilesets|Tile]]
* [[Color|Color]]
| Allows creature to sense creatures with a certain creature class through walls, floors etc. Sense will be with tile and color specified.

|-
| {{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|SET_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| {{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 (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| {{text anchor|SKILL_LEARN_RATE}}
| Caste
| [[skill_token]]:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| {{text anchor|SKILL_LEARN_RATES}}
| Caste
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| {{text anchor|SKILL_RATE}}
| Caste
| [[skill_token]]:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| {{text anchor|SKILL_RATES}}
| Caste
|
*% of improvement points you get
*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 CAN_LEARN or INTELLIGENT 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 CAN_LEARN or INTELLIGENT 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 CAN_LEARN or INTELLIGENT to function.

|-
| {{text anchor|SLOW_LEARNER}}
| Caste
|
| Shorthand for [CAN_LEARN] + [SKILL_LEARN_RATES:50].{{verify}} Used for ogres and giants. Applicable to player races. Prevents a player from recruiting nobility, even basic ones.

|-
| {{text anchor|SMALL_REMAINS}}
| Caste
|
| Creature leaves a "remains" instead of a corpse. Used for 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|SPECIFIC_FOOD}}
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Creature can will only graze or eat the designated plant or creature parts.

|-
| {{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 name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] 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 SPOUSE_CONVERTED.

|-
| {{text anchor|SPOUSE_CONVERTER}}
| Caste
|
| If the creature has the NIGHT_CREATURE_HUNTER tag, it will kidnap SPOUSE_CONVERSION_TARGETs and transform them into the caste of its species with the CONVERTED_SPOUSE tag during worldgen. It may also start families this way.

|-
| {{text anchor|STANCE_CLIMBER}}
| Caste {{verify}}
|
| Caste does not require GRASP body parts to climb -- it can climb with STANCE parts instead.

|-
| {{text anchor|STANDARD_GRAZER}}
| Caste
|
| Acts as GRAZER 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 in all default creature RAWs for grazers.

|-
| {{text anchor|SUPERNATURAL}}
| Caste
|
| Gives the creature knowledge of any secrets with SUPERNATURAL_LEARNING_POSSIBLE that match its spheres. Other effects are unknown.

|-
| {{text anchor|SWIMS_INNATE}}
| Caste
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. However, Fortress mode AI never paths into water anyway, so it's less useful there.

|-
| {{text anchor|SWIMS_LEARNED}}
| Caste
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 bones. Cutting the bone tissue severs them, disabling motor function if the target is a limb.

|-
| {{text anchor|THICKWEB}}
| Caste
|
| The creature's webs can catch larger creatures.

|-
| {{text anchor|TISSUE}}
| Creature
| name
| Begins defining a tissue in the creature file.

|-
| {{text anchor|TITAN}}
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| {{text anchor|TL_COLOR_MODIFIER}}
| Caste
| COLOR:freq:COLOR:freq etc.
| Creates a list of color patterns, giving each a relative frequency.

|-
| {{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 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 where the color change begins

|-
| {{text anchor|TRADE_CAPACITY}}
| Caste
|
| How much the creature can carry when used by merchants.

|-
| {{text anchor|TRAINABLE}}
| Caste
|
| Shortcut for [TRAINABLE_HUNTING] + [TRAINABLE_WAR].

|-
| {{text anchor|TRAINABLE_HUNTING}}
| Caste
|
| Can be trained as a hunting beast, increasing speed.

|-
| {{text anchor|TRAINABLE_WAR}}
| Caste
|
| Can be trained as a war beast, increasing strength and endurance.

|-
| {{text anchor|TRANCES}}
| Caste
|
| Allows the creature to go into martial trances.

|-
| {{text anchor|TRAPAVOID}}
| Caste
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| {{text anchor|TRIGGERABLE_GROUP}}
| Creature
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| {{text anchor|TSU_NOUN}}
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 evil/good tags.

|-
| {{text anchor|UNDERGROUND_DEPTH}}
| Creature
|
*mindepth
*maxdepth
| Depth 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. A single argument may be used instead of min and max. Only magma creatures use 4 or 5 in the default raws. [[Demon]]s use only 5:5; user-defined creatures with both this depth and [FLIER] will take part in the initial wave from the HFS alongside generated demons. Without [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 available at depth 1.

|-
| {{text anchor|UNDERSWIM}}
| Caste
|
| Creature swims under the water and can't be seen. Seems to be a relic from the 2D era.

|-
| {{text anchor|UNIQUE_DEMON}}
| Caste
|
| Typically 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. Cannot be specified in user-defined raws.

|-
| {{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 SKULKING civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

<div align="center">
{{alphabetical TOC}}
</div>

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

|-
| {{text anchor|VEGETATION}}
| Caste
|
| The creature is made of swamp stuff. Used for [[grimeling]]s.

|-
| {{text anchor|VERMIN_BITE}}
| Caste
|
*chance of occurrence{{verify}}
*verb (bitten, stung, etc.)
* [[material token]]
| Vermin bites, and injects something.

|-
| {{text anchor|VERMIN_EATER}}
| Creature
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distinct from VERMIN_ROTTER.

|-
| {{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 hate the creature and get unhappy thoughts when around it.

|-
| {{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 traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| {{text anchor|VERMIN_ROTTER}}
| Creature
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Attracted to rotting stuff left in the open. Speeds up decay?{{verify}}

|-
| {{text anchor|VERMIN_SOIL}}
| Creature
|
| The creature randomly appears near dirt or mud.

|-
| {{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 [AT_PEACE_WITH_WILDLIFE] + [RETURNS_VERMIN_KILLS_TO_OWNER] + [HUNTS_VERMIN] + [ADOPTS_OWNER].

|-
| {{text anchor|VESPERTINE}}
| Caste
|
| Sets if the creature is active in evening.

|-
| {{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 {{Verify}}
|
*binocular vision arc
*non-binocular vision arc
| The width of the creature's vision arcs. The first number is binocular vision, the second is non-binocular vision.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==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 webs, and defines what the webs are made of.

|-
| {{text anchor|WEBIMMUNE}}
| Caste
|
| The creature will not get caught in thick webs.
|}

==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
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

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

|-
| {{text anchor|SPECIALATTACK_INJECT_EXTRACT}}
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| {{text anchor|SPECIALATTACK_INTERACTION}}
| Caste
| interaction
| When this attack lands successfully, an interaction with I_SOURCE:ATTACK 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.

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

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying properties of previously defined tissues. (See also [[Tissue definition token]])

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

|-
| {{text anchor|PLUS_TISSUE_LAYER}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| {{text anchor|PLUS_TL_GROUP}}
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| {{text anchor|SELECT_TISSUE}}
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| {{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.
| Selects a tissue layer for descriptor and cosmetic purposes.
[SELECT_TISSUE_LAYER:SKIN:BY_TYPE:UPPERBODY]

|-
| {{text anchor|SET_LAYER_TISSUE}}
| Caste
|
| Sets a tissue layer to be made of a different tissue.

|-
| {{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 Iron Man:<br>
[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|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_CONNECTS}}
| Caste
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| {{text anchor|TL_HEALING_RATE}}
| Caste
|
| Presumably 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
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| {{text anchor|TL_RELATIVE_THICKNESS}}
| Caste
|
| Seems to set new relative thickness for selected tissue layers.

|-
| {{text anchor|TL_VASCULAR}}
| Caste
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]

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

Modding

2015-09-02T23:38:20Z

Hikaruchu: /* Basics of DF modding */

{{Quality|Exceptional|14:13, 7 November 2013 (UTC)}}
{{av}}
This is intended to be a guide to inform those new to DF 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.

'''See also:''' [[:Category:DF2014:Modding]]

= Modding Guide =

== 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 [http://dwarffortresswiki.org/index.php/Token here.]

== Basics of DF modding ==

All the base data that can be edited by prospective modders can be found in the \raw\ folder. This folder contains 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.

Within the \raw\objects folder are a large number of text files - these are the [[raw file|raw files]], and editing them is quite easy - you can also create your own if you wish. For now, take a look at one of the existing files. For example if you open creature_standard.txt it should look something like this:

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 won't be parsed correctly by the game. You may have also noticed the file naming scheme - this is also important; files containing creatures have names starting with "creature_", entity file names must begin with "entity_", etc..

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. 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 adding objects. It makes removing mods far easier.
* When adding files, all you need to include to ensure proper references are maintained is the token identifier's. The game will load up all *.txt in the raw folder, and searches through them by tokens. For example: You can add a new pair of leather boots and not even have to add it to the item_shoes.txt file, but rather make your own file, say item_shoes_new.txt and ensure you have the token listed, ex. [ITEM_SHOES:ITEM_SHOES_BOOTS_NEW], that's how the game will look for the item.
* If you want to edit an already-existing creature, always back up the files you plan on editing to a different location. Since v0.31.22, the game no longer loads backup files, but duplicate entries are still a very bad thing.
* When a new world is generated, all the raw files get copied into a \raw\ folder within the applicable save folder. If you want to change something within a world that's already been generated, you'll have to edit those files, not the ones in ~DF\raw\objects.
* 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... which are coincidentally what we'll be talking about next.

== Modding civilizations (entities) ==

Entities - the objects that determine how civilizations work - are stored in entity_default.txt (though, like all other files, you may add more). They follow the same format as any other raw file:

entity_default

[OBJECT:ENTITY]

[ENTITY:ENTITYNAME]
[CREATURE:CREATURETYPE]
[TRANSLATION:LANGUAGETYPE]
[BIOME_SUPPORT:BIOMETOKEN:FREQENCY]
...[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 will therefore be 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 and 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 was to type:

[BIOME_SUPPORT:ANY_FOREST:1]
[BIOME_SUPPORT:SAVANNA:2]

This would have very much the same effect as:

[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 CIV_CONTROLLABLE token, which lets you control the civ in fortress mode, the INDIV_CONTROLLABLE token, which allows you to play the civ in adventure mode as an outsider, and the ADVENTURE_TIER 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 CIV_CONTROLLABLE 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 obfuscating at first, so I'll run through it. Let's refer to the DWARF entity:

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

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

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

== Modding the 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 bodyparts. 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 bodyparts, tissues, and materials. We're going to show you part of the creature entry for a bronze colossus (bear with us):

...
[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 bodyparts. 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 bodypart category (BY_CATEGORY), bodypart 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 bodypart). This is followed by the tissue to be applied, BRONZE. So the TISSUE_LAYER token is telling the game to select all bodyparts 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.

[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:

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

...
[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 come in. Detail plans, of course, have their own file, and they are designed to help automate some of the more common processes in creature creation. 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.

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

[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:

[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 bodypart 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:

...
[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's 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 declare the body stuff normally:

...
[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 select the appropriate material:

...
[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]
[SELECT_MATERIAL:SKIN]
[MAT_FIXED_TEMP:10600]
...

We don't want them burning to death, so we'll need to stop that from happening:

...
[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]
[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:

...
[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 asexual 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 stuctures, 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 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:

[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:

[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's 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 bodypart 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 bodypart definition, but generally you should keep it fairly low for ease of use. Each body section entry is in the, very simple, format:

[BODY:BODYNAME]
[BP:TOKENID:name][TOKENSGOHERE][DEFAULT_RELSIZE:][CATEGORY:WHATEVER]

The most important tokens are "CONTYPE" and "CON": CONTYPE means the bodypart in question is connected to a certain ''type'' of bodypart, 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 bodypart'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 bodypart tokens can be found [[body token|here]].

Let's take a simple example, a head:

[BODY:BASIC_HEAD]
[BP:HD:head:STP][CONTYPE:UPPERBODY][HEAD][CATEGORY:HEAD]
[DEFAULT_RELSIZE:300]

It connects directly to an upper body.

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

[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:

[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:<br>
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).

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

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

[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.<br>
[VALUE:2] Is the value of harvested plant (default 1). Appears to have no effect in version 0.31.

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

[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:

[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:

[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.<br>
[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 available at depth 1. Defaults to 0:0 (surface only).<br>
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.<br>
For the rest of the tokens, see [[plant token]].

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

[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_S]
[BLOCK:1:0:0:1]
[BLOCK:2:0:0:1]
[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]

A line-by-line breakdown:

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

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

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

[BLOCK:1:0:0:1]
...
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:1 means that, on the first row, the first two tiles will be unblocked and the last will be blocked.

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

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

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

More can be seen at the [[Building token|building tokens]] article.

== Reactions ==

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.

== Examples ==

The Hydling by Mysteryguye (annotated, updated and separated into blocks by Putnam)

[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:78][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.

[LIKES_FIGHTING] 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.
[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.

= Modding utilities =

[http://www.bay12forums.com/smf/index.php?topic=28829.0 A list of many mods and community-developed utilities]

{{Category|Modding}}
[[Category:v0.31:Guides]]