v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Utility:DFHack"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(→‎Download and Install: new structure; more exposure for quickstart and docs)
 
(76 intermediate revisions by 21 users not shown)
Line 1: Line 1:
 
{{Quality|Superior|13:02, 2 May 2014 (UTC)}}
 
{{Quality|Superior|13:02, 2 May 2014 (UTC)}}
 
{{uv|multiple}}
 
{{uv|multiple}}
−
'''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 and Ruby scripts. For developers, 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. For users, it is a very useful utility complex that allows users to tweak their games in numerous ways in-game. 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 usually included in recent versions of the [[Utility:Lazy Newb Pack|Lazy Newb Pack]] on all platforms.
+
{{Infobox utility
−
{{TipBox2|float=right|Bug reports|
+
| image = File:Dfhack-logo.png
−
If you are using DFHack (or other utilities), do not report bugs on the Dwarf Fortress bug tracker unless you can prove that the bug is not being caused by DFHack or one of its plugins. On Linux and OS X, DFHack can be bypassed by running the "df" script. On Windows, DFHack can be temporarily disabled by renaming SDL.dll to a temporary name, then renaming SDLreal.dll to SDL.dll.
+
| misc  =
 +
* [https://store.steampowered.com/app/2346660/DFHack__Dwarf_Fortress_Modding_Engine/ Steam Store Page]
 +
* [https://github.com/DFHack/dfhack/releases Download]  
 +
* [https://docs.dfhack.org/en/stable/docs/Installing.html#installing Installation guide]
 +
* [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 the UI, automate some aspects of the game, add features, fix bugs, make a specific one-off change... or just straight-up [[Cheat|mold the universe to your liking]]. For players that do not wish to wield these god-like powers, DFHack's god-mode (''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].
  
−
All new releases are announced in a [http://www.bay12forums.com/smf/index.php?topic=139553 thread on the Bay12 forums]. DFHack is currently also being ported to versions 0.28.181.40d and 0.23.130.23a - more information can be found [http://dwarffortresswiki.org/index.php/User:Quietust#DFHack-40d here] and [http://dwarffortresswiki.org/index.php/User:Quietust#DFHack-23a here], respectively. For an exhaustive list of and manual on the commands in the utility, see the [https://github.com/DFHack/dfhack#commands GitHub documentation].  This wiki also has a [[Utility:DFHack/Programming|DFHack programming page]].
+
DFHack is a modding framework that is packaged alongside a suite of tools that use it. 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 and gameplay mod suite that allows tweaking DF in numerous ways. DFHack is 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.
  
−
== Documentation ==
+
By default, DFHack only enables UI improvements and bugfixes, but as you become more familiar with the game, you can explore DFHack's many optional and more advanced features.
−
* [[/Installation|Installation and uninstallation]]
 
−
* [[/Compiling|Compiling from source]]
 
−
==Common Uses==
 
−
DFHack is often used to automate some aspects of the game, add features, fix bugs, or to make a specific one-off change.
 
  
−
===Automation===
+
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''. Note that it needs to be installed to the same Steam library and hard drive as ''Dwarf Fortress'' itself.
−
See: workflow, autolabor, autobutcher, autochop, autonestbox, seedwatch, df-ai, dwarf manipulator.
 
  
−
===One-off changes===
+
== Download and Install ==
−
Includes commands like "cleanowned scattered x" or "reveal".
+
All new releases are announced on [https://store.steampowered.com/news/app/2346660 Steam], in a [http://www.bay12forums.com/smf/index.php?topic=164123.0 thread on the Bay12 forums], on [https://www.reddit.com/r/dwarffortress/ r/dwarffortress], and on the [https://dfhack.org/discord DFHack] and [https://discord.gg/kitfoxgames Kitfox] Discord servers. The current release can be downloaded from [https://store.steampowered.com/app/2346660/DFHack Steam] or [https://github.com/dfhack/dfhack/releases GitHub]. You can also find all past releases on GitHub, and the latest dev build (requires GitHub login) can be downloaded from [https://github.com/DFHack/dfhack/actions/workflows/build.yml?query=branch%3Adevelop+event%3Apush here], though its stability is not guaranteed.
  
−
===Additional features===
+
Stable releases are also available for 0.47.05, 0.42.06, 0.40.24, 0.34.11, 0.31.25, and other intermediate versions of DF. DFHack is currently also being ported to versions 0.28.181.40d and 0.23.130.23a - more information can be found [[User:Quietust#DFHack-40d|here]] and [[User:Quietust#DFHack-23a|here]], respectively.
−
Steam engines, power meter, improved siege engines.
 
  
−
===Stonesense===
+
* [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]
−
DFHack comes with [[Stonesense]] by default (except for unofficial r4 builds).
 
  
−
===Isoworld===
+
== Quickstart & Full Documentation ==
−
DFHack also has [[Isoworld]] integration.
+
For information about the commands in the utility, see DFHack's [https://docs.dfhack.org/en/stable/index.html documentation]. In particular, see the [https://docs.dfhack.org/en/stable/docs/Quickstart.html#quickstart-guide quickstart guide] and the [https://docs.dfhack.org/en/stable/docs/Tools.html#dfhack-tools categorized tool index]. Help for DFHack tools is also available in-game in the [https://docs.dfhack.org/en/stable/docs/tools/gui/launcher.html#gui-launcher gui/launcher interface]. For a quick list, with brief descriptions, of the commands available to you, enter the command <code>tags</code> to see tools by category or <code>ls</code> (or <code>dir</code>) to see the entire list. As of v50.08-r3, DFHack comes with more than 400 tools.
  
−
===Adventure mode===
+
* [https://docs.dfhack.org/en/stable/index.html DFHack's documentation] ● [https://docs.dfhack.org/en/stable/docs/Quickstart.html#quickstart-guide DFHack's Quickstart Guide]
−
See: advfort, companion-order.
 
  
−
==Scripts and Plugins==  
+
{{TipBox2|float=center|titlebg=red|width=80%|Bug reports|
 +
<small>If you are using DFHack (or other utilities), do not report bugs on the ''Dwarf Fortress'' bug tracker unless you can prove that the bug is not being caused by DFHack or one of its plugins. DFHack can be temporarily disabled by passing the <code>--disable-dfhack</code> commandline option when you run Dwarf Fortress.</small>
 +
}}
 +
 
 +
== Features ==
 +
[[File:Move_goods_dfhack.png|thumb|288px|right|Screenshot of the DFHack "Move goods to Trade depot" screen, showing filtering and search options.]]
 +
User Interface improvements, such as:
 +
* Search, sort, and filtering for screens with big lists.
 +
* Ability to designate placeholder buildings, furniture, and constructions that get automatically assigned building materials as they become available.
 +
* Ability to type characters not available on keyboards.
 +
 
 +
Automatic bugfixes, such as:
 +
* fix/stuck-instruments - Fix activity references on instruments whose previous player was interrupted to make them usable again.
 +
* fix/general-strike - Prevent dwarves from getting stuck and refusing to work.
 +
* orders sort - Sort manager orders by repeat frequency so one-time orders can be completed.
 +
* fix/empty-wheelbarrows - Empties wheelbarrows which have rocks stuck in them.
 +
 
 +
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
 +
* autonestbox - Assigns unpastured female egg-layers to nestbox zones.
 +
* prioritize - Ensures time-sensitive jobs get done quickly.
 +
* 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.
 +
 
 +
Gameplay modifications, such as:
 +
* 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
 +
* misery - Amplify negative thoughts.
 +
* starvingdead - Undead waste away over time.
 +
 
 +
Other scripts and plugins, such as:
 +
* [[Stonesense]] - an isometric visualizer of the map.
 +
 
 +
== Example commands ==
  
−
Originally a simple memory hacking tool, DFHack has grown to become a full-fledged unofficial extension of the game itself, adding in functionality where official development has lacked. One of the best features of DFHack is it's extensibility - anyone can create scripts or plugins. Due to its open-source and collaborative nature, anyone can add their own contribution to this tool. There are different kinds of contributions:
+
{| class=wikitable
 +
! Command
 +
! Description
 +
|-
 +
| <code>[https://docs.dfhack.org/en/stable/docs/tools/prospector.html#prospector prospect all]</code>
 +
| Prospect your embark location for a list of all the present minerals and plants.
 +
|-
 +
| <code>[https://docs.dfhack.org/en/stable/docs/tools/gui/reveal.html#gui-reveal gui/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>
 +
| Marks the tattered clothing dwarves insist on holding onto and marks it for dumping, so they go get newer clothes.
 +
|-
 +
| <code>[https://docs.dfhack.org/en/stable/docs/tools/open-legends.html#open-legends open-legends]</code>
 +
| For jumping into [[legends mode]] from a running fort or adventure.
 +
|}
  
−
    Binpatches are raw memory edits that alter the game's behavior, which is usually deduced from disassembling. Their main use is bugfixing or the removal of cumbersome, easily alterable constraints.
+
== Scripts and Plugins ==
−
    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. 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.
 
  
−
Some of the more notable are listed below; feel free to add to the list.
+
Originally a simple memory hacking tool, DFHack has grown to become a full-fledged unofficial extension of the game itself, adding in functionality where official development has lacked. One of the best features of DFHack is its extensibility - anyone can create scripts or plugins. Due to its open-source and collaborative nature, anyone can add their own contribution to this tool. There are different kinds of contributions:
  
−
=== User Interface ===
+
*Binpatches are raw memory edits that alter the game's behavior, which is usually deduced from disassembling. Their main use is bugfixing or the removal of cumbersome, easily alterable constraints.
 +
*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 the Lua scripting language and that use the DFHack-provided API bindings. They are not compiled and can be transferred between any platform and used across DFHack versions. They can break, though, if Dwarf Fortress changes the memory structures in the area that the script interacts with (this is rare, but possible). Also, because they run in an interpreter, they are unsuitable for tasks which involve large amounts of data (such as acting on every tile of the map).
  
−
The best-known are [http://www.bay12forums.com/smf/index.php?topic=119575 Falconne's UI Plugins], a collection which improves the in-game interface with features such as search functions in screens with big lists, the ability to place furniture before it's built and have it automatically allocated when available, box-select constructions(like laying designations) - including easier material selection and open space placement, easier pasturing, live happiness monitor, '''mouse support''', and an enhanced stocks screen.  The plugins make existing tasks significantly easier, and also add new functions to the game which greatly enhance the experience - such as the autochop log quotas, or the ability (with buildingplanner) to lay out rooms with Quickfort before creating the required furniture. 
+
== Remote API ==
  
−
There is also a [http://www.bay12forums.com/smf/index.php?topic=124708 GUI for the Autobutcher plugin].
+
DFHack provides a protobuf-based RPC connection to the game, enabling remote clients like Armok Vision. The service listens on <code>127.0.0.1:5000</code> (configurable within <code>dfhack-config/remote-server.json</code>).
  
−
=== Bugfixing ===
+
Currently there are no change-based or change-driven notifications, so remote fortress clients must perform the expensive operation of polling the desired volume every frame (via e.g. <code>GetBlockList</code>).
−
Many bugfixes are included with DFHack, but not enabled by default - check dfhack.init to see if the "tweak *" and "fix/*" lines are commented out. The [[Utility:Lazy_Newb_Pack|Starter Packs]] enable all bugfixes by default.
 
  
−
=== Features ===
+
More info on DFHack's remote API [https://docs.dfhack.org/en/stable/docs/dev/Remote.html here].
−
These plugins and scripts add features to the game that enhance the user's gameplay.
 
−
* [http://www.bay12forums.com/smf/index.php?topic=127116 Digging invaders], a plugin that allows hostiles to dig and deconstruct walls to path to one's fortress.
 
−
* [http://www.bay12forums.com/smf/index.php?topic=128487 Rendermax], a plugin that implements a lighting system at the graphics level.
 
−
* [http://www.bay12forums.com/smf/index.php?topic=136155 Dwarven Emigration], a plugin that allows unhappy dwarves to emigrate with their families.
 
  
−
=== Modding tools ===
+
[[Category:Utilities]]
−
These plugins and scripts add features to the game that enhance modding possibilities.
+
[[ru:Utility:DFHack]]
−
* [http://www.bay12forums.com/smf/index.php?topic=135597 DFHack scripts designed for use in interactions as "spells"]
 
−
* [http://www.bay12forums.com/smf/index.php?topic=135506 Miscellaneous DFHack script collection]
 

Latest revision as of 23:14, 19 November 2024

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
This utility page applies to multiple versions of DF.
DFHack
Dfhack-logo.png
Information
DFHack in-game help browser and command launcher

DFHack is a utility that can be used to improve the UI, automate some aspects of the game, add features, fix bugs, make a specific one-off change... or just straight-up mold the universe to your liking. For players that do not wish to wield these god-like powers, DFHack's god-mode (aka "Armok") tools can be hidden from the interface by enabling "mortal mode" in the DFHack control panel.

DFHack is a modding framework that is packaged alongside a suite of tools that use it. 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 and gameplay mod suite that allows tweaking DF in numerous ways. DFHack is 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.

By default, DFHack only enables UI improvements and bugfixes, but as you become more familiar with the game, you can explore DFHack's many optional and more advanced features.

On April 14, 2023, DFHack was additionally made available on Steam. Installing DFHack through Steam will add DFHack to an existing Steam installation of Dwarf Fortress. Note that it needs to be installed to the same Steam library and hard drive as Dwarf Fortress itself.

Download and Install[edit]

All new releases are announced on Steam, in a thread on the Bay12 forums, on r/dwarffortress, and on the DFHack and Kitfox Discord servers. The current release can be downloaded from Steam or GitHub. You can also find all past releases on GitHub, and the latest dev build (requires GitHub login) can be downloaded from here, though its stability is not guaranteed.

Stable releases are also available for 0.47.05, 0.42.06, 0.40.24, 0.34.11, 0.31.25, and other intermediate versions of DF. DFHack is currently also being ported to versions 0.28.181.40d and 0.23.130.23a - more information can be found here and here, respectively.

Quickstart & Full Documentation[edit]

For information about the commands in the utility, see DFHack's documentation. In particular, see the quickstart guide and the categorized tool index. Help for DFHack tools is also available in-game in the gui/launcher interface. For a quick list, with brief descriptions, of the commands available to you, enter the command tags to see tools by category or ls (or dir) to see the entire list. As of v50.08-r3, DFHack comes with more than 400 tools.

Bug reports

If you are using DFHack (or other utilities), do not report bugs on the Dwarf Fortress bug tracker unless you can prove that the bug is not being caused by DFHack or one of its plugins. DFHack can be temporarily disabled by passing the --disable-dfhack commandline option when you run Dwarf Fortress.


Features[edit]

Screenshot of the DFHack "Move goods to Trade depot" screen, showing filtering and search options.

User Interface improvements, such as:

  • Search, sort, and filtering for screens with big lists.
  • Ability to designate placeholder buildings, furniture, and constructions that get automatically assigned building materials as they become available.
  • Ability to type characters not available on keyboards.

Automatic bugfixes, such as:

  • fix/stuck-instruments - Fix activity references on instruments whose previous player was interrupted to make them usable again.
  • fix/general-strike - Prevent dwarves from getting stuck and refusing to work.
  • orders sort - Sort manager orders by repeat frequency so one-time orders can be completed.
  • fix/empty-wheelbarrows - Empties wheelbarrows which have rocks stuck in them.

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 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
  • autonestbox - Assigns unpastured female egg-layers to nestbox zones.
  • prioritize - Ensures time-sensitive jobs get done quickly.
  • 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.

Gameplay modifications, such as:

  • 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
  • misery - Amplify negative thoughts.
  • starvingdead - Undead waste away over time.

Other scripts and plugins, such as:

Example commands[edit]

Command Description
prospect all Prospect your embark location for a list of all the present minerals and plants.
gui/reveal Reveal the map so you can inspect the caverns and mineral layouts.
cleanowned scattered x Marks the tattered clothing dwarves insist on holding onto and marks it for dumping, so they go get newer clothes.
open-legends For jumping into legends mode from a running fort or adventure.

Scripts and Plugins[edit]

Originally a simple memory hacking tool, DFHack has grown to become a full-fledged unofficial extension of the game itself, adding in functionality where official development has lacked. One of the best features of DFHack is its extensibility - anyone can create scripts or plugins. Due to its open-source and collaborative nature, anyone can add their own contribution to this tool. There are different kinds of contributions:

  • Binpatches are raw memory edits that alter the game's behavior, which is usually deduced from disassembling. Their main use is bugfixing or the removal of cumbersome, easily alterable constraints.
  • 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 the Lua scripting language and that use the DFHack-provided API bindings. They are not compiled and can be transferred between any platform and used across DFHack versions. They can break, though, if Dwarf Fortress changes the memory structures in the area that the script interacts with (this is rare, but possible). Also, because they run in an interpreter, they are unsuitable for tasks which involve large amounts of data (such as acting on every tile of the map).

Remote API[edit]

DFHack provides a protobuf-based RPC connection to the game, enabling remote clients like Armok Vision. The service listens on 127.0.0.1:5000 (configurable within dfhack-config/remote-server.json).

Currently there are no change-based or change-driven notifications, so remote fortress clients must perform the expensive operation of polling the desired volume every frame (via e.g. GetBlockList).

More info on DFHack's remote API here.

Retrieved from "https://dwarffortresswiki.org/index.php?title=Utility:DFHack&oldid=304470"