Bay 12 Games Forum

DFHack is a cross-platform framework allowing for easier development of tools that access DF memory (and of course, making the game more enjoyable for players). It comes with some useful tools that can fix your fort and make it easier to manage. DFHack integrates with Dwarf Fortress and extends it with plugins, scripts, a console, a way to bind hotkeys to commands, support for external tools to connect over the network, and more.

Continued development of DFHack would be impossible without its contributors and definitely isn't a one man show. Check this out!

DFHack 50.12-r2.1: Download (Current stable, for 50.12, Windows and Linux, all builds)
Nightly builds: Download (May be unstable)

Note: all releases can be found on GitHub.

Please report bugs in the GitHub issue tracker. This includes documentation issues and gaps. Feature requests are also welcome there, or you can discuss features beforehand here if you prefer.
If bugs are only reported in this thread, they may be forgotten. You can create a GitHub account here in order to open issues in the issue tracker.

Documentation for the current stable version of DFHack can be found here: http://dfhack.readthedocs.io/en/stable/
Documentation for the latest development builds, including DFHack pre-releases, can be found here: http://dfhack.readthedocs.io/en/latest/

Some quick documentation links:

• Installing & Uninstalling DFHack
• List of commands and documentation

We have a couple chat options, listed here in order of age. Note that many people in these channels are idle and will only check them periodically. Please don't ask a question and leave seconds later without waiting for an answer.

• IRC: #dfhack on Libera (irc.libera.chat)
• Discord: dfhack.org/discord

(Note: our previous Freenode channel has been effectively deleted - many people have moved to Libera and/or Discord)
For even more support channels, see https://docs.dfhack.org/en/latest/docs/Support.html

The source code is available from GitHub. Please read the Compile document before building.

DFHack has many developers so we don't take donations. Donate generously to Toady instead! You can say it's in honor of DFHack if you want.

Some older versions of DFHack that aren't on GitHub can be found here: http://dethware.org/dfhack/download/

Previous threads: Peterix (through 0.34.11-r4) - Expwnent (through 0.43.03-r1)

The OS X executable is currently named "dwarfort.exe", which tends to confuse new players. Some people have concluded that the OS X package contains a Windows executable and opened reports on the bug tracker, or tried to run it through wine (which doesn't work because it is an OS X executable). Running it directly doesn't work either (unless the libraries DF requires are installed system-wide, which almost certainly won't be the case with fmodex and the version of libstdc++ DF uses) - the "df" script has to be used instead. This is also the case on Linux, but the executable is named "Dwarf_Fortress" and placed in the "libs" folder, which reduces its visibility and is a more fitting name. I'm not particularly concerned about the executable name, but I do think that moving it into the "libs" folder on OS X as well would reduce confusion, and would only require editing the "df" script.

Following some suggestions for the manipulator plugin that proved difficult to implement in C++, I've been working on a replacement script written in Lua. It currently implements most basic functionality of the manipulator plugin, although some (particularly more recent features like batch editing and custom professions) are not yet implemented:
Performance has improved recently - although this script isn't quite as fast as the plugin, performance shouldn't be a noticeable issue (see "Notes" below). There will usually be a small delay when the script starts, but CPU usage in general should be reasonable.

Usage:
* Download the latest release from GitHub
* Copy the "manipulator" folder from the archive to "hack/scripts/manipulator" in your DF folder.
* (Optional) Add a keybinding to dfhack.init (if you've already started DF, running this command in the DFHack console works as well):
keybinding add Alt-L@unitlist manipulator/main
(Alt-L can be changed to another key if you prefer.)
* On the unit list screen (u), press the key you bound to manipulator/main above or run manipulator/main in the DFHack console.

New features:
* Customizable columns: Columns can be added and edited in manipulator/columns.lua. (In fact, this is where the default columns are defined as well.) Columns can be reordered by pressing "C" in the main manipulator screen - their order persists until DF quits.
* The Shift key performs some additional functions in combination with the mouse - for example, reversing the skill sort order when clicking on grid headers and toggling an entire group of labors in the labor grid.

Manipulator plugin features already implemented:
* Basics (scrolling, labor modification) and most grid keybindings
* Viewing and zooming to units
* Sorting by skills
* Stable sort
* Batch edits

Manipulator plugin features not yet implemented:
* Sorting by column values
* Format options when editing unit names (e.g. including units' ages, professions, list positions)
* Custom professions

Possible features:
* Searching
* Saveable column layouts
* Allow columns to be defined in multiple scripts (for example, on a per-save basis or by dropping additional scripts into the hack/scripts/gui folder instead of editing manipulator-columns.lua)

Notes:
* This script requires DFHack 0.40.24-r2 or above.
* Bugs and feature requests can be reported in this thread or on the Github issue tracker
* This script makes use of a new C++ drawing API that isn't included in DFHack 0.40.24-r3 or earlier. If it is unavailable, this script will fall back to an alternative, slower implementation written in Lua. I've only noticed a 20% difference in speed on my machine, but performance should be better in future DFHack releases.

(This is very out-of-date. Many extra scripts are in the repo that aren't listed here, and the ones in the main folder in particular may be useful. I'll update this list at some point, although we're still trying to figure out how to deal with including scripts like these in DFHack.)

This is a collection of DFHack scripts that I've written. Sources are available on Github (you can download individual scripts by clicking the "Raw" button when viewing them, or download everything with the "Download ZIP" button in the sidebar).
Feature requests and bug reports can be made in the Github issue tracker or here. I prefer Github for organizational purposes (and may migrate suggestions and reports to the issue tracker), but reports and general discussion in this thread are fine as well.

Major UI scripts/changes:

• gui/cp437-table: Allows input of all CP437 characters
• gui/extended-status: Adds more pages to the z-status screen (currently just bedroom information)
• gui/load-screen: A replacement for the "Continue game" screen
• gui/settings-manager: An in-game init file editor. Currently supports most init.txt and d_init.txt settings and colors.txt, and support for announcements.txt is planned.

Cheating:

• adv-max-skills: Sets all of an adventurer's skills and attributes to their maximum values during creation

• embark-skills: Adjusts the skills of dwarves when embarking, similar to adv-max-skills

Miscellaneous:

• annc-monitor: Displays all announcements and reports (in color) in the DFHack console. More options are planned, such as displaying only certain types of announcements and writing announcements to a file with additional information.
• click-monitor: Displays the grid coordinates of the mouse (i.e. the tile position) when the mouse is clicked.
• invert-colors: Inverts DF's color scheme in-game. (This is intended as a proof-of-concept for colors.txt support in settings-manager.) Not tested with tilesets.

I'm rewriting this in Lua - you can find the development version of the script here (works with r3 and up).