DFHack 52.04-r1

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.

• 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!

Highlights

Compatibility update

Compatibility update

This is strictly a compatibility update for Dwarf Fortress 52.04. There are no new features or other changes other than those strictly necessary to make DFHack work with version 52.04.

Announcements

PSAs

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

• Compatibility with DF 52.04

DFHack 52.03-r2

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.

• 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!

Highlights

New Features, Bug Fixes

New Features

This release has several new features:

• autotraining (and its companion gui/autotraining) now automates putting units into a military squad as needed to satisfy the "Martial Training" need
• entomb can assist in cleaning up scattered body parts or corpses that aren't being buried automatically for whatever reasons
• husbandry provides an alternative to automilk and autocheese for automating these processes with less cancel spam and more efficiency
• nestboxes can now optionally be configured to only operate within a specified burrow
• stonesense now offers day/night cycle lighting while in fortress mode
• tailor can now automate the production of dyed cloth for use in clothing

Bug Fixes

We also fixed a lot of bugs: ban-cooking all will no longer crash if there is no honey in the world, confirm got a lot of adjustments, immortal-cravings should now work a lot better than it used to, stockpiles will export furniture stockpiles correctly now, uniform-unstick won't cause units to equip multiple copies of assigned items, and deities should no longer have stray commas added after their names in various DFHack displays.

Announcements ----------------------------------

Annc 1, PSAs

Annc 1

Text

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 Tools

• autotraining: new tool to assign citizens to a military squad when they need Martial Training
• entomb: allow any unit that has a corpse or body parts to be assigned a tomb zone
• gui/autotraining: configuration tool for autotraining
• husbandry: Automatically milk and shear animals at nearby farmer's workshops

New Features

• deathcause: added functionality to this script to fetch cause of death programatically
• nestboxes: allow limiting egg protection to nestboxes inside a designated burrow
• stonesense: stonesense now has visible day/night cycle lighting in fortress mode
• tailor: tailor now provides optional dye automation

Fixes

• ban-cooking: will not fail trying to ban honey if the world has no honey
• caravan:
  • in the pedestal item assignment dialog, add new items at the end of the list of displayed items instead of at a random position
  • in the pedestal item assignment dialog, consistently remove items from the list of displayed items
• confirm:
  • only show pause option for pausable confirmations
  • when editing a uniform, confirm discard of changes when exiting with Escape
  • when removing a manager order, show correct order description when using non-100% interface setting
  • when removing a manager order, show correct order description after prior order removal or window resize (when scrolled to bottom of order list)
  • when removing a manager order, show specific item/job type for ammo, shield, helm, gloves, shoes, trap component, and meal orders
  • the pause option now pauses individual confirmation types, allowing multiple different confirmations to be paused independently
• immortal-cravings: prioritize high-value meals, properly split of portions, and don't go eating or drinking on a full stomach
• stockpiles: fixed off-by-one error in exporting furniture stockpiles
• stonesense: fixed the announcements not using the bright bool (now matches vanilla DF colors)
• uniform-unstick: no longer causes units to equip multiples of assigned items
• Units::getReadableName will no longer append a comma to the names of histfigs with no profession

Misc Improvements

• devel/hello-world: updated to show off the new Slider widget

API

• Job: new functions createLinked and assignToWorkshop
• Units: new functions getFocusPenalty, unbailableSocialActivity, isJobAvailable

Lua

• New functions: dfhack.jobs.createLinked, dfhack.jobs.assignToWorkshop, dfhack.units.getFocusPenalty, dfhack.units.unbailableSocialActivity, and dfhack.units.isJobAvailable

Structures

• added default values for material and mat_index in reaction_reagentst and reaction_productst child classes

DFHack 52.03-r2rc1

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.

• 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!

Highlights

New Features, Bug Fixes

New Features

This release will have several new features:

• autotraining (and its companion gui/autotraining) will automate putting units into a military squad as needed to satisfy the "Martial Training" need
• entomb can assist in cleaning up scattered body parts or corpses that aren't being buried automatically for whatever reasons
• husbandry provides an alternative to automilk and autocheese for automating these processes with less cancel spam and more efficiency
• nestboxes can now optionally be configured to only operate within a specified burrow
• stonesense now offers day/night cycle lighting while in fortress mode
• tailor can now automate the production of dyed cloth for use in clothing

