Dwarf Fortress Wiki - User contributions [en]

Elf

2026-03-26T02:33:45Z

DPhKraken: /* Ethics */

{{Quality|Superior|11:04, 25 February 2023 (CST)}}
{{Creaturelookup/0
|image=Elf_sprite.png
|portrait=elf_portrait_anim.gif
|wiki=yes}}
{{av}}
{{creaturedesc}}

{{D for Dwarf}}

'''Elves''' (singular, '''Elf''') are <s>smelly, stuck-up, arrogant [[tree]]-fondling hippies</s> intelligent [[Creature|humanoids]] dedicated to the protection of ''their'' concept of nature (centered around trees, and the worship of certain natural [[force]]s that permeate the forests, as opposed to the [[deities]] worshipped by other races). They are one of the main [[civilization]]s of the game, featured in [[fortress mode]] and playable in [[adventurer mode]].

By default, they are often allies of [[dwarves]] and [[humans]], however, elves' conflicting view on nature compared to other races can create tension between them and their erstwhile allies. Elves often prefer using grown wood (and sometimes glass) for their weapons and armor, which do very little damage and offers little protection respectively compared to metal. If you go to war with them, you'll find that their primary danger comes from their numbers, archers, and dangerous tamed animals that may [[Mount|accompany]] them.

In fortress mode, <s>hippie wagons</s> elven caravans arrive in late spring, bringing only [[plant]]s and their own "grown" [[wood]]-related items, [[cage]]d tame animals, or various types of [[clay]] and [[sand]]. When trading with elves, unless the player seeks to intentionally antagonize them, they must be very careful to not offer any wooden objects/animal-derived goods - [[#Trading|see here for specifics]]. You may also steal from them, or even kill them, without fear of immediate repercussion, as elven caravans are unguarded, and merchants will not resist if you seize their goods, or competently fight back if attacked.

Offending elves by attempting to trade wooden items normally causes them to angrily refuse further trade that year and leave early. ''Repeatedly'' offending elves by attempting to trade wooden items may cause them to attack your fortress with an [[ambush]], which may later evolve into a full [[siege]].

Elves appear as usually thin and/or frail humanoids similar to humans, but with pointy ears and modest facial hair. Like [[goblin]]s, they are biologically [[immortal]] and will only die to violence and disease, and also similarly to goblins, this tends to result in high populations. Their life of harmony with the land and its wild beauty and creatures (due to elven civs possessing the {{token|AT_PEACE_WITH_WILDLIFE|e}} token) leads to them often settling in [[savage|high-savagery]] regions. Elves speak the [[Main:Elven language|elven language]].

Some <s>stupid, useless, tree-fondling traitors</s> ''highly misguided'' dwarves [[Preferences|like]] elves for their ''grace''.

[[File:Lafo-sarasti.jpg|thumb|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

==Fortress mode==
===Diplomats===
Once your fort has a [[baron]], elven civilizations in diplomatic contact send a [[Diplomat#Elven diplomats|diplomat]] to [[Meeting|meet]] with them approximately halfway through the first month in [[Calendar|spring]].

If this is their first visit to your fort and you aren't at war with their civilization, the diplomat will either congratulate you for your respect for the trees, or, in the more-likely event that you've cut even one down, chastise you for your disrespect. At some point, the diplomat may revisit your fortress to establish a treecutting quota, requesting that the dwarves keep the amount of trees cut down to a variable quota. It is possible to negotiate for a higher number, and the quota seems to be affected by your noble's [[Zone#Quality_and_value|office quality]], [[stress]], and [[social skill]]s. If the player agrees to a treecutting quota, it will be visible after selecting the elves in [[Civilization and World Info|the Civilizations screen]], {{menu icon|Y}}. This quota lasts until the next year's meeting, and keeping to it will improve [[Diplomacy|diplomatic relations]], while violating it will worsen them and can lead to all-out [[war]], as will rejecting a quota entirely. '''However, agreeing and sticking to a quota in one year, and then denying any agreement in the next, will keep the relationship in a state of "alliance", allowing your dwarves to raze entire forests every second year without the elves getting unhappy about it.'''

Note that the quota is measured in trees, not logs, so be sure to fell only the largest trees on your map to get the most out of your agreement. The elves also do not care if you damage saplings that haven't yet properly developed a trunk. Elves do, however, (''misguidedly enough?'')care about [[Tree#Underground trees|tree-like subterranean fungus]] like [[tower-cap]]s and [[tunnel tube]]s; cutting fungus "trees" down does count toward your quota. How many trees they will allow can be adjusted in the [[Difficulty#Tree_quota|difficulty]] [[settings]].

In addition to haggling over tree-cutting quotas, these meetings work like any other diplomatic [[meeting]]. Your [[Civilization and World Info|civilization screen]] will be updated with new info from the world, and depending on relations the diplomat may come to declare [[war]] or sue for peace.

=== Elven caravans ===
Friendly elven civilizations send a [[caravan]] in late spring bringing a mix of natural trade goods, such as tamed animals, plant clothes, and various [[Wood#Grown_wood|grown wood]] objects.

==== Trading ====
{{main|Trading#Unacceptable items|l1=Unacceptable items}}
Elven traders are very picky about what items they will accept, and consider most items made from wood or animal byproducts to be unethical, often rejecting items merely for requiring wood or ash in their preparation. Offering them even one of these items, either in a trade or as a gift, will cause their trader to insult you and leave in a huff, ending trading for that year and damaging your diplomatic relationship with their [[civilization]]. In general, items made from [[stone]], [[metal]], [[Gem|gemstone]], non-woody [[plant]]s, or [[silk]] are acceptable, as are live animals or "grown" wooden items (generally only available from elves), but even these items can be rendered taboo with inappropriate «[[decoration]]s» or by containing or being contained in an inappropriate item.

The [[Trading]] article has specific info on [[Trading#Unacceptable items|taboo]] and [[Trading#Acceptable items|accepted]] items.

==== Stock====
[[File:grown_weapon_sprites_preview.png|thumb|142px|right|Some sprites of naturally grown elven weapons, although some standard wooden weapons will also use these sprites.]]Elven caravans will never have stone, metal, or animal products. Aside from those, you can expect an average elven caravan to have:

* [[Wood]]en [[log]]s: Always useful, unless you are in a forest [[biome]] and ''already'' drowning in wooden logs. The quantity depends on how many logs you have already: lower means more. However, caravans with grown logs tend to be rare.
* [[Plant]]-based [[food]], both from [[crop]]s and picked from [[tree]]s. These can be handy for avoiding negative [[thought]]s from eating or drinking the same old thing, or satisfying a dwarf's unusual [[preference]]. They can also be a source of [[seed]]s for your own [[Tile attributes|above-ground]] [[Farming|farm]]s, if you live in a compatible [[biome]].
* Wooden containers: [[chest]]s, [[cage]]s, [[bucket]]s, and [[barrel]]s. These are usually cheap if not decorated and useful in bulk, but even if you don't have access to wood and don't want to waste metal, there are stone, clay, and glass alternatives that you can easily make on your own.
* Soil types: [[sand]] in bags, various types of [[clay]]. Unfortunately, they don't bring enough of either for large-scale production of either [[ceramic]] or [[glass]], and neither of these are very important to have in small quantities. A bit of sand can be used to make raw glass, which is occasionally demanded by dwarves in a [[strange mood]], but other races can sell you that cheaply without needing an intervening step.
* [[Bag]]s and [[rope]]s made from plant cloth. A few extra bags never hurt, but plant cloth bags are a bit expensive.
* A few above-ground tame animals in wooden cages. It may be [[opossum|a]] [[stoat|disappointingly]] [[fox|useless]] [[hoary marmot|animal]] or [[Giant badger|an]] [[Giant tiger|incredibly]] [[Giant elephant|awesome]] [[Giant eagle|one]]. Elves bring animals from the environment surrounding their settlements, so you may be able to guess what they will bring next. Elves who live in [[Surroundings|savage]] [[Biome|tropical]] lands bring the best ones. Exotic animals are considered fully tame and will never require [[Animal trainer|training]].
* Caged tame [[vermin]]. These are only even slightly useful for pleasing dwarves with a [[preference]] for that specific type of vermin, and they may even [[Hateable|annoy other dwarves]]. The vermin itself is probably worthless, but the possibly-useful cage comes included.
* [[Plant fiber]] [[thread]], [[cloth]], and [[clothing]]. These are mainly useful for jumpstarting or replacing a [[textile industry]]. Elves wear and sell the same-sized clothing as dwarves, and may sell cosmetically-different "foreign" clothes items like turbans, skirts, or sandals.
* Plant cloth [[quiver]]s. Dwarves can't make quivers out of plant cloth, but they can easily make them out of [[leather]].
* Wooden [[crutch]]es and [[Health care#Splints|splint]]s. Easy to make, but just as easy to forget, and they're fairly cheap.
* Wooden [[armor]] and [[weapon]]s. This includes weapons and armor dwarves can't normally make out of wood, but wood melee weapons and armor are [[Material science#Material and item properties|basically useless in combat]]. You can use elven melee weapons to [[Training|train]] with before making proper weapons, but that's probably not worth bothering with.
* [[Bow]]s and [[arrow]]s, both made of wood. While dwarves can't make bows, it's very easy to make your own superior [[crossbow]]s and [[bolt]]s from wood, [[bone]], or [[metal]]. Bows are less dependent on material or quality than melee weapons, which makes them a bit more useful than most weapons bought from traders. Unfortunately, bows use a separate [[combat skill]] from crossbows, can't be used for [[hunting]], and leave you reliant on trade with or [[Goblinite|scavenging from]] non-dwarven civilizations for [[arrow]] ammunition.
* Miscellaneous other [[finished goods]] made from wood or plant fiber. These might include [[instrument]]s that dwarves cannot make or copies of new [[book]]s, but other items are only marginally useful at best. Note that instrument ''parts'' are useless, since your dwarves do not know how to assemble them into a completed instrument unless they already knew how to make that instrument in the first place.

Unless you have a shortage of something, the main unique goods elves can bring are foreign plants (especially ones you can then grow yourself), foreign tame animals (especially large war-trainable carnivores), or possibly foreign instruments or new books. Everything else is relatively easy to produce on your own, and as with all traders, any dwarf with any amount of relevant crafting [[skill]] at all will make as-good- or better-[[quality]] items.

All wooden products made by elves are called "grown". Unlike regular wood, these may be traded back to the elves without repercussions; otherwise, they are identical to the wood items that you can produce.

==Ethics==
[[File:Stasost-sarasti.jpg|thumb|right|300px|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

Elven [[civilization]]s' [[ethics]] often differ from those of other races. Their position on moral philosophy will likely put them at odds with [[human]]s, [[goblin]]s, [[dwarf|dwarves]], and sometimes [[kobold]]s and [[animal people]], although they favor war with goblins over other races. Their settlement of [[savage]] lands likewise leads to animal people often joining their ranks. At any given point in time, elves and dwarves are likely to be at peace, but it is certainly possible for an elven civilization to be at war with a dwarven one at the end of worldgen. Use the tab button when selecting an [[embark]] site to view whether elves are at war with the currently selected dwarven culture, and cycle dwarven cultures to find out.

Elves are the only race which wholeheartedly accepts the devouring of enemy combatants. Looking in legends mode shows that an elven combatant will sometimes devour the other person they were fighting when they win. In spite of this, elves refuse to butcher and consume intelligent beings under other conditions. Elves find torture as an example acceptable, but condemn other forms of torture and consider torturing for information misguided. To elves, keeping any trophy of any kind is an unthinkable act. In world generation, their position on cannibalism is particularly notable for driving conflicts with other civilizations.

Elves begrudgingly allow for killing animals when done in self-defense, and the killing of fellow elves is justified if there is an extremely good reason for doing so. For elves, the killing of plants, ''especially'' trees, is unthinkable, on the other hand, the killing of neutral beings and enemies is acceptable. Elven society seems to be regulated by shame from the community, rather than by threat of punishment; as such, elves never offer serious or capital punishment to criminals; instead, elves found to have committed vandalism, trespassing or theft are reprimanded, while those convicted of treason, lying, oath-breaking, assault or participating in slavery are forced into exile.

Elves [[Personality value|value]] nature above all, and they also place a degree of value on family, eloquence, cunning, artwork, fairness, merriment, competition, and romance, but they do not especially respect commerce and have a dislike for self-control. However, even an elf can be "annoyed caught in the rain", as inconsistent as that may be with their respect for nature.

(Note that these are merely the ethics of elven ''civilizations''. Elves may adopt the cultures of other races via wandering individuals joining civilizations, or when conquest absorbs elves into another civilization. Sentient creatures adopt the values and ethics of their culture, subject to personal variation. Elves born among, [[Main:Cacame Awemedinade|or even leading]], dwarves may adopt dwarven ethics and values, and vice versa.)

As ghastly as the concept may be, elven cultures have become more powerful since the days of [[Main:Tholtig|Tholtig Cryptbrain]], and it is entirely possible for one or more dwarven civilizations to be extinct due to elven aggression. What elves lack in engineering, crafting, or [[Soaper|hygiene]], they make up for in raw, unwashed numbers, and once-mighty dwarven civilizations may crumble to hordes of soldiers and great beasts alike. Immortality also allows elven [[historical figure]]s to continually develop their skills throughout history. Even more troubling is their employment of [[Mercenary|mercenaries]], often much better equipped than the elves themselves. Embarking with (possibly homeless wandering survivor) dwarves claiming to be from that civilization is possible, but always starts at war with the elves that claimed the lives of those tragically unfortunate dwarves' friends, and you may not get migrants.

==In combat==
Elves by themselves are rarely considered a threat due to their insistence in using equipment purely made out of wood in battle, which is only marginally better than fighting unarmed and generally stands no chance against a half-competent, metal-clad dwarven militia [see [[Material_science|Material science]] for more info]. However, elves will also employ [[Mercenary|mercenaries]], often much better equipped than the elves themselves.
During [[Siege#Elven_sieges|sieges]] their archers and potential numbers (like goblins, their ageless immortality means very high populations) can still be dangerous, and perhaps the greatest threat they pose is if they bring tamed animals along with them, which may range from easily dispatched creatures to [[Giant elephant|huge]][[Tiger| sources]][[unicorn| of]][[Grizzly bear| fun]] depending upon what animals their civ has access to, which in theory can include any exotic land animal including giant variants.

==Community outlook==
Due to ''Dwarf Fortress'' making ample use of the ''wood-elven'', or "elves as stuck-up jerks who live in trees" stereotype (which is especially noticeable when talking to their diplomats), the race as a whole tends to be widely [[Unfortunate accident|disliked]] by players, who aren't too happy about said stuck-up jerks trying to tell their dwarves how to live their lives and who will gladly ambush <s>and likely eat</s> dwarven children while they play in the woods.
However, due to their wooden weaponry only being ''really'' effective on said children and unarmed dwarves, elves have a reputation among the community of being all-''bark''-and-no-bite wimps who serve as the perfect punching bags to be on the receiving end of whatever [[stupid dwarf trick]] the fortress is currently conducting, especially if it's a particularly [[Fun|violent]] one - many gruesome stories involve at least one elf as the victim. The elves' nigh-religious devotion to trees is also a point of note; many players will go as far as to raze their map clean of trees, for no reason but to spite the elves and provoke them into attacking, just for the chance to slaughter them all.

Unlike many other fantasy settings, ''Dwarf Fortress'' elves have very few redeeming characteristics (they aren't any more attractive than a dwarf, human or goblin, [http://tolkiengateway.net/wiki/Celebrimbor aren't good smiths], and don't have any superhuman abilities beyond biological [[immortality]], a peculiar ability to walk through grass and other ground covering plants without disturbing them, and a (currently) off-screen ability to "shape" wood via magic - one of their few other saving graces is their potential to provide fully-tamed exotic animals for trade), though most long-time players play their antics for laughs, resulting in them essentially being the community's collective chew-toys. Many players will take on a Tolkien (''or, more likely, Warhammer Fantasy'')-esque dwarven spirit of hatred towards elves, slaughtering them for their actions against dwarven kind; or perhaps, compelled by some god of murder for the simple glee of the resulting elven blood rain. Being compared to an elf is particularly insulting, as it implies you're an unwashed, tree-loving, cannibalistic hippie (''or, as [[Dwarf#Community_outlook|some have said]], the kind of being that's prone to sitting around and living '''in''' the world, rather than acting upon it''). That's not to say that elves are universally disliked, however: some have earned the liking of the player base, typically due to them being part of a dwarven civilization (and as such, not acting like elves), with [[Main:Cacame Awemedinade|Cacame Awemedinade]] being one of the community's most well-known and beloved characters.

{{gamedata}}
{{gamedata|title=Entity ([[civilization]]) Raws|{{raw|v50:entity_default.txt|ENTITY|FOREST}}}}
{{Creatures}}
{{Category|Races}}

Elf

2026-03-26T02:32:42Z

DPhKraken: /* Ethics */ Elaborate on some game effects

{{Quality|Superior|11:04, 25 February 2023 (CST)}}
{{Creaturelookup/0
|image=Elf_sprite.png
|portrait=elf_portrait_anim.gif
|wiki=yes}}
{{av}}
{{creaturedesc}}

{{D for Dwarf}}

'''Elves''' (singular, '''Elf''') are <s>smelly, stuck-up, arrogant [[tree]]-fondling hippies</s> intelligent [[Creature|humanoids]] dedicated to the protection of ''their'' concept of nature (centered around trees, and the worship of certain natural [[force]]s that permeate the forests, as opposed to the [[deities]] worshipped by other races). They are one of the main [[civilization]]s of the game, featured in [[fortress mode]] and playable in [[adventurer mode]].

By default, they are often allies of [[dwarves]] and [[humans]], however, elves' conflicting view on nature compared to other races can create tension between them and their erstwhile allies. Elves often prefer using grown wood (and sometimes glass) for their weapons and armor, which do very little damage and offers little protection respectively compared to metal. If you go to war with them, you'll find that their primary danger comes from their numbers, archers, and dangerous tamed animals that may [[Mount|accompany]] them.

In fortress mode, <s>hippie wagons</s> elven caravans arrive in late spring, bringing only [[plant]]s and their own "grown" [[wood]]-related items, [[cage]]d tame animals, or various types of [[clay]] and [[sand]]. When trading with elves, unless the player seeks to intentionally antagonize them, they must be very careful to not offer any wooden objects/animal-derived goods - [[#Trading|see here for specifics]]. You may also steal from them, or even kill them, without fear of immediate repercussion, as elven caravans are unguarded, and merchants will not resist if you seize their goods, or competently fight back if attacked.

Offending elves by attempting to trade wooden items normally causes them to angrily refuse further trade that year and leave early. ''Repeatedly'' offending elves by attempting to trade wooden items may cause them to attack your fortress with an [[ambush]], which may later evolve into a full [[siege]].

Elves appear as usually thin and/or frail humanoids similar to humans, but with pointy ears and modest facial hair. Like [[goblin]]s, they are biologically [[immortal]] and will only die to violence and disease, and also similarly to goblins, this tends to result in high populations. Their life of harmony with the land and its wild beauty and creatures (due to elven civs possessing the {{token|AT_PEACE_WITH_WILDLIFE|e}} token) leads to them often settling in [[savage|high-savagery]] regions. Elves speak the [[Main:Elven language|elven language]].

Some <s>stupid, useless, tree-fondling traitors</s> ''highly misguided'' dwarves [[Preferences|like]] elves for their ''grace''.

[[File:Lafo-sarasti.jpg|thumb|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

==Fortress mode==
===Diplomats===
Once your fort has a [[baron]], elven civilizations in diplomatic contact send a [[Diplomat#Elven diplomats|diplomat]] to [[Meeting|meet]] with them approximately halfway through the first month in [[Calendar|spring]].

If this is their first visit to your fort and you aren't at war with their civilization, the diplomat will either congratulate you for your respect for the trees, or, in the more-likely event that you've cut even one down, chastise you for your disrespect. At some point, the diplomat may revisit your fortress to establish a treecutting quota, requesting that the dwarves keep the amount of trees cut down to a variable quota. It is possible to negotiate for a higher number, and the quota seems to be affected by your noble's [[Zone#Quality_and_value|office quality]], [[stress]], and [[social skill]]s. If the player agrees to a treecutting quota, it will be visible after selecting the elves in [[Civilization and World Info|the Civilizations screen]], {{menu icon|Y}}. This quota lasts until the next year's meeting, and keeping to it will improve [[Diplomacy|diplomatic relations]], while violating it will worsen them and can lead to all-out [[war]], as will rejecting a quota entirely. '''However, agreeing and sticking to a quota in one year, and then denying any agreement in the next, will keep the relationship in a state of "alliance", allowing your dwarves to raze entire forests every second year without the elves getting unhappy about it.'''

Note that the quota is measured in trees, not logs, so be sure to fell only the largest trees on your map to get the most out of your agreement. The elves also do not care if you damage saplings that haven't yet properly developed a trunk. Elves do, however, (''misguidedly enough?'')care about [[Tree#Underground trees|tree-like subterranean fungus]] like [[tower-cap]]s and [[tunnel tube]]s; cutting fungus "trees" down does count toward your quota. How many trees they will allow can be adjusted in the [[Difficulty#Tree_quota|difficulty]] [[settings]].

In addition to haggling over tree-cutting quotas, these meetings work like any other diplomatic [[meeting]]. Your [[Civilization and World Info|civilization screen]] will be updated with new info from the world, and depending on relations the diplomat may come to declare [[war]] or sue for peace.

=== Elven caravans ===
Friendly elven civilizations send a [[caravan]] in late spring bringing a mix of natural trade goods, such as tamed animals, plant clothes, and various [[Wood#Grown_wood|grown wood]] objects.

==== Trading ====
{{main|Trading#Unacceptable items|l1=Unacceptable items}}
Elven traders are very picky about what items they will accept, and consider most items made from wood or animal byproducts to be unethical, often rejecting items merely for requiring wood or ash in their preparation. Offering them even one of these items, either in a trade or as a gift, will cause their trader to insult you and leave in a huff, ending trading for that year and damaging your diplomatic relationship with their [[civilization]]. In general, items made from [[stone]], [[metal]], [[Gem|gemstone]], non-woody [[plant]]s, or [[silk]] are acceptable, as are live animals or "grown" wooden items (generally only available from elves), but even these items can be rendered taboo with inappropriate «[[decoration]]s» or by containing or being contained in an inappropriate item.

The [[Trading]] article has specific info on [[Trading#Unacceptable items|taboo]] and [[Trading#Acceptable items|accepted]] items.

==== Stock====
[[File:grown_weapon_sprites_preview.png|thumb|142px|right|Some sprites of naturally grown elven weapons, although some standard wooden weapons will also use these sprites.]]Elven caravans will never have stone, metal, or animal products. Aside from those, you can expect an average elven caravan to have:

* [[Wood]]en [[log]]s: Always useful, unless you are in a forest [[biome]] and ''already'' drowning in wooden logs. The quantity depends on how many logs you have already: lower means more. However, caravans with grown logs tend to be rare.
* [[Plant]]-based [[food]], both from [[crop]]s and picked from [[tree]]s. These can be handy for avoiding negative [[thought]]s from eating or drinking the same old thing, or satisfying a dwarf's unusual [[preference]]. They can also be a source of [[seed]]s for your own [[Tile attributes|above-ground]] [[Farming|farm]]s, if you live in a compatible [[biome]].
* Wooden containers: [[chest]]s, [[cage]]s, [[bucket]]s, and [[barrel]]s. These are usually cheap if not decorated and useful in bulk, but even if you don't have access to wood and don't want to waste metal, there are stone, clay, and glass alternatives that you can easily make on your own.
* Soil types: [[sand]] in bags, various types of [[clay]]. Unfortunately, they don't bring enough of either for large-scale production of either [[ceramic]] or [[glass]], and neither of these are very important to have in small quantities. A bit of sand can be used to make raw glass, which is occasionally demanded by dwarves in a [[strange mood]], but other races can sell you that cheaply without needing an intervening step.
* [[Bag]]s and [[rope]]s made from plant cloth. A few extra bags never hurt, but plant cloth bags are a bit expensive.
* A few above-ground tame animals in wooden cages. It may be [[opossum|a]] [[stoat|disappointingly]] [[fox|useless]] [[hoary marmot|animal]] or [[Giant badger|an]] [[Giant tiger|incredibly]] [[Giant elephant|awesome]] [[Giant eagle|one]]. Elves bring animals from the environment surrounding their settlements, so you may be able to guess what they will bring next. Elves who live in [[Surroundings|savage]] [[Biome|tropical]] lands bring the best ones. Exotic animals are considered fully tame and will never require [[Animal trainer|training]].
* Caged tame [[vermin]]. These are only even slightly useful for pleasing dwarves with a [[preference]] for that specific type of vermin, and they may even [[Hateable|annoy other dwarves]]. The vermin itself is probably worthless, but the possibly-useful cage comes included.
* [[Plant fiber]] [[thread]], [[cloth]], and [[clothing]]. These are mainly useful for jumpstarting or replacing a [[textile industry]]. Elves wear and sell the same-sized clothing as dwarves, and may sell cosmetically-different "foreign" clothes items like turbans, skirts, or sandals.
* Plant cloth [[quiver]]s. Dwarves can't make quivers out of plant cloth, but they can easily make them out of [[leather]].
* Wooden [[crutch]]es and [[Health care#Splints|splint]]s. Easy to make, but just as easy to forget, and they're fairly cheap.
* Wooden [[armor]] and [[weapon]]s. This includes weapons and armor dwarves can't normally make out of wood, but wood melee weapons and armor are [[Material science#Material and item properties|basically useless in combat]]. You can use elven melee weapons to [[Training|train]] with before making proper weapons, but that's probably not worth bothering with.
* [[Bow]]s and [[arrow]]s, both made of wood. While dwarves can't make bows, it's very easy to make your own superior [[crossbow]]s and [[bolt]]s from wood, [[bone]], or [[metal]]. Bows are less dependent on material or quality than melee weapons, which makes them a bit more useful than most weapons bought from traders. Unfortunately, bows use a separate [[combat skill]] from crossbows, can't be used for [[hunting]], and leave you reliant on trade with or [[Goblinite|scavenging from]] non-dwarven civilizations for [[arrow]] ammunition.
* Miscellaneous other [[finished goods]] made from wood or plant fiber. These might include [[instrument]]s that dwarves cannot make or copies of new [[book]]s, but other items are only marginally useful at best. Note that instrument ''parts'' are useless, since your dwarves do not know how to assemble them into a completed instrument unless they already knew how to make that instrument in the first place.

Unless you have a shortage of something, the main unique goods elves can bring are foreign plants (especially ones you can then grow yourself), foreign tame animals (especially large war-trainable carnivores), or possibly foreign instruments or new books. Everything else is relatively easy to produce on your own, and as with all traders, any dwarf with any amount of relevant crafting [[skill]] at all will make as-good- or better-[[quality]] items.

All wooden products made by elves are called "grown". Unlike regular wood, these may be traded back to the elves without repercussions; otherwise, they are identical to the wood items that you can produce.

==Ethics==
[[File:Stasost-sarasti.jpg|thumb|right|300px|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

Elven [[civilization]]s' [[ethics]] often differ from those of other races. Their position on moral philosophy will likely put them at odds with [[human]]s, [[goblin]]s, [[dwarf|dwarves]], and sometimes [[kobold]]s and [[animal people]], although they favor war with goblins over other races. Their settlement of [[savage]] lands likewise leads to animal people often joining their ranks. At any given point in time, elves and dwarves are likely to be at peace, but it is certainly possible for an elven civilization to be at war with a dwarven one at the end of worldgen. Use the tab button when selecting an [[embark]] site to view whether elves are at war with the currently selected dwarven culture, and cycle dwarven cultures to find out.

Elves are the only race which wholeheartedly accepts the devouring of enemy combatants. Looking in legends mode shows that an elven combatant will sometimes devour the other person they were fighting when they win. In spite of this, elves refuse to butcher and consume intelligent beings under other conditions. Elves find torture as an example acceptable, but condemn other forms of torture and consider torturing for information misguided. To elves, keeping any trophy of any kind is an unthinkable act. In world generation, their position on cannibalism is particularly notable for driving conflicts with other civilizations.

Elves begrudgingly allow for killing animals when done in self-defense, and the killing of fellow elves is justified if there is an extremely good reason for doing so. For elves, the killing of plants, ''especially'' trees, is unthinkable, on the other hand, the killing of neutral beings and enemies is acceptable. Elven society seems to be regulated by shame from the community, rather than by threat of punishment; as such, elves never offer serious or capital punishment to criminals; instead, elves found to have committed vandalism, trespassing or theft are reprimanded, while those convicted of treason, lying, oath-breaking, assault or participating in slavery are forced into exile.

Elves [[Personality value|value]] nature above all, and they also place a degree of value on family, eloquence, cunning, artwork, fairness, merriment, competition, and romance, but they do not especially respect commerce and have a dislike for self-control. However, even an elf can be "annoyed caught in the rain", as inconsistent as that may be with their respect for nature.

(Note that these are merely the ethics of elven ''civilizations''. Elves may adopt the cultures of other races via wandering individuals joining civilizations, or when conquest absorbs elves into another civilization. Sentient creatures adopt the values and ethics of their culture, subject to personal variation. Elves born among, [[Main:Cacame Awemedinade|or even leading]], dwarves may adopt dwarven ethics and values, and vice versa.)

As ghastly as the concept may be, elven cultures have become more powerful since the days of [[Main:Tholtig|Tholtig Cryptbrain]], and it is entirely possible for one or more dwarven civilizations to be extinct due to elven aggression. What elves lack in engineering, crafting, or [[Soap maker|hygiene]], they make up for in raw, unwashed numbers, and once-mighty dwarven civilizations may crumble to hordes of soldiers and great beasts alike. Immortality also allows elven [[historical figure]]s to continually develop their skills throughout history. Even more troubling is their employment of [[Mercenary|mercenaries]], often much better equipped than the elves themselves. Embarking with (possibly homeless wandering survivor) dwarves claiming to be from that civilization is possible, but always starts at war with the elves that claimed the lives of those tragically unfortunate dwarves' friends, and you may not get migrants.

==In combat==
Elves by themselves are rarely considered a threat due to their insistence in using equipment purely made out of wood in battle, which is only marginally better than fighting unarmed and generally stands no chance against a half-competent, metal-clad dwarven militia [see [[Material_science|Material science]] for more info]. However, elves will also employ [[Mercenary|mercenaries]], often much better equipped than the elves themselves.
During [[Siege#Elven_sieges|sieges]] their archers and potential numbers (like goblins, their ageless immortality means very high populations) can still be dangerous, and perhaps the greatest threat they pose is if they bring tamed animals along with them, which may range from easily dispatched creatures to [[Giant elephant|huge]][[Tiger| sources]][[unicorn| of]][[Grizzly bear| fun]] depending upon what animals their civ has access to, which in theory can include any exotic land animal including giant variants.

==Community outlook==
Due to ''Dwarf Fortress'' making ample use of the ''wood-elven'', or "elves as stuck-up jerks who live in trees" stereotype (which is especially noticeable when talking to their diplomats), the race as a whole tends to be widely [[Unfortunate accident|disliked]] by players, who aren't too happy about said stuck-up jerks trying to tell their dwarves how to live their lives and who will gladly ambush <s>and likely eat</s> dwarven children while they play in the woods.
However, due to their wooden weaponry only being ''really'' effective on said children and unarmed dwarves, elves have a reputation among the community of being all-''bark''-and-no-bite wimps who serve as the perfect punching bags to be on the receiving end of whatever [[stupid dwarf trick]] the fortress is currently conducting, especially if it's a particularly [[Fun|violent]] one - many gruesome stories involve at least one elf as the victim. The elves' nigh-religious devotion to trees is also a point of note; many players will go as far as to raze their map clean of trees, for no reason but to spite the elves and provoke them into attacking, just for the chance to slaughter them all.

Unlike many other fantasy settings, ''Dwarf Fortress'' elves have very few redeeming characteristics (they aren't any more attractive than a dwarf, human or goblin, [http://tolkiengateway.net/wiki/Celebrimbor aren't good smiths], and don't have any superhuman abilities beyond biological [[immortality]], a peculiar ability to walk through grass and other ground covering plants without disturbing them, and a (currently) off-screen ability to "shape" wood via magic - one of their few other saving graces is their potential to provide fully-tamed exotic animals for trade), though most long-time players play their antics for laughs, resulting in them essentially being the community's collective chew-toys. Many players will take on a Tolkien (''or, more likely, Warhammer Fantasy'')-esque dwarven spirit of hatred towards elves, slaughtering them for their actions against dwarven kind; or perhaps, compelled by some god of murder for the simple glee of the resulting elven blood rain. Being compared to an elf is particularly insulting, as it implies you're an unwashed, tree-loving, cannibalistic hippie (''or, as [[Dwarf#Community_outlook|some have said]], the kind of being that's prone to sitting around and living '''in''' the world, rather than acting upon it''). That's not to say that elves are universally disliked, however: some have earned the liking of the player base, typically due to them being part of a dwarven civilization (and as such, not acting like elves), with [[Main:Cacame Awemedinade|Cacame Awemedinade]] being one of the community's most well-known and beloved characters.

{{gamedata}}
{{gamedata|title=Entity ([[civilization]]) Raws|{{raw|v50:entity_default.txt|ENTITY|FOREST}}}}
{{Creatures}}
{{Category|Races}}

Elf

2026-03-26T02:17:56Z

DPhKraken:

{{Quality|Superior|11:04, 25 February 2023 (CST)}}
{{Creaturelookup/0
|image=Elf_sprite.png
|portrait=elf_portrait_anim.gif
|wiki=yes}}
{{av}}
{{creaturedesc}}

{{D for Dwarf}}

'''Elves''' (singular, '''Elf''') are <s>smelly, stuck-up, arrogant [[tree]]-fondling hippies</s> intelligent [[Creature|humanoids]] dedicated to the protection of ''their'' concept of nature (centered around trees, and the worship of certain natural [[force]]s that permeate the forests, as opposed to the [[deities]] worshipped by other races). They are one of the main [[civilization]]s of the game, featured in [[fortress mode]] and playable in [[adventurer mode]].

By default, they are often allies of [[dwarves]] and [[humans]], however, elves' conflicting view on nature compared to other races can create tension between them and their erstwhile allies. Elves often prefer using grown wood (and sometimes glass) for their weapons and armor, which do very little damage and offers little protection respectively compared to metal. If you go to war with them, you'll find that their primary danger comes from their numbers, archers, and dangerous tamed animals that may [[Mount|accompany]] them.

In fortress mode, <s>hippie wagons</s> elven caravans arrive in late spring, bringing only [[plant]]s and their own "grown" [[wood]]-related items, [[cage]]d tame animals, or various types of [[clay]] and [[sand]]. When trading with elves, unless the player seeks to intentionally antagonize them, they must be very careful to not offer any wooden objects/animal-derived goods - [[#Trading|see here for specifics]]. You may also steal from them, or even kill them, without fear of immediate repercussion, as elven caravans are unguarded, and merchants will not resist if you seize their goods, or competently fight back if attacked.

Offending elves by attempting to trade wooden items normally causes them to angrily refuse further trade that year and leave early. ''Repeatedly'' offending elves by attempting to trade wooden items may cause them to attack your fortress with an [[ambush]], which may later evolve into a full [[siege]].

Elves appear as usually thin and/or frail humanoids similar to humans, but with pointy ears and modest facial hair. Like [[goblin]]s, they are biologically [[immortal]] and will only die to violence and disease, and also similarly to goblins, this tends to result in high populations. Their life of harmony with the land and its wild beauty and creatures (due to elven civs possessing the {{token|AT_PEACE_WITH_WILDLIFE|e}} token) leads to them often settling in [[savage|high-savagery]] regions. Elves speak the [[Main:Elven language|elven language]].

Some <s>stupid, useless, tree-fondling traitors</s> ''highly misguided'' dwarves [[Preferences|like]] elves for their ''grace''.

[[File:Lafo-sarasti.jpg|thumb|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

==Fortress mode==
===Diplomats===
Once your fort has a [[baron]], elven civilizations in diplomatic contact send a [[Diplomat#Elven diplomats|diplomat]] to [[Meeting|meet]] with them approximately halfway through the first month in [[Calendar|spring]].

If this is their first visit to your fort and you aren't at war with their civilization, the diplomat will either congratulate you for your respect for the trees, or, in the more-likely event that you've cut even one down, chastise you for your disrespect. At some point, the diplomat may revisit your fortress to establish a treecutting quota, requesting that the dwarves keep the amount of trees cut down to a variable quota. It is possible to negotiate for a higher number, and the quota seems to be affected by your noble's [[Zone#Quality_and_value|office quality]], [[stress]], and [[social skill]]s. If the player agrees to a treecutting quota, it will be visible after selecting the elves in [[Civilization and World Info|the Civilizations screen]], {{menu icon|Y}}. This quota lasts until the next year's meeting, and keeping to it will improve [[Diplomacy|diplomatic relations]], while violating it will worsen them and can lead to all-out [[war]], as will rejecting a quota entirely. '''However, agreeing and sticking to a quota in one year, and then denying any agreement in the next, will keep the relationship in a state of "alliance", allowing your dwarves to raze entire forests every second year without the elves getting unhappy about it.'''

Note that the quota is measured in trees, not logs, so be sure to fell only the largest trees on your map to get the most out of your agreement. The elves also do not care if you damage saplings that haven't yet properly developed a trunk. Elves do, however, (''misguidedly enough?'')care about [[Tree#Underground trees|tree-like subterranean fungus]] like [[tower-cap]]s and [[tunnel tube]]s; cutting fungus "trees" down does count toward your quota. How many trees they will allow can be adjusted in the [[Difficulty#Tree_quota|difficulty]] [[settings]].

In addition to haggling over tree-cutting quotas, these meetings work like any other diplomatic [[meeting]]. Your [[Civilization and World Info|civilization screen]] will be updated with new info from the world, and depending on relations the diplomat may come to declare [[war]] or sue for peace.

=== Elven caravans ===
Friendly elven civilizations send a [[caravan]] in late spring bringing a mix of natural trade goods, such as tamed animals, plant clothes, and various [[Wood#Grown_wood|grown wood]] objects.

==== Trading ====
{{main|Trading#Unacceptable items|l1=Unacceptable items}}
Elven traders are very picky about what items they will accept, and consider most items made from wood or animal byproducts to be unethical, often rejecting items merely for requiring wood or ash in their preparation. Offering them even one of these items, either in a trade or as a gift, will cause their trader to insult you and leave in a huff, ending trading for that year and damaging your diplomatic relationship with their [[civilization]]. In general, items made from [[stone]], [[metal]], [[Gem|gemstone]], non-woody [[plant]]s, or [[silk]] are acceptable, as are live animals or "grown" wooden items (generally only available from elves), but even these items can be rendered taboo with inappropriate «[[decoration]]s» or by containing or being contained in an inappropriate item.

The [[Trading]] article has specific info on [[Trading#Unacceptable items|taboo]] and [[Trading#Acceptable items|accepted]] items.

==== Stock====
[[File:grown_weapon_sprites_preview.png|thumb|142px|right|Some sprites of naturally grown elven weapons, although some standard wooden weapons will also use these sprites.]]Elven caravans will never have stone, metal, or animal products. Aside from those, you can expect an average elven caravan to have:

* [[Wood]]en [[log]]s: Always useful, unless you are in a forest [[biome]] and ''already'' drowning in wooden logs. The quantity depends on how many logs you have already: lower means more. However, caravans with grown logs tend to be rare.
* [[Plant]]-based [[food]], both from [[crop]]s and picked from [[tree]]s. These can be handy for avoiding negative [[thought]]s from eating or drinking the same old thing, or satisfying a dwarf's unusual [[preference]]. They can also be a source of [[seed]]s for your own [[Tile attributes|above-ground]] [[Farming|farm]]s, if you live in a compatible [[biome]].
* Wooden containers: [[chest]]s, [[cage]]s, [[bucket]]s, and [[barrel]]s. These are usually cheap if not decorated and useful in bulk, but even if you don't have access to wood and don't want to waste metal, there are stone, clay, and glass alternatives that you can easily make on your own.
* Soil types: [[sand]] in bags, various types of [[clay]]. Unfortunately, they don't bring enough of either for large-scale production of either [[ceramic]] or [[glass]], and neither of these are very important to have in small quantities. A bit of sand can be used to make raw glass, which is occasionally demanded by dwarves in a [[strange mood]], but other races can sell you that cheaply without needing an intervening step.
* [[Bag]]s and [[rope]]s made from plant cloth. A few extra bags never hurt, but plant cloth bags are a bit expensive.
* A few above-ground tame animals in wooden cages. It may be [[opossum|a]] [[stoat|disappointingly]] [[fox|useless]] [[hoary marmot|animal]] or [[Giant badger|an]] [[Giant tiger|incredibly]] [[Giant elephant|awesome]] [[Giant eagle|one]]. Elves bring animals from the environment surrounding their settlements, so you may be able to guess what they will bring next. Elves who live in [[Surroundings|savage]] [[Biome|tropical]] lands bring the best ones. Exotic animals are considered fully tame and will never require [[Animal trainer|training]].
* Caged tame [[vermin]]. These are only even slightly useful for pleasing dwarves with a [[preference]] for that specific type of vermin, and they may even [[Hateable|annoy other dwarves]]. The vermin itself is probably worthless, but the possibly-useful cage comes included.
* [[Plant fiber]] [[thread]], [[cloth]], and [[clothing]]. These are mainly useful for jumpstarting or replacing a [[textile industry]]. Elves wear and sell the same-sized clothing as dwarves, and may sell cosmetically-different "foreign" clothes items like turbans, skirts, or sandals.
* Plant cloth [[quiver]]s. Dwarves can't make quivers out of plant cloth, but they can easily make them out of [[leather]].
* Wooden [[crutch]]es and [[Health care#Splints|splint]]s. Easy to make, but just as easy to forget, and they're fairly cheap.
* Wooden [[armor]] and [[weapon]]s. This includes weapons and armor dwarves can't normally make out of wood, but wood melee weapons and armor are [[Material science#Material and item properties|basically useless in combat]]. You can use elven melee weapons to [[Training|train]] with before making proper weapons, but that's probably not worth bothering with.
* [[Bow]]s and [[arrow]]s, both made of wood. While dwarves can't make bows, it's very easy to make your own superior [[crossbow]]s and [[bolt]]s from wood, [[bone]], or [[metal]]. Bows are less dependent on material or quality than melee weapons, which makes them a bit more useful than most weapons bought from traders. Unfortunately, bows use a separate [[combat skill]] from crossbows, can't be used for [[hunting]], and leave you reliant on trade with or [[Goblinite|scavenging from]] non-dwarven civilizations for [[arrow]] ammunition.
* Miscellaneous other [[finished goods]] made from wood or plant fiber. These might include [[instrument]]s that dwarves cannot make or copies of new [[book]]s, but other items are only marginally useful at best. Note that instrument ''parts'' are useless, since your dwarves do not know how to assemble them into a completed instrument unless they already knew how to make that instrument in the first place.

Unless you have a shortage of something, the main unique goods elves can bring are foreign plants (especially ones you can then grow yourself), foreign tame animals (especially large war-trainable carnivores), or possibly foreign instruments or new books. Everything else is relatively easy to produce on your own, and as with all traders, any dwarf with any amount of relevant crafting [[skill]] at all will make as-good- or better-[[quality]] items.

All wooden products made by elves are called "grown". Unlike regular wood, these may be traded back to the elves without repercussions; otherwise, they are identical to the wood items that you can produce.

==Ethics==
[[File:Stasost-sarasti.jpg|thumb|right|300px|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

Elven [[civilization]]s' [[ethics]] often differ from those of other races. Their position on moral philosophy will likely put them at odds with [[human]]s, [[goblin]]s, [[dwarf|dwarves]], and sometimes [[kobold]]s and [[animal people]], although they favor war with goblins over other races. At any given point in time, elves and dwarves are likely to be at peace, but it is certainly possible for an elven civilization to be at war with a dwarven one at the end of worldgen. Use the tab button when selecting an [[embark]] site to view whether elves are at war with the currently selected dwarven culture, and cycle dwarven cultures to find out.

Elves are the only race which wholeheartedly accepts the devouring of enemy combatants. Looking in legends mode shows that an elven combatant will sometimes devour the other person they were fighting when they win. In spite of this, elves refuse to butcher and consume intelligent beings under other conditions. Elves find torture as an example acceptable, but condemn other forms of torture and consider torturing for information misguided. To elves, keeping any trophy of any kind is an unthinkable act. Elves begrudgingly allow for killing animals when done in self-defense, and the killing of other elves by an elf is justified if there is an extremely good reason for doing so. For elves, the killing of plants, ''especially'' trees, is unthinkable, on the other hand, the killing of neutral beings and enemies is acceptable. Elven society seems to be regulated by shame from the community, rather than by threat of punishment; as such, elves never offer serious or capital punishment to criminals; instead, elves found to have committed vandalism, trespassing or theft are reprimanded, while those convicted of treason, lying, oath-breaking, assault or participating in slavery are forced into exile.

Elves [[Personality value|value]] nature incredibly highly, and they also place a degree of value on family, eloquence, cunning, artwork, fairness, merriment, competition, and romance, but they do not especially respect commerce and have a dislike for self-control. However, even an elf will be "annoyed caught in the rain", as inconsistent as that may be.

(Note that these are merely the ethics of elven ''civilizations''. Elves may adopt the cultures of other races via wandering individuals joining civilizations, or when conquest absorbs elves into another civilization. Sentient creatures adopt the values and ethics of their culture, regardless of race. Elves living among, [[Main:Cacame Awemedinade|or even leading]], dwarves will have dwarven ethics and values, and vice versa.)

As ghastly as the concept may be, elven cultures have become more powerful since the days of [[Main:Tholtig|Tholtig Cryptbrain]], and it is entirely possible for one or more dwarven civilizations to be extinct due to elven aggression. What elves lack in engineering, crafting, intelligence, bravery, skill, or hygiene, they make up for in raw, unwashed numbers, and once-mighty dwarven civilizations may crumble to the hordes. Even more troubling is their employment of [[Mercenary|mercenaries]], often much better equipped than the elves themselves. Embarking with (possibly homeless wandering survivor) dwarves claiming to be from that civilization is possible, but always starts at war with the elves that claimed the lives of those tragically unfortunate dwarves' friends, and you may not get migrants.

==In combat==
Elves by themselves are rarely considered a threat due to their insistence in using equipment purely made out of wood in battle, which is only marginally better than fighting unarmed and generally stands no chance against a half-competent, metal-clad dwarven militia [see [[Material_science|Material science]] for more info]. However, elves will also employ [[Mercenary|mercenaries]], often much better equipped than the elves themselves.
During [[Siege#Elven_sieges|sieges]] their archers and potential numbers (like goblins, their ageless immortality means very high populations) can still be dangerous, and perhaps the greatest threat they pose is if they bring tamed animals along with them, which may range from easily dispatched creatures to [[Giant elephant|huge]][[Tiger| sources]][[unicorn| of]][[Grizzly bear| fun]] depending upon what animals their civ has access to, which in theory can include any exotic land animal including giant variants.

==Community outlook==
Due to ''Dwarf Fortress'' making ample use of the ''wood-elven'', or "elves as stuck-up jerks who live in trees" stereotype (which is especially noticeable when talking to their diplomats), the race as a whole tends to be widely [[Unfortunate accident|disliked]] by players, who aren't too happy about said stuck-up jerks trying to tell their dwarves how to live their lives and who will gladly ambush <s>and likely eat</s> dwarven children while they play in the woods.
However, due to their wooden weaponry only being ''really'' effective on said children and unarmed dwarves, elves have a reputation among the community of being all-''bark''-and-no-bite wimps who serve as the perfect punching bags to be on the receiving end of whatever [[stupid dwarf trick]] the fortress is currently conducting, especially if it's a particularly [[Fun|violent]] one - many gruesome stories involve at least one elf as the victim. The elves' nigh-religious devotion to trees is also a point of note; many players will go as far as to raze their map clean of trees, for no reason but to spite the elves and provoke them into attacking, just for the chance to slaughter them all.

Unlike many other fantasy settings, ''Dwarf Fortress'' elves have very few redeeming characteristics (they aren't any more attractive than a dwarf, human or goblin, [http://tolkiengateway.net/wiki/Celebrimbor aren't good smiths], and don't have any superhuman abilities beyond biological [[immortality]], a peculiar ability to walk through grass and other ground covering plants without disturbing them, and a (currently) off-screen ability to "shape" wood via magic - one of their few other saving graces is their potential to provide fully-tamed exotic animals for trade), though most long-time players play their antics for laughs, resulting in them essentially being the community's collective chew-toys. Many players will take on a Tolkien (''or, more likely, Warhammer Fantasy'')-esque dwarven spirit of hatred towards elves, slaughtering them for their actions against dwarven kind; or perhaps, compelled by some god of murder for the simple glee of the resulting elven blood rain. Being compared to an elf is particularly insulting, as it implies you're an unwashed, tree-loving, cannibalistic hippie (''or, as [[Dwarf#Community_outlook|some have said]], the kind of being that's prone to sitting around and living '''in''' the world, rather than acting upon it''). That's not to say that elves are universally disliked, however: some have earned the liking of the player base, typically due to them being part of a dwarven civilization (and as such, not acting like elves), with [[Main:Cacame Awemedinade|Cacame Awemedinade]] being one of the community's most well-known and beloved characters.

{{gamedata}}
{{gamedata|title=Entity ([[civilization]]) Raws|{{raw|v50:entity_default.txt|ENTITY|FOREST}}}}
{{Creatures}}
{{Category|Races}}

Elf

2026-03-26T01:59:40Z

DPhKraken: Elves display facial hair on their sprites, reflecting an extant tissue, though it is minimal

{{Quality|Superior|11:04, 25 February 2023 (CST)}}
{{Creaturelookup/0
|image=Elf_sprite.png
|portrait=elf_portrait_anim.gif
|wiki=yes}}
{{av}}
{{creaturedesc}}

{{D for Dwarf}}

'''Elves''' (singular, '''Elf''') are <s>smelly, stuck-up, arrogant [[tree]]-fondling hippies</s> intelligent [[Creature|humanoids]] dedicated to the protection of ''their'' concept of nature (centered around trees, and the worship of certain natural [[force]]s that permeate the forests, as opposed to the [[deities]] worshipped by other races). They are one of the main [[civilization]]s of the game, featured in [[fortress mode]] and playable in [[adventurer mode]].

By default, they are often allies of [[dwarves]] and [[humans]], however, elves' conflicting view on nature compared to other races, can create tension between them and their erstwhile allies. Elves often prefer using grown wood (and sometimes glass) for their weapons and armor, which do very little damage and offers little protection respectively compared to metal. If you go to war with them, you'll find that their primary danger comes from their numbers, archers, and dangerous tamed animals that may [[Mount|accompany]] them.

In fortress mode, <s>hippie wagons</s> elven caravans arrive in late spring, bringing only [[plant]]s and their own "grown" [[wood]]-related items, [[cage]]d tame animals, or various types of [[clay]] and [[sand]]. When trading with elves, unless the player seeks to intentionally antagonize them, they must be very careful to not offer any wooden objects/animal-derived goods - [[#Trading|see here for specifics]]. You may also steal from them, or even kill them, without fear of immediate repercussion, as elven caravans are unguarded, and merchants will not resist if you seize their goods, or competently fight back if attacked.

Offending elves by attempting to trade wooden items normally causes them to angrily refuse further trade that year and leave early. ''Repeatedly'' offending elves by attempting to trade wooden items may cause them to attack your fortress with an [[ambush]], which may later evolve into a full [[siege]].

Elves appear as usually thin and/or frail humanoids similar to humans, but with pointy ears and modest facial hair. Like [[goblin]]s, they are biologically [[immortal]] and will only die to violence and disease, and also similarly to goblins, this tends to result in high populations. Their life of harmony with the land and its wild beauty and creatures (due to elven civs possessing the {{token|AT_PEACE_WITH_WILDLIFE|e}} token) leads to them often settling in [[savage|high-savagery]] regions. Elves speak the [[Main:Elven language|elven language]].

Some <s>stupid, useless, tree-fondling traitors</s> ''highly misguided'' dwarves [[Preferences|like]] elves for their ''grace''.

[[File:Lafo-sarasti.jpg|thumb|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

==Fortress mode==
===Diplomats===
Once your fort has a [[baron]], elven civilizations in diplomatic contact send a [[Diplomat#Elven diplomats|diplomat]] to [[Meeting|meet]] with them approximately halfway through the first month in [[Calendar|spring]].

If this is their first visit to your fort and you aren't at war with their civilization, the diplomat will either congratulate you for your respect for the trees, or, in the more-likely event that you've cut even one down, chastise you for your disrespect. At some point, the diplomat may revisit your fortress to establish a treecutting quota, requesting that the dwarves keep the amount of trees cut down to a variable quota. It is possible to negotiate for a higher number, and the quota seems to be affected by your noble's [[Zone#Quality_and_value|office quality]], [[stress]], and [[social skill]]s. If the player agrees to a treecutting quota, it will be visible after selecting the elves in [[Civilization and World Info|the Civilizations screen]], {{menu icon|Y}}. This quota lasts until the next year's meeting, and keeping to it will improve [[Diplomacy|diplomatic relations]], while violating it will worsen them and can lead to all-out [[war]], as will rejecting a quota entirely. '''However, agreeing and sticking to a quota in one year, and then denying any agreement in the next, will keep the relationship in a state of "alliance", allowing your dwarves to raze entire forests every second year without the elves getting unhappy about it.'''

Note that the quota is measured in trees, not logs, so be sure to fell only the largest trees on your map to get the most out of your agreement. The elves also do not care if you damage saplings that haven't yet properly developed a trunk. Elves do, however, (''misguidedly enough?'')care about [[Tree#Underground trees|tree-like subterranean fungus]] like [[tower-cap]]s and [[tunnel tube]]s; cutting fungus "trees" down does count toward your quota. How many trees they will allow can be adjusted in the [[Difficulty#Tree_quota|difficulty]] [[settings]].

In addition to haggling over tree-cutting quotas, these meetings work like any other diplomatic [[meeting]]. Your [[Civilization and World Info|civilization screen]] will be updated with new info from the world, and depending on relations the diplomat may come to declare [[war]] or sue for peace.

=== Elven caravans ===
Friendly elven civilizations send a [[caravan]] in late spring bringing a mix of natural trade goods, such as tamed animals, plant clothes, and various [[Wood#Grown_wood|grown wood]] objects.

==== Trading ====
{{main|Trading#Unacceptable items|l1=Unacceptable items}}
Elven traders are very picky about what items they will accept, and consider most items made from wood or animal byproducts to be unethical, often rejecting items merely for requiring wood or ash in their preparation. Offering them even one of these items, either in a trade or as a gift, will cause their trader to insult you and leave in a huff, ending trading for that year and damaging your diplomatic relationship with their [[civilization]]. In general, items made from [[stone]], [[metal]], [[Gem|gemstone]], non-woody [[plant]]s, or [[silk]] are acceptable, as are live animals or "grown" wooden items (generally only available from elves), but even these items can be rendered taboo with inappropriate «[[decoration]]s» or by containing or being contained in an inappropriate item.

The [[Trading]] article has specific info on [[Trading#Unacceptable items|taboo]] and [[Trading#Acceptable items|accepted]] items.

==== Stock====
[[File:grown_weapon_sprites_preview.png|thumb|142px|right|Some sprites of naturally grown elven weapons, although some standard wooden weapons will also use these sprites.]]Elven caravans will never have stone, metal, or animal products. Aside from those, you can expect an average elven caravan to have:

* [[Wood]]en [[log]]s: Always useful, unless you are in a forest [[biome]] and ''already'' drowning in wooden logs. The quantity depends on how many logs you have already: lower means more. However, caravans with grown logs tend to be rare.
* [[Plant]]-based [[food]], both from [[crop]]s and picked from [[tree]]s. These can be handy for avoiding negative [[thought]]s from eating or drinking the same old thing, or satisfying a dwarf's unusual [[preference]]. They can also be a source of [[seed]]s for your own [[Tile attributes|above-ground]] [[Farming|farm]]s, if you live in a compatible [[biome]].
* Wooden containers: [[chest]]s, [[cage]]s, [[bucket]]s, and [[barrel]]s. These are usually cheap if not decorated and useful in bulk, but even if you don't have access to wood and don't want to waste metal, there are stone, clay, and glass alternatives that you can easily make on your own.
* Soil types: [[sand]] in bags, various types of [[clay]]. Unfortunately, they don't bring enough of either for large-scale production of either [[ceramic]] or [[glass]], and neither of these are very important to have in small quantities. A bit of sand can be used to make raw glass, which is occasionally demanded by dwarves in a [[strange mood]], but other races can sell you that cheaply without needing an intervening step.
* [[Bag]]s and [[rope]]s made from plant cloth. A few extra bags never hurt, but plant cloth bags are a bit expensive.
* A few above-ground tame animals in wooden cages. It may be [[opossum|a]] [[stoat|disappointingly]] [[fox|useless]] [[hoary marmot|animal]] or [[Giant badger|an]] [[Giant tiger|incredibly]] [[Giant elephant|awesome]] [[Giant eagle|one]]. Elves bring animals from the environment surrounding their settlements, so you may be able to guess what they will bring next. Elves who live in [[Surroundings|savage]] [[Biome|tropical]] lands bring the best ones. Exotic animals are considered fully tame and will never require [[Animal trainer|training]].
* Caged tame [[vermin]]. These are only even slightly useful for pleasing dwarves with a [[preference]] for that specific type of vermin, and they may even [[Hateable|annoy other dwarves]]. The vermin itself is probably worthless, but the possibly-useful cage comes included.
* [[Plant fiber]] [[thread]], [[cloth]], and [[clothing]]. These are mainly useful for jumpstarting or replacing a [[textile industry]]. Elves wear and sell the same-sized clothing as dwarves, and may sell cosmetically-different "foreign" clothes items like turbans, skirts, or sandals.
* Plant cloth [[quiver]]s. Dwarves can't make quivers out of plant cloth, but they can easily make them out of [[leather]].
* Wooden [[crutch]]es and [[Health care#Splints|splint]]s. Easy to make, but just as easy to forget, and they're fairly cheap.
* Wooden [[armor]] and [[weapon]]s. This includes weapons and armor dwarves can't normally make out of wood, but wood melee weapons and armor are [[Material science#Material and item properties|basically useless in combat]]. You can use elven melee weapons to [[Training|train]] with before making proper weapons, but that's probably not worth bothering with.
* [[Bow]]s and [[arrow]]s, both made of wood. While dwarves can't make bows, it's very easy to make your own superior [[crossbow]]s and [[bolt]]s from wood, [[bone]], or [[metal]]. Bows are less dependent on material or quality than melee weapons, which makes them a bit more useful than most weapons bought from traders. Unfortunately, bows use a separate [[combat skill]] from crossbows, can't be used for [[hunting]], and leave you reliant on trade with or [[Goblinite|scavenging from]] non-dwarven civilizations for [[arrow]] ammunition.
* Miscellaneous other [[finished goods]] made from wood or plant fiber. These might include [[instrument]]s that dwarves cannot make or copies of new [[book]]s, but other items are only marginally useful at best. Note that instrument ''parts'' are useless, since your dwarves do not know how to assemble them into a completed instrument unless they already knew how to make that instrument in the first place.

Unless you have a shortage of something, the main unique goods elves can bring are foreign plants (especially ones you can then grow yourself), foreign tame animals (especially large war-trainable carnivores), or possibly foreign instruments or new books. Everything else is relatively easy to produce on your own, and as with all traders, any dwarf with any amount of relevant crafting [[skill]] at all will make as-good- or better-[[quality]] items.

All wooden products made by elves are called "grown". Unlike regular wood, these may be traded back to the elves without repercussions; otherwise, they are identical to the wood items that you can produce.

==Ethics==
[[File:Stasost-sarasti.jpg|thumb|right|300px|Artist rendering of an elf by Mechlin ([http://www.bay12forums.com/smf/index.php?topic=169691.msg7701761#msg7701761 post])]]

Elven [[civilization]]s' [[ethics]] often differ from those of other races. Their position on moral philosophy will likely put them at odds with [[human]]s, [[goblin]]s, [[dwarf|dwarves]], and sometimes [[kobold]]s and [[animal people]], although they favor war with goblins over other races. At any given point in time, elves and dwarves are likely to be at peace, but it is certainly possible for an elven civilization to be at war with a dwarven one at the end of worldgen. Use the tab button when selecting an [[embark]] site to view whether elves are at war with the currently selected dwarven culture, and cycle dwarven cultures to find out.

Elves are the only race which wholeheartedly accepts the devouring of enemy combatants. Looking in legends mode shows that an elven combatant will sometimes devour the other person they were fighting when they win. In spite of this, elves refuse to butcher and consume intelligent beings under other conditions. Elves find torture as an example acceptable, but condemn other forms of torture and consider torturing for information misguided. To elves, keeping any trophy of any kind is an unthinkable act. Elves begrudgingly allow for killing animals when done in self-defense, and the killing of other elves by an elf is justified if there is an extremely good reason for doing so. For elves, the killing of plants, ''especially'' trees, is unthinkable, on the other hand, the killing of neutral beings and enemies is acceptable. Elven society seems to be regulated by shame from the community, rather than by threat of punishment; as such, elves never offer serious or capital punishment to criminals; instead, elves found to have committed vandalism, trespassing or theft are reprimanded, while those convicted of treason, lying, oath-breaking, assault or participating in slavery are forced into exile.

Elves [[Personality value|value]] nature incredibly highly, and they also place a degree of value on family, eloquence, cunning, artwork, fairness, merriment, competition, and romance, but they do not especially respect commerce and have a dislike for self-control. However, even an elf will be "annoyed caught in the rain", as inconsistent as that may be.

(Note that these are merely the ethics of elven ''civilizations''. Elves may adopt the cultures of other races via wandering individuals joining civilizations, or when conquest absorbs elves into another civilization. Sentient creatures adopt the values and ethics of their culture, regardless of race. Elves living among, [[Main:Cacame Awemedinade|or even leading]], dwarves will have dwarven ethics and values, and vice versa.)

As ghastly as the concept may be, elven cultures have become more powerful since the days of [[Main:Tholtig|Tholtig Cryptbrain]], and it is entirely possible for one or more dwarven civilizations to be extinct due to elven aggression. What elves lack in engineering, crafting, intelligence, bravery, skill, or hygiene, they make up for in raw, unwashed numbers, and once-mighty dwarven civilizations may crumble to the hordes. Even more troubling is their employment of [[Mercenary|mercenaries]], often much better equipped than the elves themselves. Embarking with (possibly homeless wandering survivor) dwarves claiming to be from that civilization is possible, but always starts at war with the elves that claimed the lives of those tragically unfortunate dwarves' friends, and you may not get migrants.

==In combat==
Elves by themselves are rarely considered a threat due to their insistence in using equipment purely made out of wood in battle, which is only marginally better than fighting unarmed and generally stands no chance against a half-competent, metal-clad dwarven militia [see [[Material_science|Material science]] for more info]. However, elves will also employ [[Mercenary|mercenaries]], often much better equipped than the elves themselves.
During [[Siege#Elven_sieges|sieges]] their archers and potential numbers (like goblins, their ageless immortality means very high populations) can still be dangerous, and perhaps the greatest threat they pose is if they bring tamed animals along with them, which may range from easily dispatched creatures to [[Giant elephant|huge]][[Tiger| sources]][[unicorn| of]][[Grizzly bear| fun]] depending upon what animals their civ has access to, which in theory can include any exotic land animal including giant variants.

==Community outlook==
Due to ''Dwarf Fortress'' making ample use of the ''wood-elven'', or "elves as stuck-up jerks who live in trees" stereotype (which is especially noticeable when talking to their diplomats), the race as a whole tends to be widely [[Unfortunate accident|disliked]] by players, who aren't too happy about said stuck-up jerks trying to tell their dwarves how to live their lives and who will gladly ambush <s>and likely eat</s> dwarven children while they play in the woods.
However, due to their wooden weaponry only being ''really'' effective on said children and unarmed dwarves, elves have a reputation among the community of being all-''bark''-and-no-bite wimps who serve as the perfect punching bags to be on the receiving end of whatever [[stupid dwarf trick]] the fortress is currently conducting, especially if it's a particularly [[Fun|violent]] one - many gruesome stories involve at least one elf as the victim. The elves' nigh-religious devotion to trees is also a point of note; many players will go as far as to raze their map clean of trees, for no reason but to spite the elves and provoke them into attacking, just for the chance to slaughter them all.

Unlike many other fantasy settings, ''Dwarf Fortress'' elves have very few redeeming characteristics (they aren't any more attractive than a dwarf, human or goblin, [http://tolkiengateway.net/wiki/Celebrimbor aren't good smiths], and don't have any superhuman abilities beyond biological [[immortality]], a peculiar ability to walk through grass and other ground covering plants without disturbing them, and a (currently) off-screen ability to "shape" wood via magic - one of their few other saving graces is their potential to provide fully-tamed exotic animals for trade), though most long-time players play their antics for laughs, resulting in them essentially being the community's collective chew-toys. Many players will take on a Tolkien (''or, more likely, Warhammer Fantasy'')-esque dwarven spirit of hatred towards elves, slaughtering them for their actions against dwarven kind; or perhaps, compelled by some god of murder for the simple glee of the resulting elven blood rain. Being compared to an elf is particularly insulting, as it implies you're an unwashed, tree-loving, cannibalistic hippie (''or, as [[Dwarf#Community_outlook|some have said]], the kind of being that's prone to sitting around and living '''in''' the world, rather than acting upon it''). That's not to say that elves are universally disliked, however: some have earned the liking of the player base, typically due to them being part of a dwarven civilization (and as such, not acting like elves), with [[Main:Cacame Awemedinade|Cacame Awemedinade]] being one of the community's most well-known and beloved characters.

{{gamedata}}
{{gamedata|title=Entity ([[civilization]]) Raws|{{raw|v50:entity_default.txt|ENTITY|FOREST}}}}
{{Creatures}}
{{Category|Races}}

On the origins of dwarves

2026-03-03T17:44:47Z

DPhKraken: "dwarfhood" implies a non-dwarven life stage, so "adulthood" would be a better correction

{{D for Dwarf}}

Piecewise's <s>article</s> <s>masterstroke</s> work of art on the forums needs to go here, so all can admire it.

== "On the Origin of Dwarves" ==

Long before our times, during the times of yore when great beasts stalked the darkness and tore civilization’s forebears asunder, there came to this world a strange new race: the dwarves. The ancestry of the dwarves is muddled and confused, often times contradictory, impossible, incestuous or all three. This can mainly be contributed to the dwarven tendency to keep their history through the use of engravings, rather than books or even oral tradition. Dwarves, being a subterranean people, rarely create paper and lack the memories to pass down stories of their ancestors in any reasonable fashion; this inability is mostly blamed on their near constant state of inebriation. Also unfortunate to would be historians is the dwarven tendency to place these historical engravings 60 feet underground and surrounded by all manner of deadly traps, questionable architecture and various slavering beasts. If one didn’t know better it would seem as though they are deliberately hiding their past.

Through what can be recovered the origin of dwarven kind (according to their creation myths) is as follows:

Once, long ago, a particularly ugly and foul tempered mountain goat raped a particularly hairy and insane Mandrill atop a pile of stones and vomit. From this coupling was born the first of dwarven kind, the Mountain King. He was born with a battle axe and bottomless tankard clutched in his tiny hands and his body was covered in such copious amounts of hair that he might easily have been mistaken for a bearded bear cub. The Mountain King was raised by a Granite Boulder and grew strong upon a diet of booze, cave mushrooms and the blood of his enemies. At age 4 he killed a bear in a staring contest and at age 7 he domesticated the first wagon. Upon his ascendancy into adulthood he destroyed the boulder which had raised him and reshaped it into the first anvil, proclaiming:

“Reg limar, abod ber, avuz thol, or mabdug, nokor buket!”

These words would echo forever through dwarvenkind, though it is said that another phrase was within this motto. The lost phrase is said to have been:

“Gatiz emar agak.”

Though what this phrase means has been lost to us and inquiries to dwarven historians often end in violence. What little can be gathered is that it seems to relate to animal husbandry.

His childhood behind him, the Mountain King set about founding the first Mountain Home, digging out most of the mountain by himself using only his bare hands and frighteningly calloused manhood. His lavish home now complete and balanced entirely upon a single pillar he set out to make his name known and to find a wife worthy of bearing his fuzzy offspring. The first civilization he came upon were the elves, a race of naked and eternally beautiful feyfolk who abhorred the use of trees or animals for any means. It was said that when they met the Mountain King, he was in the process of beating a mountain lion to death with a wolf. The elves, in their kindness, attempted to persuade the Mountain King to follow their naturalistic ways. In response the Mountain King tore off the head druid’s face and promptly began using it as his undergarments. Before the shocked elven masses he announced:

“Etar linem etes gubel lor."

Which, roughly translated, means:

“Your king blows my bulbous tool.”

Since this epochal meeting the relations between the elves and dwarves have continued to be tense, often times ending in massive forest fires, rampant cannibalism, horrifying dismemberment or, worst of all, crossbreeding. His duty done, the Mountain King continued his journey through the primal world. He next came upon the goblins and was delighted to find that their skinny limbs and necks broke with even the gentlest of hammer blows. After a brief campaign of recreational genocide the Mountain King grew bored of his new playthings and continued on, leaving the goblins broken and scattered, connected only by their intense hatred of small, bearded people. This hatred continues to this day, resulting in nearly constant goblin raids against dwarven settlements. Unfortunately, goblins' limbs and neck still snap with the ease of twigs, making these valiant efforts more or less meaningless.

The last race which the Mountain King discovered was that of Humans, still in their fragile and frightened infancy. Taking rare pity upon the gangly and awkward race, the Mountain King gifted them with weapons, armor and booze, ensuring a stable business and war partner as well as drinking buddy for generations to come. It was after finding this last race that the Mountain King realized he was still without a wife and was beginning to feel the effects of his decades of celibacy. After a tour of countless brothels and leaving a swath of broken pelvises and dislocated jaws behind him The Mountain king finally returned to his home. Determined to have his bride, the Mountain King built a tower to the heavens themselves and petitioned Armok, God of Blood, to grant him a wife. Armok agreed, on the condition that all their descendants from first to last be cursed with a tendency to die horribly. The Mountain King gladly agreed.

The wife which he was given, The Queen of All Stone, was truly a rightful receiver of his seed and wore a beard that could match his own. It was from these two that all dwarven kind sprang (or walked, being that dwarves don't really spring, hop, jump, skip or do anything that means removing more than one foot from the ground).

From this common ancestor onward the genealogy is scattered and unsure, engraved upon bars of soap and metal beds across the world. Many believe that the first child of the Mountain King was a girl by the name of Urist. Records become scarce beyond this but what little can be found indicate that she was notorious trickster and prone to paranoid mania, preferring to remain isolated. From this point on we can only guess.

== Urist's Anatomy ==

Dwarves are, by weight, 40% Body hair, 30% alcohol, 6% calluses, 12% anger, 7% muscle, 1% skin and 4% miscellaneous. Their blood does not have different “types”; rather it has a variety of “proofs”. Their bone structure is not unlike that of a man, though much stouter and more dense. The exceptions to this comparison come mostly from two places: the legs and the head. Dwarves, for whatever reason, lack knees and are therefore incapable of things like hopping, skipping, running in a dignified manner or bending down without falling prone. Dwarves, however, seem to prefer it this way and regard anything requiring knees as being the actions of “elven silly nannys”. Several of the other strange anatomical designs are centered in the head and the curious structure of the dwarven skull. A dwarf’s beard is actually connected directly to the bones of his jaw and palate and is comprised of a thick mane of hair like cartilage growths. These growths are actually quite sensitive to certain stimuli and allow a dwarf to detect things like an abandoned pigtail sock, even from miles away.

The dwarven skull is composed of only two very thick bones, one being the mandible and the other consisting of the entire rest of the cranium. This strange configuration seems to be an adaptation to generations of cave-ins and the popular dwarven drinking game “Smash rock with face”. Unfortunately the thick and solid skull compresses the dwarven brain and induces a species wide mental syndrome not unlike severe bipolar disorder. This means that dwarves are highly susceptible to sudden and often violent mood swings, shifting between murderous rage and enthralled stupor with only a particularly nice sock or table as the cause. Another interesting anomaly, or lack of anomaly, is that of the dwarven liver. Dwarves, as a race, are dependent on alcohol from birth; it has been proven that it is not simply conditioning but that the dwarven body is actually dependent on alcohol to perform at its best. While the exact process that makes them dependent and why it is so necessary is still unknown, it does appear as though the dwarven body is paradoxically not equipped to deal with the massive amounts of alcohol it must imbibe. The dwarven liver is by no means more effective or efficient when it comes to filtering the massive amounts of booze that a dwarf drinks, leading to liver failure to be the leading cause of death among dwarven kind (followed closely by “bludgeoned to death by enraged soap maker”).

Beyond these obvious abnormalities are the less known and harder to distinguish differences in dwarven anatomy. Dwarves are a methodical and stubborn race to the point that every aspect of their life is directly influenced. Dwarves work, party, drink and sleep in marathon-like stints, often times continuing a single party or drinking binge for months on end and their inherent stubbornness makes it nearly impossible to change tasks quickly even if their lives depend on it. It is far from unknown to hear of a dwarven fortress falling to invading hordes simply because the fortress guard were in the middle of a 6 month nap or drinking themselves comatose. This tendency has lead to the adage “oblivious as a dwarf on break”.

Beyond their stubbornness dwarves also exhibit a variety of odd behaviors, some of which seem to be related to their physiology while others are more idiosyncratic. A dwarf’s chosen profession seems to influence his thought patterns in radical ways, often leading to specific phobias and reckless behavior. Non-military dwarves, for example, seem to universally develop a crippling fear of all animals, even the most harmless. It’s not uncommon to see panicking works-dwarves running in abject terror from things like mountain goats and perturbed llamas. Military dwaves, on the other hand, seem to completely lose their sense of self-preservation and run heedlessly into battle, ignoring tactics in favor of fanatic yelling. So removed from their sense of fear are the warrior women that they often carry their children into battle, a tactic which often ends in tragedy; It should be noted, however, that there are few sights more frightening then a dwarven woman, bare from the waist up, holding a suckling newborn in one hand and a battleaxe in the other, charging toward you.

The debate on the subject of dwarven depression and anger is a complex one at best and is hard to study without significant risk to life and limb. It’s a well known fact that dwarves are particularly mentally unstable and subject a great many psychoses. One, as yet unproven, theory asserts that this tendency toward madness is actually a inborn limiting mechanism to control the number of dwarves occupying a certain area. It is a documented fact that, as a dwarven civilization grows in population the risk of insanity and depression also increases. Indeed it is impossible to walk into a thriving dwarven civilization and not see at least a handful of raving mad-dwarves screaming at the walls. The Theory asserts, however, that these harmless, though insane, individuals are not the purpose of the madness, merely a unforeseen failing. The true purpose of the madness is to limit population numbers through murder, suicide and random dwarfslaughter. Indeed it does seem that large dwarven civilizations are often brought down by internal subterfuge, mass suicide and ritual murder (or by poor architectural planning).

This inherent tendency toward insanity, whatever its cause, seems to have given dwarves an odd sense of art as well as particular building talents. Dwarves are known world over for their proficiency in metal working and weapon crafting as well as mechanical skill, however it is their decorative arts that are perhaps the most interesting. Take for instance a random piece of dwarven armor, a copper gauntlet in this case. Its construction is of the highest order and it is menacing with iron spikes, however perhaps the most frightening thing is its decoration. Recreated in painstaking detail is an image of a horse. The horse is screaming. Often times things such as dining room walls and children’s toys are adorned with images of violent slaughter, terrible holocausts and the occasional giant mushroom. Its not known exactly why dwarves would decorate their homes in such manner, but the scenes of violence actually seem to stave off fits of madness and violence, perhaps acting in some sort of primitive cathartic manner. Or perhaps dwarves just genuinely enjoy images of bloody dismemberment and triangles.

== "War, Peace and Fell Moods" ==

The dwarven society is a complex and puzzling one, when compared to our relatively simple human society. Where as we seem to be guided mostly by instinct and desire, dwarves are driven by an entirely different kind of morals and ambitions. For instance, it is still completely unknown, even by the dwarves themselves, where their orders come from. Despite the existence of nobles within their society dwarves seem to act independently yet, paradoxically, also as a whole. For the non-informed imagine it like this. One dwarf may decide to mine out some stone, while another may decided to cut stone blocks and yet another may decide to assemble these blocks into a wall. These dwarves do these actions without the knowledge of what their fellow dwarves are doing and they seem only to do this on a whim. Theories of hivemindism abound, but perhaps the most interesting theory is that, in line with dwarven creation myth, the dwarves are being influenced and semi-puppeted by Armok, the dwarven god of blood, or His helpers. However, these speculations remain simply blind guesses.

A brief glance at dwarven society reveals it to be something like Feudalism, with many settlements under the ultimate control of a Monarchy. However, in depth study reveals that the tiny fraction of nobles actually seem to have very little to do with anything outside of trade relations. The prevailing opinion of the dwarven working class is that nobles are slightly touched in the head and their orders border on delusional. Its common for nobles to attempt to restrict the trade of items that do not exist and often can not exist in a specific settlement; they're also known for their strange obsessions over seemingly random objects and will demand their manufacture, much to the annoyance of the general masses. Some believe that nobles are simply dwarves which have some how escaped whatever force binds and orders the rest of the workers, leading them to be unreliable and mentally unsound without the external control. In this situation the Aristocracy is seen more as an aggravating and demanding elephant graveyard, a position that the worthless and potentially dangerous of dwarven society are “promoted” to, in order to keep them away from weapons or heavy machinery.

The possible exceptions of this rule lie within the dwarven justice system, specifically with the sheriff and the Hammerer. Dwarven law is seemingly draconian in many ways, but is also rather progressive. Dwarves put a great emphasis on the lives of living creatures (so much so that they consider the killing of a tame, non-food animal equivalent to murder) and as such have no capital punishment. What they have instead though, could be said to be even worse. Dwarves have three forms of punishment: Imprisonment, beating and Hammering. The first two are relatively minor, with even the harshest of beatings generally resulting in only minor injuries, it is the final punishment which is the most feared. The Hammering is doled out by the Hammerer, the dwarven equivalent of an executioner who wields a war hammer rather then an ax or sword. Hammering is simply that, the condemned receives repeated blows with the war hammer until either the sentence is carried out or the criminal is dead. While death is not the express purpose of the hammering it is often a side effect, with the other outcome usually being serious, crippling injury. Unfortunately one of the crimes which can possibly net this debilitating consequence is that of failure to comply with work orders, meaning that innocent dwarves may have their heads caved in for their inability to make glass in the middle of a frozen tundra. Its not surprising that nobles tend to meet their ends under suspicious circumstances and are often found under mysterious cave ins or floating face down in the moat.

Despite their warrior mentalities and fierce personalities dwarves have shown themselves to be passive aggressive at best (and aggressively passive at worst). While they are known for their fighting ability and boastful nature they rarely conduct war as an invading force, preferring instead to let the foolhardy enemies break themselves upon the fortresses' walls. A common dwarven saying that of “The best place to insult your enemies is behind forty feet of stone.” Its not to say that the most famous dwarven conflicts were those between dwarves and other sentient beings, far from it in fact. Perhaps the greatest example of the, ahem, quirkiness of dwarven culture is that the grand fortress of Boatmurdered. Boatmurdered endured the normal hardships of a dwarven settlement, namely constant raids from goblins and an inherently unstable society, but there was one main difference: elephants. It is, to this day, not known as to why the settlement was founded so close to the forest of “Tuskydeath”, but the outcome was nothing less then horrifying on all sides. For years the dwarves and elephants traded blows, usually resulting in the brutal impalement or trampling of dwarves or the imprisonment or death of the elephants. This conflict culminated in the creation of a “doomsday device” which was used to halt aggressive flooding as well as to flash boil most of the wildlife. Since the final fiery end of Boatmurdered a fragile truce seems to have been enacted between the elephants and the dwarves, if only to prevent such slaughter from ever occurring again.

Unfortunately one creature that continues to be a continuous hazard to dwarven kind is that of carp. The official myth of the dwarves is that Armok created the carp out of river rocks and instructed them to mutilate random passersby. Regardless of their origin carp are considerably dangerous to dwarves, fisher dwarves in particular. Its not uncommon for fisher dwarves to be dragged into the river by swarms of these blood thirsty beasts. Some dwarves die as they are snatched off bridges or while gathering water and are never seen again, at least in one piece. Worse than river carp are the popularly named “death pool carp” or carp that have become trapped in murky pools. These pools are death traps and can be fatal to anything which wanders too close. Perhaps the most terrifying is the idea of what dwarves refer to (in hushed tones) as skeletal carp. These creatures are the remains of carp, animated through dark means, and are reported to be “faster than a beak dog and stronger than an ogre” as well as nearly immune to any sort of conventional weapons. There are reports of hordes of these strangely animate corpses galloping across the bleak and blasted wastes, tearing apart anything which gets in their way. Exactly how a fish, undead or not, can gallop is something beyond this writer's comprehension.

== The Book of Job(s) ==

Dwarven culture is one dominated by toil and greed, leading most dwarves to be little more then glorified workhorses for the vast majority of their lives. It was once remarked of a dwarven miner that “there has never been a life as cruel or mercifully short as his”. In general dwarven labor is separated into two categories, crafting and hauling things about. For instance, a carpenter is considered a craftdwarf, as he creates useful objects from a raw material; a woodcutter is considered a hauler because his job consists mainly of chopping trees and lugging them around till he inevitably dies during some sort of animal attack. Almost all known dwarven professions have been complied and documented here for the sake of…well, record keeping.

[[Mining]]:
The noble, humble and very crushable miner is a job of both great importance and great ineptitude. On one hand the lives and livelihoods of all other dwarves depend on their ability to carve away the mountain and protect their comrades from the harshness of outdoor living. On the other hand their only discernible skill is the ability to swing a pick and (usually) not get crushed by falling rocks (maybe). It should be noted that, though both the job and the worker are relatively simple, the work does tend to produce sculpted, muscular dwarves ripe for military usage. Let us not forget the tales of dwarven work camps being defended by Herculean miners, their massive arms bulging as they embed pickaxes into elven hearts and minds.

[[Wood cutting]]:
The wood cutter is much like his miner counterpart: essential to many facets of the modern fortress and yet requiring the rough mental equivalency of a wagon wheel. However the wood cutter faces many more dangers in his line of work, from braving the horror of the wide open sky to battling the various forest creatures (sometimes including elven assassins). Unfortunately the woodcutter gains even less recognition than the miner, probably because the material he harvests only has a small set of uses within a well established fortress.

[[Carpentry]]:
Carpenters make various things out of wood, a practice that was deemed “Dangerously elf-like” many generations ago. Because of this carpenters are viewed either as outcasts (if they enjoy their job) or as unfortunate souls doing a terrible duty out of necessity (if they don’t like their job). While it is grudgingly acknowledged that some wooden things are necessary, at least early on, this does not mean that dwarves have to like this fact. In the grand scheme of things dwarves view carpentry as somewhere between manure shoveler and rapist on the scale of social agreeability.

Generally Carpenters and Wood cutters are tolerated as essential for the sheer fact that they make elves cry.

[[Masonry]]:
A mason has a strange place within dwarven society. They're generally seen as respectable by most, their job being one of the more useful and in demand; however they are also sometimes seen as heretical and dangerous. This belief stems from a common dwarven idea that the mountain and natural stone are all around better than anything that they or any of the other races could throw together; as such it’s seen as rather impertinent that a mason would try to “improve” on the natural rock by making unnatural things out of it. However the groups that truly think this tend to be small fringe groups, many of which also believe that the masons are a world spanning cabal intent on taking over the world and then carving all the mountains into giant cheese statues.

[[Engraving]]:
Engravers are an odd bunch, perhaps the most innately subversive group in any dwarven fortress. During times of relative calm they enjoy carving things like triangles and mushrooms, perhaps in an attempt to create some sort of weaponized boredom. However, in troubled times they delight in covering every flat surface in an endless array of disturbing images; it's not uncommon for dwarven bedrooms to be adorned with mosaics of the inhabitant’s loved ones being gored by elephants or trampled by goats. Engravers are often described by their peers as “arseholes”.

[[Animal training]]:
Despite the job title this dwarf seems to have the perplexing task of randomly releasing various terrifying animals from their cages and promptly getting mauled. It seems that occasionally they may accidentally domesticate one of these snarling beasts but this can probably be chalked up to chance. Very rarely they also teach dogs to bite goblins where it hurts.

[[Animal care]]:
See Butcher

[[Health care]]:
See Burial

[[Fish cleaning]], [[small animal dissection]], [[fish dissection]];
Dwarves with any of these jobs seem rather unbalanced and are prone to fire starting and bed wetting. It’s advised that one should keep at least ten feet from them, for a variety of very good reasons, not the least of which being that they are coated in the internal fluids of untold house pets.

[[Butchery]]:
The butcher serves essentially the same purpose a human butcher does, though dwarven butchers seem to prefer battle axes to meat cleavers and enjoy their job a great deal more. While dwarves can live quite healthily on a diet of Plump Helmets they are renown for their delight in all manners of carnivorousness and as such the Butcher is seen as a welcome friend, a bloody and wide eyed bartender. The difference here is that the drinks are undercooked and made from cats.

[[Leatherworking]]:
Dwarves have a code of morals surrounding animals that is strangely familiar. They abhor the torture or mistreatment of their furry companions but seem to have no problem slaughtering, skinning, and eating them wholesale as long as it’s done in a specific manner. This means that there is often a vast amount of usable leather from various beasts and house pets just laying around the fortress, making leatherworking a stable job indeed. Dwarves seem to possess a strange affinity for elf leather products, perhaps a hold over from the leather thong of their great forefather the Mountain King.

[[Tanning]]:
This is the middle man between pet and sock, the great equalizer of life and upholstery. The tanner has the glorious job of taking the semi-rotten skin of various animals (and occasionally people) and transforming it into fine leather to be used as a raw material. It’s unknown how dwarves go about this process, as the human method of tanning requires large tracts of time, various foul chemicals and generally produces an odor that is noticeable for miles. The dwarven Tanneries are, by comparison, tiny workshops often located next to living quarters or even within kitchens. When questioned about this perplexity dwarven tanners whistle and attempt to look uninterested

[[Farming]]:
Dwarven farming takes two paths, the normal above-ground farming which we are familiar with and more exotic underground growing. Dwarves seem to prefer the act of farming underground, even if they occasionally delight in the exotic brews made possible by above ground plants. Beyond the dwarven nutritional staple of booze the farms serve a lesser purpose of producing food and raw materials. Dwarves seem unconcerned about what they eat in most cases and can easily live out their lives subsisting on a diet of Dwarven wine, plump helmet and the occasional side of cat meat; This leads to an overwhelming majority of plump helmet farms which in turn leads a dwarven farm to resemble a scene from Alice in wonderland, albeit a dark, dank, vomit reeking wonderland populated by manic-depressive midgets.

[[Fishing]]:
Depending on the area the job of a fisherdwarf can either be a luxury or a death sentence. In most areas the work of a fisherdwarf is dangerous only because of its need to be outside, amongst wild animals and horrible sky. However if [[carp]] are involved this normally menial job becomes a game of roulette, with every moment being just another chance to die. From the few historical carvings we have we know that the dwarves once had a 4th punishment, in addition to their current triad of prison, pummeling, and pounding; this fourth punishment entailed forcing the condemned to fish in a carp infested river till he was finally set upon by the beasts. This punishment was eventually banned, partially because it was deemed too cruel and partially because it tended to have a mortality rate of 4 or 5 rather then the intended 1 as guards and spectators were also dragged to their fishy end.

[[Soap making]]:
Strange does not begin to describe this particular labor, The strangeness of it stems from the fact that dwarves are seemingly incapable of using soap for its intended washing purposes, choosing instead to stacking it about or simply trade it away. The soap maker himself seems perplexed by his creation yet continues to make it. Various men have tried to instruct the dwarves in the use of their creation however they remain seemingly mentally blocked from comprehending its purpose. However, men have also tried to teach the dwarves the meaning of being on fire and were equally unsuccessful, so perhaps there is simply some sort of cognitive dissonance involved.

[[Furnace operating]]:
There is a saying which goes “When a dwarf and fire are wed, the former will inevitably end up dead.” This, above all else, accurately describes the dwarven relationship with things hotter then body temperature. As such it’s surprising that furnace operation is such a safe job, indeed there are no reports of fatalities directly relating to the furnace operator’s job (unless being caught in a cave in counts). How this record is maintained appears to be a complete mystery to all involved, including the Operators themselves. However, since it seems to take the average Operator something like a week to do even the simplest of tasks one could surmise that the record is the result of extreme safety measures or simple cowardice.

[[Wood burning]]:
Wood burners lead a charmed life, revered as heroes for their use of fire to destroy the scourge that is above-ground nature, yet constantly hunted by elven assassins for the same reason. Wood burners are often local celebrities and are the pride of a fortress but the position is rarely volunteered for. The elves, in their endless attempts to destroy dwarven values, have singled wood burners out for death. The term of a Wood burner is usually ended when he his found face down with an oak arrow embedded in his spine.

[[Lye making]]/[[Potash making]]:
This labor includes letting ash float in water and then letting that water dry out (maybe). It also includes setting one’s hair on fire in a desperate attempt to liven up one’s bleak, ashy existence.

[[Weaponsmithing]]:
The act of making a hammer with another hammer, creating the paradox of “where did the first hammer come from?” Weaponsmiths are often hulking brutes of considerable strength, perhaps second only to dwarven accountants in sheer muscle mass. Their job mainly consists of lifting something heavy and smacking it against something hot till something sharp is made. They are considered the backbone of the army, both for their skill in weapon creation and for their general propensity to cave in goblin skulls with their hammers.

[[Armoring]]:
The rival of weaponsmithing, it’s not uncommon for inter-fortress arms races to pop up as weaponsmiths and armorers compete to one up each other. (in this case however I’m referring to the ancient dwarven tradition of “arms races” in which the participants drag themselves around the fortress using only one arm.) The armorers say they are more valuable because you only need one weapon, but many items of armor.

[[Blacksmithing]] and [[Metalcrafting]]:
The work that doesn’t fall into either armoring or weaponsmithing is relegated to the humble blacksmith. The Metalsmith makes the much more mundane objects needed by the fortress, including cups which no one uses and coins that generally have no value.

[[Gem cutting]] and [[Gem setting]]
Gem cutters are the jewelers of the dwarven world and are known for their flamboyant nature and sequin cloaks. They are often found, prancing about the tunnels with small hammers, gathering the raw material for their labor before returning to the shop to gently chisel away. While not a particularly proud part of the fortress gem cutters are tolerated for the vast wealth they bring in. Curiously they’re all named Shirley. Gem setters are a fair bit more dignified, even if their casual attire is a jewel encrusted codpiece.

[[Bonecarving]]:
A habit most pick up in jail is actually a time honored tradition within dwarven society. It’s well known that dwarves prefer to use just about every part of an animal (not because of any sort of ethical ideal, but because it increases profit) and that they have a vicious sense of ironic humor; as such the act of turning elephant bones into arrows with which to shoot more elephants is seen not only as cost effective but as a genocidal good time.

[[Stonecrafting]]:
One thing that dwarven society is never short of is spare rocks and it is the stoneworker’s job to turn all this useless debris into equally useless trade goods. Some of the strangest things a stonecrafter can make are stone musical instruments. How exactly one is expected to play a stone harp is lost on this author.

[[Woodcrafting]]:
Like carpenters, woodcrafters are often the object of ridicule and anger. They do, however, have one talent which brings them some social standing: the ability to make wood bolts for crossbows. As mentioned before dwarves have a love of poetic justice and as such greatly enjoy killing elves with wooden arrows. A famous dwarven general once said of a particular conflict with the elves: “They demanded to know what we had done with all their precious trees. So our archers showed them.”

[[Glassmaking]]:
Dwarves have a perilous relationship with glass. On one hand it’s fragile, a quality dwarves detest. On the other it’s shiny and involves fire in its creation, both qualities which they love. Regardless of their opinions on the substance glass tends to have few if any practical uses within a fortress, being that windows aren’t exactly a necessity a mile beneath the earth. Much like the stonecrafter the glass maker seems to focus his efforts on building things like Goblets which dwarves never use and toys which will invariably shatter into some child’s hands and eyes. However, unlike the stonecrafter, the glassmaker’s raw material is time and resource consuming to create. This leads to the common impression that dwarven glassmakers are insane.

[[Siege engineering]] and [[Siege operating]]:
Merchants of death on a grand scale, Siege engineers create the dwarven weapons of mass destruction: the ballista and the catapult. Regarded as talented though a bit off, as they tend to test their wares on migrants and unsuspecting wildlife, much to their own delight.

[[Mechanics]]:
The dwarven mechanic is usually considered one of the most intelligent of dwarven society, capable of constructing everything from power generators to deadly traps. Oddly enough they require only one type of mechanism to do this, though the number of these mechanisms varies from machine to machine. Humans have for years tried to discover the method by which such complex apparatuses can be constructed with only 2-3 parts and have in-so-far been unsuccessful. Another mystery is the way in which mechanics can mechanically connect two objects, even across massive distances, with only two of these mechanisms. When we questioned a dwarven mechanic by the name of Hertz about this seemingly impossible phenomenon he merely shrugged and replied “Ich habe keine Ahnung, aber es ist recht interessant.”

[[Weaving]]:
While the task of weaving is usually relegated to the women of other races dwarves hold no such sexist policies. Instead they have much more dangerous policies, like capturing enormous spiders and feeding them a constant diet of crippled goblins in order to harvest the spider’s web for high value silk production. It should be noted that the dwarves also do not discriminate who to feed to said spider based on sex, race or age; in other words it’s equal opportunity murder all around.

[[Dyeing]]:
A favorite activity of dwarves, especially those near volcanoes or cliffs.

[[Clothes making]]:
Dwarves are a simple race when it comes to clothing; many wear and in fact prefer to wear simple clothing. Of course this simple clothing invariably degenerates into rags, prompting the creation of new clothing. After all, spending is better then mending. Counter-intuitively, though, the post as clothier is rarely filled, meaning that the demand for new clothing often goes unanswered. When asked why so few are willing to become a clothier most dwarves will simply scream and run, while the few braver souls will recount stories of horrible carnage and destruction. It is believed, after careful study, that the loom is actually a distant cousin of the Wagon; however, unlike the wagon, the loom is capable of moving of its own accord. Loss of life and limb is rife.

[[Milling]]:
Dwarves tend to do this when they should otherwise be working.

[[Hunting]]:
In theory this is the practice of bludgeoning, stabbing or shooting various wildlife to death in order to use their carcass as food or raw materials. In reality it’s the practice of wandering into the forest, getting trampled or gored and then dragging one’s crippled self back to the fortress where one then occupies a bed for the rest of one’s natural life.

[[Brewing]]:
Brewers are loved above all others in their community and in the cases of exceptional brewers almost worshiped. A master brewer will often have a harem of comely young women (or nubile young boys) along with substantial treasure and fame. However a brewer who disgraces the practice by brewing sub-par drinks will be ridiculed and despised, or in some extreme cases publicly lynched. It should be noted that many of the aforementioned actions and decisions happen while the participants are extremely inebriated on said brewers beer. This has lead to the adage “Madder then a Dwarf on Sewer Brew”

[[Plant gathering]]:
The act of tearing various plants out of the ground for various purposes, the favorite of which is “just to annoy the blasted elves”. The brewers do thank the gatherers - sometimes.

[[Milking]]:
Dwarves are quite odd in their choice of which animal to milk. While all manner of mammals are available to dwarves, including the cow, camel, ox and goat, dwarves instead choose a insect as their only source of milk. Beyond this they chose a maggot that many dwarves find detestable and that can only be milked once a season. When asked why they would do something so counter-intuitive most dwarves look embarrassed and attempt to change the subject.

[[Cheese making]]:
Because milk is a rather rare commodity in dwarven society, for aforementioned reasons, the prospect of cheese is rather dubious. Because of this dwarven cheese is actually extremely valuable, equal to dragon meat. This author wonders if the choice of “dwarven” cheese rather then “purring maggot” cheese has something to do with this, though dwarven cheese implies rather disturbing things in and of itself.

[[Cooking]]:
Dwarven cooks are only grudgingly accepted into society, mainly because they are seen as an unnecessary step between the raw meat of the butcher and a potential meal. The dwarves are not particularly unreasonable in this either as it is a well documented fact that dwarven cooks do not, in fact, cook anything. Raw meat, plant products and Minced wine are simply mixed together to create “roasts” and “biscuits”. While these names may sound appetizing the reality of the matter is that they are gelatinous masses of grayish moist unhappiness. While many outsiders think that the miasma found around kitchens is the result of rotting food, it is actually a byproduct of successful cooking.

[[Trapping]]:
Imagine, if you will, a great and grizzled mountain man with a long flowing beard and eyes shining like two great lumps of coal. Imagine this man holding a bear trap. Imagine this man chasing a mouse with this bear trap. This is the basic scenario of dwarven Trapping.

[[Architecture]]:
The dwarven architect is often uneducated and inexperienced, sometimes picked simply because he is the closest to the current construction job. Thus thrust into his new position the unfortunate victim usually fails terribly, often ending in the deaths of several masons and the stranding of many more. In order to avoid embarrassment the project foreman has the architect jailed and supposedly executed. However, rather then actually executing him the foreman simply gives the victim a false beard to wear over his real one and then reintroduces him into society. By the end of his life time the average dwarf is reported to be wearing no fewer then 3 false beards over his real one.

[[Category:Humor and stories]]

Profile

2026-03-03T17:34:13Z

DPhKraken: /* Thoughts */ Add image and links

{{migrated article}}
{{Quality|Unrated}}
{{av}}
:''(For workshop profiles, see [[Manager#Setting_workshop_profiles|Manager]].)''

The '''profile''' (or character sheet) is an important part of the [[interface]], giving all information you can ever need (or better get by normal means)* on a particular dwarf. The profile is accessible by clicking on a dwarf, and consists of several screens (or tabs): Relations, Groups, Military, Thoughts, Personality, Overview, Items, Health, Skills, Rooms, Labor.

After clicking the dwarf the overview screen (tab) is shown giving you an overview of their
:* upper left box: gender, age, most important family relations and pets (if any)
:* upper right box: notable characteristics
:* second row box (left): (current) health status
:* second row box (right): current positions (administrativ and noble)
:* third row box (left): hauled (job) item, only one is shown, if multiple are hauled. Might be ie. wheelbarrow, if one is currently used by the dwarf.
:* third row box (right): current assigned squad (if any) and highest combat related skills
:* fourth row box (left): highest labor/job related skills
:* last row box: a quote from the dwarf (ie. about their most recent activity or their general view on life or how they are feeling) and their most recent thoughts and memories. This can give an overview of some of the most recent activities of the dwarf.

Also on the top right side of the profile their are some buttons to view the dwarf's (recent) combat history, customize the dwarf's name and profession (ie. give the dwarf a nickname), set the camera to follow the dwarf around and a button to send the dwarf somewhere else (ie. send the dwarf to a linked site, if any, or outright expel the dwarf).

The other tabs of the profile can be accessed by clicking a tab (above the boxes) in the profile.

''Note:'' *): Some stats (ie. concrete current attribute values, raw skill level, amount of skill experience etc.) are either not acessible by normal means (except ie. using utilities like gui/gm-editor of dfhack) or only acessible (shown), if df is run with dfhack.

==Breakdown of (other) tabs==
===Relations===
{{main|Relationships}}
This section is accesible by clicking the "Relations" tab. It lists the relations with other dwarves, worshipped deities (and/or religions), pets and bonded animals. Close family relations are listed first, then any worshipped deities, followed by pets and bonded animals and at last the non-kin relationships to other dwarves (and sentient beings) are listed. The more relationships, generally, the happier they are, but also the more impacted they will be by potential deaths.

===Groups===
This lists the current and former groups (also known as entities) the dwarf does (and did) belong to, their ties to that group and the positions the dwarf holds (or did hold) in that group. Every entry gives the name of the group, the type of the group/entity (ie. civilization, site government or guild) and the tie the dwarf has to the group (ie. citizen, in case of a civilization). Groups, where the dwarf holds (or did held) a position, will be listed multiple times as each position is also a link/tie to a group. Also note for each unique position (like manager or mayor) of a group only one entry is added, ie. if a dwarf was previously a manager and is again serving as a manager, it is only mentioned that the dwarf is currently the manager (and not that the dwarf is also the ex-manager), but for each squad the dwarf was (or is) part of the list will have an entry, also for each different militia captain (squad leader) position the dwarf holds (or did hold) an entry is listed (as each squad has its own unique leader).

===Military===
Has three sub-tabs: squads (opened after clicking on the military tab), uniform and kills. If the dwarf is in a squad the name of the squad and the current orders are listed (in the first tab, opened upon clicking the military tab). The second tab gives an overview of the assigned uniform (if any) and the third tab shows the kill list.

====Kill list====
A dwarf's [[kill_list|kill list]] is a record of what creatures they have killed ([[meat industry|slaughtering]] aside). Only dwarves that have actually killed things in hostile combat get kill lists. Some dwarves arrive at your fortress with a few kills already under their belt. Although vampires draining others of blood count as kills, in practice their true kill lists are hidden and usually empty as part of their disguise.

===Thoughts===
[[File:Thoughts_v50_preview.png|right|258px]]
''See also: [[Thought]] and [[Memory (thought)|Memory]]''

This screen is accessible by clicking on the "Thoughts" tab. It has two sub-tabs: Recent thoughts and Memories.

The Recent thoughts (sub-)tab gives you a list of the recent thoughts of the dwarf (see [[Thought|thoughts]]), with the most recent thoughts (and remembered memories) listed first (in comparison to the list on the overview tab this list is much longer).

The Memories tab gives a lists of seasons and the memories the dwarf has gained in that season (see [[Memory_(thought)|memories]]), if a listed memory (upon becoming a core memory) did change a personality facet (and/or value) it is mentioned here (but is not generally mentioned, whether a listed memory has become a core memory or not).

===Personality===
[[File:Personality v50 preview.png|right|thumb|A miner's mind.]]
This tab consists of four sub-tabs (Traits, Values, Preferences, Needs) and gives an overview over the personality of the dwarf.
When the personality tab is clicked by default the Traits tab is shown.

====Traits====
This tab gives a detailed description of the dwarf's (or character's) traits.

If any of the mental attributes (see [[Attribute#Soul_attributes| mental attributes]]) are above or below the racial average attribute range, then all of these attributes are listed in the first paragraph (the paragraph is missing if all mental attributes are within the average mental attribute ranges). Instead of just listing the name of the attribute and the concrete value of the attribute a verbose description of the attribute (and the corresponding value range the attribute's value belongs to) is given instead. All attributes above the average attribute range are listed first and in green (with the attributes more tiers above the average listed before attributes with less tiers above the average) and all attributes below are listed (afterwards and) in red (with the attributes with more tiers below the average listed after the attributes with less tiers below the average, so that the worst mental attributes are listed last).

Afterwards the [[Personality_facet| personality facets]] of the creature, which are not in the default range, are listed. As usually every creature will have a personality facet, which is not in the default range, this paragraph will usually not be empty. Again the facets, with the higher deviation from the default range are listed first. If any of the personality facets were changed due to the memory of an event becoming a core memory, for each personality facet changed, the last such event with the change is also mentioned here. Also not that temporary personality facet changes (eg. due to recent alcohol consumption) are also mentioned (and highlighted by using yellow text color).

In the next paragraph the [[Mannerisms|mannerisms]] of the character are mentioned, which might be empty (if the character does not have any).

And afterwards the alcohol addiction of dwarves is mentioned and it is also mentioned if the character likes working outdoors - it is not mentioned, if a character does not like working outdoors.

====Values====
This subtab lists first (in one very long sentence) the general [[Personality_value|personality values]] shared by all members of that civilization. The personality values are ordered by the higher tier differences from the middle personality value tier listed before personality value with lower tier deviation. Any personality values, which belong to the middle tier, are omitted. Also all personality values, which differ from the normal personality value of that civilization are not mentioned in the first sentence.
Afterwards in light blue (?) text color the personality values, which differ from the cultural values (of that civilization) are mentioned.
And lastly, if the character has [[Personality_goal| personality goals]], these are listed afterwards (in vanilla, without adding any more personality goals ie. via dfhack, a character will have at most one personality goal).

====Preferences====
This sub-tab lists the [[Preferences|preferences]] of the dwarf as well as the hateable vermin, the creature hates (or dislikes) the most.

====Needs====
This sub-tab lists gives an (detailed) overview of the characters [[Need|needs]] and to which degree the need is currently met.

===Items===
This tab lists the items the character is currently wearing or hauling. Any (worn) items, which are part of the regular clothing (which includes any crafts or even large gems), are marked as such (with the letter 'c' before the button at the right side of the entry) and are considered to be owned by that dwarf. Any item worn (and not hauled), which is not considered part of the regular clothing, is not considered to be owned by that dwarf. All items (ie. to view, dump or forbid the item) can be accessed via a button on the right side of the entry.

===Health===
This tab has five sub-tabs, which are status, wounds, treatment, history and description. Upon clicking on the Health tab the status sub-tab is shown. If the character has any health problems, they are listed here. If the character has any (evaluated) wounds, they are listed in the wounds sub-tab. Any treatments are listed in the treatment sub-tab. The medical history (if any) of the character are given in the history sub-tab. The Description sub-tab gives a description of the dwarf (and an overview of the dwarfs physical attributes).

====Description====
This tab gives a detailed description of the creatures (appearance and physical capabilities).

First (in grey text color) a short description of the race (or species) the character belongs to is given.

If there are any physical attributes, which deviate from the average value range of that attribute for that creature, another paragraph is added listing all physical attributes, which deviate from the average value range. The ordering of the attributes is the same as the ordering for the mental attributes (and again the attributes above the default/average value range are listed in green text and the attributes below the default/average value range are listed in red text).

Afterwards a detailed description of the characters appearance is given. Also any missing or deformed extremeties (and organs) are listed (if there are any).

===Skills===
This tab has five sub-tabs, which are Labor, Combat, Social, Other skills and knowledge. Upon clicking on the Skills tab the Labor sub-tab is opened. In all sub-tabs (except the Knowledge sub-tab) different skills the character has are listed. In each category the skills with the higher skill levels are listed above the skills with lower skill levels. For skills with the legendary rank, the skills with higher raw skill level are listed above other legendary skills with lower raw skill level. If a skill is considered to be rusty (or very rusty) it is mentioned here.

The Labor sub-tab lists all skills (with at least 1 experience point), which are associated with any labor (including organizer, for administrative jobs, and appraiser, for the broker position, but not ie. ambusher). For each skill the color associated with the corresponding profession is used as text color.

The Combat sub-tab lists all combat related skills (including Observer and Discipline, but not ie. Mining, allthough that skill is used for characters using a pick-axe as a weapon, or ambusher).

The Social sub-tab lists all social skills of the character (including ie. leader, speaker and teacher, but not student).

In the Other skills sub-tab all remaining skills are listed, which ie. includes all skills (except speaker), which are associated with any performance, Concentration, Student, Ambusher, Swimmer and Climber.

The Knowledge sub-tab lists all knowledge of ie. art forms, with known poetic forms listed before known musical forms, which in turn are listed before known dance forms.

===Rooms===
This tab lists all rooms (Study, Quarters, Dining Room and Tomb) which are assigned to the dwarf. If no room of a type is assigned to the character (or the character's spouse) then this is also mentioned, ie. by saying "No Study" or "No Dining Room". If multiple rooms of a type are assigned to a character (including rooms assigned to the character's spouse) each such room is listed. Each entry has first an icon, donating the type of room, then the name of the room (or default name of that room, if the room was not named) and the type of the room (including quality) is mentioned. If any of the character's positions (noble or administrative) need a room of a certain quality, then the entry also mentions for any assigned room of that type, whether that room satisfies the requirement (and also the icon color is then changed from ie. grey, no requirement, to either green or yellow, depending on whether the room meets the requirement) - and in general all rooms, which do not satisfy the needed room quality should be removed (as the character might use the sub-standard room and thus get a bad thought from that). Also each room entry has a button on the right side to directly go to the location of that room (but this does not open the corresponding zone menu).

===Labor===
This tab has four sub-tabs, which are work details (shown, after clicking the labor tab), workshops, locations and work animals. At the top of each sub-tab it is mentioned, whether the character is specialized or not (and can be changed by clicking the corresponding button).

====Work details====
If the character's profession is not a baby (nor a child), then an overview of the character's work details is given here, with the possiblity to reassign the characters work details.

====Workshops====
Lists the name of the workshop (if any name was given) the character is assigned to. Each list entry also has three buttons on the right side, allowing to navigate to the location of the workshop, to view the workshop's screen (and thereby exiting the character sheet) and to remove character from an assigned workshop. All build levers are considered workshops, too, so if the character is assigned to a lever (or multiple levers), the levers are also listed here.

If the character's profession is either baby or child, then it is only stated: "No dedicated workshop assignments".

====Locations====
Lists the name of the location with the type of occupation and the name of the location. The entry also has the possibility to open the corresponding location menu (or more precise to the zone assigned to a location with the lowest id) via a button or to remove the character from the assignment via a button.

If the character's profession is either baby or child, then it is only stated: "No dedicated location assignments".

====Work animals====
Lists all work animals, which are all animals trained for either hunting or war (including work animals currently assigned to other characters), and gives the possibility to assign or remove an assigned work animal from that character (note: the first time a work animal is assigned to a character the work animal is given a name) - it should also be noted that an assigned work animal cannot be removed via the list entry in the Pet/livestock tab of the unit list. It is also possible for all listed work animals to either view the current location of the work animal or to view the corresponding character sheet (profile) of that work animal.

It should also be noted, that it is possible to assign work animals to children and babies(!) via the Pets/Lifestock tab of the unit list, but it is not possible to remove these assigned animals (before the character did come of age), because, if the character's profession is either baby or child, then it is only stated: "Cannot assign work animals" (eventhough the assignment of work animals is clearly possible, via the Pets/Lifestock tab of the unit list).

{{category|Interface}}
[[ru:Profile]]

Memory (thought)

2026-03-03T17:30:53Z

DPhKraken: Remove v44 version banner

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

[[File:memories_preview.png|thumb|258px|right|The memories of a [[scholar]].]]
'''Memories''' are recipients for a dwarf's [[thought]]s. They are essentially an evolution of the old trauma system from previous versions.

Each dwarf has eight short-term memory slots and eight long-term memory slots. During a year-long period, the dwarf will "dwell upon/relive/remember" the eight events that evoked the strongest emotions (negative or positive) and receive an additional [[stress]] change. After a year in one of the short-term slots, a memory will then be moved to the long-term memory slots if it is stronger than the ones there, otherwise it is discarded. Long-term memory slots are retained forever and keep haunting the dwarf periodically (for better or for worse), until they are overwritten by even stronger memories or enter the dwarf's core memory. In order to avoid redundant and similar trauma that piles up and clogs your dwarf's slots (e.g. multiple instances of horror in battle when seeing many creatures die), memories are grouped into categories, and only the strongest emotion in each category will get a specific slot.

The emotion evoked by the memory may change in nature as time passes, and this may cause permanent personality changes in a dwarf's [[trait]]s and [[value]]s. When this happens, it will be indicated in the [[thoughts and preferences]] screen in bright magenta: which way the trait or value changed, what event caused the change and when.

== Mechanics ==

Dwarves have thoughts based on their experiences, which provoke [[emotion]]s of varying degrees of strength, creating memories. Each type of memory falls into a group. Each dwarf has three memory storage systems: short-term, long term memory, and core memory. You can see what has recently been in a dwarf's memory by looking at their [[thoughts and preferences]] screen. If an experience is immediate: "{{DFtext|She felt satisfied at work.}}" it has affected their short-term memory, but if an experience is recalled: "{{DFtext|She felt satisfied remembering work.}}" it has affected their long-term memory. Core memories are shown in detail, alongside the year of the event and a personality change that came about as a result. "{{DFtext|She can easily fall in love or develop positive sentiments, after gaining a sibling in 351.}}"

=== Short-term memories ===

A dwarf has 8 short-term memory slots. When a dwarf has a thought, a check is made to see if a memory of that group already exists in a short-term memory slot. If the thought doesn't fall into an existing group, the new thought will fill an empty slot, or if no slots are empty, overwrite the weakest memory (the one with the weakest emotion) in the 8 short-term memory slots - even if the overwritten memory is stronger than the new one. If the thought already has one of its group in a memory slot the strongest memory of the two, the new thought and the existing memory, will be kept and the other discarded.

For example, a dwarf gets caught in the rain and is dejected (strength 1/4). If they haven't seen rain in the last year, this will be written to their memory, overwriting the weakest existing memory of a different group. If they have seen rain in the last year, it will overwrite the previously weaker emotion of being annoyed by the rain (strength 1/8), or ignore the new experience if the old emotion was the stronger being dismayed by the rain (strength 1/2).

This mostly leads to a constant cycling of the weakest of the 8 memory slots as new thoughts overwrite each other. An overwritten thought is a forgotten thought. You can see this in the dwarf's thoughts and preferences screen, they'll mention more than 8 things that they have recently experienced, but they are only being ''affected'' by 8 of those things. The list is not a reflection of what is in their current memory, but is a reflection of what has been in their memory recently. The consequence of this cycling is that short-term memories are mostly fleeting, with a maximum of 7 short-term memories having a lasting effect on a dwarf's mood.

=== Long-term memories ===

Once a memory has remained in a short-term memory slot for one year it will attempt to be promoted to a long-term memory slot. There are 8 long-term memory slots, and the procedure works similarly to short-term memory allocations, with one important difference.

When the attempt to promote is made, a check is first made to see if there is an empty slot, if there is an empty slot the memory will be promoted to that slot even if a memory of that group already exists in another long-term memory slot. It is possible (but very rare) to have more than one memory of the same group in long term memory. This cannot happen in short term memory. If there are no empty slots a check is made to see if an existing memory of the same group exists. The promotion will fail if the existing long term memory is stronger, or will overwrite if the existing long term memory is weaker. If there are no empty slots and no existing memory of the same group, then the weakest of the other existing memories in long term will be overwritten.

When a short-term memory is promoted (or possibly fails to promote) to long term memory it leaves an empty slot in the dwarf's short-term memory. Due to the cycling of the weakest short-term memories, it tends to be the stronger emotions that cause memories to remain in short-term memory for long enough to be promoted. The effect of the promotion on the dwarf's short-term memory is that it 'purges' a slot, allowing for a relatively weaker emotion to stick around without being overwritten by the cycling.

Long-term memories are important and can be particularly impactful on a dwarf's mood because: 1) if a dwarf is frequently experiencing the same thing, good or bad, the same emotion can easily exist in both short term and long term, effectively doubling its impact; 2) long term memories are often revisited long after an experience has ceased to occur; and 3) long term memories can become clogged with thoughts that can't be promoted further - more on that below.

It's currently indeterminate what causes a dwarf to think about something in their long-term memory, whether it's random or predictable, but it seems to be frequent. (Across a sample size of 300 dwarves, all of whom had been in one of several 'happy' fortresses for more than 2 years, the median number of revisited memories was 9, with 83% of dwarves revisiting 8 or more long-term memories. This suggests that all of their long-term memories had been revisited at the point of sampling, with some cycling of long-term memories having occurred within the recent months.)

=== Core memories ===

When a dwarf thinks about a long-term memory, it has a 1:3 chance of being promoted to core memory and causing one or more personality changes, if the memory is of a group that can be promoted to core memory. There is no limit on the number of core memory slots, and it is common to have several core memory slots populated by memories of the same group, for example, several experiences of seeing dead bodies in different years are common in core memory.

Core memories are less impactful than long-term memories, as they are rarely, if ever, revisited. However, the change that is made to the personality of the dwarf is permanent, and this can be for good or bad.

The majority of long-term memories that will be promoted to core memory are negative thoughts. The ones that have been found so far are: seeing a dead body, seeing somebody die, having a loved one die, being uncovered, wearing old/tattered clothing, experiencing trauma, experiencing miasma, rain, freakish weather or being made nauseous by the sun; and on the positive side: new romance, getting married, becoming a parent and gaining a sibling. A query to Toady about this tendency to promote only certain long-term memories to core memory confirmed that he thinks that there is an exclusion list, but couldn't recall what was on it at the time of the Q&A.

In fact the event becoming a parent comes in pairs (for the parents only): the mother gets the additional "giving birth to a boy/girl/twins/triplets" while the father gets two instances of becoming a parent. And both usually end up as core memories and only in one case it was observed that the event did not become a long-term memory for the parents (possibly because the mother was already carrying a baby around at the time).

The effect of mostly negative memories being promoted to core means that the long-term memory slots of a dwarf can become clogged with relatively positive emotions, if care is taken. Only the weakest long-term memory will be cycled out by short-term memories being promoted, meaning that it is possible to maintain dwarves in an ecstatic state.

Long-term memories that are written to the core memory are removed from long-term memory, thereby leaving an empty slot.

{{Category|Thoughts}}
[[ru:Memories]]

Profile

2026-03-03T17:26:42Z

DPhKraken: /* Personality */ Add image

{{migrated article}}
{{Quality|Unrated}}
{{av}}
:''(For workshop profiles, see [[Manager#Setting_workshop_profiles|Manager]].)''

The '''profile''' (or character sheet) is an important part of the [[interface]], giving all information you can ever need (or better get by normal means)* on a particular dwarf. The profile is accessible by clicking on a dwarf, and consists of several screens (or tabs): Relations, Groups, Military, Thoughts, Personality, Overview, Items, Health, Skills, Rooms, Labor.

After clicking the dwarf the overview screen (tab) is shown giving you an overview of their
:* upper left box: gender, age, most important family relations and pets (if any)
:* upper right box: notable characteristics
:* second row box (left): (current) health status
:* second row box (right): current positions (administrativ and noble)
:* third row box (left): hauled (job) item, only one is shown, if multiple are hauled. Might be ie. wheelbarrow, if one is currently used by the dwarf.
:* third row box (right): current assigned squad (if any) and highest combat related skills
:* fourth row box (left): highest labor/job related skills
:* last row box: a quote from the dwarf (ie. about their most recent activity or their general view on life or how they are feeling) and their most recent thoughts and memories. This can give an overview of some of the most recent activities of the dwarf.

Also on the top right side of the profile their are some buttons to view the dwarf's (recent) combat history, customize the dwarf's name and profession (ie. give the dwarf a nickname), set the camera to follow the dwarf around and a button to send the dwarf somewhere else (ie. send the dwarf to a linked site, if any, or outright expel the dwarf).

The other tabs of the profile can be accessed by clicking a tab (above the boxes) in the profile.

''Note:'' *): Some stats (ie. concrete current attribute values, raw skill level, amount of skill experience etc.) are either not acessible by normal means (except ie. using utilities like gui/gm-editor of dfhack) or only acessible (shown), if df is run with dfhack.

==Breakdown of (other) tabs==
===Relations===
{{main|Relationships}}
This section is accesible by clicking the "Relations" tab. It lists the relations with other dwarves, worshipped deities (and/or religions), pets and bonded animals. Close family relations are listed first, then any worshipped deities, followed by pets and bonded animals and at last the non-kin relationships to other dwarves (and sentient beings) are listed. The more relationships, generally, the happier they are, but also the more impacted they will be by potential deaths.

===Groups===
This lists the current and former groups (also known as entities) the dwarf does (and did) belong to, their ties to that group and the positions the dwarf holds (or did hold) in that group. Every entry gives the name of the group, the type of the group/entity (ie. civilization, site government or guild) and the tie the dwarf has to the group (ie. citizen, in case of a civilization). Groups, where the dwarf holds (or did held) a position, will be listed multiple times as each position is also a link/tie to a group. Also note for each unique position (like manager or mayor) of a group only one entry is added, ie. if a dwarf was previously a manager and is again serving as a manager, it is only mentioned that the dwarf is currently the manager (and not that the dwarf is also the ex-manager), but for each squad the dwarf was (or is) part of the list will have an entry, also for each different militia captain (squad leader) position the dwarf holds (or did hold) an entry is listed (as each squad has its own unique leader).

===Military===
Has three sub-tabs: squads (opened after clicking on the military tab), uniform and kills. If the dwarf is in a squad the name of the squad and the current orders are listed (in the first tab, opened upon clicking the military tab). The second tab gives an overview of the assigned uniform (if any) and the third tab shows the kill list.

====Kill list====
A dwarf's [[kill_list|kill list]] is a record of what creatures they have killed ([[meat industry|slaughtering]] aside). Only dwarves that have actually killed things in hostile combat get kill lists. Some dwarves arrive at your fortress with a few kills already under their belt. Although vampires draining others of blood count as kills, in practice their true kill lists are hidden and usually empty as part of their disguise.

===Thoughts===
This screen is accessible by clicking on the "Thoughts" tab. It has two sub-tabs Recent thoughts and memories. The Recent thoughts (sub-)tab gives you a list of the recent thoughts of the dwarf (see [[Thought|thoughts]]), with the most recent thoughts (and remembered memories) listed first (in comparison to the list on the overview tab this list is much longer). The Memories tab gives a lists of seasons and the memories the dwarf has gained in that season (see [[Memory_(thought)|memories]]), if a listed memory (upon becoming a core memory) did change a personality facet (and/or value) it is mentioned here (but is not generally mentioned, whether a listed memory has become a core memory or not).

===Personality===
[[File:Personality v50 preview.png|right|thumb|A miner's mind.]]
This tab consists of four sub-tabs (Traits, Values, Preferences, Needs) and gives an overview over the personality of the dwarf.
When the personality tab is clicked by default the Traits tab is shown.

====Traits====
This tab gives a detailed description of the dwarf's (or character's) traits.

If any of the mental attributes (see [[Attribute#Soul_attributes| mental attributes]]) are above or below the racial average attribute range, then all of these attributes are listed in the first paragraph (the paragraph is missing if all mental attributes are within the average mental attribute ranges). Instead of just listing the name of the attribute and the concrete value of the attribute a verbose description of the attribute (and the corresponding value range the attribute's value belongs to) is given instead. All attributes above the average attribute range are listed first and in green (with the attributes more tiers above the average listed before attributes with less tiers above the average) and all attributes below are listed (afterwards and) in red (with the attributes with more tiers below the average listed after the attributes with less tiers below the average, so that the worst mental attributes are listed last).

Afterwards the [[Personality_facet| personality facets]] of the creature, which are not in the default range, are listed. As usually every creature will have a personality facet, which is not in the default range, this paragraph will usually not be empty. Again the facets, with the higher deviation from the default range are listed first. If any of the personality facets were changed due to the memory of an event becoming a core memory, for each personality facet changed, the last such event with the change is also mentioned here. Also not that temporary personality facet changes (eg. due to recent alcohol consumption) are also mentioned (and highlighted by using yellow text color).

In the next paragraph the [[Mannerisms|mannerisms]] of the character are mentioned, which might be empty (if the character does not have any).

And afterwards the alcohol addiction of dwarves is mentioned and it is also mentioned if the character likes working outdoors - it is not mentioned, if a character does not like working outdoors.

====Values====
This subtab lists first (in one very long sentence) the general [[Personality_value|personality values]] shared by all members of that civilization. The personality values are ordered by the higher tier differences from the middle personality value tier listed before personality value with lower tier deviation. Any personality values, which belong to the middle tier, are omitted. Also all personality values, which differ from the normal personality value of that civilization are not mentioned in the first sentence.
Afterwards in light blue (?) text color the personality values, which differ from the cultural values (of that civilization) are mentioned.
And lastly, if the character has [[Personality_goal| personality goals]], these are listed afterwards (in vanilla, without adding any more personality goals ie. via dfhack, a character will have at most one personality goal).

====Preferences====
This sub-tab lists the [[Preferences|preferences]] of the dwarf as well as the hateable vermin, the creature hates (or dislikes) the most.

====Needs====
This sub-tab lists gives an (detailed) overview of the characters [[Need|needs]] and to which degree the need is currently met.

===Items===
This tab lists the items the character is currently wearing or hauling. Any (worn) items, which are part of the regular clothing (which includes any crafts or even large gems), are marked as such (with the letter 'c' before the button at the right side of the entry) and are considered to be owned by that dwarf. Any item worn (and not hauled), which is not considered part of the regular clothing, is not considered to be owned by that dwarf. All items (ie. to view, dump or forbid the item) can be accessed via a button on the right side of the entry.

===Health===
This tab has five sub-tabs, which are status, wounds, treatment, history and description. Upon clicking on the Health tab the status sub-tab is shown. If the character has any health problems, they are listed here. If the character has any (evaluated) wounds, they are listed in the wounds sub-tab. Any treatments are listed in the treatment sub-tab. The medical history (if any) of the character are given in the history sub-tab. The Description sub-tab gives a description of the dwarf (and an overview of the dwarfs physical attributes).

====Description====
This tab gives a detailed description of the creatures (appearance and physical capabilities).

First (in grey text color) a short description of the race (or species) the character belongs to is given.

If there are any physical attributes, which deviate from the average value range of that attribute for that creature, another paragraph is added listing all physical attributes, which deviate from the average value range. The ordering of the attributes is the same as the ordering for the mental attributes (and again the attributes above the default/average value range are listed in green text and the attributes below the default/average value range are listed in red text).

Afterwards a detailed description of the characters appearance is given. Also any missing or deformed extremeties (and organs) are listed (if there are any).

===Skills===
This tab has five sub-tabs, which are Labor, Combat, Social, Other skills and knowledge. Upon clicking on the Skills tab the Labor sub-tab is opened. In all sub-tabs (except the Knowledge sub-tab) different skills the character has are listed. In each category the skills with the higher skill levels are listed above the skills with lower skill levels. For skills with the legendary rank, the skills with higher raw skill level are listed above other legendary skills with lower raw skill level. If a skill is considered to be rusty (or very rusty) it is mentioned here.

The Labor sub-tab lists all skills (with at least 1 experience point), which are associated with any labor (including organizer, for administrative jobs, and appraiser, for the broker position, but not ie. ambusher). For each skill the color associated with the corresponding profession is used as text color.

The Combat sub-tab lists all combat related skills (including Observer and Discipline, but not ie. Mining, allthough that skill is used for characters using a pick-axe as a weapon, or ambusher).

The Social sub-tab lists all social skills of the character (including ie. leader, speaker and teacher, but not student).

In the Other skills sub-tab all remaining skills are listed, which ie. includes all skills (except speaker), which are associated with any performance, Concentration, Student, Ambusher, Swimmer and Climber.

The Knowledge sub-tab lists all knowledge of ie. art forms, with known poetic forms listed before known musical forms, which in turn are listed before known dance forms.

===Rooms===
This tab lists all rooms (Study, Quarters, Dining Room and Tomb) which are assigned to the dwarf. If no room of a type is assigned to the character (or the character's spouse) then this is also mentioned, ie. by saying "No Study" or "No Dining Room". If multiple rooms of a type are assigned to a character (including rooms assigned to the character's spouse) each such room is listed. Each entry has first an icon, donating the type of room, then the name of the room (or default name of that room, if the room was not named) and the type of the room (including quality) is mentioned. If any of the character's positions (noble or administrative) need a room of a certain quality, then the entry also mentions for any assigned room of that type, whether that room satisfies the requirement (and also the icon color is then changed from ie. grey, no requirement, to either green or yellow, depending on whether the room meets the requirement) - and in general all rooms, which do not satisfy the needed room quality should be removed (as the character might use the sub-standard room and thus get a bad thought from that). Also each room entry has a button on the right side to directly go to the location of that room (but this does not open the corresponding zone menu).

===Labor===
This tab has four sub-tabs, which are work details (shown, after clicking the labor tab), workshops, locations and work animals. At the top of each sub-tab it is mentioned, whether the character is specialized or not (and can be changed by clicking the corresponding button).

====Work details====
If the character's profession is not a baby (nor a child), then an overview of the character's work details is given here, with the possiblity to reassign the characters work details.

====Workshops====
Lists the name of the workshop (if any name was given) the character is assigned to. Each list entry also has three buttons on the right side, allowing to navigate to the location of the workshop, to view the workshop's screen (and thereby exiting the character sheet) and to remove character from an assigned workshop. All build levers are considered workshops, too, so if the character is assigned to a lever (or multiple levers), the levers are also listed here.

If the character's profession is either baby or child, then it is only stated: "No dedicated workshop assignments".

====Locations====
Lists the name of the location with the type of occupation and the name of the location. The entry also has the possibility to open the corresponding location menu (or more precise to the zone assigned to a location with the lowest id) via a button or to remove the character from the assignment via a button.

If the character's profession is either baby or child, then it is only stated: "No dedicated location assignments".

====Work animals====
Lists all work animals, which are all animals trained for either hunting or war (including work animals currently assigned to other characters), and gives the possibility to assign or remove an assigned work animal from that character (note: the first time a work animal is assigned to a character the work animal is given a name) - it should also be noted that an assigned work animal cannot be removed via the list entry in the Pet/livestock tab of the unit list. It is also possible for all listed work animals to either view the current location of the work animal or to view the corresponding character sheet (profile) of that work animal.

It should also be noted, that it is possible to assign work animals to children and babies(!) via the Pets/Lifestock tab of the unit list, but it is not possible to remove these assigned animals (before the character did come of age), because, if the character's profession is either baby or child, then it is only stated: "Cannot assign work animals" (eventhough the assignment of work animals is clearly possible, via the Pets/Lifestock tab of the unit list).

{{category|Interface}}
[[ru:Profile]]

Demon

2026-03-03T17:16:49Z

DPhKraken: /* Killed demons */ Edit joke to reference mining speed

{{Quality|Exceptional}}
{{av}}
{{spoiler}}

[[File:demon_preview.png|right]]'''Demons''' {{Tile|&|7:0}} are procedurally-generated [[creature]]s who inhabit the [[Underworld]]. These immense, malicious and formidably powerful beasts are among the most powerful enemies in the game in both [[fortress mode]] and [[adventurer mode]]. They are not available to be spawned in the [[object testing arena]].

Graphically, the sprites that demons use will be of randomly-generated creatures with random colors that resemble the generated appearance they've been given. This same setup is used for other procedurally-generated creatures, such as [[megabeast]]s, [[angel]]s, and some [[experiment]]s.

== Overview ==
{{imagefix|[[File:demon_icon.png|left]]|8}}[[File:Assdemon.png|thumb|right|300px|"Etar Patternedtombs was a mint green demon. It was the only one of its kind. A gigantic feathered ass twisted into humanoid form. It undulates rhythmically. Its mint green feathers are patchy. Beware its deadly gas!" ([http://www.bay12forums.com/smf/index.php?topic=76346.msg2667300#msg2667300 post]).]]Demons inhabit the Underworld. They are randomly generated at worldgen, creating unique [[fun]] for every player. Examples of possible demons include giant centipedes made of ash that hunger for blood, eyeless mosquitoes that spit toxins, and emaciated fruitbats with giant clicking mandibles. The number of different types of demon created during world generation is closely related to world size, and it can be directly controlled with [[advanced world generation]] – a world generated with "{{tt|Number of Demon Types}}" set to {{tt|0}} in advanced world generation will not have any demons in it.

[[File:demon_desc_v50_preview.png|thumb|300px|right|Description of a demon.]]All demons share certain traits. They are [[Creature token#SUPERNATURAL|supernatural]], [[fanciful]], evil-aligned creatures represented by an ampersand with a randomized [[color]]. They are all able to swim in and [[Amphibious|breathe]] water and magma, and [[Building destroyer|destroy buildings]]. Furthermore, they are [[Trapavoid|immune to traps]], [[No Pain|pain]], fear, nausea, [[No Stun|stunning]], [[No Exert|exertion]], dizziness, fevers, fire, any sort of poison, and have fixed body temperature, thus are unaffected by extremes of heat and cold (even if made of materials that would suggest otherwise). Roughly half possess [[Creature_token#EXTRAVISION|extravision]]. They are very large (size 10,000,000, smaller than a [[megabeast]], but larger than a [[giant]] and 167 times the size of a [[dwarf]]). They don't require sleep, food, or drink. All non-unique demons start out at Accomplished [[skill]] level in the following combat skills: wrestling, biting, striking, kicking, fighting, archery, dodging, and observing. Unique demons start out at Grand Master in the same skills. All unique demons, and roughly a half of non-unique ones, possess intelligence ([[Creature token#CAN_LEARN|<code>[CAN_LEARN]</code>]] + [[Creature token#CAN_SPEAK|<code>[CAN_SPEAK]</code>]]), so demons you face may well have developed their skills to a higher level than they began with; however, their skills cannot rust to a lower level. The initial wave spawns exactly one frame after you open the Underworld; the amount spawned can range from 10 to over 100. Demons inhabiting the Underworld spawn in groups of 1-5 individuals. The size of their population, specified as 5-10 in the raws, appears to be irrelevant, as the game makes all inhabitants of the Underworld spawn in limitless numbers. As long as the Underworld is unsealed, demons will continue to wander in from the edges of the map indefinitely, due to having populations that are (functionally) infinite.

Demons receive large bonuses to every physical [[attribute]] except agility, and to the mental attributes of focus and willpower (also analytical ability, memory, linguistic ability, and social awareness, but those are less relevant). Many, but not all, are capable of flight. They may possess a wide variety of special attacks, including webbing, firebreath, poisonous appendages, toxic spittle or poison breath. Inorganic or zombie demons are especially difficult to kill; they can be killed by bisection, decapitation, or pulping via blunt weapons (inorganic blobs can only be killed in this manner), but this is far beyond the capabilities of an ordinary dwarf.

Demons of each species can be all genderless, all male, or all female, or have both male and female castes. The latter can breed if given enough time. All demons are born adults, and immediately reach their full size after being born. They have a [[pet|pet value]] of 2000☼, but cannot be tamed, and you are rather unlikely to capture one. If you have deactivated compressed saves, the raws for a given world's demons (as well as [[forgotten beast]]s, [[titan]]s, [[werebeast]]s, etc.) can be found in the [[Saved game folder|world.dat]] of its save folder. Blob/inorganic demons tend to be genderless and non-sapient, but more research is required on this.

Due to their somewhat spoilery nature – new players are unlikely to know they exist, creating [[Fun|much surprise]] when they inevitably dig too deep – veteran ''Dwarf Fortress'' players tend to hide the existence of demons by giving them nicknames, the most famous being '''Hidden Fun Stuff''' and '''clowns''', with the Underworld being their "circus". Unique demons (see below), by extension, are usually referred to as the '''ringleaders'''.

Dwarves may [[Preferences|like]] a species of demon for their ''horrifying features'', their ''rhythmic undulations'' or their ''bloated appearance''.

== Their interaction with the world ==
Certain types of demons, those described as "being twisted into humanoid form" and marked with {{token|UNIQUE_DEMON|c}} instead of {{token|DEMON|c}} in world.dat, will occasionally escape the underworld. This happens by the aid of a [[deity]] through a ritual conducted with an [[artifact]] [[slab]]. It is most common that the demon and deity share a sphere, though it is not a requirement. Once they are in the mortal world, they will gain rule over a [[goblin]] [[civilization]] – each goblin faction in the world will be led by a unique demon, and attempting to create a world without demons in it through [[advanced world generation]] will lead to goblins being locked away in the underworld until a dwarf civilization digs too deep. As noted in [[Legends|legends mode]], these demons will occasionally make journeys to the [[Cavern|depths of the world]] and tame the creatures that dwell in them – most specifically, species with the {{token|PET_EXOTIC}} token – going from [[giant rat]]s to [[voracious cave crawler]]s and [[cave dragon]]s. Presumably, this is how goblin civilizations gain access to these creatures to use them in [[siege]]s.

Demons may also arise when a dwarven civilization digs too deep in [[world generation|worldgen]] – the dwarves have a chance to fight them off, but, most of the time, the fortress will be taken over by goblins under a demonic ruler.

Found within the goblins' [[dark fortress]]es are demonic [[Underworld spire|spires]] made of [[slade]], whose lowermost levels lead directly into the Underworld. They will also create slade [[vault]]s, whose treasure is guarded by incredibly powerful and dangerous [[angel]]s. If you can manage to fight off those freakishly strong beings ([[Fun|don't expect to by the way]]), you can find in the vault's centre the slab that contains the demon's true name. Learning this name allows your adventurer to either banish it back to the Underworld or bind it to your servitude. Although you will have a next to unkillable super soldier on your side if you opt for the latter, it's more of a bragging-rights reward, if anything – getting past the angels already requires pretty much being a god among men.

<gallery class="center" widths="400px" heights="184px">
File:Demon banish.png|Banishing a demon back to the Underworld
File:Demon compel service.png|Compelling service from demon
</gallery>

In [[fortress mode]], goblin law-giver demons may arrive as part of a goblin siege and are most of the time very dangerous.{{verify}}

Demons can (and, in most cases, will) spread sphere-aligned evil from sites they control. Nightmare or darkness demons will spread regions filled with [[bogeymen]], death demons will spread reanimating evil regions, and so on. The evil-spreading can be reversed if the demon is slain or their site conquered or razed (e.g. through a [[raid]].)

Depending on their spheres, demons may also be granted abilities similar to those of [[necromancer]]s. Death demons are able to create [[experiment]]s and raise corpses and [[intelligent undead]], though they do not raise corpses in world gen because they would be hostile to the goblins they rule. Nightmare demons may be able to summon [[nightmare]]s and [[bogeymen]].

== Demon generation ==
Although the exact algorithm used to produce demons is unknown, something of the algorithm can be gathered from the string dump and analysis of demons. When generating a demon, the game begins by picking a creature from a predefined list, which is fixed and includes creatures not found in vanilla DF (such as anteater, ankylosaurid) and more general shapes (blob, quadruped, and humanoid). It is granted spheres, with a preference for "negative" spheres like misery, death, and torture. If inorganic, a material will be chosen, either one of the hardcoded ones (such as salt, ash, ice, or vomit), flames, or a randomly chosen raw-defined inorganic (any type of stone, soil, gem, metal, or other, such as gypsum plaster). If organic, it will get some sort of randomly-colored covering (such as feathers or hair) and/or have some feature (such as its eyes, nose or skin) removed. It will be granted a few "extra" features, like a tail, a trunk, or a shell, and a flavorful descriptor (such as "it knows and intones the names of all it encounters"). It may get some sort of special attack (such as a poisonous sting, toxic breath, fire breath). It will finally be given a name consisting of an adjective and a noun. The adjective will be based on the creature's color, its material (such as "inferno" or "snow"), what animal it's shaped like, or a descriptor (such as "winged", "three-eyed" or "skinless"), and the noun chosen from the following list: demon, devil, fiend, brute, monster, spirit, ghost, banshee, haunt, phantom, specter, or wraith.

== Strategy ==
[[File:Demon_Size.png|thumb|right|200px|Estimated size comparison between a typical demon and a dwarf.]]

Of all of the challenges facing a player, defeating a demon horde is probably the most difficult, unless you are using certain [[trap]] schemes – and even then, you will need to take special precautions.

=== Containment ===
Containment is the simplest strategy for dealing with demons. A simple constructed wall will block any demon. Because of their building destroyer status, demons cannot be contained via locked doors. However, indestructible artifact-quality portals can stop them, as can some bridges. As building destroyers can only destroy objects on the same z-level, a [[floor grate]] or forbidden [[hatch cover]] on a staircase/channel will also block movement. It may be difficult to lure demons away from artifact furniture, should the area need to be accessed to reset a trap. If using [[bridge]]s, be aware that any raising bridge that lands on a demon will deconstruct, and that demons can easily have internal temperatures greatly exceeding the melting points of [[steel]] or [[iron]], leading to deconstruction as they pass over them. Because of their vast numbers, containment is an important part of any attempt to defeat them – fighting two groups of 25 demons is much easier than fighting one group of 50.

One particular gentleman, AussieGuy on the Bay12 forums, has found an ingenious method for disposing of an entire demonic invasion at once: a [[Megaprojects|stupid dwarven trick]] known as "the dwarven checkerboard".([http://www.bay12forums.com/smf/index.php?topic=94140.0 Source])

When using forbidden hatches to control flow of demons, note that some demons may be spawned with CANOPENDOORS to be not set, so once you unforbid the hatch, only the demons that can open doors will go through the door. The ones that can't open doors will remain behind the hatch, even if it is passable.

=== Traps ===
Because all demons avoid traps, trapping demons can be very difficult – but not impossible. Demons become vulnerable to traps when they are webbed, so if you can find a way to get web onto your traps, the demons will be affected as any other creature (including your own dwarves!) would be.

Alternatively, advanced triggered traps may be used. Demons do not set off [[pressure plate]]s, but if you can contain them, retracting upright spikes, casting them into [[obsidian]], or caving a portion of mountain onto them are all effective. Any plan involving these kind of traps must involve both a way to bait the demons to where you want them and a way to keep the demons where you want them. Tame animals appear to work well as bait, but need to be replaced as they're killed. Bridges can be used to contain the demons, but be wary of the risks of deconstruction as described above.

Many traps need to be designed with the potential for extreme temperatures in mind. Obsidian trappers may find water used in the casting process boiling into steam before it contacts magma. Frequently, demons made of fire or steam explode on death, broiling nearby creatures and furniture. This effect can destroy upright spikes, leaving you with a trap chamber full of demons that you have no way to deal with. Demons do not destroy supports directly, but a hot enough demon may cause the destruction of nearby supports, just through heat damage. A clever dwarf might find a way to turn that to their advantage, if only such a thing as a clever dwarf existed.

=== Ranged combat ===
Ranged combat sounds appealing, especially in the face of demons that explode with unimaginable heat upon death, but should be considered carefully. Most demons have vastly more powerful ranged attacks than marksdwarves have. Demons made of weak materials can be easily killed or dismembered by bolts, but inorganic demons composed of stronger stuff will only suffer chipped "bones".

[[Fortification]]s are appealing, as they can be dug directly into [[adamantine]] without ever exposing your fortress to a path to the demons. Even demons made out of steam cannot pass through a fortification unless it is submerged in 7/7 water or magma. Demons with syndrome attacks may attack through fortifications even without a path, although they appear to do so less frequently than if they have a path.

Still, should you contain a group of demons composed of weaker materials, marksdwarves can be very effective.

=== Melee combat ===
Demons can be very frightening melee opponents, as each one alone is nearly the size of a [[megabeast]], extremely fast, and has tremendous natural combat skills. That would be bad enough, but there tend to be pages of them rather than individuals. However, demons can still be defeated in melee combat.

Despite their powerful attacks, many demons are made up of very flimsy materials, such as salt, snow, steam, or filth. A strong punch can decapitate creatures like this. Some demons, however, can be made of much harder materials, and it can be very difficult to bring down a demon composed of minerals or armor-quality metal. Blunt weapons can be reasonably effective against weaker-material demons by severing limbs and body parts despite blunt status, but are not nearly as effective against demons as they are against earthly foes that suffer from pain and blood loss; without internal organs or blood loss, piercing weapons are relatively ineffective. Good slashing weapons can reliably take down demons of any material type.

The challenge of melee combat is how to deal with an enormous number of strong combatants while protecting against area-of-effect syndrome attacks and death explosions. Restraining visibility via a labyrinthine battleground is a good start. The area effects suggest meeting them with successive small waves of melee dwarves, but if the dwarves are too few, they'll be butchered by hundreds of angry demons before making a dent.

In all cases, your demon-fighting melee dwarves should be very well armed and armored (steel and adamantine) and Legendary in some, if not all, of the relevant combat skills.

=== Clean-up ===
Unfortunately, once the wave of demons has been dealt with, it's not yet over. [[Syndrome]]-bearing dust and blood may litter the battlefield and your survivors, and can be very difficult to isolate and contain. Some dwarves may carry burning items back from their encounters with very hot demons. Survivors should all pass through a shallow pool of water to wash them and their equipment of anything dangerous and to douse any flames. Any path used for the fight is best abandoned and walled up. Demons will continue to enter the Underworld from its map edges, as wildlife do on the surface, but path differently from the initial wave, content to wander through the Underworld even should a simple unobstructed path exist into your fortress.

== Killed demons ==
Only unintelligent demons can be butchered, and butchering them yields products similar to those from [[forgotten beast]]s, including copious amounts of [[meat]] and [[bone]]s, vividly-colored [[hair]], [[feather]]s, [[scale]]s or [[chitin]], and [[shell]]s, if the demon had one. All materials obtained from demons have a value multiplier of 1, and aren't appreciably better than their mundane counterparts.

Inorganic demons cannot be butchered, and after killing them you obtain only a massive demonic corpse to use in your [[stupid dwarf trick]].

{{D for Dwarf}}

Little do demons know that though their claws and fire cannot pierce the [[adamantine]] sealing them away, a simple [[copper]] [[pick]] (or any other kind of pick, for that matter) can dig right through it with enough time and effort. Armok forbid these unholy creatures ever get their hands on one.

{{gamedata|title=Example raws (as extracted from world.sav)|[OBJECT:CREATURE]

[CREATURE:DEMON_1]
[NAME:brine brute:brine brutes:brine brute]
[CASTE_NAME:brine brute:brine brutes:brine brute]
[GENERATED]
[DEMON]
[NATURAL_SKILL:WRESTLING:10]
[NATURAL_SKILL:BITE:10]
[NATURAL_SKILL:GRASP_STRIKE:10]
[NATURAL_SKILL:STANCE_STRIKE:10]
[NATURAL_SKILL:MELEE_COMBAT:10]
[NATURAL_SKILL:RANGED_COMBAT:10]
[NATURAL_SKILL:DODGING:10]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:10]
[LARGE_ROAMING]
[LARGE_PREDATOR]
[DIFFICULTY:10]
[BIOME:SUBTERRANEAN_CHASM]
[UNDERGROUND_DEPTH:5:5]
[POPULATION_NUMBER:5:10]
[CLUSTER_NUMBER:1:5]
[FEMALE]
[PHYS_ATT_RANGE:STRENGTH:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:TOUGHNESS:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:ENDURANCE:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]
[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]
[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]
[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]
[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]
[PERSONALITY:ANXIETY_PROPENSITY:0:0:0]
[PERSONALITY:DEPRESSION_PROPENSITY:0:0:0]
[PERSONALITY:BASHFUL:0:0:0]
[PERSONALITY:STRESS_VULNERABILITY:0:0:0]
[PERSONALITY:FRIENDLINESS:0:0:0]
[PERSONALITY:ASSERTIVENESS:100:100:100]
[PERSONALITY:DISDAIN_ADVICE:100:100:100]
[PERSONALITY:CHEER_PROPENSITY:0:0:0]
[PERSONALITY:GRATITUDE:0:0:0]
[PERSONALITY:TRUST:0:0:0]
[PERSONALITY:ALTRUISM:0:0:0]
[PERSONALITY:SWAYED_BY_EMOTIONS:0:0:0]
[PERSONALITY:CRUELTY:100:100:100]
[PERSONALITY:PRIDE:100:100:100]
[PERSONALITY:GREED:100:100:100]
[NO_DRINK]
[NO_EAT]
[NO_SLEEP]
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110]
[BODY_APPEARANCE_MODIFIER:BROADNESS:90:95:98:100:102:105:110]
[MAGMA_VISION]
[EVIL]
[FANCIFUL]
[SUPERNATURAL]
[AMPHIBIOUS]
[PETVALUE:2000]
[GRASSTRAMPLE:20]
[BUILDINGDESTROYER:2]
[ALL_ACTIVE]
[SWIMS_INNATE]
[TRAPAVOID]
[NOPAIN]
[NOSTUN]
[NONAUSEA]
[NOFEAR]
[NOEXERT]
[NO_DIZZINESS]
[NO_FEVERS]
[LARGE_PREDATOR]
[SPHERE:FISHING]
[SPHERE:HUNTING]
[SPHERE:MISERY]
[SPHERE:TORTURE]
[BODY_SIZE:0:0:10000000]
[CREATURE_TILE:'&']
[NO_THOUGHT_CENTER_FOR_MOVEMENT]
[BODY:RCP_BASIC_BODY_STANCE_WITH_HEAD_FLAG:RCP_TWO_FLIGHTLESS_WINGS]
[TISSUE:UNIFORM_TIS]
[TISSUE_NAME:tissue:NP]
[TISSUE_MATERIAL:SALT]
[TISSUE_MAT_STATE:SOLID_POWDER]
[MUSCULAR]
[FUNCTIONAL]
[STRUCTURAL]
[RELATIVE_THICKNESS:1]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[TISSUE_LAYER:BY_CATEGORY:ALL:UNIFORM_TIS]
[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS]
[BODY_DETAIL_PLAN:HUMANOID_HEAD_POSITIONS]
[BODY_DETAIL_PLAN:HUMANOID_RELSIZES]
[NOT_LIVING]
[NOT_BUTCHERABLE]
[COLOR:7:0:1]
[NOBREATHE]
[EXTRAVISION]
[FLIER]
[FIXED_TEMP:10040]
[FIREIMMUNE]
[GAIT:SWIM:Maximum Swim Speed:725:10:3:2175:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:SWIM:Faster Swim:1450:5:3:2175:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:SWIM:Fast Swim:2175:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:SWIM:Swim:2900:NO_BUILD_UP:0]( [GAIT:SWIM:Slow Swim:3900:NO_BUILD_UP:0]
[GAIT:SWIM:Creeping Swim:5900:NO_BUILD_UP:0]
[GAIT:FLY:Maximum Flight Speed:225:10:3:675:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:FLY:Faster Flight:450:5:3:675:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:FLY:Fast Flight:675:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:FLY:Fly:900:NO_BUILD_UP:0]) [GAIT:FLY:Slow Flight:1900:NO_BUILD_UP:0]
[GAIT:FLY:Hover:2900:NO_BUILD_UP:0]
[GAIT:WALK:Scramble:725:10:3:2175:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:WALK:Faster Crawl:1450:5:3:2175:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:WALK:Fast Crawl:2175:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:WALK:Crawl:2900:NO_BUILD_UP:0]
[GAIT:WALK:Slow Crawl:5900:NO_BUILD_UP:0]
[GAIT:WALK:Creep:8900:NO_BUILD_UP:0]
[GAIT:CRAWL:Scramble:225:10:3:675:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:CRAWL:Faster Crawl:450:5:3:675:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:CRAWL:Fast Crawl:675:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:CRAWL:Crawl:900:NO_BUILD_UP:0]
[GAIT:CRAWL:Slow Crawl:1900:NO_BUILD_UP:0]
[GAIT:CRAWL:Creep:2900:NO_BUILD_UP:0]
[DESCRIPTION:A towering slug composed of salt. It has wings and it has a gaunt appearance.]
[PREFSTRING:horrifying features]
}}

{{gamedata|title=Example [UNIQUE_DEMON] raws (as extracted from world.sav)|[OBJECT:CREATURE]

[CREATURE:DEMON_3]
[NAME:clear devil:clear devils:clear devilish]
[CASTE_NAME:clear devil:clear devils:clear devilish]
[GENERATED]
[UNIQUE_DEMON]
[SPREAD_EVIL_SPHERES_IF_RULER]
[NATURAL_SKILL:WRESTLING:14]
[NATURAL_SKILL:BITE:14]
[NATURAL_SKILL:GRASP_STRIKE:14]
[NATURAL_SKILL:STANCE_STRIKE:14]
[NATURAL_SKILL:MELEE_COMBAT:14]
[NATURAL_SKILL:RANGED_COMBAT:14]
[NATURAL_SKILL:DODGING:14]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:14]
[CAN_LEARN]
[CAN_SPEAK]
[DIFFICULTY:10]
[NO_GENDER]
[PHYS_ATT_RANGE:STRENGTH:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:TOUGHNESS:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:ENDURANCE:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]
[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]
[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]
[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]
[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]
[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]
[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]
[PERSONALITY:ANXIETY_PROPENSITY:0:0:0]
[PERSONALITY:DEPRESSION_PROPENSITY:0:0:0]
[PERSONALITY:BASHFUL:0:0:0]
[PERSONALITY:STRESS_VULNERABILITY:0:0:0]
[PERSONALITY:FRIENDLINESS:0:0:0]
[PERSONALITY:ASSERTIVENESS:100:100:100]
[PERSONALITY:DISDAIN_ADVICE:100:100:100]
[PERSONALITY:CHEER_PROPENSITY:0:0:0]
[PERSONALITY:GRATITUDE:0:0:0]
[PERSONALITY:TRUST:0:0:0]
[PERSONALITY:ALTRUISM:0:0:0]
[PERSONALITY:SWAYED_BY_EMOTIONS:0:0:0]
[PERSONALITY:CRUELTY:100:100:100]
[PERSONALITY:PRIDE:100:100:100]
[PERSONALITY:GREED:100:100:100]
[NO_DRINK]
[NO_EAT]
[NO_SLEEP]
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110]
[BODY_APPEARANCE_MODIFIER:BROADNESS:90:95:98:100:102:105:110]
[MAGMA_VISION]
[EVIL]
[FANCIFUL]
[SUPERNATURAL]
[AMPHIBIOUS]
[PETVALUE:2000]
[GRASSTRAMPLE:20]
[BUILDINGDESTROYER:2]
[ALL_ACTIVE]
[SWIMS_INNATE]
[TRAPAVOID]
[NOPAIN]
[NOSTUN]
[NONAUSEA]
[NOFEAR]
[NOEXERT]
[NO_DIZZINESS]
[NO_FEVERS]
[LARGE_PREDATOR]
[SPHERE:BLIGHT]
[SPHERE:DEATH]
[SPHERE:MURDER]
[SPHERE:TWILIGHT]
[BODY_SIZE:0:0:10000000]
[CREATURE_TILE:'&']
[BODY:RCP_UPPER_BODY:RCP_LOWER_BODY:RCP_NECK:RCP_HEAD:RCP_TWO_PART_ARMS:RCP_TWO_PART_LEGS:RCP_TAIL:RCP_4_FINGERS:RCP_4_TOES:RCP_LUNGS:RCP_HEART:RCP_GUTS:RCP_THROAT:RCP_SPINE:RCP_UPPER_SPINE:RCP_BRAIN:RCP_SKULL:RCP_MOUTH:RCP_TONGUE:RCP_TEETH:RCP_RIBS]
[CANOPENDOORS]
[EQUIPS]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[REMOVE_MATERIAL:SKIN]
[REMOVE_MATERIAL:HAIR]
[USE_MATERIAL_TEMPLATE:SCALE:SCALE_TEMPLATE]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[REMOVE_TISSUE:SKIN]
[REMOVE_TISSUE:HAIR]
[USE_TISSUE_TEMPLATE:SCALE:SCALE_TEMPLATE]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SCALE:FAT:MUSCLE:BONE:CARTILAGE]
[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS]
[BODY_DETAIL_PLAN:HUMANOID_HEAD_POSITIONS]
[BODY_DETAIL_PLAN:HUMANOID_RIBCAGE_POSITIONS]
[BODY_DETAIL_PLAN:HUMANOID_RELSIZES]
[USE_MATERIAL_TEMPLATE:SINEW:SINEW_TEMPLATE]
[TENDONS:LOCAL_CREATURE_MAT:SINEW:200]
[LIGAMENTS:LOCAL_CREATURE_MAT:SINEW:200]
[HAS_NERVES]
[NOBREATHE]
[EXTRAVISION]
[FIXED_TEMP:10040]
[SELECT_MATERIAL:SCALE]
[STATE_COLOR:ALL_SOLID:CLEAR]
[COLOR:0:0:1]
[SELECT_TISSUE_LAYER:HEART:BY_CATEGORY:HEART]
[PLUS_TISSUE_LAYER:SCALE:BY_CATEGORY:THROAT]
[TL_MAJOR_ARTERIES]
[USE_MATERIAL_TEMPLATE:GOO:GOO_TEMPLATE]
[BLOOD:LOCAL_CREATURE_MAT:GOO:LIQUID]
[USE_MATERIAL_TEMPLATE:CLAW:NAIL_TEMPLATE]
[USE_TISSUE_TEMPLATE:CLAW:CLAW_TEMPLATE]
[TISSUE_LAYER:BY_CATEGORY:FINGER:CLAW:FRONT]
[TISSUE_LAYER:BY_CATEGORY:TOE:CLAW:FRONT]
[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:demon sickness]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:DEMON_3:ALL]
[SYN_INJECTED]
[SYN_CONTACT]
[SYN_INHALED]
[SYN_INGESTED]
[CE_DROWSINESS:SEV:100:PROB:100:START:565:PEAK:1649:END:4938:RESISTABLE:SIZE_DELAYS:SIZE_DILUTES]
[SECRETION:LOCAL_CREATURE_MAT:POISON:LIQUID:BY_CATEGORY:ALL:SCALE]
[FIREIMMUNE]
[ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP]
[ATTACK_SKILL:GRASP_STRIKE]
[ATTACK_VERB:punch:punches]
[ATTACK_CONTACT_PERC:100]
[ATTACK_PREPARE_AND_RECOVER:2:2]
[ATTACK_FLAG_WITH]
[ATTACK_PRIORITY:MAIN]
[ATTACK:KICK:BODYPART:BY_TYPE:STANCE]
[ATTACK_SKILL:STANCE_STRIKE]
[ATTACK_VERB:kick:kicks]
[ATTACK_CONTACT_PERC:100]
[ATTACK_PREPARE_AND_RECOVER:2:2]
[ATTACK_FLAG_WITH]
[ATTACK_PRIORITY:MAIN]
[ATTACK_FLAG_BAD_MULTIATTACK]
[ATTACK:BITE:CHILD_BODYPART_GROUP:BY_CATEGORY:HEAD:BY_CATEGORY:TOOTH]
[ATTACK_SKILL:BITE]
[ATTACK_VERB:bite:bites]
[ATTACK_CONTACT_PERC:100]
[ATTACK_PENETRATION_PERC:100]
[ATTACK_PREPARE_AND_RECOVER:2:2]
[ATTACK_FLAG_EDGE]
[ATTACK_PRIORITY:MAIN]
[ATTACK_FLAG_CANLATCH]
[ATTACK:FSCRATCH:CHILD_TISSUE_LAYER_GROUP:BY_TYPE:GRASP:BY_CATEGORY:ALL:CLAW]
[ATTACK_SKILL:GRASP_STRIKE]
[ATTACK_VERB:scratch:scratches]
[ATTACK_CONTACT_PERC:100]
[ATTACK_PENETRATION_PERC:100]
[ATTACK_PREPARE_AND_RECOVER:2:2]
[ATTACK_FLAG_EDGE]
[ATTACK_PRIORITY:MAIN]
[ATTACK:TSCRATCH:CHILD_TISSUE_LAYER_GROUP:BY_TYPE:STANCE:BY_CATEGORY:ALL:CLAW]
[ATTACK_SKILL:STANCE_STRIKE]
[ATTACK_VERB:scratch:scratches]
[ATTACK_CONTACT_PERC:100]
[ATTACK_PENETRATION_PERC:100]
[ATTACK_PREPARE_AND_RECOVER:2:2]
[ATTACK_FLAG_EDGE]
[ATTACK_PRIORITY:MAIN]
[ATTACK_FLAG_BAD_MULTIATTACK]
[SELECT_MATERIAL:ALL]
[MAT_FIXED_TEMP:10040]
[HEATDAM_POINT:NONE]
[COLDDAM_POINT:NONE]
[IGNITE_POINT:NONE]
[GAIT:SWIM:Maximum Swim Speed:725:10:3:2175:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:SWIM:Faster Swim:1450:5:3:2175:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:SWIM:Fast Swim:2175:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:SWIM:Swim:2900:NO_BUILD_UP:0]
[GAIT:SWIM:Slow Swim:3900:NO_BUILD_UP:0]
[GAIT:SWIM:Creeping Swim:5900:NO_BUILD_UP:0]
[GAIT:WALK:Sprint:225:10:3:675:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:WALK:Run:450:5:3:675:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:WALK:Jog:675:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:WALK:Walk:900:NO_BUILD_UP:0]
[GAIT:WALK:Stroll:1900:NO_BUILD_UP:0]
[GAIT:WALK:Creep:2900:NO_BUILD_UP:0]
[GAIT:CRAWL:Scramble:225:10:3:675:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:CRAWL:Faster Crawl:450:5:3:675:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:CRAWL:Fast Crawl:675:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:CRAWL:Crawl:900:NO_BUILD_UP:0]
[GAIT:CRAWL:Slow Crawl:1900:NO_BUILD_UP:0]
[GAIT:CRAWL:Creep:2900:NO_BUILD_UP:0]
[GAIT:CLIMB:Scramble:225:10:3:675:50:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:50]
[GAIT:CLIMB:Faster Climb:450:5:3:675:10:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:20]
[GAIT:CLIMB:Fast Climb:675:NO_BUILD_UP:5:LAYERS_SLOW:STRENGTH:AGILITY:STEALTH_SLOWS:10]
[GAIT:CLIMB:Climb:900:NO_BUILD_UP:0]
[GAIT:CLIMB:Slow Climb:1900:NO_BUILD_UP:0]
[GAIT:CLIMB:Creep:2900:NO_BUILD_UP:0]
[DESCRIPTION:A gigantic eyeless chameleon twisted into humanoid form. It squirms and fidgets. Its clear scales are large and set far apart. Beware its noxious secretions!]
}}

{{Creatures}}
{{Category|Amphibious}}
{{Category|Building destroyer}}
{{Category|HFS}}
{{Category|Fanciful}}
{{Category|Fire immune}}
{{Category|Learns}}
{{Category|No Exert}}
{{Category|No Pain}}
{{Category|No Stun}}
[[ru:Demon]]

{{Translation
| dwarven = uthgúr
| elvish = slevina
| goblin = arstruk
| human = rohir
}}

Grime

2026-01-29T07:08:01Z

DPhKraken: FB grime palette

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

'''Grime''' is a brown-colored [[contaminant]] that makes [[water]] from [[murky pool]]s disgusting to drink. When in item form, the water will be described as "laced with grime". [[Ice]] mined from frozen murky pools will be described as "dirty ice", and will also be coated in grime.

Randomly generated creatures such as [[forgotten beast]]s may occasionally be composed of "grime and [[filth]]", giving them the appearance of [[miasma]] in the graphical version.

[[File:grime.jpg|thumb|300px|center|Waste and grime being dumped in water.]]

{{gamedata|{{raw|DF2014:hardcoded_materials.txt|MATERIAL|GRIME}}}}
{{materials}}

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

Lua scripting

2026-01-29T06:57:10Z

DPhKraken: /* Tweaks */ humanoidable_only remap

{{av}}
[[File:Lua-Logo.svg|100px|right]]
{{Modding}}

''This article is about procedural raw generation. Information on [[Utility:DFHack]] scripting can be found at https://docs.dfhack.org/en/stable/.''

'''[https://www.lua.org/ Lua] scripting''' is a feature of Dwarf Fortress's [[modding]] system. It is used to write definitions for procedurally-generated objects, with the stated goal of "supporting future [[Magic|magical]] endeavors." [https://www.youtube.com/watch?v=Z9rzhFwgfUk]

It was added as an experimental feature in version 51.06 [https://store.steampowered.com/news/app/975370/view/547854206358257941?l=english] and incorporated into the 52.01 release. [https://www.bay12games.com/dwarves/index.html#2025-07-21][https://store.steampowered.com/news/app/975370/view/547867141501617961]

Inorganic [[Material definition token|materials]], [[Language token|languages]], [[Creature token|creatures]], [[Interaction token|interactions]], [[Item token|items]] (currently excluding instruments), [[reaction]]s, [[Entity token|entities]], and [[Plant token|plants]] are open to this system.

Scripts are loaded from a mod's ``scripts/init.lua`` file, and can ``require()`` other files.

==Videos==
Announcement video:
*[https://www.youtube.com/watch?v=Z9rzhFwgfUk More powerful mods coming to Dwarf Fortress via Lua]
Tutorials:
*[https://youtu.be/QMxgsUogIIk Generating raws with Lua]
*[https://youtu.be/DEBTWMlUQzA Random creatures with Lua]

==Structure==

As of right now, Lua scripting is confined to generation of procedural objects. This is done by running the ``generate()`` function, a global function loaded in ``'''data/init/generators.lua'''``. It runs unit tests, preprocess, do_once (or do_once_early), materials, items, languages, creatures, interactions, entities and postprocessing, in that order.

When random objects are first generated, the game populates two global tables, ``world`` and ``random_object_parameters``.

* ``world`` contains info about the world currently being generated (or, in the future, played in). It contains [[World token|worldgen parameters]], raw object definitions, and a few other fields.

* ``random_object_parameters`` contains what the game expects to be generated in the current generation call.

You can print the contents of these tables to the log to see what data is available. The [https://steamcommunity.com/sharedfiles/filedetails/?id=3492961907 Runtime Dataminer] mod includes a script to read these tables.

DFHack also has a version of [https://github.com/DFHack/df-structures/blob/master/df.world.xml df.world], though these tables are not necessarily equivalent. Headers and paths may differ, even when referencing the same data.

===Debugging===
You can set the global ``debug_level`` variable to print some debug info. It's a number, but what numbers are there are completely arbitrary. If it's >0, it'll run unit tests; if it's >=0.5, it'll display what step of generation it's at, at every step. You can use ``get_debug_logger(x)`` to return a function that logs to ``lualog.txt`` if the debug level is at least ``x``.

Unit tests are functions that return a table, containing ``good``, which, if truthy, is considered passed, and ``info``, which is a string that contains information on said pass or fail. These unit tests should have no side effects, i.e. they shouldn't muck with global state any. Here's an example unit test shipped with the generators:

{{Scriptdata
|title=unittests.get_random_creature
|script=
get_random_creature=function()
local cr=world.creature.get_random_creature()
local res={}
res.good=type(cr)=='table'
res.info=res.good and ("Got a random creature: "..cr.token) or "No random creature could be gotten, even at most permissive!"
return res
end}}

===Object generation===
When ``generate()`` is called, it uses ``random_object_parameters`` to determine what is generated.

Before the world map is generated, ``random_object_parameters.pre_gen_randoms`` is true for one generation. Once the map is finalized, ``random_object_parameters.main_world_randoms`` is true for one generation when "generating prehistory"; most of the initial randomization takes place here. Further generation calls, such as for [[experiment]]s being created, do not set these variables to true.

If you're registering an entirely new procedural object type, you can generate it during these steps. The game includes a number of tables which you can add functions to, the game runs each function in them when generating raws.

*``do_once`` only runs in the "main world randoms" generation call and is the safest option for adding new objects.
*``do_once_early`` runs in the "pre-gen randoms" generation call, and can be used for objects that need to be placed in the map like minerals or surface animal populations.
*``preprocess`` runs before either of the former tables, but is run during every ``generate()`` call and you cannot predict when this happens.
*``postprocess`` runs at the end of each ``generate()`` call, after the other steps complete.

You can see examples of registering objects through these steps on the [[Lua script examples]] page.

If you want to use ``preprocess`` or ``postprocess`` to generate raws, you can check if it's the right generation step by reading the aforementioned ``random_object_parameters``. The [[Lua script examples#Adamantine alloys|"adamantine alloys" example]] includes such a check.

You can also mess around with ``random_object_parameters`` in preprocessing. Vanilla demon types are assigned here, and you can change the proportions as an end user if you want.

====Generation from list====
After ``preprocess`` and ``do_once``, the game then generates all of the individual objects that the ``random_object_parameters`` expects. The general procedure for this is that the game calls the ``generate_from_list()`` function on a table of functions, which calls every function and picks one of the resulting values at random depending on their weights.

For example, the ``interactions.secrets`` table contains one entry, that for necromancers; it returns a table containing three entries: ``{raws=tbl,weight=1,spheres=spheres}``.

*``raws`` is the full raw text of the interaction.
*``weight`` is the random weight for the interaction, i.e. if you add another function which returns a table containing ``weight=2``, that will be twice as likely as necromancers.
*``spheres`` is some extra data the generator might be able to use. It actually doesn't, at this point, but one could override ``generate_random_interactions()`` with their own version that takes into account ``spheres`` and, say, tries to evenly distribute generated secrets over available spheres. (This didn't end up in vanilla primarily out of concerns of bug-like behavior cropping up).

====Languages====
Languages are special, though; as can be seen in the [[Divine language/script]] or [[Lua script examples#Identity language|identity language]]. The ``languages`` table just expects to return table containing translations, e.g. ``tbl["ABBEY"]="abbey"``. If you want to procedurally add words or symbols (and yes, these are both doable), you can do so with ``raws.register_languages()`` in another function table.

==Creatures==
Creatures have a lot more to them than other procedural objects. Forgotten beasts are, in a sense, the simplest of them:

{{Scriptdata
|title=creatures.fb.default
|script=
creatures.fb.default=function(layer_type,tok)
local tbl={}
local options={
strong_attack_tweak=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:forgotten beast:forgotten beasts:forgotten beast]
[CASTE_NAME:forgotten beast:forgotten beasts:forgotten beast]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
return {creature=tbl,weight=1}
end}}

This is a lot of info! First, you build an ``options`` table; it's possible to make a full [[Lua functions#Options|list of options used in vanilla]], but other mods can also use arbitrary options. It then adds all the usual special-to-forgotten-beast tokens, in a big string, followed by calling ``add_regular_tokens(tbl,options)``, which adds some stuff common to all (vanilla) procedural creatures, based on the options given.

It sets ``do_water`` and the WATER [[sphere]] if the FB is in a water [[cavern]], an option which whitelists certain random creature profiles, as well as adding a random evil sphere.

``populate_sphere_info()`` is similar to ``add_regular_tokens()``; it adds all of the spheres in ``options.spheres`` to the creature, using the {{token|SPHERE}} token, then, if certain options are set, does more.

Then, it gets a random creature profile using ``get_random_creature_profile()`` and the options, uses ``add_body_size()`` to set the BODY_SIZE tokens and attendant things that come with it, sets the creature tile, and finally runs the Big Function, ``build_procgen_creature()``, which creates the description, body, tissues, et cetera.

===Random Creature Profiles===
{{main|Random creature profile}}
A random creature profile is a type of "thing" a generated creature can be. For example:

{{Scriptdata
|title=random_creature_types.GENERAL_QUADRUPED
|script=
GENERAL_QUADRUPED={
name_string="quadruped",
tile='Q',
body_base="QUADRUPED",
c_class="UNIFORM",
cannot_have_get_more_legs=true,
min_size=70000,
weight=1000
},
}}

Of these, only ``cannot_have_get_more_legs`` is optional. ``build_procgen_creature()`` has direct access to the rcp, as the first argument, and thus extra table entries can be used however you like.

``body_base`` points to a key in ``body_base_fun``, which is used to set creature options (walking and [[Procedural graphics layer|PCG layering]] are set this way) and returns a list of [[body token]]s. Quadrupeds use a special function to vary the sprite, so here's the body base function for a humanoid.

{{Scriptdata
|title=body_base_fun.HUMANOID
|script=
HUMANOID=function(rcp,options)
options.pcg_layering_base="BEAST_HUMANOID"
options.walk_var="STANDARD_BIPED_GAITS"
options.walk_speed=900
return {"RCP_UPPER_BODY","RCP_LOWER_BODY","RCP_NECK","RCP_HEAD","RCP_TWO_PART_ARMS","RCP_TWO_PART_LEGS"}
end
}}

``c_class`` also refers to another determines the kind of tissue layers the creature has. "FLESHY", "MAMMAL", "CHITIN_EXO", etc imply a biological creature with sinew, blood, different organs, nerves, and so on. "UNIFORM" describes a creature made of a single material, the choice influenced by its options. The ``random_creature_class`` and ``random_creature_material`` tables store the info for these traits.

Organic creatures can be tweaked to alter their surfaces, such as becoming skinless, hairy, or even uniform.

===Tweaks===

In the broadest sense, a tweak is any deviation from the creature profile. The aforementioned surface changes, new body parts, and attack interactions are all examples of tweaks.

A number of [[Lua functions#Options|options]] change the available tweaks or force one to happen, for example:
*``options.no_tweak`` disables random tweaks.
*``options.strong_attack_tweak`` allows the creature to always pick from the ``attack_tweaks`` table; ie: "Beware its webs!"
*``options.humanoidable_only`` makes the creature "twisted into humanoid form" (if evil), or "a <creature> in humanoid form" (if otherwise).

One potential use of ``btc1_tweaks`` (see [[Lua functions#Creature patching]]) is to add custom tweak candidates, pointing to keys in ``tweaks``.

===Color pickers===

Color picker functions can give more fitting [[color]] choices based on the options, instead of the default full spectrum. There are color pickers for certain malevolent [[sphere]]s, giving them a dark appearance. [[Werebeast]]s use a flag to only have natural brown or black colors.

If the creature matches ``cond`` and a given [[Descriptor color token|descriptor color]] matches ``color``, then it is added to the list of candidates. Colors have {{Tooltip|h,s,v|Hue, saturation, value}} and {{Tooltip|r,g,b|Red, green, blue}} values ranging from 0-1 (except hue, which ranges 0-360 degrees).

{{Scriptdata
|title=color_picker_functions
|script=color_picker_functions={
death_misery={
cond=function(options)
return options.spheres.DEATH or options.spheres.MISERY
end,
color=function(color)
-- GRAY TO BLACK/BLUEISH GREEN THAT ARE SOMEWHAT GRAYISH AND MORE BLUE
return (color.v<=0.75 and color.s<=0.001) or (color.v==color.b and color.s<=0.25)
end
},
darkness_night={
cond=function(options)
return options.spheres.DARKNESS or options.spheres.NIGHT
end,
color=function(color)
-- GRAY TO BLACK OR DARK BLUISH
return color.v<=0.4 and (color.s < 0.001 or (color.h>180 and color.h<=240))
end
},
werebeast={
cond=function(options)
-- werebeasts only, in vanilla
return options.animal_coloring_allowed
end,
color=function(color)
--BROWN OKAY TOO
return color.h>=30 and color.h<=48 and color.b<=0.15 and color.v<=0.75 and color.v > 0
end
}
}
}}

``options.blood_color`` works like a color picker function. If any colors match its function, then its [[blood]] will be colored like one of them. [[Bogeymen]] and [[nightmare]]s have a function that gives them magenta blood, for example, but you can create your own blood color functions.

Creatures with other blood types, such as ichor, are unaffected.

{{Scriptdata
|title=options.blood_color (Bogeyman)
|script=blood_color=function(cl)
-- DARKER MAGENTA COLORS
return cl.h>=260 and cl.h <= 340 and cl.v <= 0.5 and cl.v >= 0.1
end
}}

[[Category:Modding]]
[[Category:Lua|S]]

Lua functions

2026-01-29T06:55:47Z

DPhKraken: humanoidable_only remap

{{av}}
{{Modding}}

Dwarf Fortress defines a number of functions in addition to those standard for [https://www.lua.org/manual/5.4/ Lua 5.4].

==C++ function calls==

{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Function
! width="70%" | Description

|-
| ''int'' {{text anchor|trandom}}(''int'' n)
| Returns a 32-bit integer from {{Tooltip|0 to n-1|Lua arrays start at 1, C++ arrays start at 0, hence the discrepancy.}}. Uses DF's internal RNG system instead of ``math.random()``.

|-
| ''str'' {{text anchor|capitalize_string_words}}(''str'' s)
| Capitalizes every word in a string.

|-
| ''str'' {{text anchor|capitalize_string_first_word}}(''str'' s)
| Capitalizes the first word in a string.

|-
| ''str'' {{text anchor|utterance}}()
| Returns a word from the [[kobold language]].

|-
| ''void'' {{text anchor|lua_log}}(''str'' s)
| Prints a string to ``Dwarf Fortress/lualog.txt``. The ``log()`` function is more robust and should be used instead.

|-
|
''void'' {{text anchor|raws.register_reactions}}(''table'' lines) 
''void'' {{text anchor|raws.register_creatures}}(''table'' lines) 
''void'' {{text anchor|raws.register_entities}}(''table'' lines) 
''void'' {{text anchor|raws.register_items}}(''table'' lines) 
''void'' {{text anchor|raws.register_inorganics}}(''table'' lines) 
''void'' {{text anchor|raws.register_interactions}}(''table'' lines) 
''void'' {{text anchor|raws.register_languages}}(''table'' lines) 
''void'' {{text anchor|raws.register_plants}}(''table'' lines)
| Takes a table of [[token]]s and reads them as that type of [[raw file]]. It is not necessary to add a header.

|}

==Globals==
Helper functions are defined in ``init/globals.lua``, and can be accessed by any script even if ``vanilla_procedural`` is not loaded.

===Generation===
This function is defined in ``init/generators.lua``.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Function
! width="70%" | Description

|-
| ''table'' {{text anchor|add_generated_info}}(''table'' tbl)
| Adds {{token|GENERATED}} to the input table, and {{token|SOURCE_HFID}}/{{token|SOURCE_ENID}} if IDs are defined. Necessary for generated raws to be saved properly.

|}

===Randomization===
{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Function
! width="70%" | Description

|-
| ''value'' {{text anchor|pick_random}}(''table'' t)
| Returns a random value from a table.

|-
| ''value'' {{text anchor|pick_random_no_replace}}(''table'' t)
| Returns a random value from a table, then removes it from the table.

|-
| ''value'' {{text anchor|pick_random_conditional}}(''table'' t, ''function'' cond,...)
| Returns a random value from a table that satisfies ``cond(...)``.

|-
| ''bool'' {{text anchor|one_in}}(''num'' x)
| Returns true with a one in x chance.

|-
| ''value'' {{text anchor|pick_random_pairs}}(''table'' tbl)
| Returns a random key from a table. For example, ``pick_random_pairs( {WATER = true} )`` returns "WATER".

|-
| ''value'' {{text anchor|pick_weighted_from_table}}(''table'' tbl)
| Requires a table of tables with ``weight`` keys. Returns a weighted random value.
At debug level >=4, logs the roll.

|-
| ''value'' {{text anchor|generate_from_list}}(''table'' tbl,...)
| Requires a table of functions that return a ``weight`` key. Runs each function and returns a weighted random output. Used by [[werebeast]]s to generate an interaction and link to options from it.

|}

===Tables===

{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Function
! width="70%" | Description
|-
| ''table'' {{text anchor|split_to_lines}}(''table'' tbl,''string'' str)
| Adds a string into a table, with each line being a separate key.

|-
| ''table'' {{text anchor|map_merge}}(''table'' tbl1, ''table'' tbl2)
| Combines two tables. If ``tbl1`` already has a value for a given key, it will not be overwritten. Used for sets such as ``{ WATER = true }``.

|-
| ''table'' {{text anchor|table_merge}}(''table'' tbl1, ''table'' tbl2)
| Adds each value from ``tbl2`` onto the end of ``tbl1``.

|-
| ''bool'' {{text anchor|find_in_array_part}}(''table'' tbl, ''value'' item)
| Returns true if ``item`` is a value in ``tbl``.

|-
| ''void'' {{text anchor|convert_array_to_set}}(''table'' tbl)
| Makes a set from an array, e.g. takes {"a","b","c"} and makes it {a=true,b=true,c=true} so that it can be indexed.

|-
| ''void'' {{text anchor|add_unique}}(''table'' tbl, ''value'' item)
| Adds ``item`` to the end of ``tbl`` if not already present.

|-
| ''void'' {{text anchor|remove_item}}(''table'' tbl, ''value'' item)
| Removes all instances of ``item`` from ``tbl``.

|-
| ''table'' {{text anchor|shallow_copy}}(''table'' tbl)
| Returns a table copied from all values in the input table.

|-
| ''table'' {{text anchor|deep_copy}}(''table'' tbl)
| Returns a table recursively copied from all values in the input table.

|}

===Debug===

{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Function
! width="60%" | Description
|-
| ''void'' {{text anchor|log}}(...)
| Logs the input to ``Dwarf Fortress/lualog.txt``. Used for most cases.

|-
| ''string'' {{text anchor|get_caller_loc_string}}()
| Returns the debug source info and the current line.

|-
| ''string'' {{text anchor|get_debug_logger}}(''num'' level=1,...)
| Logs ``get_caller_loc_string()`` and any overloads if the ``debug_level`` is at least ``level``. ``debug_level`` is a global variable that defaults to 0.

|-
| ''function'' {{text anchor|partial_function}}(''function'' f, arg,...)
| Returns ``f(arg,...)``.

|-
| ''function'' {{text anchor|log_table}}(''table'' tbl, ''num'' debug_level=0, ''num'' nest_level=0, ''num'' added_debug_from_nest=0)
| Logs a table if the global ``debug_level`` is at least the input ``debug_level``. ``nest_level`` starts at 0 and adds ``added_debug_from_nest`` for each nesting to the input debug level.

|-
| ''function'' {{text anchor|print_table}}(''table'' tbl, ''num'' nest_level=0)
| Logs a table, regardless of debug level.

|}

===Spheres===

{| {{prettytable}}
|- style='background-color:#ddd'
! width="45%" | Function
! width="55%" | Description

|-
| ''string'' {{text anchor|get_random_sphere_adjective}}(''string'' [[Sphere#Sphere tokens|sphere]])
| Returns a random string from global table ``random_sphere_adjective[sph]``.

|-
| ''table'' {{text anchor|get_random_sphere_noun}}(''string'' [[Sphere#Sphere tokens|sphere]])
| Returns a random table ``tbl`` from global table ``random_sphere_nouns[sphere]``.
``tbl`` has two members: ``tbl.str``, which is a string; and ``tbl.flags``, which defaults to ``{OF=true,PREPOS=true,PRE=true}``, for grammar.

|-
| ''table'' {{text anchor|add_sphere_mpp}}(''table'' sphere_list, ''string'' [[Sphere#Sphere tokens|new_s]], ''table'' available_sphere, ''table'' available_sphere_cur)
| Adds ``new_s`` to ``sphere_list`` and all parents and children. Sets the added spheres in ``available_sphere`` and ``available_sphere_cur`` to false, and sets all enemies in ``available_sphere_cur`` to false.
At debug level >= 2, will be logged.
|}

==Generation tables==
The ``generate()`` function is defined in ``init/generators.lua``, and is called to generate objects.

Each type of random object is defined through a function that generates a table of raws. To generate objects for specific purposes, ``generate()`` can call functions from a table and provide inputs such as ``tok`` (unique token string).
For example, [[forgotten beast]]s are unique and generated for each cave region. If multiple functions are defined in ``creatures.fb``, such as both ``creatures.fb.default`` and a modded forgotten beast, the game uses the ``weight`` output to influence which one will be randomly chosen.

By default, objects are generated in this order: unittests{{Tooltip|*|if debug_level is at least 0}}, preprocess, do_once, materials, items, languages, creatures, interactions, entities, and postprocess. Do note that you can register raws at any step. For example, each [[vault]] entity generates a set of [[divine equipment]] during the entity step, and [[werebeast]]s generate a curse interaction during the creature step.

===Custom===

{{main|Lua scripting#Object generation}}

When the game uses ``generate()`` to generate objects, all functions in the following tables are run in sequence.

``random_object_parameters.pre_gen_randoms`` and ``random_object_parameters.main_world_randoms`` are only ever true for one generation call each, at the start of world generation in that order.

You cannot predict when ``generate()`` is called. Raws registered through ``preprocess`` and ``postprocess`` should check for either variable so that further calls do not endlessly register raws.

Functions stored and called through these tables are not supplied with arguments.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Table
! width="80%" | Description

|-
| preprocess
| Run at the start of each ``generate()`` call, after unit testing.
Includes two functions by default: 
``preprocess.demon()``, which populates the distribution of ``demon_type`` string inputs 
``preprocess.bogeyman_polymorph()``, which generates the [[bogeyman]]'s polymorph [[Interaction token|interactions]] if bogeymen exist 

|-
| do_once_early
| As ``do_once``, but only runs if ``random_object_parameters.pre_gen_randoms == true`` (before the map exists)
Recommended for generating custom objects that need to be placed in the map; ie: animal populations, [[stone layers|minerals]].

|-
| do_once
| Runs immediately after all functions in preprocess, and before all other generation steps. Only runs if ``random_object_parameters.main_world_randoms == true`` (in prehistory once the map is finalized)
Recommended for generating most custom objects. 
Includes one function by default: 
``do_once.rcp_mat_emission()``, adds the ``RCP_MATERIAL_EMISSION`` [[Interaction token|interaction]]

|-
| postprocess
| Runs after all other generation steps are finished.

|-
| unittests
| Runs before preprocess if the global ``debug_level`` is greater than 0. Expects a boolean output.

|-
| languages
| For each function in this table, registers a language. Expects table of key-value pairs where the key is the [[Language token#WORD|word token]] and the value is the translated string. Initial generation call only.

|}

===Creatures===
{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Table
! width="40%" | Inputs
! width="60%" | Article

|-
|
creatures.angel.great_beast 
creatures.angel.humanoid_generic 
creatures.angel.humanoid_warrior
| function(tok)
| [[Angel]] (see [[Angel#Angel types|types]])

|-
| creatures.demon
| function(demon_type, difficulty, tok)
| [[Demon]]

|-
|
creatures.experiment.beast_large 
creatures.experiment.beast_small 
creatures.experiment.failed_large 
creatures.experiment.failed_small 
creatures.experiment.humanoid_giant 
creatures.experiment.humanoid 
| function(tok)
| [[Experiment]]

|-
| creatures.fb
| function(layer_type, tok)
| [[Forgotten beast]]

|-
| creatures.night_creature.bogeyman
| function(tok)
| [[Bogeyman]]

|-
| creatures.night_creature.nightmare
| function(tok)
| [[Nightmare]]

|-
| creatures.night_creature.troll
| function(tok)
| [[Night troll]]

|-
| creatures.night_creature.werebeast
werebeast_origin_interactions{{Tooltip|*|Called by vanilla_procedural, not by init/generators}}
| function(tok)
function(tok, name, options)
| [[Werebeast]]

|-
| creatures.titan
| function(subregion, tok)
| [[Titan]]

|}
====Creature patching====
{{Main|Lua scripting#Tweaks}}
While ``SELECT_CREATURE`` cannot target generated objects, there are global tables set up to append data when building a creature. These tables contain functions which have access to tokens, options, and local functions from ``build_body_from_rcp()``. All functions in these tables are run at corresponding stages in the build function.

``lines``, ``options`` and ``rcp`` are the creature's raw lines and data, which can be read or modified in these functions.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="10%" | Table
! width="30%" | Inputs
! width="50%" | Timing

|-
| btc1_tweaks
| function(lines, options, add_to_body, add_to_body_unique, add_tweak_candidate)
| Before ``options.btc`` (the first tweak) is determined.

|-
| feature_tweaks
| function(rcp, options, add_to_body, add_to_body_unique, add_tweak_candidate)
| After ``options.btc2`` is set. ``add_tweak_candidate()`` is unused in vanilla at this stage.

|-
| post_attack_tweaks
| function(lines, options, is_in_body)
| After ``options.attack_tweak`` is set. By default, runs functions to add {{token|ATTACK}}s for body parts.

|-
| post_gait_tweaks
| function(lines, options)
| This is the last operation in the build function.
Includes the ``bogey_polymorph()`` function by default, which checks ``options.can_bogey_polymorph`` to add the interaction.

|}

{| {{prettytable}}
|- style='background-color:#ddd'
! width="25%" | Local Function
! width="80%" | Effect

|-
| ''void'' add_to_body(str)
| Adds the input [[body token]] to the ``options.body_string`` table.

|-
| ''void'' add_to_body_unique(str)
| As ``add_to_body()`` and ``add_unique()``, only adds if not already present.

|-
| ''void'' add_tweak_candidate(str)
| Adds the input to ``options.body_tweak_candidate``, pointing to a key in the ``tweaks`` table.

|-
| ''bool'' is_in_body(str)
| Checks if the input [[body token]] is in ``options.body_string``.

|}

===Entities===

Generated entities are supplied with the ``idx`` parameter, which is a number that starts at 1 and increments by 1 for each entity of that type. It can be used to give a unique ID to [[divine equipment]].

{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Table
! width="20%" | Inputs
! width="60%" | Articles

|-
| entities.vault_guardian
| function(idx,tok)
| [[Vault]] ([[angel]]s)

|-
| entities.mythical_guardian
| function(idx,tok)
| [[Mysterious dungeon]] ([[dungeon guardian]]s)

|}

===Interactions===

====World====
World interactions are generated in the ``generate_random_interactions()`` step of ``generators.lua``.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Table
! width="30%" | Inputs
! width="60%" | Examples

|-
|
interactions.blessing.minor 
interactions.blessing.medium
| function(idx)
| [[Die]] roll effects: luck, holy item, healing, etc

|-
|
interactions.curse.minor 
interactions.curse.medium
| function(idx)
| [[Die]] roll effects: week of curse

|-
| interactions.curse.major
| function(idx,tok)
| [[Vampire]]

|-
| interactions.disturbance
| function(idx)
| [[Mummy]]

|-
| interactions.mythical
| function(idx,power_level,[[sphere]])
| [[Dungeon guardian]]

|-
| interactions.mythical_item_power
| spheres={}, interaction=function()
| [[Primordial remnant#List of powers]]

|-
| interactions.regional
| function(idx)
| Reanimating [[Surroundings#Evil|evil biomes]]

|-
| interactions.secrets
| function(idx,[[sphere]])
| [[Necromancer]]

|}

====Powers====
Powers are stored in the ``interactions.powers`` table and can be generated by other interactions. The structure of each power entry contains several keys that determine how it can be added to an interaction's syndrome.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="15%" | Key
! width="30%" | Inputs
! width="60%" | Notes

|-
| tags
| ''table''
| A table of user-defined values that can be checked by other functions.

|-
| tags.lieutenant
| ''bool''
| If true, available to [[intelligent undead]].

|-
| rarity
| ''number'' n
| Higher is rarer. An [[intelligent undead]] has a 1 in n chance to receive this power.

|-
| gen
| ''table'' ``tbl``, ''table'' ``end_tbl`` function(name)
| Generates and returns lines of raws.
* ``tbl`` consists of [[syndrome]] lines comprising {{token|CE_CAN_DO_INTERACTION|syndrome}} and ``[[Interaction token#Usage|CDI]]``.
* ``end_tbl`` consists of lines that define the [[interaction]].

|}

====Interaction helpers====

Interaction helpers are defined by ``vanilla_procedural``.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Function
! width="60%" | Notes

|-
| ''table'' ``tbl``, ''table'' ``end_tbl`` basic_lieutenant(''string'' name, ''string'' name_plural, ''string'' token)
| Generates an interaction that raises an [[intelligent undead]] and calls ``basic_lieutenant_powers(token)``.

|-
| ''table'' ``tbl``, ''table'' ``end_tbl`` basic_lieutenant_powers(''string'' token)
| Adds any number of powers (chosen from among ``interaction.powers``) and 0-5 sicken effects (from ``add_curses()``) to the current definition.

|-
| ''table'' ``tbl``, ''table'' ``end_tbl``, ''int'' ``idx`` add_curses(''table'' tbl, ''table'' end_tbl, ''string'' token, ''int'' num, ''int'' start_idx, ''int'' sev, ''table'' good_effects)
| Adds ``num`` curses/afflictions to the current definition. ``good_effects`` lists the possible curses that can be chosen from ``default_curse_effects``, and ``sev`` is the syndrome's severity. Basic lieutenants use a ``sev`` of 500.

|-
| ''string'' get_abstract_gesture()
| Returns a random string from either ``gestures`` or ``gestures_abstract``, used for {{token|VERB|interaction}}.

|-
| populate_monotone_color_pattern()
| Writes all [[Descriptor color token|MONOTONE color patterns]] from ``world.descriptor.color_pattern`` to the global table ``monotone_color_pattern``, if not already populated.
Not to be confused with ``world.descriptor.color``, which has the same keys as a color rather than a pattern.

|-
| add_base_poison_effects(mat, good_effects, sev, max_eff, min_start, max_start, min_peak, max_peak, min_end, max_end, terminal_chance, resist_chance, size_delay_chance, size_dilute_chance)
| Writes 1 to ``max_eff`` [[syndrome]] effects from ``good_effects`` to ``mat``, a table of raw lines. Has a one in ``terminal_chance`` to not end. If the effect {{token|RESISTABLE}}

|}

===Items===

====Instruments====

The default [[instrument]] system is not currently open to Lua, but ``generators.lua`` defines tables for each token.
{| {{prettytable}}
|- style='background-color:#ddd'
! width="30%" | Table
! width="30%" | Inputs
! width="40%" | Token

|-
| items.instruments.keyboard
| N/A
| {{token|GENERATE_KEYBOARD_INSTRUMENTS|e}}

|-
| items.instruments.stringed
| N/A
| {{token|GENERATE_STRINGED_INSTRUMENTS|e}}

|-
| items.instruments.wind
| N/A
| {{token|GENERATE_WIND_INSTRUMENTS|e}}

|-
| items.instruments.percussion
| N/A
| {{token|GENERATE_PERCUSSION_INSTRUMENTS|e}}

|}

====Divine equipment====
{{Main|Divine equipment}}
``entities.vault_guardian.default`` generates from the list ``angel_item_gens``, the default function of which then calls functions from ``angel_item_info``. Unless otherwise stated, the '''Behavior''' column refers to the behavior of how ``angel_item_gens.default`` generates from these lists.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Table
! width="20%" | Inputs
! width="60%" | Behavior

|-
| angel_item_gens
| function(prefix,tokens)
| Called by ``entities.vault_guardian.default``, which supplies a unique ``prefix`` and doesn't provide ``tokens``.

|-
|
angel_item_info.armor.pants.gen 
angel_item_info.armor.armor.gen 
angel_item_info.armor.helm.gen 
angel_item_info.armor.gloves.gen 
angel_item_info.armor.shoes.gen 
angel_item_info.shield.gen
| function(i,prefix)
| Generates 1 piece of [[armor]] for each slot and 1 [[shield]].

|-
|
angel_item_info.clothing.pants.gen 
angel_item_info.clothing.armor.gen 
angel_item_info.clothing.helm.gen 
angel_item_info.clothing.gloves.gen 
angel_item_info.clothing.shoes.gen
| function(i,prefix)
| Generates 1 piece of [[clothing]] for each slot.

|-
|
angel_item_info.weapon.PIKE.gen 
angel_item_info.weapon.WHIP.gen 
angel_item_info.weapon.BOW.gen 
angel_item_info.weapon.BLOWGUN.gen 
angel_item_info.weapon.AXE.gen 
angel_item_info.weapon.SWORD.gen 
angel_item_info.weapon.DAGGER.gen 
angel_item_info.weapon.MACE.gen 
angel_item_info.weapon.HAMMER.gen 
angel_item_info.weapon.SPEAR.gen 
angel_item_info.weapon.CROSSBOW.gen
| function(i,prefix)
| Generates 5 [[weapon]]s. The tables correspond to [[combat skill]]s, and are not repeated. For example, a vault can't generate two types of swords.

|-
|
angel_item_info.ammo.ARROW 
angel_item_info.ammo.BOLT 
angel_item_info.ammo.BLOWDART
| function()
| When a ranged weapon is generated, it will also generate a random subtype of the proper ammunition.

|}

===Materials===

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Table
! width="15%" | Inputs
! width="15%" | Article
! width="60%" | Notes

|-
| materials.clouds
materials.rain
| function()
| [[Evil weather]]
| Associated regional [[interaction]]s are automatically written by ``init/generators.lua``.

|-
| materials.divine.metal
materials.divine.silk
| function([[sphere]])
| [[Divine metal]]
[[Divine fabric]]
| The list of potential spheres is determined by the individual function. See [[Lua script examples#New divine metal]].
{{token|DIVINE|inorganic}} and {{token|SPHERE|inorganic}} are added by ``generators.lua`` rather than in the individual function.

|-
| materials.mythical_remnant
| function([[sphere]])
| [[Primordial remnant]]
| Possible spheres are determined by ``random_object_parameters.mythical_sphere``.

|-
| materials.mythical_healing
| function()
| [[Mythical substance]]
|

|}

==Random creatures==

Creatures generated by ``vanilla_procedural`` use a number of shared functions to determine their attributes. The local ``options`` table stores most of the data used by these steps.

===rcp functions===
The random creature profile determines the basic body of a generated creature, such as "humanoid" or "[[toad]]", and provides options and data to later build the proper creature definition.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Function
! width="60%" | Notes

|-
| ''table'' get_random_creature_profile(options,blacklist)
| Makes a weighted random choice of options from ``random_creature_types`` that satisfy arguments set in ``options`` (``options.do_water``, etc) and ``blacklist``. Falls back to ``random_creature_types.GENERAL_BLOB``.
At debug_level >= 3, will log failures. At debug_level >= 4, will also log successes.

|-
| ''bool'' is_valid_random_creature(''string'' creature, ''bool'' do_water, ''bool'' humanoidable_only, ''bool'' is_good, ''bool'' beast_only)
| Checks if ``creature`` is a valid key in certain tables depending on the arguments: aquatic (``do_water``), can be "twisted into humanoid form" (``humanoidable_only``), isn't an "evil" species (``is_good``), and is an animal species (``beast_only``)
At debug_level >= 3, will be logged.

|-
| ''void'' finalize_random_creature_types()
| If ``random_creature_types_finalized`` is false: sets it to true and iterates over ``random_creature_types`` to sanitize certain inputs.

|}

===Shared functions===

Default creatures use ``add_regular_tokens()``, ``populate_sphere_info()``, ``get_random_creature_profile()``, ``add_body_size()`` and ``build_procgen_creature()`` as the main steps in generating raws.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="40%" | Function
! width="60%" | Notes

|-
| add_regular_tokens(tbl,options)
| Adds tokens to ``tbl``. Sets {{token|PETVALUE|2000}}, calculates material weaknesses (if ``options.material_weakness``), and adds a few immunity tokens depending on ``options.normal_biological``.

|-
| tile_string(arg)
| Returns a string usable for {{token|CREATURE_TILE}}. Encloses number arguments in ``'`` characters.

|-
| add_body_size(tbl,size,options)
| Adds {{token|BODY_SIZE|0:0:size}} and sets ``options.body_size``. Calls ``body_size_properties()``.

|-
| body_size_properties(tbl,size,options)
| Adds {{token|BUILDINGDESTROYER|2}} if size > 80,000; adds {{token|GRASSTRAMPLE|20}} and {{token|TRAPAVOID}} if size > 100,000.

|-
| populate_sphere_info(tbl,options)
| Adds {{token|SPHERE}} tokens from ``options.spheres``. If ``options.do_sphere_rcm``, 1/2 chance to set ``options.sphere_rcm``.

|-
| add_poison_bits(tbl,options)
| Generates a [[Venom|poison material]] based on ``options.poison_state`` and ``options.sickness_name``.

|-
| build_procgen_creature(rcp,tbl,options)
| Calls ``build_body_from_rcp()``, ``build_description()``, and ``build_pcg_graphics()``.

|-
| build_body_from_rcp(rcp,tbl,options)
| Generates based on ``rcp`` and ``options``, assigns tweaks (mutations from the base body), tissues, organs, special attacks.

|-
| build_description(tbl,options)
| Writes the {{token|DESCRIPTION}} and any {{token|PREFSTRING}}s.

|-
| build_pcg_graphics(tbl,options)
| Assigns [[procedural graphics layer]]s based on ``options.pcg_layering`` keys set by ``build_body_from_rcp()``.

|}

===Options===
{| {{prettytable}}
|- style='background-color:#ddd'
! width="15%" | Key
! width="20%" | Usage
! width="80%" | Notes

|-
| token
| add_poison_bits()
build_body_from_rcp()
| The creature's token.

|-
| do_water
| get_random_creature_profile()
| Use an aquatic rcp (``water_based_random_creature``)

|-
| humanoidable_only
| get_random_creature_profile()
build_body_from_rcp()
| Use a rcp that can be turned into a humanoid form (``humanoidable_random_creature``), and automatically applies the ``MAKE_HUMANOID`` tweak. Will apply the tweak even if the body is already humanoid.

|-
| beast_only
| get_random_creature_profile()
| Forbids generic humanoid/blob/quadruped rcps (``not_beast_random_creature``).

|-
| normal_biological
| add_regular_tokens()
| If untrue, adds {{token|AMPHIBIOUS}}, {{token|SWIMS_INNATE}}, {{token|NONAUSEA}}, {{token|NOEXERT}}, {{token|NO_DIZZINESS}}, {{token|NOPAIN}}, {{token|NOSTUN}}. Used by [[experiment]]s.

|-
| always_nobreathe
| build_body_from_rcp()
| Adds {{token|NOBREATHE}}, even if not uniform.

|-
| no_general_poison
| build_body_from_rcp()
| If untrue and the creature has blood or ichor, adds {{token|CREATURE_CLASS|c|GENERAL_POISON}}.

|-
| fire_immune
| build_body_from_rcp()
| Adds {{token|FIREIMMUNE}}. Does not affect materials. Set if the creature has a fire interaction.

|-
| material_weakness
| add_regular_tokens()
| Will gain a 10x {{token|MATERIAL_FORCE_MULTIPLIER}} to a random weapon [[metal]] and a {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER|c|1:2}}.

|-
| is_good
|
get_random_creature_profile() 
build_body_from_rcp() 
build_description()
| Forbids "evil" rcps (``cannot_be_good_random_creature``).
Affects options for materials, tweaks, description. Cannot have attack tweaks unless the rcp forces it.

|-
| is_evil
| build_body_from_rcp()
build_description()
| Affects options for materials, tweaks, description.

|-
| spheres
| populate_sphere_info()
color_picker_functions 
build_description()
| A set of the creature's spheres.

|-
| do_sphere_rcm
| populate_sphere_info()
| Adds a 1/2 chance to set ``options.sphere_rcm`` to a material relevant to their spheres.

|-
| pick_sphere_rcm
| random_creature_class.UNIFORM.body_fun()
| If uniform, adds an additional 1/2 chance to use a material relevant to their spheres.

|-
| pos_sphere_rcm
| populate_sphere_info()
| Temporary data storage for possible sphere RCM during ``populate_sphere_info()``.

|-
| sphere_rcm
| build_body_from_rcp()
| Forces the creature to be uniform and made of that ``random_creature_material``.

|-
| always_insubstantial
| build_body_from_rcp()
| If uniform, will always choose an insubstantial material from ``insubstantial_materials``.

|-
| never_uniform
| build_body_from_rcp()
| If ``options.r_class`` is UNIFORM, change it to FLESHY.

|-
| always_make_uniform
| build_body_from_rcp()
| Changes ``options.r_class`` to UNIFORM.

|-
| do_not_make_uniform
| build_body_from_rcp()
| Do not randomly change ``options.r_class`` to UNIFORM (normally there is a 1/20 chance), unless ``options.sphere_rcm`` is set.

|-
| walk_var
| build_body_from_rcp()
| A string for {{token|APPLY_CREATURE_VARIATION}}, ex: "STANDARD_WALKING_GAITS". Usually set by ``rcp.body_base``.

|-
| walk_speed
special_walk_speed
| build_body_from_rcp()
| The basic walking speed in a creature's [[gait]]. ``options.special_walk_speed`` will be used instead of ``options.walk_speed`` if both are present.
Crawling bodies use a ``options.walk_speed`` of 2900, walking bodies use 900.

|-
| add_fly_gaits
| build_body_from_rcp()
| Creature has a flying gait even if wings aren't added. ``local add_fly_gaits`` is used for creatures with wings.

|-
| intangible_flier
| build_body_from_rcp()
| If ``options.intangible`` (set by certain uniform materials), sets ``options.add_fly_gaits`` and adds {{token|FILER}}.

|-
| cannot_swim
| build_body_from_rcp()
| Will not add a [[swimming]] gait.

|-
| no_tweak
| build_body_from_rcp()
| Will not add any random tweaks (such as body parts or attacks) to the basic creature that aren't specified by the rcp.

|-
| always_glowing_eyes
| build_body_from_rcp()
| Will always add glowing eyes if the creature has ``options.eyes``.

|-
|
no_glowing_eyes 
cannot_have_antennae 
cannot_have_mandibles
| build_body_from_rcp()
| Will not add the listed body tweaks.

|-
| no_random_attack_tweak
| build_body_from_rcp()
| Will not add attack tweaks (or body parts that grant them) that aren't specified by the rcp.

|-
| strong_attack_tweak
| build_body_from_rcp()
| Enables access to attack tweaks. Will always gain an attack tweak, unless the rcp already specifies it.

|-
| experiment_attack_tweak
| build_body_from_rcp()
| Enables access to a limited set of attack tweaks 1/4 of the time.

|-
| sickness_name
| add_poison_bits()
| Determines the name of [[syndrome]]s caused by this creature.

|-
| poison_state
| add_poison_bits()
build_body_from_rcp()
| Accepts "LIQUID" (default), "GAS", or "SOLID_POWDER". Determines the state of this creature's [[venom]].

|-
| prioritize_bite
| post_attack_tweaks
| If true, non-bite attacks will have {{token|PRIORITY|c|SECOND}}. If untrue, non-bite attacks will have {{token|PRIORITY|c|MAIN}}.

|-
| bite_interaction
| post_attack_tweaks
| Adds {{token|SPECIALATTACK_INTERACTION}} to bite attacks.

|-
| can_bogey_polymorph
| post_gait_tweaks
| Allows the creature to use the [[bogeyman]] polymorph interaction.

|-
| rcp
| build_body_from_rcp()
build_description()
| Set in ``build_body_from_rcp()`` from the ``rcp`` argument.
Usually derived from ``random_creature_types``, passes information from the random creature profile.

|-
| r_class
| build_body_from_rcp()
| Set to a table in ``random_creature_class``. Describes the basic tissues/features a creature has, such as FLESHY, CHITIN_EXO, or UNIFORM.

|-
| surface
| build_body_from_rcp()
| The creature's exterior tissue. Set based on its ``random_creature_class`` and any tweaks.

|-
| rcm
| random_creature_class.UNIFORM.body_fun()
| Set by ``random_creature_class.UNIFORM.body_fun()``.
If ``options.sphere_rcm`` is supplied, will use that, otherwise will be randomly chosen based on ``options.is_evil``, ``options.is_good``, ``options.pick_sphere_rcm``, ``options.rcp.requires_flexible_material``, and ``options.always_insubstantial``.

|-
| post_mat_adj
| build_description()
| A string that says "composed of X", etc. Normally supplied by ``random_creature_material``.

|-
| matgloss
| random_creature_class.UNIFORM.body_fun()
| Temporary data storage when calling inorganic materials from ``random_creature_material``.

|-
| tok1
tok2
| random_creature_class.UNIFORM.body_fun()
| A uniform creature's {{token|TISSUE_MATERIAL|tissue|options.tok1:options.tok2}}.
Must be supplied by ``random_creature_material``.

|-
| mat_temp1
mat_temp2
| random_creature_class.UNIFORM.body_fun()
| A uniform creature's {{token|USE_MATERIAL_TEMPLATE|c|options.tok1:options.tok2}}.
Can be supplied by ``random_creature_material`` to add an organic material.

|-
| st_tok
| random_creature_class.UNIFORM.body_fun()
| A uniform creature's {{token|TISSUE_MAT_STATE|tissue}}. Must be supplied by ``random_creature_material``.

|-
| fixed_temp
| random_creature_class.UNIFORM.body_fun()
| A uniform creature's {{token|FIXED_TEMP|}}.
Can be supplied by ``random_creature_material``. If a material template is used, adds {{token|MAT_FIXED_TEMP|md}}.

|-
| intangible
| build_body_from_rcp()
| Flag normally supplied by ``random_creature_material``. Creature is non-solid, serves as the condition for ``options.intangible_flier``. Limits access to attack tweak.

|-
| fire_mat
| build_body_from_rcp()
| Flag normally supplied by ``random_creature_material``. Prevents a fire breath attack.

|-
| body_string
| build_body_from_rcp()
| An array of all {{token|BODY}} tokens used.

|-
| body_size
| build_description()
build_pcg_graphics()
| Set by ``body_size_properties()``. Stores the creature's volume for later use.

|-
| body_tweak_candidate
| build_body_from_rcp()
| Temporary data storage for assigning tweaks.

|-
| tweak
| ''quadruped_function_curry()''
| Temporary data storage for quadruped leg tweaks.

|-
|
attack_tweak 
btc 
btc2 
| build_body_from_rcp()
build_description()
| Strings used as a key to retrieve information about the chosen tweaks. Set by ``build_body_from_rcp()``

|-
|
eyes 
beak 
brain 
cheeks 
eyelids 
guts 
heart 
lips 
lungs 
mouth 
neck 
nose 
ribs 
skull 
spine 
teeth 
throat 
tongue
| build_body_from_rcp()
| Normally set by the creature's ``random_creature_class`` (MAMMAL, CHITIN_EXO, etc).
Adds the listed parts to the creature's body plan.

|-
|
blood 
ichor 
goo
| build_body_from_rcp()
| Normally set by the creature's ``random_creature_class`` (MAMMAL, CHITIN_EXO, etc).
Sets the creature's default {{token|BLOOD}} type.

|-
| force_goo
force_ichor
| build_body_from_rcp()
| If the creature is not uniform, overwrites the creature's default {{token|BLOOD}} type.

|-
| blood_color
| build_body_from_rcp()
| Expects a function that takes a color's HSV values and returns a boolean. Sets the creature's blood color to any color that returns true for this function.
Only works with standard [[blood]] from ``options.blood``.

|-
|
glowing_eyes 
fingers 
toes 
finger_claws 
toe_claws 
finger_nails 
toe_nails 
finger_talons 
toe_talons 
bat_wings 
lacy_wings 
feathered_wings 
has_proboscis 
do_webs

| build_procgen_creature()
| Set when building the body if the creature has those traits. Can be called by the description and when building graphics.
[[Nail]]s, claws, and talons are given attacks.

|-
| eye_count
| build_procgen_creature()
| The number of eyes the creature has. Set when building the body.

|-
| tail_count
| build_procgen_creature()
| The number of tails the creature has. Can be set before building the body.

|-
| clp
| build_procgen_creature()
| The creature's body color. Chosen randomly or based on material unless ``rcp.cannot_have_color`` is true.

|-
| eye_clp
| build_procgen_creature()
| The creature's eye color. Set when building the body.

|-
|
color_f 
color_b 
color_br
| build_body_from_rcp()
| Set based on ``options.clp`` unless ``options.forced_color`` is supplied. Adds {{token|COLOR|c|options.color_f:options.color_b:options.color_br}}.

|-
| forced_color
| build_body_from_rcp()
| Adds {{token|COLOR|c|options.forced_color.f:options.forced_color.b:options.forced_color.br}} and {{token|NO_UNIT_TYPE_COLOR}}.

|-
| animal_coloring_allowed
| build_body_from_rcp()
| Color must be a shade of brown.

|-
| experiment_colors
| build_body_from_rcp()
| Uses the set of colors assigned to [[experiment]]s.

|-
| exp_proc_surface_color
| build_pcg_graphics
| Stores the index of an experiment's color, for portraits.

|-
|
name_mat 
flavor_adj 
potential_end_phrase
| Custom names
| An array of names for a creature's material. Can be supplied by ``random_creature_material``.

|-
| feature_flavor_adj
| Custom names
| When ``build_description()`` is run, populates ``options.flavor_adj`` with strings based on the creature's tweaks and [[color]].

|-
| can_learn
| build_description()
| Enables certain description strings, such as "it knows and intones the names of all it encounters". Used by default intelligent creatures.

|-
| no_extra_description
| build_description()
| Will not add strings from ``default_desc_adds``/``good_desc_adds``/``evil_desc_adds`` to the end of the description.

|-
| custom_desc_func
| build_description()
| Adds the output of a string instead of ``default_desc_adds``/etc. Cannot have ``options.no_extra_description.``

|-
| end_phrase
| build_description()
| Adds a phrase after all other generated description pieces, such as [[Night creature|"Now you know why you fear the night."]]

|-
| and_add
| build_description()
| Temporary storage for description grammar.

|-
| pref_str
| build_description()
| A table of possible {{token|PREFSTRING}}s.

|-
| fallback_pref_str
| build_description()
| A string that is added to ``options.pref_str`` it is empty.

|-
| odor_string
odor_level
| build_body_from_rcp()
| Sets {{token|ODOR_STRING|}} and {{token|ODOR_LEVEL|}} respectively. Can be supplied by ``random_creature_material``.

|-
| forced_odor_string
forced_odor_level
forced_odor_chance
| build_body_from_rcp()
| Sets {{token|ODOR_STRING|}} and {{token|ODOR_LEVEL|}} (defaults to 90), 1 in ``options.forced_odor_chance`` of the time.

|-
| always_odor
| build_body_from_rcp()
| Can use the ``options.forced_odor_string`` even if creature is uniform.

|-
| pcg_layering
| build_pcg_graphics()
| A set of [[procedural graphics layer]]s. Set by ``build_pcg_graphics()``.

|-
| pcg_layering_base
| build_pcg_graphics()
| The basic PCG layer-set string, concatenated to form ``options.pcg_layering`` keys. Set by ``build_body_from_rcp()``.

|-
| pcg_layering_modifier
| build_pcg_graphics()
| A set of extra info for PCG layering, such as experiment skin types. Set by ``build_body_from_rcp()``.

|-
| use_werebeast_pcg
| build_pcg_graphics()
| If true, use the layers for [[werebeast]]s.

|-
| experiment_layering
| build_pcg_graphics()
| If true, use the layers for humanoid [[experiment]]s. Expects ``options.experiment_colors`` to be true.

|-
|
is_male_version
night_creature_strength_pref
night_creature_agile_pref
night_creature_strength_agile_pref
| night_troll_names
| Flags used by [[Night troll]]s.

|-
| no_default_werebeast_curse
| werebeast_origin_interactions.default()
| If this is true for a custom function in creatures.night_creature.werebeast, ``generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)`` will not be able to use werebeast_origin_interactions.default. This allows [[mod]]s to better control access to [[werebeast]] curses.

|-
| amalgam_experiment
failed_experiment
| ''experiment_description()''
| Flags used for default [[experiment]]s.

|-
| experiment_name_type
| ''experiment_name_token''
| Array of nouns used instead of ``ropar.making_experiment`` for naming [[experiment]]s.

|-
| is_large
| ''make_failed_rcp()''
| Used for large failed [[experiment]]s. Capitalizes the creature tile.

|-
| eadj
fadj
| Custom names
| Temporary data storage for complex name generation.

|}

===rcp parameters===

[[Category:Modding]]
[[Category:Lua|F]]

Lua script examples

2026-01-29T06:52:48Z

DPhKraken: /* Werebugs */ humanoidable_only remap

{{av}}
{{Modding}}
{{Main|Lua scripting}}
Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``[https://github.com/Putnam3145/DF-Raws/tree/master/vanilla_procedural/scripts data/vanilla/vanilla_procedural/scripts/]``.
__TOC__


==Helper functions==

===Search by reaction class===
This script returns a table of all inorganic materials with a given {{token|REACTION_CLASS|md}}. The ``mat`` table also has ``reaction_product_class``, which includes both {{token|MATERIAL_REACTION_PRODUCT|md}} and {{token|ITEM_REACTION_PRODUCT|md}} IDs.
{{Scriptdata
|title=get_all_by_reaction_class()
|script=
function get_all_by_reaction_class(rc)
local valid={}
for i,inorg in ipairs(world.inorganic.inorganic) do
for _,class in inorg.mat.reaction_class do
if class==rc then
valid[#valid+1]=inorg
end
end
end
return valid
end}}

==Languages==

===Identity language===
This makes a [[Language token|language]] called ``GEN_IDENTITY`` which is like: "Abbey abbeyabbeys the abbey of abbeys" - i.e. it's the "English" language you might see occasionally. It is present in ``vanilla_procedural`` and can be used for {{Token|TRANSLATION|entity}} by default.

{{Scriptdata
|title=GEN_IDENTITY
|script=
languages.GEN_IDENTITY=function()
-- just to demonstrate the absolute most basic method of generating one of these
-- also so that you can just mod stuff to use GEN_IDENTITY
local tbl={}
local unempty = function(str1, str2)
return str1=='' and str2 or str1
end
for k,v in ipairs(world.language.word) do
local str=''
str=unempty(str,v.NOUN_SING)
str=unempty(str,v.ADJ)
str=unempty(str,v.VERB_FIRST_PRES)
str=unempty(str,string.lower(v.token))
tbl[v.token]=str
end
return tbl
end}}

===Kobold language===
This generates a language made of {{token|UTTERANCES}}. This is essentially a proper translation based on the [[kobold language]]. Note that the hardcoded ``utterance()`` function generates words independently of any existing words in the language, so you may get duplicate words.

{{Scriptdata
|title=GEN_KOBOLD
|script=
languages.GEN_KOBOLD=function()
local tbl={}
for k,v in ipairs(world.language.word) do
tbl[v.token]=utterance()
end
return tbl
end}}

==Generators==

===Non-random generated material===

Here's an example of an object registered through the ``do_once`` table. There are no random elements, it is equivalent (save for being {{token|GENERATED|mat}}) to an object defined through [[Material definition token]]s and registered through the ``raws.register_inorganics()`` function. It also prints itself to the lualog for debugging purposes.

{{Scriptdata
|title=Single material
|script=do_once.cobalt = function()
local lines = {}

-- basic inorganic definition
lines[#lines+1] = "[INORGANIC:COBALT]"
-- add [GENERATED] to save properly
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling cobalt]"
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:COBALT]"
lines[#lines+1] = "[SPECIAL]"

raws.register_inorganics(lines)

-- show in lualog
print_table(lines)
end
}}
 
You can register multiple objects at the same time. This script takes a table of color tokens, and makes a metal named after each of them, with a corresponding cheaty adventure reaction.

{{Scriptdata
|title=Chromatic metals
|script=do_once.chromatic_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- make a metal for each color token
for k,v in pairs(color_tokens) do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:CHROMATICMETAL"..v.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- look up the metal's color in the world table
-- using string.lower(v) would result in "moss_green"
local metalname = world.descriptor.color[v].name
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

-- appearance
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..v.."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:CHROMATICMETAL"..v.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:CHROMATICMETAL"..v.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===Random generation===

Here's an example of various DF-specific randomizers in use:
* ``trandom()`` is used to determine how many metals generate this way.
* ``utterance()`` generates utterances from the [[Kobold language]], e.g. "gorsnus", "stogodilmus", "gaylgis"
* ``pick_random_no_replace()`` determines the color from the table, but removes the rolled value so there's no repeats.

{{Scriptdata
|title=Kobold metals
|script=do_once.kobold_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- trandom() is expressed as (1dN)-1 because it uses C++ math that starts at 0
local max_loops = trandom(10)+1

-- create 1-10 metals
for i = 1,max_loops do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:KOBOLDMETAL"..i.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- this is the kobold name function
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"
-- no_replace removes the value from the table
-- we don't need a fallback because there's more values than metals
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random_no_replace(color_tokens).."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:KOBOLDMETAL"..i.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:KOBOLDMETAL"..i.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===New divine metals===

Many of the tables used by vanilla procedural objects are global, and thus can be added to or overwritten by mods. You can add new metal descriptions for divine metal pretty easily, for example:

{{Scriptdata
|title=Laughing metal
|script=
metal_by_sphere.CHILDREN={
name="laughing metal",
col="7:0:1",
color="WHITE"
}
}}
 
You can also add alternatives to the default divine metal function, such as one based on the aforementioned kobold metals.
Vanilla divine metal uses ``metal_by_sphere`` to determine its properties, and is thus valid only if the input sphere has an entry in that table.
Note that even if the weights are nominally the same; because it is valid for all input spheres, it will outnumber instances of the more limited vanilla material.

{{Scriptdata
|title=Divine kobold metal
|script=materials.divine.metal.kobold = function(sphere)
if not foo then
log(#metal_by_sphere)
log(#world.spheres)
foo = true
end
local lines = {}
--generation function handles ID, registration, generated info
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
--add_generated_info(lines)
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}
--allow for duplicate colors
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random(color_tokens).."]"

--add a block of tokens
lines=split_to_lines(lines,[[
[MATERIAL_VALUE:200]
[SPEC_HEAT:7500]
[MELTING_POINT:NONE]
[BOILING_POINT:NONE]
[ITEMS_WEAPON][ITEMS_WEAPON_RANGED][ITEMS_AMMO][ITEMS_DIGGER][ITEMS_ARMOR][ITEMS_ANVIL]
[ITEMS_HARD]
[ITEMS_METAL]
[ITEMS_BARRED]
[ITEMS_SCALED]
[SOLID_DENSITY:1000]
[LIQUID_DENSITY:1000]
[MOLAR_MASS:20000]
[IMPACT_YIELD:1000000]
[IMPACT_FRACTURE:2000000]
[IMPACT_STRAIN_AT_YIELD:0]
[COMPRESSIVE_YIELD:1000000]
[COMPRESSIVE_FRACTURE:2000000]
[COMPRESSIVE_STRAIN_AT_YIELD:0]
[TENSILE_YIELD:1000000]
[TENSILE_FRACTURE:2000000]
[TENSILE_STRAIN_AT_YIELD:0]
[TORSION_YIELD:1000000]
[TORSION_FRACTURE:2000000]
[TORSION_STRAIN_AT_YIELD:0]
[SHEAR_YIELD:1000000]
[SHEAR_FRACTURE:2000000]
[SHEAR_STRAIN_AT_YIELD:0]
[BENDING_YIELD:1000000]
[BENDING_FRACTURE:2000000]
[BENDING_STRAIN_AT_YIELD:0]
[MAX_EDGE:12000]
]])
--sends this to get registered
return {raws=lines,weight=1}
end
}}

===Remove default functions===

Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.

See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.

<syntaxhighlight lang="lua" >
creatures.fb.default=nil
</syntaxhighlight>

===Basic generated creature===

This is essentially the simplest possible creature. It has no extraordinary options (beyond an [[Sphere|association]] with animals and creation), and each world generates one species from this function. It doesn't have any biome tokens or likewise, so it can only be spawned in the arena, but it is still functional.

A sample output would be "A quadruped composed of flame. It has two narrow tails and it has a regal bearing."

{{Scriptdata
|title=do_once.basic_creature
|script=do_once.basic_creature = function()
local lines = {}
local tok="BASIC_PROCEDURAL_CREATURE"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
CREATION=true
}
}
lines=split_to_lines(lines,[[
[NAME:procedural creature:procedural creatures:procedural]
[CASTE_NAME:procedural creature:procedural creatures:procedural]
]])
--adds some common tokens depending on the options
add_regular_tokens(lines,options)

--handles sphere options: fills out [SPHERE] tokens from options.spheres, and so on
populate_sphere_info(lines,options)

--choose a creature profile to base on
local rcp=get_random_creature_profile(options)
--set [BODY_SIZE] and some relevant tokens
add_body_size(lines,rcp.min_size,options)
--add the tile from the creature profile
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"

--the Big Function determining tweaks, body, appearance, description...
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}

===Making your own rcp===

You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.

This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique rcp, set in the function itself.

{{Scriptdata
|title=do_once.local_rcp
|script=do_once.local_rcp = function()
local lines = {}
local tok="LOCAL_RCP"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
WATER=true
}
}
add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
--habitat
lines[#lines+1]="[BIOME:ANY_OCEAN]"
lines[#lines+1]="[LARGE_ROAMING]"
lines[#lines+1]="[AQUATIC][UNDERSWIM]"

--define a local creature profile
local rcp={
name_string="eurypterid",
tile='E',
body_base="SCORPION",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}
local name_str = rcp.name_string..":"..rcp.name_string.."s:"..rcp.name_string.."]"
lines[#lines+1] = "[NAME:"..name_str
lines[#lines+1] = "[CASTE_NAME:"..name_str

add_body_size(lines,rcp.min_size,options)
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}
 
Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.

This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

Other feature variants stored in tables, like materials, attacks, or descriptions, can be added in this way.

{{Scriptdata
|title=Global rcp
|script=
random_creature_types.EURYPTERID={
name_string="eurypterid",
tile='E',
body_base="SCORPION_FLIPPERS",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}

body_base_fun.SCORPION_FLIPPERS=function(rcp,options)
options.pcg_layering_base="BEAST_SCORPION"
options.walk_var="STANDARD_WALKING_GAITS"
options.walk_speed=900
return {"RCP_CEPHALOTHORAX","RCP_ABDOMEN","RCP_FIRST_SIMPLE_LEGS","RCP_SECOND_SIMPLE_LEGS","RCP_THIRD_SIMPLE_LEGS","RCP_PINCERS","RCP_FRONT_FLIPPER"}
end

water_based_random_creature.EURYPTERID=true
}}

===Werebugs===

You can make a custom function to determine what rcps are available to a given creature.

These scripts are for an arthropoid version of a [[werebeast]].
* ``arthropod_rcp`` is a list of rcp keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
* ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].

Otherwise, the function should work the same as vanilla werebeasts, generating an associated [[Interaction token|major curse]] in the same way and becoming "twisted into humanoid form" (at the expense of their additional limbs).

{{Scriptdata
|title=arthropod_rcp
|script=local arthropod_rcp = {
"ARACHNID_MITE",
"ARACHNID_SCORPION",
"ARACHNID_SPIDER",
"ARACHNID_TARANTULA",
"ARACHNID_TICK",
"CRUSTACEAN_CRAB",
"CRUSTACEAN_LOBSTER",
"CRUSTACEAN_SHRIMP",
"INSECT_ANT",
"INSECT_ANTLION",
"INSECT_APHID",
"INSECT_BEE",
"INSECT_BUTTERFLY",
"INSECT_CADDISFLY",
"INSECT_CATERPILLAR",
"INSECT_CICADA",
"INSECT_COCKROACH",
"INSECT_CRICKET",
"INSECT_DAMSELFLY",
"INSECT_DARKLING_BEETLE",
"INSECT_DRAGONFLY",
"INSECT_EARWIG",
"INSECT_FIREFLY",
"INSECT_FLEA",
"INSECT_FLY",
"INSECT_GRASSHOPPER",
"INSECT_HORNET",
"INSECT_LACEWING",
"INSECT_LADYBUG",
"INSECT_LOUSE",
"INSECT_MAGGOT",
"INSECT_MANTIS",
"INSECT_MAYFLY",
"INSECT_MOSQUITO",
"INSECT_MOTH",
"INSECT_SILVERFISH",
"INSECT_SCARAB_BEETLE",
"INSECT_SCORPIONFLY",
"INSECT_SNAKEFLY",
"INSECT_STONEFLY",
"INSECT_TERMITE",
"INSECT_THRIPS",
"INSECT_WASP",
"INSECT_WEEVIL",
"NEMATODE",
"LEECH",
}
}}
{{Scriptdata
|title=is_bloodsucking_by_key
|script=local is_bloodsucking_by_key = {
ARACHNID_MITE=true,
ARACHNID_TICK=true,
INSECT_EARWIG=true,--some are parasitic
INSECT_FLEA=true,
INSECT_LOUSE=true,
INSECT_MAGGOT=true,
INSECT_THRIPS=true,--no bloodsucking reported, but does bite humans
NEMATODE=true,
}
}}
{{Scriptdata
|title=creatures.night_creature.werebeast.werebug
|script=creatures.night_creature.werebeast.werebug=function(tok)
local lines={}
local options={
spheres={
CHAOS=true,
ANIMALS=true,
NIGHT=true,
MOON=true
},
always_glowing_eyes=true,
use_werebeast_pcg=true, --use them if werebug sprites somehow exist
animal_coloring_allowed=true,
no_tweak=true,
material_weakness=true,
humanoidable_only=true,
prioritize_bite=true,
force_ichor=true,
token=tok
}
options.night_creature_agile_pref=true
night_creature_universals(lines,options)
lines[#lines+1]="[NIGHT_CREATURE_HUNTER]"
lines[#lines+1]="[CAN_LEARN]"
lines[#lines+1]="[CAN_SPEAK]"
lines[#lines+1]="[NO_GENDER]"
lines[#lines+1]="[BONECARN]"
lines[#lines+1]="[CRAZED]"
if options.night_creature_strength_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=1000
elseif options.night_creature_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=800;
elseif options.night_creature_strength_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=850;
end
lines[#lines+1]="[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[PERSONALITY:BASHFUL:0:0:0]"
lines[#lines+1]="[PERSONALITY:STRESS_VULNERABILITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:FRIENDLINESS:0:0:0]"
lines[#lines+1]="[PERSONALITY:DISDAIN_ADVICE:100:100:100]"
lines[#lines+1]="[PERSONALITY:CHEER_PROPENSITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:GRATITUDE:0:0:0]"
lines[#lines+1]="[PERSONALITY:TRUST:0:0:0]"
lines[#lines+1]="[PERSONALITY:ALTRUISM:0:0:0]"
lines[#lines+1]="[PERSONALITY:CRUELTY:100:100:100]"

add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
lines[#lines+1]="[NATURAL_SKILL:WRESTLING:6]"
lines[#lines+1]="[NATURAL_SKILL:BITE:6]"
lines[#lines+1]="[NATURAL_SKILL:GRASP_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:STANCE_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:MELEE_COMBAT:6]"
lines[#lines+1]="[NATURAL_SKILL:DODGING:6]"
lines[#lines+1]="[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]"
lines[#lines+1]="[NATURAL_SKILL:SNEAK:20]"

lines[#lines+1]="[DIFFICULTY:3]"
lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-- pick a random bug rcp, there's no overlap with the mammal/reptile standard werebeasts
finalize_random_creature_types() -- good practice to run before rolling on it
local rcp_key = pick_random_no_replace(arthropod_rcp) or "INSECT_MANTIS"
local rcp=random_creature_types[rcp_key]

local custom_desc_str = "it is crazed for blood and flesh"
-- make them also vampires if they suck blood
if rcp.must_suck_blood_through_proboscis or rcp.must_suck_blood_through_mouth or is_bloodsucking_by_key[rcp_key] then
lines[#lines+1]="[BLOODSUCKER]"
custom_desc_str = "it is crazed for warm blood"
end
-- This sort of process should be fully generalized
-- to all creatures you want to have bespoke associated interactions
-- for example, you can have a blessing that allows a sort of
-- uncrazed transformation into some sort of bespoke
-- generated thing--at least, hopefully it's robust enough for that
local choice=generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)
map_merge(options,choice.options)
local werebeast_choice_raws=choice.interaction or choice.raws
raws.register_interactions(werebeast_choice_raws)
add_body_size(lines,math.max(rcp.min_size,80000+trandom(11)*1000),options)
lines[#lines+1]="[CREATURE_TILE:165]" --Ñ
options.forced_color={
f=6,
b=0,
br=1
}
options.custom_desc_func=function(options)
return custom_desc_str
end
build_procgen_creature(rcp,lines,options)
lines[#lines+1]="[GO_TO_START]"
-- remove second words like " beetle", etc from the end
local short_name = rcp.name_string:gsub("%s(%w+)$","")
local name_str="were"..short_name..":were"..short_name.."s:were"..short_name.."]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str
return {raws=lines,weight=1}
end
}}

===New forgotten beasts===
You can add new types of forgotten beasts (or more appropriately, {{token|FEATURE_BEAST}}s). These generate as alternatives when populating the caverns with unique monsters. There are a number of options to interact with shared generation functions.

Unbidden spirits only appear in dry cave layers, and like "spirit" [[demon]]s, are malevolent floating beings made of gas or dust.

{{Scriptdata
|title=Unbidden spirit
|script=
creatures.fb.unbidden=function(layer_type,tok)
if layer_type==0 then return nil end -- land only
local tbl={}
local options={
strong_attack_tweak=true,
always_make_uniform=true,
always_insubstantial=true,
intangible_flier=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[CASTE_NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
-- Weight is a float; all vanilla objects have weight 1
return {creature=tbl,weight=0.5}
end
}}
 
[[Construct creature|Elementals]] are defined by the material they're made of, using a table of options to set the right properties. In a dry chasm layer, they'll roll on the ``fb_elements`` table, while in a water layer, they'll be a water elemental. Should they ever carry a [[syndrome]], they would inflict [[Wikipedia:Dyscrasia|dyskrasia]].

The most important feature is setting ``options.sphere_rcm`` to a key in ``random_creature_materials``, so fire elementals are made of "FLAME" and earth elementals are made of "ANY_MINERAL".

{{Scriptdata
|title=Elemental
|script=
fb_elements = {
{
name="fire",
rcm="FLAME",
spheres={ FIRE=true },
options={ fire_immune=true }
},
{
name="earth",
rcm="ANY_MINERAL",
rcp_options={ always_flightless=true },
spheres={
EARTH=true,
MINERALS=true
}
},
{
name="air",
rcm="STEAM",
spheres={
WIND=true,
SKY=true
},
options={
always_insubstantial=true,
intangible_flier=true
}
}
}

creatures.fb.elemental=function(layer_type,tok)
local lines={}
local options={
strong_attack_tweak=true,
always_make_uniform=true, --irrelevant due to sphere_rcm
spheres={},
sickness_name="dyskrasia",
token=tok
}
lines=split_to_lines(lines,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NO_GENDER]
[NO_EAT][NO_DRINK]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])

-- Create a water elemental in water layers, otherwise use another type
local water_elemental = {
name="water",
rcm="WATER",
spheres={WATER=true},
options={do_water=true}
}
local my_element = layer_type==1 and pick_random(fb_elements) or water_elemental

-- Assign propertes from chosen element
map_merge(options.spheres,my_element.spheres)
if my_element.options then map_merge(options,my_element.options) end

add_regular_tokens(lines,options)
lines[#lines+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
populate_sphere_info(lines,options)

-- Set custom material
options.sphere_rcm=my_element.rcm
-- Build body
local rcp=get_random_creature_profile(options)
-- Set more options on the RCP
if my_element.rcp_options then map_merge(rcp.options,my_element.rcp_options) end
add_body_size(lines,math.max(10000000,rcp.min_size),options)
lines[#lines+1]="[CREATURE_TILE:'E']"
build_procgen_creature(rcp,lines,options)

-- Generate name
local element_name = my_element.name or "glitchstuff"
local name_str = element_name.." elemental:"..element_name.." elemental:"..element_name.."-elemental]"
lines[#lines+1]="[GO_TO_START]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str

return {raws=lines,weight=1.5}
end
}}

===Tweaking creatures===
Common Lua features allow you to extend functions by mirroring the original function and then overwriting it, akin to the ``SELECT`` tags. This function extends ``add_regular_tokens()`` to add {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER}} to all generated creatures.
{{Scriptdata
|title=add_regular_tokens (extension)
|script=
old_add_regular_tokens=add_regular_tokens
function add_regular_tokens(lines,options)
old_add_regular_tokens(lines,options)
lines[#lines+1]="[GENERAL_MATERIAL_FORCE_MULTIPLIER:1:2]"
end
}}
 

This function is run in ``build_body_from_rcp()`` right before tweaks are determined (See [[Lua functions#Creature patching]]). If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.

{{Scriptdata
|title=btc1_tweaks.titan_worship
|script=
-- make all large creatures into powers
btc1_tweaks.titan_worship=function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
if options.body_size>=500000 then -- described as "very large", graphics size cutoff
options.can_learn=true -- for flavor text
lines[#lines+1]="[INTELLIGENT]"
lines[#lines+1]="[SUPERNATURAL]" -- knows secrets according to their spheres
lines[#lines+1]="[POWER]" -- impersonates deities
lines[#lines+1]="[SPREAD_EVIL_SPHERES_IF_RULER]"
end
end
}}

===Adamantine alloys===

You can add your own arbitrary generated objects, though as of right now there's no way to make settings for them. This allows for some ''truly'' wild stuff; here's a fun example: adamantine-metal alloys for every single non-special metal, giving you an average of the properties of them.

{{Scriptdata
|title=Adamantine alloys
|script=
preprocess.adamantine_alloys=function()
if not random_object_parameters.main_world_randoms then return end
local l=get_debug_logger(2)
local lines={}
local reaction_lines={}
local reaction_names={}
local adamantine=world.inorganic.inorganic.ADAMANTINE
if not adamantine then return end
local adamantine_color=world.descriptor.color[world.descriptor.color_pattern[adamantine.material.color_pattern.SOLID].color[1]]
local adamantine_modulus = 2500000 --mildly arbitrary, just below the theoretical limit
l("Starting")
local done_category=false
for k,v in ipairs(world.inorganic.inorganic) do
if not v.flags.SPECIAL and v.material.flags.IS_METAL then
l(v.token)
local token="GEN_ADAMANTINE_"..v.token
lines[#lines+1]="[INORGANIC:"..token.."]"
add_generated_info(lines)
lines[#lines+1]="[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
for kk,vv in pairs(v.material.adj) do
lines[#lines+1]="[STATE_ADJ:"..kk..":adamantine "..vv.."]" --"adamantine molten steel"? it's fine
end
for kk,vv in pairs(v.material.name) do
lines[#lines+1]="[STATE_NAME:"..kk..":adamantine "..vv.."]"
end
l(2)
local mat_values={}
-- Find the ratio for which you get closest to (but not below) 2000000 in the material's worst property
local worst=math.min(v.material.yield.IMPACT,v.material.fracture.SHEAR)
local wafers=1
local bars=1
if worst < 2000000 then
local ratio = (2000000-3*worst)/1000000
local best_diff=1
for i=1,10 do
local wafer_amt=i*ratio
if wafer_amt>1 and wafer_amt<20 and math.ceil(wafer_amt)-wafer_amt<best_diff then
best_diff=math.ceil(wafer_amt)-wafer_amt
wafers=math.ceil(wafer_amt)
bars=i
end
end
end
local avg_denom=1/(bars*3+wafers) -- Multiplication just a bit faster than division, we're rounding at the end anyway
local solid_cl=nil
for kk,vv in pairs(v.material.color_pattern) do
-- time to get silly
local this_color=world.descriptor.color[world.descriptor.color_pattern[vv].color[1]]
local wanted_color={
r=(this_color.r*bars*3+adamantine_color.r*wafers)*avg_denom,
g=(this_color.g*bars*3+adamantine_color.g*wafers)*avg_denom,
b=(this_color.b*bars*3+adamantine_color.b*wafers)*avg_denom,
}
local best_total_diff=1000000000
local best_clp=nil
for _,clp in ipairs(world.descriptor.color_pattern) do
if clp.pattern=="MONOTONE" then
local cl=world.descriptor.color[clp.color[1]]
local diff=math.abs(wanted_color.r-cl.r)+math.abs(wanted_color.b-cl.b)+math.abs(wanted_color.g-cl.g)
if diff<best_total_diff then
best_clp=clp
best_total_diff=diff
end
end
end
lines[#lines+1]="[STATE_COLOR:"..kk..":"..best_clp.token.."]"
if kk=="SOLID" then solid_cl=world.descriptor.color[best_clp.color[1]] end
end
local color_str=solid_cl.col_f..":0:"..solid_cl.col_br
l(color_str)
lines[#lines+1]="[DISPLAY_COLOR:"..color_str.."]"
lines[#lines+1]="[BUILD_COLOR:"..color_str.."]"
lines[#lines+1]="[ITEMS_METAL][ITEMS_HARD][ITEMS_SCALED][ITEMS_BARRED]"
lines[#lines+1]="[SPECIAL]"
if v.material.flags.ITEMS_DIGGER then
lines[#lines+1]="[ITEMS_DIGGER]"
end
local function new_value(str)
mat_values[str]=mat_values[str] or math.floor((adamantine.material[str]*wafers+v.material[str]*bars*3)*avg_denom+0.5)
l(str,mat_values[str])
return mat_values[str]
end
local function new_value_nested(str1,str2)
mat_values[str1..str2]=mat_values[str1..str2] or math.floor((adamantine.material[str1][str2]*wafers+v.material[str1][str2]*bars*3)/(bars*3+wafers)+0.5)
l(str1..str2,mat_values[str1..str2])
return mat_values[str1..str2]
end
if new_value_nested("fracture","SHEAR")>170000 or new_value_nested("yield","IMPACT")>245000 then
lines[#lines+1]="[ITEMS_WEAPON][ITEMS_AMMO]"
if new_value("solid_density")<10000 then
lines[#lines+1]="[ITEMS_WEAPON_RANGED][ITEMS_ARMOR]"
end
end
lines[#lines+1]="[MATERIAL_VALUE:"..new_value("base_value").."]"
lines[#lines+1]="[SPEC_HEAT:"..new_value("temp_spec_heat").."]"
lines[#lines+1]="[MELTING_POINT:"..new_value("temp_melting_point").."]"
lines[#lines+1]="[BOILING_POINT:"..new_value("temp_boiling_point").."]"
lines[#lines+1]="[SOLID_DENSITY:"..new_value("solid_density").."]"
lines[#lines+1]="[LIQUID_DENSITY:"..new_value("liquid_density").."]"
lines[#lines+1]="[MOLAR_MASS:"..new_value("molar_mass").."]" -- i don't think this is actually correct
for _,thing in ipairs({"yield","fracture"}) do
for force,_ in pairs(v.material[thing]) do
lines[#lines+1]="["..string.upper(force).."_"..string.upper(thing)..":"..new_value_nested(thing,force).."]"
end
end
for _,force in ipairs("IMPACT","COMPRESSIVE","TENSILE","TORSION","SHEAR","BENDING") do
local modulus = v.yield[force] / v.elasticity[force]
local average_modulus = (adamantine_modulus*wafers + modulus*bars*3)*avg_denom
local strain_at_yield = math.floor(new_value_nested("yield",force) / average_modulus + 0.5) -- usually zero, but can be 1 or 2 sometimes
lines[#lines+1]="["..string.upper(force).."_YIELD:"..new_value_nested("yield",force).."]"
lines[#lines+1]="["..string.upper(force).."_FRACTURE:"..new_value_nested("fracture",force).."]"
lines[#lines+1]="["..string.upper(force).."_STRAIN_AT_YIELD:"..strain_at_yield.."]"
end
lines[#lines+1]="[MAX_EDGE:"..new_value("max_edge").."]"
local reaction_token=token.."_MAKING"
reaction_lines[#reaction_lines+1]="[REACTION:"..reaction_token.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1]="[NAME:make adamantine "..v.material.name.SOLID.." (use bars)]"
reaction_lines[#reaction_lines+1]="[BUILDING:SMELTER:NONE]"
reaction_lines[#reaction_lines+1]="[REAGENT:A:"..tostring(150*wafers)..":BAR:NO_SUBTYPE:METAL:ADAMANTINE]"
reaction_lines[#reaction_lines+1]="[REAGENT:B:"..tostring(150*bars)..":BAR:NO_SUBTYPE:METAL:"..v.token.."]"
reaction_lines[#reaction_lines+1]="[PRODUCT:100:"..tostring(bars+wafers)..":BAR:NO_SUBTYPE:METAL:"..token.."][PRODUCT_DIMENSION:150]"
reaction_lines[#reaction_lines+1]="[FORTRESS_MODE_ENABLED]"
reaction_lines[#reaction_lines+1]="[CATEGORY:ADAMANTINE_ALLOYS]"
if not done_category then
done_category=true
reaction_lines[#reaction_lines+1]="[CATEGORY_NAME:Adamantine alloys]"
reaction_lines[#reaction_lines+1]="[CATEGORY_DESCRIPTION:Debase adamantine with other metals to get extremely strong alloys.]"
reaction_lines[#reaction_lines+1]="[CATEGORY_KEY:CUSTOM_SHIFT_A]"
end
reaction_lines[#reaction_lines+1]="[FUEL]"
reaction_lines[#reaction_lines+1]="[SKILL:SMELT]"
end
end
local entity_lines={}
raws.register_inorganics(lines)
-- not used in vanilla right now, due to lack of instruments, but you CAN do this
raws.register_reactions(reaction_lines)
end}}

[[Category:Modding]]
[[Category:Modding Examples]]
[[Category:Lua|S]]

Storage

2026-01-13T06:09:34Z

DPhKraken: Timelessness, container is not used to mean "box" in any of the supported versions

{{av}} {{buggy}}
{{Quality|Exceptional}}

[[File:storage_sprites_preview.png|right]]Types of items used for '''storage''' include [[Box|chests]], [[cabinet]]s, [[barrel]]s, [[large pot]]s, [[bag]]s, [[bin]]s, and [[bookcase]]s. All storage objects are used to hold items, from personal possessions to [[gem]]s, [[alcohol]], [[seed]]s, [[quarry bush]] leaves, and even living [[creature]]s. In [[Fortress mode]], each object has a specific use, so you cannot, for example, use your barrels for storing [[coin]]s. In [[Adventure mode]], any item can be stored with the {{Adv menu icon|p}} command if there's enough capacity for its [[size]].

To examine a storage object's contents, select the object location with the mouse. If the storage object isn't selected (say, if there are multiple items or units on the same tile) it should be selectable as a tab on the upper right of the window.

== Barrels, bins, bags, pots ==
[[Barrel]]s are [[wood]]en or [[metal]] containers that are useful for storing items in a [[Stockpile#food|food stockpile]] and are used to store [[alcohol]], [[plant]]s, [[seed]] bags, [[meat]], [[Creature#Aquatic|fish]], [[dwarven syrup]], [[quarry bush]] leaf bags, [[flour]] bags and [[dye]] bags, cooked food, [[fat]] and [[tallow]], and all [[prepared organs]]. They are made at a [[Carpenter's workshop]] with 1 log or at a [[Forge]] with 3 bars of metal. Barrels can be disabled in a stockpile to prevent haulers from running off with everything else inside to pick up a stray seed.

[[Pot]]s, an alternative for barrels, can be made of wood, stone, clay, glass, or metal. Pots can also be used to store alcohol and other related liquids, though clay pots (earthenware) must be [[glaze]]d to hold liquids. Pots hold the same amount as barrels (60 total units of food, or 30 units of alcohol) and weigh 1/4th as much as a barrel of equivalent material. Except for a few barrel-specific requirements, pots are generally a superior replacement.

[[Bin]]s are containers, again made from wood or metal, used for most non-food items. They are sent to all the other stockpiles (with the exclusion of the [[refuse]], [[stone]] and [[graveyard]] piles) and will hold much larger stacks of items, making organizing those endless piles of +giant cave spider silk socks+ and trade goods much easier to manage. They are made at a [[Carpenter's workshop]] with 1 log or at a [[Forge]] with 3 bars of metal. Bars and blocks will stack into a bin, but not into any other container, so a stockpile with bar/block enabled will default to requesting bins.

[[Bag]]s are used to store [[seed]]s, [[quarry bush]] leaves, [[mill]] products ([[flour]], [[sugar]], [[dye]]), [[gypsum plaster]], [[quicklime]] and [[sand]] ([[powder]]s). They are made from [[plant fiber]] (or [[silk]]) [[cloth]], [[leather]], or [[adamantine]]. Bags are used to gather and transport powder the same way [[bucket]]s are used to carry [[water]]. Bags can be placed inside some other storage-items, such as barrels. They are made at a [[Clothier's shop]] with 1 cloth or at a [[Leather works]] with 1 leather.

Empty barrels, pots, bins and bags can all be stored in a [[furniture]] [[stockpile]].

== [[Chest]]s and [[cabinet]]s ==
Except in their specific workshop order menu, any in-game reference to a "box" or "chest" refers to ''any'' of a wood or metal chest, stone coffer or glass box, three different names for storage-items that are interchangeable for in-game purposes. Chests, coffers and boxes are listed under ''boxes'' in the [[stocks]] screen, and these can be built as "chests" from the {{key|b}}uilding menu, {{key|f}}urniture submenu to satisfy the "Needs: X Chests" requirement for [[noble]]s. Each other storage-item type has its own entry.

Both cabinets and chest only work when placed as furniture. They must be built in bedrooms assigned to dwarves in order to fulfill the dwarves' room requirements. Cabinets are used to store clothing, and chests in bedrooms are used to store everything else.

Locations like [[tavern]]s, [[temple]]s, [[library|libraries]], and [[hospital]]s also need chests for their specific supply storage needs.

Once built as furniture, their contents can be viewed by clicking on them with the mouse.

== Quick reference ==
{{storage table head}}
{{storage table row|container=[[Animal trap]]|stockpile=Animals|furniture=y|solidcap=30000|liquidcap=|stores=Vermin, Bait|graphic=[[File:animal_trap_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Armor stand]]|stockpile=Furniture > Type > Armor Stands|furniture=y|solidcap=60000|liquidcap=|stores=Armor|graphic=[[File:armor_stand_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Equipment#Backpacks|Backpack]]|stockpile=Finished Goods > Type > Backpacks|furniture=n|solidcap=30000|liquidcap=|stores=Food|graphic=[[File:backpack_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n|sup_cloth=3
}}
{{storage table row|container=[[Bag]]|stockpile=Furniture > Type > Bag|furniture=n|solidcap=60000|liquidcap=|stores=Seeds, Leaves, Powders|graphic=[[File:bag_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n
}}
{{storage table row|container=[[Box]] Chest Coffer|stockpile=Furniture > Type > Boxes|furniture=y|solidcap=60000|liquidcap=|stores=Bags: Seeds, Leaves, Powders Others: Owned items|graphic=[[File:chest_sprite.png]]|stone=Coffer|wood=Chest|glass=Box|metal=Chest|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Barrel]]|stockpile=Furniture > Type > Barrels|furniture=n|solidcap=60000|liquidcap=60000|stores=Food, Alcohol, Extracts, Milk, Lye, Bags|graphic=[[File:barrel_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Bin]]|stockpile=Furniture > Type > Bins|furniture=n|solidcap=60000|liquidcap=|stores=Items, Jugs, Flasks|graphic=[[File:bin_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Bucket]]|stockpile=Furniture > Type > Buckets|furniture=n|solidcap=|liquidcap=6000|stores=Milk, Lye, Water2|graphic=[[File:bucket_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Cabinet]]|stockpile=Furniture > Type > Cabinets|furniture=y|solidcap=60000|liquidcap=|stores=Owned clothing|graphic=[[File:cabinet_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Cage]] Aquarium Terrarium|stockpile=Animals|furniture=y|solidcap=60000|liquidcap=60000|stores=Creatures, Vermin Aquarium: Water|graphic=[[File:cage_sprite.png]]|stone=n|wood=Cage|glass=Terrarium Aquarium|metal=Cage|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Coffin]] Casket Sarcophagus|stockpile=Furniture > Type > Coffins|furniture=y|solidcap=60000|liquidcap=|stores=Creature/Vermin Corpses/Remains|graphic=[[File:coffin_sprite.png]]|stone=Coffin|wood=Casket|glass=Coffin|metal=Sarcophagus|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Flask]] Vial Waterskin|stockpile=Finished Goods > Type > Flasks|furniture=n|solidcap=|liquidcap=1800|stores=Alcohol, Water Vials: Extracts|graphic=[[File:flask_collection_sprite.png]]|stone=n|wood=n|glass=Vial|metal=Flask|cloth=n|leather=Waterskin|ceramic=n
}}
{{storage table row|container=[[Hive]]|stockpile=Finished Goods > Type > Tools|furniture=y|solidcap=5000|liquidcap=5000|stores=Honey Bees, Royal Jelly, Honeycomb|graphic=[[File:hive.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Jug]]|stockpile=Finished Goods > Type > Tools|furniture=n|solidcap=|liquidcap=10000|stores=Royal Jelly, Honey, Rock Nut Oil|graphic=[[File:jug_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Large pot]]|stockpile=Finished Goods > Type > Large pots/food storage|furniture=n|solidcap=60000|liquidcap=60000|stores=Food, Alcohol, Bags|graphic=[[File:large_pot_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Minecart]]|stockpile=Furniture > Type > Minecarts|furniture=n|sup_furn=5|solidcap=500000|liquidcap=500000|stores=Hauled items; [[Minecart#Loading_liquids|scooped]], but not loaded: Water, Magma|graphic=[[File:minecart_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Nest box]]|stockpile=Finished Goods > Type > Tools|furniture=y|solidcap=2000|liquidcap=|stores=Eggs|graphic=[[File:nest_box_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n|sup_stonewood=4
}}
{{storage table row|container=Pouch|stockpile=Finished Goods > Type > Tools{{verify}}|furniture=n|solidcap=1000|liquidcap=|stores=Coins (in [[adventurer mode]])|graphic=[[File:pouch_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n
}}
{{storage table row|container=[[Equipment#Quiver|Quiver]]|stockpile=Finished Goods > Type > Quivers|furniture=n|solidcap=12000|liquidcap=|stores=Ammunition|graphic=[[File:quiver_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n|sup_cloth=3
}}
{{storage table row|container=[[Weapon rack]]|stockpile=Furniture > Type > Weapon Racks|furniture=y|solidcap=60000|liquidcap=|stores=Weapons|graphic=[[File:weapon_rack_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Wheelbarrow]]|stockpile=Furniture > Type > Wheelbarrows|furniture=n|solidcap=100000|liquidcap=|stores=Hauled items|graphic=[[File:wheelbarrow_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
|}
:1 - Large Pots can be made from any hard material, including wood and metal
:2 - Used to carry water, can store Milk and Lye but will be emptied into Barrels
:3 - Backpacks and quivers can only be made from Adamantine cloth, though ones made from other cloth can be purchased from caravans
:4 - Rock and Wood versions of these items are made in [[Craftsdwarf's workshop]] rather than [[Carpenter's workshop]] or [[Mason's workshop]] as usual.
:5 - A [[minecart]] can be placed where you need it and used for storage, but technically it's not built furniture

*[[Tools]] have capacity set in units 10 times smaller; liquids have a capacity 60 per 1 unit, i.e. capacity 180 = 3 units of water, 50000 = 833 units, etc.
*Large Pots are equivalent to Barrels, except for a few specific uses (e.g. [[Farmer's workshop#Menu|process plant to barrel]]).
*Bins are requested by stockpiles like Barrels, but store different items.
*Buckets are used for temporary storage of Milk, Lye, and Water.
*Bags are used to stockpile powders, seeds, leaves, and other items. They can be stored inside Barrels and Large Pots if holding food items.
*Jugs are liquid storage specifically for [[beekeeping]] and [[pressing]], and can be stored inside Bins.
*[[Flask]]s (metal), waterskins (leather) and vials (glass) are different names for the same item, depending on the material.
*Chests (wood or metal), coffers (stone) and boxes (glass) are different names for the same piece of furniture, depending on the material.
*A terrarium can be designated as an Aquarium. A dwarf will use a bucket to fill it with water. If deconstructed it'll stay filled with Water[10] and can even be sold with the water inside. The water costs 1☼ each, so you get 10☼ for the water.
*A [[hive]] won't be destroyed if you don't have a stockpile for its products. You could use {{key|t}} on the hive and dump the item to use it.

== Spilling ==
When a container is launched and collides with an obstacle, it spills its contents. If the obstacle permits (i.e. [[fortification]]), these continue to move in the same direction with some scattering, otherwise displaced 1 tile above and retain velocity. This was introduced for [[minecart]]s, but applies at least to [http://www.bay12forums.com/smf/index.php?topic=109460.msg3315406#msg3315406 other tools] and [http://www.bay12forums.com/smf/index.php?topic=109460.msg3340230#msg3340230 cages]. If the tile above also contains an obstacle and the spilled item is a storage-item, the process repeats on the next tick, until it runs out of either nested storage-items or wall height (see the first link above).

[[Throwing]] a container does not cause it to collide and spill its contents.

== Bugs ==
* Hauling jobs can block access to all the items in the destination container until the hauling is complete. This often results in cancellation spam and work delays.{{bug|9004}} One workaround is creating a "feeder stockpile" with barrels and bins disabled.
* Storage capacity is one-dimensional, resulting in unusually. Items only have "SIZE" determining the volume of their material and thus [[weight]], but ''no separate external volume''. For storage-items, CAPACITY is ''not'' added to it, i.e. they all are treated like soft bags: you can put 30 other bags inside a bag, and you can load a minecart with minecarts. At the same time, storage-items are assumed to ''not'' be soft bags - while weight of contents adds to the storage-item's weight, the ambiguous SIZE is constant. Together, these facts make storage-items nest-able ''indefinitely'', as long as CAPACITY>SIZE (which normally is the case) and potentially act like bags of holding - have the same stated volume whether empty or holding an arbitrary total amount of items via nested storage-items. The only nesting that normally happens in Fortress mode is minecart > barrel > bag, but this still makes a minor [[exploit]].
* Stacks made by a single job tend to ignore capacity. For one, haulers picking up items may stuff a [[Exploit#Quantum_stockpiles|quantum stockpile]] worth of items into one bin.{{bug|6063}} The same applies to brewing and extracting.
* Conversely, a freshly produced stack, no matter how small, will be put into a new container and not added into the old ones. This may be justified with ''brewing'', but also happens to production of many other items/substances without quality modifiers.

{{Buildings}}
{{Category|Items}}

Storage

2026-01-13T05:51:54Z

DPhKraken: Containers in different game modes

{{av}} {{buggy}}
{{Quality|Exceptional}}

[[File:storage_sprites_preview.png|right]]Types of items used for '''storage''' include [[Box|boxes]]*, [[cabinet]]s, [[barrel]]s, [[large pot]]s, [[bag]]s, [[bin]]s, and [[bookcase]]s. All storage objects are used to hold items, from personal possessions to [[gem]]s, [[alcohol]], [[seed]]s, [[quarry bush]] leaves, and even living [[creature]]s. In [[Fortress mode]], each object has a specific use, so you cannot, for example, use your barrels for storing [[coin]]s. In [[Adventure mode]], any item can be stored with the {{Adv menu icon|p}} command if there's enough capacity for its [[size]].

To examine a storage object's contents, select the object location with the mouse. If the storage object isn't selected (say, if there are multiple items or units on the same tile) it should be selectable as a tab on the upper right of the window.

: (* ''In game'', a "[[box]]" refers to any wooden or metal chest, stone coffer or glass box, three in-game names for the same storage-item serving the identical in-game function. In previous versions, they were known collectively as "[[container]]s", with [[bag]]s also included under this label. This article will preferentially use "storage-item" to avoid confusion, however nothing is perfect and a Wiki is a collective effort, so take any casual (mis-)use of the term "container" in context, especially in other articles.)

== Barrels, bins, bags, pots ==
[[Barrel]]s are [[wood]]en or [[metal]] storage-items that are useful for storing items in a [[Stockpile#food|food stockpile]] and are used to store [[alcohol]], [[plant]]s, [[seed]] bags, [[meat]], [[Creature#Aquatic|fish]], [[dwarven syrup]], [[quarry bush]] leaf bags, [[flour]] bags and [[dye]] bags, cooked food, [[fat]] and [[tallow]], and all [[prepared organs]]. They are made at a [[Carpenter's workshop]] with 1 log or at a [[Forge]] with 3 bars of metal. Barrels can be disabled in a stockpile to prevent haulers from running off with everything else inside to pick up a stray seed.

[[Pot]]s, an alternative for barrels, can be made of wood, stone, clay, glass, or metal. Pots can also be used to store alcohol and other related liquids, though clay pots (earthenware) must be [[glaze]]d to hold liquids. Pots hold the same amount as barrels (60 total units of food, or 30 units of alcohol) and weigh 1/4th as much as a barrel of equivalent material. Except for a few barrel-specific requirements, pots are generally a superior replacement.

[[Bin]]s are storage-items, again made from wood or metal, used for most non-food items. They are sent to all the other stockpiles (with the exclusion of the [[refuse]], [[stone]] and [[graveyard]] piles) and will hold much larger stacks of items, making organizing those endless piles of +giant cave spider silk socks+ and trade goods much easier to manage. They are made at a [[Carpenter's workshop]] with 1 log or at a [[Forge]] with 3 bars of metal. Bars and blocks will stack into a bin, but not into any other storage-item, so a stockpile with bar/block enabled will default to requesting bins.

[[Bag]]s are used to store [[seed]]s, [[quarry bush]] leaves, [[mill]] products ([[flour]], [[sugar]], [[dye]]), [[gypsum plaster]], [[quicklime]] and [[sand]] ("[[powder]]s"). They are made from [[plant fiber]] (or [[silk]]) [[cloth]], [[leather]], or [[adamantine]]. Bags are used to gather and transport powders the same way [[bucket]]s are used to carry [[water]]. Bags can be placed inside some other storage-items, such as barrels. They are made at a [[Clothier's shop]] with 1 cloth or at a [[Leather works]] with 1 leather.

Empty barrels, pots, bins and bags can all be stored in a [[furniture]] [[stockpile]].

== [[Chest]]s and [[cabinet]]s ==
Except in their specific workshop order menu, any in-game reference to a "container" or "box" or "chest" refers to ''any'' of a wood or metal chest, stone coffer or glass box, three different names for storage-items that are interchangeable for in-game purposes. Chests, coffers and boxes are listed under ''boxes'' in the [[stocks]] screen, and these can be built as "chests" from the {{key|b}}uilding menu, {{key|f}}urniture submenu to satisfy the "Needs: X Chests" requirement for [[noble]]s. Each other storage-item type has its own entry.

Both cabinets and chest only work when placed as furniture. They must be built in bedrooms assigned to dwarves in order to fulfill the dwarves' room requirements. Cabinets are used to store clothing, and containers in bedrooms are used to store everything else.

Locations like [[tavern]]s, [[temple]]s, [[library|libraries]], and [[hospital]]s also need chests for their specific supply storage needs.

Once built as furniture, their contents can be viewed by clicking on them with the mouse.

== Quick reference ==
{{storage table head}}
{{storage table row|container=[[Animal trap]]|stockpile=Animals|furniture=y|solidcap=30000|liquidcap=|stores=Vermin, Bait|graphic=[[File:animal_trap_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Armor stand]]|stockpile=Furniture > Type > Armor Stands|furniture=y|solidcap=60000|liquidcap=|stores=Armor|graphic=[[File:armor_stand_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Equipment#Backpacks|Backpack]]|stockpile=Finished Goods > Type > Backpacks|furniture=n|solidcap=30000|liquidcap=|stores=Food|graphic=[[File:backpack_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n|sup_cloth=3
}}
{{storage table row|container=[[Bag]]|stockpile=Furniture > Type > Bag|furniture=n|solidcap=60000|liquidcap=|stores=Seeds, Leaves, Powders|graphic=[[File:bag_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n
}}
{{storage table row|container=[[Box]] Chest Coffer|stockpile=Furniture > Type > Boxes|furniture=y|solidcap=60000|liquidcap=|stores=Bags: Seeds, Leaves, Powders Others: Owned items|graphic=[[File:chest_sprite.png]]|stone=Coffer|wood=Chest|glass=Box|metal=Chest|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Barrel]]|stockpile=Furniture > Type > Barrels|furniture=n|solidcap=60000|liquidcap=60000|stores=Food, Alcohol, Extracts, Milk, Lye, Bags|graphic=[[File:barrel_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Bin]]|stockpile=Furniture > Type > Bins|furniture=n|solidcap=60000|liquidcap=|stores=Items, Jugs, Flasks|graphic=[[File:bin_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Bucket]]|stockpile=Furniture > Type > Buckets|furniture=n|solidcap=|liquidcap=6000|stores=Milk, Lye, Water2|graphic=[[File:bucket_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Cabinet]]|stockpile=Furniture > Type > Cabinets|furniture=y|solidcap=60000|liquidcap=|stores=Owned clothing|graphic=[[File:cabinet_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Cage]] Aquarium Terrarium|stockpile=Animals|furniture=y|solidcap=60000|liquidcap=60000|stores=Creatures, Vermin Aquarium: Water|graphic=[[File:cage_sprite.png]]|stone=n|wood=Cage|glass=Terrarium Aquarium|metal=Cage|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Coffin]] Casket Sarcophagus|stockpile=Furniture > Type > Coffins|furniture=y|solidcap=60000|liquidcap=|stores=Creature/Vermin Corpses/Remains|graphic=[[File:coffin_sprite.png]]|stone=Coffin|wood=Casket|glass=Coffin|metal=Sarcophagus|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Flask]] Vial Waterskin|stockpile=Finished Goods > Type > Flasks|furniture=n|solidcap=|liquidcap=1800|stores=Alcohol, Water Vials: Extracts|graphic=[[File:flask_collection_sprite.png]]|stone=n|wood=n|glass=Vial|metal=Flask|cloth=n|leather=Waterskin|ceramic=n
}}
{{storage table row|container=[[Hive]]|stockpile=Finished Goods > Type > Tools|furniture=y|solidcap=5000|liquidcap=5000|stores=Honey Bees, Royal Jelly, Honeycomb|graphic=[[File:hive.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Jug]]|stockpile=Finished Goods > Type > Tools|furniture=n|solidcap=|liquidcap=10000|stores=Royal Jelly, Honey, Rock Nut Oil|graphic=[[File:jug_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Large pot]]|stockpile=Finished Goods > Type > Large pots/food storage|furniture=n|solidcap=60000|liquidcap=60000|stores=Food, Alcohol, Bags|graphic=[[File:large_pot_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=y|sup_stonewood=4
}}
{{storage table row|container=[[Minecart]]|stockpile=Furniture > Type > Minecarts|furniture=n|sup_furn=5|solidcap=500000|liquidcap=500000|stores=Hauled items; [[Minecart#Loading_liquids|scooped]], but not loaded: Water, Magma|graphic=[[File:minecart_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Nest box]]|stockpile=Finished Goods > Type > Tools|furniture=y|solidcap=2000|liquidcap=|stores=Eggs|graphic=[[File:nest_box_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n|sup_stonewood=4
}}
{{storage table row|container=Pouch|stockpile=Finished Goods > Type > Tools{{verify}}|furniture=n|solidcap=1000|liquidcap=|stores=Coins (in [[adventurer mode]])|graphic=[[File:pouch_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n
}}
{{storage table row|container=[[Equipment#Quiver|Quiver]]|stockpile=Finished Goods > Type > Quivers|furniture=n|solidcap=12000|liquidcap=|stores=Ammunition|graphic=[[File:quiver_sprite.png]]|stone=n|wood=n|glass=n|metal=n|cloth=y|leather=y|ceramic=n|sup_cloth=3
}}
{{storage table row|container=[[Weapon rack]]|stockpile=Furniture > Type > Weapon Racks|furniture=y|solidcap=60000|liquidcap=|stores=Weapons|graphic=[[File:weapon_rack_sprite.png]]|stone=y|wood=y|glass=y|metal=y|cloth=n|leather=n|ceramic=n
}}
{{storage table row|container=[[Wheelbarrow]]|stockpile=Furniture > Type > Wheelbarrows|furniture=n|solidcap=100000|liquidcap=|stores=Hauled items|graphic=[[File:wheelbarrow_sprite.png]]|stone=n|wood=y|glass=n|metal=y|cloth=n|leather=n|ceramic=n
}}
|}
:1 - Large Pots can be made from any hard material, including wood and metal
:2 - Used to carry water, can store Milk and Lye but will be emptied into Barrels
:3 - Backpacks and quivers can only be made from Adamantine cloth, though ones made from other cloth can be purchased from caravans
:4 - Rock and Wood versions of these items are made in [[Craftsdwarf's workshop]] rather than [[Carpenter's workshop]] or [[Mason's workshop]] as usual.
:5 - A [[minecart]] can be placed where you need it and used for storage, but technically it's not built furniture

*[[Tools]] have capacity set in units 10 times smaller; liquids have a capacity 60 per 1 unit, i.e. capacity 180 = 3 units of water, 50000 = 833 units, etc.
*Large Pots are equivalent to Barrels except for a few specific uses (e.g. process plant to barrel).
*Bins are like Barrels but store different items.
*Buckets are used for temporary storage of Milk, Lye, and Water.
*Bags are mini storage-items for powders, seeds, leaves, and other items, and can be stored inside Barrels/Large Pots if holding food items.
*Jugs are mini storage-items specifically for honey and royal jelly, and can be stored inside Bins; in this sense they are like Bags.
*[[Flask]]s (metal), waterskins (leather) and vials (glass) are different names for the same storage-items depending on the material it's made from.
*Chests (wood or metal), coffers (stone) and boxes (glass) are different names for the same piece of furniture depending on the material it's made from.
*A terrarium can be designated as an Aquarium. A dwarf will use a bucket to fill it with water. If deconstructed it'll stay filled with Water[10] and can even be sold with the water inside. The water costs 1☼ each, so you get 10☼ for the water.
*A hive won't be destroyed if you don't have a stockpile for its products. You could use {{key|t}} on the hive and dump the item to use it.

== Spilling ==
A storage-item that moves fast and collides with an obstacle spills its contents. If the obstacle permits (i.e. [[fortification]]), these continue to move in the same direction with some scattering, otherwise displaced 1 tile above and retain velocity. This was introduced for [[minecart]]s, but applies at least to [http://www.bay12forums.com/smf/index.php?topic=109460.msg3315406#msg3315406 other tools] and [http://www.bay12forums.com/smf/index.php?topic=109460.msg3340230#msg3340230 cages]. If the tile above also contains an obstacle and the spilled item is a storage-item, the process repeats on the next tick, until it runs out of either nested storage-items or wall height (see the first link above).

== Bugs ==
* Hauling jobs can block access to all the items in the destination storage-item until the hauling is complete. This often results in cancellation spam and work delays.{{bug|9004}} One workaround is creating a "feeder stockpile" with barrels and bins disabled.
* Storage-item size works in mysterious ways. Items only have "SIZE" determining the volume of their material and thus [[weight]], but ''no separate external volume''. For storage-items, CAPACITY is ''not'' added to it, i.e. they all are treated like soft bags: you can put 30 other bags inside a bag, and you can load a minecart with minecarts. At the same time, storage-items are assumed to ''not'' be soft bags - while weight of contents adds to the storage-item's weight, the ambiguous SIZE is constant. Together, these facts make storage-items nest-able ''indefinitely'', as long as CAPACITY>SIZE (which normally is the case) and potentially act like bags of holding - have the same stated volume whether empty or holding an arbitrary total amount of items via nested storage-items. The only nesting that normally happens in Fortress mode is minecart > barrel > bag, but this still makes a minor [[exploit]].
* Stacks made by a single job tend to ignore capacity. For one, dwarves picking up items may stuff a [[Exploit#Quantum_stockpiles|quantum stockpile]] worth of items into one storage-item.{{bug|6063}} The same applies to brewing and extracting.
* Conversely, a freshly produced stack, no matter how small, will be put into a new storage-item and not added into the old ones. This may be justified with ''brewing'', but also happens to production of many other items/substances without quality modifiers.

{{Buildings}}
{{Category|Items}}

Stockpile

2026-01-13T05:39:46Z

DPhKraken: /* Notes */ Link to item types

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

{{For/see|exploits related to stockpiling|[[Quantum stockpile]]}}
[[File:v50_stockpile_gui_preview.png|right]]'''Stockpiles''' are where [[dwarf|dwarves]] store items of various types, usually in a safer, closer or more convenient place for the consumers. Dwarves with the corresponding "[[hauling]]" job will seek out items that are not already on a stockpile that accepts them and carry them to an appropriate stockpile, if available. It's important to place your stockpiles carefully to minimize the amount of time spent carrying items back-and-forth. Items in a stockpile may be stored in [[Storage|container]]s such as [[bag|bags]], [[barrel|barrels]] or [[bin|bins]] (see [[Using bins and barrels]]). Seed bags, flour bags, and dye bags can go inside barrels. Empty bags, however, cannot be stacked.

== Creating and Removing Stockpiles ==
To create a stockpile, click the {{Menu icon|p}}Stockpile button. At this point, you can click on any existing stockpile to inspect it, but to create a new one, you must click the button that appears immediately above the original stockpile button. When you click to create a new stockpile, you can draw a rectangle with the mouse. Clicking "Accept" in the top left pop-up finalizes the stockpile, or you can continue drawing rectangles to make the stockpile bigger. Non-contiguous regions are possible, but could be confusing to manage later for little benefit. If the chosen area has parts that cannot be made into a stockpile, like a [[wall]], a [[workshop]], or an already existing stockpile, a stockpile will be created but they will not be part of it. After clicking "accept", a new menu pane opens up with a list of pre-set stockpile rules, of which you must select one or else select "Custom" to define your own rules.

When creating a stockpile, any movable items (e.g. loose [[stone]], unbuilt [[furniture]], etc.) currently occupying the designated tiles will automatically be considered part of the stockpile, even if the stockpile settings disallow those particular items. These items also mark the tile as "full", so no new items will be stored in that tile until all the original items in the tile are moved. To handle unwanted items, you can specify that the stockpile "gives" to a workshop or stockpile that will accept those items, or use a [[dump]] command to have them carried off to a garbage [[zone]].

To edit a stockpile, click the "Stockpile" button in the main menu, then click on the stockpile. The suite of buttons (mouse over to see their tooltips to determine what each button does) can be used to edit the name, edit its boundaries, set which stockpiles or workshops give to or receive from this stockpile, delete the stockpile, or set the amount of wheelbarrows and containers that can be used.

When you click to repaint the stockpile, note that a secondary toolbar appears at the bottom of the screen, which you can use to switch to eraser mode.

== Using stockpiles ==
Once a stockpile has been allocated, by default dwarves will automatically move items to the stockpile when they are available, as long as the stockpile has available space. Note that the dwarves will place the item into the empty spot that is nearest to the item, ''not counting any obstructions''{{verify}}. Dwarves will stockpile the ''newest'' item first, which may not necessarily be the nearest item to the stockpile. Tiles within a stockpile which contain only forbidden items are considered available space, and can accumulate another item without exploiting [[Quantum_stockpile#Quantum_stockpiles|quantum stockpiling]].

One method to ensure a workshop has raw material on hand is to place a small stockpile of its input materials next to the workshop. This will speed up production as the crafter only has to take a few steps to obtain the material, preventing them from dragging material across the entire map. Whenever a crafter picks up material from the stockpile, your hauling dwarves will automatically fetch more material to refill the stockpile. This speeds up a queue of jobs, as other dwarves perform the time-consuming distant haul whilst the crafter concentrates on actually making items.

It's not necessary to place stockpiles for all types of objects. If no storage is available for a certain item type, dwarves will seek out items wherever they might lie as mentioned earlier. This can be advantageous—if you don't have a stockpile for [[gem]]s, your [[jeweler]] will go pick up fresh gems without waiting for them to be carried to a pile first. However, this also means your jeweler has to spend a lot of time fetching the gems. If you have enough haulers available, it's generally more advantageous to designate stockpiles than not. Also remember that your workshops will get [[clutter]]ed and suffer production slowdowns if you let ridiculous numbers of items pile up in them, so it's important to occasionally clear out workshops if they get cluttered. This can be done either by having a stockpile available so that haulers will remove the items, by [[DF2012:Exploit#Quantum_stockpiles|quantum stockpiling]] the accumulation, or by removing and rebuilding the workshop, which will empty its contents onto the ground.

== Give and/or take from a stockpile/workshop ==
Another feature of stockpiles allows you to tell dwarves to transfer items from or to one stockpile and/or workshop to another. The button that controls that feature is [[File:v50_stockpile_workshop_button.png|23px]], which is on by default once a stockpile is created. When this button is activated, the stockpile will take designated items from anywhere, but if disabled, it will only give and take items from specified workshops and stockpiles. Your chosen stockpile will now list the stockpile it will take from. This will cause items in the second stockpile to be hauled to the first stockpile. The button next to the previously mentioned one is [[File:v50_stockpile_shopadd_button.png|23px]], which allows the player to select where a stockpile's items will be given to or taken from, which are chosen with [[File:v50_stockpile_take_button.png|23px]] and [[File:v50_stockpile_give_button.png|23px]]

Each stockpile can take from any number of other stockpiles. You can't make two stockpiles feed into each other, although larger loops (e.g. three stockpiles that feed into each other in a circle) are allowed.

When having a stockpile take items from a workshop, any items produced inside the workshop become eligible to move to the stockpile. Be aware that any items produced in the workshop that ''aren't'' accepted by the linked stockpile will not be moved anywhere at all. They will sit inside the workshop until a linked stockpile accepts them.

Enough micromanagement will allow for effective and (relatively) streamlined supply chains. Here are some examples:

*Speeding up [[wood cutting|lumber harvesting]], [[carpentry]], ''and'' [[ash]] and [[charcoal]] production by putting several wood stockpiles near the various [[Chop_down_trees|tree-felling areas]], then one large "primary" stockpile near the [[carpenter's workshop]] that takes from those small ones, and then finally, a small stockpile near the [[wood furnace]] that takes from the primary one.
*A smallish [[plant]] stockpile near your farms, disallowing barrels, will allow harvesters to spend very little time stockpiling the crops they just picked. A larger stockpile near the [[still]] (this one possibly allowing barrels), taking from the smaller stockpile, lets your general-purpose haulers do most of the grunt work of getting plants in place for the brewer. The larger stockpile should be set to "take from links only", so the harvesters do not waste their time.
*A [[clothier's shop]] produces high-quality new [[clothing]]. There is currently no way to stockpile ''only'' new clothing, as opposed to [[wear|worn]] clothing, except for the fact that the new clothing is sitting in its workshop. A stockpile can be set to take from the clothier's shop (and to "take from links only"), so that it only gets new clothing produced in that workshop. If another stockpile with "take from anywhere" and no links is created, that one will accept all the worn clothing - it will never take from the linked clothier's shop. This worn-clothing stockpile may be placed near the [[trade depot]], if you plan to sell the used clothing, or near the [[magma|garbage disposal]], if you do not.

When giving to a stockpile, an equal and opposite "take from stockpile" is created in the other direction (and vice versa). Deleting one of these inter-stockpile links also deletes the other link.

Specifying that a workshop or furnace will only get its materials from a certain stockpile provides a way to make sure everything that the workshop produces is of a specific material. For example, setting a granite stockpile to give to a mason's workshop ensures that the workshop will only use granite as its material. This is also extremely important when the workshop's input materials are heavy (e.g. [[stone]]s); linking a nearby stone stockpile to the workshop prevents the mason from hauling an enormous rock from hundreds of tiles away.

This option is quite powerful, but should be used '''very''' carefully as the linked workshop will now ''only'' take from the stockpiles set to give to that workshop. Make sure that the workshop gets ''all'' of the materials needed for its jobs there if you use this feature. For example, if you link your ore stockpile to a non-magma [[smelter]], but don't also link a stockpile that includes a [[fuel]] source, then the dwarves will be unable to smelt ores at that smelter due to a lack of fuel. If you set a fuel stockpile to give that smelter, it will still be unable to [[melt]] down items marked for melting, because it only takes from the ore and fuel stockpiles. Another common mistake is setting a plant stockpile to give to a [[still]], but forgetting to also link a [[furniture]] stockpile to the still so that it has access to [[barrel]]s.

==Max bin/barrel/wheelbarrows ==
{{imagefix|[[File:v50_stockpile_barrel_button.png|left]]|5|0}}The ''max bin'', ''max barrel'' and ''max wheelbarrows'' settings control the number of barrels, bins and wheelbarrows that are used for the organisation of items inside the stockpile. It can be useful to disallow bins and barrels from some stockpiles, for example stockpiles used to store seeds or for [[Exploit#Quantum stockpiles|quantum stockpiles]], by reducing this setting to 0.

Increasing these numbers is not usually needed - they are set to the number of tiles in the stockpile when it is created, which is the maximum number of bins or barrels the stockpile can hold anyway. Which of bins or barrels is turned on is determined by the item type selected when the stockpile is designated - food stockpiles allow barrels, for example, and bar stockpiles allow bins. However, these settings are not updated if the types of items allowed in the stockpile are changed. If you change the types of items allowed in the stockpile, it may also be useful to change the number of bins and barrels that are allowed in it to allow your dwarves to store those items more efficiently.


== Stockpile categories ==
===[[Ammo]]===
This stockpile contains ammo for all forms of ammunition-requiring weaponry (except [[siege engine]]s). It can use [[bin]]s to consolidate stacks.

===[[Animal]]===
[[Creature|Animals]] stored in [[cage|cages]] that are not affixed to a location will be stored in these stockpiles. [[Animal trap|Traps]] used for capturing wild animals and empty [[cage|cages]] are also stored here.

This type of stockpile cannot use bins or barrels.

===[[Armor]]===
Armor of all types is stored here. There is no preference for specific body parts, but usable/unusable armor may be specified. All types of armor can be stored in [[bin]]s.

===[[Bar]]/[[Block]]===
Bars of smelted [[metal]] and blocks of cut stone and [[glass]] are kept here after being processed by the [[smelter]], [[mason's workshop|mason's workshops]], and [[glass furnace|glass furnaces]], before being used for other purposes. Weirdly, [[ash|ashes]], [[potash]], [[soap]], [[charcoal]], and [[coke]] from the [[wood furnace]], [[ashery]], [[soap maker's workshop]] and [[smelter]] will also be stored here. As with all stockpiles, this can be changed to allow for specific blocks and bars to be stored with custom settings. [[Bin]]s can be used to consolidate up to 10 bars/blocks.

Bars of [[fuel]] ''(Coke and Charcoal)'' are stored in '''Bars: other materials-> Coal'''

===[[Cloth]]===
Woven cloth and [[thread]] are stored here (plant fiber, animal hair, and silk). [[Bin]]s can be used to consolidate items.

===[[Currency|Coins]]===
Minted coins are kept here, several thousand of them fitting into a single bin.

===[[Corpse|Corpses]]===
Dead sentient beings (dwarves, goblins, trolls, etc.) and [[pet|pets]] that have no burial location will be placed here. Other corpses are considered part of the ''refuse'' category.

If placed indoors, decaying bodies will generate [[miasma]], but [[bone]]s will not be removed at the end of the season. Rotting [[pet]]s or [[friend]]s give dwarves unhappy [[thought]]s unless they are given a proper burial in a [[Coffin|burial receptacle]].

Corpse stockpiles are meant to be used as ''morgues'', though the inclusion of invader corpses makes this slightly difficult.

===[[Finished goods|Finished Goods]]===
Finished goods created by the [[craftsdwarf's workshop]], as well as the [[clothier's shop]] and the [[leather works]], are placed here before being used in trade or other uses. This type of stockpile can use [[bin|bins]] to consolidate items, over a hundred objects can fit into a bin.

Since this stockpile can also contain supplies that the player might not want to trade away ([[splint]]s, [[crutch]]es, [[rope]]s, [[waterskin]]s...), it is wise to make separate custom stockpiles for these goods.

While not explicitly mentioned, the [[tools|Tool]] subcategory includes the following items:
* Scroll rollers
* [[Book binding]]
* [[Hive]]
* [[Honeycomb]]
* [[Quire]]
* [[Die]]
* [[Jug|Jugs]]
* [[Nestbox]]

=== [[Food]] ===
As one would assume based on the name, food is stored here, in addition to a wide variety of inedible plant and animal products -- [[seed]]s, [[lye]], [[giant desert scorpion]] venom, bags of [[dye]], and [[liquid fire]], to name a few. Raw [[Creature#Aquatic|fish]] is brought here, before being processed by a [[fishery]] and turned into edible [[meat]]. Drinks are always stored in [[barrel]]s or [[large pot]]s. Seeds are stored in [[bag]]s (which may in turn be stored in barrels/pots); other food items can be stored in barrels or pots.

Barrels and pots can hold, at most, 60 [[prepared meal]]s. Stacks larger than that (☼Dwarven Beer Roast [200]☼ is possible) will not fit in a barrel, but will still only take up one tile of stockpile space. To free up barrels, you may decide to have separate prepared food stockpiles that do not accept barrels - if you cook larger meals, this shouldn't be a problem.

Food will never [[wear|spoil]] while in a stockpile, although it may attract and be eaten by [[vermin]]. Food stockpiles should, in most cases, be restricted to desired types (e.g. [[seed]] stockpiles or meat stockpiles or unprepared fish stockpiles); there are simply too many things that go in them.

Fat and tallow go in the same list and are listed by animal. To separate out just the tallow, search for "tallow" and click all/none for the column. This button only applies to displayed items. Resetting the search will show that tallow has been allowed/forbidden, but fat settings are unaffected.

Fish that have been caught but not [[Fishing_industry#Fish_cleaning|cleaned]] are stored in '''Unprepared fish'''. Fish that have been cleaned ''(via Prepare a raw fish at a'' [[fishery]]) are stored in '''Fish'''.

Read more about the following food stockpile categories here:
* [[Plant]]s
** For edible plants, see [[Crop]]s
* [[Seed]]s
* [[Crop#Garden_plants|Fruit]] / [[Plant#Bulb.2FFlower.2FLeaf|Leaves]]
* [[Miller#Millable_Plants|Milled plant]]

===[[Furniture]] Storage===
Completed items from the [[carpenter's workshop]], [[mason's workshop]], and [[mechanic's workshop]] will be stored here, along with furniture created from other shops, until placed or used in another building. Bags filled with [[sand]] can also be stored in furniture stockpiles, and in fact will appear in any furniture stockpile unless expressly forbidden, regardless of materials permitted.

Since this is a very broad category, it may be useful to create stockpiles for a specific type of item (like barrels, bags, bins, mechanisms) via the stockpile settings.

Furniture cannot be stored in barrels or bins.

If you choose to apply advanced stockpiling of furniture e.g. "make a stockpile for only [[Furniture]]>[[Bed]]s." Merely selecting "beds" under the "Type" category will not suffice. In this case one also needs to ensure the required qualities are selected! Should you want to store all quality beds, just make sure you select "all" on the categories: [[#Core Quality|Core Quality]] as well as [[#Total Quality|Total Quality]].

[[Anvil]]s, [[millstone]]s, and [[quern]]s are stored as furniture, even though they are a core component of a [[workshop]].

[[Siege engine]] items are also stored in this stockpile:
* Ballista parts
* Bolt thrower parts
* Catapult parts
* [[Ballista arrow]]
* Ballista arrowhead

====Other Large Tools====
While not explicitly mentioned, the following items are stored in the "Other large tools" subcategory:
* [[Bookcase]]
* [[Pedestal]]
* [[Altar]]
* [[Stepladder]]
* [[Display case]]

===[[Gem]]===
This stockpile stores gems and raw [[glass]], both cut and uncut, along with [[gizzard stone]]s. It can use [[bin]]s to consolidate gems.

===[[Leather]]===
Leather, which is produced at a [[tanner's shop]], will be kept here. Like most stockpiles, it can use [[bin]]s to consolidate items.

===[[Refuse]]===
Since dwarves hate rot, because of the [[miasma]] it spreads when in an enclosed place like a [[cave]], any garbage item that can rot will be stored in a refuse stockpile. Also, any [[wear|XXdamaged itemsXX]] will be moved to the refuse stockpile. Many players prefer to place this stockpile outside their cavern, usually a small distance from the entrance, as rottable items on tiles that are {{DFtext|Outside |3:1}}{{DFtext|Light |6:1}}{{DFtext|Above Ground|2:1}} do not generate miasma.

If placed on a {{DFtext|Subterranean|0:1}} tile, decaying items will generate miasma, which will spread through your fortress and generate a small unhappy thought in any dwarf passing through it. For this reason, it is sensible to build [[door|doors]] (preferably several, separated by a few tiles to create an airlock) to all of your indoor refuse stockpiles. Miasma won't spread through a closed door, so only dwarves with business in the room will be bothered by the rot.

An alternative to this is to dig [[channel|channels]] down from the surface, creating an area of tiles considered to be {{DFtext|Light |6:1}}{{DFtext|Above Ground|2:1}}, yet still located within your fortress. You can place your refuse stockpile here, and although it will be in your fort, rotten items on those tiles will not generate miasma. If you choose to cover them with walls or floors for security and/or aesthetic reasons, it will convert them to {{DFtext|Inside|6:0}}, but they will remain {{DFtext|Light |6:1}}{{DFtext|Above Ground|2:1}} tiles, which again do not generate miasma in rotten items. (For even more creative methods to restrict the spread of foul rotting stench, see the [[miasma]] page.)

[[Bone]]s, [[skull]]s, and [[shell]]s are also stored here, whether from defeated enemies or raw food processing - if left in an area with high [[vermin]] levels, these will randomly disappear. Refuse stockpiles can be restricted to store only [[bone]]s, [[skull]]s, [[shell]]s, teeth, and horns/hooves.

Note that a refuse stockpile is not the same as a [[Activity_zone#Garbage_Dump|garbage dump]] - a garbage dump is only for things manually marked to be dumped. Additionally, refuse types specifically marked as '''Dwarves Dump''' ''refuse type'' will be hauled to the garbage dump instead of the refuse stockpile.

Be careful on evil biomes, since some can reanimate dead creatures and body parts. If your fort is located on a map where part is evil and part is not, it is best to put your refuse stockpile on the part that is not evil.

The corpses of sentient beings (goblins, trolls, etc.) are no longer stored in refuse stockpiles, [[Stockpile#Corpses|but in a corpse stockpile instead]]. If your dwarves are not cleaning up bodies, this is probably why.

===[[Sheets]]===
This stockpile stores sheets, including paper and parchment. Like most stockpiles, it can use bins to consolidate items.

===[[Stone]]===
Rough stone will be stored here, as well as [[ore]]. These stockpiles cannot use bins or barrels, but the use of [[wheelbarrow]]s is strongly advised. The default number of assigned wheelbarrows is 1, also if the number of assigned wheelbarrows is set to zero and the custom stockpile setting is entered, upon exiting the custom stockpile settings, the number of assigned wheelbarrows is reset to 1 (from zero), that happens even if no changes in the custom stockpile settings has been made.

[[Stone management]] is a complex topic; in the simplest terms, most stones are extremely heavy, so you want to minimize the distance they are [[hauling|hauled]] by hand (e.g. from the stone [[stockpile]] to the [[mason's workshop]] or [[smelter]]) by putting such stockpiles very close to the workshops that they feed.

===[[Weapon|Weapons]]===
Weapons of all types are stored here by default, including picks, trap components, and weapons too large for dwarves to use. [[Bin]]s can be used to consolidate weapons of any type.

===[[Wood]]===
Chopped trees are brought to the wood stockpile before being used by carpenter's workshop, a wood furnace or siege workshop. Because wood takes a long time to haul and tends to travel a long way, the stockpile should be rather close to a fortress entrance (which does not necessarily mean on the upper z-levels - moving down one z-level is only one tile), unless you have an [[Tower-cap|underground tree farm]]. It is a good idea to position this stockpile close to your carpenter's workshop (or the other way round) since he is likely to be the main "customer". Wood stockpiles will also accept "grown" wood logs that elves bring.

This type of stockpile cannot use bins or barrels.

===Additional Options===
The options are "Allow Plant/Animal" (organic goods) which appear as [[File:v50_stockpile_allowplants.png|20px]] or [[File:v50_stockpile_allowplants_off.png|20px]] and "Allow Non-Plant/Animal (non-organic goods) which appear as [[File:v50_stockpile_allowmetals.png|20px]] or [[File:v50_stockpile_allowmetals_off.png|20px]]. Unlike all the other categories, the Additional Options settings apply to all other active categories. A stockpile that allows neither organic nor non-organic goods will never receive any items. Disabling "Additional Options" is a common cause of stockpile problems, and these options generally aren't useful anyway unless you want to consolidate trade goods which are safe to [[trade]] to [[Elf|Elven]] caravans.

=== Custom stockpiles ===
With custom stockpiles, you can change which types of materials, goods, etc., can be stored in that stockpile. Any type of things can be mixed, so you could have a stockpile that will hold raw [[turtle]], [[mechanism|mechanisms]] and all stone types apart from [[onyx]] if you wanted, or only high-quality steel crossbow bolts (Ammo), all quivers (a Finished Good), and metal crossbows (a Weapon) - the combinations are endless, and can be finely tuned. Note that many sub-menus consist of several pages ( the 'other' menu of stone e.g. consists of several pages while 'metal [[ore|ores]]' and 'economic' consist of only one ).

== Stockpile Settings ==
In the '''Stockpile Settings''', the first column are the major categories. In the second column there may or may not be subcategories. In the third you will see the individual items. The second and third columns are only visible when a category is enabled and selected. Any option can be selected in any category by simply clicking on it. Each column has an "All" or "None" button, which will enable or disable entire categories so that the player does not have to individually click each option to enable or disable an entire list.

Be careful when selecting 'block all' on the subcategories, as it can make your stockpiles useless. For example, if you block all the furniture subcategories and then re-enable beds under types, the stockpile won't actually accept anything because it still registers all materials and all quality levels as forbidden. The correct way would be to 'forbid types' and then re-enable beds.

=== Core Quality ===
Core quality means the quality of the ''craftsdwarfship of the item''. A masterfully crafted armor (made from qualityless metal bars) has masterful core quality. A finely-crafted dress (made from an exceptional pig tail fiber cloth) has fine core quality (because the craftsdwarfship ''of the item'' is fine).

=== Total Quality ===
Total quality means the highest between the craftsdwarfship of the item and the craftsdwarfship of its components (or decorations). The finely-crafted dress from our previous example has a fine core quality, but its total quality is exceptional because its component — a pig tail fiber cloth — is of exceptional quality. Likewise, a superior quality steel gauntlet, masterfully studded with copper is of masterful total quality (and superior core quality).

A more complex example: A rope reed fiber sock is superiorly decorated with pond turtle shell. Is masterfully crafted from a rope reed fiber cloth which was finely dyed with redroot dye. Core quality: masterful, Total quality: masterful. (Remember, for total quality, the best of either the item's quality, the quality of its components, or the quality of its decorations is chosen.)

See also [http://www.bay12forums.com/smf/index.php?topic=96501.msg2765710 Crafting Skills, Quality and Statistics research].

=== Notes ===
Some categories will have a special extra type of item(s) that can be toggled.

{| border="1" cellpadding="4"
|+
! Categories
! Item type
|-
| Animals
| Empty [[cage]]s and empty [[animal trap]]s
|-
| Food
| [[Prepared meal|Prepared food]]
|-
| Weapons
| Usable and unusable [[weapon]]s
|-
| Armor
| Usable and unusable [[armor]]
|}

If you disable an item or items that are already sitting in a stockpile, then they become loose items. Your haulers will move them to a more suitable stockpile, should one exist. All existing stockpiles (and [[zone]]s) can be seen with {{Menu icon|P}} and viewing the "Zones" and "Stockpiles" tab.

== Custom Stockpile Uses ==
A custom stockpile is most useful for food, furniture, and bar/block stockpiles, to prevent your lye and venom sitting next to the [[kitchen|kitchens]], your [[floodgate|floodgates]] and mechanisms near the [[zone|rooms]] that need [[statue|statues]] and doors, your stone blocks next to the forges, and your metal bars by the farms.

When setting up a custom stockpile to hold more than one type of raw material, it is often best to set up multiple custom stockpiles, one for each type. Otherwise your stockpile will invariably fill up with lesser-used items, rendering your custom stockpile nearly useless.

One use for this is to have an outdoor stockpile next to your gate that will accept all refuse except bones, shells, skins and skulls, and then one or more indoor pile(s) near your craftsdwarf's workshop that will '''only''' accept these things. If you have set the option for dwarves to gather refuse from outside, the bones will be brought in once all the meat has rotted off of any carcasses outside. This means added risk to your dwarves if they try to gather refuse that is far from your gate, and additional hauling.

Another effective use of custom stockpiles is Elven trading. Make a stockpile just for elf-safe trade goods: most categories where it is relevant have a 'materials' option. Note, however, that items with [[wood]]en [[decoration]]s will '''not''' be excluded. Similarly, [[noble]]s who frequently [[mandate]] restricted trading can have their preferred goods stored separately, far away from the [[trade depot]].

A highly efficient method is to have wood burning furnaces feeding into a '[[charcoal]] only' bar/blocks stockpile, which in turn is near the smelting furnaces and forges. Bonus points if you also place a small wood stockpile near the wood furnaces.

Other good uses:
* Planter's stock: [[seed|seeds]] and [[potash]]. If your [[ashery]] is nearby, include ashes and lye.
* Smelter stock: [[ore|ores]], [[flux]] and, unless you're using [[Magma smelter]], [[coal]].
* Sandpile: [[sand]] bags.
* Dyer's stock: a food stockpile that only includes [[dye|dyes]].
* Food Plus: a food stockpile that includes barrels. This spares your dwarves from carrying empty barrels to and from the furniture stores.
* Skins: a refuse stockpile limited to [[skin|skins]], a bit like the bone & shell stockpile above. Place near the tannery.
* Brewer's stock: [[List of crops|brewable plants]].
* Miller's stock: [[List of crops|millable plants]]. (An empty [[bag]] stockpile will also speed up milling.)
* Refreshment stand: Since dwarves drink twice as often as they eat, having several small food stockpiles that only accept [[Alcohol|drinks]] scattered strategically through your fort can minimize [http://en.wikipedia.org/wiki/Smoko smoko breaks]. The usefulness of this kind of stockpile is often disputed as dwarves go to the fullest barrel first, so if you can't keep your stockpile constantly filled with new full barrels of alcohol your masons might decide to run all the way over to the alcohol stockpile you have set up for your brewers or your metalsmiths. If you can keep each stockpile constantly filled with fresh supplies of full barrels of alcohol then this can increase productivity greatly. A simple way of doing this is by keeping a brewery near each separate alcohol stockpile, or [[burrow]]ing dwarves so that local stockpile is the only one they can [[path]] to.
* Artifact materials: The massive value and effectiveness of [[artifact|artifacts]] mean the materials used in them can have drastic effects, sometimes even into the ''[[Value|millions]]''. Having special stockpiles for high-value metals, stones, gems, and other such materials will make it that much easier to ensure that you will get the most out of each [[strange mood]]. (However, even with materials-specific stockpiles, it can take a fair amount of micromanagement to get a moody dwarf to use a specific material.)
* Artifact storage: Artifacts add a great deal to the created wealth of the fortress. Keep valuable artifacts safe in a special "treasure" stockpile.
* Ingredients: Store things that are cookable but not edible, like milk and quarry bush leaves, near [[kitchen]]s. Also, more [[rot|volatile]] foods (such as [[meat]]) can be stored closer to your kitchen to encourage your cooks to use them quickly.
* [[Stone carver]]'s stone: Linking a single- or limited-type stone stockpile to a [[stoneworker's workshop]] allows you to specify exactly which [[stone]] your stone carvers will use, providing consistent output (and increased [[value]] if using [[economic stone]]). Additionally, if your stone carver has a [[preference]] for a particular stone, you can increase output [[quality]] by having him work with that stone.
* Finished goods stockpiles near a Trade Depot that includes crafts that you want to sell, but excludes ordinary clothing, backpacks, waterskins, splints and crutches that you want your dwarves to use.

==Bugs==
* Gem stockpiles' material option for clay is hidden in the UI {{Bug|9749}}.
* [[Hauling]] blocks access to items stored in [[Storage|container]]s; consider creating container-less "feeder" stockpiles linked to your storage stockpiles.
* [http://www.bay12forums.com/smf/index.php?topic=92241.msg3276117#msg3276117 Research] has suggested that stockpiles are a significant cause of [[Maximizing framerate|lag]]; see [[Exploit#Quantum_stockpiles|Quantum Stockpiles]] for designs that minimize stockpile tiles.
* Disabling "Additional Options" in the stockpile menu is a common source of stockpile problems.

==Troubleshooting==
Getting dwarves to haul items to a stockpile is a frequent source of frustration. Here are some things to check:

* Do you have idle dwarves?
** Do the idle dwarves have the appropriate hauling labors enabled?
** Are the idle dwarves constantly taking and cancelling other jobs?
* Do you have a stockpile that wants this item?
** Is there an empty spot in the stockpile?
*** Note that hidden items and wheelbarrows tie up stockpile tiles.
** Can the idle dwarves path to the stockpile and the item?
** Is the stockpile set to accept from anywhere, not just links?
** Check both the item's type and its material, in stockpiles that can filter materials.
** Check that the armor/weapon stockpile setting is "usable" and/or "unusable" as appropriate.
** Check that "Additional Options" are set correctly to allow the desired items.
* Is the item unforbidden?
* Is the item accessible (no civilian alert, burrows, etc.)?
* Is the item not owned by any dwarf?
* Is the item not tasked for a job?
* Is the item not assigned for use in any buildings/constructions?
* Check your standing orders (o), and make sure this kind of item can be gathered.
** For refuse, make sure dwarves are allowed to gather refuse that is "outside" (o r).
* Does the stockpile have wheelbarrows assigned? If so, are they all in use?
* If the item normally goes in a container, do you have suitable unused containers?
* Is the item claimed by a location (hospital, tavern, library, temple)?

{{V50 menus}}
{{Category|Stockpiles|*}}
{{Category|Items}}
[[ru:Stockpile]]

Bin

2026-01-13T05:36:26Z

DPhKraken: Added stockpile link

{{Quality|Exceptional}}
{{av}}
{{v50_item|name=Bin
|tile=X|col=0:6:0
|graphic=[[File:bin premium.png]]
|wood=y
|metal=y
|bars=3
|glass=n
|cloth=n
|leather=n
|ceramic=n
|bone=n
|shell=n
|gem=n
|wax=n
|used for=
* [[Storage]] ([[Stockpile#Stockpile categories|Most items]])
|value=10
|size=15,000
|capacity=60,000}}

{{Translation
| dwarven = osed
| elvish = masa
| goblin = sputo
| human = itlud
}}

A '''bin''' is a specially made basket for certain [[stockpile]]s. A bin can be made from one [[wood|wooden log]] at a [[carpenter's workshop]] or forged from 3 [[metal]] [[bar]]s at a [[forge]]. Bins make it possible to store lots of objects into one tile of a stockpile. A stockpile without a bin will likely fill up fast, leaving any remaining items where they are to get in the way. Graphically, when a bin is empty, the sprite will be that of an empty bin with no lid, whereas a bin with multiple types of items will have a lid, albeit slightly tilted. Bins are a component in building a [[bolt thrower]]. Bins that are filled with a specific type of item will show those items sticking out the top of the bin:
<div style="testA" style="margin-top: 10px; margin-left: 20px;">[[File:bins_variants_preview.png]]</div>

Bins are therefore incredibly useful to a maturing fortress. The best material for bins is generally [[wood]], because wooden bins are the lightest bins and will therefore save your haulers' time. Of course, if you intend to use bins next to a [[volcano]] or something equally [[fire|hot]], you may want to use metal bins.

If your fort suffers from a lack of wood but [[Fuel|charcoal]] is also your only [[fuel]] source, producing metal instead of wooden bins will actually '''increase''' your wood consumption. Forging each bin will cost one unit of fuel and smelting the metal bars will also require fuel. Charcoal is produced at a rate of one bar per log. You can only reduce wood consumption by making metal bins if you use coke or [[magma]] to heat your smelters and forges.

Stockpiles that use bins are [[ammunition|ammo]], [[armor]], [[bar]]s/[[block]]s, [[cloth]], [[Currency|coins]], [[finished goods]], [[gems]], [[leather]] and [[weapon]]s. [[Food]] stockpiles use [[barrel]]s and [[large pot]]s instead of bins. Other stockpiles do not use anything at all.

Bins are a fast way to transport trade goods to a [[trade depot]]. Instead of carrying the individual item, the dwarf will haul the whole container for trade. Though if the contents inside are heavy, it will still take a long time.

For information on managing bins in stockpiles, see [[using bins and barrels]].

[[Melt item|Melting]] metal bins return a single bar.

[[File:Wood (2942371043).jpg|thumb|A large number of wooden bins stacked upon each other.]]

== Bugs ==
* Hauling jobs block access to all the items in the destination containers until the hauling is complete. This often results in cancellation spam and work delays.{{bug|9004}} One workaround is creating a "feeder stockpile" with containers disabled.
* Items in bins are sometimes not found for tasks.{{bug|8755}}

== See also ==
* [[Storage]]
[[ru:Bin]]

Large pot

2026-01-13T05:31:57Z

DPhKraken: Added stockpile link

{{Quality|Superior}}

{{av}}
{{buggy}}

{{v50_item|name=Large pot
|graphic=[[File:large_pot_sprite.png]]
|tile={{char|232}}
|wood=n
|woodcraft=y
|stone=n
|stonecraft=y
|metal=n
|metalcraft=y
|bars=1
|glass=y
|cloth=n
|leather=n
|ceramic=y
|bone=n
|shell=n
|gem=n
|wax=n
|used for=
* [[Storage]] ([[Stockpile#Food|Food, liquids]])
|value=10
|size=5,000
|capacity=60,000
}}

'''Pots''', also known as '''large pots''', are containers that function much like [[barrel]]s, and have the same capacity, but can be made from materials other than wood or metal, such as [[stone]], [[ceramic]], and [[glass]]. The game refers to these containers sometimes as "pot" and sometimes as "large pot" but there is no actual distinction. Graphically, if a pot is empty, the sprite will show a pot with no lid; if it is filled with a specific type of item, the top of the pot will have the matching items sticking out of the top, which also applies for liquids. If the pot contains content such as [[slurry]], paste or [[tallow]], the pot will have a lid.

For most uses, large pots can replace [[barrel]]s. However, stone pots are usually heavier than wooden barrels, so tasks that require moving stone barrels may be slowed to some extent compared to wooden ones. (See "[[Large pot#Material selection|material selection]]", below).

Note, however, that large pots cannot replace barrels in all situations. Some tasks may ''specifically'' require "barrels" (eg. "Process Plant to Barrel"), and some workshops '''specify''' a barrel for their construction, e.g. an [[ashery]] or [[dyer's shop]]. Large pots cannot be encrusted with gems at a [[jeweler's workshop]], despite being stored in the Furniture stockpile.

Large pots can be made from stone by a [[stone crafter]] at a [[craftsdwarf's workshop]], [[ceramic]] at a [[kiln]], [[glass]] at a [[glass furnace]], [[wood]] at a [[craftsdwarf's workshop]], or [[metal]] at a [[metalsmith's forge]]. Pots made from stone, [[stoneware]], [[glass]], [[wood]], [[porcelain]], [[metal]], or [[glaze]]d [[earthenware]] are water-tight and can be used to store liquids, and even for [[brewing]]. Unglazed earthenware can only be used for storing dry items. Metal pots are made using the [[metalcrafting]] skill, as opposed to metal barrels, which use the [[blacksmithing]] skill.

Pots are stored in the Large Pots/Food Storage section of the Furniture stockpile. Empty pots are listed under Tools when viewing the fortress's [[stocks]] or when moving them to a [[trade depot]]. Pots are hauled using the Haul Item labor.

Large pots take up 500 units of volume. Same as barrels, pots can hold up to 60 prepared meals, plants, or cheeses, 30 pieces of meat or fish, any number of units of brewed [[alcohol]] (but only a single stack), 100 units of [[lye]] or [[milk]], or 6000 [[egg]]s regardless of size.

== Material selection ==
As with other containers, several factors are relevant in choosing the proper material for making large pots. Namely, availability, value, fire/magma safety, vermin resistance, <s>hippie</s> elf kosherness, and most importantly '''weight'''.

Pots made from stone of typical* [[Density#Density of some materials|density]] will be 33% heavier than typical* wooden barrels. Fire clay "stoneware" pots weigh the same as a wooden barrel, while earthenware pots are lighter but must be glazed. This makes large stone pots superior for any stockpile that does not require the containers to be moved, such as [[Kitchen|prepared meals]]. Ceramic pots are superior to typical wood in all cases.
: (*There are exceptionally light or heavy examples of both stone and wood, but the majority of types of each fall into a "typical" weight category.)

Pots are only 1/4 as heavy[http://www.bay12forums.com/smf/index.php?topic=127471.msg4342164#msg4342164] as barrels made from the same material (e.g. metal, glass). This means metal pots are generally a better storage option than metal barrels, saving the industry precious dwarf-hours by hauling faster due to lighter containers. Additionally, a metal barrel costs '''3''' bars, but a metal pot only '''1''', making metal barrels a vastly less attractive option.

But in the case of large pots, stone is typically used chiefly due to its abundance, especially for young outposts. Doing so will conserve wood (likely the only other economic choice) for tasks for which stone cannot be used (and metal is not always practical), such as making [[bed]]s, [[bin]]s, [[bucket]]s, [[cage]]s, [[charcoal]], [[crutch]]es and [[splint]]s, [[pipe section]]s, [[stepladder]]s, [[training weapon]]s, [[wheelbarrow]]s, and many other items* of various usefulness and importance.
: (*[[Crossbow]]s and [[bolt]]s could fall here, too, but those often deserve to be made of a weapons-grade metal.)

Unless, of course, the embark location has trees aplenty, making it viable to use wood for most everything, including pots, though this obviously requires a sufficient amount of woodcutters, wood crafters, axes, and contempt towards the <s>tree-huggers</s> elves.

== Forging and melting ==

* Metal pots cost '''one''' [[metal]] bar to forge, or '''one''' [[adamantine]] wafer.

* When a pot is [[Melt item|melted]] down, it will return '''0.3''' metal bars/adamantine wafers for an efficiency of '''30%'''.

== Bugs ==
* Pots will not be used for processing [[sweet pod]]s into [[dwarven syrup]]. {{Bug|4356}}
* Dwarves will sometimes leave pots in furniture stockpile even when using them to store food. {{Bug|1833}}

== See also ==
* [[Barrel]]
* [[Cauldron]]
* [[Jug]]

{{Translation| dwarven = or tezad | elvish = lacifa momo | goblin = sted ag | human = lod utag}}

{{Gamedata|{{raw|v50:item_tool.txt|ITEM_TOOL|ITEM_TOOL_LARGE_POT}}|title=Raws for pot as a [[tool]]}}

{{Category|Items}}
[[ru:Large pot]]

Barrel

2026-01-13T05:31:34Z

DPhKraken: Added stockpile link

{{Quality|Superior}}
{{av}}
{{v50_item|name=Barrel
|tile=÷|col=0:6:0
|graphic=[[File:Iron barrel sprite.png|23px|metal barrel]] / [[File:Barrel_premium.png|wooden barrel]]
|wood=y
|stone=n
|metal=y
|bars=3
|glass=n
|cloth=n
|leather=n
|ceramic=n
|bone=n
|shell=n
|gem=n
|wax=n
|used for=
* [[Storage]] ([[Stockpile#Food|Food, liquids]])
|value=10
|size=20,000
|capacity=60,000}}
'''Barrels''' are storage units that, like [[bin]]s and [[bag]]s, conserve [[stockpile]] space by containing several items of the same type. They can be made out of [[wood]] at a [[carpenter's workshop]] (requires one [[log]] for each barrel) or forged from [[metal]] at a [[forge]] (requires 3 [[metal]] [[bar]]s). Non-magma [[forge]]s also require one [[bar]] of [[fuel]]. Graphically, if a barrel is empty, the sprite will show an empty barrel with no lid; if it is filled with a specific type of item, the top of the barrel will have the matching items sticking out of the top. If the barrel contains a liquid, the barrel will have no lid and show the top of the liquid it contains, as well as having a tap attached to it, making the barrel resemble a keg. If the barrel contains content such as [[slurry]], paste or [[tallow]], the top of the barrel will have a lid:
<div style="testB" style="margin-top: 10px; margin-left: 20px;">[[File:barrels_variants_preview.png]]</div>

When a barrel is emptied, it may be used again or stored in a Furniture stockpile with type Barrels, plus appropriate materials (Wood is under Other materials), and qualities allowed. For more information on managing barrels in stockpiles, see [[using bins and barrels]].

For most uses, barrels can be replaced by a [[large pot]], which has the same storage capacity (and requires no [[wood]] or [[metal]]) and is only one quarter as heavy ''as a barrel made of the same material''. Typical stone pots will be 33% heavier than wooden barrels. Fire clay "stoneware" pots weigh the same as a wooden barrel, while earthenware pots are lighter but must be glazed.

Barrels are used in building [[dyer's shop]]s and [[ashery|asheries]]. Using a valuable masterwork or [[artifact]] barrel to build one of these buildings can significantly increase fortress [[wealth]].

Barrels can hold up to 60 prepared meals, plants, or cheeses, 30 pieces of meat or fish, any number of units of brewed [[alcohol]] (but only a single stack), 100 units of [[lye]] or [[milk]], or 6000 eggs regardless of size. However, alcohol brought at [[embark]] will be in barrels that only contain up to 5 units each; this due to alcohol barrels allowing only 1 stack and embark items coming in stacks of 5 units or less.

The name of a barrel can vary by circumstance: the name of an empty barrel is the material it is made of, e.g. "tower-cap barrel", otherwise a barrel will be named for what it contains with its material appended, e.g. "dwarven wine barrel (tower-cap)". Additionally, if a barrel is assigned for use in a stockpile, the number of the stockpile will be appended, e.g. "dwarven wine barrel (tower-cap) <#1>".
[[File:barrel_preview.png|thumb|360px|center|Some dwarves call these "very large cups" when alcohol is involved. ''Photographed by Ivankish'']]
== See also ==
* [[Large pot]]
* [[Storage]]
* [[Using bins and barrels]]
[[ru:Barrel]]

Draltha

2026-01-07T17:41:21Z

DPhKraken: Preserved the original sprite and an alternate design

{{Quality|fine}}
{{Creaturelookup/0
|image=draltha_sprites.png
|portrait=draltha_portrait.png
|wiki=no
|contrib=no
|bone=28-40
|meat=25-108
|fat=12-36
|eye=2
|lung=4-6
|heart=1
|intestine=7-10
|liver=2-3
|tripe=2-3
|sweetbread=1
|spleen=1
|kidney=2
|brain=2-3
|skull=1
|skin=hide
|teeth=1
}}
{{av}}
{{creaturedesc}}

'''Dralthas''' are massive [[creature]]s who dwell on the first and second [[Caverns|underground]] layers. They don't actively seek fights but are huge creatures—about half the weight of an [[elephant]]—and able to kill a [[dwarf]] with ease, often ripping them in half in the process. It is advisable to herd them into [[cage]] [[trap]]s, or keep dwarves away from them if they make their way into commonly used pathways, as they will attack if dwarves brush by them enough.

Once captured, dralthas can be trained with an [[animal trainer]], and have a high [[pet]] value of 500. Draltha products are worth three times as much as those from [[domestic animal]]s, and they are common enough to make capturing a herd for breeding easy. Their large size means they produce a good amount of meat and bones when butchered. Keep in mind that they are grazing creatures, which require a [[pasture]] in order to survive once trained. Because of their size, each will need a fairly large pasture.

Unlike most animals, dralthas can't be spawned in the [[object testing arena]].

Some dwarves [[Preferences|like]] dralthas for their ''lustrous manes''.
==Gallery==
<center>
<gallery widths="300px" heights="300px">
draltha.jpg|''Art by kruggsmash''
Notebook_13_Draltha.jpg|''Concept art by Bay 12 Games.''
Draltha human face neoriceisgood.png|''Art by Neoriceisgood.''
</gallery></center>

{{gamedata}}
{{Creatures}}
{{Category|Animals}}

File:Draltha human face neoriceisgood.png

2026-01-07T17:37:00Z

DPhKraken: An early draltha portrait and a set of alternative, redrawn sprites by official artist Neoriceisgood.

== Summary ==
An early draltha portrait and a set of alternative, redrawn sprites by official artist Neoriceisgood.
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

Strange mood

2025-11-25T05:38:22Z

DPhKraken: Undoing. There is no present link between deities and strange moods, and no need to suggest any.

{{Quality|Exceptional}}
{{av}}
{{buggy|bugsection=Bugs}}
{{minorspoiler}}
[[File:strange_mood_prev.png|thumb|350px|right|A dwarf losing ownership of his mind. ''Artwork by Zippy'']]
Periodically, individual [[Dwarf|dwarves]] are struck with an idea for a [[legendary artifact]] and enter a '''strange mood'''. Dwarves which enter a strange mood will stop whatever they are doing, and pursue the construction of this artifact to the exclusion of all else – they will not stop to eat, drink, or sleep; pretty much the ''only'' thing that can pause a "moody" dwarf is giving birth, after which they will immediately get back to making the artifact. If they do not manage to begin construction of the artifact within a handful of months, they will go [[#Failure|insane]] and die (one way or another) soon afterward.

Any creature with the {{token|STRANGE_MOODS}} token is able to enter strange moods in [[Legends|history]] and [[fortress mode]], though, by default, this ability is unique to dwarves.

==Overview==
[[File:mood_announce_v50_x2.png|right]]Once your fortress has at least 20 dwarves, occasionally one of them will be struck by a "strange mood". These largely random events will be seen as an [[announcement]], and will pause the game.

A dwarf struck by a strange mood will seek an appropriate workshop, immediately claim it for the duration of the mood, attempt to collect the materials to create their [[artifact]] of choice, and, once those have been collected, proceed to do so. Depending on the exact mood (see [[Strange mood#Types of moods|types of moods]], below), both the workshop and the artifact are based on the highest "moodable skill" of that dwarf (see "[[Strange mood#Skills and Workshops|Skills and Workshops]]", below).

At the end of this process, if successful, the dwarf will '''usually''' gain enough [[experience]] to become Legendary (or higher), and then return to life as normal, but now with a Legendary skill. The "possessed" mood is an exception to this rule, as it does not grant any experience upon completion.

A dwarf cannot be struck by more than one mood in their lifetime.

=== In fortress mode ===
[[File:workshop_claimed_sample.png|thumb|300px|right|Information from a forcefully claimed workshop.]]
# The game will announce that the dwarf has entered one of five different types of strange moods. The [[#Types of moods|types of moods]] are listed below. While in a mood, a dwarf will display a blinking exclamation point (see [[Status icon|status icons]]).
# For the duration of the mood, the dwarf will claim a workshop related to the skill that the mood affects (not all skills are eligible), kick out any dwarf who was using it, and render it otherwise unusable until the mood has ended. If a moody dwarf does not claim a workshop, it is because the appropriate workshop does not exist. (See [[#Skills and workshops|skills and workshops]] below to determine which workshop(s) might be required.) A moody dwarf will ''not'' be able to build a needed workshop; another dwarf with the appropriate [[labor]] designation must do so for them, if one is necessary. Furnaces are also counted as a workshop.
# After claiming a workshop, the dwarf will set about collecting the required materials for their artifact. If the dwarf remains idle inside the workshop, it's because they cannot find the right material. Reference the [[#Demands|demands]] section to determine what may be required. Important Note: They will only collect these materials in the order that they require them. In other words, you have to determine where they are on the list of required materials and then provide the next one before they will continue collecting other materials.
# Once all materials have been gathered, the game will once again pause and center, and the moody dwarf will begin construction. Upon completion, the dwarf will create a semi-random artifact related to the skill affected and gain [[legendary]] (or higher) status in that skill (unless the mood type is [[#Possessed|possessed]]). See the [[#Skills and workshops|skills and workshops]] for information on which skills can be gained, or the [[#Artifacts created|artifacts created]] section for more details on the artifacts themselves.
# While you have some control over the skill the dwarf uses, and so some (but less) control over the type of artifact created, and (with some effort) the materials used, you have no control over which dwarf is struck by a mood, nor the type of mood that strikes them, nor the specific type of artifact created.
# The conditions necessary for a strange mood to occur have been fully understood due to a disassembly of the game; see below for the exact mechanics.

===In world generation===
Long before your seven dwarves [[embark]] on their adventure, non-player dwarves may also be struck by strange moods during world generation, albeit these are treated more abstractly. These events are a primary source of non-player artifacts that are scattered across the outside world when the game starts (see [[Mission]]). They have the same properties and quality as any artifact your fortress could have produced, and may be stolen or pillaged just like any other non-player artifact.

== Skills and workshops ==
If struck by a Fey, Secretive or Possessed mood, the workshop and artifact will be based on the highest "moodable skill" that a dwarf possesses. Not all skills are moodable. Fell and Macabre moods will either claim a butcher's shop and use Bonecarving, or a tanner's shop and use Tanning (see [[Strange mood#Types of moods|Types of moods]], below).

{| class="wikitable sortable" cellpadding="4" style="border:1px solid black;border-collapse:collapse;text-align:left;float:right;margin:0 0 20px 30px;vertical-align:top;"
|-
! Highest skill
! Workshop required
|- style="background-color:palegreen"
| [[Armorsmith]]
| [[Metalsmith's forge]] (or [[Magma forge]])
|- style="background-color:palegreen"
| [[Bone carver]]
| [[Craftsdwarf's workshop]]
|- style="background-color:palegreen"
| [[Bowyer]]
| [[Bowyer's workshop]]
|- style="background-color:wheat"
| [[Carpenter]]
| [[Carpenter's workshop]]
|- style="background-color:palegreen"
| [[Clothier]]
| [[Clothier's shop]]
|- style="background-color:lightgray"
| [[Engraver]]
| [[Craftsdwarf's workshop]]
|- style="background-color:wheat"
| [[Gem cutter]]
| [[Jeweler's workshop]]
|- style="background-color:wheat"
| [[Gem setter]]
| [[Jeweler's workshop]]
|- style="background-color:wheat"
| [[Glassmaker]]
| [[Glass furnace]] (or [[Magma glass furnace]])
|- style="background-color:palegreen"
| [[Leatherworker]]
| [[Leather works]]
|- style="background-color:wheat"
| [[Mason]]
| [[Stoneworker's workshop]]
|- style="background-color:palegreen"
| [[Mechanic]]
| [[Mechanic's workshop]]
|- style="background-color:wheat"
| [[Metal crafter]]
| [[Metalsmith's forge]] (or [[Magma forge]])
|- style="background-color:wheat"
| [[Blacksmith|Metalsmith]]
| [[Metalsmith's forge]] (or [[Magma forge]])
|- style="background-color:wheat"
| [[Miner]]
| [[Stoneworker's workshop]]
|- style="background-color:wheat"
| [[Stone carver]]
| [[Stoneworker's workshop]]
|- style="background-color:lightgray"
| [[Stone crafter]]
| [[Craftsdwarf's workshop]]
|- style="background-color:wheat"
| [[Stonecutter]]
| [[Stoneworker's workshop]]
|- style="background-color:wheat"
| [[Tanner]]
| [[Leather works]]
|- style="background-color:palegreen"
| [[Weaponsmith]]
| [[Metalsmith's forge]] (or [[Magma forge]])
|- style="background-color:wheat"
| [[Weaver]]
| [[Clothier's shop]]
|- style="background-color:lightgray"
| [[Wood crafter]]
| [[Craftsdwarf's workshop]]
|- style="background-color:lightgray"
| <none>
| [[Craftsdwarf's workshop]]
|}

A dwarf will claim a workshop according to their highest applicable [[skill]]. If not [[Strange mood#Possessed|possessed]], completion of the artifact grants roughly 10,000 [[experience]] in that skill. This will transform a previously unskilled dwarf to one of Accomplished-level (on average). The table to the right describes all applicable skills and their potential workshop requirements – there are only 20 skills that determine the workshop and that can be affected by a mood (sometimes referred to as '''moodable''' skills.) If a dwarf does not possess at least one of the moodable skills listed to the right, they will take over a [[craftsdwarf's workshop]] and gain one of [[bone carver]], [[stone crafter]], or [[wood crafter]] skills, producing an artifact [[craft]].

When selecting the desired mood skill, only the level itself is checked, and if the highest level found is shared by multiple skills, then one will be selected randomly.

This fact can be utilized to maximize the possibility of getting a dwarf with the specific legendary skill you want: since ''non''-moodable skills are ignored, whenever possible make sure that each dwarf's highest ''moodable'' skill is one of those you want. Have all your peasants, [[farmer]]s, non-professional military and other dwarves without any moodable skills do one job each in the skill(s) you most want; if a "[[experience|dabbling]]" skill is the highest moodable skill they have, that is the skill that will be used. [[Guildhall]]s related to moodable skills may both help and hinder, as demonstrations will increase skill levels without any jobs being done.

[[Scholar]]s may discuss mechanics as part of their work and gain a small amount of experience in it. This is the only skill that scholars discuss that is moodable.

=== "Best" skills ===
Some skills produce generally useful and valuable items, and others produce only trinkets or jewelry. While what is considered "best" is very subjective, the moodable skills can be broken down into tiers of relative utility, based on the potential artifacts created and the needs and goals of a fortress.

Note that, in addition to an artifact, the mood will raise the dwarf to Legendary in the chosen skill (except for possessed moods); often, this is (from a practical standpoint) more valuable than the artifact, so you might consider trying to push poorly-trained dwarves towards moodable skills you have a need for, in case they are struck by a mood.

* [[Weaponsmith]] – One of the "best" skills for strange moods. While a moody dwarf might create a questionable lead spear or lightweight aluminum mace, odds are they'll create something that is still more deadly than its ☼steel☼ equivalent. And, with a little manipulation, you can at least make sure the item ''is'' steel, although they could still produce a non-dwarf weapon.
* [[Mechanic]] - A close second for reliability and usefulness – a mechanism's [[quality]] directly impacts a trap's chance to hit its target, and an artifact lever or trap will make a room's value skyrocket (even if unlinked!). Note that, despite popular belief, traps made with artifact mechanisms can still jam ([https://www.reddit.com/r/dwarffortress/comments/wj2ego/i_thought_traps_made_with_artifact_mechanisms/ source]).
* [[Armorsmith]] – Similarly valuable, having a decent chance to create something with exceptional value for your military (or at least one member of it). However, similar to weapons, this requires manipulating available material to avoid getting [[Armor#Material|soft]], useless gold or lead [[armor]] pieces. Additionally, boots and gauntlets are created individually, rather than in pairs. Good luck.
* [[Furniture]]-making skills ([[Mason]], [[Miner]], [[Carpenter]], [[Blacksmith]], [[Glassmaker]]) – Artifact furniture is unbreakable by building destroyers and provides otherwise-impossible fortress defense options. For example, a dwarf with a preference for doors, hatches, or floodgates will always produce that item, which can then be locked against many enemies that would otherwise break through. Similar to mechanisms, it can provide a huge boost to a room's value, and placing an artifact item where all can pass by to admire it will be good for general morale. Note that Miners are treated the same as Masons, both of whom will produce rock furniture (which is a remnant of when Masons performed the work of a Stone Carver). Also note that Stone Carvers only produce crafts while moody. Carpenters and Blacksmiths can also produce [[bucket]]s, which can be used in various work stations or a [[well]]. Glassmakers can also produce trap components, which would rate them higher on the list were it not for their chance to produce <s>useless</s> pretty crafts - don't forget about [[display furniture]]!

The remaining skills are quite odds-against. Chances are, they will produce items only useful to display or wear, and there's little chance of creating a truly useful and valuable item.
* [[Bowyer]] – While moody Bowyers can create artifact wood/bone [[crossbow]]s of great accuracy, they also have an equal chance to produce a [[blowgun]] or [[bow]]. Also, wooden crossbows make for poor melee weapons, should it come to that, so the skill falls well below the metal equivalent.
* [[Metal crafter]], [[Gem cutter]], [[Gem setter]] – Metal Crafters can produce [[chain]]s, which can be used in the creation of a [[well]]. Gem Cutters and Setters can produce furniture made solely of gems, which is otherwise impossible. However, each of these skills will most likely create a [[craft]] (Gem cutters and setters, notably, have a 50% chance to create a perfect gem instead of anything else).
* Other armormakers ([[Leatherworker]], [[Tanner]], [[Bone carver]]) – Shields can be made by Leatherworkers or Tanners, and all listed skills can create artifact leather/bone armor pieces, which could be better-suited for Marksdwarves (who ''usually'' avoid close-combat). Leatherworkers can also create normal clothing, mentioned next.
* [[Clothier]], [[Weaver]] – While these dwarves can create an artifact [[rope]], which is useful for a [[well]], they are more likely to create clothing, which can only be worn by a single dwarf. [[Adamantine]] clothing, however, is extraordinarily useful (especially [[cloak]]s). These garments provide meaningful protection, and (unlike normal Adamantine clothing) is rendered immune to wear due to its status as an artifact.
* Craft-producers ([[Engraver]], [[Stone crafter]], [[Stone carver]], [[Stonecutter]], [[Wood crafter]]) – These skills lack any redeeming potential artifacts which the other craft-producing skills possess (notably, [[Metal crafter]], [[Glassmaker]], [[Bone carver]], [[Gem cutter]], and [[Gem setter]]) and only produce [[craft]]s – surprisingly valuable trinkets in the form of amulets, totems, rings, figuringes, or (at best) crowns, which at least ''sound'' impressive.
:* [[Peasant]]s, defined here as having no moodable skill, always produce from the crafts list. Therefore, it's always a good idea to have every newly-arrived "peasant" (looking at you, Urist McPotashmaker) craft at least one item from the moodable skill of your choice, to avoid such a tragic waste of dwarfcraft.

== Types of moods ==
For each of the following types of moods, the first message is how the mood is [[Announcement|announced]]; the second message appears in the dwarf's profile when he or she is viewed with the {{K|v}} key. All moody dwarves will have "Strange Mood" listed as their active task and are "quite content", regardless of any recent [[thought]]s they may have had.

=== Fey ===
* {{Gametext|<dwarf> is taken by a fey mood!|7:1}}
: ''Has the aspect of one fey!''

This is the most basic strange mood. Fey dwarves will clearly state their demands when the workshop they are in is examined.

=== Secretive ===
* {{Gametext|<dwarf> withdraws from society...|7:0}}
: ''Peculiarly secretive...''

Secretive moods are the same as fey moods, except a secretive dwarf will sketch pictures of their required materials instead of clearly stating their demands if they cannot find what they need. Descriptions of all these [[#Demands|secretive requirements]] can be seen only by viewing the workshop that the moody dwarf has claimed, with {{k|q}}, and then only while the dwarf is waiting inside it. More than one "picture" is likely; these will cycle through the entire list automatically if any one is not available. (Since materials are gathered ''in order'', it's quite possible that only one of a long list is needed to allow the moody dwarf to continue on their project. If the dwarf has gathered some of the materials (seen as "tasked" when looking at the workshop with {{k|t}}), then the next in the list is what they are looking for.)

=== Possessed ===
* {{Gametext|<dwarf> has been possessed!|5:1}}
: ''Possessed by unknown forces!''

Possessed dwarves have cryptic material requests, and have the unfortunate distinction of not receiving any experience upon the successful construction of an artifact. No controllable circumstances lead to a possessed mood instead of one of the more desirable fey or secretive moods, it is purely luck-based. Possessed dwarves will mutter the name of the artifact they are working on (which, under some circumstances, might end up being ''their own name'') once they have all the materials they need.

Possession is the only mood that does '''''not''''' result in a jump in [[experience]].

A possessed dwarf that "keeps muttering <name of the artifact>..." has already gathered everything they need.

=== Fell ===
* {{Gametext|<dwarf> looses a roaring laughter, fell and terrible!|5:0}}
: ''Has a horrible fell look!''

A dwarf that goes into a fell mood will try to take over a [[butcher's shop]] or a [[tanner's shop]]. If neither are available, any other workshop will be used instead. The dwarf will then ''murder'' the nearest dwarf, drag the corpse into the shop and make some sort of object out of dwarf [[leather]] or [[bone]]. The unfortunate dwarf is killed on the spot – no dragging to the workshop, just sneaking up behind them, killing them, and dragging their corpse to the workshop. Once the artifact is completed, the fell dwarf will become a legendary [[bone carver]] or [[leatherworker]]. Only unhappy dwarves may enter a fell mood.

Amusingly, it seems fell dwarves can also murder [[ghost]]s. If they do, they will murder a living dwarf as well, since ghosts obviously don't yield a corpse to butcher.{{bug|4681}}

Aside from the loss of a potentially important dwarf in the wrong place at the wrong time, there doesn't seem to be any downside to a fell mood. The end result is always an artifact and a legendary craftsdwarf. Since the only ingredient used (a dwarf) is available in abundance, a fell mood will only fail if the fell dwarf is completely isolated from other dwarves, or if the proper workshop does not exist.

If no one is around to witness the murder, whichever dwarf Urist McEmo decides to slaughter will be reported as missing some time after their death. If the murder is witnessed (or if the <s>idiot</s> dwarf in fell mood reports themself), the moody dwarf will be subject to dwarven [[justice]].

A fell mood "reagent" is not merely limited to dwarves, however. In truth, any intelligent creature can be subjected to the creative imagination of the terrible laughing dwarves. Legends speak of [[werebeast]] attacks being halted by timely appearances of fell dwarves. Indeed, there are even whispers of fell mood dwarves smuggling [[clowns]] from the [[circus]] into their forts to be used in their strange artifice. In cases where an unusual intelligent creature made from a material such as [[vomit]] happens to fall prey to the depredations of a fell dwarf, the resultant crafted object will be selected randomly from the list of craftable [[shell]] items, but will be made from the victim's primary material instead of shell.

=== Macabre ===
* {{Gametext|<dwarf> begins to stalk and brood...|0:1}}
: ''Brooding darkly...''

Macabre moods are similar to fell moods, but the dwarf will not murder a fellow dwarf. A macabre dwarf may require [[bone]]s, [[skull]]s, or vermin [[remains]]; if you do not happen to have any, you will have to make some, e.g. by butchering an animal and/or allowing a [[cat]] to go hunting, or let the moody dwarf go [[insane]]. Like fell moods, only unhappy dwarves can enter macabre moods.

==Caveats==
* Shells are perhaps the most difficult-to-obtain material for a strange mood, though there are several {{catlink|Shell|creatures}} that produce shells. Some of these, such as [[armadillo]]s and [[common snapping turtle]]s, are butcherable. Vermin from [[fishing]] are the easiest and most renewable source of shells. [[Pond turtle]]s are common in many embarks in [[murky pool]]s, but usually only appear in small numbers, and can go extinct easily. A stream or river almost guarantees a functionally inexhaustible supply of [[mussel]]s. [[Nautilus]]es can also serve as sources of shells when cleaned at a fishery. Nevertheless, shells are rare and hard to acquire. Currently, the only way of trading for shells is to hope that the [[elven]] caravan brings some tamed shell-producing large creature. Traded [[pond turtle]]s are ''processed'' fish (with the shells already removed). Tamed vermin with shells cannot be butchered for their shells, since the only way to get a vermin's shell is to [[Fish cleaning|clean]] it. Since all shelled non-vermin animals are [[exotic pet|exotic]], only elves will bring them. If you should be fortunate enough to acquire some breeding, shelled, butcherable animals, it's probably worth keeping a breeding pair around in case of future need. Only dwarves with a [[preference]] for shells will demand shells in a strange mood.
* All demands for cloth are for a specific generic type (plant, silk, or yarn). Clothiers and Weavers will demand [[adamantine]] cloth if any is available, otherwise the type will be the generic form of the dwarf's first cloth preference, or a randomly chosen variety if the dwarf has no preference (or if the cloth is for a decoration, not the primary material). Types of cloth your fortress has not produced are '''not''' excluded, so it's best to keep a few bolts of each type of cloth in reserve.
* Should the claimed workshop be a [[magma forge]] and lose power due to insufficient magma beneath it, the mood will fail immediately and the dwarf will go [[insanity|insane]]. Should the forge be in danger of losing power, you should forbid it before it is claimed and wait until it is powered up reliably. Once magma forges are built, at least some dwarves will no longer be satisfied with a regular forge. Similarly, if a workshop claimed by a dwarf is deconstructed, destroyed or [[Creature_token#BUILDING_DESTROYER|toppled]] the mood will immediately fail and the dwarf will go insane.
* If one of a claimed workshop's building materials are selected and toggled to forbidden, this will also cause the mood to immediately fail and the dwarf to go insane.
* The mood's primary material will only be mentioned ''once'' in the dwarf's requests, even if the dwarf wants more than one unit of it. [http://www.bay12forums.com/smf/index.php?topic=75139.0]
* The item type of the artifact to be created is not decided until the instant the mood ''ends''. Saving (even after a dwarf has begun to gather materials) will allow you to reload and the result may be a different artifact (unless the moody dwarf's preferences force a particular item type). If you want to get an artifact platinum warhammer, make sure to have platinum nearby and/or block access to any other materials.
* You can restart the artifact creating process, even after the dwarf has gathered most of the components, by forbidding the claimed items (use {{k|t}} to view the contents of the workshop, select the undesired material, and press {{k|f}} to forbid it). If other items of that type are available, the dwarf will immediately switch to them.
* Each request for bones is actually a request for any kind of bone [[stack]], not individual bones. If they request bones more than one time, then they need that many stacks. Any size stack will do and the entire stack will be used. Bones come from [[butcher]]ing, rotted animal corpses do not count, even if they are skeletons. [[Tame]] animal corpses, whether they were pets or strays, can only be butchered as a result of a [[Butcher#Slaughtering|slaughter]] task, tame animals that died by any other means cannot be butchered. Slaughter a puppy. [http://www.bay12forums.com/smf/index.php?topic=105002.0]

== Demands ==
Once a workshop is claimed, the dwarf will begin collecting materials. Each artifact will require 1-3 "base items" and up to 7 additional items for decorations. The dwarf may well need several items of one material!

If the moody dwarf remains idle, then the necessary materials are not available. [[Forbid|Forbidden]] items must be reclaimed ({{K|i}} – {{K|F}}) before they may be used, but moody dwarves will ignore settings regarding [[economic stone]]. Click on the workshop to receive a series of clues about what the dwarf needs. '''Hints that stay active for longer than 2 seconds mean that multiple pieces of that material will be required; each single demand will be displayed for 2 seconds, so if it says "gems... shining" for 6 seconds, 3 gems are demanded. However, the mood's primary material will always be shown for only 2 seconds, even if more than one is required.''' Materials will always be fetched ''in order'', so if at least one item has already been retrieved (the items will show up with "TSK" ("task") next to them when the workshop is viewed with the {{K|t}} context menu), it will usually be possible to tell what item is required next.

If you want your dwarves to construct their artifacts out of ''valuable'' materials, instead of whatever useless thing happens to be close at hand, you can selectively forbid types of material through the stocks screen so that only the material you want them to use is available; though this might interfere with the normal crafting operations of your fortress, the disruption is generally short-lived (as long as you remember to unforbid them again afterwards!). You can even forbid something a moody dwarf is carrying (which may be necessary sometimes, since while they are not waiting in the workshop, they will not tell you what they need); the dwarf will finish hauling it to the workshop, but then immediately go searching for another. This trick can mean the difference between a bauxite statue decorated with moss agates and a native platinum statue encrusted with diamonds. Be aware that this may not always work – see below for more information.

Burrows allow even better control over a moody dwarf's material usage. Simply by creating a burrow around the claimed workshop and another part over the desired material, a moody dwarf can be controlled without forbidding every single stone in the fortress. A moody dwarf will follow the burrow definitions just like a regular worker, but be mindful that they will not leave the burrow to get materials that are outside of their assigned burrow. A problem can arise when bones from an outside refuse stockpile are needed by a moody dwarf that is assigned to a burrow.

The various demands are translated here:

:{| class="wikitable" style="text-align:left;width:90%;"
|-
! Material
! Fey
! Macabre
! Secretive
! Possessed
|-
|
| <dwarf> screams "I must have <demand>!"
| <dwarf> broods "Yes. I need <demand>."
| <dwarf> sketches pictures of <demand>.
| <dwarf> mutters "<artifact> needs <demand>..."
|-
| [[Stone]]
| colspan=2 | rock
| a quarry
| stone... rock
|-
| Stone/metal [[block]]s
| colspan=2 | rock blocks
| square blocks
| blocks... bricks
|-
| [[Wood]]
| colspan=2 | wood logs
| a forest
| tree... life
|-
| Metal [[bar]]
| colspan=2 | metal bars
| shining bars of metal
| bars... metal
|-
| [[Gem]]s (cut)
| colspan=3 | cut gems
| gems... shining
|-
| [[Gem]]s (raw)
| colspan=3 | rough gems
| rough... color
|-
| Green [[glass]]
| colspan=2 | raw green glass
| glass
| raw... green
|-
| Clear glass
| colspan=2 | raw clear glass{{verify}}
| glass and burning wood
| raw... clear
|-
| Crystal glass
| colspan=2 | raw crystal glass{{verify}}
| rough gems and glass
| raw... crystal
|-
| [[Bone]] [http://www.bay12forums.com/smf/index.php?topic=105002.0;topicseen stack]
| colspan=2 | bones
| skeletons
| bones... yes
|-
| [[Shell]] {{cite talk/this|Re:_.22Verify.22_on_the_shell_row_of_the_demands_table}}
| colspan=3 | shells
| a shell...
|-
| [[Leather]]
| colspan=2 | tanned hides
| stacked leather
| leather... skin
|-
| [[Cloth]] (plant fiber)
| colspan=2 | plant cloth
| stacked cloth
| cloth... thread
|-
| [[Cloth]] (silk)
| colspan=2 | silk cloth
| stacked cloth
| cloth... thread
|-
| [[Cloth]] (yarn)
| colspan=2 | yarn cloth
| stacked cloth
| cloth... thread
|-
| [[Skull]]{{verify}}
| colspan=2 | body parts
| death
| a corpse
|}

Dwarves in macabre moods may also say "Leave me. I need... things... certain things", in which case they want special items, such as [[skull]]s or vermin [[remains]]. Moody dwarves demanding rock blocks will also accept [[ceramic]] bricks and blocks forged from metal bars.

*The first item demanded by the dwarf is based on the moodable skill being used – stoneworkers (miners, engravers, masons, stone crafters, and mechanics) will demand boulders, woodworkers (carpenters, wood crafters, and bowyers) will demand logs, leatherworkers and tanners will demand leather, weavers and clothiers will demand cloth, metalworkers will demand metal bars, gem cutters/setters will demand rough gems, glassmakers will demand raw glass, and bone carvers will demand bones.
**Metalworkers will demand adamantine wafers or divine metals if any are available (unforbidden). If not, they will demand a preferred metal ''if'' you have ''ever'' smelted any bars of it – fey moods will state this outright, while for secretive moods and possessions, you will need to check the dwarf's [[preferences]] to see which metal they like. Metal bars acquired via [[trade]] or by melting down items (such as the 'Goblinite' technique) do ''not'' count as smelted. Otherwise, they will select any available metal(s).
**Weavers and clothiers will demand [[adamantine]] cloth if any is available (unforbidden). If not, they will demand a generic type of cloth (silk, plant fiber, or yarn) that matches a specific cloth preference (e.g. a dwarf that likes cave spider silk will require ''any'' type of silk cloth, and a dwarf who likes more than one type of cloth will demand whichever one appears first in their list). Dwarves without a cloth preference will demand a generic type at random.
**Glassmakers will demand their preferred type of glass ''if'' you've produced any of it (or if it's green glass); if they don't prefer any type of glass, they will randomly select one type of glass you've produced (though they will always assume you have created green glass). Note that acquiring raw glass from a caravan does ''not'' count as producing it.
**Dwarves in macabre moods will select 1-3 vermin remains, stacks of bones, or skulls.
**Bone carvers will demand shells if they like a type of shell; if not, they will demand bones.
**All preference-based material requests are decided the instant the mood begins – by the time the workshop is claimed, it is too late to change the dwarf's mind.
*The remaining "decoration" items are selected randomly from the following list: wood logs, metal bars, small gems, rock blocks, rough gems, boulders, bones, leather, plant/silk/yarn cloth, or raw glass (green/clear/crystal, based on what you've produced).
**Decoration items will never be the same type as the primary mood material.
**Certain mood professions will also explicitly avoid using certain items for decorations – most of these match up with the primary mood material, but miners, engravers, masons, and stonecrafters will additionally avoid requesting rock blocks.
**If you have not produced any raw glass in your fortress, moody dwarves will never request it.
**Dwarves in macabre moods have a 50% chance to replace each decoration item with either remains or bones.
*Gem cutters and gem setters have a 50% chance of only gathering a single rough gem and nothing else – when they do this, they produce a "perfect gem" with a single decoration.

Once all materials have been gathered, viewing the workshop with {{K|q}} will display a special message depending on the type of mood:
* Fey – "<dwarf> works furiously!"
* Secretive – "<dwarf> works secretly..."
* Possessed – "<dwarf> keeps muttering <artifact>..."
* Macabre – "<dwarf> works, darkly brooding..."
* Fell – "<dwarf> works with menacing fury!"

== The mechanics of moods ==

=== Frequency===
When a fortress is started, an internal counter is set to 1000. Every 100 frames (12 times per day), this counter is decremented by 1, running down to zero in about 3 months. When the counter would ordinarily be decremented and it has already reached zero, there is a 1 in 500 chance that a strange mood will strike. This means that, once all conditions are met and the clock is ticking, while there is approximately a 2.4% chance of a strange mood per day, or a ~52% chance of at least one strange mood per month, there is no guarantee when a mood will strike – might be sooner, might be (almost) never. The counter resets to 1000 once a mood begins and continues counting down as the mood progresses, resetting again if it reaches zero before the mood finishes.

=== Conditions ===
In order for a dwarf to be struck with a strange mood, three conditions must be met:
:* There is no currently active strange mood,
:* The maximum number of artifacts is not met,
:* There are at least 20 eligible creatures ''(see below)'', including those who have already created artifacts.

If all three of these conditions are true, the game may trigger a strange mood according to the frequency.

==== Maximum number of artifacts ====
The maximum number of artifacts in any one fortress is limited by the lower of:
* The number of items created divided by 100.1 Mined-out rock ''does'' count as an "item created", though it is not clear whether bolts or units of drink are counted individually.
* The number of revealed [[subterranean]] tiles divided by 2304 (this is an area equivalent to a 48x48 square). Once you discover and explore the [[cavern]]s and [[magma sea]], this limit becomes largely irrelevant, and using a [[utilities#DFHack|"reveal" utility]] will eliminate it altogether, though strip-mining an area entirely and exposing it to the surface will count ''against'' this.
:1 – actually the sum of all items by type ''and'' by type+subtype+material, divided by 200. Furthermore, destroying items does '''not''' decrement these counters, so casting and mining [[obsidian]] will count toward this.

==== Eligibility ====
First and foremost, only creatures with the {{token|STRANGE_MOODS|c}} token are capable of entering a strange mood. Additionally, they must be a permanent resident of your fortress - visitors are exempt.

The deciding factor for eligibility is a dwarf's actual [[profession]]. ''(Note that "[[Skill#Professions|custom professions]]" have no effect on this!)'' Thus, dwarves may enter strange moods regardless of what skills they have or don't have, so long as they are of an acceptable profession. Dwarves who have already created an artifact are not eligible to create another, and since every mood ends in either an artifact or death, every dwarf may enter at most one mood. Dwarves who have obtained one or more legendary skills without creating artifacts ''may'' enter strange moods and will simply become even ''more'' legendary.

On-duty dwarves with a [[Soldier#Soldier professions|military profession]] other than "Recruit" ''cannot'' enter moods. Incidental military skills make no difference – eligibility (and weighting) depends purely on the actual ''[[profession]]'' as listed at the time (with the exception of unit leaders, whose on-duty and off-duty titles are the same). Soldiers are still capable of entering moods if they are ''off duty'' and thus in Civilian mode, but you don't have to worry about your axedwarves getting a burst of inspiration mid-combat, and then wandering off to make a highest-quality craftsdwarfship gabbro scepter, decorated with cow bone menacing spikes, cow bone rings and a cow bone image of hamster men while the trolls sack your settlement.

Children may enter moods, but babies will not. Children who enter strange moods will usually attempt to create an artifact appropriate for a bone carver, wood crafter, or stonecrafter. They will also gain experience if they complete the artifact, just like an adult dwarf would--unless the mood is a possessed mood, in which case (''as extensively noted above'') they do not.
Any other profession is eligible to enter a mood, but not all have the same ''chance'' to enter a mood.

:''('''Note''' – Specifically, and to avoid previous misunderstandings, [[Strand extractor]], [[Clerk]]/[[Administrator]]/[[Trader]], [[Doctor]] (and related), [[Soldier#Recruits|Recruit]] and [[Child]] ''are'' moodable professions.)''

There are several additional factors which will prevent a dwarf from entering a mood:
* Being unable to pick up items ("cannot grasp")
* Being dragged by/dragging another unit (off to [[jail]]/leading livestock to a [[cage]], [[chain]], [[pasture]], [[Activity zone#Pit/Pond|pit/pond zone]], or to the [[butcher's shop]] or [[farmer's workshop]])

=== Chance ===
When determining who will have a strange mood, each eligible dwarf is put into a weighted lottery, where the chance of being selected is based on the dwarf's [[profession]]. Most professions receive 6 "tickets", but some receive additional tickets to improve their odds.

{| class="wikitable" cellspacing="0" border="2" cellpadding="5"
|-
! Weighting
! Professions
|-
| 21 ||Armorer, Blacksmith, Bone Carver, Clothier, Craftsdwarf, Jeweler, Gem Cutter, Gem Setter, Glassmaker, Leatherworker, Metalcrafter, Metalsmith, Stonecrafter, Weaponsmith, Weaver, Woodcrafter
|-
| 11 ||Bowyer, Carpenter, Stoneworker, Stone Carver, Woodworker
|-
| 6 ||Engraver, Mechanic, Miner, Tanner, and all other [[profession]]s (including Peasant).
|}

:'''''Example:''' What this means is: if you had 21 dwarves, made up of 20 eligible farmers, furnace operators, miners, woodcutters etc. (with 6 chances each) plus one Armorer (with 21 chances), that one Armorer would have a 21 in 141 chance (20 dwarves x 6 chances each = 120 + 21 chances more = 141 total) of the mood striking them. That's about 1 in 7, while the other 20 have a 6 in 141 chance each, or about 1 in 24. The odds are still against the armorer, but much better than for any other single dwarf.''

Note that not every profession has a moodable skill. A Soaper, Furnace Operator, or Strand Extractor can be taken by a mood, but that will not make those skills legendary, nor will they create an artifact bar of soap, bar of metal, or wafer of adamantine. The workshop a moody dwarf claims, and thus the resulting artifact they create, will always be based off their highest moodable skill, not necessarily the highest skill that determines their profession.

=== Timing ===
A dwarf will go [[Insanity|insane]] after exactly 50000 ticks (which, at 1200 ticks per day, works out to 41.66 days, or almost a month and a half) waiting for an item they demand. However:
*The insanity countdown is reset after every item they bring to the workshop.
*It doesn't run while they are out getting something, working on their construction or on their way to claim a workshop. Only during time spent idling without either the required workshop or a required item do they spiral towards madness.
*Dwarves currently under strange moods do not require food, drink, or sleep.

=== Fuel ===

{{D for dwarf}}

Curiously, [[metalsmith]]s in strange moods do not seem to require any [[fuel]] to complete their [[metal]] [[artifact]]s. It is believed that they, consumed by artistic passion, fuel the forges with their own beards, vigorously fanning the flaming hairs while they feed the furnace more beard. Such a sacrifice is a dwarf's own beard that only an artifact merits its removal. Only an artifact's completion can mollify its creator's shame; dwarves unable to complete this great pursuit go insane, not because of its failure, but because they cannot endure the inevitable humiliation.

Legend has it that the world's first [[elf]] once attempted to forge the world's most powerful artifact, imbued with magic to control all dwarves. But, because he could not suffer to cut a tree for fuel, he was unable to do so. Faced with no alternative, he kidnapped each of the seven ancient dwarves by tempting them with [[booze]], an unfamiliar drink to the first dwarves. He then forcefully shaved them and created [[charcoal]] from their beards.

Enraged by their loss, the dwarves set out to find the elf's home, based in the world's first tree. They startled the engrossed elf who fled with nothing but a handful of the tree's unborn children. After reclaiming the beard-charcoal, the dwarves set fire to this tree. Alight in flames hotter than the sun, the tree burned in what is believed to have been the world's hottest fire – a fire so hot that the tree's roots melted the inside of the earth, creating a worldwide [[magma sea]]. The elf watched this fire and swore revenge on the dwarves.

After realizing their beards could not be recovered from their charred state, the dwarves agreed to sprinkle the charcoal over the earth, as a gift and reminder to future dwarves. In doing so, they created the world's [[bituminous coal]] deposits. They then spent the next years searching for a way to create the drink they had been given. Discovering new drinks along their pursuit, the dwarves eventually perfected the hidden art of brewing booze and passed this emerging knowledge to coming generations.

== Artifacts created ==
The type of artifact created depends on the type of mood, the dwarf's highest moodable skill, and the base material. Masons and miners will always create some kind of stone furniture; bone carvers, a bone or shell object (including furniture); carpenters, a piece of wooden furniture; engravers and stone crafters, a stone craft; metalworkers, metal crafts, weapons, or armor (depending on the type of metalworker); weavers and clothiers, an article of clothing; tanners and leatherworkers, a leather armor or object. If a dwarf has no moodable skills, they will randomly select stone crafting, wood crafting, or bone carving as their mood skill and produce their artifact accordingly. The precise type of craft created is usually somewhat random, but if a dwarf has a personality preference for a particular item type, such as gauntlets or floodgates or crowns, and that thing is an available choice given the dwarf's profession, they are guaranteed to create an object of that type (if multiple preferences match, one will be randomly selected).

The first object grabbed by the dwarf will be the base material; all other materials will be used as [[decoration]]s. If a dwarf grabs a piece of [[chalk]] and makes a statue, for instance, it will be a "chalk statue", but an artifact can potentially include bone, cloth, gems, leather, metal, shell, stone, and wood decorations all at once. In some cases, a moody dwarf will produce an item which normally cannot be made from that material, leading to such odd constructions as an [[obsidian]] [[bed]], [[ruby]] [[floodgate]], or turtle [[shell]] [[cage]], but the actual item types available for each mood type are still very much restricted (e.g. only a glassmaker or jeweler can make a [[window]], and a moody clothier cannot produce an article of clothing that could not normally be made from cloth).

{| class="wikitable" cellpadding="4" style="border:1px solid black;border-collapse:collapse;text-align:left;"
|-
! Mood / Skill
! Artifact type
|-
| [[Armorsmith]]
| Each equipment item with [METAL] (mail shirt, breastplate, leggings, greaves, gauntlet, low boot, high boot, cap, helm, mask), any shield
|-
| [[Bone carver]] (bone)
| Each equipment item with [BARRED] (leggings, greaves, gauntlet, helm), any shield, instrument, toy, door, bed, chair, table, statue, chest, bin, armor stand, weapon rack, cabinet, coffin, floodgate, hatch cover, grate, chain, cage, animal trap, figurine, amulet, scepter, crown, ring, earring, bracelet, any weapon, any trap component†
|-
| [[Bone carver]] (shell)
| Each equipment item with [SCALED] (leggings, gauntlet, helm), figurine, amulet, crown, ring, earring, bracelet, chain, cage, animal trap, instrument, toy
|-
| [[Bowyer]]
| Each ranged weapon (crossbow, bow, blowgun)
|-
| [[Carpenter]]
| Door, bed, chair, table, statue, chest, bin, armor stand, weapon rack, cabinet, coffin, floodgate, hatch cover, grate, cage, barrel, bucket, animal trap, splint, crutch
|-
| [[Clothier]]
| rowspan=2| Each equipment item with [SOFT] (dress, shirt, tunic, toga, vest, robe, coat, cloak, cape, trousers, loincloth, thong, short skirt, skirt, long skirt, braies, glove, mitten, sock, sandal, shoe, chausses, cap, hood, mask, turban, head veil, face veil, headscarf), bag, rope
|-
| [[Weaver]]
|-
| [[Engraver]]
| rowspan=4| Figurine, amulet, scepter, crown, ring, earring, bracelet, goblet, instrument, toy
|-
| [[Stone crafter]]
|-
| [[Stonecutter]]
|-
| [[Stone carver]]
|-
| Fell Mood
| rowspan=3| Each equipment item with [LEATHER] (dress, shirt, tunic, toga, vest, robe, coat, cloak, cape, armor, trousers, loincloth, thong, short skirt, skirt, long skirt, braies, leggings, glove, mitten, sock, sandal, shoe, chausses, low boot, high boot, cap, hood, mask, turban, head veil, face veil, headscarf, helm), any shield, bag, backpack, quiver, instrument
|-
| [[Leatherworker]]
|-
| [[Tanner]]
|-
| [[Gem cutter]]
| rowspan=3| Perfect gem‡, door, bed, chair, table, statue, box, armor stand, weapon rack, cabinet, coffin, floodgate, hatch cover, grate, figurine, amulet, scepter, crown, ring, earring, bracelet, chain, flask, goblet, cage, barrel, bucket, animal trap, window, instrument, toy
|-
| [[Gem setter]]
|-
| [[Glassmaker]]
|-
| Macabre Mood (vermin remains)
| Amulet, bracelet, earring
|-
| [[Mason]]
| rowspan=2| Door, bed, chair, table, statue, quern, millstone, coffer, armor stand, weapon rack, cabinet, coffin, floodgate, hatch cover, grate
|-
| [[Miner]]
|-
| [[Mechanic]]
| Mechanism
|-
| [[Metal crafter]]
| Figurine, amulet, scepter, crown, ring, earring, bracelet, chain, flask, goblet, instrument, toy
|-
| [[Metalsmith]]
| Door, bed, chair, table, statue, chest, armor stand, weapon rack, cabinet, anvil, coffin, floodgate, hatch cover, grate, cage, barrel, bucket, animal trap, pipe section†, splint, crutch
|-
| [[Weaponsmith]]
| Any weapon, any trap component†
|-
| [[Wood crafter]]
| Figurine, amulet, scepter, crown, ring, earring, bracelet, goblet, instrument, toy
|}
:† ''chance of selection for this entry is reduced by 90%''
:‡ ''this item may only be selected at the beginning of the mood (50% chance)''

If your dwarf does not have a preference for any possible items, the game will randomly select one from the list. Entries with "any" are treated as collective entries with a single chance and will randomly choose a subtype which your civilization is capable of making, while entries with "each" are distinct (e.g. an Armorsmith has 11 item choices, and one of those can turn out to be either a Shield or a Buckler). This explains why bowyers and clothiers will regularly produce foreign artifacts, while weaponsmiths will not unless they have exotic preferences.

== Success ==
Once created, most [[artifact]]s will be available for use just like a normal item of its type. Artifact [[armor]] and [[weapon]]s gain extra bonuses in combat, while artifact clothing is immune to [[wear]]. Artifact mechanisms installed in weapon traps will improve attack rolls. Artifact furniture is useful for raising the value of a [[noble]]'s room. Artifact mechanisms, trap components, or weapons in [[weapon trap|weapon trap]]s can also boost a room's value considerably. Other artifacts that can be used in construction (such as [[barrel]]s, [[bucket]]s, and [[anvil]]s) may be used similarly. Artifact [[door]]s and [[hatch]]es are immune to [[building destroyer]]s, and artifact [[cage]]s can even hold gnawing vermin. All artifacts can be displayed in a [[display case]] or on a [[pedestal]], or [[trade]]d to a [[caravan]] for supplies.

Successfully creating an artifact grants a very strong happy [[thought]] (enough to make the creator totally ecstatic for several months) as well as granting the creator partial ''immunity to insanity'' – even if your fortress is left in a terrible state, any dwarf who has created an artifact is exempt from going [[insane]] due to prolonged unhappiness. The dwarf may also cry, found as a coating of dwarf tears on both their eyes.

== Failure ==
If you can't provide the desired workshop and all the required component materials within a couple of months, the dwarf will go [[insanity|insane]], which cancels the mood and the artifact. As if that's not bad enough, any dwarf who goes insane will soon die, one way or another.

A dwarf who is '''stark raving mad''', '''melancholy''', or '''catatonic''' is harmless to others (until they die and start a [[tantrum]] spiral), but a '''berserk''' dwarf will attack other dwarves and possibly pull levers at random. You may want to station a squad nearby or assign a few war dogs to the dwarf on the chance that they will lash out. If you build your workshops inside enclosed rooms with doors you can also lock the moody dwarf in the room until he or she starves. In extreme cases, building a wall around an open workshop is the best precaution.

==Bugs==
There are many bugs reported related to moody dwarves. As has been the case in 40d, most turned out to be (understandable) failures of the player to grasp the mechanics of artifact creation and demands. ([http://bay12games.com/dwarves/mantisbt/view_all_bug_page.php Bug tracker])
* If a dwarf dies due to failing to complete an artifact, a memorial made to the dwarf will read that the dwarf did create it, despite the failure, and will even list the name of the artifact that never came to be. {{bug|3640}}
* When producing an item that is normally made in pairs (gloves, boots, etc.), only a single artifact will be created.
* Attacking a dwarf who fails their mood with your militia may result in a loyalty cascade. {{bug|7107}}
* Dwarves entering a strange mood when isolated (e.g. on a stepladder) cause severe lag. {{bug|8698}}
* If the mood primary component is forbidden while working, but the strange mood still has other items tasked, the result is an iron artifact. {{bug|5625}}
* If the dwarf starts constructing the artifact and is scared off by a hostile creature before completion, they may become stuck. {{bug|9833}} Removing the floors around them, then dropping an item on them should cause them to dodge, fall, and return to the workshop.{{cite forum|161598}}

== Troubleshooting ==

'''Problem''': Moody dwarf does not claim a workshop
:'''Solution''': Check for highest moodable skill and build the corresponding workshop. If no moodable skills, build a craftsdwarf's workshop. Once [[magma forge]]s have been built, some dwarves may demand to work at a magma-powered forge or furnace while others might still insist on a coal-powered one. If a forge is needed, make sure you built a forge, not smelter. Note that [[forbid]]den workshops cannot be claimed. Verify if the dwarf is assigned to a burrow and/or if there is a civilian alert set to a burrow. If so, verify that the burrow allows access to the workshop being sought after.

'''Problem''': Moody dwarf waits in claimed workshop
:'''Solution''': Desired material is unavailable. Determine which material is requested next (materials are collected in the same order as shown in the dwarf's request list) and make some available, if possible. Be aware that some lists contain duplicates and you will need to make a seperate stack available for each one. Note that dwarves with [[preference]]s may demand a specific type of material ([[brass]] bars or [[yarn]] cloth, for example). [[Forbid]]den and inaccessible materials cannot be collected, nor can material located outside the moody dwarf's [[burrow]].

'''Problem''': No dwarf has entered a mood for a long time
:'''Solution''': Strange moods require at least 20 dwarves; if you have that many, you've probably hit one of the two caps. Exploring the caverns can increase the number of revealed tiles very quickly, while [[craft]]ing [[goblet]]s will quickly raise your item count; [[exploratory mining]] will count toward ''both'' caps, simultaneously revealing tiles and producing boulders, though more slowly than exploring or crafting. Exposing excavated terrain to the sky is counterproductive, as it will ''lower'' your artifact cap (since the cap only counts revealed ''subterranean'' tiles).

'''Problem''': Moody dwarf wants stacked cloth, but all types are available and he's not moving
:'''Solution''': Dwarves will not take items from active hospitals. If you have no cloth available outside of hospitals, try disabling or temporarily removing the hospital designation from their zones. They will then proceed to take new items, even if they don't go for the cloth right away. It is also possible that the desired cloth has been partially consumed in order to make wound dressings.

==Trivia==
* [https://www.youtube.com/watch?v=K6454rENbtc Strange Moods], by Dabu, is the fourth track in the first Premium [[soundtrack]] volume, occasionally playing during [[Fortress mode]].

{{D for Dwarf}}
It is widely said that Tarn Adams has been in the grips of a fey mood for two decades now, and we are playing his artifact. However, neither [[human]]s nor [[giant toad]]s can enter strange moods, so this must surely be a joke.

{{Category|Fortress mode}}
{{Category|Dwarves}}
[[Ru:Strange mood]]

Lua script examples

2025-11-21T04:55:45Z

DPhKraken: /* Tweaking creatures */ Added general Lua select example

{{av}}
{{Modding}}
{{Main|Lua scripting}}
Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``[https://github.com/Putnam3145/DF-Raws/tree/master/vanilla_procedural/scripts data/vanilla/vanilla_procedural/scripts/]``.
__TOC__


==Helper functions==

===Search by reaction class===
This script returns a table of all inorganic materials with a given {{token|REACTION_CLASS|md}}. The ``mat`` table also has ``reaction_product_class``, which includes both {{token|MATERIAL_REACTION_PRODUCT|md}} and {{token|ITEM_REACTION_PRODUCT|md}} IDs.
{{Scriptdata
|title=get_all_by_reaction_class()
|script=
function get_all_by_reaction_class(rc)
local valid={}
for i,inorg in ipairs(world.inorganic.inorganic) do
for _,class in inorg.mat.reaction_class do
if class==rc then
valid[#valid+1]=inorg
end
end
end
return valid
end}}

==Languages==

===Identity language===
This makes a [[Language token|language]] called ``GEN_IDENTITY`` which is like: "Abbey abbeyabbeys the abbey of abbeys" - i.e. it's the "English" language you might see occasionally. It is present in ``vanilla_procedural`` and can be used for {{Token|TRANSLATION|entity}} by default.

{{Scriptdata
|title=GEN_IDENTITY
|script=
languages.GEN_IDENTITY=function()
-- just to demonstrate the absolute most basic method of generating one of these
-- also so that you can just mod stuff to use GEN_IDENTITY
local tbl={}
local unempty = function(str1, str2)
return str1=='' and str2 or str1
end
for k,v in ipairs(world.language.word) do
local str=''
str=unempty(str,v.NOUN_SING)
str=unempty(str,v.ADJ)
str=unempty(str,v.VERB_FIRST_PRES)
str=unempty(str,string.lower(v.token))
tbl[v.token]=str
end
return tbl
end}}

===Kobold language===
This generates a language made of {{token|UTTERANCES}}. This is essentially a proper translation based on the [[kobold language]]. Note that the hardcoded ``utterance()`` function generates words independently of any existing words in the language, so you may get duplicate words.

{{Scriptdata
|title=GEN_KOBOLD
|script=
languages.GEN_KOBOLD=function()
local tbl={}
for k,v in ipairs(world.language.word) do
tbl[v.token]=utterance()
end
return tbl
end}}

==Generators==

===Non-random generated material===

Here's an example of an object registered through the ``do_once`` table. There are no random elements, it is equivalent (save for being {{token|GENERATED|mat}}) to an object defined through [[Material definition token]]s and registered through the ``raws.register_inorganics()`` function. It also prints itself to the lualog for debugging purposes.

{{Scriptdata
|title=Single material
|script=do_once.cobalt = function()
local lines = {}

-- basic inorganic definition
lines[#lines+1] = "[INORGANIC:COBALT]"
-- add [GENERATED] to save properly
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling cobalt]"
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:COBALT]"
lines[#lines+1] = "[SPECIAL]"

raws.register_inorganics(lines)

-- show in lualog
print_table(lines)
end
}}
 
You can register multiple objects at the same time. This script takes a table of color tokens, and makes a metal named after each of them, with a corresponding cheaty adventure reaction.

{{Scriptdata
|title=Chromatic metals
|script=do_once.chromatic_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- make a metal for each color token
for k,v in pairs(color_tokens) do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:CHROMATICMETAL"..v.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- look up the metal's color in the world table
-- using string.lower(v) would result in "moss_green"
local metalname = world.descriptor.color[v].name
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

-- appearance
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..v.."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:CHROMATICMETAL"..v.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:CHROMATICMETAL"..v.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===Random generation===

Here's an example of various DF-specific randomizers in use:
* ``trandom()`` is used to determine how many metals generate this way.
* ``utterance()`` generates utterances from the [[Kobold language]], e.g. "gorsnus", "stogodilmus", "gaylgis"
* ``pick_random_no_replace()`` determines the color from the table, but removes the rolled value so there's no repeats.

{{Scriptdata
|title=Kobold metals
|script=do_once.kobold_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- trandom() is expressed as (1dN)-1 because it uses C++ math that starts at 0
local max_loops = trandom(10)+1

-- create 1-10 metals
for i = 1,max_loops do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:KOBOLDMETAL"..i.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- this is the kobold name function
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"
-- no_replace removes the value from the table
-- we don't need a fallback because there's more values than metals
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random_no_replace(color_tokens).."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:KOBOLDMETAL"..i.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:KOBOLDMETAL"..i.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===New divine metals===

Many of the tables used by vanilla procedural objects are global, and thus can be added to or overwritten by mods. You can add new metal descriptions for divine metal pretty easily, for example:

{{Scriptdata
|title=Laughing metal
|script=
metal_by_sphere.CHILDREN={
name="laughing metal",
col="7:0:1",
color="WHITE"
}
}}
 
You can also add alternatives to the default divine metal function, such as one based on the aforementioned kobold metals.
Vanilla divine metal uses ``metal_by_sphere`` to determine its properties, and is thus valid only if the input sphere has an entry in that table.
Note that even if the weights are nominally the same; because it is valid for all input spheres, it will outnumber instances of the more limited vanilla material.

{{Scriptdata
|title=Divine kobold metal
|script=materials.divine.metal.kobold = function(sphere)
if not foo then
log(#metal_by_sphere)
log(#world.spheres)
foo = true
end
local lines = {}
--generation function handles ID, registration, generated info
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
--add_generated_info(lines)
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}
--allow for duplicate colors
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random(color_tokens).."]"

--add a block of tokens
lines=split_to_lines(lines,[[
[MATERIAL_VALUE:200]
[SPEC_HEAT:7500]
[MELTING_POINT:NONE]
[BOILING_POINT:NONE]
[ITEMS_WEAPON][ITEMS_WEAPON_RANGED][ITEMS_AMMO][ITEMS_DIGGER][ITEMS_ARMOR][ITEMS_ANVIL]
[ITEMS_HARD]
[ITEMS_METAL]
[ITEMS_BARRED]
[ITEMS_SCALED]
[SOLID_DENSITY:1000]
[LIQUID_DENSITY:1000]
[MOLAR_MASS:20000]
[IMPACT_YIELD:1000000]
[IMPACT_FRACTURE:2000000]
[IMPACT_STRAIN_AT_YIELD:0]
[COMPRESSIVE_YIELD:1000000]
[COMPRESSIVE_FRACTURE:2000000]
[COMPRESSIVE_STRAIN_AT_YIELD:0]
[TENSILE_YIELD:1000000]
[TENSILE_FRACTURE:2000000]
[TENSILE_STRAIN_AT_YIELD:0]
[TORSION_YIELD:1000000]
[TORSION_FRACTURE:2000000]
[TORSION_STRAIN_AT_YIELD:0]
[SHEAR_YIELD:1000000]
[SHEAR_FRACTURE:2000000]
[SHEAR_STRAIN_AT_YIELD:0]
[BENDING_YIELD:1000000]
[BENDING_FRACTURE:2000000]
[BENDING_STRAIN_AT_YIELD:0]
[MAX_EDGE:12000]
]])
--sends this to get registered
return {raws=lines,weight=1}
end
}}

===Remove default functions===

Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.

See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.

<syntaxhighlight lang="lua" >
creatures.fb.default=nil
</syntaxhighlight>

===Basic generated creature===

This is essentially the simplest possible creature. It has no extraordinary options (beyond an [[Sphere|association]] with animals and creation), and each world generates one species from this function. It doesn't have any biome tokens or likewise, so it can only be spawned in the arena, but it is still functional.

A sample output would be "A quadruped composed of flame. It has two narrow tails and it has a regal bearing."

{{Scriptdata
|title=do_once.basic_creature
|script=do_once.basic_creature = function()
local lines = {}
local tok="BASIC_PROCEDURAL_CREATURE"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
CREATION=true
}
}
lines=split_to_lines(lines,[[
[NAME:procedural creature:procedural creatures:procedural]
[CASTE_NAME:procedural creature:procedural creatures:procedural]
]])
--adds some common tokens depending on the options
add_regular_tokens(lines,options)

--handles sphere options: fills out [SPHERE] tokens from options.spheres, and so on
populate_sphere_info(lines,options)

--choose a creature profile to base on
local rcp=get_random_creature_profile(options)
--set [BODY_SIZE] and some relevant tokens
add_body_size(lines,rcp.min_size,options)
--add the tile from the creature profile
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"

--the Big Function determining tweaks, body, appearance, description...
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}

===Making your own RCP===

You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.

This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.

{{Scriptdata
|title=do_once.local_rcp
|script=do_once.local_rcp = function()
local lines = {}
local tok="LOCAL_RCP"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
WATER=true
}
}
add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
--habitat
lines[#lines+1]="[BIOME:ANY_OCEAN]"
lines[#lines+1]="[LARGE_ROAMING]"
lines[#lines+1]="[AQUATIC][UNDERSWIM]"

--define a local creature profile
local rcp={
name_string="eurypterid",
tile='E',
body_base="SCORPION",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}
local name_str = rcp.name_string..":"..rcp.name_string.."s:"..rcp.name_string.."]"
lines[#lines+1] = "[NAME:"..name_str
lines[#lines+1] = "[CASTE_NAME:"..name_str

add_body_size(lines,rcp.min_size,options)
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}
 
Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.

This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

Other feature variants stored in tables, like materials, attacks, or descriptions, can be added in this way.

{{Scriptdata
|title=Global RCP
|script=
random_creature_types.EURYPTERID={
name_string="eurypterid",
tile='E',
body_base="SCORPION_FLIPPERS",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}

body_base_fun.SCORPION_FLIPPERS=function(rcp,options)
options.pcg_layering_base="BEAST_SCORPION"
options.walk_var="STANDARD_WALKING_GAITS"
options.walk_speed=900
return {"RCP_CEPHALOTHORAX","RCP_ABDOMEN","RCP_FIRST_SIMPLE_LEGS","RCP_SECOND_SIMPLE_LEGS","RCP_THIRD_SIMPLE_LEGS","RCP_PINCERS","RCP_FRONT_FLIPPER"}
end

water_based_random_creature.EURYPTERID=true
}}

===Werebugs===

You can make a custom function to determine what RCPs are available to a given creature.

These scripts are for an arthropoid version of a [[werebeast]].
* ``arthropod_rcp`` is a list of RCP keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
* ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].

Otherwise, the function should work the same as vanilla werebeasts, generating an associated [[Interaction token|major curse]] in the same way and becoming "twisted into humanoid form" (at the expense of their additional limbs).

{{Scriptdata
|title=arthropod_rcp
|script=local arthropod_rcp = {
"ARACHNID_MITE",
"ARACHNID_SCORPION",
"ARACHNID_SPIDER",
"ARACHNID_TARANTULA",
"ARACHNID_TICK",
"CRUSTACEAN_CRAB",
"CRUSTACEAN_LOBSTER",
"CRUSTACEAN_SHRIMP",
"INSECT_ANT",
"INSECT_ANTLION",
"INSECT_APHID",
"INSECT_BEE",
"INSECT_BUTTERFLY",
"INSECT_CADDISFLY",
"INSECT_CATERPILLAR",
"INSECT_CICADA",
"INSECT_COCKROACH",
"INSECT_CRICKET",
"INSECT_DAMSELFLY",
"INSECT_DARKLING_BEETLE",
"INSECT_DRAGONFLY",
"INSECT_EARWIG",
"INSECT_FIREFLY",
"INSECT_FLEA",
"INSECT_FLY",
"INSECT_GRASSHOPPER",
"INSECT_HORNET",
"INSECT_LACEWING",
"INSECT_LADYBUG",
"INSECT_LOUSE",
"INSECT_MAGGOT",
"INSECT_MANTIS",
"INSECT_MAYFLY",
"INSECT_MOSQUITO",
"INSECT_MOTH",
"INSECT_SILVERFISH",
"INSECT_SCARAB_BEETLE",
"INSECT_SCORPIONFLY",
"INSECT_SNAKEFLY",
"INSECT_STONEFLY",
"INSECT_TERMITE",
"INSECT_THRIPS",
"INSECT_WASP",
"INSECT_WEEVIL",
"NEMATODE",
"LEECH",
}
}}
{{Scriptdata
|title=is_bloodsucking_by_key
|script=local is_bloodsucking_by_key = {
ARACHNID_MITE=true,
ARACHNID_TICK=true,
INSECT_EARWIG=true,--some are parasitic
INSECT_FLEA=true,
INSECT_LOUSE=true,
INSECT_MAGGOT=true,
INSECT_THRIPS=true,--no bloodsucking reported, but does bite humans
NEMATODE=true,
}
}}
{{Scriptdata
|title=creatures.night_creature.werebeast.werebug
|script=creatures.night_creature.werebeast.werebug=function(tok)
local lines={}
local options={
spheres={
CHAOS=true,
ANIMALS=true,
NIGHT=true,
MOON=true
},
always_glowing_eyes=true,
use_werebeast_pcg=true, --use them if werebug sprites somehow exist
animal_coloring_allowed=true,
no_tweak=true,
material_weakness=true,
prioritize_bite=true,
force_ichor=true,
token=tok
}
options.night_creature_agile_pref=true
night_creature_universals(lines,options)
lines[#lines+1]="[NIGHT_CREATURE_HUNTER]"
lines[#lines+1]="[CAN_LEARN]"
lines[#lines+1]="[CAN_SPEAK]"
lines[#lines+1]="[NO_GENDER]"
lines[#lines+1]="[BONECARN]"
lines[#lines+1]="[CRAZED]"
if options.night_creature_strength_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=1000
elseif options.night_creature_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=800;
elseif options.night_creature_strength_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=850;
end
lines[#lines+1]="[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[PERSONALITY:BASHFUL:0:0:0]"
lines[#lines+1]="[PERSONALITY:STRESS_VULNERABILITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:FRIENDLINESS:0:0:0]"
lines[#lines+1]="[PERSONALITY:DISDAIN_ADVICE:100:100:100]"
lines[#lines+1]="[PERSONALITY:CHEER_PROPENSITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:GRATITUDE:0:0:0]"
lines[#lines+1]="[PERSONALITY:TRUST:0:0:0]"
lines[#lines+1]="[PERSONALITY:ALTRUISM:0:0:0]"
lines[#lines+1]="[PERSONALITY:CRUELTY:100:100:100]"

add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
lines[#lines+1]="[NATURAL_SKILL:WRESTLING:6]"
lines[#lines+1]="[NATURAL_SKILL:BITE:6]"
lines[#lines+1]="[NATURAL_SKILL:GRASP_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:STANCE_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:MELEE_COMBAT:6]"
lines[#lines+1]="[NATURAL_SKILL:DODGING:6]"
lines[#lines+1]="[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]"
lines[#lines+1]="[NATURAL_SKILL:SNEAK:20]"

lines[#lines+1]="[DIFFICULTY:3]"
lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
finalize_random_creature_types() -- good practice to run before rolling on it
local rcp_key = pick_random_no_replace(arthropod_rcp) or "INSECT_MANTIS"
local rcp=random_creature_types[rcp_key]

local custom_desc_str = "it is crazed for blood and flesh"
-- make them also vampires if they suck blood
if rcp.must_suck_blood_through_proboscis or rcp.must_suck_blood_through_mouth or is_bloodsucking_by_key[rcp_key] then
lines[#lines+1]="[BLOODSUCKER]"
custom_desc_str = "it is crazed for warm blood"
end
-- This sort of process should be fully generalized
-- to all creatures you want to have bespoke associated interactions
-- for example, you can have a blessing that allows a sort of
-- uncrazed transformation into some sort of bespoke
-- generated thing--at least, hopefully it's robust enough for that
local choice=generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)
map_merge(options,choice.options)
local werebeast_choice_raws=choice.interaction or choice.raws
raws.register_interactions(werebeast_choice_raws)
add_body_size(lines,math.max(rcp.min_size,80000+trandom(11)*1000),options)
lines[#lines+1]="[CREATURE_TILE:165]" --Ñ
options.forced_color={
f=6,
b=0,
br=1
}
options.custom_desc_func=function(options)
return custom_desc_str
end
build_procgen_creature(rcp,lines,options)
lines[#lines+1]="[GO_TO_START]"
-- remove second words like " beetle", etc from the end
local short_name = rcp.name_string:gsub("%s(%w+)$","")
local name_str="were"..short_name..":were"..short_name.."s:were"..short_name.."]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str
return {raws=lines,weight=1}
end
}}

===New forgotten beasts===
You can add new types of forgotten beasts (or more appropriately, {{token|FEATURE_BEAST}}s). These generate as alternatives when populating the caverns with unique monsters. There are a number of options to interact with shared generation functions.

Unbidden spirits only appear in dry cave layers, and like "spirit" [[demon]]s, are malevolent floating beings made of gas or dust.

{{Scriptdata
|title=Unbidden spirit
|script=
creatures.fb.unbidden=function(layer_type,tok)
if layer_type==0 then return nil end -- land only
local tbl={}
local options={
strong_attack_tweak=true,
always_make_uniform=true,
always_insubstantial=true,
intangible_flier=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[CASTE_NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
-- Weight is a float; all vanilla objects have weight 1
return {creature=tbl,weight=0.5}
end
}}
 
[[Construct creature|Elementals]] are defined by the material they're made of, using a table of options to set the right properties. In a dry chasm layer, they'll roll on the ``fb_elements`` table, while in a water layer, they'll be a water elemental. Should they ever carry a [[syndrome]], they would inflict [[Wikipedia:Dyscrasia|dyskrasia]].

The most important feature is setting ``options.sphere_rcm`` to a key in ``random_creature_materials``, so fire elementals are made of "FLAME" and earth elementals are made of "ANY_MINERAL".

{{Scriptdata
|title=Elemental
|script=
fb_elements = {
{
name="fire",
rcm="FLAME",
spheres={ FIRE=true },
options={ fire_immune=true }
},
{
name="earth",
rcm="ANY_MINERAL",
rcp_options={ always_flightless=true },
spheres={
EARTH=true,
MINERALS=true
}
},
{
name="air",
rcm="STEAM",
spheres={
WIND=true,
SKY=true
},
options={
always_insubstantial=true,
intangible_flier=true
}
}
}

creatures.fb.elemental=function(layer_type,tok)
local lines={}
local options={
strong_attack_tweak=true,
always_make_uniform=true, --irrelevant due to sphere_rcm
spheres={},
sickness_name="dyskrasia",
token=tok
}
lines=split_to_lines(lines,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NO_GENDER]
[NO_EAT][NO_DRINK]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])

-- Create a water elemental in water layers, otherwise use another type
local water_elemental = {
name="water",
rcm="WATER",
spheres={WATER=true},
options={do_water=true}
}
local my_element = layer_type==1 and pick_random(fb_elements) or water_elemental

-- Assign propertes from chosen element
map_merge(options.spheres,my_element.spheres)
if my_element.options then map_merge(options,my_element.options) end

add_regular_tokens(lines,options)
lines[#lines+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
populate_sphere_info(lines,options)

-- Set custom material
options.sphere_rcm=my_element.rcm
-- Build body
local rcp=get_random_creature_profile(options)
-- Set more options on the RCP
if my_element.rcp_options then map_merge(rcp.options,my_element.rcp_options) end
add_body_size(lines,math.max(10000000,rcp.min_size),options)
lines[#lines+1]="[CREATURE_TILE:'E']"
build_procgen_creature(rcp,lines,options)

-- Generate name
local element_name = my_element.name or "glitchstuff"
local name_str = element_name.." elemental:"..element_name.." elemental:"..element_name.."-elemental]"
lines[#lines+1]="[GO_TO_START]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str

return {raws=lines,weight=1.5}
end
}}

===Tweaking creatures===
Common Lua features allow you to extend functions by mirroring the original function and then overwriting it, akin to the ``SELECT`` tags. This function extends ``add_regular_tokens()`` to add {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER}} to all generated creatures.
{{Scriptdata
|title=add_regular_tokens (extension)
|script=
old_add_regular_tokens=add_regular_tokens
function add_regular_tokens(lines,options)
old_add_regular_tokens(lines,options)
lines[#lines+1]="[GENERAL_MATERIAL_FORCE_MULTIPLIER:1:2]"
end
}}
 

This function is run in ``build_body_from_rcp()`` right before tweaks are determined (See [[Lua functions#Creature patching]]). If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.

{{Scriptdata
|title=btc1_tweaks.titan_worship
|script=
-- make all large creatures into powers
btc1_tweaks.titan_worship=function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
if options.body_size>=500000 then -- described as "very large", graphics size cutoff
options.can_learn=true -- for flavor text
lines[#lines+1]="[INTELLIGENT]"
lines[#lines+1]="[SUPERNATURAL]" -- knows secrets according to their spheres
lines[#lines+1]="[POWER]" -- impersonates deities
lines[#lines+1]="[SPREAD_EVIL_SPHERES_IF_RULER]"
end
end
}}

===Adamantine alloys===

You can add your own arbitrary generated objects, though as of right now there's no way to make settings for them. This allows for some ''truly'' wild stuff; here's a fun example: adamantine-metal alloys for every single non-special metal, giving you an average of the properties of them.

{{Scriptdata
|title=Adamantine alloys
|script=
preprocess.adamantine_alloys=function()
if not random_object_parameters.main_world_randoms then return end
local l=get_debug_logger(2)
local lines={}
local reaction_lines={}
local reaction_names={}
local adamantine=world.inorganic.inorganic.ADAMANTINE
if not adamantine then return end
local adamantine_color=world.descriptor.color[world.descriptor.color_pattern[adamantine.material.color_pattern.SOLID].color[1]]
local adamantine_modulus = 2500000 --mildly arbitrary, just below the theoretical limit
l("Starting")
local done_category=false
for k,v in ipairs(world.inorganic.inorganic) do
if not v.flags.SPECIAL and v.material.flags.IS_METAL then
l(v.token)
local token="GEN_ADAMANTINE_"..v.token
lines[#lines+1]="[INORGANIC:"..token.."]"
add_generated_info(lines)
lines[#lines+1]="[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
for kk,vv in pairs(v.material.adj) do
lines[#lines+1]="[STATE_ADJ:"..kk..":adamantine "..vv.."]" --"adamantine molten steel"? it's fine
end
for kk,vv in pairs(v.material.name) do
lines[#lines+1]="[STATE_NAME:"..kk..":adamantine "..vv.."]"
end
l(2)
local mat_values={}
-- Find the ratio for which you get closest to (but not below) 2000000 in the material's worst property
local worst=math.min(v.material.yield.IMPACT,v.material.fracture.SHEAR)
local wafers=1
local bars=1
if worst < 2000000 then
local ratio = (2000000-3*worst)/1000000
local best_diff=1
for i=1,10 do
local wafer_amt=i*ratio
if wafer_amt>1 and wafer_amt<20 and math.ceil(wafer_amt)-wafer_amt<best_diff then
best_diff=math.ceil(wafer_amt)-wafer_amt
wafers=math.ceil(wafer_amt)
bars=i
end
end
end
local avg_denom=1/(bars*3+wafers) -- Multiplication just a bit faster than division, we're rounding at the end anyway
local solid_cl=nil
for kk,vv in pairs(v.material.color_pattern) do
-- time to get silly
local this_color=world.descriptor.color[world.descriptor.color_pattern[vv].color[1]]
local wanted_color={
r=(this_color.r*bars*3+adamantine_color.r*wafers)*avg_denom,
g=(this_color.g*bars*3+adamantine_color.g*wafers)*avg_denom,
b=(this_color.b*bars*3+adamantine_color.b*wafers)*avg_denom,
}
local best_total_diff=1000000000
local best_clp=nil
for _,clp in ipairs(world.descriptor.color_pattern) do
if clp.pattern=="MONOTONE" then
local cl=world.descriptor.color[clp.color[1]]
local diff=math.abs(wanted_color.r-cl.r)+math.abs(wanted_color.b-cl.b)+math.abs(wanted_color.g-cl.g)
if diff<best_total_diff then
best_clp=clp
best_total_diff=diff
end
end
end
lines[#lines+1]="[STATE_COLOR:"..kk..":"..best_clp.token.."]"
if kk=="SOLID" then solid_cl=world.descriptor.color[best_clp.color[1]] end
end
local color_str=solid_cl.col_f..":0:"..solid_cl.col_br
l(color_str)
lines[#lines+1]="[DISPLAY_COLOR:"..color_str.."]"
lines[#lines+1]="[BUILD_COLOR:"..color_str.."]"
lines[#lines+1]="[ITEMS_METAL][ITEMS_HARD][ITEMS_SCALED][ITEMS_BARRED]"
lines[#lines+1]="[SPECIAL]"
if v.material.flags.ITEMS_DIGGER then
lines[#lines+1]="[ITEMS_DIGGER]"
end
local function new_value(str)
mat_values[str]=mat_values[str] or math.floor((adamantine.material[str]*wafers+v.material[str]*bars*3)*avg_denom+0.5)
l(str,mat_values[str])
return mat_values[str]
end
local function new_value_nested(str1,str2)
mat_values[str1..str2]=mat_values[str1..str2] or math.floor((adamantine.material[str1][str2]*wafers+v.material[str1][str2]*bars*3)/(bars*3+wafers)+0.5)
l(str1..str2,mat_values[str1..str2])
return mat_values[str1..str2]
end
if new_value_nested("fracture","SHEAR")>170000 or new_value_nested("yield","IMPACT")>245000 then
lines[#lines+1]="[ITEMS_WEAPON][ITEMS_AMMO]"
if new_value("solid_density")<10000 then
lines[#lines+1]="[ITEMS_WEAPON_RANGED][ITEMS_ARMOR]"
end
end
lines[#lines+1]="[MATERIAL_VALUE:"..new_value("base_value").."]"
lines[#lines+1]="[SPEC_HEAT:"..new_value("temp_spec_heat").."]"
lines[#lines+1]="[MELTING_POINT:"..new_value("temp_melting_point").."]"
lines[#lines+1]="[BOILING_POINT:"..new_value("temp_boiling_point").."]"
lines[#lines+1]="[SOLID_DENSITY:"..new_value("solid_density").."]"
lines[#lines+1]="[LIQUID_DENSITY:"..new_value("liquid_density").."]"
lines[#lines+1]="[MOLAR_MASS:"..new_value("molar_mass").."]" -- i don't think this is actually correct
for _,thing in ipairs({"yield","fracture"}) do
for force,_ in pairs(v.material[thing]) do
lines[#lines+1]="["..string.upper(force).."_"..string.upper(thing)..":"..new_value_nested(thing,force).."]"
end
end
for _,force in ipairs("IMPACT","COMPRESSIVE","TENSILE","TORSION","SHEAR","BENDING") do
local modulus = v.yield[force] / v.elasticity[force]
local average_modulus = (adamantine_modulus*wafers + modulus*bars*3)*avg_denom
local strain_at_yield = math.floor(new_value_nested("yield",force) / average_modulus + 0.5) -- usually zero, but can be 1 or 2 sometimes
lines[#lines+1]="["..string.upper(force).."_YIELD:"..new_value_nested("yield",force).."]"
lines[#lines+1]="["..string.upper(force).."_FRACTURE:"..new_value_nested("fracture",force).."]"
lines[#lines+1]="["..string.upper(force).."_STRAIN_AT_YIELD:"..strain_at_yield.."]"
end
lines[#lines+1]="[MAX_EDGE:"..new_value("max_edge").."]"
local reaction_token=token.."_MAKING"
reaction_lines[#reaction_lines+1]="[REACTION:"..reaction_token.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1]="[NAME:make adamantine "..v.material.name.SOLID.." (use bars)]"
reaction_lines[#reaction_lines+1]="[BUILDING:SMELTER:NONE]"
reaction_lines[#reaction_lines+1]="[REAGENT:A:"..tostring(150*wafers)..":BAR:NO_SUBTYPE:METAL:ADAMANTINE]"
reaction_lines[#reaction_lines+1]="[REAGENT:B:"..tostring(150*bars)..":BAR:NO_SUBTYPE:METAL:"..v.token.."]"
reaction_lines[#reaction_lines+1]="[PRODUCT:100:"..tostring(bars+wafers)..":BAR:NO_SUBTYPE:METAL:"..token.."][PRODUCT_DIMENSION:150]"
reaction_lines[#reaction_lines+1]="[FORTRESS_MODE_ENABLED]"
reaction_lines[#reaction_lines+1]="[CATEGORY:ADAMANTINE_ALLOYS]"
if not done_category then
done_category=true
reaction_lines[#reaction_lines+1]="[CATEGORY_NAME:Adamantine alloys]"
reaction_lines[#reaction_lines+1]="[CATEGORY_DESCRIPTION:Debase adamantine with other metals to get extremely strong alloys.]"
reaction_lines[#reaction_lines+1]="[CATEGORY_KEY:CUSTOM_SHIFT_A]"
end
reaction_lines[#reaction_lines+1]="[FUEL]"
reaction_lines[#reaction_lines+1]="[SKILL:SMELT]"
end
end
local entity_lines={}
raws.register_inorganics(lines)
-- not used in vanilla right now, due to lack of instruments, but you CAN do this
raws.register_reactions(reaction_lines)
end}}

[[Category:Modding]]
[[Category:Modding Examples]]
[[Category:Lua|S]]

Template:V50 weapons

2025-11-17T21:53:46Z

DPhKraken: Added great picks and digging group

{{Navbox
| name = v50 weapons
| title = [[Weapon]]s
| state = {{{state|}}}
| basestyle = background-color: #d0cbc2;

| group1 = [[Archery|Ranged]] and [[ammunition]]
| list1 = [[Blowgun]] and [[blowdart]]{{*}} [[Bow]] and [[arrow]]{{*}} [[Crossbow]] and [[bolt]]

| group2 = Blunt
| list2 = [[Flail]]{{*}} [[Mace]]{{*}} [[Maul]]{{*}} [[Training weapon]]s{{*}} [[War hammer]]{{*}} [[Whip]]

| group3 = Edged (slashing)
| list3 = [[Battle axe]]{{*}} [[Great axe]]{{*}} [[Halberd]]{{*}} [[Long sword]]{{*}} [[Scimitar]]{{*}} [[Scourge]]{{*}} [[Short sword]]{{*}} [[Two-handed sword]]

| group4 = Edged (piercing)
| list4 = [[Dagger]]{{*}} [[Morningstar]]{{*}} [[Pike (weapon)|Pike]]{{*}} [[Spear]]

| group5 = Digging
| list5 = [[Pick]]{{*}} [[Great pick]]

| below = See also: [[Attack types]]{{*}} [[Tool]]{{*}} [[Material science]]
}}<noinclude>[[Category:Navigation templates]]</noinclude><includeonly>{{Category|Weapons}}[[ru:{{PAGENAME}}]]</includeonly>

List of creatures by adult size

2025-11-17T21:46:22Z

DPhKraken: Great pick sizing

{{av}}
To arrange the list, click on any column header. Click again on that column to arrange in reverse.

[[#end of list|Jump to bottom ↓]]
 
{| class="wikitable sortable"
! Creature
! Sprite
! Adult size
! data-sort-type="number" | Adolescent size
! data-sort-type="number" | Child size
|-
| [[Ant]]
| [[File:Ant sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Beetle]]
| [[File:Beetle sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Blood gnat]]
| [[File:Blood gnat sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Brown recluse spider]]
| [[File:Brown recluse spider sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Bumblebee]]
| [[File:Bumblebee sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Damselfly]]
| [[File:Damselfly sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Dragonfly]]
| [[File:Dragonfly sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Firefly]]
| [[File:Firefly sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Fly]]
| [[File:Fly sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Grasshopper]]
| [[File:Grasshopper sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Honey bee]]
| [[File:Honey bee sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Jumping spider]]
| [[File:Jumping spider sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Large roach]]
| [[File:Large roach sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Louse]]
| [[File:Louse sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Mantis]]
| [[File:Mantis sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Monarch butterfly]]
| [[File:Monarch butterfly sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Mosquito]]
| [[File:Mosquito sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Moth]]
| [[File:Moth sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Pixie]] '''(smallest sentient being)'''
| [[File:Pixie sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Slug]]
| [[File:Slug sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Snail]]
| [[File:Snail sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Termite]]
| [[File:Termite sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Thrips]]
| [[File:Thrips sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Tick]]
| [[File:Tick sprite.png|center]]
| 1
| n/a
| n/a
|-
| [[Bark scorpion]]
| [[File:Bark scorpion sprite.png|center]]
| 3
| n/a
| n/a
|-
| [[Bushtit]]
| [[File:Bushtit sprite.png|center]]
| 5
| n/a
| 1
|-
| [[Acorn fly]]
| [[File:Acorn fly sprite.png|center]]
| 20
| n/a
| n/a
|-
| [[Sparrow]]
| [[File:Sparrow sprite.png|center]]
| 30
| n/a
| 2
|-
| [[Oriole]]
| [[File:Oriole sprite.png|center]]
| 40
| n/a
| 7
|-
| [[Wren]]
| [[File:Wren sprite.png|center]]
| 40
| n/a
| 5
|-
| [[Cardinal]]
| [[File:Cardinal sprite.png|center]]
| 50
| n/a
| 8
|-
| [[Cave spider]]
| [[File:Cave spider sprite.png|center]]
| 50
| n/a
| n/a
|-
| [[Leopard gecko]]
| [[File:Leopard gecko sprite.png|center]]
| 50
| n/a
| n/a
|-
| [[Red-winged blackbird]]
| [[File:Red-winged blackbird sprite.png|center]]
| 50
| n/a
| 10
|-
| [[Peach-faced lovebird]]
| [[File:Peach faced lovebird sprite.png|center]]
| 60
| n/a
| 8
|-
| [[Anole]]
| [[File:Anole sprite.png|center]]
| 90
| n/a
| n/a
|-
| [[Cockatiel]]
| [[File:Cockatiel sprite.png|center]]
| 90
| n/a
| 10
|-
| [[Masked lovebird]]
| [[File:Masked lovebird sprite.png|center]]
| 90
| n/a
| 8
|-
| [[Bat]]
| [[File:Bat sprite.png|center]]
| 100
| n/a
| n/a
|-
| [[Blue jay]]
| [[File:Blue jay sprite.png|center]]
| 100
| n/a
| 10
|-
| [[Cave swallow]]
| [[File:Cave swallow sprite.png|center]]
| 100
| n/a
| 10
|-
| [[Fairy]]
| [[File:Fairy sprite.png|center]]
| 100
| 50
| 5
|-
| [[Green tree frog]]
| [[File:Green tree frog sprite.png|center]]
| 100
| n/a
| n/a
|-
| [[Leech]]
| [[File:Leech sprite.png|center]]
| 100
| n/a
| n/a
|-
| [[Worm]]
| [[File:Worm sprite.png|center]]
| 100
| n/a
| n/a
|-
| [[Grackle]]
| [[File:Grackle sprite.png|center]]
| 120
| n/a
| 11
|-
| [[Parakeet]]
| [[File:Parakeet sprite.png|center]]
| 120
| n/a
| 10
|-
| [[Adder]] '''(smallest non-vermin)'''
| [[File:Adder sprite.png|center]]
| 150
| 75
| 15
|-
| [[Chameleon]]
| [[File:Chameleon sprite.png|center]]
| 150
| n/a
| n/a
|-
| [[Hamster]]
| [[File:Hamster sprite.png|center]]
| 150
| n/a
| n/a
|-
| [[Anchovy]]
| [[File:Anchovy sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Axolotl]]
| [[File:Axolotl sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Banded knifefish]]
| [[File:Banded knifefish sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Bat ray]]
| [[File:Bat ray sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Black bullhead]]
| [[File:Black bullhead sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Brook lamprey]]
| [[File:Brook lamprey sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Brown bullhead]]
| [[File:Brown bullhead sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Cap hopper]]
| [[File:Cap hopper sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Char]]
| [[File:Char sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Clown loach]]
| [[File:Clown loach sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Clownfish]]
| [[File:Clownfish sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Flounder]]
| [[File:Flounder sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Flying squirrel]]
| [[File:Flying squirrel sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Glasseye]]
| [[File:Glasseye sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Guppy]]
| [[File:Guppy sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Hagfish]]
| [[File:Hagfish sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Hake]]
| [[File:Hake sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Herring]]
| [[File:Herring sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Lizard]]
| [[File:Lizard sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Lorikeet]]
| [[File:Lorikeet sprite.png|center]]
| 200
| n/a
| 10
|-
| [[Lungfish]]
| [[File:Lungfish sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Mackerel]]
| [[File:Mackerel sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Magpie]]
| [[File:Magpie sprite.png|center]]
| 200
| n/a
| 10
|-
| [[Moon snail]]
| [[File:Moon snail sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Mussel]]
| [[File:Mussel sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Olm]]
| [[File:Olm sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Oyster]]
| [[File:Oyster sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Perch]]
| [[File:Perch sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Rainbow trout]]
| [[File:Rainbow trout sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Sailfin molly]]
| [[File:Sailfin molly sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Salmon]]
| [[File:Salmon sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Sea nettle jellyfish]]
| [[File:Sea nettle jellyfish sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Seahorse]]
| [[File:Seahorse sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Shad]]
| [[File:Shad sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Sole]]
| [[File:Sole sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Spotted ratfish]]
| [[File:Spotted_ratfish_sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Squid]]
| [[File:Squid sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Steelhead trout]]
| [[File:Steelhead trout sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Thornback ray]]
| [[File:Thornback ray sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Toad]]
| [[File:Toad sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Weasel]]
| [[File:Weasel sprite.png|center]]
| 200
| 100
| 20
|-
| [[White-spotted puffer]]
| [[File:White spotted puffer sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Yellow bullhead]]
| [[File:Yellow bullhead sprite.png|center]]
| 200
| n/a
| n/a
|-
| [[Kestrel]]
| [[File:Kestrel sprite.png|center]]
| 250
| 125
| 30
|-
| [[Chipmunk]]
| [[File:Chipmunk sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Demon rat]]
| [[File:Demon rat sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Gray squirrel]]
| [[File:Gray squirrel sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Moghopper]]
| [[File:Moghopper sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Rat]]
| [[File:Rat sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Red squirrel]]
| [[File:Red squirrel sprite.png|center]]
| 300
| n/a
| n/a
|-
| [[Stoat]]
| [[File:Stoat sprite.png|center]]
| 350
| 175
| 35
|-
| [[Grey parrot]]
| [[File:Grey parrot sprite.png|center]]
| 400
| 200
| 40
|-
| [[Barn owl]]
| [[File:Barn owl sprite.png|center]]
| 500
| 250
| 30
|-
| [[Chinchilla]]
| [[File:Chinchilla sprite.png|center]]
| 500
| 250
| 50
|-
| [[Copperhead snake]]
| [[File:Copperhead snake sprite.png|center]]
| 500
| 300
| 50
|-
| [[Crow]]
| [[File:Crow sprite.png|center]]
| 500
| n/a
| 20
|-
| [[Nautilus]]
| [[File:Nautilus sprite.png|center]]
| 500
| n/a
| n/a
|-
| [[Phantom spider]]
| [[File:Phantom spider sprite.png|center]]
| 500
| n/a
| n/a
|-
| [[Pond turtle]]
| [[File:Pond turtle sprite.png|center]]
| 500
| n/a
| 5
|-
| [[Rabbit]]
| [[File:Rabbit sprite.png|center]]
| 500
| 250
| 50
|-
| [[Skink]]
| [[File:Skink sprite.png|center]]
| 500
| n/a
| n/a
|-
| [[Cave lobster]]
| [[File:Cave lobster sprite.png|center]]
| 600
| n/a
| n/a
|-
| [[Lion tamarin]]
| [[File:Lion tamarin sprite.png|center]]
| 620
| n/a
| n/a
|-
| [[Puffin]]
| [[File:Puffin sprite.png|center]]
| 750
| 375
| 30
|-
| [[Cavy]]
| [[File:Cavy sprite.png|center]]
| 800
| 400
| 80
|-
| [[Hedgehog]]
| [[File:Hedgehog sprite.png|center]]
| 800
| n/a
| n/a
|-
| [[Mink]]
| [[File:Mink sprite.png|center]]
| 800
| 400
| 80
|-
| '''Butchering produces skull only'''
|
| 999
| n/a
| n/a
|-
| [[Cave fish]]
| [[File:Cave fish sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Creepy crawler]]
| [[File:Creepy crawler sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Cuttlefish]]
| [[File:Cuttlefish sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Duck]]
| [[File:Ducks sprite anim.gif|center]]
| 1,000
| 500
| 50
|-
| [[Fire snake]]
| [[File:Fire snake sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Kea]]
| [[File:Kea sprite.png|center]]
| 1,000
| 500
| 60
|-
| [[Knuckle worm]]
| [[File:Knuckle worm sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Purring maggot]]
| [[File:Purring maggot sprite.png|center]]
| 1,000
| n/a
| n/a
|-
| [[Two-legged rhino lizard]]
| [[File:Two legged rhino lizard sprite.png|center]]
| 1,000
| n/a
| 30
|-
| [[Peregrine falcon]]
| [[File:Peregrine falcon sprite.png|center]]
| 1,100
| 550
| 44
|-
| [[Raven]]
| [[File:Raven sprite.png|center]]
| 1,200
| n/a
| 50
|-
| [[Buzzard]]
| [[File:Buzzard sprite.png|center]]
| 1,400
| 700
| 50
|-
| [[Guineafowl]]
| [[File:Guineafowl sprite.png|center]]
| 1,500
| 750
| 40
|-
| [[Kingsnake]]
| [[File:Kingsnake sprite.png|center]]
| 1,500
| 750
| 20
|-
| [[Little penguin]]
| [[File:Little penguin sprite.png|center]]
| 1,500
| 750
| 50
|-
| [[Fluffy wambler]] '''(largest vermin)'''
| [[File:Fluffy wambler sprite.png|center]]
| 2,000
| n/a
| n/a
|-
| [[Fox squirrel]] '''(largest vermin)'''
| [[File:Fox squirrel sprite.png|center]]
| 2,000
| n/a
| n/a
|-
| [[Gila monster]]
| [[File:Gila monster sprite.png|center]]
| 2,000
| 1,000
| 30
|-
| [[Great horned owl]]
| [[File:Great horned owl sprite.png|center]]
| 2,000
| 1,000
| 50
|-
| [[Horseshoe crab]]
| [[File:Horseshoe crab sprite.png|center]]
| 2,000
| n/a
| n/a
|-
| [[Osprey]]
| [[File:Osprey sprite.png|center]]
| 2,000
| 1,000
| 55
|-
| [[Platypus]]
| [[File:Platypus sprite.png|center]]
| 2,000
| 1,000
| 10
|-
| [[Snowy owl]]
| [[File:Snowy owl sprite.png|center]]
| 2,000
| 1,000
| 60
|-
| [[Aye-aye]]
| [[File:Aye aye sprite.png|center]]
| 2,500
| 1,250
| 250
|-
| [[Hornbill]]
| [[File:Hornbill sprite.png|center]]
| 2,500
| 1,250
| 48
|-
| [[Kiwi]]
| [[File:Kiwi sprite.png|center]]
| 2,500
| 1,250
| 430
|-
| [[Chicken]]
| [[File:Chickens sprite anim.gif|center]]
| 3,000
| 1,500
| 60
|-
| [[Groundhog]]
| [[File:Groundhog sprite.png|center]]
| 3,000
| 1,500
| 300
|-
| [[Kakapo]]
| [[File:Kakapo sprite.png|center]]
| 3,000
| 1,500
| 50
|-
| [[Mongoose]]
| [[File:Mongoose sprite.png|center]]
| 3,000
| 1,500
| 300
|-
| [[Opossum]]
| [[File:Opossum sprite.png|center]]
| 3,000
| 1,500
| 300
|-
| [[White stork]]
| [[File:White stork sprite.png|center]]
| 3,000
| 1,500
| 100
|-
| [[Capuchin]]
| [[File:Capuchin sprite.png|center]]
| 3,500
| 1,750
| 350
|-
| [[Hare]]
| [[File:Hare sprite.png|center]]
| 3,500
| 1,750
| 350
|-
| [[Blue peafowl]]
| [[File:Peafowls sprite anim.gif|center]]
| 4,000
| 2,000
| 100
|-
| [[Eagle]]
| [[File:Eagle sprite.png|center]]
| 4,000
| 2,000
| 140
|-
| [[Iguana]]
| [[File:Iguana sprite.png|center]]
| 4,000
| 500
| 15
|-
| [[Penguin]]
| [[File:Penguin sprite.png|center]]
| 4,000
| 2,000
| 120
|-
| [[Skunk]]
| [[File:Skunk sprite.png|center]]
| 4,000
| 2,000
| 400
|-
| [[Goose]]
| [[File:Goose sprite.png|center]]
| 4,500
| 2,250
| 150
|-
| '''Too small to wield daggers or spears two-handed'''
|
| 4,999
| 4,999
| 4,999
|-
| [[Black mamba]]
| [[File:Black mamba sprite.png|center]]
| 5,000
| 2,500
| 40
|-
| [[Cat]]
| [[File:Cat sprite.png|center]]
| 5,000
| 2,000
| 500
|-
| [[Hungry head]]
| [[File:Hungry head sprite.png|center]]
| 5,000
| 2,000
| 200
|-
| [[Octopus]]
| [[File:Octopus sprite.png|center]]
| 5,000
| n/a
| 20
|-
| [[Pangolin]]
| [[File:Pangolin sprite.png|center]]
| 5,000
| 2,500
| 500
|-
| [[Red panda]]
| [[File:Red panda sprite.png|center]]
| 5,000
| 2,500
| 500
|-
| [[Rhesus macaque]]
| [[File:Rhesus macaque sprite.png|center]]
| 5,000
| 2,500
| 500
|-
| [[Stingray]]
| [[File:Stingray sprite.png|center]]
| 5,000
| 1,000
| 500
|-
| [[Turkey]]
| [[File:Turkey sprite.png|center]]
| 5,000
| 2,500
| 85
|-
| [[Desert tortoise]]
| [[File:Desert tortoise sprite.png|center]]
| 5,500
| 2,750
| 40
|-
| [[Bilou]]
| [[File:Bilou sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Black-crested gibbon]]
| [[File:Black crested gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Black-handed gibbon]]
| [[File:Black handed gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Coati]]
| [[File:Coati sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Fire imp]]
| [[File:Fire imp sprite.png|center]]
| 6,000
| n/a
| n/a
|-
| [[Fox]]
| [[File:Fox sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Gray gibbon]]
| [[File:Gray gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[King cobra]]
| [[File:king cobra sprite.png|center]]
| 6,000
| 3,000
| 4
|-
| [[Loon]]
| [[File:Loon sprite.png|center]]
| 6,000
| 3,000
| 150
|-
| [[Pileated gibbon]]
| [[File:Pileated gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Silvery gibbon]]
| [[File:Silvery gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Sloth]]
| [[File:Sloth sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[White-browed gibbon]]
| [[File:White browed gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[White-handed gibbon]]
| [[File:White handed gibbon sprite.png|center]]
| 6,000
| 3,000
| 600
|-
| [[Raccoon]]
| [[File:Raccoon sprite.png|center]]
| 7,000
| 3,500
| 700
|-
| [[Rattlesnake]]
| [[File:Rattlesnake sprite.png|center]]
| 7,000
| 3,500
| 40
|-
| [[Armadillo]]
| [[File:Armadillo sprite.png|center]]
| 7,500
| 3,750
| 750
|-
| [[Albatross]]
| [[File:Albatross sprite.png|center]]
| 8,000
| 4,000
| 300
|-
| [[Bobcat]]
| [[File:Bobcat sprite.png|center]]
| 8,000
| 4,000
| 800
|-
| [[Crab]]
| [[File:Crab sprite.png|center]]
| 8,000
| n/a
| 1
|-
| [[Bushmaster]]
| [[File:Bushmaster sprite.png|center]]
| 8,500
| 4,250
| 20
|-
| [[Spider monkey]]
| [[File:Spider monkey sprite.png|center]]
| 8,500
| 4,250
| 850
|-
| [[Honey badger]] (female)
| [[File:honey badger sprite.png|center]]
| 9,000
| 4,500
| 900
|-
| [[Porcupine]]
| [[File:Porcupine sprite.png|center]]
| 9,000
| 4,500
| 900
|-
| [[Vulture]]
| [[File:Vulture sprite.png|center]]
| 9,000
| 4,500
| 50
|-
| '''Too small for [[pressure plate]]s'''
|
| 9,999
| 9,999
| 9,999
|-
| [[Bugbat]]
| [[File:Bugbat sprite.png|center]]
| 10,000
| 5,000
| 1,000
|-
| [[Crundle]]
| [[File:Crundle sprite.png|center]]
| 10,000
| 1,000
| 50
|-
| [[Echidna]]
| [[File:Echidna sprite.png|center]]
| 10,000
| 5,000
| 1
|-
| [[Gremlin]] '''(smallest non-vermin sapient being)'''
| [[File:Gremlin sprite.png|center]]
| 10,000
| 2,500
| 500
|-
| [[Hoary marmot]]
| [[File:Hoary marmot sprite.png|center]]
| 10,000
| 5,000
| 1,000
|-
| [[Koala]]
| [[File:Koala sprite.png|center]]
| 10,000
| 5,000
| 1,000
|-
| [[Milkfish]]
| [[File:Milkfish sprite.png|center]]
| 10,000
| 4,000
| 1,000
|-
| [[River otter]]
| [[File:River otter sprite.png|center]]
| 10,000
| 5,000
| 1,000
|-
| [[Swan]]
| [[File:Swan sprite.png|center]]
| 10,000
| 5,000
| 300
|-
| [[Siamang]]
| [[File:Siamang sprite.png|center]]
| 12,000
| 6,000
| 1,200
|-
| [[Wagon]]
| [[File:Wagon sprite.png|center|35px]]
| 12,000
| n/a
| n/a
|-
| [[Honey badger]] (male)
| [[File:Honey badger sprite.png|center]]
| 14,000
| 7,000
| 900
|-
| '''Too small to wield crossbow, bow or blowgun'''
|
| 14,999
| 14,999
| 14,999
|-
| [[Angelshark]]
| [[File:Angelshark sprite.png|center]]
| 15,000
| 3,000
| 1,000
|-
| [[Badger]]
| [[File:Badger sprite.png|center]]
| 15,000
| 7,500
| 1,500
|-
| [[Blacktip reef shark]]
| [[File:Blacktip reef shark sprite.png|center]]
| 15,000
| 6,000
| 1,000
|-
| [[Bluefish]]
| [[File:Bluefish sprite.png|center]]
| 15,000
| 5,000
| 1,500
|-
| [[Coyote]]
| [[File:Coyote sprite.png|center]]
| 15,000
| 7,500
| 1,500
|-
| [[Dark gnome]]
| [[File:Dark gnome sprite.png|center]]
| 15,000
| 7500
| 1500
|-
| [[Gray langur]]
| [[File:Gray langur sprite.png|center]]
| 15,000
| 7,500
| 1,500
|-
| [[Jackal]]
| [[File:Jackal sprite.png|center]]
| 15,000
| 7,500
| 1,500
|-
| [[Mountain gnome]]
| [[File:Mountain gnome sprite.png|center]]
| 15,000
| 7,500
| 1,500
|-
| [[Whitetip reef shark]]
| [[File:Whitetip reef shark sprite.png|center]]
| 15,000
| 6,000
| 1,000
|-
| [[Amphibian man]]
| [[File:Amphibian man sprite.png|center]]
| 20,000
| 5,000
| 1,000
|-
| [[Antman]] (worker or drone)
| [[File:Antman sprite.png|center]]
| 20,000
| 5,000
| 1,000
|-
| [[Beaver]]
| [[File:Beaver sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| [[Cave blob]]
| [[File:Cave blob sprite.png|center]]
| 20,000
| n/a
| n/a
|-
| [[Creeping eye]]
| [[File:Creeping eye sprite.png|center]]
| 20,000
| n/a
| n/a
|-
| [[Dingo]]
| [[File:Dingo sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| [[Floating guts]]
| [[File:Floating guts sprite.png|center]]
| 20,000
| n/a
| n/a
|-
| [[Gazelle]]
| [[File:Gazelle sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| [[Kobold]] '''(smallest main race in-game)'''
| [[File:Kobold sprite.png|center]]
| 20,000
| 5,000
| 1,000
|-
| [[Longnose gar]]
| [[File:Longnose gar sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| [[Mandrill]]
| [[File:Mandrill sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| [[Sea lamprey]]
| [[File:Sea lamprey sprite.png|center]]
| 20,000
| 6,000
| 2,000
|-
| [[Wolverine]]
| [[File:Wolverine sprite.png|center]]
| 20,000
| 10,000
| 2,000
|-
| '''Too small to wield scourges or whips two-handed'''
|
| 22,499
| 22,499
| 22,499
|-
| [[Large rat]]
| [[File:Large rat sprite.png|center]]
| 25,000
| 12,500
| 2,500
|-
| [[Lynx]]
| [[File:Lynx sprite.png|center]]
| 25,000
| 12,500
| 2,500
|-
| [[Ocelot]]
| [[File:Ocelot sprite.png|center]]
| 25,000
| 12,500
| 250
|-
| [[Wombat]]
| [[File:Wombat sprite.png|center]]
| 25,000
| 12,500
| 3,500
|-
| '''Too small to wield daggers, scourges or whips one-handed'''
|
| 27,499
| 27,499
| 27,499
|-
| [[Common snapping turtle]]
| [[File:Snapping turtle sprite.png|center]]
| 30,000
| n/a
| 40
|-
| [[Dog]]
| [[File:Dog sprite.png|center]]
| 30,000
| 12,500
| 1,000
|-
| [[Emperor penguin]]
| [[File:Emperor penguin sprite.png|center]]
| 30,000
| 15,000
| 450
|-
| [[Magma crab]]
| [[File:Magma crab sprite.png|center]]
| 30,000
| 2,000
| 1,000
|-
| [[Pond grabber]]
| [[File:Pond grabber sprite.png|center]]
| 30,000
| 15,000
| 2,000
|-
| [[Sea otter]]
| [[File:Sea otter sprite.png|center]]
| 30,000
| 15,000
| 3,000
|-
| [[Spiny dogfish]]
| [[File:Spiny dogfish sprite.png|center]]
| 30,000
| 10,000
| 2,000
|-
| '''Too small to wield maces, short swords, war hammers, morning stars or scimitars two-handed'''
|
| 32,499
| 32,499
| 32,499
|-
| [[Beetle man]]
| [[File:Beetle man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Brown recluse spider man]]
| [[File:Brown recluse spider man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Damselfly man]]
| [[File:Damselfly man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Dragonfly man]]
| [[File:Dragonfly man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Emu]]
| [[File:Emu sprite.png|center]]
| 35,000
| 17,500
| 800
|-
| [[Firefly man]]
| [[File:Firefly man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Fly man]]
| [[File:Fly man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Grasshopper man]]
| [[File:Grasshopper man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Jumping spider man]]
| [[File:Jumping spider man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Louse man]]
| [[File:Louse man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Mantis man]]
| [[File:Mantis man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Monarch butterfly man]]
| [[File:Monarch butterfly man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Mosquito man]]
| [[File:Mosquito man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Moth man]]
| [[File:Moth man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Pike]]
| [[File:Pike sprite.png|center]]
| 35,000
| 15,000
| 3,500
|-
| [[Roach man]]
| [[File:Roach man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Slug man]]
| [[File:Slug man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Snail man]]
| [[File:Snail man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Thrips man]]
| [[File:Thrips man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Tick man]]
| [[File:Tick man sprite.png|center]]
| 35,000
| n/a
| n/a
|-
| [[Bark scorpion man]]
| [[File:Bark scorpion man sprite.png|center]]
| 35,001
| n/a
| n/a
|-
| [[Bushtit man]]
| [[File:Bushtit man sprite.png|center]]
| 35,002
| n/a
| 7,000
|-
| [[Sparrow man]]
| [[File:Sparrow man sprite.png|center]]
| 35,015
| n/a
| 2,334
|-
| [[Oriole man]]
| [[File:Oriole man sprite.png|center]]
| 35,020
| n/a
| 6,128
|-
| [[Wren man]]
| [[File:Wren man sprite.png|center]]
| 35,020
| n/a
| 4,377
|-
| [[Cardinal man]]
| [[File:Cardinal man sprite.png|center]]
| 35,025
| n/a
| 5,604
|-
| [[Leopard gecko man]]
| [[File:Leopard gecko man sprite.png|center]]
| 35,025
| n/a
| n/a
|-
| [[Red-winged blackbird man]]
| [[File:Red winged blackbird man sprite.png|center]]
| 35,025
| n/a
| 7,005
|-
| [[Peach-faced lovebird man]]
| [[File:Peach faced lovebird man sprite.png|center]]
| 35,030
| n/a
| 4,670
|-
| [[Anole man]]
| [[File:Anole man sprite.png|center]]
| 35,045
| n/a
| n/a
|-
| [[Cockatiel man]]
| [[File:Cockatiel man sprite.png|center]]
| 35,045
| n/a
| 3,893
|-
| [[Masked lovebird man]]
| [[File:Masked lovebird man sprite.png|center]]
| 35,045
| n/a
| 3,115
|-
| [[Bat man]]
| [[File:Bat man sprite.png|center]]
| 35,050
| n/a
| n/a
|-
| [[Bluejay man]]
| [[File:Bluejay man sprite.png|center]]
| 35,050
| n/a
| 3,505
|-
| [[Cave swallow man]]
| [[File:Cave swallow man sprite.png|center]]
| 35,050
| n/a
| 3,505
|-
| [[Green tree frog man]]
| [[File:Green tree frog man sprite.png|center]]
| 35,050
| n/a
| n/a
|-
| [[Leech man]]
| [[File:Leech man sprite.png|center]]
| 35,050
| n/a
| n/a
|-
| [[Worm man]]
| [[File:Worm man sprite.png|center]]
| 35,050
| n/a
| n/a
|-
| [[Grackle man]]
| [[File:Grackle man sprite.png|center]]
| 35,060
| n/a
| 3,213
|-
| [[Parakeet man]]
| [[File:Parakeet man sprite.png|center]]
| 35,060
| n/a
| 2,921
|-
| [[Adder man]]
| [[File:Adder man sprite.png|center]]
| 35,075
| 17,537
| 3,507
|-
| [[Chameleon man]]
| [[File:Chameleon man sprite.png|center]]
| 35,075
| n/a
| n/a
|-
| [[Hamster man]]
| [[File:Hamster man sprite.png|center]]
| 35,075
| n/a
| n/a
|-
| [[Axolotl man]]
| [[File:Axolotl man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Flying squirrel man]]
| [[File:Flying squirrel man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Lizard man]]
| [[File:Lizard man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Lorikeet man]]
| [[File:Lorikeet man sprite.png|center]]
| 35,100
| n/a
| 1,755
|-
| [[Magpie man]]
| [[File:Magpie man sprite.png|center]]
| 35,100
| n/a
| 1,755
|-
| [[Moon snail man]]
| [[File:Moon snail man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Olm man]]
| [[File:Olm man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Squid man]]
| [[File:Squid man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Toad man]]
| [[File:Toad man sprite.png|center]]
| 35,100
| n/a
| n/a
|-
| [[Weasel man]]
| [[File:Weasel man sprite.png|center]]
| 35,100
| 17,550
| 3,510
|-
| [[Kestrel man]]
| [[File:Kestrel man sprite.png|center]]
| 35,125
| 17,562
| 4,215
|-
| [[Chipmunk man]]
| [[File:Chipmunk man sprite.png|center]]
| 35,150
| n/a
| n/a
|-
| [[Gray squirrel man]]
| [[File:Gray squirrel man sprite.png|center]]
| 35,150
| n/a
| n/a
|-
| [[Rat man]]
| [[File:Rat man sprite.png|center]]
| 35,150
| n/a
| n/a
|-
| [[Red squirrel man]]
| [[File:Red squirrel man sprite.png|center]]
| 35,150
| n/a
| n/a
|-
| [[Stoat man]]
| [[File:Stoat man sprite.png|center]]
| 35,175
| 17,587
| 3,517
|-
| [[Grey parrot man]]
| [[File:Grey parrot man sprite.png|center]]
| 35,200
| 17,600
| 3,520
|-
| [[Barn owl man]]
| [[File:Barn owl man sprite.png|center]]
| 35,250
| 17,625
| 2,115
|-
| [[Chinchilla man]]
| [[File:Chinchilla man sprite.png|center]]
| 35,250
| 17,625
| 3,525
|-
| [[Copperhead snake man]]
| [[File:Copperhead snake man sprite.png|center]]
| 35,250
| 21,150
| 3,525
|-
| [[Crow man]]
| [[File:Crow man sprite.png|center]]
| 35,250
| n/a
| 1,410
|-
| [[Nautilus man]]
| [[File:Nautilus man sprite.png|center]]
| 35,250
| n/a
| n/a
|-
| [[Pond turtle man]]
| [[File:Pond turtle man sprite.png|center]]
| 35,250
| n/a
| 352
|-
| [[Skink man]]
| [[File:Skink man sprite.png|center]]
| 35,250
| n/a
| n/a
|-
| [[Lion tamarin man]]
| [[File:Lion tamarin man sprite.png|center]]
| 35,310
| n/a
| n/a
|-
| [[Puffin man]]
| [[File:Puffin man sprite.png|center]]
| 35,375
| 17,687
| 1,415
|-
| [[Hedgehog man]]
| [[File:Hedgehog man sprite.png|center]]
| 35,400
| n/a
| n/a
|-
| [[Mink man]]
| [[File:Mink man sprite.png|center]]
| 35,400
| 17,700
| 3,540
|-
| [[Cave fish man]]
| [[File:Cave fish man sprite.png|center]]
| 35,500
| n/a
| n/a
|-
| [[Cuttlefish man]]
| [[File:Cuttlefish man sprite.png|center]]
| 35,500
| n/a
| n/a
|-
| [[Kea man]]
| [[File:Kea man sprite.png|center]]
| 35,500
| 17,750
| 2,130
|-
| [[Peregrine falcon man]]
| [[File:Peregrine falcon man sprite.png|center]]
| 35,550
| 17,775
| 1,422
|-
| [[Raven man]]
| [[File:Raven man sprite.png|center]]
| 35,600
| n/a
| 1,483
|-
| [[Buzzard man]]
| [[File:Buzzard man sprite.png|center]]
| 35,700
| 17,850
| 1,275
|-
| [[Kingsnake man]]
| [[File:Kingsnake man sprite.png|center]]
| 35,750
| 17,875
| 476
|-
| [[Gila monster man]]
| [[File:Gila monster man sprite.png|center]]
| 36,000
| 18,000
| 540
|-
| [[Great horned owl man]]
| [[File:Great horned owl man sprite.png|center]]
| 36,000
| 18,000
| 900
|-
| [[Horseshoe crab man]]
| [[File:Horseshoe crab man sprite.png|center]]
| 36,000
| n/a
| n/a
|-
| [[Osprey man]]
| [[File:Osprey man sprite.png|center]]
| 36,000
| 18,000
| 990
|-
| [[Platypus man]]
| [[File:Platypus man sprite.png|center]]
| 36,000
| 18,000
| 180
|-
| [[Snowy owl man]]
| [[File:Snowy owl man sprite.png|center]]
| 36,000
| 18,000
| 1,080
|-
| [[Aye-aye man]]
| [[File:Aye aye man sprite.png|center]]
| 36,250
| 18,125
| 3,625
|-
| [[Hornbill man]]
| [[File:Hornbill man sprite.png|center]]
| 36,250
| 18,125
| 696
|-
| [[Kiwi man]]
| [[File:Kiwi man sprite.png|center]]
| 36,250
| 18,125
| 6,235
|-
| [[Groundhog man]]
| [[File:Groundhog man sprite.png|center]]
| 36,500
| 18,250
| 3,650
|-
| [[Kakapo man]]
| [[File:Kakapo man sprite.png|center]]
| 36,500
| 18,250
| 608
|-
| [[Mongoose man]]
| [[File:Mongoose man sprite.png|center]]
| 36,500
| 18,250
| 3,650
|-
| [[Opossum man]]
| [[File:Opossum man sprite.png|center]]
| 36,500
| 18,250
| 3,650
|-
| [[White stork man]]
| [[File:White stork man sprite.png|center]]
| 36,500
| 18,250
| 1,216
|-
| [[Capuchin man]]
| [[File:Capuchin man sprite.png|center]]
| 36,750
| 18,375
| 3,675
|-
| [[Hare man]]
| [[File:Hare man sprite.png|center]]
| 36,750
| 18,375
| 3,675
|-
| [[Eagle man]]
| [[File:Eagle man sprite.png|center]]
| 37,000
| 18,500
| 1,295
|-
| [[Iguana man]]
| [[File:Iguana man sprite.png|center]]
| 37,000
| 4,625
| 138
|-
| [[Penguin man]]
| [[File:Penguin man sprite.png|center]]
| 37,000
| 18,500
| 1,110
|-
| [[Skunk man]]
| [[File:Skunk man sprite.png|center]]
| 37,000
| 18,500
| 3,700
|-
| '''Too small to wield maces, short swords, war hammers, morningstars or scimitars one-handed'''
|
| 37,499
| 37,499
| 37,499
|-
| [[Black mamba man]]
| [[File:Black mamba man sprite.png|center]]
| 37,500
| 18,750
| 300
|-
| [[Octopus man]]
| [[File:Octopus man sprite.png|center]]
| 37,500
| n/a
| 150
|-
| [[Pangolin man]]
| [[File:Pangolin man sprite.png|center]]
| 37,500
| 18,750
| 3,750
|-
| [[Red panda man]]
| [[File:Red panda man sprite.png|center]]
| 37,500
| 18,750
| 3,750
|-
| [[Rhesus macaque man]]
| [[File:Rhesus macaque man sprite.png|center]]
| 37,500
| 18,750
| 3,750
|-
| [[Desert tortoise man]]
| [[File:Desert tortoise man sprite.png|center]]
| 37,750
| 18,875
| 274
|-
| [[Coati man]]
| [[File:Coati man sprite.png|center]]
| 38,000
| 19,000
| 3,800
|-
| [[Fox man]]
| [[File:Fox man sprite.png|center]]
| 38,000
| 19,000
| 3,800
|-
| [[King cobra man]]
| [[File:King cobra man sprite.png|center]]
| 38,000
| 19,000
| 25
|-
| [[Loon man]]
| [[File:Loon man sprite.png|center]]
| 38,000
| 19,000
| 950
|-
| [[Sloth man]]
| [[File:Sloth man sprite.png|center]]
| 38,000
| 19,000
| 3,800
|-
| [[Raccoon man]]
| [[File:Raccoon man sprite.png|center]]
| 38,500
| 19,250
| 3,850
|-
| [[Rattlesnake man]]
| [[File:Rattlesnake man sprite.png|center]]
| 38,500
| 19,250
| 220
|-
| [[Armadillo man]]
| [[File:Armadillo man sprite.png|center]]
| 38,750
| 19,375
| 3,875
|-
| [[Albatross man]]
| [[File:Albatross man sprite.png|center]]
| 39,000
| 19,500
| 1,462
|-
| [[Bobcat man]]
| [[File:Bobcat man sprite.png|center]]
| 39,000
| 19,500
| 3,900
|-
| [[Crab man]]
| [[File:Crab man sprite.png|center]]
| 39,000
| n/a
| 4
|-
| [[Bushmaster man]]
| [[File:Bushmaster man sprite.png|center]]
| 39,250
| 19,625
| 92
|-
| [[Spider monkey man]]
| [[File:Spider monkey man sprite.png|center]]
| 39,250
| 19,625
| 3,925
|-
| [[Honey badger man]]
| [[File:Honey badger man sprite.png|center]]
| 39,500
| 19,750
| 3,950
|-
| [[Porcupine man]]
| [[File:Porcupine man sprite.png|center]]
| 39,500
| 19,750
| 3,950
|-
| [[Vulture man]]
| [[File:Vulture man sprite.png|center]]
| 39,500
| 19,750
| 219
|-
| [[Carp]]
| [[File:Carp sprite.png|center]]
| 40,000
| 20,000
| 4,000
|-
| [[Cave floater]]
| [[File:Cave floater sprite.png|center]]
| 40,000
| n/a
| n/a
|-
| [[Echidna man]]
| [[File:Echidna man sprite.png|center]]
| 40,000
| 20,000
| 4
|-
| [[Hoary marmot man]]
| [[File:Hoary marmot man sprite.png|center]]
| 40,000
| 20,000
| 4,000
|-
| [[Koala man]]
| [[File:Koala man sprite.png|center]]
| 40,000
| 20,000
| 4,000
|-
| [[Rodent man]]
| [[File:Rodent man sprite.png|center]]
| 40,000
| 8,000
| 1,000
|-
| [[Strangler]]
| [[File:Strangler sprite.png|center]]
| 40,000
| n/a
| n/a
|-
| [[Swan man]]
| [[File:Swan man sprite.png|center]]
| 40,000
| 20,000
| 1,200
|-
| [[Wolf]]
| [[File:Wolf sprite.png|center]]
| 40,000
| 20,000
| 4,000
|-
| '''Too small to wield picks, battle axes or flails two-handed'''
|
| 42,499
| 42,499
| 42,499
|-
| [[Badger man]]
| [[File:Badger man sprite.png|center]]
| 42,500
| 21,250
| 4,250
|-
| [[Coyote man]]
| [[File:Coyote man sprite.png|center]]
| 42,500
| 21,250
| 4,250
|-
| [[Gray langur man]]
| [[File:Gray langur man sprite.png|center]]
| 42,500
| 21,250
| 4,250
|-
| [[Jackal man]]
| [[File:Jackal man sprite.png|center]]
| 42,500
| 21,250
| 4,250
|-
| [[Beaver man]]
| [[File:Beaver man sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| [[Capybara]]
| [[File:Capybara sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| [[Dingo man]]
| [[File:Dingo man sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| [[Gazelle man]]
| [[File:Gazelle man sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| [[Mandrill man]]
| [[File:Mandrill man sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| [[Wolverine man]]
| [[File:Wolverine man sprite.png|center]]
| 45,000
| 22,500
| 4,500
|-
| '''Too small to wield picks, battle axes, flails or spears one-handed'''
|
| 47,499
| 47,499
| 47,499
|-
| [[Lynx man]]
| [[File:Lynx man sprite.png|center]]
| 47,500
| 23,750
| 4,750
|-
| [[Ocelot man]]
| [[File:Ocelot man sprite.png|center]]
| 47,500
| 23,750
| 475
|-
| [[Wombat man]]
| [[File:Wombat man sprite.png|center]]
| 47,500
| 23,750
| 6,650
|-
| [[Aardvark]]
| [[File:Aardvark sprite.png|center]]
| 50,000
| 25,000
| 500
|-
| [[Antman]] (soldier)
| [[File:Antman sprite.png|center]]
| 50,000
| 10,000
| 1,500
|-
| [[Bonobo]]
| [[File:Bonobo sprite.png|center]]
| 50,000
| 25,000
| 10,000
|-
| [[Cassowary]]
| [[File:Cassowary sprite.png|center]]
| 50,000
| 25,000
| 500
|-
| [[Cheetah]]
| [[File:Cheetah sprite.png|center]]
| 50,000
| 25,000
| 5,000
|-
| [[Chimpanzee]]
| [[File:Chimpanzee sprite.png|center]]
| 50,000
| 25,000
| 10,000
|-
| [[Cod]]
| [[File:Cod sprite.png|center]]
| 50,000
| 20,000
| 5,000
|-
| [[Conger eel]]
| [[File:Conger eel sprite.png|center]]
| 50,000
| 20,000
| 5,000
|-
| [[Drunian]]
| [[File:Drunian sprite.png|center]]
| 50,000
| 20,000
| 2,000
|-
| [[Goat]]
| [[File:Goat sprite.png|center]]
| 50,000
| 25,000
| 5,000
|-
| [[Gorlak]]
| [[File:Gorlak sprite.png|center]]
| 50,000
| 10,000
| 3,000
|-
| [[Helmet snake]]
| [[File:Helmet snake sprite.png|center]]
| 50,000
| 2,000
| 40
|-
| [[Ibex]]
| [[File:Ibex sprite.png|center]]
| 50,000
| 10,000
| 5,000
|-
| [[Ice wolf]]
| [[File:Ice wolf sprite.png|center]]
| 50,000
| 10,000
| 5,000
|-
| [[Impala]]
| [[File:Impala sprite.png|center]]
| 50,000
| 25,000
| 5,000
|-
| [[Leopard]]
| [[File:Leopard sprite.png|center]]
| 50,000
| 25,000
| 5,000
|-
| [[Mountain goat]]
| [[File:Mountain goat sprite.png|center]]
| 50,000
| 10,000
| 5,000
|-
| [[Otter man]]
| [[File:Otter man sprite.png|center]]
| 40,000
| 20,000
| 4,000
|-
| [[Plump helmet man]]
| [[File:Plump helmet man sprite.png|center]]
| 50,000
| 10,000
| 1,500
|-
| [[Reptile man]]
| [[File:Reptile man sprite.png|center]]
| 50,000
| 10,000
| 1,500
|-
| [[Serpent man]]
| [[File:Serpent man sprite.png|center]]
| 50,000
| 10,000
| 1,500
|-
| [[Sheep]]
| [[File:Sheep sprite anim.gif|center]]
| 50,000
| 25,000
| 5,000
|-
| [[Snapping turtle man]]
| [[File:Snapping turtle man sprite.png|center]]
| 50,000
| n/a
| 66
|-
| [[Sponge]]
| [[File:Sponge sprite.png|center]]
| 50,000
| n/a
| n/a
|-
| [[Tigerfish]]
| [[File:Tigerfish sprite.png|center]]
| 50,000
| 25,000
| 5,000
|-
| '''Too small for dwarf-sized armor and clothes'''
|
| 51,428
| 51,428
| 51,428
|-
| '''Too small to wield long-swords two-handed'''
|
| 52,499
| 52,499
| 52,499
|-
| [[Emu man]]
| [[File:Emu man sprite.png|center]]
| 52,500
| 26,250
| 1,200
|-
| [[Wolf man]]
| [[File:Wolf man sprite.png|center]]
| 55,000
| 27,500
| 5,500
|-
| '''Too small to wield long-swords one-handed'''
|
| 57,499
| 57,499
| 57,499
|-
| [[Capybara man]]
| [[File:Capybara man sprite.png|center]]
| 57,500
| 28,750
| 5,750
|-
| [[Aardvark man]]
| [[File:Aardvark man sprite.png|center]]
| 60,000
| 30,000
| 600
|-
| [[Cassowary man]]
| [[File:Cassowary man sprite.png|center]]
| 60,000
| 30,000
| 600
|-
| [[Cheetah man]]
| [[File:Cheetah man sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Cougar]]
| [[File:Cougar sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| '''[[Dwarf]]'''
| [[File:Dwarf sprite.png|center]]
| 60,000
| 15,000
| 3,000
|-
| '''[[Elf]]'''
| [[File:Elf sprite.png|center]]
| 60,000
| 15,000
| 3,000
|-
| [[Foul blendec]]
| [[File:Foul blendec sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Frill shark]]
| [[File:Frill shark sprite.png|center]]
| 60,000
| 20,000
| 3,000
|-
| '''[[Goblin]]'''
| [[File:Goblin sprite.png|center]]
| 60,000
| 15,000
| 3,000
|-
| [[Great barracuda]]
| [[File:Great barracuda sprite.png|center]]
| 60,000
| 20,000
| 6,000
|-
| [[Harpy]]
| [[File:Harpy sprite.png|center]]
| 60,000
| n/a
| n/a
|-
| [[Hyena]]
| [[File:Hyena sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Ibex man]]
| [[File:Ibex man sprite.png|center]]
| 60,000
| 12,000
| 6,000
|-
| [[Impala man]]
| [[File:Impala man sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Leopard man]]
| [[File:Leopard man sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Manera]]
| [[File:Manera sprite.png|center]]
| 60,000
| 20,000
| 2,000
|-
| [[Mountain goat man]]
| [[File:Mountain goat man sprite.png|center]]
| 60,000
| 12,000
| 6,000
|-
| [[Naked mole dog]]
| [[File:Naked mole dog sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Pig]]
| [[File:Pig sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Satyr]]
| [[File:Satyr sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| [[Sponge man]]
| [[File:Sponge man sprite.png|center]]
| 60,000
| n/a
| n/a
|-
| [[Troglodyte]]
| [[File:Troglodyte sprite.png|center]]
| 60,000
| 30,000
| 6,000
|-
| '''Too small for human-sized armor and clothes'''
|
| 60,001
| 60,001
| 60,001
|-
| '''Too small to wield two-handed swords, great axes, halberds, mauls or pikes two-handed'''
|
| 62,499
| 62,499
| 62,499
|-
| [[Cougar man]]
| [[File:Cougar man sprite.png|center]]
| 65,000
| 32,500
| 6,500
|-
| [[Hyena man]]
| [[File:Hyena man sprite.png|center]]
| 65,000
| 32,500
| 6,500
|-
| '''Too big for dwarf-sized armor and clothes'''
|
| 68,571
| 68,571
| 68,571
|-
| [[Alpaca]]
| [[File:Alpaca sprite.png|center]]
| 70,000
| 35,000
| 7,000
|-
| [[Amethyst man]]
| [[File:Amethyst man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Blood man]]
| [[File:Blood man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Fire man]]
| [[File:Fire man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Flesh ball]]
| [[File:Flesh ball sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Gabbro man]]
| [[File:Gabbro man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Green devourer]]
| [[File:Green devourer sprite.png|center]]
| 70,000
| 20,000
| 2,000
|-
| [[Grimeling]]
| [[File:Grimeling sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| '''[[Human]]'''
| [[File:Human sprite.png|center]]
| 70,000
| 17,500
| 4,000
|-
| [[Iron man]]
| [[File:Iron man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Magma man]]
| [[File:Magma man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Merperson]]
| [[File:Merperson sprite anim.gif|center]]
| 70,000
| 20,000
| 4,000
|-
| [[Mud man]]
| [[File:Mud man sprite.png|center]]
| 70,000
| n/a
| n/a
|-
| [[Reacher]]
| [[File:Reacher sprite.png|center]]
| 70,000
| 15,000
| 2,000
|-
| '''Too small to wield two-handed swords, great axes, halberds, mauls or pikes one-handed'''
|
| 77,499
| 77,499
| 77,499
|-
| [[Jaguar man]]
| [[File:Jaguar man sprite.png|center]]
| 72,500
| 38,666
| 7,250
|-
| [[Jaguar]]
| [[File:Jaguar sprite.png|center]]
| 75,000
| 40,000
| 7,500
|-
| [[Wild boar man]]
| [[File:Wild boar man sprite.png|center]]
| 75,000
| 37,500
| 7,500
|-
| '''Too big for human-sized armor and clothes'''
|
| 79,999
| 79,999
| 79,999
|-
| [[Alligator snapping turtle]]
| [[File:Alligator snapping turtle sprite.png|center]]
| 80,000
| 40,000
| 60
|-
| [[Coelacanth]]
| [[File:Coelacanth sprite.png|center]]
| 80,000
| 30,000
| 5,000
|-
| [[Kangaroo man]]
| [[File:Kangaroo man sprite.png|center]]
| 80,000
| 40,000
| 8,000
|-
| [[Longfin mako shark]]
| [[File:Longfin mako shark sprite.png|center]]
| 80,000
| 30,000
| 4,000
|-
| [[Orangutan]]
| [[File:Orangutan sprite.png|center]]
| 80,000
| 40,000
| 8,000
|-
| [[Ostrich man]]
| [[File:Ostrich man sprite anim.gif|center]]
| 80,000
| 40,000
| 1,600
|-
| [[Shortfin mako shark]]
| [[File:Shortfin mako shark sprite.png|center]]
| 80,000
| 30,000
| 4,000
|-
| [[Spotted wobbegong]]
| [[File:Spotted wobbegong sprite.png|center]]
| 80,000
| 30,000
| 10,000
|-
| [[Wild boar]]
| [[File:Wild boar sprite.png|center]]
| 80,000
| 40,000
| 8,000
|-
| [[Anaconda man]]
| [[File:Anaconda man sprite.png|center]]
| 85,000
| 42,500
| 85
|-
| [[Monitor lizard man]]
| [[File:Monitor lizard man sprite.png|center]]
| 85,000
| 42,500
| 51
|-
| [[Sloth bear man]]
| [[File:Sloth bear man sprite.png|center]]
| 85,000
| 42,500
| 8,500
|-
| [[Warthog man]]
| [[File:Warthog man sprite.png|center]]
| 85,000
| 42,500
| 8,500
|-
| [[Kangaroo]]
| [[File:Kangaroo sprite.png|center]]
| 90,000
| 45,000
| 9,000
|-
| [[Molemarian]]
| [[File:Molemarian sprite.png|center]]
| 90,000
| 12,000
| 6,000
|-
| [[Ostrich]]
| [[File:Ostrich sprite anim.gif|center]]
| 90,000
| 45,000
| 1,800
|-
| [[Black bear man]]
| [[File:Black bear man sprite.png|center]]
| 95,000
| 47,500
| 9,500
|-
| [[Anaconda]]
| [[File:Anaconda sprite.png|center]]
| 100,000
| 50,000
| 100
|-
| [[Common skate]]
| [[File:Common skate sprite.png|center]]
| 100,000
| 30,000
| 2,000
|-
| [[Elk bird]]
| [[File:Elk bird sprite.png|center]]
| 100,000
| 50,000
| 50
|-
| [[Monitor lizard]]
| [[File:Monitor lizard sprite.png|center]]
| 100,000
| 50,000
| 60
|-
| [[Panda man]]
| [[File:Panda man sprite.png|center]]
| 100,000
| 50,000
| 115
|-
| [[Sloth bear]]
| [[File:Sloth bear sprite.png|center]]
| 100,000
| 50,000
| 10,000
|-
| [[Warthog]]
| [[File:Warthog man sprite.png|center]]
| 100,000
| 50,000
| 10,000
|-
| [[Deer man]]
| [[File:Deer man sprites anim.gif|center]]
| 105,000
| 52,500
| 10,500
|-
| [[Giant tortoise man|Giant tortoise woman]]
| [[File:Giant tortoise man sprite.png|center]]
| 110,000
| 55,000
| 58
|-
| [[Giant peregrine falcon|Giant tiercel peregrine]] '''(smallest giant animal)'''
| [[File:Giant peregrine falcon sprite.png|center]]
| 113,292
| 56,646
| 8,308
|-
| [[Harp seal man]]
| [[File:Harp seal man sprite.png|center]]
| 117,500
| 58,750
| 1,175
|-
| [[Black bear]]
| [[File:Black bear sprite.png|center]]
| 120,000
| 60,000
| 12,000
|-
| [[Nightwing]]
| [[File:Nightwing sprite.png|center]]
| 120,000
| n/a
| n/a
|-
| [[Panda]]
| [[File:Panda sprite.png|center]]
| 130,000
| 65,000
| 150
|-
| [[Reindeer]]
| [[File:Reindeer sprite.png|center]]
| 130,000
| 65,000
| 13,000
|-
| [[Grizzly bear man]]
| [[File:Grizzly bear man sprite.png|center]]
| 135,000
| 67,500
| 13,500
|-
| [[Lion man]]
| [[File:Lion man sprite anim.gif|center]]
| 135,000
| 67,500
| 13,500
|-
| [[Python man]]
| [[File:Python man sprite.png|center]]
| 135,000
| 33,750
| 27
|-
| [[Tapir man]]
| [[File:Tapir man sprite.png|center]]
| 135,000
| 67,500
| 13,500
|-
| [[Deer]]
| [[File:Deer sprites anim.gif|center]]
| 140,000
| 70,000
| 14,000
|-
| [[Tiger man]]
| [[File:Tiger man sprite.png|center]]
| 147,500
| 65,555
| 14,750
|-
| [[Beak dog]]
| [[File:Beak dog sprite.png|center]]
| 150,000
| 50,000
| 1,500
|-
| [[Bull shark]]
| [[File:Bull shark sprite.png|center]]
| 150,000
| 50,000
| 5,000
|-
| [[Giant tortoise]] (female)
| [[File:Giant tortoise sprite.png|center]]
| 150,000
| 75,000
| 80
|-
| [[Gorilla]]
| [[File:Gorilla sprite.png|center]]
| 150,000
| 75,000
| 15,000
|-
| [[Nurse shark]]
| [[File:Nurse shark sprite.png|center]]
| 150,000
| 50,000
| 5,000
|-
| [[Harp seal]]
| [[File:Harp seal sprite.png|center]]
| 165,000
| 82,500
| 1,650
|-
| [[Muskox man]]
| [[File:Muskox man sprite.png|center]]
| 177,500
| 74,736
| 18,684
|-
| [[Llama]]
| [[File:Llama sprite.png|center]]
| 180,000
| 90,000
| 18,000
|-
| [[Elk man]]
| [[File:Elk man sprites anim.gif|center]]
| 185,000
| 92,500
| 18,500
|-
| [[Giant tortoise man]]
| [[File:Giant tortoise man sprite.png|center]]
| 185,000
| 92,500
| 49
|-
| [[Giant honey badger]]
| [[File:Giant honey badger sprite.png|center]]
| 192,150
| 96,075
| 19,215
|-
| [[Moose man|Moose woman]]
| [[File:Moose man sprite anim.gif|center]]
| 192,500
| 96,250
| 19,250
|-
| [[Antman]] (queen)
| [[File:Antman sprite.png|center]]
| 200,000
| 50,000
| 10,000
|-
| [[Blind cave bear]]
| [[File:Blind cave bear sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant bat]]
| [[File:Giant bat sprite anim2.gif|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant cave spider]]
| [[File:Giant cave spider sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant cave swallow]]
| [[File:Giant cave swallow sprite anim.gif|center]]
| 200,000
| 100,000
| 2,000
|-
| [[Giant cave toad]]
| [[File:Giant cave toad sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant earthworm]]
| [[File:Giant earthworm sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant mole]]
| [[File:Giant mole sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant olm]]
| [[File:Giant olm sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant rat]]
| [[File:Giant rat sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Grizzly bear]]
| [[File:Grizzly bear sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Halibut]]
| [[File:Halibut sprite.png|center]]
| 200,000
| 80,000
| 20,000
|-
| [[Lion]]
| [[File:Lion sprite anim.gif|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Opah]]
| [[File:Opah sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Python]]
| [[File:Python sprite.png|center]]
| 200,000
| 50,000
| 40
|-
| [[Tapir]]
| [[File:Tapir sprite.png|center]]
| 200,000
| 100,000
| 20,000
|-
| [[Giant beetle]]
| [[File:Giant beetle sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant brown recluse spider]]
| [[File:Giant brown recluse spider sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant damselfly]]
| [[File:Giant damselfly sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant dragonfly]]
| [[File:Giant dragonfly sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant firefly]]
| [[File:Giant firefly sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant fly]]
| [[File:Giant fly sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant grasshopper]]
| [[File:Giant grasshopper sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant jumping spider]]
| [[File:Giant jumping spider sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant louse]]
| [[File:Giant louse sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant mantis]]
| [[File:Giant mantis sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant monarch butterfly]]
| [[File:Giant monarch butterfly sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant mosquito]]
| [[File:Giant mosquito sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant moth]]
| [[File:Giant moth sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant roach]]
| [[File:Giant roach sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant slug]]
| [[File:Giant slug sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant snail]]
| [[File:Giant snail sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant thrips]]
| [[File:Giant thrips sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant tick]]
| [[File:Giant tick sprite.png|center]]
| 200,007
| n/a
| n/a
|-
| [[Giant bark scorpion]]
| [[File:Giant bark scorpion sprite.png|center]]
| 200,021
| n/a
| n/a
|-
| [[Giant bushtit]]
| [[File:Giant bushtit sprite.png|center]]
| 200,035
| n/a
| 40,007
|-
| [[Giant sparrow]]
| [[File:Giant sparrow sprite.png|center]]
| 200,210
| n/a
| 13,347
|-
| [[Giant oriole]]
| [[File:Giant oriole sprite.png|center]]
| 200,280
| n/a
| 35,049
|-
| [[Giant wren]]
| [[File:Giant wren sprite.png|center]]
| 200,280
| n/a
| 25,035
|-
| [[Giant cardinal]]
| [[File:Giant cardinal sprite.png|center]]
| 200,350
| n/a
| 32,056
|-
| [[Giant leopard gecko]]
| [[File:Giant leopard gecko sprite.png|center]]
| 200,350
| n/a
| n/a
|-
| [[Giant red-winged blackbird]]
| [[File:Giant red-winged blackbird sprite.png|center]]
| 200,350
| n/a
| 40,070
|-
| [[Giant peach-faced lovebird]]
| [[File:Giant peach faced lovebird sprite.png|center]]
| 200,419
| n/a
| 26,722
|-
| [[Giant anole]]
| [[File:Giant anole sprite.png|center]]
| 200,629
| n/a
| n/a
|-
| [[Giant cockatiel]]
| [[File:Giant cockatiel sprite.png|center]]
| 200,629
| n/a
| 22,292
|-
| [[Giant masked lovebird]]
| [[File:Giant masked lovebird sprite.png|center]]
| 200,629
| n/a
| 17,833
|-
| [[Giant bluejay]]
| [[File:Giant bluejay sprite.png|center]]
| 200,700
| n/a
| 20,070
|-
| [[Giant green tree frog]]
| [[File:Giant green tree frog sprite.png|center]]
| 200,700
| n/a
| n/a
|-
| [[Giant leech]]
| [[File:Giant leech sprite.png|center]]
| 200,700
| n/a
| n/a
|-
| [[Giant grackle]]
| [[File:Giant grackle sprite.png|center]]
| 200,840
| n/a
| 18,410
|-
| [[Giant parakeet]]
| [[File:Giant parakeet sprite.png|center]]
| 200,840
| n/a
| 16,736
|-
| [[Giant adder]]
| [[File:Giant adder sprite.png|center]]
| 201,049
| 100,524
| 20,104
|-
| [[Giant chameleon]]
| [[File:Giant chameleon sprite.png|center]]
| 201,049
| n/a
| n/a
|-
| [[Giant hamster]]
| [[File:Giant hamster sprite.png|center]]
| 201,049
| n/a
| n/a
|-
| [[Giant axolotl]]
| [[File:Giant axolotl sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant flying squirrel]]
| [[File:Giant flying squirrel sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant lizard]]
| [[File:Giant lizard sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant lorikeet]]
| [[File:Giant lorikeet sprite.png|center]]
| 201,400
| n/a
| 10,070
|-
| [[Giant magpie]]
| [[File:Giant magpie sprite.png|center]]
| 201,400
| n/a
| 10,070
|-
| [[Giant moon snail]]
| [[File:Giant moon snail sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant toad]]
| [[File:Giant toad sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant weasel]]
| [[File:Giant weasel sprite.png|center]]
| 201,400
| 100,700
| 20,140
|-
| [[Gigantic squid]]
| [[File:Gigantic squid sprite.png|center]]
| 201,400
| n/a
| n/a
|-
| [[Giant kestrel]]
| [[File:Giant kestrel sprite.png|center]]
| 201,750
| 100,875
| 24,210
|-
| [[Giant chipmunk]]
| [[File:Giant chipmunk sprite.png|center]]
| 202,101
| n/a
| n/a
|-
| [[Giant gray squirrel]]
| [[File:Giant gray squirrel sprite.png|center]]
| 202,101
| n/a
| n/a
|-
| [[Giant red squirrel]]
| [[File:Giant red squirrel sprite.png|center]]
| 202,101
| n/a
| n/a
|-
| [[Giant stoat]]
| [[File:Giant stoat sprite.png|center]]
| 202,450
| 101,225
| 20,245
|-
| [[Giant grey parrot]]
| [[File:Giant grey parrot sprite.png|center]]
| 202,800
| 101,400
| 20,280
|-
| [[Giant barn owl]]
| [[File:Giant barn owl sprite.png|center]]
| 203,500
| 101,750
| 12,210
|-
| [[Giant chinchilla]]
| [[File:Giant chinchilla sprite.png|center]]
| 203,500
| 101,750
| 20,350
|-
| [[Giant copperhead snake]]
| [[File:Giant copperhead snake sprite.png|center]]
| 203,500
| 122,100
| 20,350
|-
| [[Giant crow]]
| [[File:Giant crow sprite.png|center]]
| 203,500
| n/a
| 8,140
|-
| [[Giant nautilus]]
| [[File:Giant nautilus sprite.png|center]]
| 203,500
| n/a
| n/a
|-
| [[Giant pond turtle]]
| [[File:Giant pond turtle sprite.png|center]]
| 203,500
| n/a
| 2,035
|-
| [[Giant skink]]
| [[File:Giant skink sprite.png|center]]
| 203,500
| n/a
| n/a
|-
| [[Giant lion tamarin]]
| [[File:Giant lion tamarin sprite.png|center]]
| 204,302
| n/a
| n/a
|-
| [[Giant puffin]]
| [[File:Giant puffin sprite.png|center]]
| 205,252
| 102,626
| 8,210
|-
| [[Giant hedgehog]]
| [[File:Giant hedgehog sprite.png|center]]
| 205,600
| n/a
| n/a
|-
| [[Giant mink]]
| [[File:Giant mink sprite.png|center]]
| 205,600
| 102,800
| 20,560
|-
| [[Giant cuttlefish]]
| [[File:Giant cuttlefish sprite.png|center]]
| 207,010
| n/a
| n/a
|-
| [[Giant kea]]
| [[File:Giant kea sprite.png|center]]
| 207,010
| 103,505
| 12,420
|-
| [[Giant peregrine falcon]]
| [[File:Giant peregrine falcon sprite.png|center]]
| 207,702
| 103,851
| 8,308
|-
| [[Giant raven]]
| [[File:Giant raven sprite.png|center]]
| 208,404
| n/a
| 8,683
|-
| [[Giant buzzard]]
| [[File:Giant buzzard sprite.png|center]]
| 209,804
| 104,902
| 7,493
|-
| [[Giant kingsnake]]
| [[File:Giant kingsnake sprite.png|center]]
| 210,510
| 105,255
| 2,806
|-
| [[Giant gila monster]]
| [[File:Giant gila monster sprite.png|center]]
| 214,020
| 107,010
| 3,210
|-
| [[Giant great horned owl]]
| [[File:Giant great horned owl sprite.png|center]]
| 214,020
| 107,010
| 5,350
|-
| [[Giant horseshoe crab]]
| [[File:Giant horseshoe crab sprite.png|center]]
| 214,020
| n/a
| n/a
|-
| [[Giant osprey]]
| [[File:Giant osprey sprite.png|center]]
| 214,020
| 107,010
| 5,885
|-
| [[Giant platypus]]
| [[File:Giant platypus sprite.png|center]]
| 214,020
| 107,010
| 1,070
|-
| [[Giant snowy owl]]
| [[File:Giant snowy owl sprite.png|center]]
| 214,020
| 107,010
| 6,420
|-
| [[Giant aye-aye]]
| [[File:Giant aye aye sprite.png|center]]
| 217,525
| 108,762
| 21,752
|-
| [[Giant hornbill]]
| [[File:Giant hornbill sprite.png|center]]
| 217,525
| 108,762
| 4,176
|-
| [[Giant kiwi]]
| [[File:Giant kiwi sprite.png|center]]
| 217,525
| 108,762
| 37,414
|-
| [[Minotaur]] '''(smallest [[semi-megabeast]])'''
| [[File:Minotaur sprite.png|center]]
| 220,000
| 50,000
| 10,000
|-
| [[Giant groundhog]]
| [[File:Giant groundhog sprite.png|center]]
| 221,040
| 110,520
| 22,104
|-
| [[Giant kakapo]]
| [[File:Giant kakapo sprite.png|center]]
| 221,040
| 110,520
| 3,684
|-
| [[Giant mongoose]]
| [[File:Giant mongoose sprite.png|center]]
| 221,040
| 110,520
| 22,104
|-
| [[Giant opossum]]
| [[File:Giant opossum sprite.png|center]]
| 221,040
| 110,520
| 22,104
|-
| [[Giant white stork]]
| [[File:Giant white stork sprite.png|center]]
| 221,040
| 110,520
| 7,368
|-
| [[Giant capuchin]]
| [[File:Giant capuchin sprite.png|center]]
| 224,560
| 112,280
| 22,456
|-
| [[Giant hare]]
| [[File:Giant hare sprite.png|center]]
| 224,560
| 112,280
| 22,456

|-
| '''Too small to wield great picks'''
|
| 225,000
| 225,000
| 225,000
|-
| [[Tiger]]
| [[File:Tiger sprite.png|center]]
| 225,000
| 100,000
| 22,500
|-
| [[Giant eagle]]
| [[File:Giant eagle sprite.png|center]]
| 228,040
| 114,020
| 7,981
|-
| [[Giant iguana]]
| [[File:Giant iguana sprite.png|center]]
| 228,040
| 28,505
| 855
|-
| [[Giant skunk]]
| [[File:Giant skunk sprite.png|center]]
| 228,040
| 114,020
| 22,804
|-
| [[Giant penguin]]
| [[File:Giant penguin sprite.png|center]]
| 228,080
| 114,040
| 6,842
|-
| [[Alligator man]]
| [[File:Alligator man sprite.png|center]]
| 235,000
| 117,500
| 35
|-
| [[Leopard seal man]]
| [[File:Leopard seal man sprite.png|center]]
| 235,000
| 117,500
| 23,500
|-
| [[Polar bear man]]
| [[File:Polar bear man sprite.png|center]]
| 235,000
| 117,500
| 23,500
|-
| [[Giant black mamba]]
| [[File:Giant black mamba sprite.png|center]]
| 235,100
| 117,550
| 1,880
|-
| [[Giant octopus]]
| [[File:Giant octopus sprite.png|center]]
| 235,100
| n/a
| 940
|-
| [[Giant pangolin]]
| [[File:Giant pangolin sprite.png|center]]
| 235,100
| 117,550
| 23,510
|-
| [[Giant red panda]]
| [[File:Giant red panda sprite.png|center]]
| 235,100
| 117,550
| 23,510
|-
| [[Giant rhesus macaque]]
| [[File:Giant rhesus macaque sprite.png|center]]
| 235,100
| 117,550
| 23,510
|-
| [[Giant desert tortoise]]
| [[File:Giant desert tortoise sprite.png|center]]
| 238,645
| 119,322
| 1,735
|-
| [[Giant coati]]
| [[File:Giant coati sprite.png|center]]
| 242,160
| 121,080
| 24,216
|-
| [[Giant fox]]
| [[File:Giant fox sprite.png|center]]
| 242,160
| 121,080
| 24,216
|-
| [[Giant king cobra]]
| [[File:Giant king cobra sprite.png|center]]
| 242,160
| 121,080
| 161
|-
| [[Giant loon]]
| [[File:Giant loon sprite.png|center]]
| 242,160
| 121,080
| 6,054
|-
| [[Giant sloth]]
| [[File:Giant sloth sprite.png|center]]
| 242,160
| 121,080
| 24,216
|-
| [[Giant raccoon]]
| [[File:Giant raccoon sprite.png|center]]
| 249,270
| 124,635
| 24,927
|-
| [[Giant rattlesnake]]
| [[File:Giant rattlesnake sprite.png|center]]
| 249,270
| 124,635
| 1,424
|-
| [[Troll]]
| [[File:Troll sprite.png|center]]
| 250,000
| 50,000
| 10,000
|-
| [[Giant armadillo]]
| [[File:Giant armadillo sprite.png|center]]
| 252,750
| 126,375
| 25,275
|-
| [[Giant albatross]]
| [[File:Giant albatross sprite.png|center]]
| 256,320
| 128,160
| 9,612
|-
| [[Giant bobcat]]
| [[File:Giant bobcat sprite.png|center]]
| 256,320
| 128,160
| 25,632
|-
| [[Giant crab]]
| [[File:Giant crab sprite.png|center]]
| 256,320
| n/a
| 32
|-
| [[Giant bushmaster]]
| [[File:Giant bushmaster sprite.png|center]]
| 259,845
| 129,922
| 611
|-
| [[Giant spider monkey]]
| [[File:Giant spider monkey sprite.png|center]]
| 259,845
| 129,922
| 25,984
|-
| [[Giant porcupine]]
| [[File:Giant porcupine sprite.png|center]]
| 263,430
| 131,715
| 26,343
|-
| [[Giant vulture]]
| [[File:Giant vulture sprite.png|center]]
| 263,430
| 131,715
| 1,463
|-
| [[Giant echidna]]
| [[File:Giant echidna sprite.png|center]]
| 270,500
| 135,250
| 27
|-
| [[Giant hoary marmot]]
| [[File:Giant hoary marmot sprite.png|center]]
| 270,500
| 135,250
| 27,050
|-
| [[Giant koala]]
| [[File:Giant koala sprite.png|center]]
| 270,500
| 135,250
| 27,050
|-
| [[Giant swan]]
| [[File:Giant swan sprite.png|center]]
| 270,500
| 135,250
| 8,115
|-
| '''Too small to wield great picks one-handed'''
|
| 275,000
| 275,000
| 275,000
|-
| [[Muskox]]
| [[File:Giant muskox sprite.png|center]]
| 285,000
| 120,000
| 30,000
|-
| [[One-humped camel man]]
| [[File:One humped camel man sprite.png|center]]
| 285,000
| 142,500
| 28,500
|-
| [[Two-humped camel man]]
| [[File:Two humped camel man sprite.png|center]]
| 285,000
| 142,500
| 28,500
|-
| [[Moose man]]
| [[File:Moose man sprite anim.gif|center]]
| 297,500
| 148,750
| 17,850
|-
| [[Blizzard man]]
| [[File:Blizzard man sprite.png|center]]
| 300,000
| n/a
| n/a
|-
| [[Blue shark]]
| [[File:Blue shark sprite.png|center]]
| 300,000
| 100,000
| 10,000
|-
| [[Donkey]]
| [[File:Donkey sprite.png|center]]
| 300,000
| 100,000
| 40,000
|-
| [[Elk]]
| [[File:Elk sprites anim.gif|center]]
| 300,000
| 150,000
| 30,000
|-
| [[Giant tortoise]] (male)
| [[File:Giant tortoise sprite.png|center]]
| 300,000
| 150,000
| 80
|-
| [[Sasquatch]]
| [[File:Sasquatch sprite.png|center]]
| 300,000
| 100,000
| 20,000
|-
| [[Yeti]]
| [[File:Yeti sprite.png|center]]
| 300,000
| 100,000
| 20,000
|-
| [[Giant badger]]
| [[File:Giant badger sprite.png|center]]
| 306,000
| 153,000
| 30,600
|-
| [[Giant coyote]]
| [[File:Giant coyote sprite.png|center]]
| 306,000
| 153,000
| 30,600
|-
| [[Giant gray langur]]
| [[File:Giant gray langur sprite.png|center]]
| 306,000
| 153,000
| 30,600
|-
| [[Giant jackal]]
| [[File:Giant jackal sprite.png|center]]
| 306,000
| 153,000
| 30,600
|-
| [[Moose|Moose cow]]
| [[File:Moose sprite anim.gif|center]]
| 315,000
| 157,500
| 31,500
|-
| [[Giant beaver]]
| [[File:Giant beaver sprite.png|center]]
| 341,800
| 170,900
| 34,180
|-
| [[Giant dingo]]
| [[File:Giant dingo sprite.png|center]]
| 341,800
| 170,900
| 34,180
|-
| [[Giant gazelle]]
| [[File:Giant gazelle sprite.png|center]]
| 341,800
| 170,900
| 34,180
|-
| [[Giant mandrill]]
| [[File:Giant mandrill sprite.png|center]]
| 341,800
| 170,900
| 34,180
|-
| [[Giant wolverine]]
| [[File:Giant wolverine sprite.png|center]]
| 341,800
| 170,900
| 34,180
|-
| [[Giant lynx]]
| [[File:Giant lynx sprite.png|center]]
| 377,750
| 188,875
| 37,775
|-
| [[Giant ocelot]]
| [[File:Giant ocelot sprite.png|center]]
| 377,750
| 188,875
| 3,777
|-
| [[Giant wombat]]
| [[File:Giant wombat sprite.png|center]]
| 377,750
| 188,875
| 52,885
|-
| [[Alligator]]
| [[File:Alligator sprite.png|center]]
| 400,000
| 200,000
| 60
|-
| [[Leopard seal]]
| [[File:Leopard seal sprite.png|center]]
| 400,000
| 200,000
| 40,000
|-
| [[Mule]]
| [[File:Mule sprite.png|center]]
| 400,000
| 150,000
| 50,000
|-
| [[Polar bear]]
| [[File:Polar bear sprite.png|center]]
| 400,000
| 200,000
| 40,000
|-
| [[Saltwater crocodile man]]
| [[File:Saltwater crocodile man sprite.png|center]]
| 435,000
| 217,500
| 32
|-
| [[Giant emu]]
| [[File:Giant emu sprite.png|center]]
| 450,100
| 225,050
| 10,288
|-
| [[Giant wolf]]
| [[File:Giant wolf sprite.png|center]]
| 486,800
| 243,400
| 48,680
|-
| [[Elephant seal man|Elephant seal woman]]
| [[File:Elephant seal man sprite.png|center]]
| 490,000
| 245,000
| 49,000
|-
| [[Hammerhead shark]]
| [[File:Hammerhead shark sprite.png|center]]
| 500,000
| 200,000
| 10,000
|-
| [[Horse]]
| [[File:Horse sprite.png|center]]
| 500,000
| 200,000
| 100,000
|-
| [[One-humped camel]]
| [[File:One humped camel sprite.png|center]]
| 500,000
| 250,000
| 50,000
|-
| [[Tiger shark]]
| [[File:Tiger shark sprite.png|center]]
| 500,000
| 200,000
| 10,000
|-
| [[Two-humped camel]]
| [[File:Two humped camel sprite.png|center]]
| 500,000
| 250,000
| 50,000
|-
| [[Giant capybara]]
| [[File:Giant capybara sprite.png|center]]
| 523,350
| 261,675
| 52,335
|-
| [[Moose|Moose bull]]
| [[File:Moose sprite anim.gif|center]]
| 525,000
| 262,500
| 31,500
|-
| [[Giraffe man]]
| [[File:Giraffe man sprite.png|center]]
| 535,000
| 267,500
| 53,500
|-
| [[Giant aardvark]]
| [[File:Giant aardvark sprite.png|center]]
| 560,000
| 280,000
| 5,600
|-
| [[Giant cassowary]]
| [[File:Giant cassowary sprite.png|center]]
| 560,000
| 280,000
| 5,600
|-
| [[Giant cheetah]]
| [[File:Giant cheetah sprite.png|center]]
| 560,000
| 280,000
| 56,000
|-
| [[Giant ibex]]
| [[File:Giant ibex sprite.png|center]]
| 560,000
| 112,000
| 56,000
|-
| [[Giant impala]]
| [[File:Giant impala sprite.png|center]]
| 560,000
| 280,000
| 56,000
|-
| [[Giant leopard]]
| [[File:Giant leopard sprite.png|center]]
| 560,000
| 280,000
| 56,000
|-
| [[Giant mountain goat]]
| [[File:Giant mountain goat sprite.png|center]]
| 560,000
| 112,000
| 56,000
|-
| [[Giant sponge]]
| [[File:Giant sponge sprite.png|center]]
| 560,000
| n/a
| n/a
|-
| [[Bluefin tuna]]
| [[File:Bluefin tuna sprite.png|center]]
| 600,000
| 200,000
| 60,000
|-
| [[Cave crocodile]]
| [[File:Cave crocodile sprite.png|center]]
| 600,000
| 300,000
| 70
|-
| [[Cow]]
| [[File:Cow sprite.png|center]]
| 600,000
| 250,000
| 100,000
|-
| [[Giant grouper]]
| [[File:Giant grouper sprite.png|center]]
| 600,000
| 200,000
| 60,000
|-
| [[Unicorn]]
| [[File:Unicorn sprite.png|center]]
| 600,000
| 300,000
| 60,000
|-
| [[Giant cougar]]
| [[File:Giant cougar sprite.png|center]]
| 633,600
| 316,800
| 63,360
|-
| [[Giant hyena]]
| [[File:Giant hyena sprite.png|center]]
| 633,600
| 316,800
| 63,360
|-
| [[Narwhal man]]
| [[File:Narwhal man sprite.png|center]]
| 635,000
| 317,500
| 63,500
|-
| [[Swordfish]]
| [[File:Swordfish sprite.png|center]]
| 650,000
| 200,000
| 65,000
|-
| [[Yak]]
| [[File:Yak sprite.png|center]]
| 700,000
| 350,000
| 70,000
|-
| [[Giant jaguar]]
| [[File:Giant jaguar sprite.png|center]]
| 745,500
| 397,600
| 74,550
|-
| [[Giant wild boar]]
| [[File:Giant wild boar sprite.png|center]]
| 783,200
| 391,600
| 78,320
|-
| [[Hippo man]]
| [[File:Hippo man sprite.png|center]]
| 785,000
| 392,500
| 26,166
|-
| [[Walrus man]]
| [[File:Walrus man sprite.png|center]]
| 785,000
| 392,500
| 78,500
|-
| [[Marlin]]
| [[File:Marlin sprite.png|center]]
| 800,000
| 300,000
| 80,000
|-
| [[Saltwater crocodile]]
| [[File:Saltwater crocodile sprite.png|center]]
| 800,000
| 400,000
| 60
|-
| [[Giant otter]]
| [[File:Giant otter sprite.png|center]]
| 811,500
| 405,750
| 81,150
|-
| [[Giant kangaroo]]
| [[File:Giant kangaroo sprite.png|center]]
| 857,700
| 428,850
| 85,770
|-
| [[Giant ostrich]]
| [[File:Giant ostrich sprite.png|center]]
| 857,700
| 428,850
| 17,154
|-
| [[Voracious cave crawler]]
| [[File:Voracious cave crawler sprite.png|center]]
| 900,000
| 400,000
| 20,000
|-
| [[Elephant seal]] (female)
| [[File:Elephant seal sprite.png|center]]
| 910,000
| 455,000
| 91,000
|-
| [[Giant anaconda]]
| [[File:Giant anaconda sprite.png|center]]
| 933,000
| 466,500
| 933
|-
| [[Giant monitor lizard]]
| [[File:Giant monitor lizard sprite.png|center]]
| 933,000
| 466,500
| 559
|-
| [[Giant sloth bear]]
| [[File:Giant sloth bear sprite.png|center]]
| 933,000
| 466,500
| 93,300
|-
| [[Giant warthog]]
| [[File:Giant warthog sprite.png|center]]
| 933,000
| 466,500
| 93,300
|-
| [[Giraffe]]
| [[File:Giraffe sprite.png|center]]
| 1,000,000
| 500,000
| 100,000
|-
| [[Ocean sunfish]]
| [[File:Ocean sunfish sprite.png|center]]
| 1,000,000
| 400,000
| 100,000
|-
| [[Water buffalo]]
| [[File:Water buffalo sprite.png|center]]
| 1,000,000
| 500,000
| 100,000
|-
| [[Giant black bear]]
| [[File:Giant black bear sprite.png|center]]
| 1,084,800
| 542,400
| 108,480
|-
| [[Giant snapping turtle]]
| [[File:Giant snapping turtle sprite.png|center]]
| 1,104,000
| 552,000
| 828
|-
| [[Gigantic panda]]
| [[File:Gigantic panda sprite.png|center]]
| 1,160,900
| 580,450
| 1,339
|-
| [[Narwhal]]
| [[File:Narwhal sprite.png|center]]
| 1,200,000
| 600,000
| 120,000
|-
| '''Too big for [[bridge]]s'''
|
| 1,200,001
| 1,200,001
| 1,200,001
|-
| [[Giant deer]]
| [[File:Giant deer sprite.png|center]]
| 1,237,600
| 618,800
| 123,760
|-
| [[Gigantic tortoise]] (female)
| [[File:Gigantic tortoise sprite.png|center]]
| 1,239,000
| 619,500
| 660
|-
| [[Giant harp seal]]
| [[File:Giant harp seal sprite.png|center]]
| 1,428,900
| 714,450
| 14,289
|-
| [[Hippo]]
| [[File:Hippo sprite.png|center]]
| 1,500,000
| 750,000
| 50,000
|-
| [[Sturgeon]]
| [[File:Sturgeon sprite.png|center]]
| 1,500,000
| 300,000
| 10,000
|-
| [[Walrus]]
| [[File:Walrus sprite.png|center]]
| 1,500,000
| 750,000
| 150,000
|-
| [[Elephant seal man]]
| [[File:Elephant seal man sprite.png|center]]
| 1,535,000
| 767,500
| 153,500
|-
| [[Rhinoceros man]]
| [[File:Rhinoceros man sprite.png|center]]
| 1,535,000
| 767,500
| 153,500
|-
| [[Giant grizzly bear]]
| [[File:Giant grizzly bear sprite.png|center]]
| 1,700,000
| 850,000
| 170,000
|-
| [[Giant lion]]
| [[File:Giant lion sprite_anim.gif|center]]
| 1,700,000
| 850,000
| 170,000
|-
| [[Giant python]]
| [[File:Giant python sprite.png|center]]
| 1,700,000
| 425,000
| 340
|-
| [[Giant tapir]]
| [[File:Giant tapir sprite.png|center]]
| 1,700,000
| 850,000
| 170,000
|-
| [[Giant tiger]]
| [[File:Giant tiger sprite.png|center]]
| 1,894,500
| 842,000
| 189,450
|-
| [[Great white shark]]
| [[File:Great white shark sprite.png|center]]
| 2,000,000
| 500,000
| 50,000
|-
| [[Manta ray]]
| [[File:Manta ray sprite.png|center]]
| 2,300,000
| 500,000
| 100,000
|-
| [[Giant muskox]]
| [[File:Giant muskox sprite.png|center]]
| 2,362,650
| 994,800
| 248,700
|-
| [[Giant elk]]
| [[File:Giant elk sprite.png|center]]
| 2,478,000
| 1,239,000
| 247,800
|-
| [[Gigantic tortoise]] (male)
| [[File:Gigantic tortoise sprite.png|center]]
| 2,478,000
| 1,239,000
| 660
|-
| [[Draltha]]
| [[File:Draltha sprite.png|center]]
| 2,500,000
| 100,000
| 50,000
|-
| [[Elephant man]] '''(largest land-dwelling animal people)'''
| [[File:Elephant man sprite.png|center]]
| 2,535,000
| 1,267,500
| 253,500
|-
| [[Orca man]]
| [[File:Orca man sprite.png|center]]
| 2,535,000
| 1,267,500
| 91,260
|-
| [[Giant moose|Giant moose cow]]
| [[File:Giant moose sprite.png|center]]
| 2,554,650
| 1,277,325
| 255,465
|-
| [[Elephant seal]] (male)
| [[File:Elephant seal sprite.png|center]]
| 3,000,000
| 1,500,000
| 300,000
|-
| [[Rhinoceros]]
| [[File:Rhinoceros sprite.png|center]]
| 3,000,000
| 1,500,000
| 300,000
|-
| [[Rutherer]]
| [[File:Rutherer sprite.png|center]]
| 3,000,000
| 1,500,000
| 300,000
|-
| [[Giant alligator]]
| [[File:Giant alligator sprite.png|center]]
| 3,268,000
| 1,634,000
| 490
|-
| [[Giant leopard seal]]
| [[File:Giant leopard seal sprite.png|center]]
| 3,268,000
| 1,634,000
| 326,800
|-
| [[Giant polar bear]]
| [[File:Giant polar bear sprite.png|center]]
| 3,268,000
| 1,634,000
| 326,800
|-
| [[Giant one-humped camel]]
| [[File:Giant one humped camel sprite.png|center]]
| 4,055,000
| 2,027,500
| 405,500
|-
| [[Giant two-humped camel]]
| [[File:Giant two humped camel sprite.png|center]]
| 4,055,000
| 2,027,500
| 405,500
|-
| [[Giant moose|Giant moose bull]]
| [[File:Giant moose sprite.png|center]]
| 4,257,750
| 2,128,875
| 255,465
|-
| [[Jabberer]]
| [[File:Jabberer sprite anim.gif|center]]
| 4,500,000
| 2,000,000
| 5,000
|-
| [[Elephant]] '''(biggest mundane land animal)'''
| [[File:Elephant sprite.png|center]]
| 5,000,000
| 2,500,000
| 500,000
|-
| [[Orca]]
| [[File:Orca sprite.png|center]]
| 5,000,000
| 2,500,000
| 180,000
|-
| [[Ogre]]
| [[File:Ogre sprite.png|center]]
| 6,000,000
| 2,000,000
| 200,000
|-
| [[Giant saltwater crocodile]]
| [[File:Giant saltwater crocodile sprite.png|center]]
| 6,440,000
| 3,220,000
| 483
|-
| [[Blind cave ogre]]
| [[File:Blind cave ogre sprite.png|center]]
| 7,000,000
| 2,500,000
| 250,000
|-
| [[Giant elephant seal]] (female)
| [[File:Giant elephant seal sprite.png|center]]
| 7,316,400
| 3,658,200
| 731,640
|-
| [[Cyclops]]
| [[File:Cyclops sprite.png|center]]
| 8,000,000
| 2,000,000
| 200,000
|-
| [[Ettin]]
| [[File:Ettin sprite.png|center]]
| 8,000,000
| 2,000,000
| 200,000
|-
| [[Hydra]] '''(smallest [[megabeast]])'''
| [[File:Hydra sprite.png|center]]
| 8,000,000
| n/a
| 200,000
|-
| [[Sea monster]]
| [[File:Sea monster sprite.png|center]]
| 8,000,000
| n/a
| n/a
|-
| [[Giant giraffe]]
| [[File:Giant giraffe sprite.png|center]]
| 8,030,000
| 4,015,000
| 803,000
|-
| [[Giant]] '''(biggest semi-megabeast, biggest land sapient)'''
| [[File:Giant sprite.png|center]]
| 9,000,000
| 3,000,000
| 200,000
|-
| [[Sea serpent]]
| [[File:Sea serpent sprite.png|center]]
| 9,000,000
| n/a
| 6,000
|-
| [[Giant narwhal]]
| [[File:Giant narwhal sprite.png|center]]
| 9,624,000
| 4,812,000
| 962,400
|-
| [[Demon]]
| [[File:Demon sprite.png|center]]
| 10,000,000
| n/a
| n/a
|-
| [[Forgotten beast]]
| [[File:Beast example2 sprite.png|center]]
| 10,000,000
| n/a
| n/a
|-
| [[Titan]]
| [[File:Beast example1 sprite.png|center]]
| 10,000,000
| n/a
| n/a
|-
| [[Giant hippo]]
| [[File:Giant hippo sprite.png|center]]
| 12,030,000
| 6,015,000
| 401,000
|-
| [[Giant walrus]]
| [[File:Giant walrus sprite.png|center]]
| 12,030,000
| 6,015,000
| 1,203,000
|-
| [[Sperm whale man]] '''(biggest sapient being in-game)'''
| [[File:Sperm whale man sprite.png|center]]
| 12,535,000
| 6,267,500
| 250,700
|-
| [[Basking shark]]
| [[File:Basking shark sprite.png|center]]
| 15,000,000
| 5,000,000
| 100,000
|-
| [[Cave dragon]]
| [[File:Cave dragon sprite anim.gif|center]]
| 15,000,000
| n/a
| 6,000
|-
| [[Bronze colossus]]
| [[File:Bronze colossus sprite.png|center]]
| 20,000,000
| n/a
| n/a
|-
| [[Roc]] '''(biggest flying creature)'''
| [[File:Roc sprite.png|center]]
| 20,000,000
| 5,000,000
| 200,000
|-
| [[Whale shark]]
| [[File:Whale shark sprite.png|center]]
| 20,000,000
| 5,000,000
| 1,000,000
|-
| '''Too big for [[pressure plate]]s'''
|
| 20,000,001
| 20,000,001
| 20,000,001
|-
| [[Giant rhinoceros]]
| [[File:Giant rhinoceros sprite.png|center]]
| 24,000,000
| 12,000,000
| 2,400,000
|-
| [[Giant elephant seal]] (male)
| [[File:Giant elephant seal sprite.png|center]]
| 24,120,000
| 12,060,000
| 2,412,000
|-
| [[Dragon]] '''(biggest megabeast)'''
| [[File:Dragon sprite.png|center]]
| 25,000,000
| n/a
| 6,000
|-
| [[Sperm whale]] '''biggest mundane animal'''
| [[File:Sperm whale sprite.png|center]]
| 25,000,000
| 12,500,000
| 500,000
|-
| [[Giant elephant]] '''(biggest land creature in-game)'''
| [[File:Giant elephant sprite.png|center]]
| 40,000,000
| 20,000,000
| 4,000,000
|-
| [[Giant orca]]
| [[File:Giant orca sprite.png|center]]
| 40,000,000
| 20,000,000
| 1,440,000
|-
| [[Giant sperm whale]] '''(biggest creature in-game)'''
| [[File:Giant sperm whale sprite.png|center]]
| 200,000,000
| 100,000,000
| 4,000,000
|}
 
[[#top of list|Jump to top ↑]]
[[ru:List of creatures by adult size]]

Great pick

2025-11-17T21:43:32Z

DPhKraken: Created page with "{{Quality|Unrated}} {{av}} A '''great pick''' is an alternative to picks sized for large creatures. Troll, ogre, and blind cave ogre miners from dark gob..."

{{Quality|Unrated}}
{{av}}
A '''great pick''' is an alternative to [[pick]]s sized for large creatures. [[Troll]], [[ogre]], and [[blind cave ogre]] [[miner]]s from dark [[goblin]] [[Dark pits|pits]] can arrive in [[siege]]s wielding this [[weapon]].

A great pick is eight times the [[Weapon#size|size]] of a standard pick. It has the same internal [[Attack types|attack properties]], but hits with more force due to its size. A creature must be at least 225,000 cm³ to wield it, with [[List of creatures by adult size|some large species]] of [[animal people]] being the smallest creatures that can equip it in [[fortress mode]].

When [[Melt item|melted]] down, great picks produce roughly four bars of metal.

{{Translation
| dwarven = saràm tekkud
| elvish = apaca mubara
| goblin = snuz otez
| human = umon tekud
}}

{{gamedata}}
{{Weapons}}
{{Category|Weapons}}

File:Blind cave ogre sprite.png

2025-11-17T21:10:44Z

DPhKraken: DPhKraken uploaded a new version of File:Blind cave ogre sprite.png

== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ogre sprite.png

2025-11-17T21:10:16Z

DPhKraken: DPhKraken uploaded a new version of File:Ogre sprite.png

== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Blind cave ogre sprites.png

2025-11-17T21:08:23Z

DPhKraken: DPhKraken uploaded a new version of File:Blind cave ogre sprites.png

== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Ogre sprites.png

2025-11-17T21:06:58Z

DPhKraken: DPhKraken uploaded a new version of File:Ogre sprites.png

== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

File:Nest.png

2025-11-17T20:44:10Z

DPhKraken: Category:Interface images

== Summary ==
[[Category:Interface images]]
== Licensing ==
{{Non-free Dwarf Fortress Screenshot}}

Health care

2025-11-17T18:42:33Z

DPhKraken: /* Gypsum plaster */

{{Quality|Fine}}
{{av}}
{{buggy|bugsection=Bugs}}
[[File:hospital_preview.png|right]]A '''hospital''' [[location]] allows [[wound]]ed dwarves to rest and receive care and treatment. Hospitals use any [[bed]]s, [[Table]]s, [[traction bench]]es, and [[chest]]s that have been built within the zone. The hospital will requisition [[thread]], [[cloth]], [[splint]]s, [[crutch]]es, [[Gypsum plaster|plaster powder]] (for casts), [[bucket]]s, and [[soap]] for medical use. These will be stored within the hospital's containers; you may adjust the desired quantities.

'''Doctors''' are dwarves assigned to any of the four doctoring occupations: [[diagnostician|diagnosis]], [[surgeon|surgery]], [[bone doctor|setting bones]], and doctor, which does all of the above. All doctors in the fortress operate under the instruction of the [[chief medical dwarf]], an appointed [[noble]]. Doctors perform their medical procedures on a dwarf only after treatment has been prescribed by a diagnostician. Doctors do not (yet; one must use [[DFHack]] in the interim) perform any healthcare on animals. Suturing and wound dressing are done by orderlies, but their quality is not impacted by any skills, so having all dwarves assigned to it has no negative effect.

Dwarves assigned roles via the hospital zone will only begin doing them once the labors for all dwarves have been updated. To quickly achieve this, go to the labor menu and set 'only selected dwarves mine' to 'no dwarves mine' and then set back to 'only selected dwarves mine', or do anything else in work details.

All beds within a hospital location are automatically hospital beds, where injured dwarves will go (or be brought) to recuperate. Tired, healthy dwarves will occasionally camp there too if the hospital is close, even if they have their own bed.

==Setting up a hospital==
Hospitals are designated as [[locations]]. Designate a Meeting Area zone in the usual way, then select the Add Location button (plus sign) and select Hospital. Any amount of zones can be added to the hospital in the same way, selecting the existing hospital name instead of clicking "new hospital" at the top of the menu. Select the view location button (magnifying glass) allows you to check the equipment and medical supplies missing/available to your hospital.
* Place enough [[bed]]s in that zone to ensure you can keep all wounded dwarves in the hospital. Dwarves can lie on the ground instead of in beds if none are available, but this is not ideal.
* Place at least one [[table]] ({{Menu icon|b|f|t|sep=-}}) for surgeons to perform surgery on. Adjacency to beds makes it easier to move a patient for surgery. You may perform surgery without tables; it will be messier.
** Multiple dwarves may undergo simultaneous surgeries on the same table.
* Place one or more [[traction bench]]es ({{Menu icon|b|f|T|sep=-}}) to handle compound fractures when the dwarf requires "immobilization."
** Each traction bench can only accommodate one dwarf at a time, and the dwarf may be there for quite some time, so plan accordingly.
* Place [[chest]]s ({{Menu icon|b|f|h|sep=-}}) to store medical supplies reserved for hospital use. Once placed, dwarves will start stocking the hospital with medical supplies, you can track their progress and change storage limits in the zone's 'Set Hospital Information' menu. A small hospital can manage with two containers, while a fully-fledged fortress with an adventurous military may need as many as eight. (Containers are not strictly necessary; doctors can and will use supplies from anywhere, but dedicated hospital containers allow you to earmark some supplies for medical use - for example, to prevent the auto-looming of ''every'' last thread.)

Medical Staff:
* Assign dwarves to one of the doctoring occupations and they will do them once work details have been updated. You might want to set several dwarves to be dedicated doctors, with diagnosis labor well-covered - without a diagnosis, patients cannot be treated, if they cannot be treated, they will occupy the hospital area until they die, performing no function. Any dwarf who is assigned as a doctor or diagnoser can diagnose dwarves. Once a patient is diagnosed, you can see on the individual health screen what procedures are needed, for example, washing or suturing. Low-skilled diagnosers may miss syndromes, so if you're having an epidemic of [[forgotten beast|flesh melting extract]], it may be best to only have your best diagnosers on duty.
* If you use a [[burrow]] to keep doctors near the hospital zone, ensure that this burrow covers all needed materials or you could get job cancellations because of a lack of material. Thread/cloth stockpiles, and items bought from caravans (e.g. plaster early in the game) are often the most troubling.

== Skills and injuries==
There are four skilled [[doctor]]ing labors and two unskilled supporting hauling labors involved in healthcare.

{| Class=wikitable
! Labor
! Use
|-
| [[Diagnostician]]
| Determines what procedures (of the other four) are necessary. Bad diagnosers might miss [[syndrome|syndromes]] others won't.
|-
| [[Surgeon]]
| Repair internal organ damage, excise necrotic tissue or serious injuries to muscle, bones. Good surgeons cause less bleeding in their operations.
|-
| [[Bone doctor]]
| Sets simple breaks for healing
|-
| [[Suturer]]
| Stops serious bleeding. Part of the default '''orderly''' work detail.
|-
| [[Wound dresser]]
| Finalizes closed wounds for healing. Part of the default '''orderly''' work detail.
|- style="background-color:#eaeaea;"
| [[Labor|Recovering wounded]]
| Hauls wounded units to the hospital. Part of the default '''orderly''' work detail.
|- style="background-color:#eaeaea;"
| Feed patients/prisoners
| Gives food/water to patients/prisoners. Part of the default '''orderly''' work detail.
|}

Those with the '''recover wounded''' labor will attempt to carry an injured dwarf to a hospital zone, or, lacking one, to the nearest unoccupied bed. Dwarves are not light, especially ones in full armor, so these laborers should not have low strength [[attribute]]s. Note that recovering wounded appears to be an extremely low priority task, and since immobile patients will need to be carried to a hospital before diagnosis, it may be necessary to temporarily disable all other labors on dwarves with this labor to get the wounded moved quickly.

Once in the hospital, a '''diagnoser''' will then evaluate the patient and prescribe a treatment, which any doctor who have the appropriate medical labors enabled (including themselves) may carry out – dwarves cannot be treated without a diagnosis. Depending on the injury, a treatment job will occur. Diagnosis is often required between procedures as well.

After diagnosis, [[Wound|injuries]] to various body parts will be revealed. The color of the text will indicate the severity of the wound, from least to most serious, as follows:

<div style="background:black; width:840px; border-radius:3px">
:{{DFtext|NONE: No recorded active wounds on the part.|#fff}}
:{{DFtext|MINOR: Any damage that doesn't have functional/structural consequences (might be heavy bleeding, though).|#808000}}
:{{DFtext|INHIBITED: Any muscular, structural, or functional damage, without total loss.|#ffff00}}
:{{DFtext|FUNCTION LOSS: An important function of the part is completely lost, but the part is structurally sound (or at least partially intact).|#00ffff}}
:{{DFtext|BROKEN: The part has lost all structural integrity or muscular ability.|#ff0000}}
:{{DFtext|MISSING: The part is completely gone.|#808080}}
</div>

With a chief medical dwarf appointed, you can view your dwarves' health using {{k|w}} for wounds section.

*'''Internal Organs''' can be treated or removed by a surgeon using tables and traction benches, and are typically caused by [[attack_types#Piercing_weapons|piercing]] injuries.

: Surgery also covers the repair of [[Health care#Infection|infected]] or rotten wounds, which are typically caused by lack of [[soap]], poor [[water]] access for cleaning, delayed medical care, or just bad luck.

* '''Bones''' can be set and treated by bone doctors using thread and cloth (for minor fractures), splints and casts, or traction benches, depending on severity. [[Body_token#GRASP|Grasping]] is often impaired during healing. The {{DFtext|Immobilization Request}} status tag is an indication that a splint or plaster cast is required. Multiple overlapping and compound fractures require a surgeon. Typically caused by [[attack_types#Blunt_weapons|blunt]] trauma.

*'''Skin and muscle''' can be treated by a suturer using thread and cloth. The wound will continue to bleed until sutured. Severe wounds to the hands can impair grasping during healing. Typically caused by [[attack_types#Edged_weapons|slashing]] injuries.

* Closed wounds will be dressed by a wound dresser.

Any dwarves with the feed patients/prisoners labor will attempt to give food or a bucket of water to a hungry or thirsty patient. By default, all dwarves start with the non-doctoring, supporting labors enabled; these have no corresponding [[skill]]s, do not cause experience gain, and merely are activities that can be performed by any dwarf, but can be disabled for those with more important labors.

==Infection==
Every open wound can become infected. Infections may heal over time; however, many dwarves will die due to infection, often months after the actual wounding. The creature that caused the infection will be credited for the kill.

Causes of infection include:
* No cleaning of the wounds.
* Cleaning with water from a [[Water#Stagnant_Water|stagnant water]] source, or cleaning with [[Water#Water_laced_with_mud|water laced with mud]]. {{Verify}}
* Cleaning without [[soap]].
* Bad luck

An infection effectively causes constant internal bleeding, and if the infected dwarf is healthy enough, they can naturally replenish their blood quickly enough to outpace the infection.

It's worth noting however that [[Necromancer|necromancy]] effectively cures infections, as the [[intelligent undead|intelligent undead]] it can create cannot die of bleeding.

== Equipment and medical supplies ==
[[File:Hospital information v50.03.png|thumb|In-game hospital information summary]]
=== Traction benches ===
A traction bench is used by a [[bone doctor]] in a [[Hospital|hospital zone]] to immobilize a dwarf that has sustained complex or overlapping fractures.

It is constructed in the [[mechanic's workshop]], and requires a [[table]], a [[mechanism]], and a [[rope]] or a [[chain]] to construct. The [[quality]] of each component is not reflected in the quality of the traction bench, and only the [[material]] of the table is used as the material for the bench. "Recycling" low-quality, low-value components into high-quality traction benches can provide a modest increase in [[value]]. Note that if any [[Stockpile|stockpiles]] have been linked to "Give" to the workshop, all of the resources needed to construct the traction bench must be found in the linked piles (e.g., linking only a stone stockpile may prevent access to the necessary tables/ropes/chains).

=== Gypsum plaster ===

Orthopedic casts are made out of [[Gypsum plaster|plaster powder]] and are used to keep bones in their proper place until healed. To store them in a hospital, place a chest or other container inside the hospital zone. Applying a cast also requires a bucket, cloth, and a water source.

Plaster powder is produced at a [[kiln]] or [[magma kiln]] from [[gypsum]], [[alabaster]], [[selenite]], or [[satinspar]] and an empty [[bag]] by a dwarf with the furnace operator skill enabled. They can also be bought at embark for 3 points per unit; each unit comes with a free bag.

Gypsum powder is superior to a splint in that it allows the dwarf to leave the hospital and resume their duties, which is not possible with a splint. If(!) gypsum powder is available, use that rather than splints.

=== Splints ===
Splints, applied by a bone doctor, immobilize limbs that have sustained bone fractures, allowing them to heal. Dwarves will '''not''' be able to leave the hospital and resume their normal duties until the broken limb is fully healed. {{verify}}

They can be made out of one [[wood]] at the [[carpenter's workshop]] or one metal [[bar]] at the [[metalsmith's forge]] or the [[magma forge]]. Splints are categorized as [[finished goods]].

Splints are inferior to plaster casts, as while they are easier to obtain and prepare, they do not allow movement while healing (which can take months). If plaster powder is available, it is by far the better option vs. splints.

=== Other equipment===
*[[Table]]s are used to conduct operations on. ''(Bug: One table can hold multiple simultaneous diagnostic/surgical patients.)''
*[[Bed]]s are used by patients to rest. Placing beds at the corners of a hospital will help ensure the wounded are brought to a tile that has a bed.
*[[Soap]] is used to clean wounds, sterilizing and preventing infection.
*[[Water]] is used to clean wounds, bathe patients and give drink, as patients do not drink alcohol. Make sure a [[Zones#Water_source|designated]] source is safe, nearby and clean, either a [[well]], [[cistern]] or running water.
*[[Bucket]]s are used to gather and hold water for its uses.
*[[Thread]] is used to suture closed wounds.
*[[Cloth]] is used to clean wounds, wash patients and dress wounds.
*[[Chest]]s are used to store hospital supplies.
*[[Crutch]]es {{DFtext|┬|6:1}} help a crippled dwarf walk again.

==Tips for an effective hospital==
* Regularly use ({{k|i}}-{{k|H}}) to examine your hospital stockpile. Ensure your hospital is well-stocked. If you run out of materials regularly, increase the limits.
** Note that the quantities listed in the "Set Hospital Information" screen are different than those used in stockpiles.
*** 1 stockpile unit of thread = 15000 in the hospital
*** 1 cloth = 10000
*** 1 soap = 150
*** 1 gypsum powder = 150
* It is possible to do without soap in the hospital stockpile. Choosing to do so, however, increases the risk of infection, which will most likely kill the patient. Consult the [[soap]] page to understand that industry. Bring 1 lye on embark for one bar of soap, which translates to 150 units.
* Put a [[well]] inside (or near) the hospital for maximum efficiency. Doctors need to wash patients regularly, and clean water reduces infection.
* Do not place chairs next to your surgery tables. A chair is an invitation for rat-roast-eating freeloaders to block the medical process.
* You may wish to consider individual rooms for each bed if you find your doctors are choosing to treat Urist McPaperCut over Urist McBloodFountainTheGushing. A locked door minimizes the mess, and thereby infection and allows you to prioritize. Plus, necrotizing flesh can generate lots of [[miasma]], which a closed door will stop.
* You can select nurses who enjoy helping people to give them good thoughts. This also prevents dwarves that hate bringing others food from receiving unhappy thoughts.
* If you use Dwarf Therapist, try to select strong or large-sized dwarves to recover wounded. Weak dwarves slowly inching back to the hospital from a hostile area with a dying patient can result in [[fun]].
* When a serious injury happens, don't exit (or save) the game until the injured are in the hospital zone, especially if a dwarf is immobile. "Bring crutch" and "Recover Wounded" jobs will be lost, keeping the patient away from the hospital, and doctors will NOT go to patients, even if burrowed with them, because a diagnose job hasn't been created. Sometimes a second "crutch required" or "recover wounded" request will be generated, but often too late for the patient's full recovery. Your best bet is to ensure someone (not burrowed) has "recover wounded" enabled at all times; burrow doctors doing non-medical tasks immediately; hope the patient makes it to the hospital.{{Verify}}
* Long-term residents will seek medical care if injured. This includes non-dwarves. Doctors will treat them the same as dwarves and the different physiology doesn't seem to be an issue.
* To prevent the usage of adamantine thread, store no thread in hospital settings and instead have a stockpile of non-metal thread in the hospital while additionally having a manager order to make 1 wafer when you have 1 adamantine thread.

Dwarves will prefer to store and use the most expensive thread and cloth – yes, that includes special "[[raw adamantine|exotic]]" strands, which you may want to forbid during medical emergencies.

==Bugs==
* Occupations assigned at a hospital will not take immediate effect due to the [[Known bugs and issues#healthcare-labors-bug|healthcare labors bug]].
* For a variety of reasons, an injured dwarf may leave the hospital and/or refuse to go to the hospital. {{Bug|309}}
* Wounded dwarves are not always recovered properly. {{bug|94}} Re-injuring the dwarf (with a [[minecart]] collision, dropped item, etc.) may trigger proper recovery.
* Adamantine thread used for suturing. {{Bug|1346}}
* The quality and value of a finished traction bench does not account for all of the inputs used to make it. {{verify}}
* Dwarves resting in bed may be starving/dehydrated and not being taken care of, deconstructing the bed to generate a new Recover Wounded task and force them to rest properly fixes this.

{{d for dwarf}}
Soap is the only item dwarves will use to sterilize a wound. While dwarves are of course aware that humans will pour perfectly quaffable alcohol over their bloody wounds and onto the filthy ground to get the same effect, dwarves understand that some things are more precious than a single life, and face oblivion with a bit more dignity. The application of extreme heat is also well known to prevent infections and seal a wound, but dwarves consider magma the only legitimate heat source, and the non-lethal application of magma is sacrilege.
[[File:healthcare_preview.png|thumb|370px|center|A [[human]] doctor attempting to help. ''Art by Luke Fildes (October 3, 1843 – February 28, 1927)'']]
{{Category|Healthcare}}
{{Industry}}
[[ru:Health care]]

Saltpeter

2025-11-14T01:37:06Z

DPhKraken: Added gunpowder sourcing

{{Quality|Superior}}
{{stonelookup/0
|graphic=saltpeter_sprite.png}}
{{av}}

'''Saltpeter''' is a non-economic and low-value yellow [[stone]] found in [[vein|small clusters]] within [[sedimentary layer]]s. With a melting point of {{ct|10601}} and a boiling point of only {{ct|10720}}, it is one of the few stones which will ''boil'' in [[magma]]. Saltpeter is also the second least [[Density|dense]] non-economic stone*, making it better than most stone for objects that must be hauled frequently.

: ''(* Saltpeter is about 60% heavier than [[jet]], more than 21% lighter than typical stone, but about 350% (3 1/2 times) the weight of typical [[wood]] items.)''

In real life, its best known use is as a primary ingredient of gunpowder, along with [[charcoal]] and [[brimstone|sulfur]]. This process does not exist in ''Dwarf Fortress'' (yet; it seems [[Toady One]] has plans to include gunpowder later, but only for simple uses[https://www.bay12games.com/media/df_talk_8_transcript.html]), and therefore gunpowder is also non-existent. Saltpeter, as a source of both potassium (like [[potash]]) and nitrogen, is also a fertilizer, though it is not possible to use it as such in ''Dwarf Fortress''.

{{D for Dwarf}}

It is rumored that if a dwarf ever discovers saltpeter's capabilities, dwarven "civilization" would come to an explosive, but [[Fun]] end.


Despite persistent myths to the contrary, adding saltpeter to your male dwarves' military rations will ''not'' help to control your fortress's population ''or'' reduce incidences of romantic infidelity.

[[File:saltpeter.png|thumb|360px|center|Saltpeter mine.]]
{{gamedata}}
{{stones}}

Entity token

2025-11-04T01:54:19Z

DPhKraken: /* Behavior */ SIEGE_SKILLED_MINERS

{{Quality|Superior}}
{{av}}
{{Modding}}
'''Entity tokens''' define entities, or [[civilization]]s, in entity_*.txt files.

The <code>[OBJECT:ENTITY]</code> [[token]] begins the definition of an entity [[raw file]]. Each new entity definition that follows begins with the <code>[ENTITY:''entity_ID'']</code> token, where ''entity_ID'' is a unique identifier for that entity, and the entity's properties are then specified by the use of further entity tokens; or, tokens can be added to existing entities using <code>[SELECT_ENTITY:''entity_ID'']</code> instead.

All known entity tokens are listed below.

__TOC__
{{clear}}

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

|-
| {{text anchor|ALL_MAIN_POPS_CONTROLLABLE}}
|
| Allows adventure mode for entities with sites.

|-
| {{text anchor|SITE_CONTROLLABLE}}
|
| Allows fortress mode. If multiple entities have the SITE_CONTROLLABLE token, then at embark the specific civs can be chosen on the civ list screen. At least one civilization must have this token.

|-
| {{text anchor|CREATURE}}
| creature
|The type of creature that will inhabit the civilization. If multiple creature types are specified, each civilization will randomly choose one of the creatures. In entities with multiple possible creatures, you can manipulate the chance of one creature being chosen by adding multiple identical creature tags. For instance adding [CREATURE:DWARF][CREATURE:DWARF][CREATURE:DWARF][CREATURE:ELF] to the same entity will make the civs created about 75% dwarven, 25% elven. It should be noted that civilizations are in general weighted by this token: for example, if you have one entity with three [CREATURE:DWARF] tokens and another separate entity with a single [CREATURE:ELF] token, then you can expect to see three times as many of the former placed as the latter (assuming enough unclaimed [START_BIOME:X] space remains). Note that spawn rates are also limited by unclaimed biome space - if an entity can only spawn in a rarer set of biomes (only LAKE_TROPICAL_SALTWATER for example) then their spawn rate will end up being limited by the remaining unclaimed space in that biome type rather than the number of [CREATURE:X] tokens present in the entity raw.
|-
| {{text anchor|SOURCE_HFID}}
| integer
| Found on generated [[angel]] entities. Appears to draw from creatures with this HFID, which associates the entity with a historical figure of the same ID corresponding to a [[deity]].

|}

== Placement ==

Entity spawning during world gen is influenced by several factors:
* The "[[Advanced world generation#Number of Civilizations|Number of Civilizations]]" world gen setting places a hard limit on the total number of entities spawned.
* The "[[Advanced world generation#Playable Civilization Required|Playable Civilization Required]]" world gen setting forces at least one of each [[Entity token#SITE_CONTROLLABLE|SITE_CONTROLLABLE]] entity to spawn (presumably still limited by "Number of Civilizations").
* The number of <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens present in an entity modifies its chance of spawning. An entity containing more <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens will spawn more often (assuming other requirements are met) and may even block entities with fewer <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens from spawning altogether. You can use [SELECT_ENTITY:VANILLA_ENTITY_X] followed by any number of duplicate <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:VANILLA_CREATURE_X] tokens to attempt to balance the spawn rates of the existing vanilla entities with any custom multi-creature entities you may add.
* The number of unclaimed [[Entity token#START_BIOME|START_BIOME]] or [[Entity token#EXCLUSIVE_START_BIOME|EXCLUSIVE_START_BIOME]] tiles remaining in the world limits the spawn rate for an entity and allows entities to block each other's spawns. If there is no "starting" [[Biome token|biome]] space left for an entity then it will not spawn and the game will try to spawn a different entity instead. This means that, on average, an entity that can start in ALL_MAIN [[Biome token|biomes]] will spawn more frequently than one that can start only in LAKE_TROPICAL_SALTWATER [[Biome token|biomes]]. This also means that entities whose starting [[Biome token|biomes]] do not overlap will not block each other's spawns.

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

|-
| {{text anchor|BIOME_SUPPORT}}
|
* [[Biome token|biome]]
* frequency
| Controls the expansion of the civilization's territory. The higher the number is relative to other BIOME_SUPPORT tokens in the entity, the faster it can spread through the biome. These numbers are evaluated relative to each other, i.e. if one biome is 1 and the other is 2, the spread will be the same as if one was 100 and the other was 200. Civs can spread out over biomes they cannot actually build in; for example, humans spread quickly over oceans but cannot actually build in them.
[BIOME_SUPPORT:ANY_GRASSLAND:4]

|-
| {{text anchor|SETTLEMENT_BIOME}}
| [[Biome token|biome]]
| If the civ's territory crosses over this biome, it can build settlements here.
[SETTLEMENT_BIOME:ANY_GRASSLAND]

|-
| {{text anchor|START_BIOME}}
| [[Biome token|biome]]
| Combination of EXCLUSIVE_START_BIOME and SETTLEMENT_BIOME; allows the civ to start in and create settlements in the biome. Note that the civ's spawn rate may be limited if all of its START or EXCLUSIVE_START biome(s) are rare in the world or have already been fully occupied by other civ spawns.
[START_BIOME:ANY_FOREST]

|-
| {{text anchor|EXCLUSIVE_START_BIOME}}
| [[Biome token|biome]]
| The birth of the civilization can occur in this biome, but cannot (necessarily) build in it. If the civ does not have SETTLEMENT_BIOME or START_BIOME for the biome in question, it will only construct a single settlement there. Note that the civ's spawn rate may be limited if all of its START or EXCLUSIVE_START biome(s) are rare in the world or have already been fully occupied by other civ spawns.
[EXCLUSIVE_START_BIOME:MOUNTAIN]

|-
| {{text anchor|DEFAULT_SITE_TYPE}}
| site type
| Valid site types are DARK_FORTRESS (π), CAVE (•), CAVE_DETAILED (Ω), TREE_CITY (î), and CITY (#). Also recognizes PLAYER_FORTRESS (creates a civ of hillocks only), and MONUMENT (creates a civ without visible sites (except tombs and castles), but may cause worldgen crashes). FORTRESS is no longer a valid entry, castles are currently controlled by BUILDS_OUTDOOR_FORTIFICATIONS. Defaults to CITY. Selecting CAVE causes the classic kobold behavior of not showing up on the "neighbors" section of the site selection screen. Selecting DARK_FORTRESS also allows generation of [[underworld spire|certain other structures]]. It also gives the civ a [[demon|special overlord]].
CAVE_DETAILED civilizations will create fortresses in mountainous regions and hillocks in non-mountainous regions. [DEFAULT_SITE_TYPE:CAVE_DETAILED]

|-
| {{text anchor|LIKES_SITE}}
| site type
| Most residents will try to move to this site type, unless already at one.
[LIKES_SITE:CAVE_DETAILED]

|-
| {{text anchor|TOLERATES_SITE}}
| site type
| Some residents will try to move to this site type, unless already at one.
[TOLERATES_SITE:CITY]

|-
| {{text anchor|WORLD_CONSTRUCTION}}
| construction
| Controls which constructions the civ will build on the world map. Valid constructions are ROAD, TUNNEL, BRIDGE, and WALL.
[WORLD_CONSTRUCTION:BRIDGE]
[WORLD_CONSTRUCTION:ROAD]
[WORLD_CONSTRUCTION:TUNNEL]
[WORLD_CONSTRUCTION:WALL]

|}

== Population ==

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

|-
| {{text anchor|MAX_POP_NUMBER}}
| number
| Max historical population '''per entity'''. Multiply this by max starting civ to get the total maximum historical population of the species. Defaults to 500, but all vanilla entities use 10,000, except skulking uses 2,000.
[MAX_POP_NUMBER:10000]

|-
| {{text anchor|MAX_SITE_POP_NUMBER}}
| number
| Max historical population per individual site. Defaults to 50, but all the vanilla entities use 120.
[MAX_SITE_POP_NUMBER:120]

|-
| {{text anchor|MAX_STARTING_CIV_NUMBER}}
| number
| Max number of civilizations of this entity type to spawn at world generation, which picks entities in some sequential order from the raws, looping through the list as needed. This is a hard limit, if set to 1, only 1 civilization of this type will be placed. If all entities have reached their limit, world generation will not try to place any more, even if its own [[Advanced_world_generation#Number_of_Civilizations|total limit]] has not been reached, and will continue on. Defaults to 3, but all vanilla entities use 100 (essentially unlimited).
[MAX_STARTING_CIV_NUMBER:100]

|}

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

|-
| {{text anchor|PERMITTED_BUILDING}}
| building name
| The named, custom building can be built by a civilization in Fortress Mode.
[PERMITTED_BUILDING:SOAP_MAKER]

|-
| {{text anchor|PERMITTED_JOB}}
| [[Unit type token|profession]]
| Allows this job type to be selected. This applies to worldgen creatures, in the embark screen, and in play. Certain professions also influence the availability of materials for trade.
[PERMITTED_JOB:MINER]

|-
| {{text anchor|PERMITTED_REACTION}}
| reaction name
| Allows this reaction to be used by a civilization. It is used primarily in Fortress Mode, but also allows certain resources, such as [[steel]], to be available to a race. When creating custom reactions, this token '''must''' be present or the player will not be able to use the reaction in Fortress Mode.
[PERMITTED_REACTION:TAN_A_HIDE]

|-
| {{text anchor|CURRENCY_BY_YEAR}}
|
| Causes the civ's currency to be numbered with the year it was minted.

|-
| {{text anchor|CURRENCY}}
|
* inorganic material
* value
| What kind of metals the civ uses for coin minting, as well as the value of the [[coin]]. Only effective in Adventurer mode due to lack of [[dwarven economy]].

[CURRENCY:SILVER:5]

|-
| {{text anchor|ART_FACET_MODIFIER}}
|
* type
* number
| OWN_RACE, FANCIFUL, EVIL, GOOD
Number goes from 0 to 25600 where 256 is the default.
[ART_FACET_MODIFIER:OWN_RACE:512]

|-
| {{text anchor|ART_IMAGE_ELEMENT_MODIFIER}}
|
* item
* number
| CREATURE, PLANT, TREE, SHAPE, ITEM 0-25600

Determines the chance of each image occurring in that entity's artwork, such as engravings and on artifacts, for default (non-historical) artwork.

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

|-
| {{text anchor|ITEM_IMPROVEMENT_MODIFIER}}
|
* item
* number
| ART_IMAGE, COVERED or GLAZED, RINGS_HANGING, BANDS, SPIKES, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE 0-25600

Determines the chance of the entity using that particular artwork method, such as "encircled with bands" or "menaces with spikes".

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

This also seems to change the amount that the entity will pay for items that are improved in these ways in their tokens.

|-
| {{text anchor|TRANSLATION}}
| language
| What language raw the entity uses.
* If an entity lacks this tag, translations are drawn randomly from all translation files. Multiple translation tags will only result in the last one being used. Migrants will sometimes arrive with no name.
* If GEN_DIVINE is entered, the entity will use a generated divine language, that is, the same language that is used for the names of [[angel]]s.
* If the entity's main creature has {{token|UTTERANCES|c}}, then this token will be ignored (except when using the naming menu) in favor of procedural [[kobold]]-style [[Kobold language|pseudolanguage]].
[TRANSLATION:DWARF]

|-
| {{text anchor|SELECT_SYMBOL}}
|
* category
* [[language#language_SYM.txt|symbol]]
| ALL, REMAINING, BATTLE, BRIDGE, CIV, CRAFT_GUILD, FESTIVAL, HOSPITAL, LIBRARY, MERCHANT_COMPANY, MILITARY_UNIT, OTHER, RELIGION, ROAD, SIEGE, SITE, TEMPLE, TUNNEL, VESSEL, WALL, WAR
The entity will always use a word from the selected symbol(s) to generate names from that category.
* OTHER applies the symbol selection to personal names and site names. REMAINING will apply the symbol selection to all categories that have not already been declared above it.
* Specific to SELECT_SYMBOL, symbols selected this way will be used as "The X" in "The X of Y" names, and nouns from selected symbols can be used as first [[name]]s.

[SELECT_SYMBOL:ALL:PEACE]

|-
| {{text anchor|SUBSELECT_SYMBOL}}
|
* category
* [[language#language_SYM.txt|symbol]]
| As SELECT_SYMBOL, a word from the subselected symbol(s) will be used in names of that category, in addition to the word from SELECT_SYMBOL (if specified). Used in vanilla to put violent names in sieges and battles.
* Words chosen with SUBSELECT_SYMBOL will appear as either adjectives or "of Y" in "The X of Y" names.
* CULL_SYMBOL does not affect subselected symbols.

[SELECT_SYMBOL:SIEGE:NAME_SIEGE]

[SUBSELECT_SYMBOL:SIEGE:VIOLENT]

|-
| {{text anchor|CULL_SYMBOL}}
|
* category
* [[Language#language_SYM.txt|symbol]]
| Causes the entity to not use the words in these SYM sets.
[CULL_SYMBOL:ALL:UGLY]

|-
| {{text anchor|FRIENDLY_COLOR}}
| see [[color]]
|
The color of this entity's civilization settlements in the world gen and embark screens, also used when announcing arrival of their caravan. Defaults to 7:0:1.

[FRIENDLY_COLOR:1:0:1]

|}

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

|-
| {{text anchor|RELIGION}}
| type
|
* REGIONAL_FORCE: The creatures will worship a single force associated with the terrain of their initial biome.
* PANTHEON: The creatures will worship a group of gods, each aligned with their spheres and other appropriate ones as well.

Can be specified multiple times, and will pick randomly from the assigned types. Additional instances of each type will weight the random choice, but unlike {{token|CREATURE|e}}, will not make the entity more likely to spawn.

[RELIGION:PANTHEON]

|-
| {{text anchor|RELIGION_SPHERE}}
| [[Sphere#Available_spheres|sphere]]
| Can be any available [[sphere]] - multiple entries are possible. Choosing a religious sphere will automatically make its opposing sphere not possible for the species to have: adding [[Sphere#WATER|WATER]], for example, means civs of this entity will never get [[Sphere#FIRE|FIRE]] as a religious sphere. Note that the [[Sphere#DEATH|DEATH]] sphere favours the appearance of necromancers (and therefore, towers) "in" the entity.

[RELIGION_SPHERE:FORTRESSES]

|-
| {{text anchor|SPHERE_ALIGNMENT}}
|
* [[Sphere#Available_spheres|sphere]]
* number
|
This token forces an entity to favor or disfavor particular religious spheres. Default is 256, minimum is 0, maximum is 25600.
* Presently, this doesn't cause them to acquire those spheres more often when generating a pantheon.
* [[Sphere#PLANTS|PLANTS]] and [[Sphere#ANIMALS|ANIMALS]] affect the prevalence of depicting {{token|VEGETATION}} and {{token|NATURAL}} creatures, respectively, in a similar fashion to {{token|ART_FACET_MODIFIER|e}}.
* [[Sphere#WAR|WAR]] modifies the effective [[item value]] of [[weapon]]s and [[armor]] to [[trader]]s of this entity. The multiplier is SPHERE_ALIGNMENT/256, though this only applies to equipment the entity's main creature can properly wield.

[SPHERE_ALIGNMENT:TREES:512]

|}

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

|-
| {{text anchor|POSITION}}
| string
| Defines a leader/noble position for a civilization. These replace previous tags such as [MAYOR] and [CAN_HAVE_SITE_LEADER] and so on. To define a position further, see [[Position token]].

|-
| {{text anchor|SITE_VARIABLE_POSITIONS}}
| Position responsibility or ALL
| Allows a site responsibility to be taken up by a dynamically generated position (lords, hearthpersons, etc.). Any defined positions holding a given responsibility will take precedence over generated positions for that responsibility. Also appears to cause site disputes.{{Verify}}

|-
| {{text anchor|VARIABLE_POSITIONS}}
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker). Any defined positions holding a given responsibility will take precedence over generated positions for that responsibility.

|}

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

|-
| {{text anchor|ETHIC}}
|
*behavior
*reaction
| Sets the civ's view of [[ethic]]s (certain behaviors), from capital punishment to completely acceptable. This also causes the civ to look upon opposing ethics with disfavor if their reaction to it is opposing, and when at extremes (one ACCEPTABLE, another civ UNTHINKABLE; for example) they will often go to war over it.
[ETHIC:EAT_SAPIENT_KILL:ACCEPTABLE]

|-
| {{text anchor|VALUE}}
|
*value
*number
| Sets the civ's [[Personality value|cultural values]]. Numbers range from -50 (complete anathema) to 0 (neutral) to 50 (highly valued).
[VALUE:CRAFTSMANSHIP:50]

Certain values must be set to 15 or more for civs to create structures and form entities during history gen:
* 15+ KNOWLEDGE for libraries
* 15+ COOPERATION ''and'' 15+ CRAFTSMANSHIP for craft guilds
** Guilds also need guild-valid professions (see [[#PERMITTED_JOB|PERMITTED_JOB]])

|-
| {{text anchor|VARIABLE_VALUE}}
|
*value or ALL
*min
*max
| Makes values randomized rather than specified.
This tag overrides the VALUE tag. Using [VARIABLE_VALUE:ALL:x:y] and then overwriting single values with further [VARIABLE_VALUE:value:x:y] tags works.

|-
| {{text anchor|WILL_ACCEPT_TRIBUTE}}
|
| Makes the civ's traders accept offered goods.

|-
| {{text anchor|WANDERER}}, {{text anchor|BEAST_HUNTER}}, {{text anchor|SCOUT}}, {{text anchor|MERCENARY}}
|
| The civ will send out these sorts of adventurers in worldgen, which seems to increase Tracker skill. These types of adventurers will sometimes be seen leading a battle (instead of war leaders or generals) in remote locations during world-gen, in charge of the defenders.

Mercenaries and monster hunters from the civ may visit player's fortress and petition for residency there to enlist in the military or hunt monsters in caverns, respectively.

|-
| {{text anchor|ABUSE_BODIES}}
|
| The civilization will mutilate bodies when they are the victors in history-gen warfare, such as hanging bodies from trees, putting them on spikes, and so forth. Adventurers killed in Adventurer mode will sometimes be impaled on spikes wherever they died, with or without this token, and regardless of whether they actually antagonized the townspeople.

|-
| {{text anchor|ACTIVE_SEASON}}
| season
| The season when the civ is most active: when they will trade, interact with you via diplomats, and/or invade you. Civs can have multiple season entries. Note: If multiple caravans arrive at the same time, you are able to select which civ to trade with at the depot menu. ACTIVE_SEASON tags may be changed for a currently active fort.
[ACTIVE_SEASON:AUTUMN]

|-
| {{text anchor|AMBUSHER}}
|
| When invading, sneaks around and shoots at straggling members of your society. They will spawn on the edge of the map and will only be visible when one of their party are spotted; this can be quite dangerous to undefended trade depots. If the civilization also has the SIEGER token, they will eventually ramp it up to less subtle means of warfare.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
|
| Will not attack wildlife, and will not be attacked by them, even if you have them in your party. This can be somewhat disconcerting when attacked by bears in the forest, and your elven ally sits back and does nothing. Additionally, this token determines if the entity can settle in savage biomes.

|-
| {{text anchor|BABYSNATCHER}}
|
| Sends thieves to steal babies. Without this tag (or AMBUSHER, or ITEM_THIEF), enemy civs will only siege (if capable), and will siege as early as they would otherwise babysnatch. This can happen as early as the first year of the fort! In addition, babysnatcher civs will snatch children during worldgen, allowing them to become part of the civ if they do not escape. Also causes this civ to be hostile to any entity without this token.

Note: If the playable civ in fortress mode has this tag (e.g. you add BABYSNATCHER to the dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and goblins will be friendly to you. However, animals traded away to one's own caravan will count as snatched, reported upon the animal leaving the map, and the animal will not count as having been exported.

|-
| {{text anchor|BUILDS_OUTDOOR_FORTIFICATIONS}}
|
| Makes the civilization build castles from [[mead hall]]s. Only functions when the type of site built is a hamlet/town. This, combined with the correct type of [[position token|position]] associated with a site, is why adventurers can only lay claim to human sites. {{bug|8001}}

|-
| {{text anchor|BUILDS_OUTDOOR_TOMBS}}
|
| Makes the civilization build tombs.

|-
| {{text anchor|BANDITRY}}
| percentage
| Sets a percentage of the entity population to be used as bandits.

|-
| {{text anchor|DIPLOMAT_BODYGUARDS}}
|
| Visiting diplomats are accompanied by a pair of soldiers.
|-
| {{text anchor|GENERATED}}
|
| Found on generated divine "HF Guardian Entities". Cannot be used in user-defined raws.

|-
| {{text anchor|INVADERS_IGNORE_NEUTRALS}}
|
| Causes invaders to ignore visiting caravans and other neutral creatures.{{verify}}

|-
| {{text anchor|ITEM_THIEF}}
|
| Sends thieves to steal items. This will also occur in history generation, and thieves will have the "thief" profession. Items stolen in history gen will be scattered around that creature's home. Also causes that civ to be hostile to any entity without this token. Without this tag (or AMBUSHER, or BABYSNATCHER), enemy civs will only siege (if capable), and will siege as early as they would otherwise steal.

Note: If the playable civ in Fortress Mode has this tag (e.g. you add ITEM_THIEF to the Dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and kobolds will be friendly to you. However, ALL items traded away to one's own caravan will count as stolen, reported when the items leave the map, and the stolen items will not count as exported.

|-
| {{text anchor|LOCAL_BANDITRY}}
|
| Causes the entity to send out patrols that can ambush adventurers. Said patrols will be hostile to any adventurers they encounter, regardless of race or nationality.

|-
| {{text anchor|MERCHANT_BODYGUARDS}}
|
| Caravan merchants are accompanied by soldiers.

|-
| {{text anchor|MERCHANT_NOBILITY}}
|
| Merchants will engage in cross-civ trading and form companies.

In previous versions, this resulted in the civ having a Guild Representative / Merchant Baron / Merchant Prince, but now this is controlled solely by positions.

|-
| {{text anchor|PROGRESS_TRIGGER_POPULATION}}
| level
| 0 to 5, civ will come to site once population at site has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 20 dwarves, 2 to 50 dwarves, 3 to 80, 4 to 110, and 5 to 140. Progress triggers may be changed, added, or deleted for a currently active fort. Note: hostile civs require that this be fulfilled as well as at least one other non-siege trigger before visiting for non-siege activities.

|-
| {{text anchor|PROGRESS_TRIGGER_PRODUCTION}}
| level
| 0 to 5, civ will come to site once created wealth has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 5000☼ created wealth, 2 to 25000☼, 3 to 100000☼, 4 to 200000☼, and 5 to 300000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| {{text anchor|PROGRESS_TRIGGER_TRADE}}
| level
| 0 to 5, civ will come to site once exported goods has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 500☼ exported wealth, 2 to 2500☼, 3 to 10000☼, 4 to 20000☼, and 5 to 30000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| {{text anchor|PROGRESS_TRIGGER_POP_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger.

|-
| {{text anchor|PROGRESS_TRIGGER_PROD_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| {{text anchor|PROGRESS_TRIGGER_TRADE_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| {{text anchor|SIEGER}}
|
| Will start campfires and wait around at the edge of your map for a month or two before rushing in to attack. This will occur when the progress triggers for sieging are reached. If the civ lacks smaller methods of conflict (AMBUSHER, BABYSNATCHER, ITEM_THIEF), they will instead send smaller-scale sieges when their triggers for "first contact" are reached.

|-
| {{text anchor|SIEGE_SKILLED_MINERS}}{{v|53.01}}
|
| Improves the skill of [[miner]] invaders by a factor of 5. Used for [[dwarves]] in vanilla.

|-
| {{text anchor|SITE_GUARDIAN}}
|
| Guards certain special sites, such as a [[vault]] belonging to a [[demon]] allied with a [[deity]]. Used in generated divine entities.

|-
| {{text anchor|SKULKING}}
|
| This makes the severity of attacks depend on the extent of item/baby thievery rather than the passage of time. Designed to go with ITEM_THIEF, may or may not work with BABYSNATCHER. Prevents the civ from engaging in diplomacy or ending up at war.

|-
| {{text anchor|TREE_CAP_DIPLOMACY}}
|
| Visiting diplomats impose tree cutting quotas; without this, they will simply compliment your fortress and leave. Also causes the diplomat to make unannounced first contact at the very beginning of the first spring after your fortress becomes a land holder.

|-
| {{text anchor|LAYER_LINKED}}
|
| Defines if a civilization is a hidden subterranean entity, such as [[bat man]] civilizations. May spawn in any of the three caverns; cavern dweller raids due to [[agitation]] will pull from these. If you embark as this civ, you have access to pets and trees from all three layers, not only the first.

|-
| {{text anchor|GENERATE_KEYBOARD_INSTRUMENTS}}, {{text anchor|GENERATE_PERCUSSION_INSTRUMENTS}}, {{text anchor|GENERATE_STRINGED_INSTRUMENTS}}, {{text anchor|GENERATE_WIND_INSTRUMENTS}}, {{text anchor|GENERATE_DANCE_FORMS}}, {{text anchor|GENERATE_MUSICAL_FORMS}}, {{text anchor|GENERATE_POETIC_FORMS}}
|
| Makes civilizations generate the given instruments/forms.

|-
| {{text anchor|SCHOLAR}}
| scholar type
| ALL, ASTRONOMER, CHEMIST, DOCTOR, ENGINEER, GEOGRAPHER, HISTORIAN, MATHEMATICIAN, NATURALIST, PHILOSOPHER

|-
| {{text anchor|SET_SCHOLARS_ON_VALUES_AND_JOBS}}
|
| Generates scholars based on the values generated with the VARIABLE_VALUE tag.

|-
| {{text anchor|NO_ARTIFACT_CLAIMS}}
|
| Used for kobolds.

|-
| {{text anchor|MINING_UNDERWORLD_DISASTERS}}
|
| The civilization can breach the [[Underworld]] during world generation, spawning a civilization of {{token|EVIL}} creatures lead by a unique [[demon]].

|-
| {{text anchor|MYTHICAL}}{{version|51.01-beta26}}
|
| Builds [[mysterious dungeon]]s.

|}

== Available resources ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|AMMO}}
| item token
| Used after a ranged weapon type.
[AMMO:ITEM_AMMO_BOLTS]

|-
| {{text anchor|ARMOR}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). FORCED items will be available 100% of the time, COMMON items 50%, UNCOMMON items 10%, and RARE items 1%. If certain armor types are lacking after performing one pass of randomised checks, the game will repeat random checks until an option is successfully chosen.
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]

|-
| {{text anchor|DIGGER}}
| item token
| Causes the selected weapon to fall under the "digging tools" section of the embark screen. Also forces the weapon to be made out of metal, which can cause issues if a modded entity has access to picks without access to metal - for those cases, listing the pick under the [WEAPON] token works just as well. Note that this tag is neither necessary nor sufficient to allow use of that item as a mining tool – for that, the item itself needs to be a weapon with [SKILL:MINING].
[DIGGER:ITEM_WEAPON_PICK]

|-
| {{text anchor|GLOVES}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

|-
| {{text anchor|HELM}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[HELM:ITEM_HELM_HELM:COMMON]

|-
| {{text anchor|INSTRUMENT}}
| item token
| No longer used as of [[:Category:Version 0.42.01|Version 0.42.01]] due to the ability to generate instruments in world generation. It is still usable if pre-defined instruments are modded in, and generated musical forms are capable of selecting pre-defined instruments to use. However, reactions for making instruments, instrument parts, and/or assembling such instruments need to be added as well, as this token no longer adds such instruments to the craftdwarf's workshop menu.
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

|-
| {{text anchor|PANTS}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[PANTS:ITEM_PANTS_PANTS:COMMON]

|-
| {{text anchor|SHIELD}}
| item token
|
[SHIELD:ITEM_SHIELD_SHIELD]

|-
| {{text anchor|SHOES}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[SHOES:ITEM_SHOES_SHOES:COMMON]

|-
| {{text anchor|SIEGEAMMO}}
| item token
|
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]

|-
| {{text anchor|TOOL}}
| item token
|
[TOOL:ITEM_TOOL_NEST_BOX]

|-
| {{text anchor|TOY}}
| item token
|
[TOY:ITEM_TOY_PUZZLEBOX]

|-
| {{text anchor|TRAPCOMP}}
| item token
|
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]

|-
| {{text anchor|WEAPON}}
| item token
| While this does not accept a rarity value, something similar can be achieved by having multiple variations of a weapon type with small differences and specifying each of them.{{cite forum|179547}}
[WEAPON:ITEM_WEAPON_AXE_BATTLE]

|-
| {{text anchor|USE_ANIMAL_PRODUCTS}}
|
| Allows use of products made from animals. All relevant creatures will be able to provide wool, silk, and extracts (including milk and venom) for trade, and non-sentient creatures (unless ethics state otherwise) will be able to provide eggs, caught fish, meat, leather, bone, shell, pearl, horn, and ivory.

|-
| {{text anchor|USE_ANY_PET_RACE}}
|
| Any creature in the civilization's list of usables (from the surrounding 7x7 or so of squares and map features in those squares) which has PET or {{catlink|Exotic pet|PET_EXOTIC}} will be available as a pet, pack animal (with PACK_ANIMAL), wagon puller (with WAGON_PULLER), mount (with {{catlink|Mount|MOUNT}} or {{catlink|Exotic mount|MOUNT_EXOTIC}}), or siege minion (with {{catlink|War animals|TRAINABLE_WAR}} and ''without'' {{catlink|Learns|CAN_LEARN}}). This notion of the initial usable creature list, which then gets pared down or otherwise considered, applies below as well. All common domestic and equipment creatures are also added to the initial list.

|-
| {{text anchor|USE_CAVE_ANIMALS}}
|
| If they don't have it, creatures with exclusively subterranean biomes are skipped. If they have it, cave creatures with PET will also be available as pets, pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with {{catlink|Mount|MOUNT}} or {{catlink|Exotic mount|MOUNT_EXOTIC}}), and siege minions (with {{catlink|War animals|TRAINABLE_WAR}} and ''without'' {{catlink|Learns|CAN_LEARN}}).

|-
| {{text anchor|USE_EVIL_ANIMALS}}
|
| Without this, EVIL creatures are skipped, otherwise, evil creatures with SLOW_LEARNER or ''without'' {{catlink|Learns|CAN_LEARN}} will be also available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with {{catlink|Mount|MOUNT}} or {{catlink|Exotic mount|MOUNT_EXOTIC}}), and siege minions (with {{catlink|War animals|TRAINABLE_WAR}} or SLOW_LEARNER), even the normally untameable species.

|-
| {{text anchor|USE_EVIL_PLANTS}}
|
| Same as USE_EVIL_ANIMALS for all uses of plants.

|-
| {{text anchor|USE_EVIL_WOOD}}
|
| Same as USE_EVIL_ANIMALS for all uses of wood.

|-
| {{text anchor|USE_GOOD_ANIMALS}}
|
| Without this GOOD creatures are skipped, otherwise, good creatures ''without'' {{catlink|Learns|CAN_LEARN}} will also be available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with {{catlink|Mount|MOUNT}} or {{catlink|Exotic mount|MOUNT_EXOTIC}}), and siege minions (with {{catlink|War animals|TRAINABLE_WAR}}), even the normally untameable species.

|-
| {{text anchor|USE_GOOD_PLANTS}}
|
| Same as USE_GOOD_ANIMALS for all uses of plants.

|-
| {{text anchor|USE_GOOD_WOOD}}
|
| Same as USE_GOOD_ANIMALS for all uses of wood.

|-
| {{text anchor|USE_MISC_PROCESSED_WOOD_PRODUCTS}}
|
| If the relevant professions are permitted, controls availability of lye (LYE_MAKING), charcoal (BURN_WOOD), and potash (POTASH_MAKING).

|-
| {{text anchor|USE_NON_EXOTIC_PET_RACE}}
|
| Makes the civilization use all locally available non-exotic pets.

|-
| {{text anchor|COMMON_DOMESTIC_MOUNT}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and {{catlink|Mount|MOUNT}}. Additionally, all available (based on USE_ANY_PET_RACE, USE_CAVE_ANIMALS, USE_GOOD_ANIMALS, and USE_EVIL_ANIMALS) creature with {{catlink|Mount|MOUNT}} and PET will be allowed for use as mounts during combat.

|-
| {{text anchor|COMMON_DOMESTIC_PACK}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and PACK_ANIMAL. Additionally, all available (see above) creatures with PACK_ANIMAL and PET will be allowed for use during trade as pack animals.

|-
| {{text anchor|COMMON_DOMESTIC_PET}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and PET. Additionally, all available (see above) creatures with PET will be allowed for use as pets.

|-
| {{text anchor|COMMON_DOMESTIC_PULL}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and WAGON_PULLER. Additionally, all available (see above) creatures with WAGON_PULLER and PET will be allowed for use during trade to pull [[wagon]]s.

|-
| {{text anchor|RIVER_PRODUCTS}}
|
| Allow use of river products in the goods available for trade.

|-
| {{text anchor|OCEAN_PRODUCTS}}
|
| Allow use of ocean products (including [[amber]] and [[coral]]) in the goods available for trade. Without OCEAN_PRODUCTS, civilizations will not be able to trade ocean fish even if they are ''also'' available from other sources (e.g. [[sturgeon]]s and [[stingray]]s).

|-
| {{text anchor|INDOOR_FARMING}}
|
| Allow use of underground plant products in the goods available for trade. Lack of suitable vegetation in the caverns will cause [[World generation#Rejections|worldgen rejection]]s. According to Droseran: "Gives access to plants (structural material) and seeds. It only checks for [EDIBLE_RAW] or [EDIBLE_COOKED] on the plant's structural material. It doesn't check if the plant can be used in a reaction to produce something edible, only if it can be eaten raw or cooked. If an entity with this token is placed in a biome that doesn't have at least one of these tokens on the structural material, the map is rejected. Due to the randomness of plant selection in biomes, this can happen a lot as only about half of the vanilla plants have edible structural materials. Removing either of these tokens from plants dramatically increases map rejections."

|-
| {{text anchor|OUTDOOR_FARMING}}
|
| Allow use of outdoor plant products in the goods available for trade. Lack of suitable vegetation in this civilization's starting area will cause [[World generation#Rejections|worldgen rejection]]s. According to Droseran: "Gives access to plants (structural material) and seeds. It only checks for [EDIBLE_RAW] or [EDIBLE_COOKED] on the plant's structural material. It doesn't check if the plant can be used in a reaction to produce something edible, only if it can be eaten raw or cooked. If an entity with this token is placed in a biome that doesn't have at least one of these tokens on the structural material, the map is rejected. Due to the randomness of plant selection in biomes, this can happen a lot as only about half of the vanilla plants have edible structural materials. Removing either of these tokens from plants dramatically increases map rejections."

|-
| {{text anchor|INDOOR_GARDENS}}
|
| Allow use of underground plant growths (quarry bush leaves, in unmodded games) in the goods available for trade. According to Droseran: "Will never cause map rejections. It allows growths to be used, but doesn't care if none exist. If an entity doesn't have a farming token, they won't have seeds or plants available on embark/trade. But you can still farm in fortress mode with only this token, you just have to get the seeds manually or trading with another civ."

|-
| {{text anchor|OUTDOOR_GARDENS}}
|
| Allow use of outdoor plant growths in the goods available for trade. According to Droseran: "Will never cause map rejections. It allows growths to be used, but doesn't care if none exist. If an entity doesn't have a farming token, they won't have seeds or plants available on embark/trade. But you can still farm in fortress mode with only this token, you just have to get the seeds manually or trading with another civ."

|-
| {{text anchor|INDOOR_ORCHARDS}}
|
| Allows use of indoor tree growths in the goods available for trade. Not used in vanilla entities, as vanilla underground trees do not grow fruit. Needs INDOOR_WOOD to function. Will cause rejections, if growths are unavailable. According to Droseran: "Gives access to tree growths. It only checks for growths on trees that are [EDIBLE_RAW] or [EDIBLE_COOKED]. If an entity with this token is placed in a biome that does not have a tree with a growth with at least one of these tokens, the map is rejected."

|-
| {{text anchor|OUTDOOR_ORCHARDS}}
|
| Allows use of outdoor tree growths in the goods available for trade. Needs OUTDOOR_WOOD to function{{verify}}. According to Droseran: "Gives access to tree growths. It only checks for growths on trees that are [EDIBLE_RAW] or [EDIBLE_COOKED]. If an entity with this token is placed in a biome that does not have a tree with a growth with at least one of these tokens, the map is rejected."

|-
| {{text anchor|CLOTHING}}
|
| Civilization members will attempt to wear clothing.

|-
| {{text anchor|SUBTERRANEAN_CLOTHING}}
|
| Will wear things made of spider silk and other subterranean materials.

|-
| {{text anchor|EQUIPMENT_IMPROVEMENTS}}
|
| Adds decorations to equipment based on the level of the generated unit. Also improves item quality.

|-
| {{text anchor|IMPROVED_BOWS}}
|
| Adds decorations to weapons generated for bowman and master bowman.

|-
| {{text anchor|METAL_PREF}}
|
| Allows metal materials to be used to make cages (inexpensive metals only) and crafts.

|-
| {{text anchor|STONE_PREF}}
|
| Allows the civilization to make use of nearby stone types. If the FURNACE_OPERATOR job is permitted, also allows ore-bearing stones to be smelted into metals.

|-
| {{text anchor|WOOD_WEAPONS}}
|
| The civilization can make traditionally metallic weapons such as swords and spears from wood.

|-
| {{text anchor|WOOD_ARMOR}}
|
| The civilization can make traditionally metallic armor such as mail shirts and helmets from wood.

|-
| {{text anchor|GEM_PREF}}
|
| Enables creatures of this entity to bring gems in trade.

|-
| {{text anchor|INDOOR_WOOD}}
|
| Allow use of subterranean wood types, such as tower-cap and fungiwood logs.

|-
| {{text anchor|OUTDOOR_WOOD}}
|
| Allow use of outdoor wood types, such as mangrove and oak.

|-
| {{text anchor|GEM_SHAPE}}
| [[Descriptor shape token|shape]]
| Precious gems cut by this civilization's jewelers can be of this shape.

|-
| {{text anchor|STONE_SHAPE}}
| [[Descriptor shape token|shape]]
| Ordinary non-gem stones cut by this civilization's jewelers can be of this shape.

|-
| {{text anchor|DIVINE_MAT_CLOTHING}}
|
| Allows use of materials with [DIVINE] for clothing. Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_CRAFTS}}
|
| Allows use of materials with [DIVINE] for crafts.{{verify}} Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_WEAPONS}}
|
| Allows use of metals with [DIVINE] for weapons. Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_ARMOR}}
|
| Allows use of metals with [DIVINE] for armor. Used for generated divine entities.
|}

== Animal definitions ==

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

|-
| {{text anchor|ANIMAL}}
|
| Start an animal definition.

|-
| {{text anchor|ANIMAL_TOKEN}}
| [[creature token]]
| Select specific creature.

|-
| {{text anchor|ANIMAL_CASTE_TOKEN}}
| [[Caste|creature caste token]]
| Select specific creature caste (requires ANIMAL_TOKEN). Sites with animal populations will still include all castes, but only the selected ones will be used for specific roles.

|-
| {{text anchor|ANIMAL_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Select creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_FORBIDDEN_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Forbid creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_ALWAYS_PRESENT}}
|
| Animal will be present even if it does not naturally occur in the entity's terrain. All creatures, including [[demon]]s, night trolls and other generated ones will be used if no specific creature or class is selected.

|-
|
* {{text anchor|ANIMAL_NEVER_MOUNT}}, {{text anchor|ANIMAL_ALWAYS_MOUNT}}
* {{text anchor|ANIMAL_NEVER_WAGON_PULLER}}, {{text anchor|ANIMAL_ALWAYS_WAGON_PULLER}}
* {{text anchor|ANIMAL_NEVER_SIEGE}}, {{text anchor|ANIMAL_ALWAYS_SIEGE}}
* {{text anchor|ANIMAL_NEVER_PET}}, {{text anchor|ANIMAL_ALWAYS_PET}}
* {{text anchor|ANIMAL_NEVER_PACK_ANIMAL}}, {{text anchor|ANIMAL_ALWAYS_PACK_ANIMAL}}
|
| Override creature usage tokens. Respectively:
* [[Creature token#MOUNT|MOUNT]] and [[Creature token#MOUNT_EXOTIC|MOUNT_EXOTIC]]
* [[Creature token#WAGON_PULLER|WAGON_PULLER]]
* [[Creature token#TRAINABLE_WAR|TRAINABLE_WAR]] and not [[Creature token#CAN_LEARN|CAN_LEARN]]
* [[Creature token#PET|PET]] and [[Creature token#PET_EXOTIC|PET_EXOTIC]]
* [[Creature token#PACK_ANIMAL|PACK_ANIMAL]]
ALWAYS overrides NEVER if a caste is matched by more than one animal definition.

|}

== Tissue styling-related tokens ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|TISSUE_STYLE}}
| tissue style unit ID
| Select a tissue layer which has the ID attached using TISSUE_STYLE_UNIT token in unit raws. This allows setting further cultural style parameters for the selected tissue layer.

|-
| {{text anchor|TS_MAINTAIN_LENGTH}}
|
* minimum length?
* maximum length?
| Presumably sets culturally preferred tissue length for selected tissue. Needs testing.
Dwarves have their beards set to 100:NONE by default.

|-
| {{text anchor|TS_PREFERRED_SHAPING}}
| styling token
| Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.
Presumably sets culturally preferred tissue shapings for selected tissue. Needs testing.

|}

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

{{Category|Modding}}
{{Category|Tokens}}
{{Category|Entities}}
[[ru:Entity token]]

Development arc

2025-11-04T01:43:28Z

DPhKraken: /* Past */

In earlier days of ''Dwarf Fortress'', development was split up into outlined specific '''Arcs'''. That system was largely scrapped in favor of a private roadmap, where each choke point consists in a list of "notes", i.e. features that would be necessary for a release. The notes and roadmap are kept private because they have been proven to be too time-consuming to maintain in public, as they may be subject to frequent change.

However, even with the arc system mostly gone, certain major releases have been given names after their main focus by [[Toady One]]. These releases both include ones already released, ones being developed, and ones far into the future. These releases, or the time periods spent working on them, are often called "arcs" by the ''Dwarf Fortress'' community.

== Named Releases ==
=== Future ===
Next release has not officially been confirmed, though previously the following have been tentatively announced.
* The adventure mode site building: the return of [[Camp#Adventurer_camps|camp founding and building]].
* The map release: A rework of the generated spaces and regions, allowing for more dynamic-reactive worlds. It has been previously known as the "Big Wait" before myth and magic, but is planned to be released incrementally alongside smaller magical features.
* The villains release (second part): the second part of the villains release, finishing what was left when focus shifted to the Premium release, though possibly to be divided into multiple smaller releases.
==== Sources ====
* ''[https://store.steampowered.com/news/app/975370/view/530964346754301996 Next Steps for Dwarf Fortress + Patch 51.05 ⛏ Dwarf Fortress Dev News]'' Steam news.
* ''[https://www.youtube.com/watch?v=zw_-jdN8zcA Tarn Time - Dwarf Fortress Seasonal Update (Spring 2025)]'' YouTube video.
* ''[https://www.bay12games.com/dwarves/dev.html Dwarf Fortress Development]'' Bay 12 Games website page.

=== Possible Future ===
These are things that might be future releases, but have not been officially announced.
* The myth and magic release: scheduled to be a very long release cycle, it will add myth generation to the game, and a [[magic]] system that will tie to the original myths. With the presence of "fantasy ratings" that alter how magically the world will behave (from only humans, to a world filled with the strangest creatures), it is expected to be a complete overhaul of the game that will dramatically alter its gameplay. [[Lua scripting]], introduced as an experimental feature in 51.06, will be used for more powerful procedural generation.
* The starting scenarios release: will expand on the laws, property, customs and status framework to provide reasons for your fortress to be and guidelines on how to govern it (different kinds of migrants, different standings regarding the mountainhome, different diplomatic relationships, etc.)
* The boats release: will feature, well, boats, with all that entails (ports, maritime trade routes, pirates, and so on). Probably multi-tile creatures as well, as mechanics on how to make boats (floating superstructures) work will be borrowed to make multi-tile creatures as well.
* The economy release: will piggyback on the new trade and property stuff to establish a new framework that will completely overhaul the old (and deactivated) [[economy]] system.

=== Past ===
* The [[night creature]] release (0.34.01): added [[necromancer]]s, [[mummy|mummies]], [[vampire]]s, [[werebeast]]s as well as a complete [[undead]] overhaul. Other notable additions include evil [[weather]], improved human [[site]]s featuring [[catacombs]], [[sewer]]s and [[dungeon]]s, and a number of animals added to the game.
* The [[World activities|world activation]] release (0.40.01): allowed many [[world generation]] activities to carry on during normal gameplay, as opposed to a static world. Other notable additions include non-human [[site]]s, multi-tile trees, retireable fortresses, claimable non-player fortresses and a great variety of plants and additional animal people.
* The [[tavern]] release (0.42.01): added taverns and [[visitor]]s to the game. Other notable additions include fortress [[temple]]s, [[library|libraries]] (with [[scholar]]s complete with a [[knowledge]] system), a [[paper]] industry, art forms (music, dance and writing) and non-dwarven citizens.
* The [[artifact]] release (0.44.01): added non-player artifacts to the game. Other notable additions include the ability to send [[squad]]s of dwarves off the map (on [[mission]]s to raid sites, rescue citizens, retrive artifacts, explore ruins and so on), secret [[agent]]s, non-player [[quester]]s and improved [[kobold]] sites.
* The [[villain]]s release (first part) (0.47.01): added villains to the game, giving them goals and the ability to subvert other people into various corruption activities such as embezzlement, sabotage, kidnapping or assassination. Other notable additions included improved relationships (divorce and remarriage, children outside marriage, different kinds of friendships), improved religions (featuring prophets and monastic orders), trade companies, craft guilds, new sites (monasteries, bandit forts and the return of castles) as well as several new [[night creature]]s. This release was cut short, leaving out most of the [[cv:fortress mode|fortress mode]] and [[cv:adventure mode|adventure mode]] villainy, to hasten the Premium release.
* The Premium release (or the Steam release) (50.01): the first commercial release of ''Dwarf Fortress''. also known as ''Dwarf Fortress Premium''. As the primary commercial platform is [https://store.steampowered.com/app/975370/Dwarf_Fortress/ Steam], it is also known as the Steam release, though it is also available on [https://kitfoxgames.itch.io/dwarf-fortress itch.io]. It included a complete overhaul of UI and graphics, bug fixes, as well as an official pixel-art [[graphics set]]. A concurrent free version is still available as ''Dwarf Fortress Classic'' (Available on 12/22/22 since version 50.04 at [https://bay12games.com/dwarves/ Bay 12 Games]), which has feature parity but not the official graphics set.
* The adventure release (51.01): Re-enables [[Adventurer mode]] with a new interface and additional graphics. Implements [[:Category:Myth|mythical]] features such as [[chosen]] adventurers and [[mysterious dungeon]]s.
* The siege release (53.01): An improvement of [[siege]]s, with a focus on more intelligent invader tactics, balanced [[trap]]s, and updated [[siege engine]]s. [https://store.steampowered.com/news/app/975370/view/530964346754301996][https://store.steampowered.com/news/app/975370/view/528732929177683220][https://store.steampowered.com/news/app/975370/view/536616130148565319][https://store.steampowered.com/news/app/975370/view/530987265859522075]

== Arcs ==
''Dwarf Fortress'' development has moved away from the old large arc based strategy. The old [[Consolidated Development]] page lists 21 "short-term arcs" and 15 "long-term arcs". Not all arcs would have taken take the same length of time to complete. Each arc also encompassed certain cores, requirements, bloats, and power goals.

Here are a few notable ones:

*[[Army arc]]: possibly the biggest endeavor out of all the current arcs, it was never fully completed. Version 0.31.01 introduced many army arc features.
*[[Caravan arc]]: another famous arc, focusing on fleshing out the caravans (Status unknown as of v0.47.05, may have been completed.)
*[[County arc]]
*[[Life cycle arc]]
*[[Presentation arc]]

==External links==
* [http://www.bay12games.com/dwarves/dev_single.html ''Consolidated Development Page with Near-Term Arcs''] (outdated)

[[Category:Arcs| ]]
[[Category:Game development]]
{{unversioned}}
[[ru:Development arc]]

Random creature profile

2025-10-24T22:17:30Z

DPhKraken: Updated for Lua release

{{av}}
{{Minorspoiler}}

This is a list of '''random creature profiles''' ('''RCPs''') which are used by procedurally-generated creatures. RCPs typically use body parts from <code>body_rcp.txt</code> instead of <code>body_default.txt</code>.

== Overview ==
RCP stands for "[http://www.bay12forums.com/smf/index.php?topic=30026.msg831163#msg831163 random creature profile]". RCP is a [[Lua scripting|scripted]] [[raw]] template that defines the basic body, tissues and body attacks of a random creature before it receives [[Lua scripting#Tweaks|further randomness]] (three-eyed, wings of stretched skin, external ribs, uniform elemental composition, etc). Most amphibian, mammalian and reptilian RCPs have humanoid variations of themselves, described as "in humanoid form" or "{{Tooltip|twisted into humanoid form|If evil.}}". There are 243 standard RCPs and 81 humanoid variations, which brings the known total to 324.

The RCP of a randomly generated creature can be identified by its description. Many RCPs have identical names with normal [[creature]]s (e.g. [[albatross]]), although they are entirely unrelated; other RCPs feature animals that don't exist anywhere else, such as zebras. Some RCPs have inherent abilities like flight or [[web]]bing.

[[Night troll]]s and [[bogeyman|bogeymen]] only use the generic "humanoid" RCP, and werebeasts use the humanoid animal forms. Primates, hexapods, octopods and decapods are unique to beast-like [[experiment]]s, while armless bipeds, wyrms, and the generic "snake" and "worm" RCPs are unique to failed experiments.

== Technical details ==
{{main|Lua scripting}}

Random creature profiles can be found in ``vanilla_procedural/scripts/``. By adding data to the corresponding tables, it is possible to [[mod]] in new random creature profiles.

This [https://nm.reddit.com/r/dwarffortress/comments/kq86x5/i_made_some_calculations_towards_determining_the/gi2l7py/ explanation from Toady], shared by Meph, goes into more detail on how procedural creature generation works:

<blockquote>
The ``body_rcp.txt`` file has the definitions it expects for bodyparts. (rcp stands for "random creature profile") The main thing is that the base "animal" word is doing most of the heavy lifting in terms of making the descriptions evocative, so the rcp's don't end up mattering that much. There are little internal definitions for each animal word, about 230 of them. If we ignore that, then we're more just working with "feathered quadruped" and so forth.

Example of a random creature profile (for the elephant type):

<syntaxhighlight lang="lua">
random_creature_types.MAMMAL_ELEPHANT={
name_string="elephant",
tile='E',
body_base="QUADRUPED",
c_class="MAMMAL",
must_have_tail=true,
must_have_elephant_trunk=true,
min_size=500000,
weight=14
}
</syntaxhighlight>

So, hmm, perhaps the base and class lists are relevant here...

* classes (``random_creature_class``): mammal, chitin exo, fleshy, amphibian, reptile, feathered reptile, avian, uniform (like 'composed of iron')

* bases (``body_base_fun``): amorphous, insect, insect larva, spider, scorpion, ten legged, eight legged, worm, no limbs, quadruped, snake, humanoid, two legs + no arms, quadruped with front graspers (like a monkey)

The [[Lua functions#RCP Parameters|flags]] just force certain RCP additions, and prevent others from happening. For instance, the "slug" profile has "cannot have shell" because a slug with a shell is confusing.

Ah, here we go. The RCP are used via the "body tweak" system. A body can have a tweak from category one, a tweak from category two, and an attack tweak, respecting its profile flags.

* Category one tweaks (``options.btc``): wings, flightless wings, tail, proboscis, trunk, shell, antennae, head horns, large mandibles, twisted into humanoid form, six legged, eight legged

* Category two tweaks (``options.btc2``): hair, feathers, scales, exoskeleton, skin, skin/bones, no eyes, one eye, three eyes, beak missing, nose missing, external ribs, lidless eyes, skinless

* Attack tweaks (``options.attack_tweak``): tail stinger, insect stinger, blood proboscis, fire, webs, breath (trailing flow), breath (glob), breath (undirected), secretion, poisonous blood, poisonous bite

That material list (``random_creature_material``) looks almost right - here's the official list of variables: ash, mud, vomit, salt (powder), grime, snow, water, steam, flame, amber, coral, green glass, clear glass, crystal glass, charcoal, coke, salt (solid), ice, mineral (any), soil (any), gem (any), metal (any)

The "any" materials can't be "[[Inorganic material definition token#SPECIAL|special]]", but there don't appear to be other restrictions.
There are various other implicit flags on these things when it comes to werebeasts etc. "humanoidable" and "beast", for example. So all night creatures require "humanoidable" and werebeasts require "beast" on top of that. Which is why we don't have wereblobs or even wereserpents.
</blockquote>

== List ==
In ASCII mode, nearly all RCPs use specific uppercase or lowercase letters if the monster type does not use a fixed tile, such as '&' for demons. Lobsters uniquely use the '¥' sign instead. RCPs with humanoid versions are '''bolded'''. Humanoid forms use the same tile as their standard counterparts.

Capitalization denotes body size. In most cases, anything larger than a [[dwarf]] (60,000) uses an uppercase letter. Only uppercase letters are shown here.

In-game, the tile color is determined by the creature's external color modifier. If it does not have a color modifier and is not skinless, it uses the outermost tissue layer's default material color. If it is skinless, it is displayed in dark red (4:0:0).

{{columns-list|colwidth=15em|
* {{Tile|A|7:0}} Albatross
* {{Tile|A|7:0}} '''Alligator'''
* {{Tile|A|7:0}} Anaconda
* {{Tile|A|7:0}} Ankylosaurid
* {{Tile|I|7:0}} Ant
* {{Tile|A|7:0}} '''Anteater'''
* {{Tile|A|7:0}} '''Antelope'''
* {{Tile|I|7:0}} Antlion larva
* {{Tile|A|7:0}} '''Ape'''
* {{Tile|I|7:0}} Aphid
* {{Tile|A|7:0}} '''Armadillo'''
* {{Tile|B|7:0}} Armless biped
* {{Tile|I|7:0}} Assassin bug
* {{Tile|B|7:0}} '''Badger'''
* {{Tile|B|7:0}} Bat
* {{Tile|B|7:0}} '''Bear'''
* {{Tile|B|7:0}} '''Beaver'''
* {{Tile|I|7:0}} Bee
* {{Tile|B|7:0}} '''Bison'''
* {{Tile|B|7:0}} Blob
* {{Tile|W|7:0}} Bristleworm
* {{Tile|B|7:0}} '''Buffalo'''
* {{Tile|B|7:0}} '''Bull'''
* {{Tile|B|7:0}} Bunting
* {{Tile|B|7:0}} Bushtit
* {{Tile|I|7:0}} Butterfly
* {{Tile|B|7:0}} Buzzard
* {{Tile|I|7:0}} Caddisfly
* {{Tile|C|7:0}} '''Camel'''
* {{Tile|C|7:0}} '''Capybara'''
* {{Tile|C|7:0}} Cardinal
* {{Tile|C|7:0}} '''Cat'''
* {{Tile|I|7:0}} Caterpillar
* {{Tile|C|7:0}} '''Cavy'''
* {{Tile|C|7:0}} Ceratopsid
* {{Tile|C|7:0}} '''Chameleon'''
* {{Tile|C|7:0}} Chickadee
* {{Tile|C|7:0}} Chicken
* {{Tile|C|7:0}} '''Chinchilla'''
* {{Tile|I|7:0}} Cicada
* {{Tile|C|7:0}} '''Civet'''
* {{Tile|I|7:0}} Click beetle
* {{Tile|C|7:0}} '''Coati'''
* {{Tile|C|7:0}} Cobra
* {{Tile|C|7:0}} Cockatoo
* {{Tile|I|7:0}} Cockroach
* {{Tile|C|7:0}} Condor
* {{Tile|C|7:0}} '''Coyote'''
* {{Tile|C|7:0}} Crab
* {{Tile|C|7:0}} Crane
* {{Tile|I|7:0}} Cricket
* {{Tile|C|7:0}} '''Crocodile'''
* {{Tile|C|7:0}} Crow
* {{Tile|C|7:0}} Cuckoo
* {{Tile|I|7:0}} Damselfly
* {{Tile|I|7:0}} Darkling beetle
* {{Tile|D|7:0}} Decapod
* {{Tile|D|7:0}} '''Deer'''
* {{Tile|D|7:0}} Dimetrodon
* {{Tile|D|7:0}} '''Donkey'''
* {{Tile|D|7:0}} Dove
* {{Tile|I|7:0}} Dragonfly
* {{Tile|D|7:0}} Duck
* {{Tile|I|7:0}} Dung beetle
* {{Tile|E|7:0}} Eagle
* {{Tile|W|7:0}} Earthworm
* {{Tile|I|7:0}} Earwig
* {{Tile|E|7:0}} '''Elephant'''
* {{Tile|E|7:0}} '''Elk'''
* {{Tile|F|7:0}} Falcon
* {{Tile|F|7:0}} Fantail
* {{Tile|F|7:0}} Finch
* {{Tile|I|7:0}} Firefly
* {{Tile|F|7:0}} Flamingo
* {{Tile|W|7:0}} Flat worm
* {{Tile|I|7:0}} Flea
* {{Tile|I|7:0}} Fly
* {{Tile|F|7:0}} Flycatcher
* {{Tile|F|7:0}} '''Fox'''
* {{Tile|F|7:0}} '''Frog'''
* {{Tile|F|7:0}} Fruit bat
* {{Tile|G|7:0}} '''Gecko'''
* {{Tile|G|7:0}} '''Gila monster'''
* {{Tile|G|7:0}} '''Giraffe'''
* {{Tile|G|7:0}} '''Goat'''
* {{Tile|G|7:0}} Goose
* {{Tile|G|7:0}} '''Gopher'''
* {{Tile|I|7:0}} Grasshopper
* {{Tile|G|7:0}} Grebe
* {{Tile|G|7:0}} Grouse
* {{Tile|G|7:0}} Gull
* {{Tile|H|7:0}} Hadrosaurid
* {{Tile|H|7:0}} '''Hare'''
* {{Tile|H|7:0}} Harrier
* {{Tile|H|7:0}} Hawk
* {{Tile|H|7:0}} '''Hedgehog'''
* {{Tile|H|7:0}} Hexapod
* {{Tile|H|7:0}} '''Hippopotamus'''
* {{Tile|H|7:0}} Honeyeater
* {{Tile|H|7:0}} Hornbill
* {{Tile|I|7:0}} Hornet
* {{Tile|H|7:0}} '''Horse'''
* {{Tile|H|7:0}} Humanoid
* {{Tile|H|7:0}} Hummingbird
* {{Tile|H|7:0}} '''Hyena'''
* {{Tile|I|7:0}} '''Iguana'''
* {{Tile|I|7:0}} Iguanodont
* {{Tile|J|7:0}} '''Jackal'''
* {{Tile|J|7:0}} Jay
* {{Tile|K|7:0}} '''Kangaroo'''
* {{Tile|K|7:0}} Kestrel
* {{Tile|K|7:0}} Kingfisher
* {{Tile|K|7:0}} Kinglet
* {{Tile|K|7:0}} Kite
* {{Tile|K|7:0}} '''Koala'''
* {{Tile|I|7:0}} Lacewing
* {{Tile|I|7:0}} Ladybug
* {{Tile|L|7:0}} Lark
* {{Tile|L|7:0}} Leech
* {{Tile|L|7:0}} '''Lemur'''
* {{Tile|L|7:0}} '''Lizard'''
* {{Tile|L|7:0}} '''Llama'''
* {{Tile|¥|7:0}} Lobster
* {{Tile|L|7:0}} Loon
* {{Tile|L|7:0}} '''Loris'''
* {{Tile|I|7:0}} Louse
* {{Tile|L|7:0}} Lyrebird
* {{Tile|I|7:0}} Maggot
* {{Tile|M|7:0}} Magpie
* {{Tile|M|7:0}} '''Mammoth'''
* {{Tile|I|7:0}} Mantis
* {{Tile|M|7:0}} '''Marmot'''
* {{Tile|M|7:0}} Martin
* {{Tile|I|7:0}} Mayfly
* {{Tile|M|7:0}} Mite
* {{Tile|M|7:0}} Mockingbird
* {{Tile|M|7:0}} '''Mole'''
* {{Tile|M|7:0}} '''Mongoose'''
* {{Tile|M|7:0}} '''Monitor'''
* {{Tile|M|7:0}} '''Monkey'''
* {{Tile|M|7:0}} '''Moose'''
* {{Tile|I|7:0}} Mosquito
* {{Tile|I|7:0}} Moth
* {{Tile|M|7:0}} '''Mouse'''
* {{Tile|N|7:0}} Nematode
* {{Tile|N|7:0}} '''Newt'''
* {{Tile|N|7:0}} Nightjar
* {{Tile|N|7:0}} Nuthatch
* {{Tile|O|7:0}} Octopod
* {{Tile|O|7:0}} '''Opossum'''
* {{Tile|O|7:0}} Oriole
* {{Tile|O|7:0}} Osprey
* {{Tile|O|7:0}} '''Otter'''
* {{Tile|O|7:0}} Owl
* {{Tile|O|7:0}} Oxpecker
* {{Tile|P|7:0}} '''Panda'''
* {{Tile|P|7:0}} '''Pangolin'''
* {{Tile|P|7:0}} '''Panther'''
* {{Tile|P|7:0}} Parrot
* {{Tile|P|7:0}} Pelican
* {{Tile|P|7:0}} Penguin
* {{Tile|P|7:0}} Petrel
* {{Tile|P|7:0}} Pheasant
* {{Tile|P|7:0}} '''Pig'''
* {{Tile|P|7:0}} Pigeon
* {{Tile|P|7:0}} '''Porcupine'''
* {{Tile|P|7:0}} Primate
* {{Tile|P|7:0}} Pterosaur
* {{Tile|P|7:0}} Python
* {{Tile|Q|7:0}} Quadruped
* {{Tile|Q|7:0}} Quail
* {{Tile|Q|7:0}} Quetzal
* {{Tile|R|7:0}} '''Rabbit'''
* {{Tile|R|7:0}} '''Raccoon'''
* {{Tile|R|7:0}} '''Rat'''
* {{Tile|R|7:0}} Rattlesnake
* {{Tile|R|7:0}} Raven
* {{Tile|R|7:0}} '''Rhinoceros'''
* {{Tile|I|7:0}} Rhinoceros beetle
* {{Tile|W|7:0}} Ribbon worm
* {{Tile|I|7:0}} Rove beetle
* {{Tile|S|7:0}} '''Salamander'''
* {{Tile|S|7:0}} Sauropod
* {{Tile|I|7:0}} Scarab beetle
* {{Tile|S|7:0}} Scorpion
* {{Tile|I|7:0}} Scorpionfly
* {{Tile|S|7:0}} Serpent
* {{Tile|S|7:0}} '''Sheep'''
* {{Tile|S|7:0}} '''Shrew'''
* {{Tile|S|7:0}} Shrike
* {{Tile|S|7:0}} Shrimp
* {{Tile|I|7:0}} Silverfish
* {{Tile|S|7:0}} '''Skink'''
* {{Tile|S|7:0}} '''Skunk'''
* {{Tile|S|7:0}} '''Sloth'''
* {{Tile|S|7:0}} Slug
* {{Tile|S|7:0}} Snail
* {{Tile|S|7:0}} Snake
* {{Tile|I|7:0}} Snakefly
* {{Tile|S|7:0}} Sparrow
* {{Tile|S|7:0}} Spider
* {{Tile|S|7:0}} '''Squirrel'''
* {{Tile|I|7:0}} Stag beetle
* {{Tile|S|7:0}} Starling
* {{Tile|S|7:0}} Stegosaurid
* {{Tile|I|7:0}} Stick insect
* {{Tile|I|7:0}} Stonefly
* {{Tile|S|7:0}} Stork
* {{Tile|S|7:0}} Swallow
* {{Tile|S|7:0}} Swan
* {{Tile|S|7:0}} Swift
* {{Tile|T|7:0}} Tanager
* {{Tile|T|7:0}} '''Tapir'''
* {{Tile|S|7:0}} Tarantula
* {{Tile|I|7:0}} Termite
* {{Tile|T|7:0}} Theropod
* {{Tile|T|7:0}} Thornbill
* {{Tile|I|7:0}} Thrips
* {{Tile|T|7:0}} Thrush
* {{Tile|T|7:0}} Tick
* {{Tile|I|7:0}} Tiger beetle
* {{Tile|T|7:0}} Titmouse
* {{Tile|T|7:0}} '''Toad'''
* {{Tile|T|7:0}} '''Tortoise'''
* {{Tile|T|7:0}} Toucan
* {{Tile|T|7:0}} Turkey
* {{Tile|T|7:0}} '''Turtle'''
* {{Tile|V|7:0}} Viper
* {{Tile|V|7:0}} Vulture
* {{Tile|W|7:0}} Walrus
* {{Tile|W|7:0}} Warbler
* {{Tile|W|7:0}} '''Warthog'''
* {{Tile|I|7:0}} Wasp
* {{Tile|W|7:0}} Waxwing
* {{Tile|W|7:0}} '''Weasel'''
* {{Tile|I|7:0}} Weevil
* {{Tile|W|7:0}} '''Wolf'''
* {{Tile|W|7:0}} '''Wombat'''
* {{Tile|W|7:0}} Woodpecker
* {{Tile|W|7:0}} Worm
* {{Tile|W|7:0}} Wren
* {{Tile|W|7:0}} Wyrm
* {{Tile|Z|7:0}} '''Zebra'''
}}

== Graphics ==
All random creatures except [[werebeast]]s use [[graphics|graphic]] sprites found in <code>beasts.png</code> and <code>beasts_small.png</code>. There are 19 primary body sprites (6 are alternate-legged variations) with additional sprite layers representing secondary body parts. Several RCPs have one or more secondary sprite layers by default. A few RCPs, like quadrupeds, have more than one body sprite to randomly select from.

{| class="wikitable"
|+ RCP sprites, ignoring random body modifications, large sprites only
! RCPs
! Sprite
! Secondary graphic token(s)
! Primary graphic token
|-
| albatross, armless biped, bat, blob, bunting, bushtit, buzzard, cardinal, chickadee, chicken, cockatoo, condor, crane, crow, cuckoo, dove, duck, eagle, falcon, fantail, finch, flamingo, flycatcher, fruit bat, goose, grebe, grouse, gull, harrier, hawk, honeyeater, hornbill, hummingbird, jay, kestrel, kingfisher, kinglet, kite, lark, loon, lyrebird, magpie, martin, mockingbird, nightjar, nuthatch, oriole, osprey, owl, oxpecker, parrot, pelican, penguin, petrel, pheasant, pigeon, pterosaur, quail, quetzal, raven, shrike, sparrow, starling, stork, swallow, swan, swift, tanager, thornbill, thrush, titmouse, toucan, turkey, vulture, warbler, waxwing, woodpecker, wren
| [[File:Beast amorphous.png]]
| ''none''
| BEAST_AMORPHOUS
|-
| snake
| [[File:Beast snake.png]]
| ''none''
| rowspan="2" | BEAST_SNAKE
|-
| anaconda, cobra, python, rattlesnake, serpent, viper
| [[File:Beast snake, two eyes.png]]
| BEAST_SNAKE_EYE_TWO
|-
| bristleworm, earthworm, flat worm, leech, nematode, ribbon worm, slug, worm
| [[File:Beast worm long.png]]
| ''none''
| rowspan="2" | BEAST_WORM_LONG
|-
| snail
| [[File:Beast worm long, shell.png]]
| BEAST_WORM_LONG_SHELL_BACK
|-
| caterpillar, maggot
| [[File:Beast worm short, two eyes.png]]
| BEAST_WORM_SHORT_EYE_TWO
| BEAST_WORM_SHORT
|-
| hexapod
| [[File:Beast insect.png]]
| ''none''
| rowspan="8" | BEAST_INSECT
|-
| antlion larva, flea, louse
| [[File:Beast insect, two eyes.png]]
| BEAST_INSECT_EYE_TWO
|-
| ant, aphid, assassin bug, click beetle, cockroach, cricket, darkling beetle, dung beetle, earwig, grasshopper, ladybug, mantis, rove beetle, scarab beetle, silverfish, stick insect, stonefly, termite, thrips, tiger beetle, weevil
| [[File:Beast insect, two eyes, antennae.png]]
| BEAST_INSECT_EYE_TWO, BEAST_INSECT_ANTENNAE
|-
| stag beetle
| [[File:Beast insect, mandibles, two eyes, antennae.png]]
| BEAST_INSECT_MANDIBLES, BEAST_INSECT_EYE_TWO, BEAST_INSECT_ANTENNAE
|-
| rhinoceros beetle
| [[File:Beast insect, horns, two eyes, antennae.png]]
| BEAST_INSECT_HORNS, BEAST_INSECT_EYE_TWO, BEAST_INSECT_ANTENNAE
|-
| cicada, damselfly, dragonfly, fly
| [[File:Beast insect, lacy wings, two eyes.png]]
| BEAST_INSECT_WINGS_LACY_BACK, BEAST_INSECT_EYE_TWO
|-
| bee, butterfly, caddisfly, firefly, hornet, lacewing, mayfly, moth, scorpionfly, snakefly, wasp
| [[File:Beast insect, lacy wings, two eyes, antennae.png]]
| BEAST_INSECT_WINGS_LACY_BACK, BEAST_INSECT_EYE_TWO, BEAST_INSECT_ANTENNAE
|-
| mosquito
| [[File:Beast insect, lacy wings, two eyes, proboscis, antennae.png]]
| BEAST_INSECT_WINGS_LACY_BACK, BEAST_INSECT_EYE_TWO, BEAST_INSECT_PROBOSCIS, BEAST_INSECT_ANTENNAE
|-
| decapod, octopod
| [[File:Beast spider.png]]
| ''none''
| rowspan="3" | BEAST_SPIDER
|-
| crab, lobster, mite, spider, tarantula, tick
| [[File:Beast spider, two eyes.png]]
| BEAST_SPIDER_EYE_TWO
|-
| shrimp
| [[File:Beast spider, two eyes, antennae.png]]
| BEAST_SPIDER_EYE_TWO, BEAST_SPIDER_EYE_ANTENNAE
|-
| scorpion
| [[File:Beast scorpion, two eyes, one tail.png]]
| BEAST_SCORPION_EYE_TWO, BEAST_SCORPION_TAIL_ONE
| BEAST_SCORPION
|-
| wyrm
| [[File:Beast bipedal dinosaur.png]]
| ''none''
| BEAST_BIPEDAL_DINOSAUR
|-
| humanoid*
| [[File:Beast humanoid.png]]
| ''none''
| rowspan="5" | BEAST_HUMANOID
|-
| humanoid*

''(humanoid forms)'': ape, capybara, cavy, frog, koala, toad, wombat
| [[File:Beast humanoid, two eyes.png]]
| BEAST_HUMANOID_EYE_TWO
|-
| iguanodont, theropod

''(humanoid forms)'': alligator, anteater, antelope, armadillo, badger, bear, beaver, bison, buffalo, bull, camel, cat, chameleon, chinchilla, civet, coati, coyote, crocodile, deer, donkey, elk, fox, gecko, gila monster, giraffe, goat, gopher, hare, hedgehog, hippopotamus, horse, hyena, iguana, jackal, kangaroo, lemur, lizard, llama, loris, marmot, mole, mongoose, monitor, monkey, moose, mouse, newt, opossum, otter, panda, pangolin, panther, pig, porcupine, rabbit, raccoon, rat, rhinoceros, salamander, sheep, shrew, skink, skunk, sloth, squirrel, tapir, warthog, weasel, wolf, zebra
| [[File:Beast humanoid, two eyes, one tail.png]]
| BEAST_HUMANOID_EYE_TWO, BEAST_HUMANOID_TAIL_ONE
|-
| ''(humanoid forms)'': elephant, mammoth
| [[File:Beast humanoid, two eyes, one tail, trunk.png]]
| BEAST_HUMANOID_EYE_TWO, BEAST_HUMANOID_TAIL_ONE, BEAST_HUMANOID_TRUNK
|-
| ''(humanoid forms)'': tortoise, turtle
| [[File:Beast humanoid, two eyes, shell.png]]
| BEAST_HUMANOID_EYE_TWO, BEAST_HUMANOID_SHELL_BACK
|-
| ape
| [[File:Beast front grasp, two eyes.png]]
| BEAST_FRONT_GRASP_EYE_TWO
| rowspan="2" | BEAST_FRONT_GRASP
|-
| monkey
| [[File:Beast front grasp, two eyes, one tail.png]]
| BEAST_FRONT_GRASP_EYE_TWO, BEAST_FRONT_GRASP_TAIL_ONE
|-
| primate, quadruped
| [[File:Beast quadruped bulky.png]]
| ''none''
| rowspan="5" | BEAST_QUADRUPED_BULKY
|-
| capybara, cavy, koala, toad, wombat
| [[File:Beast quadruped bulky, two eyes.png]]
| BEAST_QUADRUPED_BULKY_EYE_TWO
|-
| ankylosaurid, armadillo, bear, beaver, bison, buffalo, bull, camel, ceratopsid, chinchilla, goat, gopher, hadrosaurid, hedgehog, hippopotamus, llama, loris, marmot, mole, panda, pig, porcupine, rhinoceros, sauropod, sheep, sloth, stegosaurid, tapir, warthog
| [[File:Beast quadruped bulky, two eyes, one tail.png]]
| BEAST_QUADRUPED_BULKY_EYE_TWO, BEAST_QUADRUPED_BULKY_TAIL_ONE
|-
| elephant, mammoth
| [[File:Beast quadruped bulky, two eyes, one tail, trunk.png]]
| BEAST_QUADRUPED_BULKY_EYE_TWO, BEAST_QUADRUPED_BULKY_TAIL_ONE, BEAST_QUADRUPED_BULKY_TRUNK
|-
| tortoise, turtle
| [[File:Beast quadruped bulky, two eyes, shell.png]]
| BEAST_QUADRUPED_BULKY_EYE_TWO, BEAST_QUADRUPED_BULKY_SHELL_FRONT
|-
| primate, quadruped
| [[File:Beast quadruped slinky.png]]
| ''none''
| rowspan="3" | BEAST_QUADRUPED_SLINKY
|-
| frog
| [[File:Beast quadruped slinky, two eyes.png]]
| BEAST_QUADRUPED_SLINKY_EYE_TWO
|-
| alligator, anteater, antelope, badger, cat, chameleon, civet, coati, coyote, crocodile, deer, dimetrodon, donkey, elk, fox, gecko, gila monster, giraffe, hare, horse, hyena, iguana, jackal, kangaroo, lemur, lizard, mongoose, monitor, moose, mouse, newt, opossum, otter, pangolin, panther, rabbit, raccoon, rat, salamander, shrew, skink, skunk, squirrel, weasel, wolf, zebra
| [[File:Beast quadruped slinky, two eyes, one tail.png]]
| BEAST_QUADRUPED_SLINKY_EYE_TWO, BEAST_QUADRUPED_SLINKY_TAIL_ONE
|-
| walrus
| [[File:Beast walrus, two eyes.png]]
| BEAST_WALRUS_EYE_TWO
| BEAST_WALRUS
|}
:'''*''' The (generic) humanoid RCP has two or no eyes (by default) depending on the type of beast/monster:
::2 eyes: bogeymen, experiments (intelligent humanoids), night trolls
::0 eyes: experiments (amalgamations), nightmares, everything else (which are elementals)

== Gallery ==
<gallery caption="Large sprites" heights="64px">
Beast amorphous.png|Amorphous sprite
Beast snake.png|Snake sprite
Beast worm long.png|Long worm sprite
Beast worm short.png|Short worm sprite
Beast insect.png|Insect sprite
Beast spider.png|Spider sprite
Beast scorpion.png|Scorpion sprite
Beast scorpion, one tail.png|Scorpion sprite (with one tail)
Beast bipedal dinosaur.png|Bipedal dinosaur sprite
Beast humanoid.png|Humanoid sprite
Beast front grasp.png|Front grasp sprite
Beast front grasp hex.png|Front grasp sprite (six-legged)
Beast front grasp oct.png|Front grasp sprite (eight-legged)
Beast quadruped bulky.png|Bulky quadruped sprite
Beast quadruped bulky hex.png|Bulky quadruped sprite (six-legged)
Beast quadruped bulky oct.png|Bulky quadruped sprite (eight-legged)
Beast quadruped slinky.png|Slinky quadruped sprite
Beast quadruped slinky hex.png|Slinky quadruped sprite (six-legged)
Beast quadruped slinky oct.png|Slinky quadruped sprite (eight-legged)
Beast walrus.png|Walrus sprite
</gallery>

<gallery caption="Small sprites" heights="32px">
Beast small amorphous.png|Small amorphous sprite
Beast small snake.png|Small snake sprite
Beast small worm long.png|Small long worm sprite
Beast small worm short.png|Small short worm sprite
Beast small insect.png|Small insect sprite
Beast small spider.png|Small spider sprite
Beast small scorpion.png|Small scorpion sprite
Beast small scorpion, one tail.png|Small scorpion sprite (with one tail)
Beast small bipedal dinosaur.png|Small bipedal dinosaur sprite
Beast small humanoid.png|Small humanoid sprite
Beast small front grasp.png|Small front grasp sprite
Beast small front grasp hex.png|Small front grasp sprite (six-legged)
Beast small front grasp oct.png|Small front grasp sprite (eight-legged)
Beast small quadruped bulky.png|Small bulky quadruped sprite
Beast small quadruped bulky hex.png|Small bulky quadruped sprite (six-legged)
Beast small quadruped bulky oct.png|Small bulky quadruped sprite (eight-legged)
Beast small quadruped slinky.png|Small slinky quadruped sprite
Beast small quadruped slinky hex.png|Small slinky quadruped sprite (six-legged)
Beast small quadruped slinky oct.png|Small slinky quadruped sprite (eight-legged)
Beast small walrus.png|Small walrus sprite
</gallery>

{{Creatures}}

[[Category:Creatures]]
[[Category:Lua]]
[[ru:Random creature profile]]

Lua scripting

2025-10-24T22:05:32Z

DPhKraken: /* Random Creature Profiles */ Main article

{{av}}
[[File:Lua-Logo.svg|100px|right]]
{{Modding}}

''This article is about procedural raw generation. Information on [[Utility:DFHack]] scripting can be found at https://docs.dfhack.org/en/stable/.''

'''[https://www.lua.org/ Lua] scripting''' is a feature of Dwarf Fortress's [[modding]] system. It is used to write definitions for procedurally-generated objects, with the stated goal of "supporting future [[Magic|magical]] endeavors." [https://www.youtube.com/watch?v=Z9rzhFwgfUk]

It was added as an experimental feature in version 51.06 [https://store.steampowered.com/news/app/975370/view/547854206358257941?l=english] and incorporated into the 52.01 release. [https://www.bay12games.com/dwarves/index.html#2025-07-21][https://store.steampowered.com/news/app/975370/view/547867141501617961]

Inorganic [[Material definition token|materials]], [[Language token|languages]], [[Creature token|creatures]], [[Interaction token|interactions]], [[Item token|items]] (currently excluding instruments), [[reaction]]s, [[Entity token|entities]], and [[Plant token|plants]] are open to this system.

Scripts are loaded from a mod's ``scripts/init.lua`` file, and can ``require()`` other files.

==Videos==
Announcement video:
*[https://www.youtube.com/watch?v=Z9rzhFwgfUk More powerful mods coming to Dwarf Fortress via Lua]
Tutorials:
*[https://youtu.be/QMxgsUogIIk Generating raws with Lua]
*[https://youtu.be/DEBTWMlUQzA Random creatures with Lua]

==Structure==

As of right now, Lua scripting is confined to generation of procedural objects. This is done by running the ``generate()`` function, a global function loaded in ``'''data/init/generators.lua'''``. It runs unit tests, preprocess, do_once (or do_once_early), materials, items, languages, creatures, interactions, entities and postprocessing, in that order.

When random objects are first generated, the game populates two global tables, ``world`` and ``random_object_parameters``.

* ``world`` contains info about the world currently being generated (or, in the future, played in). It contains [[World token|worldgen parameters]], raw object definitions, and a few other fields.

* ``random_object_parameters`` contains what the game expects to be generated in the current generation call.

You can print the contents of these tables to the log to see what data is available. The [https://steamcommunity.com/sharedfiles/filedetails/?id=3492961907 Runtime Dataminer] mod includes a script to read these tables.

DFHack also has a version of [https://github.com/DFHack/df-structures/blob/master/df.world.xml df.world], though these tables are not necessarily equivalent. Headers and paths may differ, even when referencing the same data.

===Debugging===
You can set the global ``debug_level`` variable to print some debug info. It's a number, but what numbers are there are completely arbitrary. If it's >0, it'll run unit tests; if it's >=0.5, it'll display what step of generation it's at, at every step. You can use ``get_debug_logger(x)`` to return a function that logs to ``lualog.txt`` if the debug level is at least ``x``.

Unit tests are functions that return a table, containing ``good``, which, if truthy, is considered passed, and ``info``, which is a string that contains information on said pass or fail. These unit tests should have no side effects, i.e. they shouldn't muck with global state any. Here's an example unit test shipped with the generators:

{{Scriptdata
|title=unittests.get_random_creature
|script=
get_random_creature=function()
local cr=world.creature.get_random_creature()
local res={}
res.good=type(cr)=='table'
res.info=res.good and ("Got a random creature: "..cr.token) or "No random creature could be gotten, even at most permissive!"
return res
end}}

===Object generation===
When ``generate()`` is called, it uses ``random_object_parameters`` to determine what is generated.

Before the world map is generated, ``random_object_parameters.pre_gen_randoms`` is true for one generation. Once the map is finalized, ``random_object_parameters.main_world_randoms`` is true for one generation when "generating prehistory"; most of the initial randomization takes place here. Further generation calls, such as for [[experiment]]s being created, do not set these variables to true.

If you're registering an entirely new procedural object type, you can generate it during these steps. The game includes a number of tables which you can add functions to, the game runs each function in them when generating raws.

*``do_once`` only runs in the "main world randoms" generation call and is the safest option for adding new objects.
*``do_once_early`` runs in the "pre-gen randoms" generation call, and can be used for objects that need to be placed in the map like minerals or surface animal populations.
*``preprocess`` runs before either of the former tables, but is run during every ``generate()`` call and you cannot predict when this happens.
*``postprocess`` runs at the end of each ``generate()`` call, after the other steps complete.

You can see examples of registering objects through these steps on the [[Lua script examples]] page.

If you want to use ``preprocess`` or ``postprocess`` to generate raws, you can check if it's the right generation step by reading the aforementioned ``random_object_parameters``. The [[Lua script examples#Adamantine alloys|"adamantine alloys" example]] includes such a check.

You can also mess around with ``random_object_parameters`` in preprocessing. Vanilla demon types are assigned here, and you can change the proportions as an end user if you want.

====Generation from list====
After ``preprocess`` and ``do_once``, the game then generates all of the individual objects that the ``random_object_parameters`` expects. The general procedure for this is that the game calls the ``generate_from_list()`` function on a table of functions, which calls every function and picks one of the resulting values at random depending on their weights.

For example, the ``interactions.secrets`` table contains one entry, that for necromancers; it returns a table containing three entries: ``{raws=tbl,weight=1,spheres=spheres}``.

*``raws`` is the full raw text of the interaction.
*``weight`` is the random weight for the interaction, i.e. if you add another function which returns a table containing ``weight=2``, that will be twice as likely as necromancers.
*``spheres`` is some extra data the generator might be able to use. It actually doesn't, at this point, but one could override ``generate_random_interactions()`` with their own version that takes into account ``spheres`` and, say, tries to evenly distribute generated secrets over available spheres. (This didn't end up in vanilla primarily out of concerns of bug-like behavior cropping up).

====Languages====
Languages are special, though; as can be seen in the [[Divine language/script]] or [[Lua script examples#Identity language|identity language]]. The ``languages`` table just expects to return table containing translations, e.g. ``tbl["ABBEY"]="abbey"``. If you want to procedurally add words or symbols (and yes, these are both doable), you can do so with ``raws.register_languages()`` in another function table.

==Creatures==
Creatures have a lot more to them than other procedural objects. Forgotten beasts are, in a sense, the simplest of them:

{{Scriptdata
|title=creatures.fb.default
|script=
creatures.fb.default=function(layer_type,tok)
local tbl={}
local options={
strong_attack_tweak=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:forgotten beast:forgotten beasts:forgotten beast]
[CASTE_NAME:forgotten beast:forgotten beasts:forgotten beast]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
return {creature=tbl,weight=1}
end}}

This is a lot of info! First, you build an ``options`` table; it's possible to make a full [[Lua functions#Options|list of options used in vanilla]], but other mods can also use arbitrary options. It then adds all the usual special-to-forgotten-beast tokens, in a big string, followed by calling ``add_regular_tokens(tbl,options)``, which adds some stuff common to all (vanilla) procedural creatures, based on the options given.

It sets ``do_water`` and the WATER [[sphere]] if the FB is in a water [[cavern]], an option which whitelists certain random creature profiles, as well as adding a random evil sphere.

``populate_sphere_info()`` is similar to ``add_regular_tokens()``; it adds all of the spheres in ``options.spheres`` to the creature, using the {{token|SPHERE}} token, then, if certain options are set, does more.

Then, it gets a random creature profile using ``get_random_creature_profile()`` and the options, uses ``add_body_size()`` to set the BODY_SIZE tokens and attendant things that come with it, sets the creature tile, and finally runs the Big Function, ``build_procgen_creature()``, which creates the description, body, tissues, et cetera.

===Random Creature Profiles===
{{main|Random creature profile}}
A random creature profile is a type of "thing" a generated creature can be. For example:

{{Scriptdata
|title=random_creature_types.GENERAL_QUADRUPED
|script=
GENERAL_QUADRUPED={
name_string="quadruped",
tile='Q',
body_base="QUADRUPED",
c_class="UNIFORM",
cannot_have_get_more_legs=true,
min_size=70000,
weight=1000
},
}}

Of these, only ``cannot_have_get_more_legs`` is optional. ``build_procgen_creature()`` has direct access to the RCP, as the first argument, and thus extra table entries can be used however you like.

``body_base`` points to a key in ``body_base_fun``, which is used to set creature options (walking and [[Procedural graphics layer|PCG layering]] are set this way) and returns a list of [[body token]]s. Quadrupeds use a special function to vary the sprite, so here's the body base function for a humanoid.

{{Scriptdata
|title=body_base_fun.HUMANOID
|script=
HUMANOID=function(rcp,options)
options.pcg_layering_base="BEAST_HUMANOID"
options.walk_var="STANDARD_BIPED_GAITS"
options.walk_speed=900
return {"RCP_UPPER_BODY","RCP_LOWER_BODY","RCP_NECK","RCP_HEAD","RCP_TWO_PART_ARMS","RCP_TWO_PART_LEGS"}
end
}}

``c_class`` also refers to another determines the kind of tissue layers the creature has. "FLESHY", "MAMMAL", "CHITIN_EXO", etc imply a biological creature with sinew, blood, different organs, nerves, and so on. "UNIFORM" describes a creature made of a single material, the choice influenced by its options. The ``random_creature_class`` and ``random_creature_material`` tables store the info for these traits.

Organic creatures can be tweaked to alter their surfaces, such as becoming skinless, hairy, or even uniform.

===Tweaks===

In the broadest sense, a tweak is any deviation from the creature profile. The aforementioned surface changes, new body parts, and attack interactions are all examples of tweaks.

A number of [[Lua functions#Options|options]] change the available tweaks or force one to happen, for example:
*``options.no_tweak`` disables random tweaks.
*``options.strong_attack_tweak`` allows the creature to always pick from the ``attack_tweaks`` table; ie: "Beware its webs!"
*``options.humanoid_only`` makes the creature "twisted into humanoid form" (if evil), or "a <creature> in humanoid form" (if otherwise).

One potential use of ``btc1_tweaks`` (see [[Lua functions#Creature patching]]) is to add custom tweak candidates, pointing to keys in ``tweaks``.

===Color pickers===

Color picker functions can give more fitting [[color]] choices based on the options, instead of the default full spectrum. There are color pickers for certain malevolent [[sphere]]s, giving them a dark appearance. [[Werebeast]]s use a flag to only have natural brown or black colors.

If the creature matches ``cond`` and a given [[Descriptor color token|descriptor color]] matches ``color``, then it is added to the list of candidates. Colors have {{Tooltip|h,s,v|Hue, saturation, value}} and {{Tooltip|r,g,b|Red, green, blue}} values ranging from 0-1 (except hue, which ranges 0-360 degrees).

{{Scriptdata
|title=color_picker_functions
|script=color_picker_functions={
death_misery={
cond=function(options)
return options.spheres.DEATH or options.spheres.MISERY
end,
color=function(color)
-- GRAY TO BLACK/BLUEISH GREEN THAT ARE SOMEWHAT GRAYISH AND MORE BLUE
return (color.v<=0.75 and color.s<=0.001) or (color.v==color.b and color.s<=0.25)
end
},
darkness_night={
cond=function(options)
return options.spheres.DARKNESS or options.spheres.NIGHT
end,
color=function(color)
-- GRAY TO BLACK OR DARK BLUISH
return color.v<=0.4 and (color.s < 0.001 or (color.h>180 and color.h<=240))
end
},
werebeast={
cond=function(options)
-- werebeasts only, in vanilla
return options.animal_coloring_allowed
end,
color=function(color)
--BROWN OKAY TOO
return color.h>=30 and color.h<=48 and color.b<=0.15 and color.v<=0.75 and color.v > 0
end
}
}
}}

``options.blood_color`` works like a color picker function. If any colors match its function, then its [[blood]] will be colored like one of them. [[Bogeymen]] and [[nightmare]]s have a function that gives them magenta blood, for example, but you can create your own blood color functions.

Creatures with other blood types, such as ichor, are unaffected.

{{Scriptdata
|title=options.blood_color (Bogeyman)
|script=blood_color=function(cl)
-- DARKER MAGENTA COLORS
return cl.h>=260 and cl.h <= 340 and cl.v <= 0.5 and cl.v >= 0.1
end
}}

[[Category:Modding]]
[[Category:Lua|S]]

Centaur

2025-10-24T21:58:18Z

DPhKraken: RCPs aren't hardcoded anymore

{{Quality|Superior}}
{{Creaturelookup/0
|biome=None
|death=nobutcher
|contrib=no
|wiki=yes}}
{{av}}
'''Centaurs''' are [[fanciful]] [[creature]]s which are merely the stuff of [[legends]]. They do not actually exist, appearing only in [[engraving]]s as the fancy of artists. A female centaur is known as a ''centauress''.

Some [[Dwarf|dwarves]] [[Preferences|like]] centaurs for their ''strength''.

==The "Centaur" Problem==

''"We've got the "centaur" problem, or whatever, where I wanna take any piece of anything, and slap it onto something else... That has complications in terms of the materials, and the body parts, and that kind of thing that need to be worked out."'' - [[Toady One]], [[Dwarf Fortress Talk]] #28 [38:26]
 
Procedurally [[Creature token#GENERATED|generating]] centaurs has been discussed since the days of ''Dwarf Fortress's'' predecessor, ''[[Armok|Slaves to Armok]]''. Combining two creature objects, such as a [[human]] with the lower body of a [[horse]], and respecting the [[raw file]]s and body structure of each component is a consideration that the nonexistent nature of the centaur and the other [[fanciful]] hybrid creatures allude to.

Though [[creature]]s like [[Merperson|merpeople]] and [[satyr]]s are conceptually hybrids, they are singular, manual implementations, rather than a system that can generate any number of [[Chimera|chimeric]] beings based on combining existing creatures. [[Experiment]]s are generated from an independent [[random creature profile]] rather than being based on their input creature.

{{D for Dwarf}}


Some [[Troll|trolls]] like centaurs for their
{{#splitrand:
[[milk]]
[[Strength|STRENGTH]]
}}.
[[File:Brooklyn Museum - Centauress - John La Farge - overall.jpg|thumb|center|300px|Admired for its ''strength''.]]

==See Also==
* [[Chimera]]
* [[Griffon]]
{{gamedata}}
{{Creatures}}
{{Category|Myth}}
[[ru:Centaur]]

Lua script examples

2025-10-19T06:57:16Z

DPhKraken: /* Werebugs */

{{av}}
{{Modding}}
{{Main|Lua scripting}}
Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``[https://github.com/Putnam3145/DF-Raws/tree/master/vanilla_procedural/scripts data/vanilla/vanilla_procedural/scripts/]``.
__TOC__


==Helper functions==

===Search by reaction class===
This script returns a table of all inorganic materials with a given {{token|REACTION_CLASS|md}}. The ``mat`` table also has ``reaction_product_class``, which includes both {{token|MATERIAL_REACTION_PRODUCT|md}} and {{token|ITEM_REACTION_PRODUCT|md}} IDs.
{{Scriptdata
|title=get_all_by_reaction_class()
|script=
function get_all_by_reaction_class(rc)
local valid={}
for i,inorg in ipairs(world.inorganic.inorganic) do
for _,class in inorg.mat.reaction_class do
if class==rc then
valid[#valid+1]=inorg
end
end
end
return valid
end}}

==Languages==

===Identity language===
This makes a [[Language token|language]] called ``GEN_IDENTITY`` which is like: "Abbey abbeyabbeys the abbey of abbeys" - i.e. it's the "English" language you might see occasionally. It is present in ``vanilla_procedural`` and can be used for {{Token|TRANSLATION|entity}} by default.

{{Scriptdata
|title=GEN_IDENTITY
|script=
languages.GEN_IDENTITY=function()
-- just to demonstrate the absolute most basic method of generating one of these
-- also so that you can just mod stuff to use GEN_IDENTITY
local tbl={}
local unempty = function(str1, str2)
return str1=='' and str2 or str1
end
for k,v in ipairs(world.language.word) do
local str=''
str=unempty(str,v.NOUN_SING)
str=unempty(str,v.ADJ)
str=unempty(str,v.VERB_FIRST_PRES)
str=unempty(str,string.lower(v.token))
tbl[v.token]=str
end
return tbl
end}}

===Kobold language===
This generates a language made of {{token|UTTERANCES}}. This is essentially a proper translation based on the [[kobold language]]. Note that the hardcoded ``utterance()`` function generates words independently of any existing words in the language, so you may get duplicate words.

{{Scriptdata
|title=GEN_KOBOLD
|script=
languages.GEN_KOBOLD=function()
local tbl={}
for k,v in ipairs(world.language.word) do
tbl[v.token]=utterance()
end
return tbl
end}}

==Generators==

===Non-random generated material===

Here's an example of an object registered through the ``do_once`` table. There are no random elements, it is equivalent (save for being {{token|GENERATED|mat}}) to an object defined through [[Material definition token]]s and registered through the ``raws.register_inorganics()`` function. It also prints itself to the lualog for debugging purposes.

{{Scriptdata
|title=Single material
|script=do_once.cobalt = function()
local lines = {}

-- basic inorganic definition
lines[#lines+1] = "[INORGANIC:COBALT]"
-- add [GENERATED] to save properly
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling cobalt]"
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:COBALT]"
lines[#lines+1] = "[SPECIAL]"

raws.register_inorganics(lines)

-- show in lualog
print_table(lines)
end
}}
 
You can register multiple objects at the same time. This script takes a table of color tokens, and makes a metal named after each of them, with a corresponding cheaty adventure reaction.

{{Scriptdata
|title=Chromatic metals
|script=do_once.chromatic_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- make a metal for each color token
for k,v in pairs(color_tokens) do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:CHROMATICMETAL"..v.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- look up the metal's color in the world table
-- using string.lower(v) would result in "moss_green"
local metalname = world.descriptor.color[v].name
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

-- appearance
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..v.."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:CHROMATICMETAL"..v.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:CHROMATICMETAL"..v.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===Random generation===

Here's an example of various DF-specific randomizers in use:
* ``trandom()`` is used to determine how many metals generate this way.
* ``utterance()`` generates utterances from the [[Kobold language]], e.g. "gorsnus", "stogodilmus", "gaylgis"
* ``pick_random_no_replace()`` determines the color from the table, but removes the rolled value so there's no repeats.

{{Scriptdata
|title=Kobold metals
|script=do_once.kobold_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- trandom() is expressed as (1dN)-1 because it uses C++ math that starts at 0
local max_loops = trandom(10)+1

-- create 1-10 metals
for i = 1,max_loops do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:KOBOLDMETAL"..i.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- this is the kobold name function
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"
-- no_replace removes the value from the table
-- we don't need a fallback because there's more values than metals
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random_no_replace(color_tokens).."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:KOBOLDMETAL"..i.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:KOBOLDMETAL"..i.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===New divine metals===

Many of the tables used by vanilla procedural objects are global, and thus can be added to or overwritten by mods. You can add new metal descriptions for divine metal pretty easily, for example:

{{Scriptdata
|title=Laughing metal
|script=
metal_by_sphere.CHILDREN={
name="laughing metal",
col="7:0:1",
color="WHITE"
}
}}
 
You can also add alternatives to the default divine metal function, such as one based on the aforementioned kobold metals.
Vanilla divine metal uses ``metal_by_sphere`` to determine its properties, and is thus valid only if the input sphere has an entry in that table.
Note that even if the weights are nominally the same; because it is valid for all input spheres, it will outnumber instances of the more limited vanilla material.

{{Scriptdata
|title=Divine kobold metal
|script=materials.divine.metal.kobold = function(sphere)
if not foo then
log(#metal_by_sphere)
log(#world.spheres)
foo = true
end
local lines = {}
--generation function handles ID, registration, generated info
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
--add_generated_info(lines)
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}
--allow for duplicate colors
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random(color_tokens).."]"

--add a block of tokens
lines=split_to_lines(lines,[[
[MATERIAL_VALUE:200]
[SPEC_HEAT:7500]
[MELTING_POINT:NONE]
[BOILING_POINT:NONE]
[ITEMS_WEAPON][ITEMS_WEAPON_RANGED][ITEMS_AMMO][ITEMS_DIGGER][ITEMS_ARMOR][ITEMS_ANVIL]
[ITEMS_HARD]
[ITEMS_METAL]
[ITEMS_BARRED]
[ITEMS_SCALED]
[SOLID_DENSITY:1000]
[LIQUID_DENSITY:1000]
[MOLAR_MASS:20000]
[IMPACT_YIELD:1000000]
[IMPACT_FRACTURE:2000000]
[IMPACT_STRAIN_AT_YIELD:0]
[COMPRESSIVE_YIELD:1000000]
[COMPRESSIVE_FRACTURE:2000000]
[COMPRESSIVE_STRAIN_AT_YIELD:0]
[TENSILE_YIELD:1000000]
[TENSILE_FRACTURE:2000000]
[TENSILE_STRAIN_AT_YIELD:0]
[TORSION_YIELD:1000000]
[TORSION_FRACTURE:2000000]
[TORSION_STRAIN_AT_YIELD:0]
[SHEAR_YIELD:1000000]
[SHEAR_FRACTURE:2000000]
[SHEAR_STRAIN_AT_YIELD:0]
[BENDING_YIELD:1000000]
[BENDING_FRACTURE:2000000]
[BENDING_STRAIN_AT_YIELD:0]
[MAX_EDGE:12000]
]])
--sends this to get registered
return {raws=lines,weight=1}
end
}}

===Remove default functions===

Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.

See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.

<syntaxhighlight lang="lua" >
creatures.fb.default=nil
</syntaxhighlight>

===Basic generated creature===

This is essentially the simplest possible creature. It has no extraordinary options (beyond an [[Sphere|association]] with animals and creation), and each world generates one species from this function. It doesn't have any biome tokens or likewise, so it can only be spawned in the arena, but it is still functional.

A sample output would be "A quadruped composed of flame. It has two narrow tails and it has a regal bearing."

{{Scriptdata
|title=do_once.basic_creature
|script=do_once.basic_creature = function()
local lines = {}
local tok="BASIC_PROCEDURAL_CREATURE"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
CREATION=true
}
}
lines=split_to_lines(lines,[[
[NAME:procedural creature:procedural creatures:procedural]
[CASTE_NAME:procedural creature:procedural creatures:procedural]
]])
--adds some common tokens depending on the options
add_regular_tokens(lines,options)

--handles sphere options: fills out [SPHERE] tokens from options.spheres, and so on
populate_sphere_info(lines,options)

--choose a creature profile to base on
local rcp=get_random_creature_profile(options)
--set [BODY_SIZE] and some relevant tokens
add_body_size(lines,rcp.min_size,options)
--add the tile from the creature profile
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"

--the Big Function determining tweaks, body, appearance, description...
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}

===Making your own RCP===

You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.

This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.

{{Scriptdata
|title=do_once.local_rcp
|script=do_once.local_rcp = function()
local lines = {}
local tok="LOCAL_RCP"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
WATER=true
}
}
add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
--habitat
lines[#lines+1]="[BIOME:ANY_OCEAN]"
lines[#lines+1]="[LARGE_ROAMING]"
lines[#lines+1]="[AQUATIC][UNDERSWIM]"

--define a local creature profile
local rcp={
name_string="eurypterid",
tile='E',
body_base="SCORPION",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}
local name_str = rcp.name_string..":"..rcp.name_string.."s:"..rcp.name_string.."]"
lines[#lines+1] = "[NAME:"..name_str
lines[#lines+1] = "[CASTE_NAME:"..name_str

add_body_size(lines,rcp.min_size,options)
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}
 
Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.

This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

Other feature variants stored in tables, like materials, attacks, or descriptions, can be added in this way.

{{Scriptdata
|title=Global RCP
|script=
random_creature_types.EURYPTERID={
name_string="eurypterid",
tile='E',
body_base="SCORPION_FLIPPERS",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}

body_base_fun.SCORPION_FLIPPERS=function(rcp,options)
options.pcg_layering_base="BEAST_SCORPION"
options.walk_var="STANDARD_WALKING_GAITS"
options.walk_speed=900
return {"RCP_CEPHALOTHORAX","RCP_ABDOMEN","RCP_FIRST_SIMPLE_LEGS","RCP_SECOND_SIMPLE_LEGS","RCP_THIRD_SIMPLE_LEGS","RCP_PINCERS","RCP_FRONT_FLIPPER"}
end

water_based_random_creature.EURYPTERID=true
}}

===Werebugs===

You can make a custom function to determine what RCPs are available to a given creature.

These scripts are for an arthropoid version of a [[werebeast]].
* ``arthropod_rcp`` is a list of RCP keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
* ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].

Otherwise, the function should work the same as vanilla werebeasts, generating an associated [[Interaction token|major curse]] in the same way and becoming "twisted into humanoid form" (at the expense of their additional limbs).

{{Scriptdata
|title=arthropod_rcp
|script=local arthropod_rcp = {
"ARACHNID_MITE",
"ARACHNID_SCORPION",
"ARACHNID_SPIDER",
"ARACHNID_TARANTULA",
"ARACHNID_TICK",
"CRUSTACEAN_CRAB",
"CRUSTACEAN_LOBSTER",
"CRUSTACEAN_SHRIMP",
"INSECT_ANT",
"INSECT_ANTLION",
"INSECT_APHID",
"INSECT_BEE",
"INSECT_BUTTERFLY",
"INSECT_CADDISFLY",
"INSECT_CATERPILLAR",
"INSECT_CICADA",
"INSECT_COCKROACH",
"INSECT_CRICKET",
"INSECT_DAMSELFLY",
"INSECT_DARKLING_BEETLE",
"INSECT_DRAGONFLY",
"INSECT_EARWIG",
"INSECT_FIREFLY",
"INSECT_FLEA",
"INSECT_FLY",
"INSECT_GRASSHOPPER",
"INSECT_HORNET",
"INSECT_LACEWING",
"INSECT_LADYBUG",
"INSECT_LOUSE",
"INSECT_MAGGOT",
"INSECT_MANTIS",
"INSECT_MAYFLY",
"INSECT_MOSQUITO",
"INSECT_MOTH",
"INSECT_SILVERFISH",
"INSECT_SCARAB_BEETLE",
"INSECT_SCORPIONFLY",
"INSECT_SNAKEFLY",
"INSECT_STONEFLY",
"INSECT_TERMITE",
"INSECT_THRIPS",
"INSECT_WASP",
"INSECT_WEEVIL",
"NEMATODE",
"LEECH",
}
}}
{{Scriptdata
|title=is_bloodsucking_by_key
|script=local is_bloodsucking_by_key = {
ARACHNID_MITE=true,
ARACHNID_TICK=true,
INSECT_EARWIG=true,--some are parasitic
INSECT_FLEA=true,
INSECT_LOUSE=true,
INSECT_MAGGOT=true,
INSECT_THRIPS=true,--no bloodsucking reported, but does bite humans
NEMATODE=true,
}
}}
{{Scriptdata
|title=creatures.night_creature.werebeast.werebug
|script=creatures.night_creature.werebeast.werebug=function(tok)
local lines={}
local options={
spheres={
CHAOS=true,
ANIMALS=true,
NIGHT=true,
MOON=true
},
always_glowing_eyes=true,
use_werebeast_pcg=true, --use them if werebug sprites somehow exist
animal_coloring_allowed=true,
no_tweak=true,
material_weakness=true,
prioritize_bite=true,
force_ichor=true,
token=tok
}
options.night_creature_agile_pref=true
night_creature_universals(lines,options)
lines[#lines+1]="[NIGHT_CREATURE_HUNTER]"
lines[#lines+1]="[CAN_LEARN]"
lines[#lines+1]="[CAN_SPEAK]"
lines[#lines+1]="[NO_GENDER]"
lines[#lines+1]="[BONECARN]"
lines[#lines+1]="[CRAZED]"
if options.night_creature_strength_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=1000
elseif options.night_creature_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=800;
elseif options.night_creature_strength_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=850;
end
lines[#lines+1]="[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[PERSONALITY:BASHFUL:0:0:0]"
lines[#lines+1]="[PERSONALITY:STRESS_VULNERABILITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:FRIENDLINESS:0:0:0]"
lines[#lines+1]="[PERSONALITY:DISDAIN_ADVICE:100:100:100]"
lines[#lines+1]="[PERSONALITY:CHEER_PROPENSITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:GRATITUDE:0:0:0]"
lines[#lines+1]="[PERSONALITY:TRUST:0:0:0]"
lines[#lines+1]="[PERSONALITY:ALTRUISM:0:0:0]"
lines[#lines+1]="[PERSONALITY:CRUELTY:100:100:100]"

add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
lines[#lines+1]="[NATURAL_SKILL:WRESTLING:6]"
lines[#lines+1]="[NATURAL_SKILL:BITE:6]"
lines[#lines+1]="[NATURAL_SKILL:GRASP_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:STANCE_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:MELEE_COMBAT:6]"
lines[#lines+1]="[NATURAL_SKILL:DODGING:6]"
lines[#lines+1]="[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]"
lines[#lines+1]="[NATURAL_SKILL:SNEAK:20]"

lines[#lines+1]="[DIFFICULTY:3]"
lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
finalize_random_creature_types() -- good practice to run before rolling on it
local rcp_key = pick_random_no_replace(arthropod_rcp) or "INSECT_MANTIS"
local rcp=random_creature_types[rcp_key]

local custom_desc_str = "it is crazed for blood and flesh"
-- make them also vampires if they suck blood
if rcp.must_suck_blood_through_proboscis or rcp.must_suck_blood_through_mouth or is_bloodsucking_by_key[rcp_key] then
lines[#lines+1]="[BLOODSUCKER]"
custom_desc_str = "it is crazed for warm blood"
end
-- This sort of process should be fully generalized
-- to all creatures you want to have bespoke associated interactions
-- for example, you can have a blessing that allows a sort of
-- uncrazed transformation into some sort of bespoke
-- generated thing--at least, hopefully it's robust enough for that
local choice=generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)
map_merge(options,choice.options)
local werebeast_choice_raws=choice.interaction or choice.raws
raws.register_interactions(werebeast_choice_raws)
add_body_size(lines,math.max(rcp.min_size,80000+trandom(11)*1000),options)
lines[#lines+1]="[CREATURE_TILE:165]" --Ñ
options.forced_color={
f=6,
b=0,
br=1
}
options.custom_desc_func=function(options)
return custom_desc_str
end
build_procgen_creature(rcp,lines,options)
lines[#lines+1]="[GO_TO_START]"
-- remove second words like " beetle", etc from the end
local short_name = rcp.name_string:gsub("%s(%w+)$","")
local name_str="were"..short_name..":were"..short_name.."s:were"..short_name.."]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str
return {raws=lines,weight=1}
end
}}

===New forgotten beasts===
You can add new types of forgotten beasts (or more appropriately, {{token|FEATURE_BEAST}}s). These generate as alternatives when populating the caverns with unique monsters. There are a number of options to interact with shared generation functions.

Unbidden spirits only appear in dry cave layers, and like "spirit" [[demon]]s, are malevolent floating beings made of gas or dust.

{{Scriptdata
|title=Unbidden spirit
|script=
creatures.fb.unbidden=function(layer_type,tok)
if layer_type==0 then return nil end -- land only
local tbl={}
local options={
strong_attack_tweak=true,
always_make_uniform=true,
always_insubstantial=true,
intangible_flier=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[CASTE_NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
-- Weight is a float; all vanilla objects have weight 1
return {creature=tbl,weight=0.5}
end
}}
 
[[Construct creature|Elementals]] are defined by the material they're made of, using a table of options to set the right properties. In a dry chasm layer, they'll roll on the ``fb_elements`` table, while in a water layer, they'll be a water elemental. Should they ever carry a [[syndrome]], they would inflict [[Wikipedia:Dyscrasia|dyskrasia]].

The most important feature is setting ``options.sphere_rcm`` to a key in ``random_creature_materials``, so fire elementals are made of "FLAME" and earth elementals are made of "ANY_MINERAL".

{{Scriptdata
|title=Elemental
|script=
fb_elements = {
{
name="fire",
rcm="FLAME",
spheres={ FIRE=true },
options={ fire_immune=true }
},
{
name="earth",
rcm="ANY_MINERAL",
rcp_options={ always_flightless=true },
spheres={
EARTH=true,
MINERALS=true
}
},
{
name="air",
rcm="STEAM",
spheres={
WIND=true,
SKY=true
},
options={
always_insubstantial=true,
intangible_flier=true
}
}
}

creatures.fb.elemental=function(layer_type,tok)
local lines={}
local options={
strong_attack_tweak=true,
always_make_uniform=true, --irrelevant due to sphere_rcm
spheres={},
sickness_name="dyskrasia",
token=tok
}
lines=split_to_lines(lines,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NO_GENDER]
[NO_EAT][NO_DRINK]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])

-- Create a water elemental in water layers, otherwise use another type
local water_elemental = {
name="water",
rcm="WATER",
spheres={WATER=true},
options={do_water=true}
}
local my_element = layer_type==1 and pick_random(fb_elements) or water_elemental

-- Assign propertes from chosen element
map_merge(options.spheres,my_element.spheres)
if my_element.options then map_merge(options,my_element.options) end

add_regular_tokens(lines,options)
lines[#lines+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
populate_sphere_info(lines,options)

-- Set custom material
options.sphere_rcm=my_element.rcm
-- Build body
local rcp=get_random_creature_profile(options)
-- Set more options on the RCP
if my_element.rcp_options then map_merge(rcp.options,my_element.rcp_options) end
add_body_size(lines,math.max(10000000,rcp.min_size),options)
lines[#lines+1]="[CREATURE_TILE:'E']"
build_procgen_creature(rcp,lines,options)

-- Generate name
local element_name = my_element.name or "glitchstuff"
local name_str = element_name.." elemental:"..element_name.." elemental:"..element_name.."-elemental]"
lines[#lines+1]="[GO_TO_START]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str

return {raws=lines,weight=1.5}
end
}}

===Tweaking creatures===


This function is run in ``build_body_from_rcp()`` right before tweaks are determined. If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.

{{Scriptdata
|title=btc1_tweaks.titan_worship
|script=
-- make all large creatures into powers
btc1_tweaks.titan_worship=function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
if options.body_size>=500000 then -- described as "very large", graphics size cutoff
options.can_learn=true -- for flavor text
lines[#lines+1]="[INTELLIGENT]"
lines[#lines+1]="[SUPERNATURAL]" -- knows secrets according to their spheres
lines[#lines+1]="[POWER]" -- impersonates deities
lines[#lines+1]="[SPREAD_EVIL_SPHERES_IF_RULER]"
end
end
}}

===Adamantine alloys===

You can add your own arbitrary generated objects, though as of right now there's no way to make settings for them. This allows for some ''truly'' wild stuff; here's a fun example: adamantine-metal alloys for every single non-special metal, giving you an average of the properties of them.

{{Scriptdata
|title=Adamantine alloys
|script=
preprocess.adamantine_alloys=function()
if not random_object_parameters.main_world_randoms then return end
local l=get_debug_logger(2)
local lines={}
local reaction_lines={}
local reaction_names={}
local adamantine=world.inorganic.inorganic.ADAMANTINE
if not adamantine then return end
local adamantine_color=world.descriptor.color[world.descriptor.color_pattern[adamantine.material.color_pattern.SOLID].color[1]]
local adamantine_modulus = 2500000 --mildly arbitrary, just below the theoretical limit
l("Starting")
local done_category=false
for k,v in ipairs(world.inorganic.inorganic) do
if not v.flags.SPECIAL and v.material.flags.IS_METAL then
l(v.token)
local token="GEN_ADAMANTINE_"..v.token
lines[#lines+1]="[INORGANIC:"..token.."]"
add_generated_info(lines)
lines[#lines+1]="[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
for kk,vv in pairs(v.material.adj) do
lines[#lines+1]="[STATE_ADJ:"..kk..":adamantine "..vv.."]" --"adamantine molten steel"? it's fine
end
for kk,vv in pairs(v.material.name) do
lines[#lines+1]="[STATE_NAME:"..kk..":adamantine "..vv.."]"
end
l(2)
local mat_values={}
-- Find the ratio for which you get closest to (but not below) 2000000 in the material's worst property
local worst=math.min(v.material.yield.IMPACT,v.material.fracture.SHEAR)
local wafers=1
local bars=1
if worst < 2000000 then
local ratio = (2000000-3*worst)/1000000
local best_diff=1
for i=1,10 do
local wafer_amt=i*ratio
if wafer_amt>1 and wafer_amt<20 and math.ceil(wafer_amt)-wafer_amt<best_diff then
best_diff=math.ceil(wafer_amt)-wafer_amt
wafers=math.ceil(wafer_amt)
bars=i
end
end
end
local avg_denom=1/(bars*3+wafers) -- Multiplication just a bit faster than division, we're rounding at the end anyway
local solid_cl=nil
for kk,vv in pairs(v.material.color_pattern) do
-- time to get silly
local this_color=world.descriptor.color[world.descriptor.color_pattern[vv].color[1]]
local wanted_color={
r=(this_color.r*bars*3+adamantine_color.r*wafers)*avg_denom,
g=(this_color.g*bars*3+adamantine_color.g*wafers)*avg_denom,
b=(this_color.b*bars*3+adamantine_color.b*wafers)*avg_denom,
}
local best_total_diff=1000000000
local best_clp=nil
for _,clp in ipairs(world.descriptor.color_pattern) do
if clp.pattern=="MONOTONE" then
local cl=world.descriptor.color[clp.color[1]]
local diff=math.abs(wanted_color.r-cl.r)+math.abs(wanted_color.b-cl.b)+math.abs(wanted_color.g-cl.g)
if diff<best_total_diff then
best_clp=clp
best_total_diff=diff
end
end
end
lines[#lines+1]="[STATE_COLOR:"..kk..":"..best_clp.token.."]"
if kk=="SOLID" then solid_cl=world.descriptor.color[best_clp.color[1]] end
end
local color_str=solid_cl.col_f..":0:"..solid_cl.col_br
l(color_str)
lines[#lines+1]="[DISPLAY_COLOR:"..color_str.."]"
lines[#lines+1]="[BUILD_COLOR:"..color_str.."]"
lines[#lines+1]="[ITEMS_METAL][ITEMS_HARD][ITEMS_SCALED][ITEMS_BARRED]"
lines[#lines+1]="[SPECIAL]"
if v.material.flags.ITEMS_DIGGER then
lines[#lines+1]="[ITEMS_DIGGER]"
end
local function new_value(str)
mat_values[str]=mat_values[str] or math.floor((adamantine.material[str]*wafers+v.material[str]*bars*3)*avg_denom+0.5)
l(str,mat_values[str])
return mat_values[str]
end
local function new_value_nested(str1,str2)
mat_values[str1..str2]=mat_values[str1..str2] or math.floor((adamantine.material[str1][str2]*wafers+v.material[str1][str2]*bars*3)/(bars*3+wafers)+0.5)
l(str1..str2,mat_values[str1..str2])
return mat_values[str1..str2]
end
if new_value_nested("fracture","SHEAR")>170000 or new_value_nested("yield","IMPACT")>245000 then
lines[#lines+1]="[ITEMS_WEAPON][ITEMS_AMMO]"
if new_value("solid_density")<10000 then
lines[#lines+1]="[ITEMS_WEAPON_RANGED][ITEMS_ARMOR]"
end
end
lines[#lines+1]="[MATERIAL_VALUE:"..new_value("base_value").."]"
lines[#lines+1]="[SPEC_HEAT:"..new_value("temp_spec_heat").."]"
lines[#lines+1]="[MELTING_POINT:"..new_value("temp_melting_point").."]"
lines[#lines+1]="[BOILING_POINT:"..new_value("temp_boiling_point").."]"
lines[#lines+1]="[SOLID_DENSITY:"..new_value("solid_density").."]"
lines[#lines+1]="[LIQUID_DENSITY:"..new_value("liquid_density").."]"
lines[#lines+1]="[MOLAR_MASS:"..new_value("molar_mass").."]" -- i don't think this is actually correct
for _,thing in ipairs({"yield","fracture"}) do
for force,_ in pairs(v.material[thing]) do
lines[#lines+1]="["..string.upper(force).."_"..string.upper(thing)..":"..new_value_nested(thing,force).."]"
end
end
for _,force in ipairs("IMPACT","COMPRESSIVE","TENSILE","TORSION","SHEAR","BENDING") do
local modulus = v.yield[force] / v.elasticity[force]
local average_modulus = (adamantine_modulus*wafers + modulus*bars*3)*avg_denom
local strain_at_yield = math.floor(new_value_nested("yield",force) / average_modulus + 0.5) -- usually zero, but can be 1 or 2 sometimes
lines[#lines+1]="["..string.upper(force).."_YIELD:"..new_value_nested("yield",force).."]"
lines[#lines+1]="["..string.upper(force).."_FRACTURE:"..new_value_nested("fracture",force).."]"
lines[#lines+1]="["..string.upper(force).."_STRAIN_AT_YIELD:"..strain_at_yield.."]"
end
lines[#lines+1]="[MAX_EDGE:"..new_value("max_edge").."]"
local reaction_token=token.."_MAKING"
reaction_lines[#reaction_lines+1]="[REACTION:"..reaction_token.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1]="[NAME:make adamantine "..v.material.name.SOLID.." (use bars)]"
reaction_lines[#reaction_lines+1]="[BUILDING:SMELTER:NONE]"
reaction_lines[#reaction_lines+1]="[REAGENT:A:"..tostring(150*wafers)..":BAR:NO_SUBTYPE:METAL:ADAMANTINE]"
reaction_lines[#reaction_lines+1]="[REAGENT:B:"..tostring(150*bars)..":BAR:NO_SUBTYPE:METAL:"..v.token.."]"
reaction_lines[#reaction_lines+1]="[PRODUCT:100:"..tostring(bars+wafers)..":BAR:NO_SUBTYPE:METAL:"..token.."][PRODUCT_DIMENSION:150]"
reaction_lines[#reaction_lines+1]="[FORTRESS_MODE_ENABLED]"
reaction_lines[#reaction_lines+1]="[CATEGORY:ADAMANTINE_ALLOYS]"
if not done_category then
done_category=true
reaction_lines[#reaction_lines+1]="[CATEGORY_NAME:Adamantine alloys]"
reaction_lines[#reaction_lines+1]="[CATEGORY_DESCRIPTION:Debase adamantine with other metals to get extremely strong alloys.]"
reaction_lines[#reaction_lines+1]="[CATEGORY_KEY:CUSTOM_SHIFT_A]"
end
reaction_lines[#reaction_lines+1]="[FUEL]"
reaction_lines[#reaction_lines+1]="[SKILL:SMELT]"
end
end
local entity_lines={}
raws.register_inorganics(lines)
-- not used in vanilla right now, due to lack of instruments, but you CAN do this
raws.register_reactions(reaction_lines)
end}}

[[Category:Modding]]
[[Category:Modding Examples]]
[[Category:Lua|S]]

Lua script examples

2025-10-18T18:54:55Z

DPhKraken: Repo link

{{av}}
{{Modding}}
{{Main|Lua scripting}}
Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``[https://github.com/Putnam3145/DF-Raws/tree/master/vanilla_procedural/scripts data/vanilla/vanilla_procedural/scripts/]``.
__TOC__


==Helper functions==

===Search by reaction class===
This script returns a table of all inorganic materials with a given {{token|REACTION_CLASS|md}}. The ``mat`` table also has ``reaction_product_class``, which includes both {{token|MATERIAL_REACTION_PRODUCT|md}} and {{token|ITEM_REACTION_PRODUCT|md}} IDs.
{{Scriptdata
|title=get_all_by_reaction_class()
|script=
function get_all_by_reaction_class(rc)
local valid={}
for i,inorg in ipairs(world.inorganic.inorganic) do
for _,class in inorg.mat.reaction_class do
if class==rc then
valid[#valid+1]=inorg
end
end
end
return valid
end}}

==Languages==

===Identity language===
This makes a [[Language token|language]] called ``GEN_IDENTITY`` which is like: "Abbey abbeyabbeys the abbey of abbeys" - i.e. it's the "English" language you might see occasionally. It is present in ``vanilla_procedural`` and can be used for {{Token|TRANSLATION|entity}} by default.

{{Scriptdata
|title=GEN_IDENTITY
|script=
languages.GEN_IDENTITY=function()
-- just to demonstrate the absolute most basic method of generating one of these
-- also so that you can just mod stuff to use GEN_IDENTITY
local tbl={}
local unempty = function(str1, str2)
return str1=='' and str2 or str1
end
for k,v in ipairs(world.language.word) do
local str=''
str=unempty(str,v.NOUN_SING)
str=unempty(str,v.ADJ)
str=unempty(str,v.VERB_FIRST_PRES)
str=unempty(str,string.lower(v.token))
tbl[v.token]=str
end
return tbl
end}}

===Kobold language===
This generates a language made of {{token|UTTERANCES}}. This is essentially a proper translation based on the [[kobold language]]. Note that the hardcoded ``utterance()`` function generates words independently of any existing words in the language, so you may get duplicate words.

{{Scriptdata
|title=GEN_KOBOLD
|script=
languages.GEN_KOBOLD=function()
local tbl={}
for k,v in ipairs(world.language.word) do
tbl[v.token]=utterance()
end
return tbl
end}}

==Generators==

===Non-random generated material===

Here's an example of an object registered through the ``do_once`` table. There are no random elements, it is equivalent (save for being {{token|GENERATED|mat}}) to an object defined through [[Material definition token]]s and registered through the ``raws.register_inorganics()`` function. It also prints itself to the lualog for debugging purposes.

{{Scriptdata
|title=Single material
|script=do_once.cobalt = function()
local lines = {}

-- basic inorganic definition
lines[#lines+1] = "[INORGANIC:COBALT]"
-- add [GENERATED] to save properly
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling cobalt]"
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:COBALT]"
lines[#lines+1] = "[SPECIAL]"

raws.register_inorganics(lines)

-- show in lualog
print_table(lines)
end
}}
 
You can register multiple objects at the same time. This script takes a table of color tokens, and makes a metal named after each of them, with a corresponding cheaty adventure reaction.

{{Scriptdata
|title=Chromatic metals
|script=do_once.chromatic_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- make a metal for each color token
for k,v in pairs(color_tokens) do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:CHROMATICMETAL"..v.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- look up the metal's color in the world table
-- using string.lower(v) would result in "moss_green"
local metalname = world.descriptor.color[v].name
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

-- appearance
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..v.."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:CHROMATICMETAL"..v.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:CHROMATICMETAL"..v.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===Random generation===

Here's an example of various DF-specific randomizers in use:
* ``trandom()`` is used to determine how many metals generate this way.
* ``utterance()`` generates utterances from the [[Kobold language]], e.g. "gorsnus", "stogodilmus", "gaylgis"
* ``pick_random_no_replace()`` determines the color from the table, but removes the rolled value so there's no repeats.

{{Scriptdata
|title=Kobold metals
|script=do_once.kobold_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- trandom() is expressed as (1dN)-1 because it uses C++ math that starts at 0
local max_loops = trandom(10)+1

-- create 1-10 metals
for i = 1,max_loops do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:KOBOLDMETAL"..i.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- this is the kobold name function
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"
-- no_replace removes the value from the table
-- we don't need a fallback because there's more values than metals
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random_no_replace(color_tokens).."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:KOBOLDMETAL"..i.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:KOBOLDMETAL"..i.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===New divine metals===

Many of the tables used by vanilla procedural objects are global, and thus can be added to or overwritten by mods. You can add new metal descriptions for divine metal pretty easily, for example:

{{Scriptdata
|title=Laughing metal
|script=
metal_by_sphere.CHILDREN={
name="laughing metal",
col="7:0:1",
color="WHITE"
}
}}
 
You can also add alternatives to the default divine metal function, such as one based on the aforementioned kobold metals.
Vanilla divine metal uses ``metal_by_sphere`` to determine its properties, and is thus valid only if the input sphere has an entry in that table.
Note that even if the weights are nominally the same; because it is valid for all input spheres, it will outnumber instances of the more limited vanilla material.

{{Scriptdata
|title=Divine kobold metal
|script=materials.divine.metal.kobold = function(sphere)
if not foo then
log(#metal_by_sphere)
log(#world.spheres)
foo = true
end
local lines = {}
--generation function handles ID, registration, generated info
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
--add_generated_info(lines)
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}
--allow for duplicate colors
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random(color_tokens).."]"

--add a block of tokens
lines=split_to_lines(lines,[[
[MATERIAL_VALUE:200]
[SPEC_HEAT:7500]
[MELTING_POINT:NONE]
[BOILING_POINT:NONE]
[ITEMS_WEAPON][ITEMS_WEAPON_RANGED][ITEMS_AMMO][ITEMS_DIGGER][ITEMS_ARMOR][ITEMS_ANVIL]
[ITEMS_HARD]
[ITEMS_METAL]
[ITEMS_BARRED]
[ITEMS_SCALED]
[SOLID_DENSITY:1000]
[LIQUID_DENSITY:1000]
[MOLAR_MASS:20000]
[IMPACT_YIELD:1000000]
[IMPACT_FRACTURE:2000000]
[IMPACT_STRAIN_AT_YIELD:0]
[COMPRESSIVE_YIELD:1000000]
[COMPRESSIVE_FRACTURE:2000000]
[COMPRESSIVE_STRAIN_AT_YIELD:0]
[TENSILE_YIELD:1000000]
[TENSILE_FRACTURE:2000000]
[TENSILE_STRAIN_AT_YIELD:0]
[TORSION_YIELD:1000000]
[TORSION_FRACTURE:2000000]
[TORSION_STRAIN_AT_YIELD:0]
[SHEAR_YIELD:1000000]
[SHEAR_FRACTURE:2000000]
[SHEAR_STRAIN_AT_YIELD:0]
[BENDING_YIELD:1000000]
[BENDING_FRACTURE:2000000]
[BENDING_STRAIN_AT_YIELD:0]
[MAX_EDGE:12000]
]])
--sends this to get registered
return {raws=lines,weight=1}
end
}}

===Remove default functions===

Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.

See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.

<syntaxhighlight lang="lua" >
creatures.fb.default=nil
</syntaxhighlight>

===Basic generated creature===

This is essentially the simplest possible creature. It has no extraordinary options (beyond an [[Sphere|association]] with animals and creation), and each world generates one species from this function. It doesn't have any biome tokens or likewise, so it can only be spawned in the arena, but it is still functional.

A sample output would be "A quadruped composed of flame. It has two narrow tails and it has a regal bearing."

{{Scriptdata
|title=do_once.basic_creature
|script=do_once.basic_creature = function()
local lines = {}
local tok="BASIC_PROCEDURAL_CREATURE"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
CREATION=true
}
}
lines=split_to_lines(lines,[[
[NAME:procedural creature:procedural creatures:procedural]
[CASTE_NAME:procedural creature:procedural creatures:procedural]
]])
--adds some common tokens depending on the options
add_regular_tokens(lines,options)

--handles sphere options: fills out [SPHERE] tokens from options.spheres, and so on
populate_sphere_info(lines,options)

--choose a creature profile to base on
local rcp=get_random_creature_profile(options)
--set [BODY_SIZE] and some relevant tokens
add_body_size(lines,rcp.min_size,options)
--add the tile from the creature profile
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"

--the Big Function determining tweaks, body, appearance, description...
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}

===Making your own RCP===

You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.

This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.

{{Scriptdata
|title=do_once.local_rcp
|script=do_once.local_rcp = function()
local lines = {}
local tok="LOCAL_RCP"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
WATER=true
}
}
add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
--habitat
lines[#lines+1]="[BIOME:ANY_OCEAN]"
lines[#lines+1]="[LARGE_ROAMING]"
lines[#lines+1]="[AQUATIC][UNDERSWIM]"

--define a local creature profile
local rcp={
name_string="eurypterid",
tile='E',
body_base="SCORPION",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}
local name_str = rcp.name_string..":"..rcp.name_string.."s:"..rcp.name_string.."]"
lines[#lines+1] = "[NAME:"..name_str
lines[#lines+1] = "[CASTE_NAME:"..name_str

add_body_size(lines,rcp.min_size,options)
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}
 
Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.

This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

Other feature variants stored in tables, like materials, attacks, or descriptions, can be added in this way.

{{Scriptdata
|title=Global RCP
|script=
random_creature_types.EURYPTERID={
name_string="eurypterid",
tile='E',
body_base="SCORPION_FLIPPERS",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}

body_base_fun.SCORPION_FLIPPERS=function(rcp,options)
options.pcg_layering_base="BEAST_SCORPION"
options.walk_var="STANDARD_WALKING_GAITS"
options.walk_speed=900
return {"RCP_CEPHALOTHORAX","RCP_ABDOMEN","RCP_FIRST_SIMPLE_LEGS","RCP_SECOND_SIMPLE_LEGS","RCP_THIRD_SIMPLE_LEGS","RCP_PINCERS","RCP_FRONT_FLIPPER"}
end

water_based_random_creature.EURYPTERID=true
}}

===Werebugs===

You can make a custom function to determine what RCPs are available to a given creature.

These scripts are for an arthropoid version of a [[werebeast]].
* ``arthropod_rcp`` is a list of RCP keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
* ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].

Otherwise, the function should work the same as vanilla werebeasts, generating an associated [[Interaction token|major curse]] in the same way and becoming "twisted into humanoid form" (at the expense of their additional limbs).

{{Scriptdata
|title=arthropod_rcp
|script=local arthropod_rcp = {
"ARACHNID_MITE",
"ARACHNID_SCORPION",
"ARACHNID_SPIDER",
"ARACHNID_TARANTULA",
"ARACHNID_TICK",
"CRUSTACEAN_CRAB",
"CRUSTACEAN_LOBSTER",
"CRUSTACEAN_SHRIMP",
"INSECT_ANT",
"INSECT_ANTLION",
"INSECT_APHID",
"INSECT_BEE",
"INSECT_BUTTERFLY",
"INSECT_CADDISFLY",
"INSECT_CATERPILLAR",
"INSECT_CICADA",
"INSECT_COCKROACH",
"INSECT_CRICKET",
"INSECT_DAMSELFLY",
"INSECT_DARKLING_BEETLE",
"INSECT_DRAGONFLY",
"INSECT_EARWIG",
"INSECT_FIREFLY",
"INSECT_FLEA",
"INSECT_FLY",
"INSECT_GRASSHOPPER",
"INSECT_HORNET",
"INSECT_LACEWING",
"INSECT_LADYBUG",
"INSECT_LOUSE",
"INSECT_MAGGOT",
"INSECT_MANTIS",
"INSECT_MAYFLY",
"INSECT_MOSQUITO",
"INSECT_MOTH",
"INSECT_SILVERFISH",
"INSECT_SCARAB_BEETLE",
"INSECT_SCORPIONFLY",
"INSECT_SNAKEFLY",
"INSECT_STONEFLY",
"INSECT_TERMITE",
"INSECT_THRIPS",
"INSECT_WASP",
"INSECT_WEEVIL",
"NEMATODE",
"LEECH",
}
}}
{{Scriptdata
|title=is_bloodsucking_by_key
|script=local is_bloodsucking_by_key = {
ARACHNID_MITE=true,
ARACHNID_TICK=true,
INSECT_EARWIG=true,--some are parasitic
INSECT_FLEA=true,
INSECT_LOUSE=true,
INSECT_MAGGOT=true,
INSECT_THRIPS=true,--no bloodsucking reported, but does bite humans
NEMATODE=true,
}
}}
{{Scriptdata
|title=creatures.night_creature.werebeast.werebug
|script=creatures.night_creature.werebeast.werebug=function(tok)
local lines={}
local options={
spheres={
CHAOS=true,
ANIMALS=true,
NIGHT=true,
MOON=true
},
always_glowing_eyes=true,
use_werebeast_pcg=true, --use them if werebug sprites somehow exist
animal_coloring_allowed=true,
no_tweak=true,
material_weakness=true,
prioritize_bite=true,
force_ichor=true,
token=tok
}
options.night_creature_agile_pref=true
night_creature_universals(lines,options)
lines[#lines+1]="[NIGHT_CREATURE_HUNTER]"
lines[#lines+1]="[CAN_LEARN]"
lines[#lines+1]="[CAN_SPEAK]"
lines[#lines+1]="[NO_GENDER]"
lines[#lines+1]="[BONECARN]"
lines[#lines+1]="[CRAZED]"
if options.night_creature_strength_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=1000
elseif options.night_creature_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=800;
elseif options.night_creature_strength_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=850;
end
lines[#lines+1]="[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[PERSONALITY:BASHFUL:0:0:0]"
lines[#lines+1]="[PERSONALITY:STRESS_VULNERABILITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:FRIENDLINESS:0:0:0]"
lines[#lines+1]="[PERSONALITY:DISDAIN_ADVICE:100:100:100]"
lines[#lines+1]="[PERSONALITY:CHEER_PROPENSITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:GRATITUDE:0:0:0]"
lines[#lines+1]="[PERSONALITY:TRUST:0:0:0]"
lines[#lines+1]="[PERSONALITY:ALTRUISM:0:0:0]"
lines[#lines+1]="[PERSONALITY:CRUELTY:100:100:100]"

add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
lines[#lines+1]="[NATURAL_SKILL:WRESTLING:6]"
lines[#lines+1]="[NATURAL_SKILL:BITE:6]"
lines[#lines+1]="[NATURAL_SKILL:GRASP_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:STANCE_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:MELEE_COMBAT:6]"
lines[#lines+1]="[NATURAL_SKILL:DODGING:6]"
lines[#lines+1]="[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]"
lines[#lines+1]="[NATURAL_SKILL:SNEAK:20]"

lines[#lines+1]="[DIFFICULTY:3]"
lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
finalize_random_creature_types() -- good practice to run before rolling on it
local rcp_key = pick_random_no_replace(arthropod_rcp)
local rcp=random_creature_types[rcp_key] or random_creature_types.INSECT_MANTIS

local custom_desc_str = "it is crazed for blood and flesh"
-- make them also vampires if they suck blood
if rcp.must_suck_blood_through_proboscis or rcp.must_suck_blood_through_mouth or is_bloodsucking_by_key[rcp_key] then
lines[#lines+1]="[BLOODSUCKER]"
custom_desc_str = "it is crazed for warm blood"
end
-- This sort of process should be fully generalized
-- to all creatures you want to have bespoke associated interactions
-- for example, you can have a blessing that allows a sort of
-- uncrazed transformation into some sort of bespoke
-- generated thing--at least, hopefully it's robust enough for that
local choice=generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)
map_merge(options,choice.options)
local werebeast_choice_raws=choice.interaction or choice.raws
raws.register_interactions(werebeast_choice_raws)
add_body_size(lines,math.max(rcp.min_size,80000+trandom(11)*1000),options)
lines[#lines+1]="[CREATURE_TILE:165]" --Ñ
options.forced_color={
f=6,
b=0,
br=1
}
options.custom_desc_func=function(options)
return custom_desc_str
end
build_procgen_creature(rcp,lines,options)
lines[#lines+1]="[GO_TO_START]"
-- remove second words like " beetle", etc from the end
local short_name = rcp.name_string:gsub("%s(%w+)$","")
local name_str="were"..short_name..":were"..short_name.."s:were"..short_name.."]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str
return {raws=lines,weight=1}
end
}}

===New forgotten beasts===
You can add new types of forgotten beasts (or more appropriately, {{token|FEATURE_BEAST}}s). These generate as alternatives when populating the caverns with unique monsters. There are a number of options to interact with shared generation functions.

Unbidden spirits only appear in dry cave layers, and like "spirit" [[demon]]s, are malevolent floating beings made of gas or dust.

{{Scriptdata
|title=Unbidden spirit
|script=
creatures.fb.unbidden=function(layer_type,tok)
if layer_type==0 then return nil end -- land only
local tbl={}
local options={
strong_attack_tweak=true,
always_make_uniform=true,
always_insubstantial=true,
intangible_flier=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[CASTE_NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
-- Weight is a float; all vanilla objects have weight 1
return {creature=tbl,weight=0.5}
end
}}
 
[[Construct creature|Elementals]] are defined by the material they're made of, using a table of options to set the right properties. In a dry chasm layer, they'll roll on the ``fb_elements`` table, while in a water layer, they'll be a water elemental. Should they ever carry a [[syndrome]], they would inflict [[Wikipedia:Dyscrasia|dyskrasia]].

The most important feature is setting ``options.sphere_rcm`` to a key in ``random_creature_materials``, so fire elementals are made of "FLAME" and earth elementals are made of "ANY_MINERAL".

{{Scriptdata
|title=Elemental
|script=
fb_elements = {
{
name="fire",
rcm="FLAME",
spheres={ FIRE=true },
options={ fire_immune=true }
},
{
name="earth",
rcm="ANY_MINERAL",
rcp_options={ always_flightless=true },
spheres={
EARTH=true,
MINERALS=true
}
},
{
name="air",
rcm="STEAM",
spheres={
WIND=true,
SKY=true
},
options={
always_insubstantial=true,
intangible_flier=true
}
}
}

creatures.fb.elemental=function(layer_type,tok)
local lines={}
local options={
strong_attack_tweak=true,
always_make_uniform=true, --irrelevant due to sphere_rcm
spheres={},
sickness_name="dyskrasia",
token=tok
}
lines=split_to_lines(lines,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NO_GENDER]
[NO_EAT][NO_DRINK]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])

-- Create a water elemental in water layers, otherwise use another type
local water_elemental = {
name="water",
rcm="WATER",
spheres={WATER=true},
options={do_water=true}
}
local my_element = layer_type==1 and pick_random(fb_elements) or water_elemental

-- Assign propertes from chosen element
map_merge(options.spheres,my_element.spheres)
if my_element.options then map_merge(options,my_element.options) end

add_regular_tokens(lines,options)
lines[#lines+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
populate_sphere_info(lines,options)

-- Set custom material
options.sphere_rcm=my_element.rcm
-- Build body
local rcp=get_random_creature_profile(options)
-- Set more options on the RCP
if my_element.rcp_options then map_merge(rcp.options,my_element.rcp_options) end
add_body_size(lines,math.max(10000000,rcp.min_size),options)
lines[#lines+1]="[CREATURE_TILE:'E']"
build_procgen_creature(rcp,lines,options)

-- Generate name
local element_name = my_element.name or "glitchstuff"
local name_str = element_name.." elemental:"..element_name.." elemental:"..element_name.."-elemental]"
lines[#lines+1]="[GO_TO_START]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str

return {raws=lines,weight=1.5}
end
}}

===Tweaking creatures===


This function is run in ``build_body_from_rcp()`` right before tweaks are determined. If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.

{{Scriptdata
|title=btc1_tweaks.titan_worship
|script=
-- make all large creatures into powers
btc1_tweaks.titan_worship=function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
if options.body_size>=500000 then -- described as "very large", graphics size cutoff
options.can_learn=true -- for flavor text
lines[#lines+1]="[INTELLIGENT]"
lines[#lines+1]="[SUPERNATURAL]" -- knows secrets according to their spheres
lines[#lines+1]="[POWER]" -- impersonates deities
lines[#lines+1]="[SPREAD_EVIL_SPHERES_IF_RULER]"
end
end
}}

===Adamantine alloys===

You can add your own arbitrary generated objects, though as of right now there's no way to make settings for them. This allows for some ''truly'' wild stuff; here's a fun example: adamantine-metal alloys for every single non-special metal, giving you an average of the properties of them.

{{Scriptdata
|title=Adamantine alloys
|script=
preprocess.adamantine_alloys=function()
if not random_object_parameters.main_world_randoms then return end
local l=get_debug_logger(2)
local lines={}
local reaction_lines={}
local reaction_names={}
local adamantine=world.inorganic.inorganic.ADAMANTINE
if not adamantine then return end
local adamantine_color=world.descriptor.color[world.descriptor.color_pattern[adamantine.material.color_pattern.SOLID].color[1]]
local adamantine_modulus = 2500000 --mildly arbitrary, just below the theoretical limit
l("Starting")
local done_category=false
for k,v in ipairs(world.inorganic.inorganic) do
if not v.flags.SPECIAL and v.material.flags.IS_METAL then
l(v.token)
local token="GEN_ADAMANTINE_"..v.token
lines[#lines+1]="[INORGANIC:"..token.."]"
add_generated_info(lines)
lines[#lines+1]="[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
for kk,vv in pairs(v.material.adj) do
lines[#lines+1]="[STATE_ADJ:"..kk..":adamantine "..vv.."]" --"adamantine molten steel"? it's fine
end
for kk,vv in pairs(v.material.name) do
lines[#lines+1]="[STATE_NAME:"..kk..":adamantine "..vv.."]"
end
l(2)
local mat_values={}
-- Find the ratio for which you get closest to (but not below) 2000000 in the material's worst property
local worst=math.min(v.material.yield.IMPACT,v.material.fracture.SHEAR)
local wafers=1
local bars=1
if worst < 2000000 then
local ratio = (2000000-3*worst)/1000000
local best_diff=1
for i=1,10 do
local wafer_amt=i*ratio
if wafer_amt>1 and wafer_amt<20 and math.ceil(wafer_amt)-wafer_amt<best_diff then
best_diff=math.ceil(wafer_amt)-wafer_amt
wafers=math.ceil(wafer_amt)
bars=i
end
end
end
local avg_denom=1/(bars*3+wafers) -- Multiplication just a bit faster than division, we're rounding at the end anyway
local solid_cl=nil
for kk,vv in pairs(v.material.color_pattern) do
-- time to get silly
local this_color=world.descriptor.color[world.descriptor.color_pattern[vv].color[1]]
local wanted_color={
r=(this_color.r*bars*3+adamantine_color.r*wafers)*avg_denom,
g=(this_color.g*bars*3+adamantine_color.g*wafers)*avg_denom,
b=(this_color.b*bars*3+adamantine_color.b*wafers)*avg_denom,
}
local best_total_diff=1000000000
local best_clp=nil
for _,clp in ipairs(world.descriptor.color_pattern) do
if clp.pattern=="MONOTONE" then
local cl=world.descriptor.color[clp.color[1]]
local diff=math.abs(wanted_color.r-cl.r)+math.abs(wanted_color.b-cl.b)+math.abs(wanted_color.g-cl.g)
if diff<best_total_diff then
best_clp=clp
best_total_diff=diff
end
end
end
lines[#lines+1]="[STATE_COLOR:"..kk..":"..best_clp.token.."]"
if kk=="SOLID" then solid_cl=world.descriptor.color[best_clp.color[1]] end
end
local color_str=solid_cl.col_f..":0:"..solid_cl.col_br
l(color_str)
lines[#lines+1]="[DISPLAY_COLOR:"..color_str.."]"
lines[#lines+1]="[BUILD_COLOR:"..color_str.."]"
lines[#lines+1]="[ITEMS_METAL][ITEMS_HARD][ITEMS_SCALED][ITEMS_BARRED]"
lines[#lines+1]="[SPECIAL]"
if v.material.flags.ITEMS_DIGGER then
lines[#lines+1]="[ITEMS_DIGGER]"
end
local function new_value(str)
mat_values[str]=mat_values[str] or math.floor((adamantine.material[str]*wafers+v.material[str]*bars*3)*avg_denom+0.5)
l(str,mat_values[str])
return mat_values[str]
end
local function new_value_nested(str1,str2)
mat_values[str1..str2]=mat_values[str1..str2] or math.floor((adamantine.material[str1][str2]*wafers+v.material[str1][str2]*bars*3)/(bars*3+wafers)+0.5)
l(str1..str2,mat_values[str1..str2])
return mat_values[str1..str2]
end
if new_value_nested("fracture","SHEAR")>170000 or new_value_nested("yield","IMPACT")>245000 then
lines[#lines+1]="[ITEMS_WEAPON][ITEMS_AMMO]"
if new_value("solid_density")<10000 then
lines[#lines+1]="[ITEMS_WEAPON_RANGED][ITEMS_ARMOR]"
end
end
lines[#lines+1]="[MATERIAL_VALUE:"..new_value("base_value").."]"
lines[#lines+1]="[SPEC_HEAT:"..new_value("temp_spec_heat").."]"
lines[#lines+1]="[MELTING_POINT:"..new_value("temp_melting_point").."]"
lines[#lines+1]="[BOILING_POINT:"..new_value("temp_boiling_point").."]"
lines[#lines+1]="[SOLID_DENSITY:"..new_value("solid_density").."]"
lines[#lines+1]="[LIQUID_DENSITY:"..new_value("liquid_density").."]"
lines[#lines+1]="[MOLAR_MASS:"..new_value("molar_mass").."]" -- i don't think this is actually correct
for _,thing in ipairs({"yield","fracture"}) do
for force,_ in pairs(v.material[thing]) do
lines[#lines+1]="["..string.upper(force).."_"..string.upper(thing)..":"..new_value_nested(thing,force).."]"
end
end
for _,force in ipairs("IMPACT","COMPRESSIVE","TENSILE","TORSION","SHEAR","BENDING") do
local modulus = v.yield[force] / v.elasticity[force]
local average_modulus = (adamantine_modulus*wafers + modulus*bars*3)*avg_denom
local strain_at_yield = math.floor(new_value_nested("yield",force) / average_modulus + 0.5) -- usually zero, but can be 1 or 2 sometimes
lines[#lines+1]="["..string.upper(force).."_YIELD:"..new_value_nested("yield",force).."]"
lines[#lines+1]="["..string.upper(force).."_FRACTURE:"..new_value_nested("fracture",force).."]"
lines[#lines+1]="["..string.upper(force).."_STRAIN_AT_YIELD:"..strain_at_yield.."]"
end
lines[#lines+1]="[MAX_EDGE:"..new_value("max_edge").."]"
local reaction_token=token.."_MAKING"
reaction_lines[#reaction_lines+1]="[REACTION:"..reaction_token.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1]="[NAME:make adamantine "..v.material.name.SOLID.." (use bars)]"
reaction_lines[#reaction_lines+1]="[BUILDING:SMELTER:NONE]"
reaction_lines[#reaction_lines+1]="[REAGENT:A:"..tostring(150*wafers)..":BAR:NO_SUBTYPE:METAL:ADAMANTINE]"
reaction_lines[#reaction_lines+1]="[REAGENT:B:"..tostring(150*bars)..":BAR:NO_SUBTYPE:METAL:"..v.token.."]"
reaction_lines[#reaction_lines+1]="[PRODUCT:100:"..tostring(bars+wafers)..":BAR:NO_SUBTYPE:METAL:"..token.."][PRODUCT_DIMENSION:150]"
reaction_lines[#reaction_lines+1]="[FORTRESS_MODE_ENABLED]"
reaction_lines[#reaction_lines+1]="[CATEGORY:ADAMANTINE_ALLOYS]"
if not done_category then
done_category=true
reaction_lines[#reaction_lines+1]="[CATEGORY_NAME:Adamantine alloys]"
reaction_lines[#reaction_lines+1]="[CATEGORY_DESCRIPTION:Debase adamantine with other metals to get extremely strong alloys.]"
reaction_lines[#reaction_lines+1]="[CATEGORY_KEY:CUSTOM_SHIFT_A]"
end
reaction_lines[#reaction_lines+1]="[FUEL]"
reaction_lines[#reaction_lines+1]="[SKILL:SMELT]"
end
end
local entity_lines={}
raws.register_inorganics(lines)
-- not used in vanilla right now, due to lack of instruments, but you CAN do this
raws.register_reactions(reaction_lines)
end}}

[[Category:Modding]]
[[Category:Modding Examples]]
[[Category:Lua|S]]

Lua script examples

2025-10-17T18:30:34Z

DPhKraken: /* Werebugs */ Added fallback RCP

{{av}}
{{Modding}}
{{Main|Lua scripting}}
Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``data/vanilla/vanilla_procedural/scripts/``.
__TOC__


==Helper functions==

===Search by reaction class===
This script returns a table of all inorganic materials with a given {{token|REACTION_CLASS|md}}. The ``mat`` table also has ``reaction_product_class``, which includes both {{token|MATERIAL_REACTION_PRODUCT|md}} and {{token|ITEM_REACTION_PRODUCT|md}} IDs.
{{Scriptdata
|title=get_all_by_reaction_class()
|script=
function get_all_by_reaction_class(rc)
local valid={}
for i,inorg in ipairs(world.inorganic.inorganic) do
for _,class in inorg.mat.reaction_class do
if class==rc then
valid[#valid+1]=inorg
end
end
end
return valid
end}}

==Languages==

===Identity language===
This makes a [[Language token|language]] called ``GEN_IDENTITY`` which is like: "Abbey abbeyabbeys the abbey of abbeys" - i.e. it's the "English" language you might see occasionally. It is present in ``vanilla_procedural`` and can be used for {{Token|TRANSLATION|entity}} by default.

{{Scriptdata
|title=GEN_IDENTITY
|script=
languages.GEN_IDENTITY=function()
-- just to demonstrate the absolute most basic method of generating one of these
-- also so that you can just mod stuff to use GEN_IDENTITY
local tbl={}
local unempty = function(str1, str2)
return str1=='' and str2 or str1
end
for k,v in ipairs(world.language.word) do
local str=''
str=unempty(str,v.NOUN_SING)
str=unempty(str,v.ADJ)
str=unempty(str,v.VERB_FIRST_PRES)
str=unempty(str,string.lower(v.token))
tbl[v.token]=str
end
return tbl
end}}

===Kobold language===
This generates a language made of {{token|UTTERANCES}}. This is essentially a proper translation based on the [[kobold language]]. Note that the hardcoded ``utterance()`` function generates words independently of any existing words in the language, so you may get duplicate words.

{{Scriptdata
|title=GEN_KOBOLD
|script=
languages.GEN_KOBOLD=function()
local tbl={}
for k,v in ipairs(world.language.word) do
tbl[v.token]=utterance()
end
return tbl
end}}

==Generators==

===Non-random generated material===

Here's an example of an object registered through the ``do_once`` table. There are no random elements, it is equivalent (save for being {{token|GENERATED|mat}}) to an object defined through [[Material definition token]]s and registered through the ``raws.register_inorganics()`` function. It also prints itself to the lualog for debugging purposes.

{{Scriptdata
|title=Single material
|script=do_once.cobalt = function()
local lines = {}

-- basic inorganic definition
lines[#lines+1] = "[INORGANIC:COBALT]"
-- add [GENERATED] to save properly
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid cobalt]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling cobalt]"
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:COBALT]"
lines[#lines+1] = "[SPECIAL]"

raws.register_inorganics(lines)

-- show in lualog
print_table(lines)
end
}}
 
You can register multiple objects at the same time. This script takes a table of color tokens, and makes a metal named after each of them, with a corresponding cheaty adventure reaction.

{{Scriptdata
|title=Chromatic metals
|script=do_once.chromatic_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- make a metal for each color token
for k,v in pairs(color_tokens) do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:CHROMATICMETAL"..v.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- look up the metal's color in the world table
-- using string.lower(v) would result in "moss_green"
local metalname = world.descriptor.color[v].name
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

-- appearance
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..v.."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:CHROMATICMETAL"..v.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:CHROMATICMETAL"..v.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===Random generation===

Here's an example of various DF-specific randomizers in use:
* ``trandom()`` is used to determine how many metals generate this way.
* ``utterance()`` generates utterances from the [[Kobold language]], e.g. "gorsnus", "stogodilmus", "gaylgis"
* ``pick_random_no_replace()`` determines the color from the table, but removes the rolled value so there's no repeats.

{{Scriptdata
|title=Kobold metals
|script=do_once.kobold_metal = function()
local lines = {}
local reaction_lines = {}

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}

-- trandom() is expressed as (1dN)-1 because it uses C++ math that starts at 0
local max_loops = trandom(10)+1

-- create 1-10 metals
for i = 1,max_loops do
-- begin definition with ID token, [GENERATED] and template
lines[#lines+1] = "[INORGANIC:KOBOLDMETAL"..i.."]"
add_generated_info(lines)
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"

-- this is the kobold name function
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"
-- no_replace removes the value from the table
-- we don't need a fallback because there's more values than metals
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random_no_replace(color_tokens).."]"
lines[#lines+1] = "[SPECIAL]"

-- create a corresponding reaction
reaction_lines[#reaction_lines+1] = "[REACTION:KOBOLDMETAL"..i.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1] = "[NAME:create "..metalname.." bars]"
reaction_lines[#reaction_lines+1] = "[ADVENTURE_MODE_ENABLED]"
-- make sure we're consistent with the inorganic ID
reaction_lines[#reaction_lines+1] = "[PRODUCT:100:1:BAR:NONE:INORGANIC:KOBOLDMETAL"..i.."]"
reaction_lines[#reaction_lines+1] = "[PRODUCT_DIMENSION:150]"
end
raws.register_inorganics(lines)
raws.register_reactions(reaction_lines)
end
}}

===New divine metals===

Many of the tables used by vanilla procedural objects are global, and thus can be added to or overwritten by mods. You can add new metal descriptions for divine metal pretty easily, for example:

{{Scriptdata
|title=Laughing metal
|script=
metal_by_sphere.CHILDREN={
name="laughing metal",
col="7:0:1",
color="WHITE"
}
}}
 
You can also add alternatives to the default divine metal function, such as one based on the aforementioned kobold metals.
Vanilla divine metal uses ``metal_by_sphere`` to determine its properties, and is thus valid only if the input sphere has an entry in that table.
Note that even if the weights are nominally the same; because it is valid for all input spheres, it will outnumber instances of the more limited vanilla material.

{{Scriptdata
|title=Divine kobold metal
|script=materials.divine.metal.kobold = function(sphere)
if not foo then
log(#metal_by_sphere)
log(#world.spheres)
foo = true
end
local lines = {}
--generation function handles ID, registration, generated info
lines[#lines+1] = "[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
--add_generated_info(lines)
local metalname = utterance().."ite"
lines[#lines+1] = "[STATE_NAME_ADJ:ALL_SOLID:"..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:LIQUID:liquid "..metalname.."]"
lines[#lines+1] = "[STATE_NAME_ADJ:GAS:boiling "..metalname.."]"

local color_tokens = {
"AMETHYST",
"AQUAMARINE",
"CARDINAL",
"COBALT",
"EMERALD",
"JADE",
"MOSS_GREEN",
"PEARL",
"SAFFRON",
"TURQUOISE",
"WHITE",
}
--allow for duplicate colors
lines[#lines+1] = "[STATE_COLOR:ALL_SOLID:"..pick_random(color_tokens).."]"

--add a block of tokens
lines=split_to_lines(lines,[[
[MATERIAL_VALUE:200]
[SPEC_HEAT:7500]
[MELTING_POINT:NONE]
[BOILING_POINT:NONE]
[ITEMS_WEAPON][ITEMS_WEAPON_RANGED][ITEMS_AMMO][ITEMS_DIGGER][ITEMS_ARMOR][ITEMS_ANVIL]
[ITEMS_HARD]
[ITEMS_METAL]
[ITEMS_BARRED]
[ITEMS_SCALED]
[SOLID_DENSITY:1000]
[LIQUID_DENSITY:1000]
[MOLAR_MASS:20000]
[IMPACT_YIELD:1000000]
[IMPACT_FRACTURE:2000000]
[IMPACT_STRAIN_AT_YIELD:0]
[COMPRESSIVE_YIELD:1000000]
[COMPRESSIVE_FRACTURE:2000000]
[COMPRESSIVE_STRAIN_AT_YIELD:0]
[TENSILE_YIELD:1000000]
[TENSILE_FRACTURE:2000000]
[TENSILE_STRAIN_AT_YIELD:0]
[TORSION_YIELD:1000000]
[TORSION_FRACTURE:2000000]
[TORSION_STRAIN_AT_YIELD:0]
[SHEAR_YIELD:1000000]
[SHEAR_FRACTURE:2000000]
[SHEAR_STRAIN_AT_YIELD:0]
[BENDING_YIELD:1000000]
[BENDING_FRACTURE:2000000]
[BENDING_STRAIN_AT_YIELD:0]
[MAX_EDGE:12000]
]])
--sends this to get registered
return {raws=lines,weight=1}
end
}}

===Remove default functions===

Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.

See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.

<syntaxhighlight lang="lua" >
creatures.fb.default=nil
</syntaxhighlight>

===Basic generated creature===

This is essentially the simplest possible creature. It has no extraordinary options (beyond an [[Sphere|association]] with animals and creation), and each world generates one species from this function. It doesn't have any biome tokens or likewise, so it can only be spawned in the arena, but it is still functional.

A sample output would be "A quadruped composed of flame. It has two narrow tails and it has a regal bearing."

{{Scriptdata
|title=do_once.basic_creature
|script=do_once.basic_creature = function()
local lines = {}
local tok="BASIC_PROCEDURAL_CREATURE"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
CREATION=true
}
}
lines=split_to_lines(lines,[[
[NAME:procedural creature:procedural creatures:procedural]
[CASTE_NAME:procedural creature:procedural creatures:procedural]
]])
--adds some common tokens depending on the options
add_regular_tokens(lines,options)

--handles sphere options: fills out [SPHERE] tokens from options.spheres, and so on
populate_sphere_info(lines,options)

--choose a creature profile to base on
local rcp=get_random_creature_profile(options)
--set [BODY_SIZE] and some relevant tokens
add_body_size(lines,rcp.min_size,options)
--add the tile from the creature profile
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"

--the Big Function determining tweaks, body, appearance, description...
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}

===Making your own RCP===

You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.

This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.

{{Scriptdata
|title=do_once.local_rcp
|script=do_once.local_rcp = function()
local lines = {}
local tok="LOCAL_RCP"
lines[#lines+1]="[CREATURE:"..tok.."]"
add_generated_info(lines)

local options={
token=tok,
spheres={
ANIMALS=true,
WATER=true
}
}
add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
--habitat
lines[#lines+1]="[BIOME:ANY_OCEAN]"
lines[#lines+1]="[LARGE_ROAMING]"
lines[#lines+1]="[AQUATIC][UNDERSWIM]"

--define a local creature profile
local rcp={
name_string="eurypterid",
tile='E',
body_base="SCORPION",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}
local name_str = rcp.name_string..":"..rcp.name_string.."s:"..rcp.name_string.."]"
lines[#lines+1] = "[NAME:"..name_str
lines[#lines+1] = "[CASTE_NAME:"..name_str

add_body_size(lines,rcp.min_size,options)
lines[#lines+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,lines,options)

raws.register_creatures(lines)
end
}}
 
Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.

This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

Other feature variants stored in tables, like materials, attacks, or descriptions, can be added in this way.

{{Scriptdata
|title=Global RCP
|script=
random_creature_types.EURYPTERID={
name_string="eurypterid",
tile='E',
body_base="SCORPION_FLIPPERS",
c_class="CHITIN_EXO",
must_have_pincers=true,
must_have_tail=true,
min_size=70000,
weight=200,
}

body_base_fun.SCORPION_FLIPPERS=function(rcp,options)
options.pcg_layering_base="BEAST_SCORPION"
options.walk_var="STANDARD_WALKING_GAITS"
options.walk_speed=900
return {"RCP_CEPHALOTHORAX","RCP_ABDOMEN","RCP_FIRST_SIMPLE_LEGS","RCP_SECOND_SIMPLE_LEGS","RCP_THIRD_SIMPLE_LEGS","RCP_PINCERS","RCP_FRONT_FLIPPER"}
end

water_based_random_creature.EURYPTERID=true
}}

===Werebugs===

You can make a custom function to determine what RCPs are available to a given creature.

These scripts are for an arthropoid version of a [[werebeast]].
* ``arthropod_rcp`` is a list of RCP keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
* ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].

Otherwise, the function should work the same as vanilla werebeasts, generating an associated [[Interaction token|major curse]] in the same way and becoming "twisted into humanoid form" (at the expense of their additional limbs).

{{Scriptdata
|title=arthropod_rcp
|script=local arthropod_rcp = {
"ARACHNID_MITE",
"ARACHNID_SCORPION",
"ARACHNID_SPIDER",
"ARACHNID_TARANTULA",
"ARACHNID_TICK",
"CRUSTACEAN_CRAB",
"CRUSTACEAN_LOBSTER",
"CRUSTACEAN_SHRIMP",
"INSECT_ANT",
"INSECT_ANTLION",
"INSECT_APHID",
"INSECT_BEE",
"INSECT_BUTTERFLY",
"INSECT_CADDISFLY",
"INSECT_CATERPILLAR",
"INSECT_CICADA",
"INSECT_COCKROACH",
"INSECT_CRICKET",
"INSECT_DAMSELFLY",
"INSECT_DARKLING_BEETLE",
"INSECT_DRAGONFLY",
"INSECT_EARWIG",
"INSECT_FIREFLY",
"INSECT_FLEA",
"INSECT_FLY",
"INSECT_GRASSHOPPER",
"INSECT_HORNET",
"INSECT_LACEWING",
"INSECT_LADYBUG",
"INSECT_LOUSE",
"INSECT_MAGGOT",
"INSECT_MANTIS",
"INSECT_MAYFLY",
"INSECT_MOSQUITO",
"INSECT_MOTH",
"INSECT_SILVERFISH",
"INSECT_SCARAB_BEETLE",
"INSECT_SCORPIONFLY",
"INSECT_SNAKEFLY",
"INSECT_STONEFLY",
"INSECT_TERMITE",
"INSECT_THRIPS",
"INSECT_WASP",
"INSECT_WEEVIL",
"NEMATODE",
"LEECH",
}
}}
{{Scriptdata
|title=is_bloodsucking_by_key
|script=local is_bloodsucking_by_key = {
ARACHNID_MITE=true,
ARACHNID_TICK=true,
INSECT_EARWIG=true,--some are parasitic
INSECT_FLEA=true,
INSECT_LOUSE=true,
INSECT_MAGGOT=true,
INSECT_THRIPS=true,--no bloodsucking reported, but does bite humans
NEMATODE=true,
}
}}
{{Scriptdata
|title=creatures.night_creature.werebeast.werebug
|script=creatures.night_creature.werebeast.werebug=function(tok)
local lines={}
local options={
spheres={
CHAOS=true,
ANIMALS=true,
NIGHT=true,
MOON=true
},
always_glowing_eyes=true,
use_werebeast_pcg=true, --use them if werebug sprites somehow exist
animal_coloring_allowed=true,
no_tweak=true,
material_weakness=true,
prioritize_bite=true,
force_ichor=true,
token=tok
}
options.night_creature_agile_pref=true
night_creature_universals(lines,options)
lines[#lines+1]="[NIGHT_CREATURE_HUNTER]"
lines[#lines+1]="[CAN_LEARN]"
lines[#lines+1]="[CAN_SPEAK]"
lines[#lines+1]="[NO_GENDER]"
lines[#lines+1]="[BONECARN]"
lines[#lines+1]="[CRAZED]"
if options.night_creature_strength_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=1000
elseif options.night_creature_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:450:550:700:750:800:850:900]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1250:1500:2000:2250:2500:3000]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=800;
elseif options.night_creature_strength_agile_pref then
lines[#lines+1]="[PHYS_ATT_RANGE:STRENGTH:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:AGILITY:1000:1150:1250:1500:2000:2250:2500]"
lines[#lines+1]="[PHYS_ATT_RANGE:TOUGHNESS:850:900:950:1000:1050:1100:1150]"
lines[#lines+1]="[PHYS_ATT_RANGE:ENDURANCE:850:900:950:1000:1050:1100:1150]"
options.special_walk_speed=850;
end
lines[#lines+1]="[PHYS_ATT_RANGE:RECUPERATION:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[PHYS_ATT_RANGE:DISEASE_RESISTANCE:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[MENT_ATT_RANGE:ANALYTICAL_ABILITY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:FOCUS:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:WILLPOWER:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:PATIENCE:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:MEMORY:1250:1500:1750:2000:2500:3000:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:LINGUISTIC_ABILITY:450:1050:1150:1250:1350:1550:2250]"
lines[#lines+1]="[MENT_ATT_RANGE:MUSICALITY:0:333:666:1000:2333:3666:5000]"
lines[#lines+1]="[MENT_ATT_RANGE:SOCIAL_AWARENESS:700:1300:1400:1500:1600:1800:2500]"
lines[#lines+1]="[PERSONALITY:BASHFUL:0:0:0]"
lines[#lines+1]="[PERSONALITY:STRESS_VULNERABILITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:FRIENDLINESS:0:0:0]"
lines[#lines+1]="[PERSONALITY:DISDAIN_ADVICE:100:100:100]"
lines[#lines+1]="[PERSONALITY:CHEER_PROPENSITY:0:0:0]"
lines[#lines+1]="[PERSONALITY:GRATITUDE:0:0:0]"
lines[#lines+1]="[PERSONALITY:TRUST:0:0:0]"
lines[#lines+1]="[PERSONALITY:ALTRUISM:0:0:0]"
lines[#lines+1]="[PERSONALITY:CRUELTY:100:100:100]"

add_regular_tokens(lines,options)
populate_sphere_info(lines,options)
lines[#lines+1]="[NATURAL_SKILL:WRESTLING:6]"
lines[#lines+1]="[NATURAL_SKILL:BITE:6]"
lines[#lines+1]="[NATURAL_SKILL:GRASP_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:STANCE_STRIKE:6]"
lines[#lines+1]="[NATURAL_SKILL:MELEE_COMBAT:6]"
lines[#lines+1]="[NATURAL_SKILL:DODGING:6]"
lines[#lines+1]="[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]"
lines[#lines+1]="[NATURAL_SKILL:SNEAK:20]"

lines[#lines+1]="[DIFFICULTY:3]"
lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
finalize_random_creature_types() -- good practice to run before rolling on it
local rcp_key = pick_random_no_replace(arthropod_rcp)
local rcp=random_creature_types[rcp_key] or random_creature_types.INSECT_MANTIS

local custom_desc_str = "it is crazed for blood and flesh"
-- make them also vampires if they suck blood
if rcp.must_suck_blood_through_proboscis or rcp.must_suck_blood_through_mouth or is_bloodsucking_by_key[rcp_key] then
lines[#lines+1]="[BLOODSUCKER]"
custom_desc_str = "it is crazed for warm blood"
end
-- This sort of process should be fully generalized
-- to all creatures you want to have bespoke associated interactions
-- for example, you can have a blessing that allows a sort of
-- uncrazed transformation into some sort of bespoke
-- generated thing--at least, hopefully it's robust enough for that
local choice=generate_from_list(werebeast_origin_interactions,tok,rcp.name_string,options)
map_merge(options,choice.options)
local werebeast_choice_raws=choice.interaction or choice.raws
raws.register_interactions(werebeast_choice_raws)
add_body_size(lines,math.max(rcp.min_size,80000+trandom(11)*1000),options)
lines[#lines+1]="[CREATURE_TILE:165]" --Ñ
options.forced_color={
f=6,
b=0,
br=1
}
options.custom_desc_func=function(options)
return custom_desc_str
end
build_procgen_creature(rcp,lines,options)
lines[#lines+1]="[GO_TO_START]"
-- remove second words like " beetle", etc from the end
local short_name = rcp.name_string:gsub("%s(%w+)$","")
local name_str="were"..short_name..":were"..short_name.."s:were"..short_name.."]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str
return {raws=lines,weight=1}
end
}}

===New forgotten beasts===
You can add new types of forgotten beasts (or more appropriately, {{token|FEATURE_BEAST}}s). These generate as alternatives when populating the caverns with unique monsters. There are a number of options to interact with shared generation functions.

Unbidden spirits only appear in dry cave layers, and like "spirit" [[demon]]s, are malevolent floating beings made of gas or dust.

{{Scriptdata
|title=Unbidden spirit
|script=
creatures.fb.unbidden=function(layer_type,tok)
if layer_type==0 then return nil end -- land only
local tbl={}
local options={
strong_attack_tweak=true,
always_make_uniform=true,
always_insubstantial=true,
intangible_flier=true,
spheres={CAVERNS=true},
is_evil=true,
sickness_name="beast sickness",
token=tok
}
tbl=split_to_lines(tbl,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[CASTE_NAME:unbidden spirit:unbidden spirit:unbidden spirit]
[NO_GENDER]
[CARNIVORE]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])
add_regular_tokens(tbl,options)
tbl[#tbl+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
if layer_type==0 then options.spheres.WATER=true end
options.spheres[pick_random(evil_spheres)]=true
options.do_water=layer_type==0
populate_sphere_info(tbl,options)
local rcp=get_random_creature_profile(options)
add_body_size(tbl,math.max(10000000,rcp.min_size),options)
tbl[#tbl+1]="[CREATURE_TILE:"..tile_string(rcp.tile).."]"
build_procgen_creature(rcp,tbl,options)
-- Weight is a float; all vanilla objects have weight 1
return {creature=tbl,weight=0.5}
end
}}
 
[[Construct creature|Elementals]] are defined by the material they're made of, using a table of options to set the right properties. In a dry chasm layer, they'll roll on the ``fb_elements`` table, while in a water layer, they'll be a water elemental. Should they ever carry a [[syndrome]], they would inflict [[Wikipedia:Dyscrasia|dyskrasia]].

The most important feature is setting ``options.sphere_rcm`` to a key in ``random_creature_materials``, so fire elementals are made of "FLAME" and earth elementals are made of "ANY_MINERAL".

{{Scriptdata
|title=Elemental
|script=
fb_elements = {
{
name="fire",
rcm="FLAME",
spheres={ FIRE=true },
options={ fire_immune=true }
},
{
name="earth",
rcm="ANY_MINERAL",
rcp_options={ always_flightless=true },
spheres={
EARTH=true,
MINERALS=true
}
},
{
name="air",
rcm="STEAM",
spheres={
WIND=true,
SKY=true
},
options={
always_insubstantial=true,
intangible_flier=true
}
}
}

creatures.fb.elemental=function(layer_type,tok)
local lines={}
local options={
strong_attack_tweak=true,
always_make_uniform=true, --irrelevant due to sphere_rcm
spheres={},
sickness_name="dyskrasia",
token=tok
}
lines=split_to_lines(lines,[[
[FEATURE_BEAST]
[ATTACK_TRIGGER:0:0:2]
[NO_GENDER]
[NO_EAT][NO_DRINK]
[DIFFICULTY:10]

[NATURAL_SKILL:WRESTLING:6]
[NATURAL_SKILL:BITE:6]
[NATURAL_SKILL:GRASP_STRIKE:6]
[NATURAL_SKILL:STANCE_STRIKE:6]
[NATURAL_SKILL:MELEE_COMBAT:6]
[NATURAL_SKILL:DODGING:6]
[NATURAL_SKILL:SITUATIONAL_AWARENESS:6]
[LARGE_PREDATOR]
]])

-- Create a water elemental in water layers, otherwise use another type
local water_elemental = {
name="water",
rcm="WATER",
spheres={WATER=true},
options={do_water=true}
}
local my_element = layer_type==1 and pick_random(fb_elements) or water_elemental

-- Assign propertes from chosen element
map_merge(options.spheres,my_element.spheres)
if my_element.options then map_merge(options,my_element.options) end

add_regular_tokens(lines,options)
lines[#lines+1]=layer_type==0 and "[BIOME:SUBTERRANEAN_WATER]" or "[BIOME:SUBTERRANEAN_CHASM]"
populate_sphere_info(lines,options)

-- Set custom material
options.sphere_rcm=my_element.rcm
-- Build body
local rcp=get_random_creature_profile(options)
-- Set more options on the RCP
if my_element.rcp_options then map_merge(rcp.options,my_element.rcp_options) end
add_body_size(lines,math.max(10000000,rcp.min_size),options)
lines[#lines+1]="[CREATURE_TILE:'E']"
build_procgen_creature(rcp,lines,options)

-- Generate name
local element_name = my_element.name or "glitchstuff"
local name_str = element_name.." elemental:"..element_name.." elemental:"..element_name.."-elemental]"
lines[#lines+1]="[GO_TO_START]"
lines[#lines+1]="[NAME:"..name_str
lines[#lines+1]="[CASTE_NAME:"..name_str

return {raws=lines,weight=1.5}
end
}}

===Tweaking creatures===


This function is run in ``build_body_from_rcp()`` right before tweaks are determined. If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.

{{Scriptdata
|title=btc1_tweaks.titan_worship
|script=
-- make all large creatures into powers
btc1_tweaks.titan_worship=function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
if options.body_size>=500000 then -- described as "very large", graphics size cutoff
options.can_learn=true -- for flavor text
lines[#lines+1]="[INTELLIGENT]"
lines[#lines+1]="[SUPERNATURAL]" -- knows secrets according to their spheres
lines[#lines+1]="[POWER]" -- impersonates deities
lines[#lines+1]="[SPREAD_EVIL_SPHERES_IF_RULER]"
end
end
}}

===Adamantine alloys===

You can add your own arbitrary generated objects, though as of right now there's no way to make settings for them. This allows for some ''truly'' wild stuff; here's a fun example: adamantine-metal alloys for every single non-special metal, giving you an average of the properties of them.

{{Scriptdata
|title=Adamantine alloys
|script=
preprocess.adamantine_alloys=function()
if not random_object_parameters.main_world_randoms then return end
local l=get_debug_logger(2)
local lines={}
local reaction_lines={}
local reaction_names={}
local adamantine=world.inorganic.inorganic.ADAMANTINE
if not adamantine then return end
local adamantine_color=world.descriptor.color[world.descriptor.color_pattern[adamantine.material.color_pattern.SOLID].color[1]]
local adamantine_modulus = 2500000 --mildly arbitrary, just below the theoretical limit
l("Starting")
local done_category=false
for k,v in ipairs(world.inorganic.inorganic) do
if not v.flags.SPECIAL and v.material.flags.IS_METAL then
l(v.token)
local token="GEN_ADAMANTINE_"..v.token
lines[#lines+1]="[INORGANIC:"..token.."]"
add_generated_info(lines)
lines[#lines+1]="[USE_MATERIAL_TEMPLATE:METAL_TEMPLATE]"
for kk,vv in pairs(v.material.adj) do
lines[#lines+1]="[STATE_ADJ:"..kk..":adamantine "..vv.."]" --"adamantine molten steel"? it's fine
end
for kk,vv in pairs(v.material.name) do
lines[#lines+1]="[STATE_NAME:"..kk..":adamantine "..vv.."]"
end
l(2)
local mat_values={}
-- Find the ratio for which you get closest to (but not below) 2000000 in the material's worst property
local worst=math.min(v.material.yield.IMPACT,v.material.fracture.SHEAR)
local wafers=1
local bars=1
if worst < 2000000 then
local ratio = (2000000-3*worst)/1000000
local best_diff=1
for i=1,10 do
local wafer_amt=i*ratio
if wafer_amt>1 and wafer_amt<20 and math.ceil(wafer_amt)-wafer_amt<best_diff then
best_diff=math.ceil(wafer_amt)-wafer_amt
wafers=math.ceil(wafer_amt)
bars=i
end
end
end
local avg_denom=1/(bars*3+wafers) -- Multiplication just a bit faster than division, we're rounding at the end anyway
local solid_cl=nil
for kk,vv in pairs(v.material.color_pattern) do
-- time to get silly
local this_color=world.descriptor.color[world.descriptor.color_pattern[vv].color[1]]
local wanted_color={
r=(this_color.r*bars*3+adamantine_color.r*wafers)*avg_denom,
g=(this_color.g*bars*3+adamantine_color.g*wafers)*avg_denom,
b=(this_color.b*bars*3+adamantine_color.b*wafers)*avg_denom,
}
local best_total_diff=1000000000
local best_clp=nil
for _,clp in ipairs(world.descriptor.color_pattern) do
if clp.pattern=="MONOTONE" then
local cl=world.descriptor.color[clp.color[1]]
local diff=math.abs(wanted_color.r-cl.r)+math.abs(wanted_color.b-cl.b)+math.abs(wanted_color.g-cl.g)
if diff<best_total_diff then
best_clp=clp
best_total_diff=diff
end
end
end
lines[#lines+1]="[STATE_COLOR:"..kk..":"..best_clp.token.."]"
if kk=="SOLID" then solid_cl=world.descriptor.color[best_clp.color[1]] end
end
local color_str=solid_cl.col_f..":0:"..solid_cl.col_br
l(color_str)
lines[#lines+1]="[DISPLAY_COLOR:"..color_str.."]"
lines[#lines+1]="[BUILD_COLOR:"..color_str.."]"
lines[#lines+1]="[ITEMS_METAL][ITEMS_HARD][ITEMS_SCALED][ITEMS_BARRED]"
lines[#lines+1]="[SPECIAL]"
if v.material.flags.ITEMS_DIGGER then
lines[#lines+1]="[ITEMS_DIGGER]"
end
local function new_value(str)
mat_values[str]=mat_values[str] or math.floor((adamantine.material[str]*wafers+v.material[str]*bars*3)*avg_denom+0.5)
l(str,mat_values[str])
return mat_values[str]
end
local function new_value_nested(str1,str2)
mat_values[str1..str2]=mat_values[str1..str2] or math.floor((adamantine.material[str1][str2]*wafers+v.material[str1][str2]*bars*3)/(bars*3+wafers)+0.5)
l(str1..str2,mat_values[str1..str2])
return mat_values[str1..str2]
end
if new_value_nested("fracture","SHEAR")>170000 or new_value_nested("yield","IMPACT")>245000 then
lines[#lines+1]="[ITEMS_WEAPON][ITEMS_AMMO]"
if new_value("solid_density")<10000 then
lines[#lines+1]="[ITEMS_WEAPON_RANGED][ITEMS_ARMOR]"
end
end
lines[#lines+1]="[MATERIAL_VALUE:"..new_value("base_value").."]"
lines[#lines+1]="[SPEC_HEAT:"..new_value("temp_spec_heat").."]"
lines[#lines+1]="[MELTING_POINT:"..new_value("temp_melting_point").."]"
lines[#lines+1]="[BOILING_POINT:"..new_value("temp_boiling_point").."]"
lines[#lines+1]="[SOLID_DENSITY:"..new_value("solid_density").."]"
lines[#lines+1]="[LIQUID_DENSITY:"..new_value("liquid_density").."]"
lines[#lines+1]="[MOLAR_MASS:"..new_value("molar_mass").."]" -- i don't think this is actually correct
for _,thing in ipairs({"yield","fracture"}) do
for force,_ in pairs(v.material[thing]) do
lines[#lines+1]="["..string.upper(force).."_"..string.upper(thing)..":"..new_value_nested(thing,force).."]"
end
end
for _,force in ipairs("IMPACT","COMPRESSIVE","TENSILE","TORSION","SHEAR","BENDING") do
local modulus = v.yield[force] / v.elasticity[force]
local average_modulus = (adamantine_modulus*wafers + modulus*bars*3)*avg_denom
local strain_at_yield = math.floor(new_value_nested("yield",force) / average_modulus + 0.5) -- usually zero, but can be 1 or 2 sometimes
lines[#lines+1]="["..string.upper(force).."_YIELD:"..new_value_nested("yield",force).."]"
lines[#lines+1]="["..string.upper(force).."_FRACTURE:"..new_value_nested("fracture",force).."]"
lines[#lines+1]="["..string.upper(force).."_STRAIN_AT_YIELD:"..strain_at_yield.."]"
end
lines[#lines+1]="[MAX_EDGE:"..new_value("max_edge").."]"
local reaction_token=token.."_MAKING"
reaction_lines[#reaction_lines+1]="[REACTION:"..reaction_token.."]"
add_generated_info(reaction_lines)
reaction_lines[#reaction_lines+1]="[NAME:make adamantine "..v.material.name.SOLID.." (use bars)]"
reaction_lines[#reaction_lines+1]="[BUILDING:SMELTER:NONE]"
reaction_lines[#reaction_lines+1]="[REAGENT:A:"..tostring(150*wafers)..":BAR:NO_SUBTYPE:METAL:ADAMANTINE]"
reaction_lines[#reaction_lines+1]="[REAGENT:B:"..tostring(150*bars)..":BAR:NO_SUBTYPE:METAL:"..v.token.."]"
reaction_lines[#reaction_lines+1]="[PRODUCT:100:"..tostring(bars+wafers)..":BAR:NO_SUBTYPE:METAL:"..token.."][PRODUCT_DIMENSION:150]"
reaction_lines[#reaction_lines+1]="[FORTRESS_MODE_ENABLED]"
reaction_lines[#reaction_lines+1]="[CATEGORY:ADAMANTINE_ALLOYS]"
if not done_category then
done_category=true
reaction_lines[#reaction_lines+1]="[CATEGORY_NAME:Adamantine alloys]"
reaction_lines[#reaction_lines+1]="[CATEGORY_DESCRIPTION:Debase adamantine with other metals to get extremely strong alloys.]"
reaction_lines[#reaction_lines+1]="[CATEGORY_KEY:CUSTOM_SHIFT_A]"
end
reaction_lines[#reaction_lines+1]="[FUEL]"
reaction_lines[#reaction_lines+1]="[SKILL:SMELT]"
end
end
local entity_lines={}
raws.register_inorganics(lines)
-- not used in vanilla right now, due to lack of instruments, but you CAN do this
raws.register_reactions(reaction_lines)
end}}

[[Category:Modding]]
[[Category:Modding Examples]]
[[Category:Lua|S]]

Advanced world generation

2025-10-17T18:25:34Z

DPhKraken: /* Number of Werebeast Curse Types */ Wereblob bug

{{migrated article}}
{{Quality|Superior}}
{{av}}
:''This article contains information on advanced world generation. For information on basic world generation, see [[World generation]].'' ''See [[World token]] to more easily find information by the names used in the world_gen.txt file, [[World rejection]] for information on solving problems related to worlds always being rejected, and [[Worldgen examples]] for example worlds.''

[[File:adv_worldgen_v50.png|thumb|400px|right|The advanced world generation screen. ''(Click to enlarge)'']]'''Advanced world generation''', also labeled as '''detailed mode''', allows substantially more detail-oriented options of customization than standard, basic world generation. This gives the player much more control over how their world is generated. To better understand this article, it is advised that one should read about [[World generation|'''basic world generation''']] first.

The advanced world generation screen is reached by clicking "Create new world" at the main menu, then clicking "Detailed mode". Once at that screen, clicking "Basic options" will return the user to the standard world generation screen.

== Parameter sets ==
There are multiple default sets of all the advanced world generation parameters hard-coded in ''Dwarf Fortress'', which will be overridden by the <tt>prefs/world_gen.txt</tt> file in the main ''Dwarf Fortress'' directory, if it exists. It does not exist by default, you must create it, either by saving the default sets, or saving a copy from the [[world_gen.txt]] wiki page or elsewhere. This file can then be edited with a text editor, and you can copy and paste other players' sets of parameters into it. For sources of such parameter sets see [[Advanced_world_generation#Parameter_set_examples|Parameter set examples]] below.

To get back the default sets, move the existing <tt>prefs/world_gen.txt</tt> to somewhere else (like Documents), or delete it if you do not want to keep the changes, then load the sets in the game, it will then use the hardcoded defaults.

== User interface ==
First, there is a line of text inputs and buttons along the top of the screen, from left to right:
* The drop down menu of currently defined parameter sets, click the down arrow to select a set that you want to work with. The currently selected set can be renamed by clicking the current name or the [[File:Quill.png]] button. The first set in the file is selected by default, usually "LARGE ISLAND". See [[#Parameter set title|Parameter set title]].
* The dimensions of the world for the selected set, see [[#World dimensions|World dimensions]].
* A text entry box to set all of the seed options to the same seed, will show "Random seed", "Various seeds", or, if all four seeds are set to use the same value, that value. See [[Advanced_world_generation#Seed_values|Seed values]] and [[Advanced_world_generation#Seed_values|Seed notes]].
* The Copy Button to make a copy of the currently selected set and appends it to the bottom of the list.
* The red Delete button to delete the currently selected set, you will be prompted to confirm the deletion.
* The New parameter set to create a new parameter set and appends it to the bottom of the list. This seems to just copy the default "LARGE REGION" set.
* The Save button to save all of the current sets to the <tt>prefs/world_gen.txt</tt> file.
* The Load button to load from the same file, there is no confirmation, '''any unsaved changes will be lost'''. If that file does not exist, this resets all of the sets to the defaults.

Most of the middle is the parameters themselves, with a scroll bar to the right. Each row of the list can include:
* The name of the option
* The range of accepted values; not every option has this, and does not always match the displayed value, for example "0 to 1" might show as "No" and "Yes".
:* Sometimes the range might not initially show on rows that it should, reloading the sets with the Load button sometimes fixes that.{{bug|13176}}
* A plus button to increase the value or cycle through options, when applicable (this button will be missing if the range is missing.)
* The current value; can be clicked to edit, to actually set a value you must press {{k|enter}}, without doing that, clicking another entry box or right clicking will instead reset to the currently set value.
* An edit button to show that the previous box is editable, same as clicking on the text box.
* A minus button to decrease the value or cycle through options, when applicable (this button will be missing if the range is missing).
* A red button to disable this parameter, when applicable, usually setting the value to 0, or -1.

{{notice bar|bgcolor=#faa|bordercolor=#f00|All of the buttons below leave this screen and do not prompt to save the sets, so unsaved changes may be lost.}}
At the bottom right are 3 or 4 more buttons:
* The Create world button to do just that using the currently selected set, '''unsaved changes are lost'''.
* The Basic options button to go back to the normal world generation screen, unsaved changes are not lost if you come directly back to Detailed mode.
* The [[Mods]] button to go to the mod selection screen, unsaved changes are not lost if you come directly back to Detailed mode. Only shown if mods are available.
* Back to main menu button to do just that, '''unsaved changes are lost'''.

=== World painter ===
:''Main article: [[World painter]]
The '''world painter''' tool is not in the current version of ''Dwarf Fortress''; it allowed you to paint features onto a map. '''However''', those maps can still be used when generating a world by pasting world painter parameter set maps created in old versions into the <tt>prefs/world_gen.txt</tt> file. [[Utilities#Perfect_World_DF|Perfect World DF]] is a utility that uses the same parameter functionality as the world painter to paint a map, and it also can work with the current version of ''Dwarf Fortress''.

== Generating a world ==
You can either use an already-defined parameter set, or you can edit them, though it is highly suggested to edit a copy of one of the defaults. Once you are happy with the parameters you should save the values you just edited before you click the Create world button. Information about each parameter is documented below.

The phases of the world generation process are (this order is not completely correct):
* Preparing elevation...
* Setting temperature...
* Running rivers...
* Forming lakes and minerals...
* Growing vegetation...
* Verifying terrain...
* Importing wildlife...
* Recounting legends...
* Placing civilizations...
* Making cave civilizations...
* Making cave pops...
* Placing other beasts...
* Placing megabeasts...
* Placing good/evil...
* Placing caves...
* Prehistory generation
* Finalizing civ mats...
* Finalizing art...
* Finalizing uniforms...
* Finalizing sites...

== Seed notes ==
The world generation process uses a PRNG (Pseudo Random Number Generator) algorithm. A PRNG will produce a sequence of numbers that "looks" random, even though the actual sequence of numbers will always be the same if the PRNG is started with the same seed value. Basically this means that if you run world generation with a certain seed value on your computer, and someone else runs world generation with the same seed value on their computer, the same sequence of random numbers will be generated on both computers. The practical impact of this is that someone else can generate exactly the same world that you generated by entering the same seed value that you used.

In the current version, the seed values for the world itself and the names seem to produce the same result, but you will get changes in events which will result in a very different world history.{{bug|6934}} Keep this in mind if you want to regenerate a particular world.

The way that a world is generated can also be affected by certain world tokens. Changing them causes that code to use more or fewer PRNG values, causing later uses to get different parts of the sequence. So, you cannot for example, change the minimum and maximum rainfall and get 'the same world but drier or wetter', instead, a different world is generated. That said, it would also seem that certain small changes to these world tokens can occasionally generate a very similar world, however, other tokens are more sensitive. For more information see the forum thread [http://www.bay12forums.com/smf/index.php?topic=112132.msg3404199#msg3404199 here].

The following are tokens which use the PRNG values in ways that changing them will likely cause broader changes:

* [DIM:X:X]
* [ELEVATION:X:X:X:X]
* [RAINFALL:X:X:X:X]
* [TEMPERATURE:X:X:X:X]
* [DRAINAGE:X:X:X:X]
* [VOLCANISM:X:X:X:X]
* [SAVAGERY:X:X:X:X]
* [ELEVATION_FREQUENCY:X:X:X:X:X:X]
* [RAIN_FREQUENCY:X:X:X:X:X:X]
* [DRAINAGE_FREQUENCY:X:X:X:X:X:X]
* [TEMPERATURE_FREQUENCY:X:X:X:X:X:X]
* [SAVAGERY_FREQUENCY:X:X:X:X:X:X]
* [VOLCANISM_FREQUENCY:X:X:X:X:X:X]
* [PARTIAL_OCEAN_EDGE_MIN:X]
* [COMPLETE_OCEAN_EDGE_MIN:X]
* [HAVE_BOTTOM_LAYER_1:X]
* [MINERAL_SCARCITY:X] {{cite talk/this|Mineral scarcity}}

Many other world parameters, such as end year and embark points, can, however, be changed without it having any effect on the geography of the world generated from the seed values.

Normally, you don't enter these seed values, the game comes up with values based on some other sort of pseudo-random information from things like the current date and time.

When generating a world, ''Dwarf Fortress'' records the seeds it used in [[gamelog.txt]].

== Advanced parameters ==
There are essentially 4 types of controls for the generation of the surface map;

'''Terrain parameters''': as described below, these 5 variables define the basic background world, how hot or cold it is, how much rainfall, how high the mountains are. The world automatically goes through the temperature range along the Y axis, although sometimes it will be hotter in the north, other times in the south, or cold at both. Minimum, maximum and X,Y variance can drastically alter the world.

'''Weighted meshes''': these are a way to fine-tune the amount of the 5 basic variables on the map. They can be used to set the specific distribution of different elevations or rainfall areas for example.

'''Feature parameters''': such as rivers, mountain peaks, volcanoes, and oceans, which can cause rejections if the terrain parameters don't allow enough suitable locations for the features to be placed.

'''Rejection parameters''': ''Dwarf Fortress'' uses a 'belt-and-braces' approach to world generation. The above controls allow you to shape the world, then the rejection parameters throw it out if it does not meet certain criteria. There are a number of rejection parameters for the number and degree of the 5 basic variables, for biome types, etc. If the world does not meet the requirements of any one rejection parameter the world is rejected and re-randomised. Also see [[World rejection]].

Leaving tokens out of a set in <tt>world_gen.txt</tt> will cause the game to use default values which are not adjusted for smaller world sizes, this may cause smaller worlds to always be rejected.

If you are experimenting with world design, there is also a [[Settings#Feature_toggles|game setting]] that will log the rejection reasons to ``[[map_rejection_log.txt]]``. With that information you can then either adjust the rejection parameters to allow those worlds, or the other parameters to prevent them from trying to generate. ''Dwarf Fortress'' will keep adding to the file, so you may want to trim or delete it occasionally.

The parameters are described below in the order that they appear in the list in the game, which is not necessarily the order they appear in <tt>world_gen.txt</tt>. See [[world token]] for an index that will help you look things up by token name. The tokens used in <tt>world_gen.txt</tt> are at the bottom of each of the following parameter descriptions.

=== Parameter set title ===
This sets the name of the parameter set itself, as used in the list of sets (this has nothing to do with the name of the generated world).
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITLE:<name>]</nowiki></tt>
| <tt><nowiki>[TITLE:MEDIUM ISLAND]</nowiki></tt>
| Required
|}

=== World dimensions ===
The size of the map for the current set can be changed by changing the Width and Height values at the top next to the set title. You will need to confirm this, since changing the dimensions of the world will change other parameters, because many of them have different defaults depending on the surface area available.

Larger maps usually take longer to generate and may reduce [[Frames per second|FPS]] in-game, though this is really a matter of larger worlds usually having more civilizations, sites, historical figures, and events; restricting the number of those can speed up the process. Non-square maps may result in crashes{{bug|2928}}.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[DIM:<width>:<height>]</nowiki></tt>
| <tt><nowiki>[DIM:257:257]</nowiki></tt>
| Valid values are 17, 33, 65, 129, and 257, other values will use one of those. Changing the size in the file without adjusting other parameters can cause many rejections.
|}

=== Seed values ===
Enables the use of, and specifies seed values for, different parts of the world generation process. Just entering a specific seed does not enable it, that must be done separately, although using the box at the top to set all the seeds to the same value does enable them all. Enabling a seed puts the token in using what ever is in the text box below. If you enable a seed, but do not enter a seed, the string "Seed text" will be used (<tt><nowiki>[SEED:Seed text]</nowiki></tt>). Trying to use a <tt><nowiki>]</nowiki></tt> in the string in the file will end the seed there, since it closes the token, any text after that will be ignored. Normally, just leave these set to Random, unless trying to reproduce the results of a previous world generation. See also the [[Advanced_world_generation#Seed_notes|seed notes section]] above.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SEED:<text>]</nowiki></tt>
| <tt><nowiki>[SEED:31337]</nowiki></tt>
| rowspan="4" |
For each of these not in the config file, a random seed will be used, and the first seed is not used to generate the others. The seeds used are output to [[gamelog.txt]] when world generation starts.
|-
| <tt><nowiki>[HISTORY_SEED:<text>]</nowiki></tt>
| <tt><nowiki>[HISTORY_SEED:31337]</nowiki></tt>
|-
| <tt><nowiki>[NAME_SEED:<text>]</nowiki></tt>
| <tt><nowiki>[NAME_SEED:31337]</nowiki></tt>
|-
| <tt><nowiki>[CREATURE_SEED:<text>]</nowiki></tt>
| <tt><nowiki>[CREATURE_SEED:31337]</nowiki></tt>
|}

=== World name ===
As previously mentioned, the title of the parameter set doesn't affect the name of the world. You can specify a particular name for your world, or leave the value blank for a random one. (The [[DFHack]] utility adds an option to rename the world using the in-game languages.)
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CUSTOM_NAME:<name>]</nowiki></tt>
| <tt><nowiki>[CUSTOM_NAME:Realm of Cheese Engravings]</nowiki></tt>
| For a random name, simply don't use this token.
|}

=== Embark Points ===
The number of points for equipment and animals when embarking in fortress mode (there is no equivalent setting for adventure mode). Normally, the default of 1504 is fine, but can be increased for various purposes like experimentation or to help dwarves survive in a particularly evil world, or reduced for certain [[challenges]].
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EMBARK_POINTS:<number>]</nowiki></tt>
| <tt><nowiki>[EMBARK_POINTS:1504]</nowiki></tt>
| 0 to 10,000
|}

=== End year ===
The maximum number of years generated for the world, although generation can be paused and the world used as is any time after the second year; the same as the [[World_generation#History|History]] parameter in basic world gen, except that you can enter an exact value. A too-short history can limit the materials available to civilizations, and [[Chosen|certain adventure mode features]] are only available after certain site events, while too long a history often leads to civilizations dying.

For more information on the history aspect of the game, see [[Legends]] and [[Calendar#Ages|Ages]].
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[END_YEAR:<number>]</nowiki></tt>
| <tt><nowiki>[END_YEAR:250]</nowiki></tt>
| 2 to 10,000
|}

=== Population cap after civ creation ===
A soft limit to the total number of [[historical figure]]s alive at the same time during generation across all civilizations, only preventing the birth of new historical figures.{{cite forum|140544/5701667}} Each civilization is allotted a percentage of the total by the percentage of sites they control.{{cite forum|159164/7553641}} Civilizations also have non-historical populations, and there is no setting to limit those (in early versions, all civilization members were historical figures, this is also why the name of this setting is misleading). Each [[entity]] also has limits from their raws, see the [[Entity_token#Population|population]] entity tokens, and setting this to unlimited will not remove those.

Huge historical figure populations can slow generation and the game in general.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TOTAL_CIV_POPULATION:<number>]</nowiki></tt>
| <tt><nowiki>[TOTAL_CIV_POPULATION:15000]</nowiki></tt>
| -1 to 100,000, -1 is no limit
|}

=== Site cap after civ creation ===
Total number of [[site]]s that can be directly created by all civilizations combined like [[hillocks]], [[hamlet]]s, [[dark pits]], [[forest retreat]]s, etc. Does not prevent the placement of initial civilization sites, though they will then be counted for the limit. Does not affect creature sites like [[cave]]s or [[lair]]s, group sites like [[castle]]s, [[monastery|monasteries]], [[tower]]s, [[fort]]s, or [[camp]]s, or unpopulated sites like [[tomb]]s. After this limit is reached, no civilization will be able to place new sites. See the [[Entity_token#Placement|placement]] entity tokens for other ways that civilization site placement can be limited.

Increasing this will slow generation down and reduce the available places for player sites. Since the {{token|MAX_SITE_POP_NUMBER|entity}} entity token limits the historical figure population per site, this site cap can also limit the total historical figure population of all civilizations combined, and some expand faster than others getting more sites before the limit is reached.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SITE_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[SITE_CAP:1500]</nowiki></tt>
| -1 to 100,000, -1 is no limit
|}

=== Beast control ===

These parameters don't usually matter too much, but may matter for small numbers of beasts.

==== Percentage of Megabeasts and Titans Dead for Stoppage ====

The world starts out with a certain number of powerful megabeast and titan entities in existence. If a percentage of the megabeast and titan population dies out during history generation, then history generation will stop early. For example, if the elimination value is 80%, and the generated history starts with 200 entities and 160 of those 200 entities are eliminated by historical events before the End Year is reached, history generation will stop immediately.

If you want to end the creation of your world at the beginning of a certain age, choose the following values:
* Age of Legends: ~34%
* Age of Heroes: ~67%
If there are three or fewer titans or megabeasts in your world, the age will be given a special name reflecting the remaining megabeasts/titans, instead.

==== Year to Begin Checking Megabeast Percentage ====

The percentage of dead [[megabeast]]s and [[titan]]s for stoppage will not be checked until this year is reached in history generation. This can be used to ensure that a world reaches a certain year even if all of the megabeasts in the world are slain earlier.

If the number of living [[megabeast]]s and [[titan]]s starts at or drops to less than four, then world generation will always stop if the current year is equal to or greater than the Year to Begin Checking Megabeast Percentage ''regardless'' of how many [[megabeast]]s and [[titan]]s are dead — Percentage of Megabeasts and Titans Dead for Stoppage is ignored. The number of megabeasts and titans at the start of the world is set by the sum of the [[Advanced_world_generation#Max_Megabeasts_Caves|Max Megabeasts Caves]] and [[Advanced_world_generation#Titan_Parameters|Titan Number]] parameters.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[BEAST_END_YEAR:<year>:<percentage or -1>]</nowiki></tt>
| <tt><nowiki>[BEAST_END_YEAR:200:80]</nowiki></tt>
| Use -1 as percentage to disable. Year must still be at least 2.
|}

=== Cull Unimportant Historical Figures ===

Whether or not the game will ignore unimportant figures in history generation. The culling of unimportant historical figures is a CPU-intensive step in history generation but it saves memory and will speed up loading/saving games in fortress mode. This does mean that the "unimportant" figures will not appear in Legends mode or in engravings, but unimportant figures would likely not appear in engravings anyway.

Unimportant figures are creatures who suffer early deaths, never have offspring or kill a named creature during world gen. For example, a resident of a goblin tower may get murdered by demons at a young age. After culling unimportant figures, Legends mode would say "In the year 102, the demon Evil McEvilface killed an unknown creature at Eviltower."

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CULL_HISTORICAL_FIGURES:<0 or 1>]</nowiki></tt>
| <tt><nowiki>[CULL_HISTORICAL_FIGURES:0]</nowiki></tt>
| 0 = No, 1 = Yes
|}

=== Reveal All Historical Events ===

Setting this to Yes will allow access to most information about the history of the world in [[Legends mode]]. All events will be revealed, but some [[historical figure]]s, [[site]]s, [[region]]s, and [[civilization]]s and other entities may not be, possibly because they are not known to any civilization. If set to No, then you will have to discover historical information in [[adventure mode]] or by instructing dwarves to make engravings.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[REVEAL_ALL_HISTORY:<0 or 1>]</nowiki></tt>
| <tt><nowiki>[REVEAL_ALL_HISTORY::1]</nowiki></tt>
| 0 = No, 1 = Yes
|}

=== Terrain Parameters ===

These set limits and variance for terrain elevation, rainfall, temperature, drainage, volcanism, and savagery which determines how those values are generated. What biomes exist are then determined by how these factors overlap with each other.

==== Minima and Maxima ====
These are the absolute minimum and maximum values that can ever be generated for a particular map square characteristic. By ''subtly'' tweaking the min and max values, vastly different maps can be made. Changing these can cause the occurrence of certain [[Biome|biomes]] to become impossible, so you may want to use [[#Terrain Mesh Sizes and Weights|Weighted Ranges]] instead.

==== X and Y Variance ====
These control how wildly things like elevation and rainfall can vary between adjacent map squares. For example, if these values are set to the maximum of 3,200 for elevation then you will end up with more very low areas right next to very high areas. The number for X determines the east-west variance and the number for Y determines the north-south variance. By setting only one of these to a high value you can, for example, create horizontal or vertical bands of areas which are more similar to each other.

Generally speaking, raising both of these values will create a more random "patchwork" of many small biomes while setting both x and y values to 0 will cause every square on the map to use a single random value for the given characteristic.

For "patchwork" worlds to avoid being rejected, [[#Maximum Number of Subregions|Maximum Number of Subregions]] will probably need to be increased from the default.

==== Elevation ====
This controls the range of terrain elevations that can occur in the world. Usually, you just want to leave the min/max values alone. Raising the minimum elevation can, for example, make it impossible for oceans to exist. This does '''not''' directly control the number of available Z-levels at a particular site, though high maximum values may contribute to peaks, which can raise the number of above ground Z-levels - in other words, a maximum elevation of 400 and minimum of 1 does not mean you get 400 Z-levels, but it might increase the number of Z-levels somewhat in some regions compared to others. Raising the variance will result in a more bumpy, uneven landscape.

Some biomes/features that are impacted by elevation:
* A high minimum (above 99) means no oceans, as they need elevations below 100.
* A low maximum (below 300) means no mountains, as mountains need elevations above 300.
* Rivers will be placed when the elevation maximum is 104 or higher. Therefore, keeping both values above 100 and below 104 will prevent all water tiles from appearing.
* Mountain peaks can only form at elevations of 400.

==== Rainfall ====
Controls the amount of rainfall in each map square/area. Setting the minimum or maximum too high or low can make the formation of certain biomes impossible. Rainfall causes it to [[rain]] more in a given area, which can have various effects. Also makes more rivers appear on the world map.

Note that if [[#Do Orographic Precipitation and Rain Shadows|orographic precipitation and rain shadows]] is on, then mountains will cause additional variance in rainfall, so (for example) rainfall below the specified minimum can occur in the shadow of a mountain. If you want the minimum and maximum for this parameter to be absolutely respected, you must turn off the orographic precipitation option.

Additionally, with 'Orthographic Precipitation' turned on, orthographic precipitation and rain shadows will only occur in regions with greater than or equal to 50 drainage. [http://www.bay12forums.com/smf/index.php?topic=139916.0 [Report, reproduced 2022]]

==== Temperature ====
{{main|Climate|Temperature}}
These parameters control how hot or cold various areas will be. If you lower the minimum and maximum values, the world will be colder overall, for example. As with the others, changing these values too much could make it impossible for certain biomes to exist. The temperature scale used in this setting is related to regular degrees Urist by the equation "local temp = world temp * 0.75 + 10000".{{cite forum|169696/8395484}} This scale doesn't seem to be used anywhere else in the game. See [[Climate]] for more info.

These parameters form the "base" temperature for an area, and describe peak summer temperature in a scale that isn't used elsewhere in the game. This number also does not correspond 1:1 with the final climate. [[Temperature]] is always influenced by a number of variables, including elevation, time of year, thick forestation, and if [[Advanced_world_generation#Poles|poles]] are enabled, latitude. These other variables are factored in after the temperature mesh is applied, and frequently bring temperatures above and below their set minimum and maximum values. ''The inclusion of Poles is particularly strong in this regard, as it allows latitude to raise and/or lower temperatures by more than 75 degrees Celsius! That said, the temperatures aren't raised or lowered by more than about 65 degrees past the set minimum and maximum. Furthermore, for typical ranges, the temperature will never be raised more than about 25 degrees past the maximum (but will still drop up to about 65 degrees Celsius below the minimum).'' (unsure about exact values, research needed)

Elves can spawn where the temperature is 10 degrees or warmer, and humans can spawn where the temperature is 0 degrees or warmer.

==== Drainage ====
Changing drainage parameters will change the way water-affected biomes are formed. Low drainage will contribute to the formation of [[Lake|lakes]], [[River|rivers]], and [[Swamp|swamps]]. High drainage will cause water to sink into the ground rather than sit on the surface, which is important for forming hills.

Lower drainage values have been reported to contribute to the formation of thicker soil layers, though it is currently unknown exactly how other factors (such as elevation or perhaps rain) impact soil formation.

==== Volcanism ====
Volcanism controls the occurrence of igneous [[layer]]s, and the formation of volcanoes. For a volcano to form, a square must have a volcanism value of 100, so reducing the maximum from 100 will make volcanoes impossible. Raising the minimum will increase the rarity of non-igneous layers.

Setting the minimum to a high value is not a good way to produce multiple volcanoes, as you are likely to get a "Volcanism not evenly distributed" rejection. Instead, use the Minimum Number of Volcanoes parameter, and possibly adjust the weighted ranges for volcanism as described below.

==== Savagery ====
These parameters control the level of [[Surroundings#Savage|savagery]] on the map. Raising the minimum savagery too high may make it impossible for certain races to exist, and similarly lowering the maximum too far can make it impossible for certain creatures to exist. The largest chance of having unusable maps comes from a too-high savagery value.

==== Configuration Tokens ====
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[ELEVATION:1:400:401:401]</nowiki></tt>
| Range: 0 to 400 Maximum of 400 required for mountain peaks. Variance range: 0-3200
|-
| <tt><nowiki>[RAINFALL:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[RAINFALL:0:100:200:200]</nowiki></tt>
| Range: 0 to 100 Variance range: 0-3200
|-
| <tt><nowiki>[TEMPERATURE:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[TEMPERATURE:25:75:200:200]</nowiki></tt>
| Range: -1000 to 1000 Variance range: 0-3200
|-
| <tt><nowiki>[DRAINAGE:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE:0:100:200:200]</nowiki></tt>
| Range: 0 to 100 Variance range: 0-3200
|-
| <tt><nowiki>[VOLCANISM:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM:1:100:200:200]</nowiki></tt>
| Range: 0 to 100 Maximum of 100 required for volcanoes. Variance range: 0-3200
|-
| <tt><nowiki>[SAVAGERY:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY:1:100:200:200]</nowiki></tt>
| Range: 0 to 100 Variance range: 0-3200
|}

=== Terrain Mesh Sizes and Weights ===

These parameters make it possible to influence the number of squares in a particular range, without making conditions outside of that range impossible. For example, you can make it possible for many more low-elevation squares to exist without making it impossible for high elevations to form. Changing these parameters is often preferable to simply changing the min/max values.

The basic steps of applying weighted ranges are as follows:

# Create a grid with 2''MeshSize'' - 1 tiles in both X and Y direction.
# At each grid intersection, set the value according to the weighted ranges.
# Smooth out the area between the intersection points.
# Add noise according to the variance parameters.

where ''MeshSize'' is the raw parameter value found in the world_gen.txt. See the image on the right for an example.

[[File:World_map-large-32x32-elevation-mesh.png|thumb|300px|A large world generated with an Elevation Mesh Size of 32×32 and range weights set to 1:0:0:0:1 (i.e., only extreme high and low elevations). Note how the grid intersections are either set very high or very low and the space between them is smoothed out.]]

==== Mesh Size/Weighted Ranges ====

Mesh size determines how many grid tiles there will be. Setting this to Ignore will cause the weighted range settings to be ignored for that terrain characteristic. As an example, setting it to 2×2 means the grid will be 2 times 2 tiles large and there will be 3×3 for a total of 9 intersection points. On a pocket world, this means one grid tile will be 8×8 world tiles large, whereas on a large world, one grid tile will be 128×128 world tiles. Note that the highest possible value for a given world size will always make the grid tiles 8×8 world tiles large.

If mesh size is set to something other than Ignore, these weights will be applied at the granularity of the selected mesh size for purposes of generating random values in each range. This allows random number generation to be non-linear for the given terrain characteristic.

For example, if the Elevation Weighted Range parameters were set to (starting with the 0-20 range) 60:10:10:10:10 (these values do not have to add up to any particular number) and elevation min and max are set to 1 and 400 respectively then about 60% of the grid line intersection points (on average) will be set to an elevation in the range of 1-80 (0% to 20%), and the other ranges will be represented by around 10% of the intersection points each. The exact distribution is still left up to chance though ''on average'' it will be close to this specification.

Weighted ranges do not make rejection checks, although they can be responsible for many rejections if you neglect to adjust or disable some of the [[#Minimum Number of Mid/Low/High Characteristic Squares|Minimum Number of Mid/Low/High Characteristic Squares]] for example.

==== Interaction between Mesh Size and Variance ====

The end result can vary greatly depending on how the corresponding [[#X_and_Y_Variance|X and Y Variance]] parameters are set. First of all, if the variance is too large the noise it adds can completely negate the effect of the weighted ranges. For instance, with a 2×2 mesh, the default variance parameters are high enough that usually the mesh grid can hardly be recognized. How strong the variance's effect is, is also dependent on the mesh size. Having a larger mesh size (i.e. smaller grid tiles) means the variance also has to be higher for a visible effect. For instance, with a variance of 400, the effects are clearly visible with a 2×2 mesh and barely visible at all with a 8×8 mesh. Note that this effect is directly dependent on the mesh size and not, as one might expect, on the actual size of the grid tiles. This means, that a large world with a 32×32 mesh will look essentially the same as a pocket world with a 2×2 mesh, only stretched to 256 times the size.

Also see this [http://www.bay12forums.com/smf/index.php?topic=139916.0 forum post] for more details.

==== Configuration Tokens ====

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[ELEVATION_FREQUENCY:2:1:2:3:4:5]</nowiki></tt>
| rowspan="6" | Valid mesh values:

1 = Ignore

2 = 2x2

3 = 4x4

4 = 8x8

5 = 16x16

6 = 32x32

(limited by world size)
|-
| <tt><nowiki>[RAIN_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[RAIN_FREQUENCY:3:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[DRAINAGE_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE_FREQUENCY:4:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[TEMPERATURE_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[TEMPERATURE_FREQUENCY:1:1:1:1:1:1]</nowiki></tt>
|-
| <tt><nowiki>[SAVAGERY_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY_FREQUENCY:5:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[VOLCANISM_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM_FREQUENCY:1:1:1:1:1:1]</nowiki></tt>
|}

=== Poles ===

With this, you can influence how polar regions are added. The poles can be on the north or south edge, and the equator will be on the opposite edge, or in the middle if there are two poles. If poles are set to NONE, then there will be no seasonal changes in the weather (e.g. no winter snow in temperate biomes).

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[POLE:<placement>]</nowiki></tt>
| <tt><nowiki>[POLE:NORTH]</nowiki></tt>
| Viable options: NONE, NORTH_OR_SOUTH, NORTH_AND_OR_SOUTH, NORTH, SOUTH, NORTH_AND_SOUTH
|}

=== Minimum Mountain Peak Number ===

This will cause the world to be rejected if fewer than this many peaks (based on elevation) are present on the map. EG: elevations of 400 must be possible for mountain peaks to occur. If set to zero, then worlds will not be rejected based on number of peaks.

You may need to adjust elevation parameters, such as the highest weighted range, in order to get the desired number of elevation-400 squares needed for larger numbers of peaks. Like volcanoes, mountain peaks can make embark zones more interesting, but other than that, they don't appear to "do" anything special. Reportedly, they do increase the highest Z-level above ground in all embark zones in the same region, even if the selected embark zone does not include the peak.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PEAK_NUMBER_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[PEAK_NUMBER_MIN:20]</nowiki></tt>
| Elevations of 400 must occur for peaks to form.
|}

=== Minimum Partial Edge Oceans ===

This will cause a world to be rejected unless there are at least this many oceans touching an edge of the map. If set to zero then worlds will not be rejected based on this criterion. Setting both this parameter and Minimum Complete Edge Oceans to values that total more than 4 when added together may cause all worlds to be rejected as you can't have both a partial and complete edge ocean on a given edge.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PARTIAL_OCEAN_EDGE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[PARTIAL_OCEAN_EDGE_MIN:2]</nowiki></tt>
| Maximum of 4
|}

=== Minimum Complete Edge Oceans ===

This will cause a world to be rejected unless there are at least this many oceans which completely cover an edge of the map. Since a square map only has 4 edges, the maximum value possible is 4. If set to zero then worlds will not be rejected based on this criterion but still might end up with complete edge oceans by chance.

Note that the ability for this many edge oceans to exist will be limited by elevation. Therefore, to actually create large oceans you will probably need to change things like the Elevation Mesh Size and Weighted Ranges to increase the number and distribution of very low elevation squares on the map. In addition, if Complete Edge Oceans is set to any value ''other'' than 0 or 4, you may need to lower elevation variance for at least one of the axes: if set too high, such as a variation of 1600 for both X and Y axes (the default for Large Island and Medium Island parameter sets), the game may generate worlds very slowly or even hang.{{bug|565}}

Given appropriate weight, range, and variance values for things like elevation, a setting of: 1 results in a world that seems like a chunk of coastline. One edge of the map will be completely underwater and there will be ocean taking up much of the map on that side (think the east or west coast of the United States, the north coast of Canada, or southern Europe). If your edge ocean happens to pick your world's frozen side, most of it will be glacier.

*2 results in another coastline along with the first one -- the map could end up looking something like Panama if the oceans pick opposite sides of the map.
*3 results in a peninsula, like Florida in the US. There will be oceans surrounding 3 sides of the map, and land touching only one side of the map.
*4 results in one or more island(s) depending on things like elevation variance and weights. Regardless of whether you get one island or multiple islands, the entire map will be surrounded by water.

Unfortunately, there's no easy way to control which oceans end up on which edges, except perhaps setting X/Y variance to different values.

Edge oceans will take up part of the other edges too. For example, a full edge ocean on the east side will have part of the north and south sides underwater, but that does ''not'' add to the ''partial'' edge oceans count.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[COMPLETE_OCEAN_EDGE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[COMPLETE_OCEAN_EDGE_MIN:0]</nowiki></tt>
| Maximum of 4
|}

=== Minimum Volcano Number ===

Worlds with less than this number of volcanoes will be rejected. Note that this will not just create this many volcanoes at random; there must be at least this many squares with a Volcanism of 100. Therefore, adjusting Weighted Range for 80-100 to some higher value is recommended if you want to facilitate a large number of volcanoes. In addition, Maximum Volcanism must be set to 100 or squares with volcanism of 100 will be impossible, making volcanoes impossible.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[VOLCANO_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[VOLCANO_MIN:15]</nowiki></tt>
| Volcanoes require a volcanism of 100 to occur.
|}

=== Mineral Scarcity ===
Controls the frequency at which minerals occur; setting this value higher will decrease both the number of different types and amounts of ore and gems present on a map. The default value will result in many metal ores, while the old default of ''sparse'' would be only a few ores, which may be limiting until other metals can be requested and traded for.

The options "Very Rare", "Rare", "Sparse", "Frequent", and "Everywhere" in the [[World_generation#Basic_world_generation_menu|basic world generation menu]] use the values 50000, 10000, 2500, 500 and 100 respectively.

According to [http://www.bay12forums.com/smf/index.php?topic=79018.msg2063804#msg2063804 research] by Shandra in v0.31.25, this is the relationship between the value of this setting and the approximate number of gems and ore:

[[File:MineralSetting_v25_limit10k.png]]

This is for the same 8x8 embark region in a world which is otherwise the same, except for the mineral scarcity parameter (although most of the detailed information comes from experiments with previous versions). (The chart legend has an error, the first "Pot.(Types)" should read "Pot.(Amount)".)
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MINERAL_SCARCITY:<number>]</nowiki></tt>
| <tt><nowiki>[MINERAL_SCARCITY:100]</nowiki></tt>
| Range: 100 to 100,000
|}

=== Max Megabeast Caves ===

This is the number of [[megabeast]]s placed at the beginning of history. Megabeasts are [[hydra]]s, [[bronze colossus]]es, [[roc]]s, and [[dragon]]s, which are all placed in equal proportions [http://www.bay12forums.com/smf/index.php?topic=112465.msg3415177#msg3415177 data].

Increasing this value can lead to early extinction of civilizations.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MEGABEAST_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[MEGABEAST_CAP:75]</nowiki></tt>
| Megabeasts count towards BEAST_END_YEAR calculation.
|}

=== Max Semi-Megabeast Caves ===

This is the number of [[semi-megabeast]]s placed at the beginning of history. Semimegabeasts are [[giant]]s, [[ettin]]s, [[minotaur]]s, and [[cyclops]], which are placed in equal proportions [http://www.bay12forums.com/smf/index.php?topic=112465.msg3415188#msg3415188 data].

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SEMIMEGABEAST_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[SEMIMEGABEAST_CAP:150]</nowiki></tt>
| Semimegabeasts do not count towards the BEAST_END_YEAR calculation.
|}

=== Titan Parameters ===

==== Number ====

This controls the number of [[titan]]s that exist at the beginning of history[http://www.bay12forums.com/smf/index.php?topic=112465.msg3415203#msg3415203 data]. The number of forgotten beasts is unaffected by this parameter [http://www.bay12forums.com/smf/index.php?topic=112465.msg3415155#msg3415155 data].

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITAN_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[TITAN_NUMBER:33]</nowiki></tt>
| Titans count towards BEAST_END_YEAR calculation.
|}

==== Attack Population Requirement ====

[[Titan]]s will begin to attack your fort once at least this many dwarves inhabit it, regardless of whether any other attack criteria have been met.

This number defaults to 80, which isn't usually too difficult to deal with.

==== Exported Wealth Requirement ====

Titans will begin to attack your fort once you have exported at least this many [[Currency|dwarfbucks]]-worth of goods, regardless of whether or not any other criteria have been met. This parameter defaults to None (disabled).

==== Created Wealth Requirement ====

Titans will begin to attack your fort once the fort's total wealth has reached this many [[Currency|dwarfbucks]] in value. This happens regardless of whether any of the other criteria, such as population, have been met; therefore, even with 1 dwarf, a fort could be attacked if the fort were worth at least this value.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITAN_ATTACK_TRIGGER:<population>:<exp wealth>:<created wealth>]</nowiki></tt>
| <tt><nowiki>[TITAN_ATTACK_TRIGGER:80:0:100000]</nowiki></tt>
| 0 = None (disabled). Only one requirement must be met for an attack.
|}

=== Number of Demon Types ===

[[Demon]]s are similar to [[titan]]s and [[forgotten beast]]s, in that they are procedurally generated, but most are not unique. Thus, many different types of demons can exist in the world, but there will also be many individuals of most types. Thanks to [[Underworld spire|certain fun things]], fewer demon types also means fewer goblin civilizations[http://www.bay12forums.com/smf/index.php?PHPSESSID=7348f68f41a9659443c05b2acf534e6c&topic=112465.15]. You need at least 2 demon types, or else goblin civilizations won't exist initially, though if dwarves breach the underworld during world generation, at least one will be generated then.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[DEMON_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[DEMON_NUMBER:52]</nowiki></tt>
| 0 to 1000
|}

=== Number of Night Troll Types ===

The number of different [[night troll]]s, also procedurally generated, that will exist in the world. Setting this to zero means that the world will have no night trolls, custom or otherwise.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[NIGHT_TROLL_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[NIGHT_TROLL_NUMBER:77]</nowiki></tt>
| 0 to 1000
|}

=== Number of Bogeyman Types ===
The number of different [[bogeyman]] forms that will exist in the world. Bogeymen are procedurally generated, though their forms do not vary by much. Setting this to zero means that the world will have no bogeymen, custom or otherwise.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[BOGEYMAN_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[BOGEYMAN_NUMBER:27]</nowiki></tt>
| 0 to 1000
|}

=== Number of Nightmare Types ===
The number of different [[nightmare]] forms that will exist in the world. Nightmares are procedurally generated. Setting this to zero means that the world will have no nightmares, custom or otherwise.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[NIGHTMARE_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[NIGHTMARE_NUMBER:27]</nowiki></tt>
| 0 to 1000
|}

=== Number of Vampire Curse Types ===

The number of different types of [[Vampire|vampires]] that will exist in the world. Although they are generated at the start of a new world, they aren't different from each other. Setting this to zero means no vampires will exist.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[VAMPIRE_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[VAMPIRE_NUMBER:72]</nowiki></tt>
| 0 to 1000
|}

=== Werebeast Parameters ===

==== Number of Werebeast Curse Types====

The number of different types of [[werebeast]]s that can exist in the world. It is common for werebeasts, unlike vampires, to assume many different forms and variations, the most well-known of these amount to different species of animals, from lizards, to wolves, to even bears. Setting this to zero means no werebeasts will exist, and will also remove a large amount of [[fun]] from the game.

In vanilla, there are only 82 possible unique werebeast species. Any further species will generate as wereblobs.{{bug|13308}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[WEREBEAST_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[WEREBEAST_NUMBER:58]</nowiki></tt>
| 0 to 1000
|}

==== Attack Population Requirement ====

Werebeasts will begin to attack your fort once at least this many dwarves inhabit it, regardless of whether any other attack criteria have been met. This number defaults to 50 which will often be reached in the second year of the fort.

==== Exported Wealth Requirement ====
Werebeasts will begin to attack your fort once you have exported at least this many [[Currency|dwarfbucks]]-worth of goods, regardless of whether or not any other criteria have been met. This parameter defaults to 5000.

==== Created Wealth Requirement ====

Werebeasts will begin to attack your fort once the fort's total wealth has reached this many [[Currency|dwarfbucks]] in value. This happens regardless of whether any of the other criteria, such as population, have been met; therefore, even with 1 dwarf, a fort could be attacked if the fort were worth at least this value.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[WEREBEAST_ATTACK_TRIGGER:<population>:<exp wealth>:<created wealth>]</nowiki></tt>
| <tt><nowiki>[WEREBEAST_ATTACK_TRIGGER:50:5000:50000]</nowiki></tt>
| 0 = None (disabled). Only one requirement must be met for an attack.
|}

=== Number of Secret Types ===

The number of secrets that exist in the world. Currently, all secrets are secrets of life and death, and the ones holding these secrets are [[necromancer]]s, thus, setting this to zero means that no necromancers will appear.
Non-necromancer towers can still appear (extremely rarely) with zero secrets, constructed by independent undead groups.
The primary difference between having 1 or 1000 secrets is the chance of your world having any necromancer towers at all. With 1, this chance is low. With the default number, it's seemingly guaranteed.
Even with 1 secret, if you have any necromancer towers at all, it is likely a great number will quickly appear in world generation (though this isn't guaranteed).

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SECRET_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[SECRET_NUMBER:52]</nowiki></tt>
| 0 to 1000
|}

=== Number of Regional Interaction Types ===

The number of interactions that can be caused in regions, which may incorporate evil rain and cloud types. Currently, only evil region interactions are generated this way.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[REGIONAL_INTERACTION_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[REGIONAL_INTERACTION_NUMBER:20]</nowiki></tt>
| 0 to 1000
|}

=== Number of Disturbance Interaction Types ===
The number of different [[Mummy|disturbed dead]] that can exist in the world. Setting this to zero should prevent any mummy from appearing{{verify}}, but it will not prevent the creation of [[tomb]]s.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[DISTURBANCE_INTERACTION_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[DISTURBANCE_INTERACTION_NUMBER:10]</nowiki></tt>
| 0 to 1000
|}

=== Number of Evil Cloud / Evil Rain Types ===

This number specifies how many [[Weather#Evil weather|various face-melting, eye-boiling, and zombifyingly-fun]] clouds of pure evil may appear in your world. Setting this to zero means you no longer will ever have to deal with encroaching dust walls of doom in that world. It is generally advised to keep this value low...

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EVIL_CLOUD_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[EVIL_CLOUD_NUMBER:45]</nowiki></tt>
| 0 to 1000
|}

The latter number states how many different types of green-ooze drenchers, disconcerting blood-showers, and sickly yellow slime-baths can occur in your world. Compared to evil clouds though, this one hardly is worth stressing out about, usually.... Setting this to zero means the only semi-solid to fully-liquid fluids to fall from the sky will be pure H2O.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EVIL_RAIN_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[EVIL_RAIN_NUMBER:352]</nowiki></tt>
| 0 to 1000
|}

=== Generate Divine Materials ===
This turns the generation of [[Divine_metal|divine metals]] on or off. It does not influence the creation of [[vault]]s. Probably determines whenever or not using divination dice spawns weapons.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[GENERATE_DIVINE_MATERIALS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[GENERATE_DIVINE_MATERIALS:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Generate Mythical Materials ===

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[GENERATE_MYTHICAL_MATERIALS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[GENERATE_MYTHICAL_MATERIALS:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Allow Mythical Healing ===

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ALLOW_MYTHICAL_HEALING:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_MYTHICAL_HEALING:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Allow Divination, Experiments, and Necromancy types ===
These allow or disallow [[die|divination]], demon or necromancer [[experiment]]s, and the more advanced [[necromancer]] abilities.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ALLOW_DIVINATION:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_DIVINATION:1]</nowiki></tt>
| 1/0 = Yes/No
|-
| <tt><nowiki>[ALLOW_DEMONIC_EXPERIMENTS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_DEMONIC_EXPERIMENTS:1]</nowiki></tt>
| 1/0 = Yes/No
|-
| <tt><nowiki>[ALLOW_NECROMANCER_EXPERIMENTS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_NECROMANCER_EXPERIMENTS:1]</nowiki></tt>
| 1/0 = Yes/No
|-
| <tt><nowiki>[ALLOW_NECROMANCER_LIEUTENANTS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_NECROMANCER_LIEUTENANTS:1]</nowiki></tt>
| 1/0 = Yes/No
|-
| <tt><nowiki>[ALLOW_NECROMANCER_GHOULS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_NECROMANCER_GHOULS:1]</nowiki></tt>
| 1/0 = Yes/No
|-
| <tt><nowiki>[ALLOW_NECROMANCER_SUMMONS:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALLOW_NECROMANCER_SUMMONS:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Desired Good/Evil Square Counts ===

These values change the amount of [[Surroundings#Good|good or evil]] tiles on the map, depending on the size of the region they are being considered for. The counts are for all tiles in all subregions of a given size considered together, ''not'' counts for each subregion considered separately (all tiles in the same subregion share the same [[surroundings]] values).

As used here, a "subregion" is a named world area. Subregion names and locations for a generated world are viewable in legends mode under "Regions". Subregions are classified by size the same way for all map sizes: 1-24 tiles is Small, 25-99 tiles is Medium, and 100+ tiles is Large.

The counts used here will always be restricted to regions of the given size, no matter how large the count. Also, the count is more of a goal than a minimum or maximum. As a result, you can end up with many more or many fewer than the requested number of squares in some situations. In particular, if you have something like a case where only 3 large regions exist in a world, and you request "1 evil square" in large regions, you will end up with one of the large regions being ''entirely evil''. So any non-zero value in one of these settings essentially means "force at least one region of this size to be all good/evil."

Note that the "evilness" of evil biomes is also impacted by savagery. Certain civilizations cannot exist in good and/or evil squares, so too many of one or the other may limit the size of certain types of civilizations - dwarves, for example, need non-aligned biomes. Creating too many evil biomes seems to lead to the danger of many civilizations' early extinction.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[GOOD_SQ_COUNTS::<med region>:<lg region>]</nowiki></tt>
| <tt><nowiki>[GOOD_SQ_COUNTS:100:1000:2000]</nowiki></tt>
| rowspan="2" | Set count to zero to disable for that region size.
|-
| <tt><nowiki>[EVIL_SQ_COUNTS::<med region>:<lg region>]</nowiki></tt>
| <tt><nowiki>[EVIL_SQ_COUNTS:100:1000:2000]</nowiki></tt>
|}

=== Minimum Biome Square Counts ===

These numbers control whether or not a world will be rejected based on a lack of different [[biome|biomes]]. Raising these numbers will '''not''' automatically generate the given number of squares of the given biome! For a biome to exist, certain conditions like elevation and rainfall must exist.

These parameters simply filter out worlds that (for example) randomly fail to have enough high elevation squares to support a given number of mountains, etc. Some settings may cause worlds to always be rejected. For example, if for some reason the maximum elevation parameter is set to a value below what will support mountain biomes, it will be impossible to satisfy a non-zero requirement for mountain squares. The same principle goes for other conditions and biomes such as low elevations and oceans, etc.

Certain civilizations require different biomes to exist (such as dwarves and mountains), so eliminating certain biomes will make it impossible for certain civilizations to form.

These parameters often result in infinite world rejection problems. See [[World rejection]] for information on solving problems related to worlds always being rejected due to one or more of these parameters.

0 means no minimum for rejection - setting it to 0 does not guarantee 0 squares of that biome.

==== Biome Type Requirement Table ====

Terrain requirements for various biomes are described below.{{Verify}} Note that some of the exact ranges are unknown.

{| {{prettytable}}
|- bgcolor="#dddddd"
! rowspan="2" | Biome
! colspan="4" | Terrain Requirement
|-
! Elevation
! Rainfall
! Temperature
! Drainage
|-
| Swamp/Marsh
| 100-299
| 33-100
| Non-Freezing
| 0-32
|-
| Desert/Badland
| 100-299
| 0-9
| non-freezing
| note1
|-
| Forest
| 100-299
| 66-100
| non-freezing
| 66-100
|-
| Mountains
| 300-400
| N/A
| N/A
| N/A
|-
| Ocean
| 0-99
| N/A
| N/A
| N/A
|-
| Glacier
| 100-299
| N/A
| Freezing
| 80(?)-100
|-
| Tundra
| 100-299
| N/A
| Freezing
| 0-66
|-
| Grassland
| 100-299
| 0-66
| Non-Freezing
| 0-66
|-
| Hills
| 100-299
| 0-66
| Non-Freezing
| 66-100
|}
note1 drainage: 00-32 sand desert, 33-49 rocky wasteland, 50-65 rocky wasteland but different characters/appearance, 66-100 badlands

==== Minimum Initial Square Count ====

'''Note: The exclusive purpose of these parameters is to cause world rejection.'''

This is the minimum number of squares of the given biome that must exist before things like erosion take place. One thing to keep in mind is the maximum number of squares on a map of a given size - if the total number of squares on a map is lower than the sum of all square count parameters, then you will get infinite world rejection.

To determine the number of squares on a map, just multiply the dimensions. In practice these parameters will need to sum to lower than the maximum because some space is needed for "slack".

{| {{prettytable}}
|- bgcolor="#dddddd"
! Map Size
! Number of Squares
|-
| 17×17
| 289
|-
| 33×33
| 1089
|-
| 65×65
| 4225
|-
| 129×129
| 16614
|-
| 257×257
| 66049
|}

==== Minimum Initial Region Count ====

This is the minimum number of regions of contiguous biome squares that must exist before other processes such as erosion take place.

==== Minimum Final Region Count ====

This many regions of the given biome must exist after erosion and similar phases of generation have been completed.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[REGION_COUNTS:SWAMP:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:SWAMP:1032:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:DESERT:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:DESERT:1032:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:FOREST:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:FOREST:4128:13:12]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:MOUNTAINS:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:MOUNTAINS:8256:9:9]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:OCEAN:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:OCEAN:8256:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:GLACIER:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:GLACIER:0:0:0]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:TUNDRA:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:TUNDRA:0:0:0]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:GRASSLAND:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:GRASSLAND:8256:13:12]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:HILLS:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:HILLS:8256:13:12]</nowiki></tt>
|}

=== Erosion Cycle Count ===

Tells the world generator how long the world has to erode its tall peaks down to mountainsides during the 'running rivers...' stage of world creation. The higher this number, the less jagged the world will be, and the more wide the major rivers will be. If you use the maximum number, your mountains will dissolve before your eyes into plains which can lead to rejections if there aren't enough mountains to use for river start points and dwarven civilization origin points.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EROSION_CYCLE_COUNT:<number>]</nowiki></tt>
| <tt><nowiki>[EROSION_CYCLE_COUNT:250]</nowiki></tt>
| Range: 0 to 1000
|}

=== Minimum/Desired River Start Locations ===

This is the minimum number of riverheads that must exist before and after erosion takes place. Worlds will be rejected if they fail to meet these numbers. As with minimum biome counts, raising this number doesn't automatically create this many riverheads. Other conditions like terrain and rainfall must exist for rivers to form.

Extremely high pre-erosion values speed erosion greatly, while low post erosion values are useful for limiting rejects due to lack of river origin points. One can try the 800 value to get more lakes.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[RIVER_MINS:<min pre-erosion>:<des post-erosion>]</nowiki></tt>
| <tt><nowiki>[RIVER_MINS:200:400]</nowiki></tt>
| Range: 0 to 800
|}

=== Periodically Erode Extreme Cliffs ===

If enabled, makes every impassable rock wall into a series of ramps. Some prefer to pump up erosion to about 250, and turn the "Desired pre-erosion river count" to 0 for good erosion and no extra canyons.

Normally this is set to Yes (1).

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PERIODICALLY_ERODE_EXTREMES:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[PERIODICALLY_ERODE_EXTREMES:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Do Orographic Precipitation and Rain Shadows ===

Toggle that allows terrain height to affect rainfall. For example, moist air coming from the ocean blows over the land. As the terrain gets higher, it forces the moist air up, causing it to rain on the seaward side of a mountain. Eventually, all the rain has fallen if the mountain is tall enough. So, when the breeze goes over the top, there's no moisture left to fall on the other side, creating a rain-shadow. In the current version, regions where drainage is above 50 will also create rain shadows, regardless of the underlying biome and elevation.{{cite forum|140685/5484064}}

Turning this on should create a tendency for more extreme rainfall in regions, creating more forests, deserts, marshlands, and grasslands. Also note that it can create rainfall outside of min-max rainfall settings, so even in a world with a 0 max rainfall you may get rainfall biomes. Turning it off should result in more controllable, less complex rainfall conditions based on rainfall parameters as it adds a random element which can distort or otherwise mess up the climates on a pregenerated map.

This should be disabled if you're importing a map or using a preset map file that has weather.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[OROGRAPHIC_PRECIPITATION:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[OROGRAPHIC_PRECIPITATION:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Maximum Number of Subregions ===

This is the number of separate biomes (the flashing regions you see on embark when you hit F1, F2, etc. when there's more than one biome on the embark location) that are allowed to exist on the entire map.

Setting this to very low values will result in numerous rejections depending on [[#X and Y Variance|variance parameters]]. If variance values are set to high numbers, many small biomes will be created causing rejection if this parameter value is not increased beyond the default.

Increasing the value of this tag is often a must when generating "patchwork" worlds with lots of biome variance, but simply increasing it without increasing variance parameters will not guarantee more biomes.

It is also interesting to note that the maximum subregions is 5000 which is more than the total number of squares for a pocket or small map. However, for a medium or large map (16641 or 66049 squares) it quickly becomes a mere fraction of the total number of possible subregions. In fact it would be quite easy on a large map to end up with far too many subregions and get endless rejections of this type.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SUBREGION_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[SUBREGION_MAX:2750]</nowiki></tt>
| Range: 1 to 5000
|}

=== Cavern Parameters ===
[[Caverns]] are the hollow areas underground, which dwarves tend to encounter when they're digging around. The '''Cavern Layer Number''' parameter determines how many cavern systems will be generated, not including the magma layer or the Bottom layer. Defaults to three - setting it to lower values could help FPS. Setting it to 2 will merge cavern 3 species into the 2nd cavern, and setting it to 1 will merge all into one cavern. However, disabling them entirely by setting it to 0 will make it impossible to grow any underground plants, as none will exist for your civilization to cultivate, nor will they be available on embark.

*Setting caverns to a sub-3 number (Spoiler, highlight to view) erases about one-third of HFS spires{{Bug|10267}} and prevents dig deep disasters. Additionally, random plant or animal species can be more frequently absent.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_COUNT:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_COUNT:3]</nowiki></tt>
| Range: 0 to 3
|}

==== Cavern Layout Parameters ====

Open caverns and dense passageways are not mutually exclusive. When both are raised, bizarre results can occur, such as layers showing a combination of open caverns, a cluster of network passages, and natural walls sprinkling the inside of an otherwise open cavern. [http://www.bay12forums.com/smf/index.php?topic=76355.msg1936859#msg1936859 Reference]

If you want the largest open spaces possible, then decrease the density and increase the openness. If you want a labyrinth of passageways, lower the openness and raise the passage density.

Another interesting note about the cavern layers is that the seed and number of demon types affect the layout of the caverns.

<gallery widths=200 heights=200 perrow=2>
File:Open00Density100.jpg|Cavern slice with Openness of 0 and Density of 100
File:Open100Density00.jpg|Cavern slice with Openness of 100 and Density of 0
File:Open100Density100.jpg|Cavern slice with Openness of 100 and Density of 100
File:Open50Density50.jpg|Cavern slice with Openness of 50 and Density of 50
</gallery>

===== Layer Openness Min/Max =====

Dictates the size of cavern passages. When Passage Density (see below) is set to minimum (0), caverns will be open expanses. Raising the maximum will increase the size of the caverns.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MAX:100]</nowiki></tt>
|}

===== Layer Passage Density Min/Max =====

This determines how many passages form the cavern. If openness (see above) is set to minimum and density increased, then you will get a maze-like network of small criss-crossing passages. Raising the values further increases the number of the maze-like passages.

Caverns will be large, open spaces at 0, and comprised of many small vertical shafts of rock at 100. Setting both values to be the same results in a uniform look for the caverns.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MAX:100]</nowiki></tt>
|}

===== Layer Water min\max =====

Determines how many caverns (out of a max. 3) will have water at the bottom. Note that, even at 100, there will be some amount of ground in caverns, but each cavern 'bubble' will contain some amount of water.

At 0, there will be no water in your caverns. This may impact future underground plant growth, although maps will still start with underground flora.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_WATER_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_WATER_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_WATER_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_WATER_MAX:100]</nowiki></tt>
|}

==== Magma Layer ====

This parameter controls whether the [[magma sea]] exists.

Setting 1/Yes causes the magma layer to exist, value 0/No prevents it. Appears not to have any impact on volcanoes nor volcanism, so even if 0/No, there will still be embark locations with magma. If a [[volcano]] exists, it appears to always tap the magma sea, but the magma sea will not be revealed by revealing the volcano.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[HAVE_BOTTOM_LAYER_1:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[HAVE_BOTTOM_LAYER_1:1]</nowiki></tt>
|}

==== Bottom Layer ====

Determines if the space below the magma sea exists. If Yes the "HFS" layer is always present. Normally you want to leave this set to Yes for maximum fun.

If enabled, this will force the magma layer above it.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[HAVE_BOTTOM_LAYER_2:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[HAVE_BOTTOM_LAYER_2:1]</nowiki></tt>
|}

=== Z Levels (Depth) Settings ===

These parameters control the "thickness" of various "layers" on the map. Note that a "layer" in this case does not refer to one Z-level, but refers to a number of related Z-levels such as "levels above ground".

The following table assumes that you have 3 cavern layers. (out of a minimum of 0-3) The Levels Above Layer settings control how many Z-Levels are above each layer. A layer may itself consist of multiple Z-Levels (and almost always does).

{|style="margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;" class="wikitable"
|-style="background:#F2F2F2;text-align:center;"
!style="border:1px #AAA solid;padding:0.2em;" width="120"|Setting Name
!style="border:1px #AAA solid;padding:0.2em;" width="200"|Token
!style="border:1px #AAA solid;padding:0.2em;"| Description
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Ground
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_GROUND:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| The number of Z-levels of air above the highest surface level. Has no impact on how many Z-levels deep the surface layer is.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above layer 1
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_1:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of stone above the first cavern layer. Making this higher will guarantee ''at least'' this many levels to build your fortress, but will have no impact on how many z-levels thick the surface layer is. Also, the top of a cavern may be higher than the rest of a cavern, so in practice there will be more "solid" levels than this above the cavern.
As of version 0.31.25 this setting is inaccurate. The actual number of z-levels may vary in a range of approx. ±5, which may result in non-existence of any solid z-levels between a surface layer and first cavern layer.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 2
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_2:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of earth between the very top of the second cavern and the very bottom of the first cavern.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 3
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_3:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of earth between the very top of the third cavern and the very bottom of the second cavern.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 4
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_4:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of earth between the very highest magma and the very bottom of the third cavern. Spoiler Hidden (select invisible text to read): Making this high will give a large area for HFS veins, so that it never touches caverns, giving more to mine '''if''' it was impacting the cavern previously.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 5
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_5:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Uncertain. May control the number of levels of "Semi Molten Rock" between HFS and Magma, may control number of levels of magma, may impact both. In experimentation, the overall depth of all magma sea and semi-molten rock levels appears to increase, but not consistent enough to say for certain. Only valid if Magma Layer present. Spoiler Hidden:Often the HFS vein will only extend as high as the highest magma, making this the only guaranteed way to increase amount of HFS to mine, but unfortunately also creating enormous useless semi-molten z-levels
|-
|style="border:1px #AAA solid;padding:0.2em;"| At Bottom
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_AT_BOTTOM:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Appears to be number of levels of HFS chamber. Only valid if Bottom Layer present, often having no impact. Values larger than default result in strange things.
|}

Some implications:
* The number of surface layers (e.g. soil), at this time, cannot be controlled. For example, on a map with 1 layer of peat, then a layer of silt, then a layer of obsidian, there is no control to let you increase either one to be, say, 20 z-levels. (though you may get lucky with the obsidian).
* There can be multiple stone layers between the cavern and the surface, so, increasing Levels Above Layer 1 may give you more conglomerate or more granite, and you have no control over which stone layer spans those Z-levels.
* The layers shown on embark span across the cavern layers in an unknown and inconsistent way. Sometimes those 10 different layers of stone are evenly distributed over your 400 z-level deep map, sometimes the first 9 get 1 z-level each and the last gets the other 391 levels. No way to control found yet.
* The HFS chamber, if present, will always extend into the rock layers, and appears to always make contact with the bottom cave. Large values for levels above layer 5 and layer 4 can result in enormous chambers, but the number of levels at the top (the part with undead) appears to be unaffected.
* Unconfirmed whether number of levels between caverns has any impact on cavern height. There will be connecting ramps and/or shafts between cavern layers no matter how many levels are between them.
* '''Very Important''': These values appear to apply across a whole 16x16 region, not just embark areas. That means that if a 16x16 region is completely flat, but has one tall mountain in one far corner, even if you set Levels Above Ground low (e.g. 2 z-levels) you still have all the empty air of the highest mountain in every embark tile (e.g. 200 z-levels). Also can happen to the semi-molten layer, and can lead to unexpected behavior.
* Very large or small values can cause strange things to happen.

=== Cave Parameters ===

Caves are somewhat like caverns, except that they have a passage to the surface, and are generally much smaller – caves can connect to caverns if they are sufficiently deep.

==== Minimum/Maximum Natural Cave Size ====

These parameters appear to control the length and depth of caves.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVE_MIN_SIZE:<number>]</nowiki></tt>
| <tt><nowiki>[CAVE_MIN_SIZE:5]</nowiki></tt>
| rowspan="2" | Range: 1 to 500
|-
| <tt><nowiki>[CAVE_MAX_SIZE:<number>]</nowiki></tt>
| <tt><nowiki>[CAVE_MAX_SIZE:25]</nowiki></tt>
|}

==== Number of Caves ====
The number of caves generated in mountainous and non-mountainous regions, mountain caves will always be generated on the edge of mountain ranges next to non-mountainous regions. Lurking [[kobold]]s set up shop in caves, and store their stolen items there - a setting of 0 in both will stop kobold civilizations from appearing. Special note: a cave is not initially a [[lair]], although beasts can later use them as their lair.
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MOUNTAIN_CAVE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[MOUNTAIN_CAVE_MIN:100]</nowiki></tt>
| rowspan="2" | Range: 0 to 800
|-
| <tt><nowiki>[NON_MOUNTAIN_CAVE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[NON_MOUNTAIN_CAVE_MIN:200]</nowiki></tt>
|}

==== Make Caves Visible ====

If set to no (default) then the location of caves will not be marked on the map. If set to yes, caves will appear on the map so that they may be sought out or avoided as desired.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ALL_CAVES_VISIBLE:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALL_CAVES_VISIBLE:0]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Allow Init Options to Show Tunnels ===

If enabled, you will be able to see the underground tunnels often built by dwarves on the world map, and they will appear as black lines, similar to roads.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SHOW_EMBARK_TUNNEL:<0-2>]</nowiki></tt>
| <tt><nowiki>[SHOW_EMBARK_TUNNEL:2]</nowiki></tt>
| 0 = No 1 = Only in Finder 2 = Always
|}

=== Number of Civilizations ===

This number of [[civilization]]s will be placed on the map before history generation begins. These civilizations may later die out due to historical events. It is noteworthy that the chance for any given civilization to be destroyed through megabeasts decreases with a higher total number of civilizations present[http://www.bay12forums.com/smf/index.php?PHPSESSID=7348f68f41a9659443c05b2acf534e6c&topic=112465.15 data]. The five races are dwarf, elf, human, goblin, and kobold; they will generally be placed in equal numbers until the quota has been reached. If there are not enough biomes or other worldgen prerequisites for an even distribution, certain civs will be much more or less frequent than others[http://www.bay12forums.com/smf/index.php?PHPSESSID=7348f68f41a9659443c05b2acf534e6c&topic=112465.15 data]. If there is an odd number of civs (not divisible by 5), then the remainder is distributed randomly. Kobold civs require caves to be placed; if no caves exist, then kobolds are skipped and will not appear. This does not cause rejections [http://www.bay12forums.com/smf/index.php?topic=112465.msg3415125#msg3415125 data]. Goblin civilizations require multiple demons, see the [[#Number_of_Demon_Types|number of demon types]] section above.

Note that a high value here can cause lots of map rejections, particularly on smaller maps as there simply isn't enough room or regions to put them all in.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TOTAL_CIV_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[TOTAL_CIV_NUMBER:40]</nowiki></tt>
| Range: 0 to 300
|}

=== Playable Civilization Required ===

If this is set to yes (default) then worlds will be rejected if no civilization with [[Entity token|CIV_CONTROLLABLE]] can be placed. In an unmodded game, only the dwarves have this token.

If set to no, the result may be a world that cannot be played in Fortress Mode.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PLAYABLE_CIVILIZATION_REQUIRED:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[PLAYABLE_CIVILIZATION_REQUIRED:1]</nowiki></tt>
| 1/0 = Yes/No
|}

=== Minimum Number of Mid/Low/High Characteristic Squares ===

Sets the minimum possible number of squares of certain ranges of each of the region qualities, such as elevation, rain, drainage, volcanism, savagery, and temperature. These need to be changed to reflect your regional meshes and weights, and are responsible for a HUGE number of map rejections. These values can all be set to 0 for much fewer map rejections, particularly in the case of more wacky, non-standard maps.

These values will cause worlds to be rejected unless at least the given number of squares of the given type are randomly generated. Setting these values too high could result in worlds always being rejected if other parameters such as the maximum/minimums for elevation, etc., don't allow enough of those squares to get generated.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[ELEVATION_RANGES:8256:16512:8256]</nowiki></tt>
| rowspan="5" | Minimum number of squares that must have low, medium, and high amounts of the given attribute. 
0 = No minimum
|-
| <tt><nowiki>[RAIN_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[RAIN_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[DRAINAGE_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[SAVAGERY_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[VOLCANISM_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM_RANGES:8256:16512:8256]</nowiki></tt>
|}

==World rejection==

:''Main article: [[World rejection]]''

If you are having the common problem of generated worlds always being rejected by the world generator, see [[v0.31:World rejection|Solving World Rejection Problems (v0.31 page)]] as it contains many detailed suggestions on how to troubleshoot and solve these issues.

== Parameter set examples ==

If you're trying to do something specific, then the [[Worldgen examples]] - complete parameter sets that can be copied directly into your ''world_gen.txt'' file and customized as desired - might be helpful.
If none of the examples suit your needs, [[Worldgen tricks]] has strategies and tips on making a world just right for you.

For many, many more examples see:
* [http://www.bay12forums.com/smf/index.php?topic=101280 DF2012 (v0.34) WorldGen "Cookbook" Thread]
* [http://www.bay12forums.com/smf/index.php?topic=140180 DF2014 (v0.40) WorldGen "Cookbook" Thread]
* [http://www.bay12forums.com/smf/index.php?topic=168543.0 DF2014 (v0.44.02+) WorldGen "Cookbook" Thread]
* [http://www.bay12forums.com/smf/index.php?topic=175538 DF2014 (v0.47.01+) WorldGen "Cookbook" Thread]
* [http://www.bay12forums.com/smf/index.php?topic=180805.0 DF2022 (v0.50.01+) WorldGen "Cookbook" Thread]

{{World}}

Centaur

2025-10-16T04:30:55Z

DPhKraken:

{{Quality|Superior}}
{{Creaturelookup/0
|biome=None
|death=nobutcher
|contrib=no
|wiki=yes}}
{{av}}
'''Centaurs''' are [[fanciful]] [[creature]]s which are merely the stuff of [[legends]]. They do not actually exist, appearing only in [[engraving]]s as the fancy of artists. A female centaur is known as a ''centauress''.

Some [[Dwarf|dwarves]] [[Preferences|like]] centaurs for their ''strength''.

==The "Centaur" Problem==

''"We've got the "centaur" problem, or whatever, where I wanna take any piece of anything, and slap it onto something else... That has complications in terms of the materials, and the body parts, and that kind of thing that need to be worked out."'' - [[Toady One]], [[Dwarf Fortress Talk]] #28 [38:26]
 
Procedurally [[Creature token#GENERATED|generating]] centaurs has been discussed since the days of ''Dwarf Fortress's'' predecessor, ''[[Armok|Slaves to Armok]]''. Combining two creature objects, such as a [[human]] with the lower body of a [[horse]], and respecting the [[raw file]]s and body structure of each component is a consideration that the nonexistent nature of the centaur and the other [[fanciful]] hybrid creatures allude to.

Though [[creature]]s like [[Merperson|merpeople]] and [[satyr]]s are conceptually hybrids, they are singular, manual implementations, rather than a system that can generate any number of [[Chimera|chimeric]] beings based on combining existing creatures. [[Experiment]]s are generated from a hardcoded [[random creature profile]] rather than being based on their input creature.

{{D for Dwarf}}


Some [[Troll|trolls]] like centaurs for their
{{#splitrand:
[[milk]]
[[Strength|STRENGTH]]
}}.
[[File:Brooklyn Museum - Centauress - John La Farge - overall.jpg|thumb|center|300px|Admired for its ''strength''.]]

==See Also==
* [[Chimera]]
* [[Griffon]]
{{gamedata}}
{{Creatures}}
{{Category|Myth}}
[[ru:Centaur]]

Centaur

2025-10-16T04:30:34Z

DPhKraken: Randomizing D for Dwarf prefstring references is a dangerous power.

{{Quality|Superior}}
{{Creaturelookup/0
|biome=None
|death=nobutcher
|contrib=no
|wiki=yes}}
{{av}}
'''Centaurs''' are [[fanciful]] [[creature]]s which are merely the stuff of [[legends]]. They do not actually exist, appearing only in [[engraving]]s as the fancy of artists. A female centaur is known as a ''centauress''.

Some [[Dwarf|dwarves]] [[Preferences|like]] centaurs for their ''strength''.

==The "Centaur" Problem==

''"We've got the "centaur" problem, or whatever, where I wanna take any piece of anything, and slap it onto something else... That has complications in terms of the materials, and the body parts, and that kind of thing that need to be worked out."'' - [[Toady One]], [[Dwarf Fortress Talk]] #28 [38:26]
 
Procedurally [[Creature token#GENERATED|generating]] centaurs has been discussed since the days of ''Dwarf Fortress's'' predecessor, ''[[Armok|Slaves to Armok]]''. Combining two creature objects, such as a [[human]] with the lower body of a [[horse]], and respecting the [[raw file]]s and body structure of each component is a consideration that the nonexistent nature of the centaur and the other [[fanciful]] hybrid creatures allude to.

Though [[creature]]s like [[Merperson|merpeople]] and [[satyr]]s are conceptually hybrids, they are singular, manual implementations, rather than a system that can generate any number of [[Chimera|chimeric]] beings based on combining existing creatures. [[Experiment]]s are generated from a hardcoded [[random creature profile]] rather than being based on their input creature.

{{D for Dwarf}}


Some [[Troll|trolls]] like centaurs for their
{{#splitrand:
[[milk]]
[[Sphere token#STRENGTH|STRENGTH]]
}}.
[[File:Brooklyn Museum - Centauress - John La Farge - overall.jpg|thumb|center|300px|Admired for its ''strength''.]]

==See Also==
* [[Chimera]]
* [[Griffon]]
{{gamedata}}
{{Creatures}}
{{Category|Myth}}
[[ru:Centaur]]

Dye

2025-10-14T17:46:23Z

DPhKraken: Bayberry leaf dye is made from bayberry leaf

{{Quality|Superior}}
{{av}}
{{distinguish|Die}}
[[File:dye_bag_preview.png|right|Bag of Dimple Cup dye powder.]]
'''Dye''' can be used at the [[dyer's shop]] to change the [[Color#Color_tokens|color]] of clothing materials.

==Production==
Dyes can be produced by milling a number of [[crop|plants]] at a [[millstone]] or [[quern]] (which also produces seeds) as well as from other sources at a [[dyer's shop]] (which does '''not''' produce seeds). Usually, all [[trading|caravans]] will bring dye for [[trade]] too. Importing dye, however, is only useful if you have a somewhat-skilled [[dyer]], otherwise, little value is added and the work wasted. It is better to buy or grow the 'source' plants if available, and mill them yourself. Of course, the nice colors are a value in themselves, if you don't stuff it all in bins.

Dyes can be applied either to woven [[cloth]], raw [[thread]], or [[leather]]{{v|52.03}}. Dyed items have their [[value]] increased by the value of the dye (see table above), multiplied by the [[quality]] with which the dye was applied. There is not known to be any difference in the end product based on when the dye was applied during the production process. Dyes can't be applied to finished goods made from cloth, such as clothing, bags, or crafts.

Dyes can be mixed to create additional colors. The desired color can be chosen at the [[dyer's shop]] with the "dye cloth ([[color]])" job, blending dyes with each other, or the material's natural color, to produce the chosen color.

==Storage==
On the [[stocks]] screen, dyes are listed under [[powder]]. Dyes are [[stockpile]]d as "Food/Milled Plants", along with [[flour]]s. [[Barrel]]s that contain only powders are called 'Mill barrel'. Each barrel can contain up to 60 dye [[Bag|bags]], each bag containing one stack of dye items.

==Work Order Conditions==
Bag contents are not recognized in the [[Manager#Work orders|manager's work order conditions]].
As such, item type (powder) and material (e.g. 'Dimple dye', 'Redroot dye', 'potato skin dye', etc) will not work (despite being the recommended condition on create dye jobs).
As a workaround, reference all items/materials and use adjectives.

Examples:
* Count all stacks of dye: Item type 'items', material type 'no material', adjective 'dye item'
* Count all stacks of midnight blue (dimple cup) dye: Item type 'itemsi, material type 'no material', adjective 'dye item', adjective 'Color midnight blue'

==List of dyes==
{| class="wikitable sortable" cellspacing="0" border="1" cellpadding="5" style="margin: 0 auto; border-spacing: 0"
|- style="background:#ddd"
!Plant
!Dye
!colspan=2|Color
!Value
!Crop type
!Production

|-
|[[Dimple cup]]
|Dimple dye
|Midnight blue
| bgcolor="#003366" |    
|20[[Currency|☼]]
|Underground
|Milled
|-
|[[Blade weed]]
|Emerald dye
|Emerald
| bgcolor="#50c878" |    
|20[[Currency|☼]]
|Aboveground
|Milled
|-
|[[Hide root]]
|Redroot dye
|Red
| bgcolor="#ff0000" |    
|10[[Currency|☼]]
|Aboveground
|Milled
|-
|[[Sliver barb]]
|Sliver dye
|Black
| bgcolor="#000000" |    
|20[[Currency|☼]]
|Aboveground
|Milled

|-
|[[Sorghum]]
|Sorghum leaf dye
|Rust
| bgcolor="#B7410E" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Rice]]
|Rice husk dye
|Buff
| bgcolor="#F0DC82" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Red spinach]]
|Red spinach leaf dye
|Fuchsia
| bgcolor="#F400A1" |    
|20[[Currency|☼]]
|Aboveground
|Plant

|-
|[[Cabbage]]
|Cabbage leaf dye
|Pink
| bgcolor="#FFC0CB" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Wild carrot]]
|Carrot dye
|Pale brown
| bgcolor="#987654" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Eggplant]]
|Eggplant dye
|Lilac
| bgcolor="#C8A2C8" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Onion]]
|Onion skin dye
|Orange
| bgcolor="#FFA500" |    
|20[[Currency|☼]]
|Aboveground
|Bulb
|-
|[[Peanut]]
|Peanut shell dye
|Dark brown
| bgcolor="#654321" |    
|20[[Currency|☼]]
|Aboveground
|Pod
|-
|[[Potato]]
|Potato skin dye
|Beige
| bgcolor="#F5F5DC" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Radish]]
|Radish dye
|Pale pink
| bgcolor="#FADADD" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Rhubarb]]
|Rhubarb leaf dye
|Tan
| bgcolor="#D2B48C" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Spinach]]
|Spinach leaf dye
|Leaf green
| bgcolor="#19b211" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Sweet potato]]
|Sweet potato skin dye
|Beige
| bgcolor="#F5F5DC" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Tomato]]
|Tomato skin dye
|Amber
| bgcolor="#FFBF00" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Turnip]]
|Turnip skin dye
|Beige
| bgcolor="#F5F5DC" |    
|20[[Currency|☼]]
|Aboveground
|Plant
|-
|[[Watermelon]]
|Watermelon dye
|Orchid pink
| bgcolor="#e55bc3" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Grape]]
|Grape dye
|Lavender
| bgcolor="#E6E6FA" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Cranberry]]
|Cranberry dye
|Red
| bgcolor="#FF0000" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Bilberry]]
|Bilberry dye
|Violet
| bgcolor="#8B00FF" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Blueberry]]
|Blueberry dye
|Lavender
| bgcolor="#E6E6FA" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Blackberry]]
|Blackberry dye
|Lavender
| bgcolor="#E6E6FA" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Raspberry]]
|Raspberry dye
|Raspberry pink
| bgcolor="#ff1980" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Pineapple]]
|Pineapple leaf dye
|Golden yellow
| bgcolor="#FFDF00" |    
|20[[Currency|☼]]
|Aboveground
|Leaves

|-
| rowspan="2" | [[Mangrove]]
|Mangrove bark dye
|Burnt umber
| bgcolor="#8A3324" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Mangrove leaf dye
|Burnt umber
| bgcolor="#8A3324" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Pine]]
|Pine bark dye
|Beige
| bgcolor="#F5F5DC" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|[[Oak]]
|Oak bark dye
|Brown
| bgcolor="#964B00" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|[[Mahogany]]
|Mahogany bark dye
|Mahogany
| bgcolor="#C04000" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|[[Acacia]]
|Acacia bark dye
|Chocolate
| bgcolor="#DC691E" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|[[Maple]]
|Maple bark dye
|Light brown
| bgcolor="#CD853F" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
| rowspan="2" | [[Willow]]
|Willow bark dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Willow leaf dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Larch]]
|Larch bark dye
|Golden yellow
| bgcolor="#FFDF00" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
| rowspan="3" | [[Chestnut]]
|Chestnut bark dye
|Dark brown
| bgcolor="#654321" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Chestnut leaf dye
|Dark brown
| bgcolor="#654321" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|Chestnut hull dye
|Dark brown
| bgcolor="#654321" |    
|20[[Currency|☼]]
|Aboveground
|Nuts
|-
| rowspan="2" | [[Alder]]
|Alder bark dye
|Russet
| bgcolor="#755A57" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Alder cone dye
|Russet
| bgcolor="#755A57" |    
|20[[Currency|☼]]
|Aboveground
|Cones
|-
|[[Birch]]
|Birch bark dye
|Beige
| bgcolor="#F5F5DC" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|[[Ash (tree)|Ash]]
|Ash bark dye
|Goldenrod
| bgcolor="#DAA520" |    
|20[[Currency|☼]]
|Aboveground
|Logs

|-
| rowspan="2" | [[Banana]]
|Banana leaf dye
|Ochre
| bgcolor="#CC7722" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|Banana peel dye
|Ochre
| bgcolor="#CC7722" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Coffee]]
|Coffee bean dye
|Brown
| bgcolor="#964B00" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
| rowspan="2" | [[Guava]]
|Guava bark dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Guava leaf dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Tea]]
|Tea leaf dye
|Tan
| bgcolor="#D2B48C" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Avocado]]
|Avocado skin dye
|Peach
| bgcolor="#FFE5B4" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
| rowspan="2" | [[Olive]]
|Olive bark dye
|Woodland green
| bgcolor="#0f9931" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Olive leaf dye
|Woodland green
| bgcolor="#0f9931" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
| rowspan="3" | [[Pomegranate]]
|Pomegranate leaf dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|Pomegranate rind dye
|Green-yellow
| bgcolor="#ADFF2F" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|Pomegranate bark dye
|Gray
| bgcolor="#808080" |    
|20[[Currency|☼]]
|Aboveground
|Log
|-
|[[Almond]]
|Almond shell dye
|Light brown
| bgcolor="#CD853F" |    
|20[[Currency|☼]]
|Aboveground
|Nut
|-
| rowspan="2" | [[Apple]]
|Apple bark dye
|Rose
| bgcolor="#F4C2C2" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Apple leaf dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Apricot]]
|Apricot bark dye
|Pink
| bgcolor="#FFC0CB" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
| rowspan="2" | [[Bayberry]]
|Bayberry leaf dye
|Yellow
| bgcolor="#FFFF00" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|Bayberry dye
|Blue
| bgcolor="#0000FF" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
| rowspan="2" | [[Cherry]]
|Cherry bark dye
|Pale pink
| bgcolor="#FADADD" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Cherry leaf dye
|Light brown
| bgcolor="#CD853F" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Ginkgo]]
|Ginkgo leaf dye
|Lemon
| bgcolor="#FDE910" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
| rowspan="2" | [[Hazel]]
|Hazel bark dye
|Gold
| bgcolor="#D4AF37" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Hazel leaf dye
|Gold
| bgcolor="#D4AF37" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Peach]]
|Peach bark dye
|Amber
| bgcolor="#FFBF00" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
| rowspan="2" | [[Pear]]
|Pear bark dye
|Ecru
| bgcolor="#C2B280" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|-
|Pear leaf dye
|Ecru
| bgcolor="#C2B280" |    
|20[[Currency|☼]]
|Aboveground
|Leaves
|-
|[[Persimmon]]
|Persimmon dye
|Slate gray
| bgcolor="#708090" |    
|20[[Currency|☼]]
|Aboveground
|Fruit
|-
|[[Plum]]
|Plum bark dye
|Mauve taupe
| bgcolor="#915F6D" |    
|20[[Currency|☼]]
|Aboveground
|Logs
|}

==Trivia==
A number of plants have comments in their [[raw file]]s suggesting they should produce dye, dating from before more dyes were added in [[Release information/52.03|52.03]]. [[Wild carrot]] and [[rhubarb]] produce dyes from different parts than their comment suggests: flowers and roots in the respective comments. [[Pendant amaranth]] flowers are noted to produce dye, but do not have any in-game dye materials.

Sliver barbs are only found in [[Surroundings#Evil|evil]] areas, therefore, [[elf|elves]], [[dwarf|dwarves]], and [[human]]s won't bring sliver barbs to trade. To obtain it, you must embark in an evil area and pull it from the ground yourself.

[[Hide root|Redroot dye]] is the only dye priced at 10[[Currency|☼]].

{{D for Dwarf}}

In some dwarven civilizations, a common battle cry is ‘ESHON ALOD ATÍR!’, which [[Dwarven language|translates]] as ‘TODAY IS A GOOD DAY TO DYE!’ Dwarven historians have been unable to determine why this should be.

==See also==
*[[Decoration]]
*[[Textile industry]]

{{Translation
| dwarven = atír
| elvish = afithi
| goblin = osmu
| human = asseg
}}

{{materials}}

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

Modding

2025-10-07T18:51:28Z

DPhKraken: /* Basics of DF modding */ Full mod folder structure as of the Lua update

{{Quality|Fine}}
{{av}}
{{For/see|a list of Dwarf Fortress mods|[[List of mods]]}}
{{Modding}}
'''Modding''', or creating [[mod]]s, refers to modifying the behavior of the base game (vanilla). ''Dwarf Fortress'' is remarkably moddable.

== Resource Overview==
[[File:modding_icon.png|120px|right]]This section serves as a portal to all modding-related pages on the wiki.

; Using Mods:
* [[Mod#Downloading mods|Downloading mods]]
* [[Mod#Enabling/installing mods|Enabling mods in-game]]

; Guides and references:
* [[Modding guide|DF RAWs modding guide]]
* [[Modding pitfalls]] for troubleshooting

* [[Mod#Mod format|Mod format]] and [[Game folders and files]]
* [https://github.com/Putnam3145/DF-Raws/tree/master Official DFRaws repository] and [https://github.com/DF-Wiki/DFRawFunctions Wiki mirror]
* [[Mod#Publishing on Steam Workshop|Publish on Steam Workshop]]
* [[Character table]]
* [[String dump]]

* [https://github.com/Putnam3145/Dwarf-Fortress--libgraphics-- Official SLD2 repository]
* [https://docs.dfhack.org/en/latest/docs/guides/modding-guide.html#dfhack-modding-guide DFHack modding guide]
* [[Memory hacking]], [[Main:Offset Finding Methods|Offset Finding Methods]]

; Where to get help?
* The official [http://www.bay12forums.com/smf/index.php?board=13.0 modding subforum] on the [[Bay 12 Forums]].
* [https://discord.com/channels/329272032778780672/629902895138996264 #modding-discussion] and [https://discord.com/channels/329272032778780672/1069640085718450218 #modding-technical] channels on [[Kitfox Games]]' Discord.
* [https://docs.dfhack.org/en/stable/docs/Introduction.html#getting-help DFHack questions]

; Modding tools
* There are several specialized [[Utilities#Modding tools|utilities]] that assist in modding efforts. There is [http://www.bay12forums.com/smf/index.php?topic=28829.0 a longer list of them] on the [[Bay 12 Forums]].
:*[https://putnam3145.github.io/helper Material Helper] by [[User:Putnam3145]], for calculating [[Material definition token|material properties]].
:*[https://jose96xd.github.io/DF_Tools/index.html DF Tools] by [[User:Jose96xd]], a collection of web tools.
:*[https://dffd.bay12games.com/file.php?id=1738 DFLang] (by Igfig) and [https://dffd.bay12games.com/file.php?id=7174 LangCreate] (by Talvieno) for generating [[Language token|translations]].
:*[http://www.bay12forums.com/smf/index.php?topic=158930.0 Dwarf Portrait] by Rose, for visualizing unit [[Body token|bodies]].
* Text editors are used in all areas of modding. Use a good text editor to edit files and search into multiple files (like the free [https://notepad-plus-plus.org/ Notepad++] for example) or more advanced editors capable of highlighting and formatting the displayed text (like [[Utilities#DF RAW Language server|DF RAW Language server]])
* Image editors are needed for doing custom graphics. [https://www.getpaint.net/ Paint.NET], Photoshop and GIMP are the most used, but whatever supports the .png format will work.

=== Documentation===
; [[Raw file]]s

These object files, stored in <code>/data/vanilla/*/objects/</code>, define various specifics of game items, materials, and creatures, and can be changed using mods to alter how the game behaves. These are text based and can be edited with any text editor, however, editing the vanilla raw files is now discouraged.

See [[Token|Token reference]] - It's always good to refer to tokens on the wiki. Even experienced modders have to look up tokens! A list of articles about tokens can be found here.

; [[Graphics|Graphics files]]:

The `/data/art/` subfolder of Dwarf Fortress is used to store user-customizable [[tileset]]s while mods can include their own [[Graphics#Premium Graphics|graphics files]].

; [[Reaction]]s:

; [[Language token|Language]] and [[Speech file]]:

; [[Audio|Sound and Music files]]:

All sound and music files used by ''Dwarf Fortress'' are stored in the [https://en.wikipedia.org/wiki/Ogg .ogg] format within the <code>/data/sound/</code> subfolders. Mods can load new audio files. You can also change some of the definitions of when certain musical cues are played, using available [[music token]]s and [[sound token]]s in the raw files.

An example mod by [[User:Putnam3145]] is available on [https://github.com/Putnam3145/dwarf-fortress-example-sound-mod Github].

; [[Lua scripting]]:

An experimental feature used for procedural generation.

=== Best practice ===
The current best practice is to not modify the original raw files, since most modifications can be made via mods. Mods can add new objects, add tokens to existing objects, and cut objects entirely. You should prefer ``SELECT`` over ``CUT``, and prefer ``CUT`` over unloading ([[Mod info token|conflicting with]]) vanilla raws.

== Guide ==
This is intended to be a guide to inform those new to ''Dwarf Fortress'' modding on what elements of the game can be modified, and how. After reading through this guide, a user should be capable of editing creatures, entities, materials ''et al'', and creating their own.

Generally, breaking stuff is fine - nothing that can be changed will affect the DF executable, and new additions can be easily removed.

This guide is based on [[40d:Modding guide|Teldin's guide]], originally created for version 0.27.176.39c. Per wiki tradition, it has been updated through all the major releases since then; hopefully it reflects current knowledge.

=== Token reference ===
It's always good to refer to tokens on the wiki. Even experienced modders have to look up tokens! A list of articles about tokens can be found [[Token|here]].

=== Basics of DF modding ===
To make a mod, one must put a folder into the <code>/mods/</code> directory in the game's AppData [[File|folder]] or the portable directory. When a mod is first installed, it is copied to <code>/data/installed_mods/</code> and the game loads all data from the installed copy. Changes are NOT immediately propagated from <code>/mods/</code> to <code>/data/installed_mods/</code>. You can create a new installed copy by deleting the old copy or by incrementing the [[Mod info token|version info]] - see [[modding pitfalls]] for more information. The vast majority of modifications to the game can be done via this method.

Your mod folder must contain a file named "info.txt" and subfolders depending on what your mod includes. The majority of mods will want to have an ``objects/`` folder, which can define most kinds of [[Raw file|game content]], and a ``graphics/`` folder, to add [[graphics]].

[[File:Folder-orange.svg|20px|link=]] Mod Name
├ [[File:Folder.svg|20px|link=]] [[Graphics|graphics]]
├ [[File:Folder.svg|20px|link=]] [[Raw file|objects]]
├ [[File:Folder.svg|20px|link=]] [[Lua scripting|scripts]]
├ &emsp;[[File:Lua-Logo.svg|20px|link=]] init.lua
├ [[File:Folder.svg|20px|link=]] [[Audio|sound]]
├ [[File:Text-x-generic.svg|20px|link=]] [[info.txt]]
└ [[File:Picture icon.png|20px|link=]] preview.png

The [[info.txt]] is formatted like so:

{{code|
[ID:my_first_mod]
[NUMERIC_VERSION:1]
[DISPLAYED_VERSION:1.0.0]
[EARLIEST_COMPATIBLE_NUMERIC_VERSION:1]
[EARLIEST_COMPATIBLE_DISPLAYED_VERSION:1.0.0]
[AUTHOR:Your Name Here]
[NAME:My First Mod]
[DESCRIPTION:A cool mod I made!]
}}

A mod should have all of these. There are a [[mod info token|few more tokens]], but the above are the important ones.

Most of the game's vanilla content is in the same format as mods. Many text files can be found in the subfolders of the <code>/data/vanilla</code> folder - these are the [[raw file|raw files]], and using them as a basis for modification is quite easy. For now, we will take a look at one of the existing files. For example, if you open <code>/data/vanilla/vanilla_creatures/objects/creature_standard.txt</code>, it should look something like this:

{{code|
creature_standard

[OBJECT:CREATURE]

[CREATURE:DWARF]
[DESCRIPTION:A short, sturdy creature fond of drink and industry.]
[NAME:dwarf:dwarves:dwarven]
[CASTE_NAME:dwarf:dwarves:dwarven]
[CREATURE_TILE:1][COLOR:3:0:0]
[CREATURE_SOLDIER_TILE:2]
...
}}

As you can see, each file comprises a header string stating the file name, a second header stating the type of object data it contains, followed by the contents of the file itself. These are all necessary elements of the file, and without them, the file will be ignored by the game.

'''In other words, to be recognized by the game, a raw file must have all of the following:'''

# A filename that refers to the type of objects contained therein. '''Creature files must start with creature_, entity files must start with entity_, and so on.'''
# The filename on the first line of the file.
# ``[OBJECT:type]``, where "type" is replaced with the relevant object type.

Below the headers, there begins a list of entries. Each entry is made up of its own header (in this case, ``[CREATURE:DWARF]``), again stating the type of object, and then the object's unique identifier - if an identifier isn't unique, the game will mess up and you'll get some serious, and potentially very trippy, errors. ([[Duplicated raws|For example...]]) Below that, we have the body of the entry, which determines the entry's specific properties.

The body of an entry is made up of a series of "tokens", which are essentially flags that can be added or removed to affect the entry's attributes. Most of these effects are hardcoded: for example, it's possible to make a creature only eat meat with the {{token|CARNIVOROUS}} token, but it's impossible to create your own token detailing a specific diet for the creature.

Before we continue, a few key things to remember when modding the raw files:

* Try to avoid modifying the existing raw files when possible. You should make a mod instead!
* When adding files, token identifiers are all you need to include to ensure proper references are maintained. The game searches through all loaded raw files by tokens.
** For example, you can add a new pair of leather boots and not even have to add it to a file named ``item_shoes.txt``, but rather your own file, say ``item_shoes_new.txt``.
** All objects must have a unique token identifier. Adding a consistent prefix or suffix to your mod's objects (ie: ``[ITEM_SHOES:ITEM_SHOES_BOOTS_NEW]``) greatly reduces the chance that another mod uses the same token. If two mods define objects with the same token without cutting the other, then they will be incompatible due to [[duplicated raws]].
* When a new world is generated, the mods included are "baked in" and cannot be modified except to be updated—for this, the game checks that the mod used by the save is of a compatible {{token|NUMERIC_VERSION|modinfo}}.
* There's nothing stopping you from just copying an existing creature/entity/whatever, changing the identifier, and modifying it. This can save you a lot of time, especially when it comes to entities.

=== Modifying the vanilla objects ===

You should not modify the vanilla raws where they originally are if you can help it. Instead, patch them using the patching functions provided with ''Dwarf Fortress'' since v50.01.

There are two patching functions: ``SELECT`` and ``CUT``. When ``SELECT`` is used, it lets you make changes to an object without needing the entire entry to be present in your mod file. When ``CUT`` is used, it forces the game to not use that object, even though it is still found in the vanilla raws (or in any other mods earlier in the load order). Both of these functions take the form of tokens. These functions are not universally applicable to any token found in any entry, just the following list of base objects:

* [[Creature token|CREATURE]]
* [[Entity token|ENTITY]]
* [[Interaction token|INTERACTION]]
* [[Item definition token|ITEM]]
* [[Language token|WORD, TRANSLATION, SYMBOL]]
* [[Inorganic material definition token|INORGANIC]]
* [[Plant token|PLANT]]
* [[Audio|MUSIC, SOUND]]
* [[Reaction token|REACTION]]

The syntax required for these functions is: ``[<function>_<object>:<specific object being affected>]``. For instance, ``[CUT_PLANT:MUSHROOM_HELMET_PLUMP]`` cuts the plump helmet object originally defined in the vanilla file ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/plant_standard.txt plant_standard.txt]``, so the game will not use that object at all. However, ``[SELECT_ITEM_HELM:ITEM_HELM_HELM]`` does not select the helm object from the vanilla file ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_helm.txt item_helm.txt]``, even though that's how the object appears in that file, because there is no ``[SELECT_ITEM_HELM]`` token. Instead, the helm would be selected with ``[SELECT_ITEM:ITEM_HELM_HELM]``.

For example, if you wanted to mod beards onto dwarven women while also removing elephants from the game:

{{code|
creature_mypatch

[OBJECT:CREATURE]

[SELECT_CREATURE:DWARF] starts editing DWARF from the end of the entry
[SELECT_CASTE:FEMALE]
[BODY_DETAIL_PLAN:FACIAL_HAIR_TISSUE_LAYERS]

[CUT_CREATURE:ELEPHANT] removes the ELEPHANT creature
}}

Or, say, add your own reaction and building to dwarves:

{{code|
entity_mypatch

[OBJECT:ENTITY]

[SELECT_ENTITY:MOUNTAIN]
[PERMITTED_REACTION:MY_REACTION]
[PERMITTED_BUILDING:MY_BUILDING]
}}

And in any of these, one can add the token ``[LOG_CURRENT_ENTRY]`` somewhere under one of the objects of the file, which logs the full contents of the object in question to ``logs\current_entry.txt``. This can be useful to make sure that the patch is doing what you think it is. For instance if ``[LOG_CURRENT_ENTRY]`` were added on the next line after ``[CREATURE:DWARF]`` in your mod file, then the dwarf object would be the object detailed in the log entry.

Note that it is not possible to remove an existing token from most objects using ``SELECT`` or ``CUT`` alone. Creatures can make use of {{token|CV_REMOVE_TAG|cv}}; for other objects, it is currently necessary to ``CUT`` the entire object and redefine it.

...Speaking of, let's move on to modifying and adding entities.

=== Modding civilizations (entities) ===

Entities - the objects that determine how civilizations work - are stored in <code>[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/entity_default.txt vanilla_entities/objects/entity_default.txt]</code> (though, like all other files, you may add more). They follow the same format as any other raw file:

{{code|
entity_default

[OBJECT:ENTITY]

[ENTITY:ENTITYNAME]
[CREATURE:CREATURETYPE]
[TRANSLATION:LANGUAGETYPE]
[BIOME_SUPPORT:BIOMETOKEN:FREQUENCY]
...[OTHER TAGS]...
}}

Most of the time, it doesn't matter which order these tokens are in or where they're placed so long as they're below the ``[ENTITY:]`` identifier, but there are some important exceptions in the case of other files, especially creatures, which can contain a lot of "nested" tokens.

{{token|CREATURE|e}} links the civilization with a specific creature defined in a creature file. This is the creature that'll be making up the entity's population, and, therefore, the creature you'll be playing as in fortress or adventure mode if the entity is a playable one. For example, if you wanted to do something silly, you could switch the {{token|CREATURE|e|DWARF}} entry in ``entity_default.txt`` with {{token|CREATURE|e|ELF}} and you would be marching elves around in fortress mode, although they would still use dwarven technology, [[Dwarven language|language]] and [[name]]s and so forth. Oh, and before you get any funny ideas - it ''is'' possible to define more than one creature for a civ, but that won't work in quite the way you probably expect; it will pick only one of the defined creatures at random to use for the civ. Later on, in the creature section, you'll learn about castes, which will provide a much more viable alternative, so try to bear with us until then.

{{token|TRANSLATION|e}} defines the language file that the entity will be using, which will determine what their native 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``, as well as the generated ``GEN_DIVINE`` and ``GEN_IDENTITY``.{{version|51.06-Lua}}

{{token|BIOME_SUPPORT|e}} defines the [[Biome token|biomes]] that civs will attempt to settle in. The ``FREQUENCY`` value determines the likelihood of them building there, but also raises an important point: most of the values you'll be setting for things are relative to each other. If one were to type:

{{code|
[BIOME_SUPPORT:ANY_FOREST:1]
[BIOME_SUPPORT:SAVANNA:2]
}}

This would have very much the same effect as:

{{code|
[BIOME_SUPPORT:ANY_FOREST:5]
[BIOME_SUPPORT:SAVANNA:10]
}}

This holds true for a lot of values throughout the files, excluding when it simply doesn't make sense, such as in materials. For more information, see [[entity token]]s.

Besides those mentioned, some fundamental ones are the {{token|SITE_CONTROLLABLE|e}} token, which lets you control the civ in fortress mode, and the {{token|ALL_MAIN_POPS_CONTROLLABLE|e}} token, which allows you to play a civ native (non-outsider) in adventure mode. Other tokens that you should pay attention to are {{token|START_BIOME|e}} and the ones regarding sites, but in general, you can just run through the aforementioned list and add or remove what you want.

Also see the creature-level {{token|OUTSIDER_CONTROLLABLE}} token, which allows you to play in adventure mode as an outsider.

By default, the game chooses a {{token|SITE_CONTROLLABLE|e}} civ (and therefore a species if there is more than one) at random when starting a fortress mode game. The group selection section on the embark screen lists all available civs and their primary creature.

You can also attempt to discern the civ yourself by the names it uses - this is the realm of [[Language#language_SYM|symbols]], collections of words centered around a specific concept. The civ will use words from whatever symbols are selected for it for various things. This association might be a little confusing at first, so, let's refer to the "MOUNTAIN" entity:

{{code|
[SELECT_SYMBOL:WAR:NAME_WAR]
[SUBSELECT_SYMBOL:WAR:VIOLENT]
[SELECT_SYMBOL:BATTLE:NAME_BATTLE]
[SUBSELECT_SYMBOL:BATTLE:VIOLENT]
[SELECT_SYMBOL:SIEGE:NAME_SIEGE]
[SUBSELECT_SYMBOL:SIEGE:VIOLENT]
}}

Here, we can see that dwarves will generally name their wars first after words in the "NAME_WAR" symbol group, and then, after words in the "[[language_SYM.txt/Violent|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 [[language_SYM.txt/Violent|VIOLENT]] with, say, [[language_SYM.txt/Peace|PEACE]] and end up with a battle called "The Clash of Calm" or something.

{{code|
[SELECT_SYMBOL:ROAD:NAME_ROAD]
[SELECT_SYMBOL:TUNNEL:NAME_TUNNEL]
[SELECT_SYMBOL:BRIDGE:NAME_BRIDGE]
[SELECT_SYMBOL:WALL:NAME_WALL]
}}

The above applies here. Dwarves are fond of naming their roads and tunnels after... roads and tunnels.

{{code|
[SELECT_SYMBOL:REMAINING:ARTIFICE]
[SELECT_SYMBOL:REMAINING:EARTH]
[CULL_SYMBOL:ALL:DOMESTIC]
[CULL_SYMBOL:ALL:SUBORDINATE]
[CULL_SYMBOL:ALL:EVIL]
[CULL_SYMBOL:ALL:UNTOWARD]
[CULL_SYMBOL:ALL:FLOWERY]
[CULL_SYMBOL:ALL:NEGATIVE]
[CULL_SYMBOL:ALL:UGLY]
[CULL_SYMBOL:ALL:NEGATOR]
}}

This section deals with everything else. The things that haven't already been dealt with (hence the ``REMAINING``) - such as site names, kingdom names, the names of individuals, and such - will have names from the [[language_SYM.txt/Artifice|ARTIFICE]] and [[language_SYM.txt/Peace|PEACE]] symbol groups. After that, the dwarf entity is told to cull all inappropriate symbols - this applies to everything (hence the ``ALL``) so if the game happens to choose a symbol associated with, say, [[language_SYM.txt/Evil|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 an entity 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, but that can be found in [[Advanced Entity Position Mechanics]].

==== Trade ====
The following [[entity token]]s affect the appearance of [[trading]] [[caravan]]s:

* {{token|ACTIVE_SEASON|e}} - Defines the seasons when an entity may visit your fortress.
* ``[[Entity token#PROGRESS_TRIGGER_POPULATION|[PROGRESS_TRIGGER_*]]]`` - Defines the triggers which control when an entity will become interested in your fortress.
* {{token|COMMON_DOMESTIC_PACK|e}} - Allows the civilization to use domestic pack animals. If an entity lacks pack animals (or ability to pull wagons), it will be unable to send caravans (showing as {{DFtext|No Trade|6:1}} at the [[embark]] screen), unless it has domesticated any suitable animal species or is forced to use a non-suitable creature by the {{token|ANIMAL|e}} definition {{token|ALWAYS_WAGON_PULLER|e}} on creature, caste or class.
* {{token|COMMON_DOMESTIC_PULL|e}} - Allows the civilization to use domestic animals to pull [[wagon]]s, assuming their ``[[Ethic#KILL_PLANT|[ETHIC:KILL_PLANT]]]`` permits them to use wagons in the first place.
* {{token|MERCHANT_BODYGUARDS|e}} - Caravan will be guarded by [[soldier]]s.

=== Modding creatures ===

Creature modding is great fun – you can change nearly any aspect of a creature, or make your own completely from scratch.

Modding creatures is very similar to modding civs: it's just a matter of editing, adding, or removing tokens, enclosed in square brackets underneath the creature's ``[CREATURE:]`` header. The creature entries contain all of the information about each and every non-random creature in the game, from animals to dwarves to goblins to even caravan wagons. A lot of the creature tokens are fairly self-explanatory; you can find a list of such tokens [[creature token|here]]. But before you start creating your own creatures, you'll want to learn how the tissues system works.

==== Creature materials and tissues ====

In the most basic sense, a creature is a series of body parts. These parts are defined in their own file, and we'll talk about them later, as a specific aspect of how creatures work, which throws off a lot of prospective modders, is the relationship between body parts, tissues, and materials. We're going to show you part of the [[bronze colossus/raw|creature entry]] for a [[bronze colossus]] (bear with us):

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:HUMANOID_JOINTS:5FINGERS:5TOES]
[NO_THOUGHT_CENTER_FOR_MOVEMENT]
[TISSUE:BRONZE]
[TISSUE_NAME:bronze:bronze]
[TISSUE_MATERIAL:INORGANIC:BRONZE]
[MUSCULAR]
[FUNCTIONAL]
[STRUCTURAL]
[RELATIVE_THICKNESS:1]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[TISSUE_LAYER:BY_CATEGORY:ALL:BRONZE]
...
}}

At the top, we can see the {{token|BODY}} token, followed by a list of body parts. As you've probably guessed, these parts make up the physical form of the colossus. But the colossus has to be made out of something - it has to have tissues, and those tissues also have to be made out of something - in this case, bronze.

Below the {{token|BODY}} token you'll see a {{token|TISSUE}} token, followed by an identifier, much like the others we've seen. The {{token|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 {{token|MUSCULAR|tissue}}, {{token|FUNCTIONAL|tissue}} and {{token|STRUCTURAL|tissue}} tokens. The tissue also references a material - ``[INORGANIC:BRONZE]`` - the properties of which are declared in the [[Inorganic material definition token|inorganic materials]] file ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/inorganic_metal.txt inorganic_metal.txt]``, and the tissue is subsequently made out of this material. With us so far?

Below the tissue definition is the {{token|TISSUE_LAYER}} line. {{token|TISSUE_LAYER}} allows you to control where each tissue is applied. Its first argument defines if it's to search by body part category (``BY_CATEGORY``), body part type (``BY_TYPE``), or look for a specific part (``BY_TOKEN``). That's followed by the parts argument itself, which is in this case ``ALL`` (so the game's looking for parts in all categories, which is to say, every body part). This is followed by the tissue to be applied, "BRONZE". So the {{token|TISSUE_LAYER}} token is telling the game to select all body parts in every category and make them out of the tissue "BRONZE". The colossus is now made of [[bronze]].

By now, you're probably thinking "Wow, if this was for a creature made out of however many tissues, this would be amazingly longwinded!" and you're right. Luckily, there are two methods by which we can speed things up a lot.

Firstly, there are material and tissue templates. Let's say you were going to make a lot of creatures out of bronze, and you didn't want to have to copy and paste the bronze tissue all over the place. Instead, you create a tissue template. This goes, as you've probably guessed, in a tissue template file.

{{code|
[TISSUE_TEMPLATE:BRONZE_TEMPLATE]
[TISSUE_NAME:bronze:bronze]
[TISSUE_MATERIAL:INORGANIC:BRONZE]
[MUSCULAR]
[FUNCTIONAL]
[STRUCTURAL]
[RELATIVE_THICKNESS:1]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
}}

Now, instead of applying the tissue to each and every bronze creature you're making, you can just refer to the template:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:HUMANOID_JOINTS:5FINGERS:5TOES]
[NO_THOUGHT_CENTER_FOR_MOVEMENT]
[USE_TISSUE_TEMPLATE:BRONZE:BRONZE_TEMPLATE]
[TISSUE_LAYER:BY_CATEGORY:ALL:BRONZE]
...
}}

Material templates work in the same way, but refer to materials instead of tissues.

However, if we're looking at something like a dwarf, even with the templates, editing can get very slow indeed:

{{code|
...
[USE_MATERIAL_TEMPLATE:SKIN:SKIN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:FAT:FAT_TEMPLATE]
[USE_MATERIAL_TEMPLATE:MUSCLE:MUSCLE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:BONE:BONE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:CARTILAGE:CARTILAGE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:HAIR:HAIR_TEMPLATE]
[USE_MATERIAL_TEMPLATE:TOOTH:TOOTH_TEMPLATE]
[USE_MATERIAL_TEMPLATE:EYE:EYE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:NERVE:NERVE_TEMPLATE]
[USE_MATERIAL_TEMPLATE:BRAIN:BRAIN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:LUNG:LUNG_TEMPLATE]
[USE_MATERIAL_TEMPLATE:HEART:HEART_TEMPLATE]
[USE_MATERIAL_TEMPLATE:LIVER:LIVER_TEMPLATE]
[USE_MATERIAL_TEMPLATE:GUT:GUT_TEMPLATE]
[USE_MATERIAL_TEMPLATE:STOMACH:STOMACH_TEMPLATE]
[USE_MATERIAL_TEMPLATE:PANCREAS:PANCREAS_TEMPLATE]
[USE_MATERIAL_TEMPLATE:SPLEEN:SPLEEN_TEMPLATE]
[USE_MATERIAL_TEMPLATE:KIDNEY:KIDNEY_TEMPLATE]
[USE_TISSUE_TEMPLATE:SKIN:SKIN_TEMPLATE]
[USE_TISSUE_TEMPLATE:FAT:FAT_TEMPLATE]
[USE_TISSUE_TEMPLATE:MUSCLE:MUSCLE_TEMPLATE]
...
}}

This is where [[Body detail plan token|body detail plans]], which have their own file, and are designed to help automate some of the more common processes in creature creation, come in. The first entry in ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/b_detail_plan_default.txt b_detail_plan_default.txt]`` does exactly what we've been trying to do above: it takes all the common materials and shoves them into one plan, which can be referenced with a single token.

{{code|
...
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
...
}}

Much easier. But what about the {{token|TISSUE_LAYER}} tokens? Will we have to type out all of those manually? Nope, detail plans have that covered as well. It's possible to place variable arguments into a detail plan. For example:

{{code|
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS]
[BP_LAYERS:BY_CATEGORY:BODY:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:BODY_UPPER:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:BODY_LOWER:ARG3:50:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:ARM:ARG4:25:ARG3:25:ARG2:5:ARG1:1]
[BP_LAYERS:BY_CATEGORY:ARM_UPPER:ARG4:25:ARG3:25:ARG2:5:ARG1:1]
...
[BP_LAYERS:BY_CATEGORY:NOSE:ARG5:4:ARG1:1]
...
}}

First, an argument is placed in the plan (``ARG1``, ``ARG2`` etc.), followed by the thickness of the tissue that will be inserted in place of the argument. So when we reference the "VERTEBRATE_TISSUE_LAYERS" plan, we'll be able to do something like this:

{{code|
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
}}

``ARG1`` in the detail plan is replaced by "SKIN", the first tissue we entered. ``ARG2`` is replaced by "FAT", ``ARG3`` by "MUSCLE", ``ARG4`` by "BONE", and ``ARG5`` by "CARTILAGE". Hence, our creature's body part designated as {{token|CATEGORY|body|BODY}} is made up of "SKIN" with thickness 1, "FAT" with thickness 5, and "MUSCLE" with thickness 50. Its nose is made up of "SKIN" (thickness 1) and "CARTILAGE" (thickness 4).

Things left out of the body plans aside, our dwarf's entire body, material, tissue and tissue layer tokens have been boiled down to this:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:2LUNGS:HEART:GUTS:ORGANS:HUMANOID_JOINTS:
THROAT:NECK:SPINE:BRAIN:SKULL:5FINGERS:5TOES:MOUTH:FACIAL_FEATURES:TEETH:RIBCAGE]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
...
}}

This can save you a lot of time and space if you're making lots of changes common to many creatures. In general, if you're making a creature that's fleshy or chitinous, there are detail plans already included in the game to help you out. You should only have to resort to declaring tissues individually (like our bronze colossus) if you're doing something really out-of-the-ordinary.

Another great thing about templates (and so, detail plans) is that they can be modified after being declared. Let's say we wanted our dwarves to be perpetually on fire (don't ask). We leave the body stuff declared normally:

{{code|
...
[BODY:HUMANOID:2EYES:2EARS:NOSE:2LUNGS:HEART:GUTS:ORGANS:HUMANOID_JOINTS:
THROAT:NECK:SPINE:BRAIN:SKULL:5FINGERS:5TOES:MOUTH:FACIAL_FEATURES:TEETH:RIBCAGE]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE]
...
}}

We then, in our own mod, select the appropriate material:

{{code|
[SELECT_CREATURE:DWARF]
[SELECT_MATERIAL:SKIN]
[MAT_FIXED_TEMP:10600]
...
}}

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

{{code|
[SELECT_CREATURE:DWARF]
[SELECT_MATERIAL:SKIN]
[MAT_FIXED_TEMP:10600]
[SELECT_MATERIAL:ALL]
[HEATDAM_POINT:NONE]
...
}}

Note that this makes use of DF's built-in temperature scale - you can read more about that [[Temperature|on this page]]. We're also referencing [[material definition token]]s, 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 ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/creature_subterranean.txt creature_subterrenean.txt]``:

{{code|
...
[CASTE:WORKER]
[CASTE_NAME:worker ant woman:worker ant women:worker ant woman]
Female, but non-breeding.
[POP_RATIO:10000]
[CASTE:SOLDIER]
[CASTE_NAME:soldier ant woman:soldier ant women:soldier ant woman]
Female, but non-breeding.
[POP_RATIO:1000]
[CASTE:DRONE]
[MALE]
[CASTE_NAME:drone ant man:drone ant men:drone ant man]
[POP_RATIO:5]
[CASTE:QUEEN]
[FEMALE]
[CASTE_NAME:queen ant woman:queen ant women:queen ant woman]
[POP_RATIO:1]
[SELECT_CASTE:WORKER]
[SELECT_ADDITIONAL_CASTE:SOLDIER]
[SELECT_ADDITIONAL_CASTE:QUEEN]
[BODY:HUMANOID_4ARMS:2EYES:HEART:GUTS:BRAIN:MOUTH]
[BODYGLOSS:INSECT_UPPERBODY:INSECT_LOWERBODY]
[SELECT_CASTE:DRONE]
[BODY:HUMANOID_4ARMS:2EYES:HEART:GUTS:BRAIN:MOUTH:2WINGS]
[BODYGLOSS:INSECT_UPPERBODY:INSECT_LOWERBODY]
[FLIER]
[SELECT_CASTE:ALL]
[BODY_DETAIL_PLAN:CHITIN_MATERIALS]
[BODY_DETAIL_PLAN:CHITIN_TISSUES]
[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:CHITIN:FAT:MUSCLE]
[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS]
[ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP]
[ATTACK_SKILL:GRASP_STRIKE]
[ATTACK_VERB:punch:punches]
...
}}

It's evident that the process of creating and editing castes is comparable to the modifications we were making to tissues and materials earlier: A caste is declared, and modifications to the base creature are made. Declared castes can be selected and subsequently modified, again, just like tissues and materials.

In this case, each caste is declared, given its own name, and a {{token|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 {{token|MALE}} and {{token|FEMALE}} tokens respectively - these tokens determine how breeding works. A creature without both a {{token|MALE}} caste and a {{token|FEMALE}} caste will be unable to breed (no asexually reproducing creatures yet, unfortunately). As they lack {{token|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 {{token|FLIER}} token, which the other castes lack. It's entirely possible for creatures of different castes to have completely different body structures, even to the extent that they don't resemble each other at all. If you read the section of this guide that dealt with entities, you may remember a passing mention of multi-creature civilisations and how they don't quite work as you may think they would. The castes system is your workaround. You could create a caste that is, for all intents and purposes, a human, and another caste of the same creature that acts exactly like a giant cave spider, put the creature in a civ, and get a human-spider civ. The only flaw in this approach is that the castes will interbreed and produce offspring of either caste.

That's the most complex components of creature creation out of the way. You should find the rest trivial by comparison.

=== Modding items ===

Items are fairly simple to deal with. By default, each item type is contained in its own file; this may help make browsing for a specific item easier, but from a purely technical point of view, it's possible to throw all items into one file. Unfortunately, [[Item definition token]]s don't seem to be especially well-documented (at least not as well as the other object types), but you should be able to figure out most things by way of our explanations and your assumptions.

Let's look at the entry for, of course, the thong:

{{code|
[ITEM_PANTS:ITEM_PANTS_THONG]
[NAME:thong:thongs]
[LAYER:UNDER]
[COVERAGE:25]
[LAYER_SIZE:10]
[LAYER_PERMIT:30]
[MATERIAL_SIZE:1]
[SOFT]
[LEATHER]
[STRUCTURAL_ELASTICITY_WOVEN_THREAD]
}}

Most of these are pretty obvious if one compares them to the other entries in the file. There's a layer for the item, determining where it's worn; a coverage value to determine how well it protects you from cold and other things; a size token to determine how much it counts for when it's under something else; a layer permit token to determine how much can be worn under it; and a material size token to determine how much raw material it takes to make it.

Now, if you wanted to mod these to turn them into metal thongs (ouch!), you would simply have to add {{token|METAL|armor}} to it somewhere. Simple! These tokens work by tying into material properties - some materials are designated as suitable for making hard items, some for soft, etc..

Weapons involve a little more detail:

{{code|
[ITEM_WEAPON:ITEM_WEAPON_SWORD_2H]
[NAME:two-handed sword:two-handed swords]
[SIZE:900]
[SKILL:SWORD]
[TWO_HANDED:67500]
[MINIMUM_SIZE:62500]
[MATERIAL_SIZE:5]
[ATTACK:EDGE:100000:8000:slash:slashes:NO_SUB:1250]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:EDGE:50:4000:stab:stabs:NO_SUB:1000]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:BLUNT:100000:8000:slap:slaps:flat:1250]
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK:BLUNT:100:1000:strike:strikes:pommel:1000]
[ATTACK_PREPARE_AND_RECOVER:3:3]
}}

{{token|SIZE|wp}} determines how heavy the weapon is. This has a substantial effect on weapon effectiveness. {{token|SKILL|wp}} determines which skill is used in using the weapon; a list of skills can be found [[skill token|on this page]]. {{token|MINIMUM_SIZE|wp}} determines the minimum size a creature must be before the weapon can be wielded, while {{token|TWO_HANDED|wp}} determines how large a creature must be in order to wield the weapon with one hand.

Attacks take a little more explanation. The first value determines the contact area of the weapon's attack; this should be high for slashing weapons and low for bludgeoning, piercing and poking ones. The second value determines how deep the weapon penetrates - for ``BLUNT`` attacks this value is ignored as they're not supposed to penetrate anyway, but in the case of ``EDGE`` attacks it should generally be lower for slashing attacks and higher for stabbing attacks.

Following these are the nouns and verb used; they should be self-explanatory. Finally, we have the velocity modifier, which has a multiplying effect on the weapon's size for the purposes of determining how powerful it is in combat. But more accurate it describe distribution of momentum across length of weapon. So "STAB" perfomed with only muscular power and modifier is x1 (1000). "SLASH" performed with some rotating momentum of cutting edge, but sword is pretty balanced thru it's length and modifier is just x1.25 (1250). Axes, hammers and maces have more unbalanced mass distribution and weapon mass concentrated far from grasp, so higher modifiers.

{{token|ATTACK_PREPARE_AND_RECOVER|weapon}} determines number of game frames to perform these actions. In vanilla, all attacks except [[whip|lashing]] use 3:3.

Other, more miscellaneous items are generally simple and shouldn't require any further explanation.

Once you've made an item, you just add it to the civ entry so a civilization can actually craft it, and it's done.

=== Modding language files ===
{{main|Language token}}

Let's say you added a whole new species. Sure, you could just swipe one of the existing translation files and steal their language for your species, but that's the lazy way! If you want to create a whole new language, it is very simple.

First, you'd need a whole new "language_NAME.txt" file, such as "language_LIZARDMAN.txt", along with "language_LIZARDMAN" at the top of the file, followed by ``[OBJECT:LANGUAGE]`` and ``[TRANSLATION:LIZARDMAN]``. After that, it's just a matter of copy-pasting one of the existing language lists and editing the finished 'translated' word. That's it! Then just add the translation link to your civ in entity_default.txt and it'll be added to the game on worldgen.

All raw files use [[Character table|Code Page 437]] encoding, and you should make sure you are editing these files in that format. As many text editors default to UTF-8, some characters with diacritical marks may fail to show properly. Saving one of the default language raw files in this state will overwrite these characters with the Unicode question mark, which will corrupt the file. To fix this replace the file with a clean one downloaded from the distributed version of DF.

(Note that the name of the file doesn't actually matter; but it's typical to name the file after a creature if it's exclusive to their civilization.)

=== 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 ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/body_default.txt body_default.txt]`` and then linked to a creature in the creature's entry. We've talked about how bodyparts make up creatures earlier, in the creature section. You can mix and match them in the creature entry and it makes no difference, as long as they're there: each body part will link itself to the appropriate connection automatically when the creature is first created.

Body parts work by sections: you can add as many sections as you want to a body part definition, but generally you should keep it fairly low for ease of use. Each body section entry is in the, very simple, format:

{{code|
[BODY:BODYNAME]
[BP:TOKENID:name][TOKENSGOHERE][DEFAULT_RELSIZE:][CATEGORY:WHATEVER]
}}

The most important tokens are {{token|CONTYPE|body}} and {{token|CON|body}}: {{token|CONTYPE|body}} means the body part in question is connected to a certain ''type'' of body part, while {{token|CON|body}} 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 {{token|CON|body}} or ``BY_TOKEN``. {{token|DEFAULT_RELSIZE|body}} defines, of course, what the body part's size is in relation to the other parts. {{token|CATEGORY|body}} defines a category for the part, which can be unique or shared with other parts. This is referenced whenever ``BY_CATEGORY`` is used.

A list of body part tokens can be found [[body token|here]].

Let's take a simple example, a head:

{{code|
[BODY:BASIC_HEAD]
[BP:HD:head:STP][CONTYPE:UPPERBODY][HEAD][CATEGORY:HEAD]
[DEFAULT_RELSIZE:300]
}}

It connects directly to an upper body.

{{code|
[BODY:2EYES]
[BP:REYE:right eye:STP][CONTYPE:HEAD][SIGHT][EMBEDDED][SMALL][RIGHT][CATEGORY:EYE]
[DEFAULT_RELSIZE:5]
[BP:LEYE:left eye:STP][CONTYPE:HEAD][SIGHT][EMBEDDED][SMALL][LEFT][CATEGORY:EYE]
[DEFAULT_RELSIZE:5]
}}

These are a pair of eyes, connecting to the head.

{{code|
[BODY:HUMANOID]
[BP:UB:upper body:upper bodies][UPPERBODY][CATEGORY:BODY_UPPER]
[DEFAULT_RELSIZE:1000]
[BP:LB:lower body:lower bodies][CON:UB][LOWERBODY][CATEGORY:BODY_LOWER]
[DEFAULT_RELSIZE:1000]
[BP:HD:head:STP][CON:UB][HEAD][CATEGORY:HEAD]
[DEFAULT_RELSIZE:300]
[BP:RUA:right upper arm:STP][CON:UB][LIMB][RIGHT][CATEGORY:ARM_UPPER]
[DEFAULT_RELSIZE:200]
[BP:LUA:left upper arm:STP][CON:UB][LIMB][LEFT][CATEGORY:ARM_UPPER]
[DEFAULT_RELSIZE:200]
[BP:RLA:right lower arm:STP][CON:RUA][LIMB][RIGHT][CATEGORY:ARM_LOWER]
[DEFAULT_RELSIZE:200]
[BP:LLA:left lower arm:STP][CON:LUA][LIMB][LEFT][CATEGORY:ARM_LOWER]
[DEFAULT_RELSIZE:200]
[BP:RH:right hand:STP][CON:RLA][GRASP][RIGHT][CATEGORY:HAND]
[DEFAULT_RELSIZE:80]
[BP:LH:left hand:STP][CON:LLA][GRASP][LEFT][CATEGORY:HAND]
[DEFAULT_RELSIZE:80]
[BP:RUL:right upper leg:STP][CON:LB][LIMB][RIGHT][CATEGORY:LEG_UPPER]
[DEFAULT_RELSIZE:500]
[BP:LUL:left upper leg:STP][CON:LB][LIMB][LEFT][CATEGORY:LEG_UPPER]
[DEFAULT_RELSIZE:500]
[BP:RLL:right lower leg:STP][CON:RUL][LIMB][RIGHT][CATEGORY:LEG_LOWER]
[DEFAULT_RELSIZE:400]
[BP:LLL:left lower leg:STP][CON:LUL][LIMB][LEFT][CATEGORY:LEG_LOWER]
[DEFAULT_RELSIZE:400]
[BP:RF:right foot:right feet][CON:RLL][STANCE][RIGHT][CATEGORY:FOOT]
[DEFAULT_RELSIZE:120]
[BP:LF:left foot:left feet][CON:LLL][STANCE][LEFT][CATEGORY:FOOT]
[DEFAULT_RELSIZE:120]
}}

An entire humanoid body. The foot bone's connected to the ankle bone...

``[[Bodygloss|[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 definition ``[BODYGLOSS:CLAW_HAND:hand:claw]`` in ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/body_default.txt 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 ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/plant_standard.txt plant_standard.txt]`` should explain most things. Here's the list of [[Plant token]]s.

Below is the [[plump helmet]] raw description:

{{code|
[PLANT:MUSHROOM_HELMET_PLUMP]
[NAME:plump helmet][NAME_PLURAL:plump helmets][ADJ:plump helmet]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PICKED_TILE:6][PICKED_COLOR:5:0: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]
[STATE_COLOR:ALL:AMETHYST]
[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:58]
[DEAD_SHRUB_TILE:58]
[SHRUB_COLOR:5:0:0]
[DEAD_SHRUB_COLOR:0:0:1]
}}

Let's look at this line by line: 
First, we define its file name. In this case it's "MUSHROOM_HELMET_PLUMP". Next we define its in-game name, "plump helmet" and its adjective for if you were to craft with its materials (e.g. {{DFtext|plump helmet plant earrings}}).

{{code|
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

This defines the structure and material of the plant. It references "STRUCTURAL_PLANT_TEMPLATE" in the first line, so if you were to say, add wings to the template, the plump helmet plant would be winged. This is for the plant itself, not the end plump helmets.

After that we get our edible tokens. These say that [[vermin]] can eat the plant, and it can be eaten raw or cooked by your dwarves. So if you wanted a plant that vermin would leave alone, you'd remove the {{token|EDIBLE_VERMIN|md}} token.

{{code|
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
}}

Next, {{token|PICKED_TILE|p|6}} is the character (6, or ♠) shown when the crop is harvested. See [[Main:Character table|character table]] for a table of usable tiles. {{token|PICKED_COLOR|p|5:0:0}} is the [[color]] used for the crop's tile when harvested. It's in a ``<foreground>:<background>:<brightness>`` format, resulting in a purple spade: {{Tile|♠|5:0}}

{{code|
[PICKED_TILE:6][PICKED_COLOR:5:0:0]
}}

{{token|GROWDUR|p|300}} is how long it takes for your crop to grow. There are 1008 growdur units in a [[Time|season]]. You can calculate this value [https://jose96xd.github.io/DF_Tools/Modules/TimeConverter.html here]. 
{{token|VALUE|p|2}} is the [[item value]] of the harvested plant (default 1).

{{code|
[GROWDUR:300][VALUE:2]
}}

This defines the plant's alcohol states. {{token|STATE_NAME_ADJ|ALL_SOLID|md}} is the frozen name, followed is the actual drink name, and then its boiling name. Drinks can evaporate and freeze in Scorching or Freezing [[Temperature|climates]], respectively.

{{token|DISPLAY_COLOR|md}} is ASCII color, and {{token|STATE_COLOR|md}} is a [[Color#Color tokens|named color]] linked to a graphical [[palette]].

{{token|EDIBLE_RAW|md}} and {{token|EDIBLE_COOKED|md}} are saying you can drink the alcohol raw or cooked.

{{code|
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen dwarven wine]
[STATE_NAME_ADJ:LIQUID:dwarven wine]
[STATE_NAME_ADJ:GAS:boiling dwarven wine]
[STATE_COLOR:ALL:AMETHYST]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:5:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
}}

After that we get our seed template:

{{code|
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[EDIBLE_COOKED]
[SEED:plump helmet spawn:plump helmet spawn:4:0:1:LOCAL_PLANT_MAT:SEED]
}}

And all this says is that the seeds may be eaten by vermin or cooked. Then it gives the name of our plant's seed, its plural name, its foreground, background, and brightness colors, followed by its seed material; said material should have {{token|SEED_MAT|p}} to permit proper stockpiling.

And finally for the last chunk we have this:

{{code|
[SPRING][SUMMER][AUTUMN][WINTER]
[FREQUENCY:100]
[CLUSTERSIZE:5]
[PREFSTRING:rounded tops]
[WET][DRY]
[BIOME:SUBTERRANEAN_WATER]
[UNDERGROUND_DEPTH:1:3]
[SHRUB_TILE:58]
[DEAD_SHRUB_TILE:58]
[SHRUB_COLOR:5:0:0]
[DEAD_SHRUB_COLOR:0:0:1]
}}

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. {{token|PREFSTRING|p}} is what your dwarves [[Preference|like]] about the plant, which in this case is the rounded tops. {{token|WET|p}}{{token|DRY|p}} 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. 
{{token|BIOME|p}} is what [[Biome token|biome]] the plant grows in. {{token|UNDERGROUND_DEPTH:Minimum:Maximum|p}} Is the highest and lowest cavern levels that the plant can appear in if its biome is subterranean. Dwarven civilizations will only export (via the embark screen or caravans) things that are available at depth 1. Defaults to ``0:0`` (surface only). 
Lastly, {{token|SHRUB_TILE|p}} is the character used for the naturally spawning [[shrub]] of this plant, {{token|DEAD_SHRUB|p}} is the dead shrub character. {{token|SHRUB_COLOR|p}} Is the shrub's color, and {{token|DEAD_SHRUB_COLOR|p}} is, of course, the dead shrub's color.

Plump helmet shrubs look like {{Tile|:|5:0}}.

While this may or may not look like a lot of tokens, it's very easy. Just copy an existing plant and edit it to your new plant. 
For the rest of the tokens, see [[plant token]].

==== Trees ====

[[Tree]]s are another kind of plant that can be modded. Being plants, they use many of the same tokens as edible crops, but differ in having a few tree-specific tokens.

Below is the [[apple|apple tree]] raw description:

{{code|
[PLANT:APPLE] malus sieversii
[NAME:apple tree][NAME_PLURAL:apple trees][ADJ:apple tree]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[USE_MATERIAL_TEMPLATE:WOOD:WOOD_TEMPLATE]
[STATE_NAME:ALL_SOLID:apple wood]
[STATE_ADJ:ALL_SOLID:apple wood]
[PREFIX:NONE]
[SOLID_DENSITY:745] *** http://www.csudh.edu/oliver/chemdata/woods.htm
[STATE_COLOR:ALL_SOLID:CHOCOLATE] *** http://www.forestryforum.com/board/index.php/topic,61009.0.html
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen apple cider]
[STATE_NAME_ADJ:LIQUID:apple cider]
[STATE_NAME_ADJ:GAS:boiling apple cider]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:6:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
[USE_MATERIAL_TEMPLATE:LEAF:LEAF_TEMPLATE]
[STATE_COLOR:ALL:GREEN]
[DISPLAY_COLOR:2:0:0]
[USE_MATERIAL_TEMPLATE:FLOWER:FLOWER_TEMPLATE]
[STATE_COLOR:ALL:ROSE]
[DISPLAY_COLOR:5:0:1]
[USE_MATERIAL_TEMPLATE:FRUIT:FRUIT_TEMPLATE]
[STATE_COLOR:ALL:RUST]
[DISPLAY_COLOR:4:0:0]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[STOCKPILE_PLANT_GROWTH]
[MATERIAL_REACTION_PRODUCT:DRINK_MAT:LOCAL_PLANT_MAT:DRINK]
[MATERIAL_REACTION_PRODUCT:SEED_MAT:LOCAL_PLANT_MAT:SEED]
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[SEED:apple seed:apple seeds:0:0:1:LOCAL_PLANT_MAT:SEED]
[TREE:LOCAL_PLANT_MAT:WOOD][TREE_TILE:5]
[TRUNK_PERIOD:10]
[HEAVY_BRANCH_DENSITY:25]
[BRANCH_DENSITY:50]
[MAX_TRUNK_HEIGHT:3]
[HEAVY_BRANCH_RADIUS:1]
[BRANCH_RADIUS:2]
[TRUNK_BRANCHING:2]
[MAX_TRUNK_DIAMETER:1]
[TRUNK_WIDTH_PERIOD:200]
[ROOT_DENSITY:5]
[ROOT_RADIUS:3]
[STANDARD_TILE_NAMES]
[PREFSTRING:fruit]
[DRY]
[BIOME:ANY_TEMPERATE]
[SAPLING]
[GROWTH:LEAVES]
[GROWTH_NAME:apple leaf:apple leaves]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:LEAF]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_HOST_TILE:SAPLING]
[GROWTH_TIMING:0:300000]
[GROWTH_PRINT:0:6:2:0:0:0:209999:1]
[GROWTH_PRINT:0:6:6:0:1:210000:239999:1] autumn color
[GROWTH_PRINT:0:6:4:0:1:240000:269999:1]
[GROWTH_PRINT:0:6:4:0:0:270000:300000:1]
[GROWTH_DROPS_OFF]
[GROWTH:FLOWERS]
[GROWTH_NAME:apple flower:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FLOWER]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:60000:119999]
[GROWTH_PRINT:5:5:5:0:1:60000:119999:2]
[GROWTH:FRUIT]
[GROWTH_NAME:apple:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FRUIT]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:120000:200000]
[GROWTH_DROPS_OFF_NO_CLOUD]
[GROWTH_PRINT:'%':'%':4:0:0:120000:200000:3]
[GROWTH_HAS_SEED]
}}

The first lines are the same as the ones we saw being used in the plump helmets, defining the plant object, giving it a name, and setting up the basic materials.

{{code|
[PLANT:APPLE] malus sieversii
[NAME:apple tree][NAME_PLURAL:apple trees][ADJ:apple tree]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

Adding the token {{token|DISPLAY_COLOR|md}} (ASCII) / {{token|STATE_COLOR|md}} ([[graphics]]) directly after {{token|USE_MATERIAL_TEMPLATE|plant}} would allow us to change the color of the tree.

{{code|
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[DISPLAY_COLOR:1:0:0]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
}}

would give us a {{DFtext|dark blue|1:0}} apple tree. This method is used by the game by [[birch|birches]] and [[spore tree|various]] [[nether-cap|underground]] [[blood thorn|trees]].

Next come the definitions of various other materials used by the tree:

{{code|
[USE_MATERIAL_TEMPLATE:WOOD:WOOD_TEMPLATE]
[STATE_NAME:ALL_SOLID:apple wood]
[STATE_ADJ:ALL_SOLID:apple wood]
[PREFIX:NONE]
[SOLID_DENSITY:745] *** http://www.csudh.edu/oliver/chemdata/woods.htm
[STATE_COLOR:ALL_SOLID:CHOCOLATE] *** http://www.forestryforum.com/board/index.php/topic,61009.0.html
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen apple cider]
[STATE_NAME_ADJ:LIQUID:apple cider]
[STATE_NAME_ADJ:GAS:boiling apple cider]
[MATERIAL_VALUE:2]
[DISPLAY_COLOR:6:0:0]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
[USE_MATERIAL_TEMPLATE:LEAF:LEAF_TEMPLATE]
[STATE_COLOR:ALL:GREEN]
[DISPLAY_COLOR:2:0:0]
[USE_MATERIAL_TEMPLATE:FLOWER:FLOWER_TEMPLATE]
[STATE_COLOR:ALL:ROSE]
[DISPLAY_COLOR:5:0:1]
[USE_MATERIAL_TEMPLATE:FRUIT:FRUIT_TEMPLATE]
[STATE_COLOR:ALL:RUST]
[DISPLAY_COLOR:4:0:0]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[STOCKPILE_PLANT_GROWTH]
[MATERIAL_REACTION_PRODUCT:DRINK_MAT:LOCAL_PLANT_MAT:DRINK]
[MATERIAL_REACTION_PRODUCT:SEED_MAT:LOCAL_PLANT_MAT:SEED]
[USE_MATERIAL_TEMPLATE:SEED:SEED_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[SEED:apple seed:apple seeds:0:0:1:LOCAL_PLANT_MAT:SEED]
}}

From them, we get to know what the parts of the tree can be used for, as well as how they will appear when separated from the tree. Any alterations that can be done to materials normally can be done here, such as changing the value or adding a [[syndrome]].

[TREE:LOCAL_PLANT_MAT:WOOD][TREE_TILE:5]

{{token|TREE|p}} is what turns your plant object into an actual tree. The following argument describes what material the harvested logs should be made of. If ``NONE``, the felled tree will give no logs. {{token|TREE_TILE|p}} is the tile the tree shows up as on the world map, in this case {{Tile|♣|2:1}}.

Note that all vanilla trees (that give logs) use the "WOOD" material defined above as the argument for {{token|TREE|p}}, as opposed to the "STRUCTURAL" material. Thus, any changes to the properties of the wood harvested should be done to the "WOOD" material.

The following tokens decide the dimensions of the tree, and how it grows.

{{code|
[TRUNK_PERIOD:10]
[HEAVY_BRANCH_DENSITY:25]
[BRANCH_DENSITY:50]
[MAX_TRUNK_HEIGHT:3]
[HEAVY_BRANCH_RADIUS:1]
[BRANCH_RADIUS:2]
[TRUNK_BRANCHING:2]
[MAX_TRUNK_DIAMETER:1]
[TRUNK_WIDTH_PERIOD:200]
[ROOT_DENSITY:5]
[ROOT_RADIUS:3]
}}

{{token|TRUNK_PERIOD|p}} and {{token|TRUNK_WIDTH_PERIOD|p}} determine how long it takes for the trunk to grow one tile taller respectively wider, in years. {{token|MAX_TRUNK_HEIGHT|p|3}} and {{token|MAX_TRUNK_DIAMETER|p|1}} determine the maximum value the above can reach. {{token|TRUNK_BRANCHING|p}} decides how "curvy" the tree is, with {{token|TRUNK_BRANCHING|p|0}} meaning the tree is entirely straight.

{{token|HEAVY_BRANCH_DENSITY|p|25}}, {{token|HEAVY_BRANCH_RADIUS|p|1}}, {{token|BRANCH_DENSITY|p|50}}, {{token|BRANCH_RADIUS|p|2}}, {{token|ROOT_DENSITY|p|5}}, and {{token|ROOT_RADIUS|p|3}} determine the density (how many are there, integer ranging 0-100) and radius (in tiles) away from the trunk, of heavy branches, normal branches and roots respectively.

{{token|STANDARD_TILE_NAMES|p}} makes the tree use standard names for the trunk, branches etc. Otherwise custom ones can be used. (see [[Plant_token|full plant token list]])

{{token|SAPLING|p}} ensures saplings of this tree are called "[tree name] sapling", instead of the standard "young [tree name]".

Lastly, we are introduced to the {{token|GROWTH|p}} token. {{token|GROWTH|p}} defines growths growing on a plant, in this case our apple tree. Apple trees have three growths: leaves, flowers and fruits.

{{code|
[GROWTH:FRUIT]
[GROWTH_NAME:apple:STP]
[GROWTH_ITEM:PLANT_GROWTH:NONE:LOCAL_PLANT_MAT:FRUIT]
[GROWTH_DENSITY:1000]
[GROWTH_HOST_TILE:BRANCHES_AND_TWIGS]
[GROWTH_TIMING:120000:200000]
[GROWTH_DROPS_OFF_NO_CLOUD]
[GROWTH_PRINT:'%':'%':4:0:0:120000:200000:3]
[GROWTH_HAS_SEED]
}}

First comes the name of the growth. Then, with {{token|GROWTH_ITEM|p}}, what kind of growth it is, in this case a {{token|PLANT_GROWTH|i}} made out of the local "FRUIT" material. {{token|GROWTH_DENSITY|p}} says how densely the growth grows, and {{token|GROWTH_HOST_TILE|p}} where on the tree it grows. {{token|GROWTH_TIMING|p}} decides when the growth appears, in [[Time|annual ticks]]. The growth then drops off, leaving no clouds (items to be picked up by your dwarves). {{token|GROWTH_PRINT|p}} sets it to look like {{Tile|%|4:0}}, and {{token|GROWTH_HAS_SEED|p}} implies that eating this growth will leave you with a seed.

=== Workshops ===

Workshops are raw-designed pretty differently from everything else in the game, being buildable structures rather than items or methods to gain items. However, they are fairly simple. For example, here's the raw for the [[soap maker's workshop]]:

{{code|code=
[BUILDING_WORKSHOP:SOAP_MAKER]
[NAME:Soap Maker's Workshop]
[NAME_COLOR:7:0:1]
[DIM:3:3]
[WORK_LOCATION:2:2]
[BUILD_LABOR:SOAP_MAKER]
[BUILD_KEY:CUSTOM_SHIFT_P]
[BLOCK:1:0:0:0] workbenches no longer block
[BLOCK:2:0:0:0]
[BLOCK:3:0:0:0]
[TILE:0:1:' ':' ':150]
[TILE:0:2:' ':' ':'/']
[TILE:0:3:'-':' ':' ']
[COLOR:0:1:0:0:0:0:0:0:6:0:0]
[COLOR:0:2:0:0:0:0:0:0:6:0:0]
[COLOR:0:3:6:0:0:0:0:0:0:0:0]
[TILE:1:1:' ':' ':'=']
[TILE:1:2:'-':' ':8]
[TILE:1:3:' ':' ':150]
[COLOR:1:1:0:0:0:0:0:0:6:0:0]
[COLOR:1:2:6:0:0:0:0:0:6:0:0]
[COLOR:1:3:0:0:0:0:0:0:6:0:0]
[TILE:2:1:'-':' ':8]
[TILE:2:2:' ':' ':8]
[TILE:2:3:' ':150:' ']
[COLOR:2:1:6:0:0:0:0:0:6:0:0]
[COLOR:2:2:0:0:0:0:0:0:6:0:0]
[COLOR:2:3:0:0:0:6:0:0:0:0:0]
[TILE:3:1:150:' ':8]
[TILE:3:2:' ':' ':8]
[TILE:3:3:' ':240:' ']
[COLOR:3:1:6:0:0:0:0:0:6:7:0]
[COLOR:3:2:0:0:0:0:0:0:6:7:0]
[COLOR:3:3:0:0:0:7:0:1:0:0:0]
[BUILD_ITEM:1:BUCKET:NONE:NONE:NONE][EMPTY][CAN_USE_ARTIFACT]
[BUILD_ITEM:1:NONE:NONE:NONE:NONE][BUILDMAT][WORTHLESS_STONE_ONLY][CAN_USE_ARTIFACT]
[TOOLTIP:Use tallow (rendered fat) or oil here with lye to make soap.]
}}

A line-by-line breakdown:

{{code|
[NAME:Soap Maker's Workshop]
[NAME_COLOR:7:0:1]
}}

These define the name of the workshop ({{DFtext|Soap Maker's Workshop|7:1}}) and [[color]] of the workshop's name when examined.

{{code|
[DIM:3:3]
[WORK_LOCATION:2:2]
}}

{{token|DIM|b}} refers to how large the workshop will be, in this case 3 wide, 3 tall. {{token|WORK_LOCATION|b}} tells where the creature using it (usually a dwarf) will work, numbered from the top right--in this case, ``2:2``, or the middle. Multiple work locations can be defined, even outside the dim.

{{code|
[BUILD_LABOR:SOAP_MAKER]
[BUILD_KEY:CUSTOM_SHIFT_S]
}}

These refer to the worker required to build it ([[Soaper|soap maker]]) and the key used to build it in the workshop menu (capital {{k|S}}).

{{code|
[BLOCK:1:0:0:0]
...
}}
This is a bit more complex, and is where we get to the meaty part of workshop making--the tiles' properties. {{token|BLOCK|b}} refers to which tiles will be untraversable--1 means blocked, 0 means unblocked. The first number refers to row, and the next 3 refer to column, so 1:0:0:0 means that, on the first row, all tiles will be unblocked. This is the case for all vanilla workshops, as of now.

{{code|
[TILE:0:1:' ':' ':150]
...
}}
The {{token|TILE|b}} 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 {{token|BLOCK|b}}; however, instead of 1s and 0s, you must input tiles. The tiles themselves can be given in quotes (as in ' ') or given as a number, which can be looked up [[Tilesets|here]]. Here, we have 150, which is û.

{{code|
[COLOR:0:1:0:0:0:0:0:0:6:0:0]
...
}}
{{token|COLOR|b}} is as {{token|TILE|b}}, 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 ({{Raw tile|☻|4:2:1}}).

For the first row (``0:1``) our colors are [``0:0:0``, ``0:0:0``, ``6:0:0``]. Combining tile and color, this is our result:
{{Tile| |0:0}}{{Tile| |0:0}}{{Tile| |0:0}}{{Tile| |0:0}}{{Tile|û|6:0}}

{{code|
[BUILD_ITEM:1:BUCKET:NONE:NONE:NONE][EMPTY][CAN_USE_ARTIFACT]
[BUILD_ITEM:1:NONE:NONE:NONE:NONE][BUILDMAT][WORTHLESS_STONE_ONLY][CAN_USE_ARTIFACT]
}}
These refer to items required to build the building. These are in the same format as [[Reaction|reaction reagents and products]]:
``<quantity>:<[[Item token|item]]>:<item subtype>:<[[Material token|material]]>:<material subtype>``.

You'll learn more about those on the article about [[Reaction|reactions]], though. The second {{token|BUILD_ITEM|b}} is special— it uses modifiers exclusively to determine its requirements.

{{token|BUILDMAT|b}} refers to [[wood]] logs, wood [[block]]s, [[stone]] boulders, and stone blocks; {{token|WORTHLESS_STONE_ONLY|b}} means it can't use economic stone; {{token|CAN_USE_ARTIFACT|b}} means that it... can use artifacts. {{token|EMPTY|b}}, in the bucket's case, means that the bucket must be empty.

{{code|
[TOOLTIP:Use tallow (rendered fat) or oil here with lye to make soap.]
}}

This is the text in the tooltip shown when the building is highlighted by the mouse in the workshops list.

More can be seen at the [[Building token|building tokens]] article, including links to graphical editors for assembling workshop tile visuals.

=== Reactions ===

Reactions are the crafting recipes used in [[workshop]]s, and by the [[adventurer mode|adventurer]]. By adding new reactions you can make new items available, or enable you to get items or materials in new ways. The reactions can also be given to entities, in which case they will make use of them during both world gen and play; making a reaction that creates [[steel]] directly from [[plant fiber]]s could allow the elves to craft steel, and arrive clad in it in a [[siege]].

Not all crafting jobs are custom reactions. Reactions are explicitly defined in raws, such as those for [[ceramic industry|pottery]] and [[Metal#Alloys 2|alloy]] making.

An in-depth guide for reactions is available [[Reactions|here]].

=== Materials ===

As we've seen when talking about creatures, materials are vital. Materials can be defined in three forms: material templates, organic materials local to creatures and plants, and inorganic materials such as stone or metal.

Let's take a look at "METAL_TEMPLATE" in ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/inorganic_metal.txt 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 ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/inorganic_metal.txt 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 ``[https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/inorganic_stone_mineral.txt inorganic_stone_mineral.txt]``. Here we can see that in addition to the changes made to the template, there are also {{token|ENVIRONMENT|im}} 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 regardless of the item type, just with different properties.

== Selecting and Cutting ==

[[#Modifying the vanilla objects|As explained above]], existing raws can be altered with the use of ``SELECT``, and can also be culled with ``CUT`` for more granular control, compared to simply unloading vanilla content in the mod loader. Token behavior when multiple tokens are added depends on the individual token, such as adding to or overwriting the past value. Removing tags from an object without cutting and recreating the object in question is typically impossible, except for creature object tags removed and/or replaced with the use of [[creature variation token]]s.

The syntax for selecting and cutting objects is as follows:

{{code|code=
Substitute X for the desired object. A CUT does not need a SELECT prior, this is simply a list of available options.
Functions that apply only to local sub-objects are indented. In order to edit these, the base object must be currently being defined or have been selected prior.

[SELECT_CREATURE:X]
[CUT_CREATURE:X]

[SELECT_CASTE:X]
[SELECT_ADDITIONAL_CASTE:X]

[SELECT_MATERIAL:X]
[PLUS_MATERIAL:X]
[REMOVE_MATERIAL:X]

[SELECT_TISSUE:X]
[REMOVE_TISSUE:X]

[SELECT_TISSUE_LAYER:X]
[PLUS_TISSUE_LAYER:X]

[SELECT_ENTITY:X]
[CUT_ENTITY:X]

[SELECT_INTERACTION:X]
[CUT_INTERACTION:X]

[SELECT_ITEM:X]
[CUT_ITEM:X]

[SELECT_WORD:X]
[CUT_WORD:X]

[SELECT_TRANSLATION:X]
[CUT_TRANSLATION:X]

[SELECT_SYMBOL:X]
[CUT_SYMBOL:X]

[SELECT_INORGANIC:X]
[CUT_INORGANIC:X]

[SELECT_PLANT:X]
[CUT_PLANT:X]

[SELECT_MATERIAL:X]

[SELECT_GROWTH:X]

[SELECT_REACTION:X]
[CUT_REACTION:X]

[SELECT_MUSIC:X]
[CUT_MUSIC:X]

[SELECT_SOUND:X]
[CUT_SOUND:X]

}}

Note that the {{token|SELECT_SYMBOL|e}} [[entity token]] is separate from the ``[SELECT_SYMBOL]`` [[language token]].

== Examples ==
:''Main articles: [[:Category:Modding_Examples]]''

The Hydling below was made by Mysteryguye (and annotated, updated and separated into blocks by Putnam), to act as an example creature.

{{code|code=
[CREATURE:HYDLING]
[DESCRIPTION:A seven-headed small hairy thing, about the size of a dog. It is very loyal to its masters, and will promptly disembowel any enemy straying too close.]
This is the description that shows up in-game when viewing the creature.

[NAME:hydling:hydlings:hydlish] If there were a civ made of hydlings, it would appear as "hydlings" in the neighbors screen.

[CASTE_NAME:hydling:hydlings:hydlish]

[CREATURE_TILE:'='][COLOR:2:0:1] Will appear as a light green "=".

[PETVALUE:40][NATURAL] Creature is known to be naturally occurring by the game. Will cost 40 embark points to buy.

[LARGE_ROAMING] Will spawn outdoors, wandering around.

[COMMON_DOMESTIC][TRAINABLE][PET] Can be bought on embark as a pet, war animal, or hunting animal.

[BONECARN] Can eat meat and bones only--no vegetables.

[PREFSTRING:loyalty] Dwarves will like it for its loyalty.

[LARGE_PREDATOR] Will attack rather than flee.

[BODY:BASIC_2PARTBODY:7HEADNECKS:BASIC_FRONTLEGS:BASIC_REARLEGS:TAIL:2EYES:NOSE:2LUNGS:HEART:GUTS:ORGANS:THROAT:SPINE:BRAIN:SKULL:3TOES_FQ_REG:3TOES_RQ_REG:MOUTH:TONGUE:GENERIC_TEETH_WITH_FANGS:RIBCAGE]

Has a lower body, upper body, 4 legs, a tail, fourteen eyes, fourteen ears, seven noses, two lungs, a heart, guts, a pancreas etc., and 7 heads with all that goes with those.

[BODYGLOSS:PAW] Feet will be called "paws"

[BODY_DETAIL_PLAN:STANDARD_MATERIALS] Declares the standard materials that most creatures' tissues are made of.

[BODY_DETAIL_PLAN:STANDARD_TISSUES] This declares the tissues that the creature's tissue layers are made of.

[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] And this describes the tissue layers that the creature is made of.

[BODY_DETAIL_PLAN:BODY_HAIR_TISSUE_LAYERS:HAIR] Creature will be covered with a layer of fur.

[USE_MATERIAL_TEMPLATE:NAIL:NAIL_TEMPLATE] And it'll have nails.

[USE_TISSUE_TEMPLATE:NAIL:NAIL_TEMPLATE]

[TISSUE_LAYER:BY_CATEGORY:TOE:NAIL:FRONT] On the toe, specifically.

[SELECT_TISSUE_LAYER:HEART:BY_CATEGORY:HEART]
[PLUS_TISSUE_LAYER:SKIN:BY_CATEGORY:THROAT]
[TL_MAJOR_ARTERIES] Heart and throat--called above--will cause heavy bleeding if ruptured.

[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS] Places eyes, ears and what-have-you into their correct placement, so that you don't have people punching out eyes from behind.

[BODY_DETAIL_PLAN:HUMANOID_RIBCAGE_POSITIONS] Sets the ribcage as being around lungs and heart.

[USE_MATERIAL_TEMPLATE:SINEW:SINEW_TEMPLATE] Defines sinew so that...
[TENDONS:LOCAL_CREATURE_MAT:SINEW:200] Tendons...
[LIGAMENTS:LOCAL_CREATURE_MAT:SINEW:200] ...And ligaments can be defined.

[HAS_NERVES] Creature has nerves, and as such can be disabled by severing them.

[USE_MATERIAL_TEMPLATE:BLOOD:BLOOD_TEMPLATE] Defines the material BLOOD using the template BLOOD_TEMPLATE.
[BLOOD:LOCAL_CREATURE_MAT:BLOOD:LIQUID] Defines the creature's BLOOD as being made of the above-defined BLOOD material in a LIQUID state.

[CREATURE_CLASS:GENERAL_POISON] Creature can be affected by syndromes that affect GENERAL_POISON.

[GETS_WOUND_INFECTIONS] Pretty much self-explanatory. Creature can get infected from wounds.
[GETS_INFECTIONS_FROM_ROT] And from necrosis.

[USE_MATERIAL_TEMPLATE:PUS:PUS_TEMPLATE] Defines PUS using PUS_TEMPLATE.
[PUS:LOCAL_CREATURE_MAT:PUS:LIQUID] Defines PUS as being made of PUS.

[BODY_SIZE:0:0:1000] Creature will be 1000 cubic centimeters at birth...
[BODY_SIZE:1:0:12500] 12500 cubic centimeters at 1 year old...
[BODY_SIZE:2:0:30000] and 30000 cubic centimeters at 2.

[BODY_APPEARANCE_MODIFIER:LENGTH:90:95:98:100:102:105:110] Creature can be anywhere from 90% to 110% as long as others.
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] As above, but with height.
[BODY_APPEARANCE_MODIFIER:BROADNESS:90:95:98:100:102:105:110] As above, but with broadness. This puts the minimum size of the creature (when fully grown) at 21870 and the maximum size at 39930.

[MAXAGE:20:30] Creature will die of old age between the ages of 20 and 30, no later than 30, no sooner than 20.

[CAN_DO_INTERACTION:MATERIAL_EMISSION] Creature can use the MATERIAL_EMISSION interaction.
[CDI:ADV_NAME:Hurl fireball] In adventurer mode, the MATERIAL_EMISSION interaction will appear as "Hurl fireball".
[CDI:USAGE_HINT:ATTACK] Creature will use MATERIAL_EMISSION when it's attacking, on creatures that it's attacking.
[CDI:BP_REQUIRED:BY_CATEGORY:HEAD] Creature must have at least one HEAD to use MATERIAL_EMISSION.
[CDI:FLOW:FIREBALL] The MATERIAL_EMISSION will shoot a fireball.
[CDI:TARGET:C:LINE_OF_SIGHT] The target for the emission--a location--must be within the line of sight of the Hydling.
[CDI:TARGET_RANGE:C:15] And must be, at most, 15 tiles away.
[CDI:MAX_TARGET_NUMBER:C:1] The hydling can only shoot at one target at a time...
[CDI:WAIT_PERIOD:30] and only every 30 ticks (3 tenths of a second at 100 FPS)

[ATTACK:BITE:CHILD_BODYPART_GROUP:BY_CATEGORY:HEAD:BY_CATEGORY:TOOTH] Defines a BITE attack that uses teeth.
[ATTACK_SKILL:BITE] Attack uses the BITE skill.
[ATTACK_VERB:nom:noms] "The Hydling noms the Elf in the left first toe, tearing the muscle!"
[ATTACK_CONTACT_PERC:100] Will use all of the tooth. Note that this can be more than 100.
[ATTACK_PENETRATION_PERC:100] Will sink the tooth all the way in. This can also be more than 100.
[ATTACK_FLAG_EDGE] Attack is an EDGE attack.
[ATTACK_PRIORITY:MAIN] Attack is of priority MAIN. Other option is SECOND.
[ATTACK_FLAG_CANLATCH] Attack can latch on.
[ATTACK_PREPARE_AND_RECOVER:3:3] Takes 3 ticks to wind up attack and 3 to recover from it.
[ATTACK_FLAG_INDEPENDENT_MULTIATTACK] Can use each head independently.

[ATTACK:SCRATCH:CHILD_TISSUE_LAYER_GROUP:BY_TYPE:STANCE:BY_CATEGORY:ALL:NAIL] As above, but for nail instead of teeth.
[ATTACK_SKILL:STANCE_STRIKE] Uses the kicking skill.
[ATTACK_VERB:slice:slices] "You slice the Elf in the left foot and the severed part sails off in an arc!"
[ATTACK_CONTACT_PERC:100] Uses the whole nail.
[ATTACK_PENETRATION_PERC:100] The whole nail goes in.
[ATTACK_FLAG_EDGE] Attack is an edge attack.
[ATTACK_PREPARE_AND_RECOVER:3:3]
[ATTACK_PRIORITY:SECOND]

[CHILD:1] Hydling will become an adult at 1 year old.

[GENERAL_CHILD_NAME:hydie:hydies] Children will appear as "hydies".

[DIURNAL] Is active during the daytime.

[HOMEOTHERM:10070] Has a body temperature of 102 Fahrenheit.

[APPLY_CREATURE_VARIATION:STANDARD_QUADRUPED_GAITS:900:730:561:351:1900:2900] Can run at 25 kph
[APPLY_CREATURE_VARIATION:STANDARD_SWIMMING_GAITS:3512:2634:1756:878:4900:6900] Can swim at 10 kph
[APPLY_CREATURE_VARIATION:STANDARD_CRAWLING_GAITS:6561:6115:5683:1755:7456:8567] Can crawl at 5 kph
[SWIMS_INNATE]Swims innately.

[CASTE:FEMALE] Defines a caste called FEMALE.
[FEMALE] FEMALE caste is female.

[CASTE:MALE] As above, but with male.
[MALE] See above.
}}

== See also ==
{{catbox|Modding}}

* [[Raw file]]
* [[Token]]
* [[Modding pitfalls]]
* [[Cheating]]
* Bay 12 Guide: https://bay12games.com/dwarves/modding_guide.html

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

Sparrow man

2025-09-20T15:56:03Z

DPhKraken: Clarified references

{{Quality|Fine}}
{{Creaturelookup/0
|image=sparrow_man_sprite.png
|portrait=sparrow_man_portrait.png
|death=nobutcher
|contrib=no
|wiki=no}}
{{av}}
{{creaturedesc}}

'''Sparrow men''' are [[animal people]] variants of the common [[sparrow]] who inhabit many [[savage]] [[biome]]s. They spawn in groups of anywhere between 5-10 individuals and are generally content to keep to themselves. In terms of size, they are a little over half the weight of the average [[dwarf]]. All sparrow men are born with Legendary [[skill]] in [[Climber|climbing]].

Like other savage animal people, sparrow men can join [[civilization]]s, become [[historical figure]]s, appear as [[visitor]]s and be playable in [[adventurer mode]].

Some dwarves [[Preferences|like]] sparrow men for their ''dust baths'' and their ''lovely songs''.

{{D for Dwarf}}

Sparrow men are known for their habit of endeavors in piracy. Beware, if you let young female nobles stay near [[fun]] coasts, reanimated skeletons of [[human]]s may take her, prompting a sparrow man to drag along your [[smith]] to rescue her.


Rumours of sparrow women making [[prepared meal]]s using [[sea lamprey]] late at night have yet to be verified.

{{gamedata}}
{{Creatures}}

Release information/52.03

2025-09-16T02:41:58Z

DPhKraken: /* Dye improvements */ Documented new color tokens.

{{release notes}}

:Here is a release to continue to stabilize the lua update. There are several regular fixes as well, listed below in the patch notes.
:Also, we have some dye improvements for you! You can now mix dyes to produce a variety of colors, and you can tint with dyes to mix the natural color of the material and the color of the dye during the dyeing process. If you make a new world, you'll also have access to some additional outdoor plant dyes. Leather can now be dyed, and there are some new stockpile controls to help you manage all of the new stuff.
:If you want to see your dwarves in their new outfits after you've made some shiny clothes, there's the existing preference setting to show their dyed outfits rather than coloring them by profession.
—[[Toady One]], August 7, 2025

== Dye improvements ==
* Added dye mixing.
* Added dyeing of leather.
* Added partial dyeing of items (tinting).
* Added 60+ new outdoor plant dyes (in new worlds).
* Leather, cloth, armor, and finished goods stockpiles can now filter by color and dye status.
* Plant processing and extraction jobs can have a specific plant set.
* Added natural colors to undyed cloth, thread, and leather descriptions.
* Added dye color to dye descriptions.
* Added 20 new [[Color#Color tokens|color definitions]].

== Modding and lua updates ==
* Mods in mod_upload are now sorted (first by ID, then name, then numeric version, then description).
* The "delete" buttons for saves have been replaced with a "Files" button, which, when clicked, gives the previous menu (with a warning that "Delete" is permanent and instant) with an extra button that opens the saves folder (Windows).
* You may click on mods in the various mod lists to open their folder (Windows).
* Added logging for missing PERMITTED_REACTION and PERMITTED_BUILDING objects.
* Reactions associated to entities that use plant reagents will check that the entity has those plants when making powder list (reaction products are not checked.)
* Changed how duplicate object message boxes work.
* Possible improvement to Linux message boxes.
* Added DYER to list of hard-coded buildings permitted for reactions.
* Nightmares no longer have bogeyman polymorph.
* Fixed angel sphere descriptions.
* Fixed attack tweaks and webs on forgotten beasts.
* Fixed necromancer animation missing IT_MANUAL_INPUT.

== General updates ==
* Fixed issue with not all save files being copied to the folder.
* Archers will no longer infinitely flick each frame between archery training and going to some other training if they have no ammo.
* Fixed problem causing some armies to become stuck.
* Announcement settings save properly again.
* Prevented some potential crashes on startup.
* Removes dead/ghostly/caged/sleeping/paralyzed units from the noble queue.
* Makes nobles drop their haul items when they go to a meeting.
* Noble meetings auto-rebuff if meeting data is lost.
* Improved/optimized memory management for armies/army controllers.
* Optimized a particularly slow army loop.
* Fixed crash associated to transformed creatures with fewer body parts than their untransformed body.
* Fixed the "view sheet" hotkey for items/units.
* Fixed placement of titan shrines.
* Made work orders reset their suggested conditions properly when details are changed.
* Added some crash guards and logs for corrupted units/nemesis records.
* Made default embark cloth items dyeable.
* Updated historical nicknames in more places so that legends mode has them.
* Adds a fix for scrolling on laptop trackpads etc.
* Fixed typo in nemesis corruption message.

Reaction

2025-08-29T14:18:50Z

DPhKraken: /* Reaction identifier */

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

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

== Reaction differences between modes ==

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

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

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

The reactions themselves generally adhere to the following structure:

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

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

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

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

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

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

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

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

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

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

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

=== Category ===

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

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

Categories will be displayed in alphabetical order, first off the file name and then off the category name. They currently have no effect on adventure mode reactions.

==== Defining a category ====

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

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

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

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

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

Each reaction can belong to only one category.

=== Reagents ===

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

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

==== Name ====

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

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

==== Quantity ====

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

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

==== Item token ====

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

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

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

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

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

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

==== Material token ====

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

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

==== Modifiers ====

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

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

The following is a list of all known reagent modifiers:

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

=== Products ===

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

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

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

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

==== Probability ====

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

==== Quantity ====

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

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

==== Item token ====

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

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

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

==== Material token ====

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

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

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

==== Product modifiers ====

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

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

=== Improvements ===

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

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

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

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

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

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

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

==== Material token ====

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

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

=== Other tokens ===

==== Fuel ====

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

==== Skill ====

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

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

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

==== Max multiplier ====

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

==== Automatic ====

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

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

==== Mode enabled ====

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

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

==== Description ====

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

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

== Reaction classes and products ==

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

=== Reaction classes ===

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

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

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

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

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

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

=== Material reaction products ===

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

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

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

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

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

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

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

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

=== Item reaction products ===

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

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

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

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

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

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

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

Sacks, of course! Wait, how about silk?

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

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

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

== Reactions and world generation ==

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

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

== Full token list ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

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

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

Bilberry

2025-08-12T22:53:28Z

DPhKraken: Fixed hyperlinks

{{Quality|Fine}}
{{plantlookup
|graphic=bilberry_shrub_sprite.png
|seedimage=bilberry_seeds_sprite.png
|uses=
* [[Food]]|wiki=vaccinium myrtillus
}}
{{av}}

'''Bilberries''' are an [[aboveground]] [[crop|garden vegetable]] that highly resembles blueberries. They can be planted in all seasons, the fruit is edible raw or [[cooking|cooked]], and can also be [[brewing|brewed]] into [[alcohol|bilberry wine]], or processed in a [[dyer's shop]] into violet [[dye]].

When processed at a [[farmer's workshop]], bilberry bushes produces bilberries and seeds.

They are among the [[blueberry|very]] [[cranberry|few]] crops that can be grown in a [[tundra]] environment.

Some [[Dwarf|dwarves]] [[preferences|like]] bilberry bushes for their ''fruit''.

[[File:Lahemaa mustikad.jpg|thumb|center|300px|Admired for its ''fruit''.]]

{{gamedata}}
{{Plants}}