DFHack - Dwarf Fortress Modding Engine News

[h3]Q: How do I download DFHack?[/h3]
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.

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

• Install DFHack from Steam
• Manual install
• Quickstart guide (for players)
• Modding guide (for modders)

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!
[h2]Highlights[/h2][h3]Search! Search! Search![/h3]
We finally have search widgets for many of the screens with long lists. No longer will you need to scroll endlessly to find Bim Zasitisos, Cook. You can just type "bim", or "cook", or maybe "knifedales", since that's what "Zasitisos" translates to and it's the name you see in some contexts.

Search units on the Citizens tab:


Search (and filter) interview candidates on the Justice tab:


Search artifacts on the world screen (for raids):


Search religions for dedicating a new temple:


So far, here are the screens that are covered:

• Info -> Creatures -> Citizens
• Info -> Creatures -> Pets/Livestock
• Info -> Creatures -> Pets/Livestock -> Overall Training
• Info -> Creatures -> Pets/Livestock -> Assign Trainer
• Info -> Creatures -> Others
• Info -> Creatures -> Dead/Missing
• Info -> Tasks
• Info -> Labor -> Work details
• Info -> Objects -> Artifacts
• Info -> Objects -> Symbols
• Info -> Objects -> Named objects
• Info -> Objects -> Written content
• Info -> Justice ->
• -> Interrogate
• Info -> Justice ->
• -> Convict
• Location selector -> Temple
• Location selector -> Guildhall
• Unit selector -> Bedroom
• Unit selector -> Office
• Unit selector -> Dining hall
• Unit selector -> Tomb
• Unit selector -> Workshop worker
• Unit selector -> Occupation
• Unit selector -> Burrow
• Unit selector -> Squad kill order

Plus the screens that were already covered in previous DFHack versions:

• Unit selector -> Squad assignment
• Zone -> Pasture -> Animal assignment
• Zone -> Pit -> Animal assignment
• Building -> Cage -> Animal assignment
• Building -> Restraint -> Animal assignment

[h3]Preserve tomb assignments[/h3]
Have you noticed that your nobles don't actually get buried in the nice tombs you assigned to them while they were alive and demanding nice tombs? This is because DF loses track of that assignment when they die, which is amusingly and tragically ironic.

Enable preserve-tombs in the DFHack gui/control-panel ("Fort" and "Autostart" tabs) to keep track of those tomb assignments and ensure they are actually used for their intended purposes.
[h2]Announcements[/h2][h3]PSAs[/h3]
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.

Many 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 do not compile yet and are not available 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.
[h2]New Tools[/h2]

