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.

advtools

A package of different adventure mode tools (currently just one)

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 changes only the layer at the cursor position. Note that one layer can stretch across lots of z levels. By default changes only the geology which is linked to the biome under the cursor. That geology might be linked to other biomes as well, though. Mineral veins and gem clusters will stay on the map. Use 'changevein' for them.

tl;dr: You will end up with changing quite big areas in one go, especially if you use it in lower z levels. Use with care.

changevein

Changes material of the vein under cursor to the specified inorganic RAW material.

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 is of the same subtype (for example wood<->wood, stone<->stone etc). But since some transformations work pretty well and may be desired you can override this with 'force'. Note that some attributes will not be touched, possibly resulting in weirdness. To get an idea how the RAW id should look like, check some items with 'info'. Using 'force' might create items which are not touched by crafters/haulers.

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. Without a cursor the whole map will be checked.

By default cursed creatures will be only counted in case you just want to find out if you have any of them running around in your fort. Dead and passive creatures (ghosts who were put to rest, killed vampires, ...) are ignored. Undead skeletons, corpses, bodyparts and the like are all thrown into the curse category "zombie". Anonymous zombies and resurrected body parts will show as "unnamed creature".

follow

Makes the game view follow the currently highlighted unit after you exit from current menu/cursor mode. Handy for watching dwarves running around. Deactivated by moving the view manually.

forcepause

Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.

• Activate with 'forcepause 1'
• Deactivate with 'forcepause 0'

nopause

Disables pausing (both manual and automatic) with the exception of pause forced by 'reveal hell'. This is nice for digging under rivers.

die

Instantly kills DF without saving.

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. Be aware that any active dump item tasks still point at the item.

Cursor must be placed on a floor tile so the items can be dumped there.

autodump-destroy-here

Destroy items marked for dumping under cursor. Identical to autodump destroy-here, but intended for use as keybinding.

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.

burrow

Miscellaneous burrow control. Allows manipulating burrows and automated burrow expansion while digging.

catsplosion

Makes cats just multiply. It is not a good idea to run this more than once or twice.

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.

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.

cleanowned

Confiscates items owned by dwarfs. By default, owned food on the floor and rotten items are confistacted and dumped.

colonies

Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.

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

dfusion

This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.

See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic=69682.15

drybuckets

This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.

fastdwarf

Makes your minions move at ludicrous speeds.

• Activate with 'fastdwarf 1'
• Deactivate with 'fastdwarf 0'

feature

Enables management of map features.

• Discovering a magma feature (magma pool, volcano, magma sea, or curious underground structure) permits magma workshops and furnaces to be built.
• Discovering a cavern layer causes plants (trees, shrubs, and grass) from that cavern to grow within your fortress.

filltraffic

Set traffic designations using flood-fill starting at the cursor.

alltraffic

Set traffic designations for every single tile of the map (useful for resetting traffic designations).

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 civilizations, allowing them to negotiate tree cutting quotas (and allowing you to violate them and potentially start wars) in case you haven't already modified your raws accordingly.

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

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.

fixwagons

Due to a bug in all releases of version 0.31, merchants no longer bring wagons with their caravans. This command re-enables them for all appropriate civilizations.

flows

A tool for checking how many tiles contain flowing liquids. If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map.

getplants

This tool allows plant gathering and tree cutting by RAW ID. Specify the types of trees to cut down and/or shrubs to gather by their plant names, separated by spaces.

tidlers

Toggle between all possible positions where the idlers count can be placed.

twaterlvl

Toggle between displaying/not displaying liquid depth as numbers.

job

Command for general job query and manipulation.

Options:

• no extra options - Print details of the current job. The job can be selected in a workshop, or the unit/jobs screen.
• list - Print details of all jobs in the selected workshop.
• item-material <item-idx> <material[:subtoken]> - Replace the exact material id in the job item.
• item-type <item-idx> <type[:subtype]> - Replace the exact item type id in the job item.

job-material

Alter the material of the selected job.

Invoked as: job-material <inorganic-token>

Intended to be used as a keybinding:

• In 'q' mode, when a job is highlighted within a workshop or furnace, changes the material of the job. Only inorganic materials can be used in this mode.
• In 'b' mode, during selection of building components positions the cursor over the first available choice with the matching material.

job-duplicate

Duplicate the selected job in a workshop:

• In 'q' mode, when a job is highlighted within a workshop or furnace building, instantly duplicates the job.

keybinding

Manages DFHack keybindings.

Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z.

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 liquids-here (which can be bound to a hotkey).

For more information, refer to the command's internal help.

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.

mode

This command lets you see and change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results. There are a few good ones though.

I take no responsibility of anything that happens as a result of using this tool

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.

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 ;)

probe