Bug Fixes

We also fixed a lot of bugs: ban-cooking all will no longer crash if there is no honey in the world, confirm got a lot of adjustments, immortal-cravings should now work a lot better than it used to, stockpiles will export furniture stockpiles correctly now, uniform-unstick won't cause units to equip multiple copies of assigned items, and deities will no longer have stray commas added after their names in various DFHack displays.

Announcements

PSAs

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 Tools

• autotraining: new tool to assign citizens to a military squad when they need Martial Training
• entomb: allow any unit that has a corpse or body parts to be assigned a tomb zone
• gui/autotraining: configuration tool for autotraining
• husbandry: Automatically milk and shear animals at nearby farmer's workshops

New Features

• deathcause: added functionality to this script to fetch cause of death programatically
• nestboxes: allow limiting egg protection to nestboxes inside a designated burrow
• stonesense: stonesense now has visible day/night cycle lighting in fortress mode
• tailor: tailor now provides optional dye automation

Fixes

• ban-cooking: will not fail trying to ban honey if the world has no honey
• confirm:
  • only show pause option for pausable confirmations
  • when editing a uniform, confirm discard of changes when exiting with Escape
  • when removing a manager order, show correct order description when using non-100% interface setting
  • when removing a manager order, show correct order description after prior order removal or window resize (when scrolled to bottom of order list)
  • when removing a manager order, show specific item/job type for ammo, shield, helm, gloves, shoes, trap component, and meal orders
  • the pause option now pauses individual confirmation types, allowing multiple different confirmations to be paused independently
• immortal-cravings: prioritize high-value meals, properly split of portions, and don't go eating or drinking on a full stomach
• stockpiles: fixed off-by-one error in exporting furniture stockpiles
• stonesense: fixed the announcements not using the bright bool (now matches vanilla DF colors)
• uniform-unstick: no longer causes units to equip multiples of assigned items
• Units::getReadableName will no longer append a comma to the names of histfigs with no profession

Misc Improvements

• devel/hello-world: updated to show off the new Slider widget

API

• Job: new functions createLinked and assignToWorkshop
• Units: new functions getFocusPenalty, unbailableSocialActivity, isJobAvailable

Lua

• New functions: dfhack.jobs.createLinked, dfhack.jobs.assignToWorkshop, dfhack.units.getFocusPenalty, dfhack.units.unbailableSocialActivity, and dfhack.units.isJobAvailable

Structures

• added default values for material and mat_index in reaction_reagentst and reaction_productst child classes

DFHack 52.03-r1.1

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.

• 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!

Highlights

Hotfix to DFHack 52.03-r1

Hotfix to DFHack 52.03-r1

This is a hotfix release to fix an alignment error that was breaking several tools, including the building planner and the trade interface, and also to fix an issue with job names appearing incorrectly for dye-related jobs.

Announcements

PSAs

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

Fixes

• job descriptions of mix dye job will display proper dye names

Structures

• fixed alignment issue in entity_raw

DFHack 52.03-r1

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.

• 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!

Highlights

Compatibility with DF 52.03

Compatibility with DF 52.03

This is primarily a compatibility release for DF 52.03.

Announcements

DFHack's mod manager

DFHack's mod manager

DF 52.01 added a new vanilla module called "Vanilla Procedural Objects". Mod presets saved using DFHack's mod manager in versions prior to 52.01 will not automatically have this mod added to them even if the preset has other vanilla mods in it, which may result in worlds generated using those presets to fail to have procedurally generated objects (such as forgotten beasts). If you are using presets saved in an older version of DF than the one you are currently running, you should inspect the preset for whether this module should be added. We don't currently have logic to do this automatically; it's a nontrivial problem and we did not want to delay this release while we figured out how to deal with this.

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

Fixes

• make-legendary: make-legendary all will no longer corrupt souls
• preserve-rooms will no longer hang on startup in the presence of a cycle in the replacement relationship of noble positions

