Editing Utility:DFHack

* [https://docs.dfhack.org/en/stable/index.html Documentation]

* [https://docs.dfhack.org/en/stable/docs/Introduction.html#support Support channels], including [https://dfhack.org/discord Discord]

[[File:Dfhack_gui_launcher.png|thumb|300px|right|DFHack in-game help browser and command launcher]]

'''DFHack''' is a [[utility]] that can be used to improve UI, automate some aspects of the game, add features, fix bugs, make a specific one-off change... or just straight-up [[cheat]] - though DFHack's cheat (''aka "Armok"'') tools can be hidden from the interface by enabling "mortal mode" in the DFHack [https://docs.dfhack.org/en/stable/docs/tools/gui/control-panel.html#gui-control-panel control panel].

DFHack is an extensive standardized memory access library, packaged alongside a suite of basic tools that use it. Currently, tools come in the form of plugins, as well as Lua scripts. For developers and modders, DFHack is a comprehensive, standardized memory access package that unites the various ways tools access the ''Dwarf Fortress'' memory space, allowing for easier development of new tools and a vast expansion of capabilities for mods. For players, it is a very useful utility complex that allows tweaking DF in numerous ways. This is probably one of the most useful utilities for DF, acting as an advanced expansion that fixes, improves and adds to the game in many ways, and is recommended for all players.

On April 14, 2023, DFHack was additionally [https://store.steampowered.com/app/2346660/DFHack__Dwarf_Fortress_Modding_Engine/ made available on Steam]. Installing DFHack through Steam will add DFHack to an existing Steam installation of ''Dwarf Fortress''.

 

 

 

* [https://store.steampowered.com/app/2346660/DFHack Steam page] ● [https://github.com/DFHack/dfhack/releases Manual download] ● [https://docs.dfhack.org/en/stable/docs/Installing.html#installing Installation guide] ● [https://docs.dfhack.org/en/stable/index.html DFHack's documentation]

 

Fortress design tools, such as:

* gui/design - Designate digging or constructions in shapes and lines

* gui/quickfort- Designate digging, stockpiles, buildings, and/or zones from a blueprint. DFHack also comes with a [https://docs.dfhack.org/en/stable/docs/guides/quickfort-library-guide.html library of blueprints].

Fortress management automation tools, such as:

* autobutcher - Designates excess livestock for slaughter.

* autochop - Designates trees for chopping when the fortress needs more logs.

* autolabor - Automatically assign labors to dwarves to efficiently complete pending jobs

* seedwatch - Controls settings for cooking seeds and plants so you don't run out of seeds to plant.

* tailor - Generate manager workorders for clothing as existing clothing wears out.

 

* deteriorate - Cause corpses, clothes, and/or food to rot away over time.

* dwarfvet - Allow animals to be treated at hospitals.

* emigration - Allow unhappy dwarves to voluntarily leave the fortress

* starvingdead - Undead waste away over time.

Other scripts and plugins, such as:

* [[Stonesense]] - an isometric visualizer of the map.

| <code>[https://docs.dfhack.org/en/stable/docs/tools/prospector.html#prospector prospect]</code>

| To prospect your embark location for a list of all the present minerals and plants.

| <code>[https://docs.dfhack.org/en/stable/docs/tools/dig.html#digtype digv]</code>

| <code>[https://docs.dfhack.org/en/stable/docs/tools/reveal.html#revflood reveal]</code>

| Reveal the map so you can inspect the caverns and mineral layouts.  

| <code>[https://docs.dfhack.org/en/stable/docs/tools/cleanowned.html#cleanowned cleanowned scattered x]</code>

| Collects the random junk dwarves fling about the fortress and marks it for dumping.

| <code>[https://docs.dfhack.org/en/stable/docs/tools/exportlegends.html#exportlegends exportlegends]</code>

| For exporting [[Legends mode]] information.

*Plugins are snippets of C++ code that uses DFHack's library to fix bugs or add functionality. They must be compiled before use and are thus platform and dfhack-version dependent, but as a result they tend to be extremely ''fast''. They can be found in the hack/plugins folder.

*Scripts are files written in a scripting language DFHack provides bindings for (usually Lua or Ruby) that when loaded by DFHack fix bugs or add functionality. Contrary to plugins, they are not compiled and can be transferred between any platform. However any change within the DFHack data structures (i.e. between versions) may break some of these scripts. However, because they run in an interpreter they are unsuitable for tasks which involve large amounts of data (such as revealing the map).