Can be used to determine tile properties like temperature.

prospect

Prints a big list of all the present minerals and plants. By default, only the visible part of the map is scanned.

regrass

Regrows grass. Not much to it ;)

rename

Allows renaming various things.

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 to unpause with hell revealed, use 'reveal demons'.

Reveal also works in adventure mode, but any of its effects are negated once you move. When you use it this way, you don't need to run 'unreveal'.

unreveal

Reverts the effects of 'reveal'.

revtoggle

Switches between 'reveal' and 'unreveal'.

revflood

This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.

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.

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 won't be able to restore state of real monster lairs using 'lair reset'.

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.

showmood

Shows all items needed for the currently active strange mood.

copystock

Copies the parameters of the currently highlighted stockpile to the custom stockpile settings and switches to custom stockpile placement mode, effectively allowing you to copy/paste stockpiles easily.

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

All the data resides in the 'stonesense' directory. For detailed instructions, see stonesense/README.txt

Compatible with Windows > XP SP3 and most modern Linux distributions.

Older versions, support and extra graphics can be found in the bay12 forum thread: http://www.bay12forums.com/smf/index.php?topic=43260.0

Some additional resources: http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

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 tiles will be processed. First set of options is the filter, which can exclude some of the tiles from the brush by looking at the tile properties. The second set of options is the paint - this determines how the selected tiles are changed.

Both paint and filter can have many different properties including things like general shape (WALL, FLOOR, etc.), general material (SOIL, STONE, MINERAL, etc.), state of 'designated', 'hidden' and 'light' flags.

The properties of filter and paint can be partially defined. This means that you can for example do something like this:

filter material STONE
filter shape FORTIFICATION
paint shape FLOOR

This will turn all stone fortifications into floors, preserving the material.

Or this:

filter shape FLOOR
filter material MINERAL
paint shape WALL

Turning mineral vein floors back into walls.

The tool also allows tweaking some tile flags:

Or this:

paint hidden 1
paint hidden 0

This will hide previously revealed tiles (or show hidden with the 0 option).

Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword:

paint hidden ANY
paint shape ANY
filter material any
filter shape any
filter any

You can use several different brushes for painting tiles:

• Point. (point)
• Rectangular range. (range)
• A column ranging from current cursor to the first solid tile above. (column)
• DF map block - 16x16 tiles, in a regular grid. (block)

Example:

range 10 10 1

This will change the brush to a rectangle spanning 10x10 tiles on one z-level. The range starts at the position of the cursor and goes to the east, south and up.

For more details, see the 'help' command while using this.

tiletypes-commands

Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.

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

Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.

tweak

Contains various tweaks for minor bugs (currently just one).

tubefill

Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).

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

digvx

A permanent alias for 'digv x'.

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

diglx

A permanent alias for 'digl x'.

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.

digcircle

A command for easy designation of filled and hollow circles. It has several types of options.

weather

Prints the current weather map by default.

Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.

workflow

Manage control of repeat jobs.

workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50

workflow count FOOD 120 30
workflow count DRINK 120 30

workflow count BIN 30
workflow count BARREL 30
workflow count BOX/CLOTH,SILK,YARN 30

workflow count BAR//COAL 20
workflow count BAR//COPPER 30

workflow count POWDER_MISC/SAND 20
workflow count BOULDER/CLAY 20

  workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20

In order for this to work, you have to set the material of the PLANT input
on the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material'
command.

mapexport

Export the current loaded map as a file. This will be eventually usable with visualizers.

dwarfexport

Export dwarves to RuneSmith-compatible XML.

zone

Helps a bit with managing activity zones (pens, pastures and pits) and cages.

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 of the size. The age of the units is currently not checked, most birds grow up quite fast. Egglayers who are also grazers will be ignored, since confining them to a 1x1 pasture is not a good idea. Only tame and domesticated own units are processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.

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 autobutcher you can give them nicknames with the tool 'rename unit' for single units or with 'zone nick' to mass-rename units in pastures and cages).

Creatures trained for war or hunting will be ignored as well.

Creatures assigned to cages will be ignored if the cage is defined as a room (to avoid butchering unnamed zoo animals).

Once you have too much adults, the oldest will be butchered first. Once you have too much kids, the youngest will be butchered first. If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults.

autobutcher target 4 3 2 1 ALPACA BIRD_TURKEY
autobutcher target 0 0 0 0 CAT
autobutcher watch ALPACA BIRD_TURKEY CAT
autobutcher start

autobutcher target 0 0 0 0 new
autobutcher autowatch
autobutcher start

autobutcher unwatch ALPACA CAT

