-
-
- adv-bodyswap -
- advtools +
- Adventure mode -
- Map modification
-
-
- 3dveins -
- changelayer -
- changevein -
- changeitem -
- colonies -
- createitem -
- deramp (by zilpin) -
- feature -
- infiniteSky -
- liquids -
- liquids-here -
- tiletypes -
- tiletypes-commands -
- tiletypes-here -
- tiletypes-here-point -
- tubefill -
- extirpate -
- grow -
- immolate -
- regrass -
- weather +
- Map modification -
- Map inspection
-
-
- cursecheck -
- flows -
- probe -
- prospect
-
-
- Pre-embark estimate +
- Map inspection -
- Mod Interaction
-
-
- autoSyndrome -
- outsideOnly -
- syndromeTrigger
-
-
- True Transformation +
- Mod Interaction -
- Designations
-
-
- burrow -
- digv -
- digvx -
- digl -
- diglx -
- digexp -
- digcircle -
- digtype -
- digFlood -
- filltraffic -
- alltraffic -
- restrictliquid -
- restrictice -
- getplants +
- Designations -
- Cleanup and garbage disposal
-
-
- clean -
- spotclean -
- autodump -
- autodump-destroy-here -
- autodump-destroy-item -
- cleanowned +
- Cleanup and garbage disposal -
- Bugfixes
-
-
- drybuckets -
- fixdiplomats -
- fixmerchants -
- fixveins -
- tweak -
- fix-armory +
- Bugfixes -
- Mode switch and reclaim
-
-
- lair -
- mode +
- Mode switch and reclaim -
- Visualizer and data export
-
-
- ssense / stonesense -
- mapexport -
- dwarfexport +
- Visualizer and data export -
- Job management
-
-
- job -
- job-material -
- job-duplicate -
- workflow
-
-
- Function -
- Constraint format -
- Constraint examples +
- Job management -
- Fortress activity management
-
-
- seedwatch -
- zone
-
-
- Usage with single units -
- Usage with filters -
- Mass-renaming -
- Cage zones -
- Examples +
- Fortress activity management -
- Other -
- Scripts
-
-
- fix/* -
- gui/* -
- binpatch -
- quicksave -
- setfps -
- siren -
- growcrops -
- removebadthoughts -
- exterminate -
- source -
- masspit -
- digfort -
- invasion-now -
- digmat -
- superdwarf -
- drainaquifer -
- deathcause -
- lua -
- embark -
- lever -
- stripcaged -
- create-items -
- locate-ore -
- soundsense-season -
- multicmd +
- Scripts -
- In-game interface tools
-
-
- Dwarf Manipulator -
- Search -
- AutoMaterial -
- gui/liquids -
- gui/mechanisms -
- gui/rename -
- gui/room-list -
- gui/choose-weapons +
- In-game interface tools
-
+
- Dwarf Manipulator +
- Search +
- AutoMaterial +
- gui/liquids +
- gui/mechanisms +
- gui/rename +
- gui/room-list +
- gui/choose-weapons +
- gui/clone-uniform
- gui/guide-path
- gui/workshop-job
- gui/workflow @@ -566,24 +566,25 @@ access DF memory and allow for easier development of new tools.
- gui/advfort
- gui/companion-order
- gui/gm-editor +
- gui/mod-manager
- - Behavior Mods
-
-
- Siege Engine
-
-
- Rationale -
- Configuration UI +
- Behavior Mods
@@ -898,11 +899,18 @@ siege engine or an activity zone.
++
command-prompt
+A one line command prompt in df. Same as entering command into dfhack console. Best +used as a keybinding. Can be called with optional "entry" that will start prompt with +that pre-filled.
+
+-Adventure mode
+Adventure mode
-adv-bodyswap
+adv-bodyswap
This allows taking control over your followers and other creatures in adventure mode. For example, you can make them pick up new arms and armor and equip them properly.
@@ -915,7 +923,7 @@ properly.-Map modification
+Map modification
-3dveins
+3dveins
Removes all existing veins from the map and generates new ones using 3D Perlin noise, in order to produce a layout that smoothly flows between Z levels. The vein distribution is based on the world seed, so running @@ -954,7 +962,7 @@ if vein mass shifts between Z layers.
Note that there is no undo option other than restoring from backup.
-changelayer
+changelayer
Changes material of the geology layer under cursor to the specified inorganic RAW material. Can have impact on all surrounding regions, not only your embark! By default changing stone to soil and vice versa is not allowed. By default @@ -1029,7 +1037,7 @@ You did save your game, right?
-changevein
+changevein
Changes material of the vein under cursor to the specified inorganic RAW material. Only affects tiles within the current 16x16 block - for veins and large clusters, you will need to use this command multiple times.
@@ -1042,7 +1050,7 @@ large clusters, you will need to use this command multiple times.-changeitem
+changeitem
Allows changing item material and base quality. By default the item currently selected in the UI will be changed (you can select items in the 'k' list or inside containers/inventory). By default change is only allowed if materials @@ -1082,7 +1090,7 @@ crafters/haulers.
-colonies
+colonies
Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.
Options:
@@ -1097,7 +1105,7 @@ crafters/haulers.
-createitem
+createitem
Allows creating new items of arbitrary types and made of arbitrary materials. By default, items created are spawned at the feet of the selected unit.
Specify the item and material information as you would indicate them in custom reaction raws, with the following differences: @@ -1136,12 +1144,12 @@ By default, items created are spawned at the feet of the selected unit.
-deramp (by zilpin)
+deramp (by zilpin)
Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation. It also removes any and all 'down ramps' that can remain after a cave-in (you don't have to designate anything for that to happen).
-feature
+feature
Enables management of map features.
- Discovering a magma feature (magma pool, volcano, magma sea, or curious @@ -1166,7 +1174,7 @@ that cavern to grow within your fortress.
-infiniteSky
+infiniteSky
Automatically allocates new z-levels of sky at the top of the map as you build up, or on request allocates many levels all at once.
- Examples: @@ -1177,7 +1185,7 @@ Enables/disables monitoring of constructions. If you build anything in the secon
-liquids
+liquids
Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey. Settings will be remembered as long as dfhack runs. Intended for use in combination with the command @@ -1190,13 +1198,13 @@ temperatures (creating heat traps). You've been warned.
-liquids-here
+liquids-here
Run the liquid spawner with the current/last settings made in liquids (if no settings in liquids were made it paints a point of 7/7 magma by default).
Intended to be used as keybinding. Requires an active in-game cursor.
-tiletypes
+tiletypes
Can be used for painting map tiles and is an interactive command, much like liquids.
The tool works with two set of options and a brush. The brush determines which @@ -1277,22 +1285,22 @@ up.
For more details, see the 'help' command while using this.
-tiletypes-commands
+tiletypes-commands
Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.
-tiletypes-here
+tiletypes-here
Apply the current tiletypes options at the in-game cursor position, including the brush. Can be used from a hotkey.
-tiletypes-here-point
+tiletypes-here-point
Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.
--tubefill
+tubefill
Fills all the adamantine veins again. Veins that were hollow will be left alone.
-
@@ -1310,13 +1318,36 @@ alone.
Beware that filling in hollow veins will trigger a demon invasion on top of your miner when you dig into the region that used to be hollow.
-extirpate
-A tool for getting rid of trees and shrubs. By default, it only kills -a tree/shrub under the cursor. The plants are turned into ashes instantly.
-Options:
--
+
+-plant
+A tool for creating shrubs, growing, or getting rid of them.
+-
+
- Subcommands: +
+
++ + + create: Create a new shrub/sapling. +grow: Make saplings grow into trees. +extirpate: Kills trees and shrubs, turning them into ashes instantly. +immolate: Similar to extirpate, but sets the plants on fire instead. The fires can and will spread ;) +
+
create creates a new sapling under the cursor. Takes a raw ID as +argument (e.g. TOWER_CAP). The cursor must be located on a dirt or grass +floor tile.
+grow works on the sapling under the cursor, and turns it into a tree. +Works on all shrubs of the map if the cursor is hidden.
+extirpate and immolate work only on the plant under the cursor.
+-
+
- For mass effects, use one of the additional options: +
- -@@ -1328,23 +1359,15 @@ a tree/shrub under the cursor. The plants are turned into ashes instantly.
--grow
-Makes all saplings present on the map grow into trees (almost) instantly.
--immolate
-Very similar to extirpate, but additionally sets the plants on fire. The fires -can and will spread ;)
+ +-weather
+weather
Prints the current weather map by default.
Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.
Options:
@@ -1365,9 +1388,9 @@ can and will spread ;)-Map inspection
+Map inspection
-cursecheck
+cursecheck
Checks a single map tile or the whole map/world for cursed creatures (ghosts, vampires, necromancers, werebeasts, zombies).
With an active in-game cursor only the selected tile will be observed. @@ -1422,17 +1445,17 @@ of curses, for example.
-Pre-embark estimate
+Pre-embark estimate
If prospect is called during the embark selection screen, it displays an estimate of layer stone availability.
@@ -1476,7 +1499,7 @@ that is actually present.-reveal
+reveal
This reveals the map. By default, HFS will remain hidden so that the demons don't spawn. You can use 'reveal hell' to reveal everything. With hell revealed, you won't be able to unpause until you hide the map again. If you really want @@ -1485,35 +1508,35 @@ to unpause with hell revealed, use 'reveal demons'.
you move. When you use it this way, you don't need to run 'unreveal'.-revflood
+revflood
This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.
-revforget
+revforget
When you use reveal, it saves information about what was/wasn't visible before revealing everything. Unreveal uses this information to hide things again. This command throws away the information. For example, use in cases where you abandoned with the fort revealed and no longer want the data.
-Mod Interaction
+Mod Interaction
This section describes plugins that interact with information in the raw files to add new features that cannot be achieved by only changing raw files.
-autoSyndrome
+autoSyndrome
This plugin replaces "boiling rock" syndromes. Without this plugin, it is possible to add a syndrome to a unit by making the unit perform a custom reaction. First, add the syndrome to a rock which boils at room temperature. Make sure that the syndrome is spread by inhaling. Then, add a custom reaction which creates that rock. When the reaction is performed, the rock will be created, then boil. Hopefully, the dwarf will inhale the gas and become afflicted with the syndrome. This has disadvantages.
- The creating unit might not inhale the gas. This makes it difficult to balance gameplay, as it is hard to measure this probability. @@ -1554,11 +1577,11 @@ you abandoned with the fort revealed and no longer want the data.
Again, note that plugins AND scripts can be executed this way, and arguments will be passed according to the same rules.
-outsideOnly
+outsideOnly
This plugin makes it so that buildings whose names begin with OUTSIDE_ONLY cannot be built inside. If the player attempts to do so, the building will automatically be deconstructed.
-syndromeTrigger
+syndromeTrigger
This plugin allows DFHack commands to be executed whenever a unit becomes afflicted with a syndrome. This can happen due to a boiling rock, an interaction, autoSyndrome, etc. Regardless of the cause, if the appropriate SYN_CLASS tags are present, the command will execute.
The syntax is very similar to autoSyndrome. If the syndrome has the \COMMAND tag, every subsequent SYN_CLASS tag will be used to create a console command. The following tags are "special":
-
@@ -1568,7 +1591,7 @@ you abandoned with the fort revealed and no longer want the data.
If there is a [SYN_CLASS:\AUTO_SYNDROME] tag, then the command, if any, will NOT be executed by syndromeTrigger, because it should already have been executed by autoSyndrome.
-True Transformation
+True Transformation
The syndromeTrigger plugin also allows true, permanent transformations. In vanilla DF, if syndrome A transforms dwarves into goblins permanently, and syndrome B transforms goblins into dragons permanently, then syndrome B would NOT properly transform goblins that had been transformed from dwarves. True transformations can be achieved with this plugin.
True transformations work differently. First, the unit transforms into a temporary, distinct, intermediate form. While transformed, this plugin overwrites their "original" unit type with the desired type. When the transformation wears off, they will turn "back" into the new unit type. Once truly transformed, units will function as if they had always been the new unit type. Equipment may be dropped on transformation, but relationships and experience should be maintained.
Suppose you want to transform dwarves into goblins. First, make a syndrome that turns dwarves into ducks for 1 tick (start:0:end:1). It should work with END:1, but if it doesn't, try END:5. You MUST use START:0. Setting the end time very high will make the intermediate form take longer, and should have no other influence on the behavior of this plugin. The intermediate form must NOT be the same as the original form, and it must NOT be the same as the final form, or the game will crash. Add the following tags:
@@ -1581,9 +1604,9 @@ you abandoned with the fort revealed and no longer want the data.-Designations
+Designations
-burrow
+burrow
Miscellaneous burrow control. Allows manipulating burrows and automated burrow expansion while digging.
Options:
@@ -1631,17 +1654,17 @@ Digging 1-wide corridors with the miner inside the burrow is SLOW.-digv
+digv
Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).
-digl
+digl
Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it @@ -1649,11 +1672,11 @@ will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).
-digexp
+digexp
This command can be used for exploratory mining.
See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining
There are two variables that can be set: pattern and filter.
@@ -1716,7 +1739,7 @@ z-level deep layer was not such a good idea after all).-digcircle
+digcircle
A command for easy designation of filled and hollow circles. It has several types of options.
Shape:
@@ -1779,7 +1802,7 @@ repeats with the last selected parameters.-digtype
+digtype
For every tile on the map of the same vein type as the selected tile, this command designates it to have the same designation as the selected tile. If the selected tile has no designation, they will be dig designated. If an argument is given, the designation of the selected tile is ignored, and all appropriate tiles are set to the specified designation.
Options:
@@ -1807,7 +1830,7 @@ If an argument is given, the designation of the selected tile is ignored, and al-digFlood
+digFlood
Automatically digs out specified veins as they are discovered. It runs once every time a dwarf finishes a dig job. It will only dig out appropriate tiles that are adjacent to the finished dig job. To add a vein type, use digFlood 1 [type]. This will also enable the plugin. To remove a vein type, use digFlood 0 [type] 1 to disable, then remove, then re-enable.
digFlood 0 disable
digFlood 1 enable
@@ -1818,7 +1841,7 @@ If an argument is given, the designation of the selected tile is ignored, and alSee help digFlood for details.
-filltraffic
+filltraffic
Set traffic designations using flood-fill starting at the cursor.
Traffic Type Codes:
@@ -1857,7 +1880,7 @@ If an argument is given, the designation of the selected tile is ignored, and al 'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room.
-alltraffic
+alltraffic
Set traffic designations for every single tile of the map (useful for resetting traffic designations).
Traffic Type Codes:
@@ -1881,15 +1904,15 @@ If an argument is given, the designation of the selected tile is ignored, and al 'alltraffic N' - Set traffic to 'normal' for all tiles.
-Cleanup and garbage disposal
+Cleanup and garbage disposal
-clean
+clean
Cleans all the splatter that get scattered all over the map, items and creatures. In an old fortress, this can significantly reduce FPS lag. It can also spoil your !!FUN!!, so think before you use it.
@@ -1952,12 +1975,12 @@ also spoil your !!FUN!!, so think before you use it.-spotclean
+spotclean
Works like 'clean map snow mud', but only for the tile under the cursor. Ideal if you want to keep that bloody entrance 'clean map' would clean up.
-autodump
+autodump
This utility lets you quickly move all items designated to be dumped. Items are instantly moved to the cursor position, the dump flag is unset, and the forbid flag is set, as if it had been dumped normally. @@ -1984,17 +2007,17 @@ Be aware that any active dump item tasks still point at the item.
-autodump-destroy-here
+autodump-destroy-here
Destroy items marked for dumping under cursor. Identical to autodump destroy-here, but intended for use as keybinding.
-autodump-destroy-item
+autodump-destroy-item
Destroy the selected item. The item may be selected in the 'k' list, or inside a container. If called again before the game is resumed, cancels destroy.
-cleanowned
+cleanowned
Confiscates items owned by dwarfs. By default, owned food on the floor and rotten items are confistacted and dumped.
Options:
@@ -2028,13 +2051,13 @@ worn items with 'X' damage and above.-Bugfixes
+Bugfixes
-drybuckets
+drybuckets
This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.
-fixdiplomats
+fixdiplomats
Up to version 0.31.12, Elves only sent Diplomats to your fortress to propose tree cutting quotas due to a bug; once that bug was fixed, Elves stopped caring about excess tree cutting. This command adds a Diplomat position to all Elven @@ -2043,19 +2066,19 @@ to violate them and potentially start wars) in case you haven't already modified your raws accordingly.
-fixmerchants
+fixmerchants
This command adds the Guild Representative position to all Human civilizations, allowing them to make trade agreements (just as they did back in 0.28.181.40d and earlier) in case you haven't already modified your raws accordingly.
-fixveins
+fixveins
Removes invalid references to mineral inclusions and restores missing ones. Use this if you broke your embark with tools like tiletypes, or if you accidentally placed a construction on top of a valuable mineral floor.
-tweak
+tweak
Contains various tweaks for minor bugs.
One-shot subcommands:
@@ -2165,7 +2188,7 @@ This tweak prevents it by auto-gathering the products if this happens.
-fix-armory
+fix-armory
Enables a fix for storage of squad equipment in barracks.
Specifically, it prevents your haulers from moving squad equipment to stockpiles, and instead queues jobs to store it on weapon racks, @@ -2219,9 +2242,9 @@ these rules is intended by Toady; the rest are invented by this plugin.
-Mode switch and reclaim
+Mode switch and reclaim
-lair
+lair
This command allows you to mark the map as 'monster lair', preventing item scatter on abandon. When invoked as 'lair reset', it does the opposite.
Unlike reveal, this command doesn't save the information about tiles - you @@ -2241,7 +2264,7 @@ won't be able to restore state of real monster lairs using 'lair reset'.
-Visualizer and data export
+Visualizer and data export
-ssense / stonesense
+ssense / stonesense
An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).
@@ -2276,19 +2299,19 @@ thread: http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository-Job management
+Job management
-job
+job
Command for general job query and manipulation.
- Options: @@ -2307,7 +2330,7 @@ in a workshop, or the unit/jobs screen.
-job-material
+job-material
Alter the material of the selected job.
Invoked as:
@@ -2325,7 +2348,7 @@ over the first available choice with the matching material.
-job-duplicate
+job-duplicate
- Duplicate the selected job in a workshop:
-
@@ -2336,7 +2359,7 @@ instantly duplicates the job.
-workflow
+workflow
Manage control of repeat jobs.
Usage:
@@ -2368,7 +2391,7 @@ this list can be copied to a file, and then reloaded using the
-Function
+Function
When the plugin is enabled, it protects all repeat jobs from removal. If they do disappear due to any cause, they are immediately re-added to their workshop and suspended.
@@ -2381,7 +2404,7 @@ the frequency of jobs being toggled. in the game UI.-Constraint format
+Constraint format
The contstraint spec consists of 4 parts, separated with '/' characters:
ITEM[:SUBTYPE]/[GENERIC_MAT,...]/[SPECIFIC_MAT:...]/[LOCAL,<quality>] @@ -2410,7 +2433,7 @@ be used to ignore imported items or items below a certain quality.
-Constraint examples
+Constraint examples
Keep metal bolts within 900-1000, and wood/bone within 150-200.
workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 @@ -2459,15 +2482,15 @@ workflow count CRAFTS///LOCAL,EXCEPTIONAL 100 90
-Fortress activity management
+Fortress activity management
-seedwatch
+seedwatch
Tool for turning cooking of seeds and plants on/off depending on how much you have of them.
See 'seedwatch help' for detailed description.
-zone
+zone
Helps a bit with managing activity zones (pens, pastures and pits) and cages.
Options:
@@ -2566,7 +2589,7 @@ for war/hunt). Negatable.
-Usage with single units
+Usage with single units
One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2575,7 +2598,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.
-Usage with filters
+Usage with filters
All filters can be used together with the 'assign' command.
Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2593,14 +2616,14 @@ are not properly added to your own stocks; slaughtering them should work).
Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).
-Mass-renaming
+Mass-renaming
Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.
-Cage zones
+Cage zones
Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2611,7 +2634,7 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.
-autonestbox
+autonestbox
Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2666,7 +2689,7 @@ frames between runs.
-autobutcher
+autobutcher
Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.
Named units will be completely ignored (to protect specific animals from @@ -2774,7 +2797,7 @@ autobutcher.bat
-Other
+Other
-catsplosion
+catsplosion
Makes cats just multiply. It is not a good idea to run this more than once or twice.
-dfusion
+dfusion
- This is the DFusion lua plugin system by Warmist, running as a DFHack plugin. There are two parts to this plugin: an interactive script that shows a text based menu and lua modules. Some of the functionality of is intentionaly left out of the menu:
@@ -2821,7 +2844,7 @@ twice.
-misery
+misery
When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).
Usage:
@@ -2843,7 +2866,7 @@ twice.
-strangemood
+strangemood
Creates a strange mood job the same way the game itself normally does it.
Options:
@@ -2869,7 +2892,7 @@ Valid values are "miner", "carpenter", "engraver",
-Scripts
+Scripts
Lua or ruby scripts placed in the hack/scripts/ directory are considered for execution as if they were native DFHack commands. They are listed at the end of the 'ls' command output.
@@ -2878,7 +2901,7 @@ only be listed by ls if called as 'ls -a'. This is intended as a way to hide scripts that are obscure, developer-oriented, or should be used as keybindings.Some notable scripts:
-fix/*
+fix/*
Scripts in this subdirectory fix various bugs and issues, some of them obscure.
fix/dead-units
@@ -2910,12 +2933,12 @@ in dfhack.init makes it run automatically.
-gui/*
+gui/*
Scripts that implement dialogs inserted into the main game window are put in this directory.
-binpatch
+binpatch
Checks, applies or removes binary patches directly in memory at runtime:
binpatch check/apply/remove <patchname> @@ -2925,17 +2948,17 @@ script uses hack/patches/<df-v the version appropriate for the currently loaded executable.-quicksave
+quicksave
If called in dwarf mode, makes DF immediately auto-save the game by setting a flag normally used in seasonal auto-save.
-setfps
+setfps
Run setfps <number> to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :)
-siren
+siren
Wakes up sleeping units, cancels breaks and stops parties either everywhere, or in the burrows given as arguments. In return, adds bad thoughts about noise, tiredness and lack of protection. Also, the units with interrupted @@ -2943,7 +2966,7 @@ breaks will go on break again a lot sooner. The script is intended for emergencies, e.g. when a siege appears, and all your military is partying.
-growcrops
+growcrops
Instantly grow seeds inside farming plots.
With no argument, this command list the various seed types currently in use in your farming plots. @@ -2955,7 +2978,7 @@ growcrops plump 40
-removebadthoughts
+removebadthoughts
This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.
The script can target a single creature, when used with the him argument, @@ -2969,12 +2992,14 @@ but in the short term your dwarves will get much more joyful.
quickly after you unpause.-exterminate
+exterminate
Kills any unit of a given race.
With no argument, lists the available races and count eligible targets.
With the special argument him, targets only the selected creature.
With the special argument undead, targets all undeads on the map, regardless of their race.
+When specifying a race, a caste can be specified to further restrict the +targeting. To do that, append and colon and the caste name after the race.
Any non-dead non-caged unit of the specified race gets its blood_count set to 0, which means immediate death at the next game tick. For creatures such as vampires, it also sets animal.vanish_countdown to 2.
@@ -2987,6 +3012,7 @@ but ignore caged/chained creatures.Ex:
exterminate gob +exterminate gob:male
To kill a single creature, select the unit with the 'v' cursor and:
@@ -2998,7 +3024,7 @@ exterminate elve magma
-source
+source
Create an infinite magma or water source or drain on a tile.
This script registers a map tile as a liquid source, and every 12 game ticks that tile receives or remove 1 new unit of flow based on the configuration.
@@ -3020,14 +3046,14 @@ source add water 0 - water drain-masspit
+masspit
Designate all creatures in cages on top of a pit/pond activity zone for pitting. Works best with an animal stockpile on top of the zone.
Works with a zone number as argument (eg Activity Zone #6 -> masspit 6) or with the game cursor on top of the area.
-digfort
+digfort
A script to designate an area for digging according to a plan in csv format.
This script, inspired from quickfort, can designate an area for digging. Your plan should be stored in a .csv file like this:
@@ -3049,7 +3075,7 @@ as an offset for the pattern: instead of starting at the cursor, it will start Dwarf Fortress.exe is found).-invasion-now
+invasion-now
Triggers an invasion, or several in the near future.
invasion-now civName trigger an invasion from the civilization with the id civName, starting in about ten ticks
invasion-now civName start trigger an invasion from civName in a number of ticks between 10*start and 11*start-1 (inclusive)
@@ -3057,7 +3083,7 @@ Dwarf Fortress.exe is found).Probably fails if the start time of a triggered invasion is later than the start of the next year.
-digmat
+digmat
Designates a tile for digging. Monitors the tile, and when it is dug out, add surrounding discovered tiles of the same material for digging. Similar to 'digv', but less cheaty. Works for stone layers, soil layers, veins, etc.
@@ -3066,7 +3092,7 @@ same designation for future digging (eg dig up/downstairs). When digging stairs, also designate tiles on z-1 and z+1 when they are discovered.-superdwarf
+superdwarf
Similar to fastdwarf, per-creature.
To make any creature superfast, target it ingame using 'v' and:
@@ -3076,17 +3102,17 @@ superdwarf add
This plugin also shortens the 'sleeping' and 'on break' periods of targets.
-deathcause
+deathcause
Focus a body part ingame, and this script will display the cause of death of the creature. Also works when selecting units from the 'u'nitlist viewscreen.
-lua
+lua
There are the following ways to invoke this command:
lua (without any parameters)
@@ -3105,11 +3131,11 @@ directory. If the filename is not supplied, it loads "dfhack.lua".
-lever
+lever
Allow manipulation of in-game levers from the dfhack console.
Can list levers, including state and links, with:
@@ -3123,7 +3149,7 @@ lever pull 42 --now
-stripcaged
+stripcaged
For dumping items inside cages. Will mark selected items for dumping, then a dwarf may come and actually dump it. See also autodump.
With the items argument, only dumps items laying in the cage, excluding @@ -3141,7 +3167,7 @@ stripcaged weapons 25321 34228
-create-items
+create-items
Spawn arbitrary items under the cursor.
The first argument gives the item category, the second gives the material, and the optionnal third gives the number of items to create (defaults to 20).
@@ -3163,7 +3189,7 @@ create-items bar adamantine-locate-ore
+locate-ore
Scan the map for metal ores.
Finds and designate for digging one tile of a specific metal ore. Only works for native metal ores, does not handle reaction stuff (eg STEEL).
@@ -3176,7 +3202,7 @@ locate-ore iron-soundsense-season
+soundsense-season
It is a well known issue that Soundsense cannot detect the correct current season when a savegame is loaded and has to play random season music until a season switch occurs.
@@ -3185,7 +3211,7 @@ to gamelog.txt on every map load to fix this. For best results call the script from dfhack.init.-In-game interface tools
+In-game interface tools
These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.
@@ -3211,7 +3237,7 @@ guideline because it arguably just fixes small usability bugs in the game UI.-Dwarf Manipulator
+Dwarf Manipulator
Implemented by the 'manipulator' plugin.
To activate, open the unit screen and press 'l'.
@@ -3250,7 +3276,7 @@ cursor onto that cell instead of toggling it.
directly to the main dwarf mode screen.
-Search
+Search
Implemented by the 'search' plugin.
The search plugin adds search to the Stocks, Animals, Trading, Stockpile, Noble (assignment candidates), Military (position candidates), Burrows @@ -3281,7 +3307,7 @@ only fat or tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats again while the list is filtered.
-AutoMaterial
+AutoMaterial
Implemented by the 'automaterial' plugin.
This makes building constructions (walls, floors, fortifications, etc) a little bit easier by saving you from having to trawl through long lists of materials each time @@ -3309,7 +3335,7 @@ materials, it returns you back to this screen. If you use this along with severa enabled materials, you should be able to place complex constructions more conveniently.
-gui/liquids
+gui/liquids
To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.
This script is a gui front-end to the liquids plugin and works similar to it, @@ -3329,7 +3355,7 @@ rivers power water wheels even when full and technically not flowing.
After setting up the desired operations using the described keys, use Enter to apply them.
-gui/mechanisms
+gui/mechanisms
To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.
Lists mechanisms connected to the building, and their links. Navigating the list centers @@ -3339,7 +3365,7 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.
-gui/rename
+gui/rename
Backed by the rename plugin, this script allows entering the desired name via a simple dialog in the game ui.
-
@@ -3362,7 +3388,7 @@ their species string.
unit profession change to Ctrl-Shift-T.
-gui/room-list
+gui/room-list
To use, bind to a key (the example config uses Alt-R) and activate in the 'q' mode, either immediately or after opening the assign owner page.
@@ -3370,7 +3396,7 @@ either immediately or after opening the assign owner page.
list, and allows unassigning them.
-+gui/choose-weapons
+gui/choose-weapons
Bind to a key (the example config uses Ctrl-W), and activate in the Equip->View/Customize page of the military screen.
Depending on the cursor location, it rewrites all 'individual choice weapon' entries @@ -3380,6 +3406,13 @@ only that entry, and does it even if it is not 'individual choice'.
Rationale: individual choice seems to be unreliable when there is a weapon shortage, and may lead to inappropriate weapons being selected.
+gui/clone-uniform
+Bind to a key (the example config uses Ctrl-C), and activate in the Uniforms +page of the military screen with the cursor in the leftmost list.
+When invoked, the script duplicates the currently selected uniform template, +and selects the newly created copy.
+gui/guide-path
Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with @@ -3507,11 +3540,18 @@ keybinding. (e.g. keybinding set Ctrl-T gui/advfort). Possible arguments:
implies -a- job - selects that job (e.g. Dig or FellTree)
+An example of player digging in adventure mode:
+
++DISCLAIMER
+advfort changes only persist in non procedural sites. Namely: player forts, caves, camps.
++gui/companion-order
A script to issue orders for companions. Select companions with lower case chars, issue orders with upper case. Must be in look or talk mode to issue command on tile.
+
- move - orders selected companions to move to location. If companions are following they will move no more than 3 tiles from you.
- equip - try to equip items on the ground. @@ -3534,12 +3574,19 @@ its results (e.g. gui/gm-editor "df.global.world.items.all" shows all
- using gui/gm-editor dialog - shows an in game dialog to input lua command. Works the same as version above.
This editor allows to change and modify almost anything in df. Press '?' for an in-game help.
+gui/mod-manager
+A way to simply install and remove small mods. It looks for specially formated mods in +df subfolder 'mods'. Mods are not included, for example mods see: github mini mod repository
+
+-Behavior Mods
+Behavior Mods
These plugins, when activated via configuration UI or by detecting certain structures in RAWs, modify the game engine behavior concerning the target objects to add features not otherwise present.
@@ -3550,20 +3597,20 @@ technical challenge, and do not represent any long-term plans to produce more similar modifications of the game.-Siege Engine
+Siege Engine
The siege-engine plugin enables siege engines to be linked to stockpiles, and aimed at an arbitrary rectangular area across Z levels, instead of the original four directions. Also, catapults can be ordered to load arbitrary objects, not just stones.
-Rationale
+Rationale
Siege engines are a very interesting feature, but sadly almost useless in the current state because they haven't been updated since 2D and can only aim in four directions. This is an attempt to bring them more up to date until Toady has time to work on it. Actual improvements, e.g. like making siegers bring their own, are something only Toady can do.
-Configuration UI
+Configuration UI
The configuration front-end to the plugin is implemented by the gui/siege-engine script. Bind it to a key (the example config uses Alt-A) and activate after selecting a siege engine in 'q' mode.
@@ -3586,7 +3633,7 @@ menu.-Power Meter
+Power Meter
The power-meter plugin implements a modified pressure plate that detects power being supplied to gear boxes built in the four adjacent N/S/W/E tiles.
The configuration front-end is implemented by the gui/power-meter script. Bind it to a @@ -3597,11 +3644,11 @@ in the build menu.
configuration page, but configures parameters relevant to the modded power meter building.-Steam Engine
+Steam Engine
The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.
-Rationale
+Rationale
The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -3612,7 +3659,7 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.
-Construction
+Construction
The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.
@@ -3636,7 +3683,7 @@ short axles that can be built later than both of the engines.-Operation
+Operation
In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -3667,7 +3714,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.
-Explosions
+Explosions
The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.
During operation weak parts get gradually worn out, and @@ -3676,7 +3723,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.
-Save files
+Save files
It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -3687,7 +3734,7 @@ being generated.
-Add Spatter
+Add Spatter
This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements. The produced contaminants are immune to being washed away by water or destroyed by diff --git a/Readme.rst b/Readme.rst index def0dd343..99ac710fe 100644 --- a/Readme.rst +++ b/Readme.rst @@ -708,8 +708,7 @@ Subcommands: :create: Create a new shrub/sapling. :grow: Make saplings grow into trees. :extirpate: Kills trees and shrubs, turning them into ashes instantly. - :immolate: Similar to extirpate, but sets the plants on fire instead. The -fires can and *will* spread ;) + :immolate: Similar to extirpate, but sets the plants on fire instead. The fires can and *will* spread ;) ``create`` creates a new sapling under the cursor. Takes a raw ID as argument (e.g. TOWER_CAP). The cursor must be located on a dirt or grass @@ -719,6 +718,7 @@ floor tile. Works on all shrubs of the map if the cursor is hidden. ``extirpate`` and ``immolate`` work only on the plant under the cursor. + For mass effects, use one of the additional options: :shrubs: affect all shrubs on the map :trees: affect all trees on the map
- Siege Engine