github DFHack/dfhack 51.09-r1
DFHack 51.09-r1

latest release: 51.10-r1
one day ago

Q: How do I download DFHack?

A: Either add to your Steam library from our Steam page or scroll to the latest release on our GitHub releases page, expand the "Assets" list, and download the file for your platform (e.g. dfhack-XX.XX-rX-Windows-64bit.zip. If you are on Windows and are manually installing from the zip file, please remember to right click on the file after downloading, open the file properties, and select the "Unblock" checkbox. This will prevent issues with Windows antivirus programs.


This release is compatible with all distributions of Dwarf Fortress: Steam, Itch, and Classic.

Please report any issues (or feature requests) on the DFHack GitHub issue tracker. When reporting issues, please upload a zip file of your savegame and a zip file of your mods directory to the cloud and add links to the GitHub issue. Make sure your files are downloadable by "everyone with the link". We need your savegame to reproduce the problem and test the fix, and we need your active mods so we can load your savegame. Issues with savegames and mods attached get fixed first!

Highlights

New toolbar icons for popular tools

New toolbar icons for popular tools

By popular demand, gui/sitemap now has an icon on the main toolbar at the bottom of the screen. Click this button to quickly find and zoom to (or follow) units, locations (like your guildhalls and hospital), or artifacts. You can search by either native names or translated names for units and artifacts.

If you prefer hotkeys, the Ctrl-g hotkey for gui/sitemap still works as it always has.

gui_sitemap_toolbar

Similarly gui/mass-remove now has a toolbar button that shows when you click the vanilla "eraser" toolbar icon. The new button shows up next to the other "remove" icons. gui/mass-remove allows you to area select to remove any combination of constructions, buildings, stockpiles, and zones. For buildings and constructions, you also have the option to only remove those that are fully built, those that are planned but not yet built, or both.

gui_mass_remove_toolbar

Announcements

Experimental branch support, PSAs

###Experimental branch support

If you are subscribed to the DF experimental branch, be sure to also select the experimental branch in your Steam client for DFHack.

PSAs

As always, remember that, just like the vanilla DF game, DFHack tools can also have bugs. It is a good idea to save often and keep backups of the forts that you care about.

Some DFHack tools that worked in previous (pre-Steam) versions of DF have not been updated yet and are marked with the "unavailable" tag in their docs. If you try to run them, they will show a warning and exit immediately. You can run the command again to override the warning (though of course the tools may not work). We make no guarantees of reliability for the tools that are marked as "unavailable".

The in-game interface for running DFHack commands (gui/launcher) will not show "unavailable" tools by default. You can still run them if you know their names, or you can turn on dev mode by hitting Ctrl-D while in gui/launcher and they will be added to the autocomplete list. Some tools listed as "unavailable" in the docs do not compile yet and are not accessible at all, even when in dev mode.

If you see a tool complaining about the lack of a cursor, know that it's referring to the keyboard cursor (which used to be the only real option in Dwarf Fortress). You can enable the keyboard cursor by entering mining mode or selecting the dump/forbid tool and hitting Alt-K (the DFHack keybinding for toggle-kbd-cursor). We're working on making DFHack tools more mouse-aware and accessible so this step isn't necessary in the future.

Changelog

New tools, fixes, and improvements

New Features

  • gui/journal: Ctrl-j hotkey to launch gui/journal now works in adventure mode!
  • gui/mass-remove: add a button to the bottom toolbar when eraser mode is active for launching gui/mass-remove
  • gui/sitemap: add a button to the toolbar at the bottom left corner of the screen for launching gui/sitemap
  • idle-crafting: default to only considering happy and ecstatic units for the highest need threshold

Fixes

  • Fix processing error in the overlay that displays unit preferences in the baron selection list
  • gui/journal: prevent pause/unpause events from leaking through the UI when keys are mashed
  • idle-crafting: check that units still have crafting needs before creating a job for them

API

  • Filesystem module: rewritten to use C++ standard library components, for better portability

Don't miss a new dfhack release

NewReleases is sending notifications on new releases.