Utility:DFHack - Revision history

Quietust: /* Download and Install */

2026-03-17T21:05:47Z

Download and Install

Lethosor: /* Tutorials */

2024-12-14T06:23:48Z

Tutorials

Urist2000: + Tutorials section & official youtube channel

2024-12-13T23:46:34Z

+ Tutorials section & official youtube channel

Urist2000: /* Download and Install */ new structure; more exposure for quickstart and docs

2024-11-19T23:14:24Z

Download and Install: new structure; more exposure for quickstart and docs

Silverwing235 at 11:21, 19 July 2024

2024-07-19T11:21:27Z

Silverwing235: formatting

2024-07-19T09:53:23Z

formatting

Myk002: make Remote API a top-level section

2024-04-28T22:40:11Z

make Remote API a top-level section

Myk002: remove outdated info

2024-04-28T22:39:04Z

remove outdated info

Myk002: refresh example commands

2024-04-28T22:33:54Z

refresh example commands

Myk002: introduction editing pass

2024-04-28T22:29:35Z

introduction editing pass

@@ Line 22: / Line 22: @@
 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.
-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.
+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. Unofficial ports of DFHack for versions 0.28.181.40d and 0.23.130.23a are also available - for more information, see [[User:Quietust#DFHack-40d|here]] and [[User:Quietust#DFHack-23a|here]], respectively.
 * [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]

@@ Line 108: / Line 108: @@
 == Tutorials ==
 *[https://www.youtube.com/@dfhack DFHack Offical] on YouTube.
-*[https://www.youtube.com/watch?v=NNBcQ9Km6P8 Introduction to DFHAck] by FurtherReading
+*[https://www.youtube.com/watch?v=NNBcQ9Km6P8 Introduction to DFHack] by FurtherReading
 *[https://www.youtube.com/playlist?list=PLuA85gNtnLtKPMltGKHcuTx7yrEWNxxh6 DFHack Commands Playlist] by Twisted Logic Gaming
 [[Category:Utilities]]
 [[ru:Utility:DFHack]]

@@ Line 105: / Line 105: @@
 More info on DFHack's remote API [https://docs.dfhack.org/en/stable/docs/dev/Remote.html here].
 [[Category:Utilities]]
 [[ru:Utility:DFHack]]

@@ Line 24: / Line 24: @@
 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.
 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.
-* [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]
+* [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]
 {{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 ==

@@ Line 11: / Line 11: @@
 }}
 [[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 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].
+'''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].
 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.
@@ Line 75: / Line 75: @@
 |-
 | <code>[https://docs.dfhack.org/en/stable/docs/tools/prospector.html#prospector prospect all]</code>
-| To prospect your embark location for a list of all the present minerals and plants.
+| 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>
@@ Line 81: / Line 81: @@
 |-
 | <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.
+| 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.
+| For jumping into [[legends mode]] from a running fort or adventure.
 |}

@@ Line 17: / Line 17: @@
 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 [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.
+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.
 == Download and Install ==

@@ Line 87: / Line 87: @@
 |}
-==Scripts and Plugins==
+== Scripts and Plugins ==
 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:
@@ Line 95: / Line 95: @@
 *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 ===
+== Remote API ==
 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>).
 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>).
 [[Category:Utilities]]
 [[ru:Utility:DFHack]]

@@ Line 93: / Line 93: @@
 *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 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).
+*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).
-Some of the more notable are listed below; feel free to add to the list.
+=== Remote API ===
-=== User Interface ===
+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>).
-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.
+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>).
 [[Category:Utilities]]
 [[ru:Utility:DFHack]]

@@ Line 68: / Line 68: @@
 * [[Stonesense]] - an isometric visualizer of the map.
-== Common use ==
+== Example commands ==
 {| class=wikitable
@@ Line 74: / Line 74: @@
 ! Description
 |-
-| <code>[https://docs.dfhack.org/en/stable/docs/tools/prospector.html#prospector prospect]</code>
+| <code>[https://docs.dfhack.org/en/stable/docs/tools/prospector.html#prospector prospect all]</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/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>
-| Collects the random junk dwarves fling about the fortress and marks it for dumping.
+| 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/exportlegends.html#exportlegends exportlegends]</code>
+| <code>[https://docs.dfhack.org/en/stable/docs/tools/open-legends.html#open-legends open-legends]</code>
-| For exporting [[Legends mode]] information.
+| For jumping into [[Legends mode]] from a running fort or adventure.
 |}