• add-recipe: (reinstated) add reactions to your civ (e.g. for high boots if your civ didn't start with the ability to make high boots)
• preserve-tombs: keep tombs assigned to units when they die
• spectate: (reinstated) automatically follow dwarves, cycling among interesting ones

[h2]New Features[/h2]

• drain-aquifer:
  • gained ability to drain just above or below a certain z-level
  • new option to drain all layers except for the first N aquifer layers, in case you want some aquifer layers but not too many
• gui/control-panel: drain-aquifer --top 2 added as an autostart option
• logistics: automelt now optionally supports melting masterworks; click on gear icon on stockpiles overlay frame
• sort:
  • new search widgets for Info panel tabs, including all "Creatures" subtabs, all "Objects" subtabs, "Tasks", and the "Work details" subtab under "Labor"
  • new search and filter widgets for the "Interrogate" and "Convict" screens under "Justice"
  • new search widgets for location selection screen (when you're choosing what kind of guildhall or temple to dedicate)
  • new search widgets for burrow assignment screen and other unit assignment dialogs
  • new search widgets for artifacts on the world/raid screen

[h2]Fixes[/h2]

• gui/sandbox: fix scrollbar moving double distance on click
• hide-tutorials: fix the embark tutorial prompt sometimes not being skipped
• suspendmanager: fix errors when constructing near the map edge
• zone: don't show animal assignment link for cages and restraints linked to dungeon zones (which aren't normally assignable)

[h2]Misc Improvements[/h2]

• orders: recheck command now only resets orders that have conditions that can be rechecked
• overlay: allow overlay_onupdate_max_freq_seconds to be dynamically set to 0 for a burst of high-frequency updates
• sort: added help button for squad assignment search/filter/sort
• zone: animals trained for war or hunting are now labeled as such in animal assignment screens

[h2]Removed[/h2]

• FILTER_FULL_TEXT: moved from gui.widgets to utils; if your full text search preference is lost, please reset it in gui/control-panel

[h2]Lua[/h2]

• added GRAY color aliases for GREY colors
• utils.search_text: text search routine (generalized from internal widgets.FilteredList logic)

[h2]Structures[/h2]

• add new global: translate_name
• artifact_rumor_locationst: defined
• viewscreen_worldst: defined types for view_mode and artifacts_arl fields
• world_view_mode_type: defined

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

• Install DFHack from Steam
• Manual install
• Quickstart guide (for players)
• Modding guide (for modders)

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!
[h2]Highlights[/h2][h3]Display furniture item selector[/h3]



The vanilla screen for choosing which items you want to display on a pedestal or display case requires quite a bit of scrolling and clicking to use. It is also hard to figure out how the items you have assigned will affect the value of the room. There is now an alternate dialog that should make the process much easier and less opaque:



You can search items by name (including book titles), filter by quality (e.g. see only artifacts), and sort by name, value, or where the item is currently assigned for display.

If the pedestal is in a guildhall or temple, there is also a convenient indicator for whether you've added enough value to bump the guildhall or temple to the next tier. For example, if you need to provide your citizens with a grand guildhall, the indicator will change from "Guildhall" to "Grand guildhall" when you've assigned items with enough value.
[h3]Scrolling for the unit list when embarking[/h3]



Some people have already experimented with the newly re-added startdwarf script, which allows you to change the number of dwarves you embark with, and have found that the DF embark screen doesn't support scrolling for the unit list. This means that if you embark with more dwarves than can fit on your screen, you cannot select them to configure their skills.

We now have a DFHack-added scrollbar so you can scroll up and down through the list and configure each of your extra dwarves:



Note that the vanilla screen was not intended to be scrolled, so the behavior of the list is a little odd. When you select a dwarf to configure, the list will jump so that the dwarf you selected is at the top of the screen. This can be a little disorienting, but the dwarf is still configurable, and all dwarves are accessible.
[h2]Announcements[/h2][h3]Mouse event definitions have changed for scripts[/h3]
This only affects modders and players who are writing their own DFHack scripts and who react to mouse events like _MOUSE_L or _MOUSE_L_DOWN. Everyone else can skip reading this.

Back in the pre-v50 days, when the mouse was much less used in DF, I made a mistake in how I interpreted DF's handling of mouse button state. The result is that DFHack has been representing mouse state incorrectly to the Lua scripts. This hasn't been much of a problem since all the scripts were written to misinterpret the state the same way. However, now that DFHack tools are integrating more closely with the vanilla DF UI, the difference in interpretation of mouse state is causing conflicts.

The _MOUSE_L event now correctly fires when the mouse button has just been clicked, and the _MOUSE_L_DOWN event now correctly fires when the mouse button is held down. The previous definitions were backwards.

If you have written your own script and you refer to mouse events in your onInput(keys) function, you can update to the new definitions by swapping references to _MOUSE_L with _MOUSE_L_DOWN and vice versa. Similarly for _MOUSE_R and _MOUSE_M, if you happen to use them. My apologies for breaking scripts. This is something we try not to do very often, though hopefully this change will make up for the hassle by allowing scripts to integrate more smoothly with vanilla DF widgets. Thanks!
[h3]PSAs[/h3]
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.

Many 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 do not compile yet and are not available 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.
[h2]New Tools[/h2]

• startdwarf: (reinstated) set number of starting dwarves
• tubefill: (reinstated) replenishes mined-out adamantine

[h2]New Features[/h2]

• A new searchable, sortable, filterable dialog for selecting items for display on pedestals and display cases
• startdwarf: overlay scrollbar so you can scroll through your starting dwarves if they don't all fit on the screen

[h2]Fixes[/h2]

• EventManager: Unit death event no longer misfires on units leaving the map
• autolabor: ensure vanilla work details are reinstated when the fort or the plugin is unloaded
• suspendmanager: fixed a bug where floor grates, bars, bridges etc. wouldn't be recognised as walkable, leading to unnecessary suspensions in certain cases.
• dfhack.TranslateName(): fixed crash on certain invalid names, which affected warn-starving

[h2]Misc Improvements[/h2]

• EventManager:
  • guard against potential iterator invalidation if one of the event listeners were to modify the global data structure being iterated over
  • for onBuildingCreatedDestroyed events, changed firing order of events so destroyed events come before created events
• devel/inspect-screen: display total grid size for UI and map layers
• digtype:
  • designate only visible tiles by default, and use "auto" dig mode for following veins
  • added options for designating only current z-level, this z-level and above, and this z-level and below
• hotkeys:
  • make the DFHack logo brighten on hover in ascii mode to indicate that it is clickable
  • use vertical bars instead of "!" symbols for the DFHack logo in ascii mode to make it easier to read
• suspendmanager: now suspends constructions that would cave-in immediately on completion

[h2]Lua[/h2]

• mouse key events are now aligned with internal DF semantics: _MOUSE_L indicates that the left mouse button has just been pressed and _MOUSE_L_DOWN indicates that the left mouse button is being held down. similarly for _MOUSE_R and _MOUSE_M. 3rd party scripts may have to adjust.

[h2]Structures[/h2]

• add new global: start_dwarf_count

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

• Install DFHack from Steam
• Manual install
• Quickstart guide (for players)
• Modding guide (for modders)

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!
[h2]Announcements[/h2][h3]Linux support[/h3]
As of DF 50.10, both DF and DFHack can run natively on Linux. If you're subscribed to DF and DFHack on Steam, here's how to switch over:

• In the Steam client, open the properties for Dwarf Fortress
• Select the "Compatibility" section and deselect "Force the use of a specific Steam Play compatibility tool"
• DF should update with the Linux native version

You can tell if you did it right if you no longer have Dwarf Fortress.exe in your DF directory and instead have dwarfort, which is the Linux binary.

Then, turn off the compatibility layer for DFHack. dfhooks.dll will disappear and you'll get libdfhooks.so and the dfhack script in its place.

Sometimes, Steam says you've got the Linux version, but when you look you see you still have Dwarf Fortress.exe instead of dwarfort. Try re-enabling the Proton compatibility layer and then turning off the compatibility layer again until it "sticks".

The DFHack terminal console works differently on Linux

You can run DF with DFHack from the Steam client without issues. However, if you want an external DFHack terminal console, you have to run from the commandline with the ./dfhack launcher script.

On Windows (or in Windows emulation), you could use the show command to pop up an external DFHack terminal console. You would use this for running DFHack commands from outside the game window, and the external terminal is the only way to run commandline-interactive DFHack commands like tiletypes and the interactive mode of the lua interpreter.

Linux has a different method of providing a terminal console. You can't spawn it dynamically like you can on Windows. You have to start DF from the commandline, and the terminal from which you ran ./dfhack becomes the terminal console. This should be a familiar process to many Linux users (most Linux commands work this way), but the change is jarring if you're not expecting it. We're also looking into providing a virtual console that doesn't depend on an existing system console so you can still get a console even if you run from Steam, but that work is far from being completed.

You can still launch from Steam if you want to. Many tools log information and errors to the console, though, so if you run into strange issues, it might be useful to try running from the commandline to see if there is diagnostic output there that can help you.
[h3]PSAs[/h3]
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.

Many 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 do not compile yet and are not available 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.
[h2]Highlights[/h2]
This is just a compatibility release; please see the release notes for 50.09-r3 and 50.09-r4 for significant recent changes to DFHack.
[h2]Fixes[/h2]

• 'fix/general-strike: fix issue where too many seeds were getting planted in farm plots
• Linux launcher: allow Steam Overlay and game streaming to function
• autobutcher: don't ignore semi-wild units when marking units for slaughter

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

For Linux support, please configure your Steam client to subscribe to the DF beta release branch and the DFHack 50.10-beta release branch.

• Install DFHack from Steam
• Manual install
• Quickstart guide (for players)
• Modding guide (for modders)

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!
[h2]Announcements[/h2]
Please see the release notes for DFHack 50.09-r3 for extensive information on Linux support.
[h3]PSAs[/h3]
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.

Many 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 do not compile yet and are not available 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.
[h2]Highlights[/h2][h3]Squad assignment sort improvements[/h3]




Units now have a rating displayed next to them. The ratings are the values used for the current sort, and are colored based on how "good" the unit is according to the sort option. The "stress face" graphics are used for the "stress" and "need for training" sorts to indicate how dire the need is.

In addition to the new "need for training" sort, there are also a few new filters. You can now choose whether mothers with infants, units with weak mental fortitude (who would then become unduly stressed by military service), and critically injured units are shown as candidates.
[h3]Smooth/carve designation indicators for ASCII mode[/h3]




ASCII mode has been missing any indication of smoothing/engraving/track carving/fortification carving designations. DFHack will now automatically add in visual indicators so you can see what you have designated. They will flash between an icon indicating the designation type and the priority you have set the designation for, similar to how the information was displayed in older versions of DF.
[h2]New Features[/h2]

• dig: new overlay for ASCII mode that visualizes designations for smoothing, engraving, carving tracks, and carving fortifications

[h2]Fixes[/h2]

• buildingplan: make the construction dimensions readout visible again
• gui/mod-manager: don't continue to display overlay after the raws loading progress bar appears
• seedwatch: fix a crash when reading data saved by very very old versions of the plugin

[h2]Misc Improvements[/h2]

• autofish: changed --raw argument format to allow explicit setting to on or off
• caravan: move goods to depot screen can now see/search/trade items inside of barrels and pots
• gui/launcher: show tagged tools in the autocomplete list when a tag name is typed
• sort:
  • add sort option for training need on squad assignment screen
  • filter mothers with infants, units with weak mental fortitude, and critically injured units on the squad assignment screen
  • display a rating relative to the current sort order next to the visible units on the squad assignment screen

[h2]API[/h2]

• overlay: overlay widgets can now declare a version attribute. changing the version of a widget will reset its settings to defaults. this is useful when changing the overlay layout and old saved positions will no longer be valid.

[h2]Lua[/h2]

• argparse.boolean: convert arguments to lua boolean values.

[h2]Structures[/h2]

• Identified a number of previously anonymous virtual methods in itemst

[h2]Documentation[/h2]

• add instructions for downloading development builds to the Installing page

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

For the Dwarf Fortress beta branch on Steam, this release works with the Linux version (50.09-linux1) but NOT the Windows version. Windows users have to move to the DF default branch to be able to use DFHack. Note that the Windows version currently on the beta branch has no new features compared to the default branch, so you won't be missing out on anything.

• Install DFHack from Steam
• Manual install
• Quickstart guide (for players)
• Modding guide (for modders)

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!
[h2]Announcements[/h2][h3]Linux support![/h3]


Both DF and DFHack now run natively on Linux. If you're on Linux, we encourage you to try it out! The interface is noticeably snappier, FPS is up, and load times are reduced. If you're subscribed to DF and DFHack on Steam, here's how to switch over:

• In the Steam client, open the properties for Dwarf Fortress
• In the "Betas" section, switch to the "beta" branch
• Let that finish updating
• Select the "Compatibility" section and deselect "Force the use of a specific Steam Play compatibility tool"
• DF should update again with the Linux native version

You can tell if you did it right if you no longer have Dwarf Fortress.exe in your DF directory and instead have dwarfort, which is the Linux binary. The plan is to "officially" release Linux support with DF 50.10, so once DF 50.10 comes out, you should be able to switch back to the default Steam branch and keep the native Linux support.

Then, turn off the compatibility layer for DFHack. dfhooks.dll will disappear and you'll get libdfhooks.so and the dfhack script in its place.

Sometimes, Steam says you've got the Linux version, but when you look you see you still have Dwarf Fortress.exe instead of dwarfort. Try re-enabling the Proton compatibility layer and then turning off the compatibility layer again until it "sticks".

Major caveat for DF 50.09-linux1

This particular beta release of Dwarf Fortress has address layout randomization enabled. This causes some trouble for DFHack since DFHack needs to know the memory addresses of several key data structures. For this release only, be sure to start DF by launching DFHack from the Steam client or by running the ./dfhack commandline startup script. That will normalize the address space and allow DF to run with DFHack. Otherwise, DF will crash on startup. Again, this is only for this release. Future releases will not need this workaround and should go back to allowing you to start DF from either the Dwarf Fortress or DFHack Steam client entries, or from either the ./dwarfort or ./dfhack commandline commands.

The DFHack terminal console works differently on Linux

You can run DF with DFHack by starting DFHack in the Steam client. However, if you want an external DFHack terminal console, you have to run from the commandline.

On Windows, you could use the show command to pop up an external DFHack terminal console. You could use this for running DFHack commands from outside the game window, and the external terminal is the only way to run commandline-interactive DFHack commands like tiletypes and the interactive mode of the lua interpreter.

Linux has a different method of providing a terminal console. You can't spawn it dynamically like you can on Windows. You have to start DF from the commandline, and the terminal from which you ran ./dwarfort becomes the terminal console. This should be a familiar process to many Linux users (most Linux commands work this way), but the change is jarring if you're not expecting it. We're also looking into providing a virtual console that doesn't depend on an existing system console so you can still get a console even if you run from Steam, but that work is far from being completed.

You can still launch DFHack from Steam if you want to. Many tools log information and errors to the console, though, so if you run into strange issues, it might be useful to try running from the commandline to see if there is diagnostic output there that can help you.
[h3]PSAs[/h3]
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.

Many 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 do not compile yet and are not available 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.
[h2]Highlights[/h2][h3]Hide tutorial popups[/h3]


Once you've played a few forts, you probably don't need the tutorial popups that assault assist you when you open certain screens. Enable hide-tutorials in the System tab of gui/control-panel and never be bothered by them again!
[h3]Search and sort for squad assignment screen[/h3]




When you bring up the screen to assign units to squads, there are now widgets for searching, sorting, and filtering. The default sort is by "melee effectiveness", which takes both weapon skill and physical attributes into account, but you can choose from a variety of relevant ascending or descending sorting orders.

Thanks to research into combat mechanics by community contributor Halifay, you can also sort by melee and ranged "potential", which predicts how effective a unit could become in the future, given adequate training.

There are also configurable filters to show or hide units in other squads, appointed/elected officials (like your manager, high priests, and doctors), and nobility.

Of course, if you know exactly who you're looking for, you can also search for units by name.
[h3]Animal assignment[/h3]




The "Assign to pasture" screen released in the previous DFHack version has been expanded and generalized to support cages, restraints, and pits/ponds. Please tell us if you have any additional needs for animal assignment that those screens don't meet!
[h3]Trade good selection[/h3]




The "Bring goods to trade depot" screen can now see inside bins, and you can select individual items within bins for trade instead of the entire bin, if you so choose. You can also search for contents within bins, even when in "bring the bin" mode. For example, you can find the "Gem bin"s that contain rubies by searching for "ruby".
[h3]One-click UI integration for exportlegends[/h3]




exportlegends now sports a new integration with the vanilla "Export XML" button. Now you can generate both the vanilla export and the extended data export with a single click!
[h3]Onscreen HUD getting in your way? Hide it![/h3]




hide-interface hides all the vanilla UI elements for clean screenshots or distraction-free fortress watching. Even with the interface hidden, you can still pause/unpause the game with spacebar and move around the map with the keyboard or mouse. Hide that cluster of urgent notifications bubbles for a while and just enjoy watching your citizens scurry around for a while : )
[h2]New Tools[/h2]