Load savegame where you made the settings.
Start a CMD shell and navigate to the df directory. Type the following into the shell:
dfhack-run autobutcher list_export > autobutcher.bat
Load the savegame where you want to copy the settings to, run the batch file (from the shell):
autobutcher.bat

autolabor

Automatically manage dwarf labors.

When enabled, autolabor periodically checks your dwarves and enables or disables labors. It tries to keep as many dwarves as possible busy but also tries to have dwarves specialize in specific skills.

For detailed usage information, see 'help autolabor'.

growcrops

Instantly grow seeds inside farming plots.

With no argument, this command list the various seed types currently in use in your farming plots. With a seed type, the script will grow 100 of these seeds, ready to be harvested. You can change the number with a 2nd argument.

For exemple, to grow 40 plump helmet spawn:

growcrops plump 40

removebadthoughts

This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.

With a selected unit in 'v' mode, will clear this unit's mind, otherwise clear all your fort's units minds.

Individual dwarf happiness may not increase right after this command is run, but in the short term your dwarves will get much more joyful. The thoughts are set to be very old, and the game will remove them soon when you unpause.

With the optional -v parameter, the script will dump the negative thoughts it removed.

slayrace

Kills any unit of a given race.

With no argument, lists the available races.

With the special argument 'him', targets only the selected creature.

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, also set animal.vanish_countdown to 2.

An alternate mode is selected by adding a 2nd argument to the command, magma. In this case, a column of 7/7 magma is generated on top of the targets until they die (Warning: do not call on magma-safe creatures. Also, using this mode for birds is not recommanded.)

Will target any unit on a revealed tile of the map, including ambushers.

Ex:

slayrace gob

To kill a single creature, select the unit with the 'v' cursor and:

slayrace him

To purify all elves on the map with fire (may have side-effects):

slayrace elve magma

magmasource

Create an infinite magma source on a tile.

This script registers a map tile as a magma source, and every 12 game ticks that tile receives 1 new unit of flowing magma.

Place the game cursor where you want to create the source (must be a flow-passable tile, and not too high in the sky) and call:

magmasource here

To add more than 1 unit everytime, call the command again.

To delete one source, place the cursor over its tile and use delete-here. To remove all placed sources, call magmasource stop.

With no argument, this command shows an help message and list existing sources.

Dwarf Manipulator

Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'.

This tool implements a Dwarf Therapist-like interface within the game ui.

Liquids

Implemented by the gui/liquids script. To use, bind to a key and activate in the 'k' mode.

While active, use the suggested keys to switch the usual liquids parameters, and Enter to select the target area and apply changes.

Mechanisms

Implemented by the gui/mechanims script. To use, bind to a key and activate in the 'q' mode.

Lists mechanisms connected to the building, and their links. Navigating the list centers the view on the relevant linked buildings.

To exit, press ESC or Enter; ESC recenters on the original building, while Enter leaves focus on the current one. Shift-Enter has an effect equivalent to pressing Enter, and then re-entering the mechanisms ui.

Power Meter

Front-end to the power-meter plugin implemented by the gui/power-meter script. Bind to a key and activate after selecting Pressure Plate in the build menu.

The script follows the general look and feel of the regular pressure plate build configuration page, but configures parameters relevant to the modded power meter building.

Rename

Backed by the rename plugin, the gui/rename script allows entering the desired name via a simple dialog in the game ui.

• gui/rename [building] in 'q' mode changes the name of a building.

  The selected building must be one of stockpile, workshop, furnace, trap or siege engine.

• gui/rename [unit] with a unit selected changes the nickname.

• gui/rename unit-profession changes the selected unit's custom profession name.

The building or unit are automatically assumed when in relevant ui state.

Room List

Implemented by the gui/room-list script. To use, bind to a key and activate in the 'q' mode, either immediately or after opening the assign owner page.

The script lists other rooms owned by the same owner, or by the unit selected in the assign list, and allows unassigning them.

Siege Engine

Front-end to the siege-engine plugin implemented by the gui/siege-engine script. Bind to a key and activate after selecting a siege engine in 'q' mode.

The main mode displays the current target, selected ammo item type, linked stockpiles and the allowed operator skill range. The map tile color is changed to reflect if it can be hit by the selected engine.

Pressing 'r' changes into the target selection mode, which works by highlighting two points with Enter like all designations. When a target area is set, the engine projectiles are aimed at that area, or units within it, instead of the vanilla four directions.

Pressing 't' switches to stockpile selection.

Exiting from the siege engine script via ESC reverts the view to the state prior to starting the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main menu.

DISCLAIMER: Siege engines are a very interesting feature, but currently nearly useless 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.

Steam Engine

The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.

Add Spatter

This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements.

Intended to give some use to all those poisons that can be bought from caravans.

To be really useful this needs patches from bug 808 and tweak fix-dimensions.