DFHack tools¶
DFHack comes with a lot of tools. This page attempts to make it clearer what they are, how they work, and how to find the ones you want.
What tools are and how they work¶
DFHack is a Dwarf Fortress memory access and modification framework, so DFHack tools normally access Dwarf Fortress internals and make some specific changes.
Some tools just make a targeted change when you run them, like unforbid, which
scans through all your items and removes the forbidden
flag from each of
them.
Some tools need to be enabled, and then they run in the background and make changes to the game on your behalf, like autobutcher, which monitors your livestock population and automatically marks excess animals for butchering.
And some tools just exist to give you information that is otherwise hard to come by, like gui/petitions, which shows you the active petitions for guildhalls and temples that you have agreed to.
Finding the tool you need¶
DFHack tools are tagged with categories to make them easier to find. These categories are listed in the next few sections. Note that a tool can belong to more than one category. If you already know what you’re looking for, try the Search Page or Ctrl-F on this page. If you’d like to see the full list of tools in one flat list, please refer to the annotated index.
Some tools are part of our back catalog and haven’t been updated yet for v50 of Dwarf Fortress. These tools are tagged as unavailable. They will still appear in the alphabetical list at the bottom of this page, but unavailable tools will not listed in any of the indices.
DFHack tools by game mode¶
- adventure
Tools that are useful while in adventure mode.
- dfhack
Tools that you use to run DFHack commands or interact with the DFHack or DF system.
- embark
Tools that are useful while on the fort embark screen or while creating an adventurer.
- fort
Tools that are useful while in fort mode.
- legends
Tools that are useful while in legends mode.
DFHack tools by theme¶
- armok
Tools which give the player god-like powers or the ability to access information the game intentionally keeps hidden. Players that do not wish to see these tools can hide them in the
Preferences
tab of gui/control-panel.
- auto
Tools that run in the background and automatically manage routine, toilsome aspects of your fortress.
- bugfix
Tools that fix specific bugs, either permanently or on-demand.
- design
Tools that help you with fort layout.
- dev
Tools that are useful when debugging or developing mods.
- fps
Tools that help you prevent impact to your FPS.
- gameplay
Tools that introduce new gameplay elements.
- inspection
Tools that let you view information that is otherwise difficult to find.
- productivity
Tools that help you perform common tasks quickly and easily.
DFHack tools by what they affect¶
- animals
Tools that interact with animals.
- buildings
Tools that interact with buildings and furniture.
- graphics
Tools that interact with game graphics.
- interface
Tools that interact with or extend the DF user interface.
- items
Tools that interact with in-game items.
- jobs
Tools that interact with jobs.
- labors
Tools that deal with labor assignment.
- map
Tools that interact with the game map.
- military
Tools that interact with the military.
- plants
Tools that interact with grass, trees, shrubs, and crops.
- stockpiles
Tools that interact with stockpiles.
- units
Tools that interact with units.
- workorders
Tools that interact with workorders.
All DFHack tools alphabetically¶
- 3dveins
- RemoteFortressReader
- adaptation
- add-recipe
- add-spatter
- add-thought
- adv-max-skills
- advtools
- agitation-rebalance
- alias
- allneeds
- animal-control
- aquifer
- armoks-blessing
- assign-attributes
- assign-beliefs
- assign-facets
- assign-goals
- assign-minecarts
- assign-preferences
- assign-profile
- assign-skills
- autobutcher
- autochop
- autoclothing
- autodump
- autofarm
- autofish
- autogems
- autolabor
- autolabor-artisans
- autonestbox
- autonick
- autoslab
- ban-cooking
- binpatch
- blueprint
- bodyswap
- brainwash
- break-dance
- build-now
- building-hacks
- buildingplan
- burial
- burrow
- cannibalism
- caravan
- catsplosion
- changeitem
- changelayer
- changevein
- channel-safely
- cleanconst
- cleaners
- cleanowned
- clear-smoke
- clear-webs
- cls
- colonies
- color-schemes
- combat-harden
- combine
- confirm
- control-panel
- createitem
- cursecheck
- cxxrandom
- deathcause
- debug
- deep-embark
- deramp
- design
- deteriorate
- die
- dig
- dig-now
- digFlood
- diggingInvaders
- diplomacy
- disable
- do-job-now
- dwarf-op
- dwarfmonitor
- dwarfvet
- elevate-mental
- elevate-physical
- embark-anyone
- embark-assistant
- embark-skills
- emigration
- empty-bin
- enable
- eventful
- exportlegends
- exterminate
- extinguish
- fastdwarf
- faststart
- feature
- fillneeds
- filltraffic
- firestarter
- fix-occupancy
- fix-ster
- fixnaked
- fixveins
- flashstep
- flows
- follow
- forbid
- force
- forceequip
- forget-dead-body
- forum-dwarves
- fpause
- full-heal
- gaydar
- geld
- generated-creature-renamer
- getplants
- ghostly
- growcrops
- help
- hermit
- hfs-pit
- hide
- hide-interface
- hide-tutorials
- hotkey-notes
- hotkeys
- idle-crafting
- infiniteSky
- install-info
- instruments
- isoworldremote
- item
- jobutils
- keybinding
- kill-lua
- labormanager
- lair
- launch
- lever
- light-aquifers-only
- linger
- liquids
- list-agreements
- list-waves
- load
- load-save
- locate-ore
- logistics
- ls
- lua
- luasocket
- make-legendary
- make-monarch
- makeown
- manipulator
- map-render
- markdown
- migrants-now
- misery
- mode
- multicmd
- names
- necronomicon
- nestboxes
- notes
- on-new-fortress
- once-per-save
- open-legends
- orders
- overlay
- pathable
- pet-uncapper
- plant
- plug
- points
- pop-control
- position
- power-meter
- pref-adjust
- prefchange
- preserve-rooms
- preserve-tombs
- prioritize
- probe
- prospector
- putontable
- questport
- quickfort
- quicksave
- quickstart-guide
- region-pops
- regrass
- rejuvenate
- reload
- remove-stress
- remove-wear
- rename
- rendermax
- repeat
- resurrect-adv
- reveal
- reveal-adv-map
- reveal-hidden-sites
- reveal-hidden-units
- sc-script
- script
- season-palette
- seedwatch
- set-orientation
- set-timeskip-duration
- setfps
- show
- showmood
- siege-engine
- siren
- sort
- source
- spawnunit
- spectate
- startdwarf
- starvingdead
- steam-engine
- stockflow
- stockpiles
- stocks
- stonesense
- strangemood
- stripcaged
- superdwarf
- suspend
- suspendmanager
- sync-windmills
- tags
- tailor
- tame
- teleport
- tidlers
- tiletypes
- timestream
- title-folder
- toggle-kbd-cursor
- trackstop
- troubleshoot-item
- tubefill
- twaterlvl
- tweak
- type
- undump-buildings
- unforbid
- ungeld
- uniform-unstick
- unload
- unretire-anyone
- view-item-info
- view-unit-reports
- warn-stranded
- weather
- work-now
- workflow
- workorder
- xlsxreader
- zone
- devel/all-bob
- devel/annc-monitor
- devel/block-borders
- devel/check-other-ids
- devel/check-release
- devel/clear-script-env
- devel/click-monitor
- devel/cmptiles
- devel/dump-offsets
- devel/dump-rpc
- devel/dump-tooltip-ids
- devel/eventful-client
- devel/export-dt-ini
- devel/find-primitive
- devel/hello-world
- devel/inject-raws
- devel/input-monitor
- devel/inspect-screen
- devel/kill-hf
- devel/light
- devel/list-filters
- devel/lsmem
- devel/lua-example
- devel/luacov
- devel/modstate-monitor
- devel/nuke-items
- devel/pop-screen
- devel/print-args
- devel/print-args2
- devel/print-event
- devel/query
- devel/save-version
- devel/sc
- devel/scan-vtables
- devel/scanitemother
- devel/send-key
- devel/spawn-unit-helper
- devel/test-perlin
- devel/tile-browser
- devel/tree-info
- devel/unit-path
- devel/visualize-structure
- devel/watch-minecarts
- fix/blood-del
- fix/civil-war
- fix/corrupt-equipment
- fix/corrupt-jobs
- fix/dead-units
- fix/drop-webs
- fix/dry-buckets
- fix/empty-wheelbarrows
- fix/engravings
- fix/general-strike
- fix/loyaltycascade
- fix/noexert-exhaustion
- fix/occupancy
- fix/ownership
- fix/population-cap
- fix/protect-nicks
- fix/retrieve-units
- fix/sleepers
- fix/stable-temp
- fix/stuck-instruments
- fix/stuck-merchants
- fix/stuck-worship
- fix/stuckdoors
- fix/wildlife
- gui/advfort
- gui/aquifer
- gui/autobutcher
- gui/autochop
- gui/autodump
- gui/autofish
- gui/autogems
- gui/biomes
- gui/blueprint
- gui/choose-weapons
- gui/civ-alert
- gui/clone-uniform
- gui/color-schemes
- gui/companion-order
- gui/confirm
- gui/control-panel
- gui/cp437-table
- gui/create-item
- gui/design
- gui/dfstatus
- gui/embark-anywhere
- gui/extended-status
- gui/family-affairs
- gui/gm-editor
- gui/gm-unit
- gui/guide-path
- gui/journal
- gui/kitchen-info
- gui/launcher
- gui/liquids
- gui/load-screen
- gui/manipulator
- gui/mass-remove
- gui/masspit
- gui/mod-manager
- gui/notify
- gui/overlay
- gui/pathable
- gui/petitions
- gui/power-meter
- gui/prerelease-warning
- gui/quantum
- gui/quickcmd
- gui/quickfort
- gui/rename
- gui/reveal
- gui/room-list
- gui/sandbox
- gui/seedwatch
- gui/settings-manager
- gui/siege-engine
- gui/sitemap
- gui/stamper
- gui/stockpiles
- gui/suspendmanager
- gui/teleport
- gui/tiletypes
- gui/unit-info-viewer
- gui/unit-syndromes
- gui/workflow
- gui/workorder-details
- gui/workshop-job
- modtools/add-syndrome
- modtools/anonymous-script
- modtools/change-build-menu
- modtools/create-item
- modtools/create-tree
- modtools/create-unit
- modtools/equip-item
- modtools/extra-gamelog
- modtools/fire-rate
- modtools/if-entity
- modtools/interaction-trigger
- modtools/invader-item-destroyer
- modtools/item-trigger
- modtools/moddable-gods
- modtools/outside-only
- modtools/pref-edit
- modtools/projectile-trigger
- modtools/random-trigger
- modtools/raw-lint
- modtools/reaction-product-trigger
- modtools/reaction-trigger
- modtools/reaction-trigger-transition
- modtools/set-belief
- modtools/set-need
- modtools/set-personality
- modtools/skill-change
- modtools/spawn-flow
- modtools/spawn-liquid
- modtools/syndrome-trigger
- modtools/transform-unit