DFHack 52.02-r2

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.

• 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!

Highlights

Fixes and improvements to the mod manager

Fixes and improvements to the mod manager

The main focus of this release is on DFHack's mod manager, which was broken in 52.02-r1. The breaking issue has been resolved and we've also added support for using the mod manager in arena mode and made some minor improvements in the operation of the mod manager.

Announcements

Notice about DFHack co-saves and "portable mode", PSAs

Notice about DFHack co-saves and "portable mode"

DF 52.01 added a toggle for "portable mode". If set to "on" DF saves games in the install folder the way it did in prior versions. If set to "off" DF saves games instead in a user profile folder, the location of which varies by operating system. DFHack 52.01-r1 did not correctly adjust for this change in save game location when portable mode is off; as a result, DFHack cosaves (which store per-world and per-fortress customizations) were not loaded or saved properly with DFHack 52.01-r1. This was corrected in DFHack 52.02-r1. If you have lost a cosave file, you can copy it from the old save location to the new save location manually (while DF is not running). DFHack cosaves are named with filenames starting with "dfhack" in the same folder as the DF save itself.

If you experience issues with DFHack not loading cosaves in 51.02 or later, please feel free to open an issue report on GitHub or contact us on our Discord for assistance.

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/mod-manager: now supports arena mode

Fixes

• Several fixes related to changes in file system handling in DF 52.01
• dig-now: don't allow UNDIGGABLE stones to be excavated
• gui/mod-manager:
  • gracefully handle vanilla mods with different versions from the user's preset
  • hide other versions of loaded mods and unhides them when unloaded

Misc Improvements

• autoclothing: added a clear option to unset previously set orders

API

• Added GUI focus strings for new_arena: /Loading and /Mods
• Expanded the partial implementations of Military::addToSquad and Military::removeFromSquad
• Filesystem::getBaseDir and Filesystem::getInstallDir added (and made available in Lua)

Lua

• Inserting values into STL containers containing nonprimitive types is now supported

DFHack 52.02-r1

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.

• 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!

Highlights

Compatibility with 52.02

Compatibility with 52.02

This is primarily a compatibility release with DF 52.02.

Announcements

Notice about DFHack co-saves and "portable mode", PSAs

Notice about DFHack co-saves and "portable mode"

DF 52.01 added a toggle for "portable mode". If set to "on" DF saves games in the install folder the way it did in prior versions. If set to "off" DF saves games instead in a user profile folder, the location of which varies by operating system. DFHack 52.01-r1 did not correctly adjust for this change in save game location when portable mode is off; as a result, DFHack cosaves (which store per-world and per-fortress customizations) were not loaded or saved properly with DFHack 52.01-r1. This has been corrected in DFHack 52.02-r1. If you have lost a cosave file, you can copy it from the old save location to the new save location manually (while DF is not running). DFHack cosaves are named with filenames starting with "dfhack" in the same folder as the DF save itself.

If you experience issues with DFHack not loading cosaves in 51.02 or later, please feel free to open an issue report on GitHub or contact us on our Discord for assistance.

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

Fixes

• Honor the "portable mode" preference setting for locating save folders. Fixes DFHack cosaves not working in most cases.
• embark-anyone: Validate viewscreen before using. Avoids a crash.

DFHack 52.01-r1

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.

• 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!

Highlights

Compatibility with 52.01, better animal trapping

Compatibility with 52.01

This is primarily a compatibility release with DF 52.01.

Better animal trapping

The new animaltrap-reuse tweak causes built animal traps to automatically unload the vermin they catch into stockpiled traps, facilitating easier reloading and reuse.

Announcements

PSAs

Annc 1

Text

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

• tweak: animaltrap-reuse: make it so built animal traps automatically unload the vermin they catch into stockpiled animal traps, so that they can be automatically re-baited and reused

Fixes

• fixed references to removed unit.curse compound
• gui/gm-unit: remove reference to think_counter, removed in v51.12
• gui/journal: fix typo which caused the table of contents to always be regenerated even when not needed
• gui/mod-manager: gracefully handle mods with missing or broken info.txt files
• uniform-unstick: resolve overlap with new buttons in 51.13

