PSAs

As always, remember that, just like the vanilla DF game, DFHack tools can also have bugs. It is a good idea to save often and keep backups of the forts that you care about.

Many DFHack tools that worked in previous (pre-Steam) versions of DF have not been updated yet and are marked with the "unavailable" tag in their docs. If you try to run them, they will show a warning and exit immediately. You can run the command again to override the warning (though of course the tools may not work). We make no guarantees of reliability for the tools that are marked as "unavailable".

The in-game interface for running DFHack commands (gui/launcher) will not show "unavailable" tools by default. You can still run them if you know their names, or you can turn on dev mode by hitting Ctrl-D while in gui/launcher and they will be added to the autocomplete list. Some tools do not compile yet and are not available at all, even when in dev mode.

If you see a tool complaining about the lack of a cursor, know that it's referring to the keyboard cursor (which used to be the only real option in Dwarf Fortress). You can enable the keyboard cursor by entering mining mode or selecting the dump/forbid tool and hitting Alt-K (the DFHack keybinding for toggle-kbd-cursor). We're working on making DFHack tools more mouse-aware and accessible so this step isn't necessary in the future.

New Features

• zone: Add overlay for toggling butchering/gelding/adoption/taming options in animal "Overview" tabs

Fixes

• dig-now:
  • remove diagonal ramps rendered unusable by digging
  • fix error propagating "light" and "outside" properties to newly exposed tiles when piercing the surface
• item: fix missing item categories when using --by-type
• makeown: fix error when adopting units that need a historical figure to be created
• sort: fix potential crash when switching between certain info tabs
• suspendmanager: overlays for suspended building info panels no longer disappear when another window has focus

Misc Improvements

• autonestbox: don't automatically assign partially trained egg-layers to nestboxes if they don't have an ongoing trainer assigned since they might revert to wild
• buildingplan: replace [edit filters] button in planner overlay with abbreviated filter information
• reveal: automatically reset saved map state when a new save is loaded

Removed

• nopause: functionality has moved to spectate

API

• Gui::getAnyJob: get the job associated with the selected game element (item, unit, workshop, etc.)
• Gui::getAnyWorkshopJob: get the first job associated with the selected workshop
• Units::assignTrainer: assign a trainer to a trainable animal
• Units::unassignTrainer: unassign a trainer from an animal

Lua

• dfhack.gui.getAnyJob: expose API to Lua
• dfhack.gui.getAnyWorkshopJob: expose API to Lua
• dfhack.units.assignTrainer: expose API to Lua
• dfhack.units.isTamable: return false for invaders to match vanilla logic
• dfhack.units.unassignTrainer: expose API to Lua

Structures

• soundst: fix alignment