Editing Utility:DFHack

{{Quality|Superior|13:02, 2 May 2014 (UTC)}}
{{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; 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.

For an exhaustive list of and manual on the commands in the utility, see the [https://github.com/peterix/dfhack#commands GitHub documentation].  This wiki also has a [[Utility:DFHack/Programming|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 [[Utility:Lazy Newb Pack|recent edition of the Lazy Newb Pack]], DFHack is already installed and configured; otherwise see the instructions on [http://www.bay12forums.com/smf/index.php?topic=139553 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 [https://github.com/DFHack/dfhack here]. All new releases are announced in a [http://www.bay12forums.com/smf/index.php?topic=139553 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 [http://dwarffortresswiki.org/index.php/User:Quietust#DFHack-40d here] and [http://dwarffortresswiki.org/index.php/User:Quietust#DFHack-23a 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, df-ai, dwarf manipulator.  

===One-off changes===
Includes commands like "cleanowned scattered x" or "reveal".

===Additional features===
Steam engines, power meter, improved siege engines.

===Stonesense===
DFHack comes with [[Stonesense]] by default (except for unofficial r4 builds).

==Scripts and Plugins==
One of the best features of DFHack is it's extensibility - anyone can create scripts or plugins.  Some of the more notable are listed below; feel free to add to the list.  

=== User Interface ===

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.  

There is also a [http://www.bay12forums.com/smf/index.php?topic=124708 GUI for the Autobutcher plugin].  

=== Bugfixing ===
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.  

The [http://www.bay12forums.com/smf/index.php?topic=126558 growth bug] is not fixed by DFHack by default, and can be patched with either a [http://dffd.wimbli.com/file.php?id=7849 plugin] (windows) or a [http://www.bay12forums.com/smf/index.php?topic=91166.msg4313566#msg4313566 script] (any platform).

=== Features ===
These plugins and scripts add features to the game, and are mostly used by modders.
* [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.
* [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]

=== Cheating ===
These plugins and scripts allow cheating to various degrees. Some are covered more in-depth than the Readme on this wiki:
* [[/createitem/]]: Creates arbitrary items made of any material at the feet of a unit