Structures

• removed fake curse compound in unitst to resolve an alignment issue

DFHack 51.13-r1

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.

• 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!

Changelog

New tools, fixes, and improvements

New Features

• Compatibility with DF 51.13

DFHack 51.12-r1.1

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.

• 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!

Highlights

Paint the map with stars, Search for units by any name, Let items rot away, What's my mod list again?

Paint the map with stars

The DFHack drawing tool gui/design now has an option for drawing hollow or filled N-point stars. You can even rotate the star around its axis so the points can go in any direction. Go ahead, make a Palace of the Sun for your demanding monarch!

Search for units by any name

The general search and find tool, gui/sitemap, now displays both the native and the English translated name for all units. Whichever name you happen to remember, you can search for it and find the unit you're looking for! Click on the name to zoom to that unit on the map, or shift-click to start following that unit around.

Let items rot away

The deteriorate tool is now available on the DFHack gui/control-panel. It allows items to rot away over time. This can be good for just keeping your map clean, but you can also use it to add a bit more challenge to the game. If you enable it with default settings, it will check the map for non-entombed corpses and non-usable body parts and let them rot away over the next few months. For an additional challenge, you can add food, usable body parts (like hair and bones) and damaged clothing to that list. Use it or lose it!

What's my mod list again?

You can now use gui/mod-manager to see a list of your active mods. You can even export the list to the clipboard for easy sharing or posting.

Announcements

PSAs

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 Tools

• deteriorate: (reinstated) allow corpses, body parts, food, and/or damaged clothes to rot away
• modtools/moddable-gods: (reinstated) create new deities from scratch

New Features

• gui/blueprint: now records zone designations
• gui/design: add option to draw N-point stars, hollow or filled or inverted, and change the main axis to orient in any direction
• gui/mod-manager: when run in a loaded world, shows a list of active mods -- click to export the list to the clipboard for easy sharing or posting
• gui/spectate: added "Prefer nicknamed" to the list of options

Fixes

• fixed an overly restrictive type constraint that resulted in some object types being glossed as a boolean when passed as an argument from C++ to Lua
• getplants:
  • will no longer crash when faced with plants with growths that do not drop seeds when processed
  • use updated formula for calculating whether plant growths are ripe
  • fix logic for determining whether plant growths have been picked
• gui/design: prevent line thickness from extending outside the map boundary
• gui/teleport: adapt to new behavior in DF 51.11 to avoid a crash when teleporting items into mid-air
• plants: will no longer generate a traceback when a filter is used
• preserve-rooms: don't warn when a room is assigned to a non-existent unit. this is now common behavior for DF when it keeps a room for an unloaded unit
• script-manager: fix lua scripts in mods not being reloaded properly upon entering a saved world on Windows
• starvingdead:
  • properly restore to correct enabled state when loading a new game that is different from the first game loaded in this session
  • ensure undead decay does not happen faster than the declared decay rate when saving and loading the game

Misc Improvements

• All places where units are listed in DFHack tools now show the translated English name in addition to the native name. In particular, this makes units searchable by English name in gui/sitemap.
• blueprint:
  • support for recording zones
  • support for recording stockpile properties like names and stockpile links; does not yet support recording detailed contents configuration
• dig: ASCII overlay now displays priority of digging designations
• remove-stress: also applied to long-term stress, immediately removing stressed and haggard statuses
• spectate: added prefer nicknamed units

Removed

• removed historically unused Core::RegisterData/Core::GetData API and associated internal data structures

API

• cuboid::forCoord, Maps::forCoord: take additional parameter to control whether iteration goes in column major or row major order
• Items::getDescription: fixed display of quality levels, now displays ALL item designations (in correct order) and obeys vanilla SHOW_IMP_QUALITY setting
• Random module: added SplitmixRNG class, implements the Splitmix64 RNG used by Dwarf Fortress for "simple" randomness

Lua

• script-manager:
  • new get_active_mods() function for getting information on active mods
  • new get_mod_info_metadata() function for getting information out of mod info.txt files