• devel/scan-vtables: scan and dump likely vtable addresses (for memory research)
• hide-interface: hide the vanilla UI elements for clean screenshots or laid-back fortress observing
• hide-tutorials: hide the DF tutorial popups; enable in the System tab of gui/control-panel
• set-orientation: tinker with romantic inclinations (reinstated from back catalog of tools)

[h2]New Features[/h2]

• buildingplan: one-click magma/fire safety filter for planned buildings
• exportlegends: new overlay that integrates with the vanilla "Export XML" button. Now you can generate both the vanilla export and the extended data export with a single click!
• sort: search, sort, and filter for squad assignment screen
• zone: advanced unit assignment screens for cages, restraints, and pits/ponds

[h2]Fixes[/h2]

• Core:
  • reload scripts in mods when a world is unloaded and immediately loaded again
  • fix text getting added to DFHack text entry widgets when Alt- or Ctrl- keys are hit
• autobutcher: fix ticks commandline option incorrectly rejecting positive integers as valid values
• buildingplan: ensure selected barrels and buckets are empty (or at least free of lye and milk) as per the requirements of the building
• caravan:
  • corrected prices for cages that have units inside of them
  • correct price adjustment values in trade agreement details screen
  • apply both import and export trade agreement price adjustments to items being both bought or sold to align with how vanilla DF calculates prices
  • cancel any active TradeAtDepot jobs if all caravans are instructed to leave
