DFHack - Dwarf Fortress Modding Engine News

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]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.

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.

This is a compatibility release for DF 51.05 and has no new features since DFHack 51.04-r1.1.

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

Currently, each distribution channel of DF has a different version. This release of DFHack is specifically compatible with:

• Dwarf Fortress 51.04 on Steam
• Dwarf Fortress 51.03 on Itch
• Dwarf Fortress 51.02 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]New Features[/h2]

• stonesense:
  • added option EXTRUDE_TILES to slightly expand sprite to avoid gaps (on by default)
  • added option PIXELPERFECT_ZOOM to change the zoom scale to avoid gaps (off by default)
  • added back minecart track graphics

[h2]Fixes[/h2]

• Ctrl-a hotkeys have been changed to something else (Ctrl-n) for tools that also have an editable text field, where Ctrl-a is interpreted as select all text
• advtools: fix dfhack-added conversation options not appearing in the ask whereabouts conversation tree
• gui/launcher:
  • ensure commandline is fully visible when searching through history and switching from a very long command to a short command
  • flatten text when pasting multi-line text from the clipboard
• gui/rename: fix error when changing the language of a unit's name
• stonesense:
  • fixed announcement text rendering off-screen with larger font sizes
  • screen dimensions are now properly set when overriden by a window manager
  • fixed glass cabinets and bookcases being misaligned by 1 pixel
  • fixed unrevealed walls being hidden by default
  • vampires no longer show their true name when they shouldn't
  • fixed debug performance timers to show milliseconds as intended
  • CACHE_IMAGES now disables mipmapping, stopping sprites from going transparent
  • fixed issue where depth borders wouldn't be rendered for some walls
  • fixed issue where tiles near the bottom edge would be culled

[h2]Misc Improvements[/h2]

• assign-preferences: new --show option to display the preferences of the selected unit
• pref-adjust: new show command to display the preferences of the selected unit
• stonesense:
  • improved the way altars look
  • fog no longer unnecessarily renders to a separate bitmap
  • added new connective tiles for pools of blood and vomit

[h2]Removed[/h2]

• gui/control-panel: removed craft-age-wear tweak for Windows users; the tweak doesn't currently load on Windows

[h2]API[/h2]

• Core :: getUnpausedMs: new API for getting unpaused ms since load in a fort-mode game

Compatibility with DF 51.04

This release is just a quick compatibility update for the latest stable DF release (51.03).

[h2]Fixes[/h2]

• gui/gm-editor: fix Enter key not being recognized for opening the selected object

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]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.

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.
[h2]Fixes[/h2]

• deathcause: fix error when retrieving the name of a historical figure

[h2]Misc Improvements[/h2]

• DFHack edit field widgets, such as the commandline editor in gui/launcher, now support text selection and other advanced text editing features from gui/journal
• stonesense:
  • keybinds.txt config file is now read from dfhack-config/stonesense/keybinds.txt
  • added some missing artwork for bookcases, displays, and offering places
  • reorganized the position of some existing art to be more intuitive
  • added index numbers empty sprite slots to aid in making the xml files for the sprites
  • zoom levels in stonesense now mirror the main game when in follow mode