- 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.
Difference between revisions of "Utility:DFHack"
(Added a (stubby) uses section) |
m (Changed quality rating from "Fine" to "Superior" using the rating script) |
||
| Line 1: | Line 1: | ||
| − | {{Quality| | + | {{Quality|Superior|13:02, 2 May 2014 (UTC)}} |
'''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; external application is a planned feature for the future. 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 and most-used utilities for the game, after [[Utilities#Dwarf Therapist|Dwarf Therapist]] and the [[tileset]]s, and is included in recent versions of the [[Utility:Lazy Newb Pack|Lazy Newb Pack]] on all platforms. | '''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; external application is a planned feature for the future. 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 and most-used utilities for the game, after [[Utilities#Dwarf Therapist|Dwarf Therapist]] and the [[tileset]]s, and is included in recent versions of the [[Utility:Lazy Newb Pack|Lazy Newb Pack]] on all platforms. | ||
Revision as of 13:02, 2 May 2014
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; external application is a planned feature for the future. 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 and most-used utilities for the game, after Dwarf Therapist and the tilesets, and is included in recent versions of the Lazy Newb Pack on all platforms.
For an exhaustive list of and manual on the commands in the utility, see the GitHub documentation. This wiki also has a DFHack programming page.
If you are using DFHack, 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.
Installation
If you use a recent edition of the Lazy Newb Pack, DFHack is already installed and configured; otherwise see the instructions on the Bay12 forum thread for separate installation. The project is currently hosted on GitHub; for source, binaries, and a detailed discussion of how the program works, see here. All new releases are announced in a thread on the Bay12 forums. DFHack works on Windows XP, Vista, 7, any modern Linux distribution, and OS X 10.6 and later. On Windows, you have to use the SDL version of DF. Currently, version 0.34.11 is supported (and tested). If you need DFHack for older versions, look for older releases.
DFHack is currently also being ported to Dwarf Fortress versions 0.28.181.40d and 0.23.130.23a - more information can be found here and here, respectively.
Common Uses
DFHack is often used to automate some aspects of Fortress Mode, or to make a specific one-off change.
Automation
See: workflow, autolabor, autobutcher, autochop, autonestbox, seedwatch.
One-off changes
Includes commands like "cleanowned scattered x" or "reveal".