• emigration:
  • fix errors loading forts after dwarves assigned to work details or workshops have emigrated
  • fix citizens sometimes "emigrating" to the fortress site
• fix/retrieve-units: fix retrieved units sometimes becoming duplicated on the map
• gui/launcher, gui/gm-editor: recover gracefully when the saved frame position is now offscreen
• gui/sandbox: correctly load equipment materials in modded games that categorize non-wood plants as wood
• orders: prevent import/export overlay from appearing on the create workorder screen
• quickfort: cancel old dig jobs that point to a tile when a new designation is applied to the tile
• seedwatch: ignore unplantable tree seeds
• starvingdead: ensure sieges end properly when undead siegers starve
• suspendmanager:
  • Fix the overlay enabling/disabling suspendmanager unexpectedly
  • improve the detection on "T" and "+" shaped high walls
• tailor: remove crash caused by clothing items with an invalid maker_race
• dialogs.MessageBox: fix spacing around scrollable text

[h2]Misc Improvements[/h2]

• Surround DFHack-specific UI elements with square brackets instead of red-yellow blocks for better readability
• autobutcher: don't mark animals for butchering if they are already marked for some kind of training (war, hunt)
• caravan: optionally display items within bins in bring goods to depot screen
• createitem: support creating items inside of bags
• devel/lsmem: added support for filtering by memory addresses and filenames
• gui/design: change "auto commit" hotkey from c to Alt-c to avoid conflict with the default keybinding for z-level down
• gui/gm-editor:
  • hold down shift and right click to exit, regardless of how many substructures deep you are
  • display in the title bar whether the editor window is scanning for live updates
