Expanded keybindings

We've expanded the ability to bind hotkeys in DFHack so that you can now bind nearly any key combination you can think of. You are no longer limited by the keys DF recognizes; any key combo that SDL understands can be bound now. We also added both a GUI and a Lua API for managing these bindings.

Edge scrolling

A much-requested accessibility feature, the edgescroll plugin optionally enables automatically panning DF's viewport when the mouse is near the screen border.

Return of infinite-sky

The infinite-sky plugin, which we had to disable in the last release, is back with this release, fully compatible with the changes made in the siege update.

Bug fixes and other improvements

Various other tools had bugs fixed or improvements added: empty-bin will no longer dump powders out of bags (unless forced), DF's enhanced sort and filter support no longer causes DF to crash on exit (did you notice? we did), and the search widget for places has been moved out of the way of DF's new "siege engines" subtab and now also supports searching and filtering siege engines. The fpause command can now be used to force worldgen to pause, combine does a better job of identifying the current stockpile, and createitem now supports placing newly created items in or on more types of furniture than before.

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.

New Tools

• gui/keybinds: gui for managing and saving custom keybindings
• infinite-sky: Re-enabled with compatibility with new siege map data.
• edgescroll: Introduced plugin to pan the view automatically when the mouse reaches the screen border.

New Features

• sort: Places search widget can search "Siege engines" subtab by name, loaded status, and operator status

Fixes

• empty-bin: renamed --liquids parameter to --force and made emptying of containers (bags) with powders contingent on that parameter. Previously powders would just always get disposed.
• sort:
  • Using the squad unit selector will no longer cause Dwarf Fortress to crash on exit
  • Places search widget moved to account for DF's new "Siege engines" subtab

Misc Improvements

• The fpause console command can now be used to force world generation to pause (as it did prior to version 50).
• combine: try harder to find the currently-selected stockpile
• createitem: created items can now be placed onto/into tables, nests, bookcases, display cases, and altars
• keybinding: keybinds may now include the super key, and are no longer limited to particular keys ranges of keys, allowing any recognized by SDL.

API

• Hotkey: New module for hotkey functionality

Lua

• The Lua interactive interpreter banner now documents keywords such as unit and item which reference the currently-selected object in the DF UI.
• dfhack.hotkey.addKeybind: Creates new keybindings
• dfhack.hotkey.getKeybindingInput: Reads the input saved in response to a request.
• dfhack.hotkey.listActiveKeybinds: Lists all keybinds for the current context
• dfhack.hotkey.listAllKeybinds: Lists all keybinds for all contexts
• dfhack.hotkey.removeKeybind: Removes existing keybindings
• dfhack.hotkey.requestKeybindingInput: Requests the next keybind-compatible input is saved

Structures

• updated codegen to generate enum trait constants as constexpr