Stockpile export/import

We updated the stockpile import and export tools to understand the new color and dyed/undyed filters.
This fixes reported issues with quickfort-created stockpiles, including QSPs.

Noble symbols

Tjhe new fix/symbol-unstick tool can remove the assignment of a symbol to a noble that no longer exists.
If you had assigned that spiffy amulet to your baron only to have it go missing when he got promoted to count, this will
let you get it back.

Armor resize

The resize-armor tool will allow you to change the size of any item of armor or clothing to fit any chosen creature.
Mainly useful for adventure mode, especially if you're playing as an animal man race much larger or smaller than human
for which there just isn't that much clothing available otherwise.

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

• fix/symbol-unstick: unstick noble symbols that cannot be re-designated.
• resize-armor: resize armor or clothing item to any creature size.

Misc Improvements

• stockpiles: add support for managing the dyed, undyed, and color filter settings.

Archery Practice Bug Mitigation

This prerelease features an new version of the fix/archery-practice script, updated to mitigate the way archery practice was changed in Dwarf Fortress 52.05. In 52.04, archery practice would only proceed if the marksdwarf had exactly one stack of training ammo in their inventory, and so our fix/archery-practice tool in 52.04 sought to accomplish this as much as possible. In 52.05, Dwarf Fortress's behavior changed so that archery practice would only proceed if the marksdwarf had two or more stacks of training ammo in their inventory. In addition, a requirement that the unit's quiver had to be the last item in their inventory appeared. The new version of fix/archery-practice attempts to maintain these conditions as best it can. The mitigation is not perfect, but it's better than no practice at all.

Mod Scripting Path

We recently discovered that DFHack's script manager was not properly adding scripts_modactive folders for active mods to DFHack's script path in all situations. We believe this was due to the changes in folder location introduced by Dwarf Fortress's introduction of the "portable mode" toggle and to storing player-specific game data in an "appdata" folder by default. This prerelease includes a fix that should resolve this issue for at least most scenarios, although there are some edge cases (especially when a player has mod content in both locations) that may still not be handled correctly. Feedback is requested.

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.

Fixes

• fix/archery-practice: now splits instead of combining ammo items in quivers, and moves quivers to end of unit's inventory list
• script-manager: the scripts_modactive and scripts_modinstalled folders of a script-enabled mod will be properly added to the script path search list

Documentation

• added a clarification link to DF's Lua API documentation to the DFHack Lua API documentation, as a way to reduce end-user confusion

Archery Practice Bug Mitigation

This prerelease features an new version of the fix/archery-practice script, updated to mitigate the way archery practice was changed in Dwarf Fortress 52.05. In 52.04, archery practice would only proceed if the marksdwarf had exactly one stack of training ammo in their inventory, and so our fix/archery-practice tool in 52.04 sought to accomplish this as much as possible. In 52.05, Dwarf Fortress's behavior changed so that archery practice would only proceed if the marksdwarf had two or more stacks of training ammo in their inventory. In addition, a requirement that the unit's quiver had to be the last item in their inventory appeared. The new version of fix/archery-practice attempts to maintain these conditions as best it can. The mitigation is not perfect, but it's better than no practice at all.

Mod Scripting Path

We recently discovered that DFHack's script manager was not properly adding scripts_modactive folders for active mods to DFHack's script path in all situations. We believe this was due to the changes in folder location introduced by Dwarf Fortress's introduction of the "portable mode" toggle and to storing player-specific game data in an "appdata" folder by default. This prerelease includes a fix that should resolve this issue for at least most scenarios, although there are some edge cases (especially when a player has mod content in both locations) that may still not be handled correctly. Feedback is requested.

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.

Fixes

• fix/archery-practice: now splits instead of combining ammo items in quivers, and moves quivers to end of unit's inventory list
• script-manager: the scripts_modactive and scripts_modinstalled folders of a script-enabled mod will be properly added to the script path search list

Documentation

• added a clarification link to DF's Lua API documentation to the DFHack Lua API documentation, as a way to reduce end-user confusion

Military gear mitigations

This update offers several improvements to DFHack's uniform-unstick tool, which assists in getting problems with military uniform equipment jams resolved. It also offers fix/archery-practice, which is a mitigation of a defect in DF that we hope was fixed in 52.05, but if it's not the tool is available for you to use.

Assorted bug fixes and other improvements

We also fixed some bugs in file handling: your cat can no longer crash DF by trying to run a script with a too-long filename. ban-cooking honey will now apply to all animal extracts similar to honey, rather than just vanilla honeybee, and zone should no longer crash even if DF somehow assigns an animal to a pasture that isn't a pasture.

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

• fix/archery-practice: combine ammo items in units' quivers to fix 'Soldier (no item)' issue
• gui/adv-finder: UI for tracking historical figures and artifacts in adventure mode
• store-owned: task owned items to be stored in the owner's room furniture

Fixes

• improved file system handling: gracefully handle errors from operations, preventing crashes.
• ban-cooking: bans honey added by creatures other than vanilla honey bee
• uniform-unstick:
  • added quivers, backpacks, and flasks/waterskins to uniform analysis
  • the --drop option now only evaluates clothing as possible items to drop
  • the --free option no longer redundantly reports an improperly assigned item when that item is removed from a uniform
  • the --drop and --free options now only drop items which are actually in a unit's inventory
  • the --all and --drop options, when used together, now print the separator line between each unit's report in the proper place
• zone: animal assignment dialog now tolerates corrupt animal-to-pasture links.

Misc Improvements

• adapt Lua tools to use new API functionality for creating and assigning jobs
• idle-crafting: properly interrupt interruptible (i.e. "green") social activities

Military gear mitigations

This update offers several improvements to DFHack's uniform-unstick tool, which assists in getting problems with military uniform equipment jams resolved. It also offers fix/archery-practice, which is a quick mitigation of a defect in DF that should be fixed in the next DF update.

Assorted bug fixes and other improvements

We also fixed some bugs in file handling: your cat can no longer crash DF by trying to run a script with a too-long filename. ban-cooking honey will now apply to all animal extracts similar to honey, rather than just vanilla honeybee, and zone should no longer crash even if DF somehow assigns an animal to a pasture that isn't a pasture.

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

• fix/archery-practice: combine ammo items in units' quivers to fix 'Soldier (no item)' issue
• gui/adv-finder: UI for tracking historical figures and artifacts in adventure mode
• store-owned: task owned items to be stored in the owner's room furniture

Fixes

• improved file system handling: gracefully handle errors from operations, preventing crashes.
• ban-cooking: bans honey added by creatures other than vanilla honey bee
• uniform-unstick:
  • added quivers, backpacks, and flasks/waterskins to uniform analysis
  • the --drop option now only evaluates clothing as possible items to drop
  • the --free option no longer redundantly reports an improperly assigned item when that item is removed from a uniform
  • the --drop and --free options now only drop items which are actually in a unit's inventory
  • the --all and --drop options, when used together, now print the separator line between each unit's report in the proper place
• zone: animal assignment dialog now tolerates corrupt animal-to-pasture links.

Misc Improvements

• adapt Lua tools to use new API functionality for creating and assigning jobs
• idle-crafting: properly interrupt interruptible (i.e. "green") social activities

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.

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 Features

• Compatibility with DF 52.04

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.

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.

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

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.

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

• 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

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

Changelog

Compatibility with DF 52.03

This is primarily a compatibility release for DF 52.03.

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.

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