• gui/liquids: support removing river sources by converting them into stone floors
• gui/quickfort: blueprint details screen can now be closed with Ctrl-D (the same hotkey used to open the details)
• hotkeys: don't display DFHack logo in legends mode since it covers up important interface elements. the Ctrl-Shift-C hotkey to bring up the menu and the mouseover hotspot still function, though.
• quickfort: linked stockpiles and workshops can now be specified by ID instead of only by name. this is mostly useful when dynamically generating blueprints and applying them via the quickfort API
• sort: animals are now sortable by race on the assignment screens
• suspendmanager: display a different color for jobs suspended by suspendmanager

[h2]API[/h2]

• RemoteFortressReader: add a force_reload option to the GetBlockList RPC API to return blocks regardless of whether they have changed since the last request
• Gui: getAnyStockpile and getAnyCivzone (along with their getSelected variants) now work through layers of ZScreens. This means that they will still return valid results even if a DFHack tool window is in the foereground.
• Items::getValue(): remove caravan_buying parameter since the identity of the selling party doesn't actually affect the item value
• Units: new animal propery check functions isMarkedForTraining(unit), isMarkedForTaming(unit), isMarkedForWarTraining(unit), and isMarkedForHuntTraining(unit)

[h2]Lua[/h2]

• dfhack.gui: new getAnyCivZone and getAnyStockpile functions; also behavior of getSelectedCivZone and getSelectedStockpile functions has changes as per the related API notes
• dfhack.items.getValue(): remove caravan_buying param as per C++ API change
• dfhack.screen.readTile(): now populates extended tile property fields (like top_of_text) in the returned Pen object
• dfhack.units: new animal propery check functions isMarkedForTraining(unit), isMarkedForTaming(unit), isMarkedForWarTraining(unit), and isMarkedForHuntTraining(unit)
• new(): improved error handling so that certain errors that were previously uncatchable (creating objects with members with unknown vtables) are now catchable with pcall()
• widgets.BannerPanel: panel with distinctive border for marking DFHack UI elements on otherwise vanilla screens
• widgets.Panel: new functions to override instead of setting corresponding properties (useful when subclassing instead of just setting attributes): onDragBegin, onDragEnd, onResizeBegin, onResizeEnd

[h2]Structures[/h2]

• Added global_table global and corresponding global_table_entry type
• help_context_type: fix typo in enum name: EMBARK_TUTORIAL_CHICE -> EMBARK_TUTORIAL_CHOICE
• plotinfo: name the fields related to tutorial popups
• viewscreen_legendsst: realign structure
• viewscreen_new_arenast: added (first appeared in 50.06)