DFHack - Dwarf Fortress Modding Engine news & patch notes

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 Dwarf Fortress 53.15

The main feature of this release is compatibility with Dwarf Fortress 53.15.

Fixes and improvements

Several tools have had minor fixes or improvements. See the changelog for details.

Announcements

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

• machine-toggle: interface for toggling gear assemblies, as well as pressure plates (previously in trackstop) (available only if "armok" tools are shown)

Fixes

• add-recipe: fix to include incorrectly excluded recipes

• autoclothing: will no longer count gloves and pants as if they were helms

• gui/control-panel: fixed incorrect description of deteriorate commands

• gui/petitions: fix deity display

• timestream: do not skip ticks when a caravan is loading or unloading, and be more careful about skipping ticks when flows are active

Misc Improvements

• trackstop: pressureplate overlay moved to machine-toggle as an "armok" tool

Structures

• corrected return type on art_image_propertyst vmethod clone

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

Changes in how Dwarf Fortress handles announcements have made the logcleaner impossible to implement safely, and so this tool has been removed with this hotfix.

In addition, a change has been made to DF's core code to prevent any attempt by a script to delete internal game data objects, such as announcements, which cannot be safely deleted, in order to prevent crashes caused by bugs of this nature. Script code which attempts to delete data objects which cannot be safely deleted will now throw an exception, which will result in either a script error or a controlled crash (which will normally create a useful crash log), instead of causing memory corruption and an uncontrolled crash.

Announcements

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

Misc Improvements

• Core: attempts to delete a pool-allocated DF object will now throw an exception instead of corrupting the heap

Removed

• logcleaner: Removed (cannot be safely implemented at this time)

• gui/logcleaner: Removed

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 Dwarf Fortress 53.14, Other new features and fixes

Compatibility with Dwarf Fortress 53.14

The primary feature of this release is compatibility with Dwarf Fortress 53.14.

Other new features and fixes

A handful of tools had minor bugs fixed or small features added. See the changelog, below, for details.

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 Dwarf Fortress 53.14

Fixes

• caravan: fix ethics warning for wooden weapons

• gui/control-panel: fixed inconsistent space in command help ("tweak" -> "tweak ", like with other commands)

• gui/siegemanager: consistently set the initial filter to "All"

• immortal-cravings: also take care of immortal units with alcohol dependence

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

Bug fix

This release fixes a critical defect caused by a change in how Dwarf Fortress internally handles announcements in version 53.13. This defect could cause DF to crash if a DFHack tool used any of the Gui::makeAnnoucement, Gui::showPopupAnnouncement, or Gui::autoDFAnnouncement routines. These routines are used by several standard DFHack tools, including autonestbox and emigration, as well as many third party scripts. This release fixes this defect.

Announcements

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

Fixes

• Gui::makeAnnoucement, Gui::showPopupAnnouncement`, and Gui::autoDFAnnouncement`` will no longer attempt to cull the DF announcement vector

Structures

• added a proper default for pool_id fields in several structures

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 Dwarf Fortress 53.13

The main focus of this release is to add compatibility with Dwarf Fortress 53.13.

Structures review

A fairly significant review and update of DFHack's view of DF data structures is incorporated in this release. This should have little impact on regular players but may affect those who write DFHack scripts. See the changelog for more details.

Other bug fixes and improvements

A minor bug that occasionally affected autotrain has been fixed, some documentation was slightly improved, and a few APIs were made more useful.

Announcements

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

Documentation

• updated documentation for autofarm for more clarity

API

• add flexible casting to enum_field to enable explicit casting to more types

• Handle units without current soul in Units::getFocusPenalty

Structures

• added some missing enums and bitfields

• assigned proper bitfield data type on agreement_details_data_plot_infiltration_coup.flags

• changed various fields to make use of existing enums and bitfields

• ensured that original-name always appears after name or type-name, never before

• filled in missing original-name attributes

• fixed assorted typos in original-name attributes

• fixed base types of creature_sound_type, creature_sound_method_type, and art_image_property_verb

• fixed several enums

• fixed several structure field type errors

• fixed several typos in original-name attributes

• fixed various fields to use correct signedness

• fixed various fields to use int8_t or bool as appropriate

• merged item_statue_graphics_type bitfield into item_statue_graphics_flag

• other changes:

  • added name to field cgl_itemst.item_type

  • inclusion_type now has 16-bit base type (though nothing relies on it)

  • renamed adventure_interface_attackst.scrselected_item_idoll_position_wrestle to selected_item_id

• specific changes:

  • fixed building_constructionst.type to be 32-bit, along with the construction_type enum

  • fixed contextst.interrogator_relationships to be a pointer to evidence_repositoryst

  • fixed actor_entryst.associated_org to contain pointers to organization_entryst

  • fixed justice_interfacest.interrogation_report to contain pointers to interrogation_report

  • fixed main_interface_settings.member to contain shared pointers to world_gen_param_valuest

  • fixed squad_equipment_interfacest.am_cand_subtype to contain int16_t

  • fixed startup_charactersheet_petst.race to be int32_t

  • fixed lookinfo_verminst.caste to be int16_t

  • fixed intrigue_corruption.facet_rating to be int16_t

  • fixed historical_entity.current_wgwg to be a direct pointer

  • fixed historical_figure.worldgen_relationships to be a direct pointer

  • fixed pmd_tree_texture_infost.texpos_tree_wood_tile to use correct array length (sized against the correct enum)

  • fixed build_square_type enum to add missing element OUTSIDE

  • swapped main_hover_instruction elements ADVENTURE_MOVE_DOWN_RAMP_E and ADVENTURE_MOVE_DOWN_RAMP_W

  • viewscreen_titlest.mode now uses new enum title_mode_type

  • viewscreen_worldst.squad_flag now uses new bitfield civlist_squad_flag

  • viewscreen_worldst.messenger_flag now uses new bitfield civlist_messenger_flag

  • fixed historical_entity.resources.art_image_types to use new entity_art_image_type enum

  • adventure_movement_movest.aim_attack_flag now uses aim_attack_flag bitfield

  • adventure_movement_mountst.riderposition now uses rider_positions_type enum

  • adventure_constructionst.building_jobitemflag now uses job_material_category bitfield

  • adventure_constructionst.mat_jobitemflag now uses job_material_category bitfield

  • adventure_constructionst.mat_jobitemflag_master now uses job_material_category bitfield

  • building_defst.build_key now uses interface_key enum

  • body_detail_plan.bp_layers_tissue now uses creature_interaction_effect_target_mode enum

  • body_detail_plan.bp_position_value now uses body_part_position_type enum

  • body_detail_plan.bp_relation_value_1 now uses body_part_relation_type enum

  • custom_stockpile_interfacest.cur_main_mode_flag now uses stockpile_group_set bitfield

  • custom_stockpile_interfacest.main_mode_flag now uses stockpile_group_set bitfield

  • name_creator_interfacest.cur_name_place now uses language_name_component enum

  • name_creator_interfacest.cur_word_place now uses language_word_table_index enum

  • dance_form_section.dance_flag now uses dance_flag bitfield

  • evidence_hf_filest.evidence now uses evidence_type enum

  • historical_entity.resources.scholar_flag now uses entity_scholar_flag bitfield

  • interaction_effect_summon_unitst fields required_creature_flags and forbidden_creature_flags now use creature_raw_flags enum

  • interaction_effect_summon_unitst fields required_caste_flags and forbidden_caste_flags now use caste_raw_flags enum

  • interaction_effect_change_weatherst fields add_weather_flag and remove_weather_flag now use region_weather_bits bitfield

  • creature_interaction_effect_body_transformationst fields required_creature_flags and forbidden_creature_flags now use creature_raw_flags enum

  • creature_interaction_effect_body_transformationst fields required_caste_flags and forbidden_caste_flags now use caste_raw_flags enum

  • unit_personality.habit now uses habit_type enum

  • world_region_feature.vertical_connection now uses layer_connection_type enum

  • site_construction_blueprintst fields construction_type and building_type now use building_type enum

  • site_construction_blueprintst fields construction_jobitemflag and building_jobitemflag now use job_material_category bitfield

  • building_weaponrackst.rack_flags is now unsigned

  • temperaturest.fraction is now unsigned

  • historical_entity fields did_wg_variable_position and did_wg_variable_market_position are now unsigned

  • item_body_component fields nonsolid_remaining, layer_wound_area, layer_cut_fraction, layer_dent_fraction, and layer_effect_fraction are now signed

  • unit_personality.traits is now signed

  • rpd_indicator_datast fields marker_char, marker_f, marker_b, and marker_br are now unsigned

  • embark_note.tile is now unsigned

  • world_population fields count_min, count_max, and temp_num are now unsigned

  • world_site_realization.mini_colors is now unsigned

  • unit.body.components fields nonsolid_remaining, layer_wound_area, layer_cut_fraction, layer_dent_fraction, and layer_effect_fraction are now signed

  • unit.body fields blood_max and blood_count are now signed

  • unit.counters fields pain, nausea, and dizziness are now signed

  • unit fields uwss_alt_period, uwss_alt_on_period, uwss_speed_add, uwss_speed_perc, and uwss_skill_role_adjust are now signed

  • unit.counters fields paralysis, numbness, fever, exhaustion, hunger_timer, thirst_timer, sleepiness_timer, stomach_content, stomach_food, vomit_timeout, and stored_fat are now signed

  • unit.status2.liquid_depth are now signed

  • viewscreen_dwarfmodest.sideSubmenu is now bool

  • entity_raw fields likes_site, tolerates_site, start_biome, settlement_biome, and active_season are now bool

  • entity_raw.jobs.permitted_labor is now int8_t

  • graphicst fields do_clean_tile_cache and do_post_init_texture_clear are now bool

  • world_generatorst fields have_logged_parameters and last_used_valid are now bool

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

Dwarf Fortress 53.12 compatibility

Dwarf Fortress 53.12 compatibility

This release adds compatibility with Dwarf Fortress 53.12.

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 Dwarf Fortress 53.12

Fixes

• Stockpile definitions in the default library will be correctly found and used (fixed missing path separator)

Highlights

Rework for Steam client compatibility; Windows console encoding

Rework for Steam client compatibility

The overwhelming purpose for this release is to rework DFHack so that it will work seamlessly when installed via Steam. Steam recently changed its client in a way that made our prior method of installing DFHack where DF could "see" it stop working. With a single tiny exception, the entirety of this update is to facilitate being able to install DFHack via Steam with a minimum of user hassle.

Windows console encoding

Dwarf Fortress recently was updated to force UTF-8 for all interactions with the operating system in Windows; however, this change did not reach to the text console used by DFHack on Windows, which is still defaulting to the user's default system code page. This has caused some anomalous behavior for users whose default system code page is not already UTF-8. This update includes a tiny change that forces this console to also use UTF-8 regardless of the user's default system code page.

Announcements

Special instructions for this update; DFHack Steam Cloud support; Legacy support branches; on Steam; PSAs

Special instructions for this update

One of the side effects of the changes made by the Steam client is that people who were using DFHack before the Steam client change now have a "stranded" installation of DFHack still living in their Dwarf Fortress installation folder. This installation must be removed for DFHack to work correctly going forward. Our installer has code to detect this. On Windows, the user will be asked for permission to remove the legacy installation, while on Linux a popup with instructions on how to remove the legacy installation will be displayed.

In addition, for technical reasons, DFHack can no longer completely install itself into Dwarf Fortress solely by installing the app on Steam. As a result, it is now necessary to launch from the DFHack application at least once after installing DFHack so DFHack can install itself into Dwarf Fortress. After this, it should be possible to launch from either Dwarf Fortress or DFHack the same way as before.

If you have problems with DFHack not working after installing this update which are not resolved by launching the DFHack application, we recommend the following process:

• Uninstall DFHack via Steam

• Remove the following files and folders from the Dwarf Fortress installation folder:

  • hack (entire folder/directory)

  • stonesense (entire folder/directory)

  • binpatch.exe (Windows) / binpatch (Linux)

  • dfhack-run.exe (Windows) / dfhack-run (Linux)

  • all files named allegro_*.dll (Windows) or liballegro_*.so (Linux)

  • dfhack-client.dll (Windows) / libdfhack-client.so (Linux)

  • dfhooks_dfhack.dll (Windows) / libdfhooks_dfhack.so (Linux)

  • lua53.dll (Windows) / liblua53.dll (Linux)

  • protobuf-lite.dll (Windows) / libprotobuf-lite.so (Linux)

• Reinstall DFHack via Steam

• Launch DFHack once

DFHack Lua scripters need to be aware that the hack folder is no longer guaranteed to be in hack. A path to it can be obtained with the dfhack.getHackPath() call. While all standard scripts have been updated to reflect this, user written scripts have not. The dfhack-config folder has not moved with this update.

DFHack Steam Cloud support

DFHack has, for some time now, used Steam Auto-Cloud to synchronize the dfhack-config folder that contains each user's personal configuration of DFHack. For technical reasons, we can no longer do this; as a result, we have turned off DFHack Steam Cloud. You may wish to consider manually backing up the contents of your dfhack-config folder.

Legacy support branches on Steam

We will not be porting support for the new installation to the legacy support branches currently available on Steam. As these branches won't work for Steam users anyway (as they install to the wrong place), there's no value in keeping them around, and so they have been deleted. Note that you can still download legacy versions of DFHack from GitHub for far further back than we keep on Steam, and these legacy versions will still work as they always have by manually installing them into the installation folder of the matching version of Dwarf Fortress.

We will continue to provide legacy support branches on Steam going forward, subject to the limits on how many branches Steam allows, of course.

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

• Core: Windows console will always use UTF-8 regardless of system code page settings

• Steam launcher: Switch to injection strategy, allowing Dwarf Fortress and DFHack to be installed in disparate locations

Misc Improvements

• Make DFHack relocatable so that it doesn't depend on being fully co-installed with Dwarf Fortress

This is a new prerelease build, with several small but significant technical changes, for more final testing, Anticipated release date is Monday April 14,

Highlights

Rework for Steam client compatibility

The overwhelming purpose for this release is to rework DFHack so that it will work seamlessly when installed via Steam. Steam recently changed its client in a way that made our prior method of installing DFHack where DF could "see" it stop working. With a single tiny exception, the entirety of this update is to facilitate being able to install DFHack via Steam with a minimum of user hassle.

Highlights

Rework for Steam client compatibility; Windows console encoding

Rework for Steam client compatibility

The overwhelming purpose for this release is to rework DFHack so that it will work seamlessly when installed via Steam. Steam recently changed its client in a way that made our prior method of installing DFHack where DF could "see" it stop working. With a single tiny exception, the entirety of this update is to facilitate being able to install DFHack via Steam with a minimum of user hassle.

Windows console encoding

Dwarf Fortress recently was updated to force UTF-8 for all interactions with the operating system in Windows; however, this change did not reach to the text console used by DFHack on Windows, which is still defaulting to the user's default system code page. This has caused some anomalous behavior for users whose default system code page is not already UTF-8. This update includes a tiny change that forces this console to also use UTF-8 regardless of the user's default system code page.

Announcements

Special instructions for this update

One of the side effects of the changes made by the Steam client is that people who were using DFHack before the Steam client change now have a "stranded" installation of DFHack still living in their Dwarf Fortress installation folder. This installation must be removed for DFHack to work correctly going forward. Our installer has code to detect this. On Windows, the user will be asked for permission to remove the legacy installation, while on Linux a popup with instructions on how to remove the legacy installation will be displayed.

In addition, for technical reasons, DFHack can no longer completely install itself into Dwarf Fortress solely by installing the app on Steam. As a result, it is now necessary to launch from the DFHack application at least once after installing DFHack so DFHack can install itself into Dwarf Fortress. After this, it should be possible to launch from either Dwarf Fortress or DFHack the same way as before.

If you have problems with DFHack not working after installing this update which are not resolved by launching the DFHack application, we recommend the following process:

• Uninstall DFHack via Steam

• Remove the following files and folders from the Dwarf Fortress installation folder:

  • hack (entire folder/directory)

  • stonesense (entire folder/directory)

  • binpatch.exe (Windows) / binpatch (Linux)

  • dfhack-run.exe (Windows) / dfhack-run (Linux)

  • all files named allegro_*.dll (Windows) or liballegro_*.so (Linux)

  • dfhack-client.dll (Windows) / libdfhack-client.so (Linux)

  • dfhooks_dfhack.dll (Windows) / libdfhooks_dfhack.so (Linux)

  • lua53.dll (Windows) / liblua53.dll (Linux)

  • protobuf-lite.dll (Windows) / libprotobuf-lite.so (Linux)

• Reinstall DFHack via Steam

• Launch DFHack once

DFHack Lua scripters need to be aware that the hack folder is no longer guaranteed to be in hack. A path to it can be obtained with the dfhack.getHackPath() call. While all standard scripts have been updated to reflect this, user written scripts have not. The stonesense folder has also moved to be inside the hack folder. The dfhack-config folder has not moved with this update.

DFHack Steam Cloud support

DFHack has, for some time now, used Steam Auto-Cloud to synchronize the dfhack-config folder that contains each user's personal configuration of DFHack. For technical reasons, we can no longer do this; as a result, we will be turning off DFHack Steam Cloud. You may wish to consider manually backing up the contents of your dfhack-config folder.

Legacy support branches on Steam

We will not be porting support for the new installation to the legacy support branches currently available on Steam. As these branches won't work for Steam users anyway (as they install to the wrong place), there's no value in keeping them around, and so we will be deleting them. Note that you can still download legacy versions of DFHack from GitHub for far further back than we keep on Steam, and these legacy versions will still work as they always have by manually installing them into the installation folder of the matching version of Dwarf Fortress.

We will continue to provide legacy support branches on Steam going forward, subject to the limits on how many branches Steam allows, of course.

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

• Core: Windows console will always use UTF-8 regardless of system code page settings

• Steam launcher: Switch to injection strategy, allowing Dwarf Fortress and DFHack to be installed in disparate locations

Misc Improvements

• Make DFHack relocatable so that it doesn't depend on being fully co-installed with Dwarf Fortress

This is a prerelease build for final testing!

Highlights

Rework for Steam client compatibility

The overwhelming purpose for this release is to rework DFHack so that it will work seamlessly when installed via Steam. Steam recently changed its client in a way that made our prior method of installing DFHack where DF could "see" it stop working. With a single tiny exception, the entirety of this update is to facilitate being able to install DFHack via Steam with a minimum of user hassle.

Highlights

Rework for Steam client compatibility; Windows console encoding

Rework for Steam client compatibility

The overwhelming purpose for this release is to rework DFHack so that it will work seamlessly when installed via Steam. Steam recently changed its client in a way that made our prior method of installing DFHack where DF could "see" it stop working. With a single tiny exception, the entirety of this update is to facilitate being able to install DFHack via Steam with a minimum of user hassle.

Windows console encoding

Dwarf Fortress recently was updated to force UTF-8 for all interactions with the operating system in Windows; however, this change did not reach to the text console used by DFHack on Windows, which is still defaulting to the user's default system code page. This has caused some anomalous behavior for users whose default system code page is not already UTF-8. This update includes a tiny change that forces this console to also use UTF-8 regardless of the user's default system code page.

Announcements

Special instructions for this update

One of the side effects of the changes made by the Steam client is that people who were using DFHack before the Steam client change now have a "stranded" installation of DFHack still living in their Dwarf Fortress installation folder. This installation must be removed for DFHack to work correctly going forward. Our installer has code to detect this. On Windows, the user will be asked for permission to remove the legacy installation, while on Linux a popup with instructions on how to remove the legacy installation will be displayed.

In addition, for technical reasons, DFHack can no longer completely install itself into Dwarf Fortress solely by installing the app on Steam. As a result, it is now necessary to launch from the DFHack application at least once after installing DFHack so DFHack can install itself into Dwarf Fortress. After this, it should be possible to launch from either Dwarf Fortress or DFHack the same way as before.

If you have problems with DFHack not working after installing this update which are not resolved by launching the DFHack application, we recommend the following process:

• Uninstall DFHack via Steam

• Remove the following files and folders from the Dwarf Fortress installation folder:

  • hack (entire folder/directory)

  • stonesense (entire folder/directory)

  • binpatch.exe (Windows) / binpatch (Linux)

  • dfhack-run.exe (Windows) / dfhack-run (Linux)

  • all files named allegro_*.dll (Windows) or liballegro_*.so (Linux)

  • dfhack-client.dll (Windows) / libdfhack-client.so (Linux)

  • dfhooks_dfhack.dll (Windows) / libdfhooks_dfhack.so (Linux)

  • lua53.dll (Windows) / liblua53.dll (Linux)

  • protobuf-lite.dll (Windows) / libprotobuf-lite.so (Linux)

• Reinstall DFHack via Steam

• Launch DFHack once

DFHack Lua scripters need to be aware that the hack folder is no longer guaranteed to be in hack. A path to it can be obtained with the dfhack.getHackPath() call. While all standard scripts have been updated to reflect this, user written scripts have not. The dfhack-config folder has not moved with this update.

DFHack Steam Cloud support

DFHack has, for some time now, used Steam Auto-Cloud to synchronize the dfhack-config folder that contains each user's personal configuration of DFHack. For technical reasons, we can no longer do this; as a result, we will be turning off DFHack Steam Cloud. You may wish to consider manually backing up the contents of your dfhack-config folder.

Legacy support branches on Steam

We will not be porting support for the new installation to the legacy support branches currently available on Steam. As these branches won't work for Steam users anyway (as they install to the wrong place), there's no value in keeping them around, and so we will be deleting them. Note that you can still download legacy versions of DFHack from GitHub for far further back than we keep on Steam, and these legacy versions will still work as they always have by manually installing them into the installation folder of the matching version of Dwarf Fortress.

We will continue to provide legacy support branches on Steam going forward, subject to the limits on how many branches Steam allows, of course.

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

• Core: Windows console will always use UTF-8 regardless of system code page settings

• Steam launcher: Switch to injection strategy, allowing Dwarf Fortress and DFHack to be installed in disparate locations

Misc Improvements

• Make DFHack relocatable so that it doesn't depend on being fully co-installed with Dwarf Fortress

Situation report

Work is now nearly complete on updating DFHack to once again install (mostly) seamlessly with the new changes to Steam's client. There are several significant changes that I want to warn the community of in advance:

First, most of you will have to do a one-time cleanup of your previous DFHack installation, nestled as it is in Dwarf Fortress's install folder, either because it was installed there by the Steam installer previously or because you manually copied it there to keep things working. While we could try to write a tool to clean these up automatically, I am not comfortable with silently deleting files that someone might want to keep, so we're going to leave this to you to do on your own. Preliminary instructions on how to do this are below.

Second, we are going to disable Steam Cloud synchronization of DFHack's configuration folder (dfhack-config). This is because, for now, we are going to leave this folder in DF's folder (where it was before) which we cannot configure to synchronize with Steam Auto-Cloud (this is a technical limitation of Steam Auto-Cloud). We're still trying to figure out how to best deal with this folder going forward; all of the potential solutions have drawbacks and we haven't decided what the best way to move forward is. Thus, you might want to make a manual backup of your dfhack-config folder before installing this coming update.

Third, we are going to drop all of the existing legacy branches of DFHack currently on Steam. They won't work seamlessly anyway due to the installation path changes, so the convenience value they once offered is now nonexistent and so there's no value in continuing to provide them. Note that we willl still have legacy versions of DFHack available from Github, which will still work (just as they always have) simply by dropping them directly into DF's installation folder.

None of the changes we're making with this update will directly impact users who choose to install DFHack by downloading it from Github; the builds published there will continue to work, as they always have, by unpacking them directly into DF's installation folder. Also, if you subscribe to DFHack on Steam, but not DF, and are using the Classic version of DF that you can download from Bay12 installed into DFHack's installation folder, again, you should experience no change in the behavior of the application (except for the Steam Cloud issue mentioned above).

Test build is available!

A test build of DFHack that works with the current release of DF and works with the new Steam client is available on our "testing" branch. If you choose to use this build, be aware of the following EXTREMELY IMPORTANT INFORMATION:

• This build does not self-install. You will have to launch from DFHack once after installation in order for it to detect and install into DF. After this one launch, you can launch from either DF or DFHack. We're hopeful that we can get it to be self-installing for Windows users, but this still has to be implemented and tested in a way that won't break existing builds or cause unexpected behavior.

• This build does not clean out any previous DFHack installation in your DF install folder. While this has not been extensively tested, it's likely that if you have a previous installation in your DF folder, it will take precedence over the new version. You will be able to tell with the test build by the DFHack version displayed at launch: if there isn't a (git: nnnnnnn) tag after the version number, you're still running on the public release version and need to clean that old installation out to proceed.

• This build has only been tested on Windows and has not been extensively tested, especially for exceptional conditions. If you use it, please provide feedback, especially if you run into problems.

• Going back to the release version will require manually copying that install into your DF folder; you won't be able to just switch back to the public branch without further steps to get DFHack back which you will have to do manually.

How to clean out a prior DFHack install installed by Steam

Go to Dwarf Fortress's installation folder (Manage > Browse Local FIles). (Let me again stress that this is under the Dwarf Fortress app, not under DFHack's app.) Delete the following files and folders/directories, if they are present:

• hack (entire folder/directory)

• stonesense (entire folder/directory)

• binpatch.exe (Windows) / binpatch (Linux)

• dfhack-run.exe (Windows) / dfhack-run (Linux)

• all files named allegro_*.dll (Windows) or liballegro_*.so (Linux)

• dfhack-client.dll (Windows) / libdfhack-client.so (Linux)

• dfhooks_dfhack.dll (Windows) / libdfhooks_dfhack.so (Linux)

• lua53.dll (Windows) / liblua53.dll (Linux)

• protobuf-lite.dll (Windows) / libprotobuf-lite.so (Linux)

Do not delete dfhooks.dll (Windows), libdfhooks.so (Linux), or dfhooks_dfhack.ini (both WIndows and Linux); these files are injected by DFHack's one-time installer and are how DFHack connects to DF. (If you do delete them, launching from DFHack will reinstate them.)

The most important one to delete is dfhooks_dfhack.dll (Windows) / libdfhooks_dfhack.so (Linux); if you don't delete this one, you'll almost certainly get the old version of DFHack instead of the new one.

I'm sure some of you have seen this message over the past few weeks and not understood why you're getting it.

Recently, Steam changed the way the Steam client installs applications. Specifically, Steam changed their installer so that two apps can no longer install into the same location. On the whole this was probably a good choice by Steam, since it definitely prevents one Steam app from maliciously overwriting another Steam app. However, DFHack has always relied on the ability to do this as its installation method, this is because of the way a DF extension module (which is what DFHack is) connects to DF. (And, yes, we have and have always had Bay12's explicit permission to do this.) As a result of Steam's decision here, DFHack no longer seamlessly links up with DF, which leads to the above message and makes DFHack not work, which obviously makes us all sad.

Some people have also asked why DFHack is not a DF mod, and so I'm going to take a moment to address this.

DFHack is not a DF mod because DF's modding system only allows the mod to provide graphics assets and text files to be parsed as DF "raws". DFHack is neither a graphics asset nor a text file to be parsed as raws, and so it cannot function as a DF mod. DF mods simply cannot do what DFHack does.

Instead, DFHack operates as a DF extension module, which works by dropping a specifically named file in a specific location in the DF installation that DF detects during its startup and connects to if that file meets certain specified criteria. There is, at present, no way for a workshop mod to drop a file in this location, and so no workshop mod can be, by itself, a DF extension module.

In the past Steam allowed DFHack to install in the same folder as DF, and so we could just passively use Steam's installer to drop the required file in the right location. Steam has changed their installer so this is no longer possible, so we will now instead have to use some sort of active method to put the the required file in the right location. This is actually the easy part, which is why I haven't done it yet.

We could simply have rewritten our launcher to to find DF and copy all of DFHack into DF, creating the same situation that we had when Steam just let us install DFHack in the same location as DF, but this approach makes updating much harder (we'd have to detect when an update occurred, remove all of the old version, and install all of the new version, which is a pain) so we're not doing that; instead, we will only be copying two small files that will hopefully change very infrequently, and, being small, will be easy to copy even if they do change. On Windows, this will be completely transparent to the user; however, on Linux, players will have to manually launch DFHack once after installing DFHack for the first time. The discrepancy here is because Steam does not provide for custom install scripting in the Linux version of its client, and so on Windows we can automatically run the post-update script to find and copy into DF's folder, but on Linux the user will have to "do something" to run the post-update script, so what we're going to be doing is having the DFHack launcher check at startup if the post-update script has been run, and if it hasn't run it itself. This is the part I haven't written yet, because it's frankly easy and I wanted to save the easy part for last.

The harder part is that DFHack has long operated on the assumption that it will live in the same folder as DF, an assumption we can no longer make. Thus, we have had to go through all of DFHack's code and rewrite every place where the code assumed that DFHack was installed in DF's folder, so as to make DFHack work no matter where DFHack is installed. At this point, I think the programming aspect of this is complete, but we still need to test to verify that it works correctly under what we hope are a sufficiently wide range of scenarios to cover the majority of player use cases.

While this testing continues, I'm going to now go to work on the "easy" part, updating the launcher, and once both of these are done, we'll publish a PTB on Steam in our "testing" branch, hopefully in the next week or three.

We do apologize for all the trouble this has created for players. If Steam gave us any advance notice of this change, we didn't see it, and so it pretty much caught us unawares. And as DFHack is and always has been a 100% volunteer project, we obviously have limited resources to develop, test, and implement changes, especially in a hurry.

For the DFHack Team,

rome of oxtrot

Highlights

Bug fixes

This release fixes several bugs, most notably the rename tool, which was hanging, and several tools that managed work orders that were creating them wrong due to an underlying infrastructure change that interacted in an unexpected way.

In addition, a change in DF itself caused the DFHack console to work differently which caused problems displaying names with accent marks; this has been fixed, and the DFHack console will now work more reliably on Windows systems.

Announcements

Steam client issues

IMPORTANT PLEASE READ THIS

Steam has changed the way the Steam client installed DFHack in a way that prevents it from working automatically. Until we update our deployment mechanics, this means that users using DFHack via Steam may have to manually copy DFHack from the location Steam installs DFHack into, into DF's folder. Steam users who have to do this may also have to launch using the "Dwarf Fortress" entry in their Steam library, not from the "DFHack" entry. We have been aware of this as a coming thing for a while now, but we didn't have time to get it addressed before Steam's changes went live. We apologize for the inconvenience. Fixing this is a top priority right now, and and we expect to have this fixed within the next few weeks.

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

Fixes

• autoclothing, autoslab, tailor: orders will no longer be created with a repetition frequency of NONE

• gui/rename: skip NONE when iterating through language name options

• quickfort: work orders will no longer be created with a repetition frequency of NONE

Misc Improvements

• General: DFHack will unconditionally use UTF-8 for the console on Windows, now that DF forces the process effective system code page to 65001 during startup

Structures

• reordered XML attributes for consistency: ret-type, base-type, type-name, and pointer-type now appear first (and in that exact order)

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

Dwarf Fortress 53.11 compatibility

This release is primarily for compatibility with Dwarf Fortress 53.11.

One bug fix

We fixed one bug in 53.10-r2 in this release; the "hates combat" filter on the squad selection filter will now work correctly.

Announcements

Known defect

53.10-r2 has a reported defect in the "rename" tool which we have not had time to fix; this release also has this defect. We are working to find and fix this bug and will release an update as soon as we can once we've got a fix.

Issues with Steam Client Beta

The beta of the Steam client alters the way Steam applications are deployed in a way that impacts DFHack, and we have had reports of DFHack not working as expected for people who are using the Steam beta client. We are aware of this issue, have a plan to mitigate it in development, and hope to have a solution in place before the change Steam is making makes it to the release client.

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

Fixes

• sort: correct misspelling of PERSEVERENCE; fixes "hates combat" filter in squad selection screen

Structures

• added codegen support for static-wstring (wchar_t *), required to support DF 53.11

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

QoL features, Bug fixes, Technical updates

QoL features

This update features many QoL features:

• For those of you with hundreds or even thousands of manager orders, we added a tool to make it a bit easier to find the one you're looking for

• We added a filter to exclude (or, if you really want, include) dwarves with "uniformed" civilian roles in the squad selection menu filters

• We added a utility to automatically clear certain categories of announcements (like sparring) from the announcement buffer so that the announcements you actually care about won't be crowded out

• We added a button to show a unit's death cause to the dead/missing units tab

• You can now assign names or labels to "quick commands"

• You can now edit pressure plate settings

Bug fixes

We also fixed a few bugs:

• The prioritize overlay will no longer inappropriately appear when following a unit

• The "missing nemesis record" notifier has been adjusted to be a bit more selective in how it reports issues

• The rename tool is now slightly more conscientious in validating its inputs

Technical updates

There are also some technical features with this update:

• For scripters/modders, we added a library function to place spatters

• We added "original-name" attributes to virtually every DF structure whose name didn't match the Bay12 name, which facilitates reverse-engineering as well as communications with Bay12. This process also fixed a handful of typos or other errors, which may require some third-party scripts to be adjusted to reflect. A list of specific changes appears in the changelog, below

• DFHack now validates vtable pointers before using them. This will prevent DFHack from crashing when some DF data structure contains bad data. Of course, when this happens DF will probably crash sooner or later, but at least it won't be DFHack's fault...

Announcements

Issues with Steam Client Beta, PSAs

Issues with Steam Client Beta

The beta of the Steam client alters the way Steam applications are deployed in a way that impacts DFHack, and we have had reports of DFHack not working as expected for people who are using the Steam beta client. We are aware of this issue, have a plan to mitigate it in development, and hope to have a solution in place before the change Steam is making makes it to the release client.

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

• gui/logcleaner: graphical overlay for configuring the logcleaner plugin with enable and filter toggles.

• logcleaner: New plugin for time-triggered clearing of combat, sparring, and hunting reports with configurable filtering and overlay UI.

New Features

• orders: added search overlay to find and navigate to matching manager orders with arrow indicators

• sort:

  • added Uniformed filter to squad assignment screen to filter dwarves with mining, woodcutting, or hunting labors

  • Add death cause button to dead/missing tab in the creatures screen

• trackstop: can now modify pressure plates; permits minecart and creature triggers to be set beyond normal sensitivity

Fixes

• gui/rename: added check for entity_id input in get_target function

• prioritize: Fix the overlay appearing where it should not when following a unit

Misc Improvements

• Core: DFHack now validates vtable pointers in objects read from memory and will throw an exception instead of crashing when an invalid vtable pointer is encountered. This makes it easier to identify which DF data structure contains corrupted data when this manifests in the form of a bad vtable pointer, and shifts blame for such crashes from DFHack to DF.

• gui/notify: reduced severity of the missing nemesis records warning if no units on the map are affected. clarified wording.

API

• Added Items::pickGrowthPrint: given a plant material and a growth index, returns the print variant corresponding to the current in-game time.

• Added Items::useStandardMaterial: given an item type, returns true if the item is made of a specific material and false if it has a race and caste instead.

• Added Maps::addItemSpatter: add a spatter of the specified item + material + growth print to the indicated tile, returning whatever amount wouldn't fit in the tile.

• Added Maps::addMaterialSpatter: add a spatter of the specified material + state to the indicated tile, returning whatever amount wouldn't fit in the tile.

Lua

• Added Maps::addItemSpatter as dfhack.maps.addItemSpatter.

• Added Maps::addMaterialSpatter as dfhack.maps.addMaterialSpatter.

Structures

• added original-name attributes to all relevant objects

• fixed numerous structure errors

• specific changes:

  • added NONE entries to many enum types (may affect C++ code using switch() statements): abstract_building_reputation_type, adopt_region_stage_type, artifact_claim_type, block_square_event_type, building_profile_acquisition_method, civzone_type, dance_form_context, dance_form_group_size, dance_form_move_type, divination_outcome_type, dungeon_type, dungeon_wrestle_type, embark_finder_option, environment_type, era_type, flow_type, genetic_modifier_type, hf_artifact_action_type, history_event_collection_type, incident_artifact_location_type, incident_type, incident_written_content_location_type, insurrection_outcome, interaction_flags, interaction_source_type, intrigue_corruption_method_type, inventory_profile_skill_type, inv_item_role_type, journey_type, language_name_category, language_name_component, language_word_table_index, load_game_stage_type, main_choice_type, misc_trait_type, musical_form_melody_frequency, musical_form_melody_style, musical_form_purpose, occasion_schedule_feature, occasion_schedule_type, occupation_type, personality_preference_type, plant_material_def, poetic_form_persona_type, poetic_form_persona_type, prepare_rod_stage_type, projectile_type, region_weather_type, report_zoom_type, resource_allotment_specifier_type, save_substage, scale_construction_type, scale_naming_type, scale_type, secretion_condition, simple_action_type, site_dispute_type, squad_order_cannot_reason, squad_order_type, tactical_situation, talk_choice_type, theft_method_type, timbre_type, travel_log_itinerary_type, workquota_frequency_type, world_construction_type, wrestle_attack_type

  • assigned explicit "UNUSED" names to anonymous enum/bitfield members which are unused

  • expanded builtin_mats to include 640 new elements for CREATURE_1-200, HIST_FIG_1-200, PLANT_1-200, and UNUSED01-40

  • assigned proper placeholder names to interface_key section labels

  • promoted several inline-defined types to top-level (intrigue_corruption_flag, job_posting_flag, unitproperyplacementst)

  • plant_raw.stockpile_growth_flags now uses ras_crop_flag

  • added entity_raw_flags element "SIEGE_SKILLED_MINERS"

  • added stockpile_category element "ALL"

  • fixed structure layouts for adventure_interface_companionsst, caste_raw, entity_position_assignment, message_order_to_perform_actionst, and workshop_graphics_infost

  • renamed army_controller_goal_infiltrate_societyst field "agoal_ab_id" to "goal_ab_id"

  • renamed creature_graphics_layer field "dye_color_iuse_palette_rowndex" to "use_palette_row"

  • renamed entity_raw_flags enum member "MISSING_UNDERWORLD_DISASTERS" to "MINING_UNDERWORLD_DISASTERS"

  • assigned proper names to hf_religious_datast.anon_1, pet_profilest.anon_1, and unit_vision_arcst.anon_1

  • renamed historical_entity field "unkarmy_reeling_defense" to "army_reeling_defense"

  • renamed history_event_hf_learns_secretst field "interaction_effect" to "interaction_source"

  • renamed item_craft_graphics_flag field "size" to "material"

  • renamed lookinfo_spatterst field "extend" to "extent"

  • renamed personality_ethicst field "reponse" to "response"

  • renamed personality_facet_type enum member "PERSEVERENCE" to "PERSEVERANCE"

  • renamed value_type enum member "PERSEVERENCE" to "PERSEVERANCE"

  • renamed poetic_form_action enum member "MakeConsession" to "MakeConcession"

  • renamed simple_action_type enum member "performe_horrible_experiments" to "performed_horrible_experiments"

  • renamed stair_graphics_flag_material enum member "FOZEN" to "FROZEN"

  • renamed timbre_type enum member "PURE_" to "PURE"

  • renamed tissue_style_type enum member "PONY_TAILS" to "PONY_TAIL"

  • renamed unit field "job.siege_boulder" to "job.siege_builder"

  • renamed unit field "pool_index" to "pool_id"

  • renamed viewscreen_choose_start_sitest field "def_candidate_nearst" to "def_candidate_near_st"

  • changed caste_raw.extracts.blood_state and caste_raw.extracts.pus_state to use the matter_state enum

  • changed d_init.display.track_tile_invert and d_init.display.track_ramp_invert to use a bitfield

  • changed interrogation_resultst.relationship_factor to use a new enum type (which DF itself actually isn't using yet due to a bug)

  • changed intrigue_perspectivest.potential_corrupt_circumstance_target\[] to contain circumstance_id unions instead of plain integers

  • changed world.buildings.other.WINDOW_ANY to specify the correct element type

  • changed world.items.other.BAG, world.items.other.BOLT_THROWER_PARTS, world.items.other.ANY_DRINK, world.items.other.ANY_CRITTER, and world.items.other.FOOD_STORAGE to specify the correct element types

  • changed game.main_interface.last_displayed_hover_inst to use the main_hover_instruction enum

  • changed world.raws.music.all\.m_event\[] and world.raws.music.all\.context\[] to hold enums

  • changed widget_job_details_button.jb to correctly point at a job instead of a generic pointer

  • changed world.worldgen_status.rejection_reason to use the map_reject_type enum

  • changed world.history.first_\_flag\ to use the various knowledge_scholar_flags_N bitfields

  • changed the history_event vmethods getSentence and getPhrase to add 2 new boolean arguments (to which the game always passes "true, false")

  • changed the interaction_target vmethod affects_unit first parameter from an integer to a unit pointer

  • changed the item vmethod getGloveHandedness return type from int8_t to uint32_t

  • changed the item vmethod getAmmoType to take no parameters and to return an std::string by value

  • changed the item vmethod getDyeAmount to take an integer parameter

  • changed the unit vmethod getCreatureTile to take a boolean parameter

  • add ref-target attributes to various fields that were missing them, for use by gui/gm-editor and similar tools

  • changed caste_raw.extracts.vermin_bite_chance to vermin_bite_state and changed its type to matter_state

  • changed ci_personal_reputation_profilest field entity_id to cultural_identity (now referring to a cultural_identity)

  • changed cultural_identity.events\[] to cultural_identity.rumor_info.events\[]

  • changed dance_form field entity to event (now referring to at a history_event)

  • changed dance_form_section field acts_out_civ to acts_out_event (now referring to a history_event)

  • changed entity_burial_request field civ to hfid (now referring to a historical_figure)

  • changed entity_pop_specifierst field squad_id to squad_enid (now referring to a historical_entity)

  • changed gps.color\\ to gps.default_palette.color\

  • changed history_event_modified_buildingst field modification to use a different bitfield abstract_building_tower_flag

  • changed itemdef_ammost, itemdef_siegeammost, itemdef_toolst, itemdef_trapcompst, and itemdef_weaponst fields "texpos" (and "texpos2") into longer lists of specific fields

  • changed knowledge_profilest.known_events\[] to knowledge_profilest.rumor_info.events\[]

  • changed relationship_event_supplement integer field occasion_type to circumstance of type unit_thought_type (an enum)

  • changed relationship_event_supplement integer field site to circumstance_id field of type circumstance_id (a union)

  • changed relationship_event_supplement field profession to reason_id field of type history_event_reason_id

  • changed scholar_knowledge.knowledge_goal bitfield to a union of all knowledge_scholar_flags_N bitfields (selected by the value of scholar_knowledge.research_prject)

  • changed unit.enemy.rumor\[] to unit.enemy.rumor_info.events\[]

This is a beta prerelease. 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

QoL features, Bug fixes, Technical updates

QoL features

This update features many QoL features:

• For those of you with hundreds or even thousands of manager orders, we added a tool to make it a bit easier to find the one you're looking for

• We added a filter to exclude (or, if you really want, include) dwarves with "uniformed" civilian roles in the squad selection menu filters

• We added a utility to automatically clear certain categories of announcements (like sparring) from the announcement buffer so that the announcements you actually care about won't be crowded out

• We added a button to show a unit's death cause to the dead/missing units tab

• You can now assign names or labels to "quick commands"

• You can now edit pressure plate settings

Bug fixes

We also fixed a few bugs:

• The prioritize overlay will no longer inappropriately appear when following a unit

• The "missing nemesis record" notifier has been adjusted to be a bit more selective in how it reports issues

• The rename tool is now slightly more conscientious in validating its inputs

Technical updates

There are also some technical features with this update:

• For scripters/modders, we added a library function to place spatters

• We added "original-name" attributes to virtually every DF structure whose name didn't match the Bay12 name, which facilitates reverse-engineering as well as communications with Bay12. This process also fixed a handful of typos or other errors, which may require some third-party scripts to be adjusted to reflect. A list of specific changes appears in the changelog, below

• DFHack now validates vtable pointers before using them. This will prevent DFHack from crashing when some DF data structure contains bad data. Of course, when this happens DF will probably crash sooner or later, but at least it won't be DFHack's fault...

Announcements

Issues with Steam Client Beta, PSAs

Issues with Steam Client Beta

The beta of the Steam client alters the way Steam applications are deployed in a way that impacts DFHack, and we have had reports of DFHack not working as expected for people who are using the Steam beta client. We are aware of this issue, have a plan to mitigate it in development, and hope to have a solution in place before the change Steam is making makes it to the release client.

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

• gui/logcleaner: graphical overlay for configuring the logcleaner plugin with enable and filter toggles.

• logcleaner: New plugin for time-triggered clearing of combat, sparring, and hunting reports with configurable filtering and overlay UI.

New Features

• orders: added search overlay to find and navigate to matching manager orders with arrow indicators

• sort:

  • added Uniformed filter to squad assignment screen to filter dwarves with mining, woodcutting, or hunting labors

  • Add death cause button to dead/missing tab in the creatures screen

• trackstop: can now modify pressure plates; permits minecart and creature triggers to be set beyond normal sensitivity

Fixes

• gui/rename: added check for entity_id input in get_target function

Misc Improvements

• Core: DFHack now validates vtable pointers in objects read from memory and will throw an exception instead of crashing when an invalid vtable pointer is encountered. This makes it easier to identify which DF data structure contains corrupted data when this manifests in the form of a bad vtable pointer, and shifts blame for such crashes from DFHack to DF.

• gui/notify: reduced severity of the missing nemesis records warning if no units on the map are affected. clarified wording.

API

• Added Items::pickGrowthPrint: given a plant material and a growth index, returns the print variant corresponding to the current in-game time.

• Added Items::useStandardMaterial: given an item type, returns true if the item is made of a specific material and false if it has a race and caste instead.

• Added Maps::addItemSpatter: add a spatter of the specified item + material + growth print to the indicated tile, returning whatever amount wouldn't fit in the tile.

• Added Maps::addMaterialSpatter: add a spatter of the specified material + state to the indicated tile, returning whatever amount wouldn't fit in the tile.

Lua

• Added Maps::addItemSpatter as dfhack.maps.addItemSpatter.

• Added Maps::addMaterialSpatter as dfhack.maps.addMaterialSpatter.

Structures

• added original-name attributes to all relevant objects

• fixed numerous structure errors

• specific changes:

  • added NONE entries to many enum types (may affect C++ code using switch() statements): abstract_building_reputation_type, adopt_region_stage_type, artifact_claim_type, block_square_event_type, building_profile_acquisition_method, civzone_type, dance_form_context, dance_form_group_size, dance_form_move_type, divination_outcome_type, dungeon_type, dungeon_wrestle_type, embark_finder_option, environment_type, era_type, flow_type, genetic_modifier_type, hf_artifact_action_type, history_event_collection_type, incident_artifact_location_type, incident_type, incident_written_content_location_type, insurrection_outcome, interaction_flags, interaction_source_type, intrigue_corruption_method_type, inventory_profile_skill_type, inv_item_role_type, journey_type, language_name_category, language_name_component, language_word_table_index, load_game_stage_type, main_choice_type, misc_trait_type, musical_form_melody_frequency, musical_form_melody_style, musical_form_purpose, occasion_schedule_feature, occasion_schedule_type, occupation_type, personality_preference_type, plant_material_def, poetic_form_persona_type, poetic_form_persona_type, prepare_rod_stage_type, projectile_type, region_weather_type, report_zoom_type, resource_allotment_specifier_type, save_substage, scale_construction_type, scale_naming_type, scale_type, secretion_condition, simple_action_type, site_dispute_type, squad_order_cannot_reason, squad_order_type, tactical_situation, talk_choice_type, theft_method_type, timbre_type, travel_log_itinerary_type, workquota_frequency_type, world_construction_type, wrestle_attack_type

  • assigned explicit "UNUSED" names to anonymous enum/bitfield members which are unused

  • expanded builtin_mats to include 640 new elements for CREATURE_1-200, HIST_FIG_1-200, PLANT_1-200, and UNUSED01-40

  • assigned proper placeholder names to interface_key section labels

  • promoted several inline-defined types to top-level (intrigue_corruption_flag, job_posting_flag, unitproperyplacementst)

  • plant_raw.stockpile_growth_flags now uses ras_crop_flag

  • added entity_raw_flags element "SIEGE_SKILLED_MINERS"

  • added stockpile_category element "ALL"

  • fixed structure layouts for adventure_interface_companionsst, caste_raw, entity_position_assignment, message_order_to_perform_actionst, and workshop_graphics_infost

  • renamed army_controller_goal_infiltrate_societyst field "agoal_ab_id" to "goal_ab_id"

  • renamed creature_graphics_layer field "dye_color_iuse_palette_rowndex" to "use_palette_row"

  • renamed entity_raw_flags enum member "MISSING_UNDERWORLD_DISASTERS" to "MINING_UNDERWORLD_DISASTERS"

  • assigned proper names to hf_religious_datast.anon_1, pet_profilest.anon_1, and unit_vision_arcst.anon_1

  • renamed historical_entity field "unkarmy_reeling_defense" to "army_reeling_defense"

  • renamed history_event_hf_learns_secretst field "interaction_effect" to "interaction_source"

  • renamed item_craft_graphics_flag field "size" to "material"

  • renamed lookinfo_spatterst field "extend" to "extent"

  • renamed personality_ethicst field "reponse" to "response"

  • renamed personality_facet_type enum member "PERSEVERENCE" to "PERSEVERANCE"

  • renamed value_type enum member "PERSEVERENCE" to "PERSEVERANCE"

  • renamed poetic_form_action enum member "MakeConsession" to "MakeConcession"

  • renamed simple_action_type enum member "performe_horrible_experiments" to "performed_horrible_experiments"

  • renamed stair_graphics_flag_material enum member "FOZEN" to "FROZEN"

  • renamed timbre_type enum member "PURE_" to "PURE"

  • renamed tissue_style_type enum member "PONY_TAILS" to "PONY_TAIL"

  • renamed unit field "job.siege_boulder" to "job.siege_builder"

  • renamed unit field "pool_index" to "pool_id"

  • renamed viewscreen_choose_start_sitest field "def_candidate_nearst" to "def_candidate_near_st"

  • changed caste_raw.extracts.blood_state and caste_raw.extracts.pus_state to use the matter_state enum

  • changed d_init.display.track_tile_invert and d_init.display.track_ramp_invert to use a bitfield

  • changed interrogation_resultst.relationship_factor to use a new enum type (which DF itself actually isn't using yet due to a bug)

  • changed intrigue_perspectivest.potential_corrupt_circumstance_target\[] to contain circumstance_id unions instead of plain integers

  • changed world.buildings.other.WINDOW_ANY to specify the correct element type

  • changed world.items.other.BAG, world.items.other.BOLT_THROWER_PARTS, world.items.other.ANY_DRINK, world.items.other.ANY_CRITTER, and world.items.other.FOOD_STORAGE to specify the correct element types

  • changed game.main_interface.last_displayed_hover_inst to use the main_hover_instruction enum

  • changed world.raws.music.all\.m_event\[] and world.raws.music.all\.context\[] to hold enums

  • changed widget_job_details_button.jb to correctly point at a job instead of a generic pointer

  • changed world.worldgen_status.rejection_reason to use the map_reject_type enum

  • changed world.history.first_\_flag\ to use the various knowledge_scholar_flags_N bitfields

  • changed the history_event vmethods getSentence and getPhrase to add 2 new boolean arguments (to which the game always passes "true, false")

  • changed the interaction_target vmethod affects_unit first parameter from an integer to a unit pointer

  • changed the item vmethod getGloveHandedness return type from int8_t to uint32_t

  • changed the item vmethod getAmmoType to take no parameters and to return an std::string by value

  • changed the item vmethod getDyeAmount to take an integer parameter

  • changed the unit vmethod getCreatureTile to take a boolean parameter

  • add ref-target attributes to various fields that were missing them, for use by gui/gm-editor and similar tools

  • changed caste_raw.extracts.vermin_bite_chance to vermin_bite_state and changed its type to matter_state

  • changed ci_personal_reputation_profilest field entity_id to cultural_identity (now referring to a cultural_identity)

  • changed cultural_identity.events\[] to cultural_identity.rumor_info.events\[]

  • changed dance_form field entity to event (now referring to at a history_event)

  • changed dance_form_section field acts_out_civ to acts_out_event (now referring to a history_event)

  • changed entity_burial_request field civ to hfid (now referring to a historical_figure)

  • changed entity_pop_specifierst field squad_id to squad_enid (now referring to a historical_entity)

  • changed gps.color\\ to gps.default_palette.color\

  • changed history_event_modified_buildingst field modification to use a different bitfield abstract_building_tower_flag

  • changed itemdef_ammost, itemdef_siegeammost, itemdef_toolst, itemdef_trapcompst, and itemdef_weaponst fields "texpos" (and "texpos2") into longer lists of specific fields

  • changed knowledge_profilest.known_events\[] to knowledge_profilest.rumor_info.events\[]

  • changed relationship_event_supplement integer field occasion_type to circumstance of type unit_thought_type (an enum)

  • changed relationship_event_supplement integer field site to circumstance_id field of type circumstance_id (a union)

  • changed relationship_event_supplement field profession to reason_id field of type history_event_reason_id

  • changed scholar_knowledge.knowledge_goal bitfield to a union of all knowledge_scholar_flags_N bitfields (selected by the value of scholar_knowledge.research_prject)

  • changed unit.enemy.rumor\[] to unit.enemy.rumor_info.events\[]

Highlights

Compatibility with DF 53.10

This release provides compatibility with Dwarf Fortress 53.10.

Bug fixes

This release fixes a bug in `suspendmanager` that caused its overlay to appear at inappropriate times, and also fixed a bug in `autochop` that prevented it from reporting its own status.

Nemesis record validation checker

The DFHack team has noticed in recent months that many players have saves that have damaged nemesis records. Saves with damaged nemesis records often experience a wide range of misbehaviors. This release has a new feature that will periodically check that every unit in the fort that should have a nemesis record has one, and verify that it's the correct one. If a unit that should have a nemesis record does not have the correct nemesis record, a diagnostic warning will be displayed. If you get this message, we suggest that you contact Bay12 and offer to provide your save to them for debugging purposes.

Announcements

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 Features

• gui/notify: new notification type: missing nemesis records; displays a warning message about game corruption.

Fixes

• autochop: the report will no longer throw a C++ exception when burrows are defined.

• suspendmanager: Fix the overlay appearing where it should not when following a unit

API

• Added Burrows::getName: obtains the name of a burrow, or the same placeholder name that DF would show if the burrow is unnamed.

Lua

• Added Burrows::getName as dfhack.burrows.getName.

Highlights

Compatibility

This release is mainly a compatibility release for Dwarf Fortress 53.09.

Bug fixes

A bug that caused some file names to be transcoded incorrectly, causing (among other things) the blueprint tool to stop working in some situations, has been fixed.

A small tweak

An old tweak, drawbridge-tiles, altering the rendering of drawbridges in text mode so that the direction in which a raised drawbridge has been raised can be seen, has been reinstated with this release.

Announcements

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 Features

• tweak: drawbridge-tiles: Make it so raised bridges render with different tiles in ASCII mode to make it more obvious that they ARE raised (and to indicate their direction)

Fixes

• Filesystem::as_string now always uses UTF-8 encoding rather than using the system locale encoding

Highlights

Compatibility with DF 53.08

This release is solely for compatibility with Dwarf Fortress 53.08.

Announcements

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.

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

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.

Announcements

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

• fix/codex-pages: add pages to written content that have unspecified page counts.
• 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

This is a beta prerelease.

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

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.

Announcements

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

• 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

Highlights

Compatibility

This release features compatibility with Dwarf Fortress 53.06.

Bug fixes

Using the enhanced sort features in the squad selector screen will no longer cause Dwarf Fortress to crash on exit, "gui/gm-unit" will now behave correctly when used to set a unit's traits to average or to randomize them, and "gui/design" no longer has the same key bound to two different functions. Also, "infiniteSky" has been temporarily removed until we can update it to account for changes made in the siege update.

Announcements

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

Fixes

• "gui/design":

  • designating a single-level stair construction now properly follows the selected stair type.

  • adjusted conflicting keybinds, diagonal line reverse becoming "R" and bottom stair type becoming "g".

• "modtools/set-personality": use correct caste trait ranges; fixes "gui/gm-unit" being unable to correctly randomize traits or set traits to caste average

• "sort": Using the squad unit selector will no longer cause Dwarf Fortress to crash on exit

Removed

• "infiniteSky": Temporarily disabled due to incompatibility with changes made as part of DF's siege update

Structures

• added missing field in "history_event_artifact_createdst"

• fixed incorrect base class on "widget_anchored_tile"

Highlights

Compatibility with DF 53.05

This release is for compatibility with Dwarf Fortress 53.05.

Announcements

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

(There were no logged changes for this release.)

DFHack 53.04-r1.1 has been released as a hotfix to fix a defect which caused crashes in certain dialogs due to a misaligned structure.

Highlights

Compatibility with DF 53.04

This release is primarily for compatibility with Dwarf Fortress 53.04.

Better support for Siege Update

Several tools have been enhanced or updated to work better with the siege update. Autolabor, blueprint, buildingplan, gui/design, RemoteFortressReader, Stonesense, and quickfort all have received updates for the new content, and we also added a siege manager (which went in before we knew Tarn was adding one to 53.04 so now you have choices).

Announcements

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

• "gui/siegemanager": manage your siege engines at a glance.

New Features

• "item": new "--total-quality" option for use in conjunction with "--min-quality" or "--max-quality" to filter items according to their total quality

Fixes

• "buildingplan": Bolt throwers will no longer be constructed using populated bins.

• "RemoteFortressReader": updated siege engine facing enums for new diagonal directions

• "suspendmanager": treat reinforced walls as a blocking construction and buildable platform

Misc Improvements

• "autolabor": support for new dyeing and siege-related labors

• "blueprint": support for reinforced walls and bolt throwers

• "gui/design": can now construct reinforced walls

• "quickfort": support for reinforced walls and bolt throwers

• "stonesense": queued constructions of reinforced walls are now visible

Structures

• several arrays indexed by enums have been recoded to use the enum's size to size the array so that these will automatically update when the enum is updated, reflecting Bay12 practice

Highlights

Compatibility with DF 53.03

This release is for compatibility with Dwarf Fortress 53.03.

Announcements

Linux compiler change

Starting with this release, Linux release builds of DFHack will be compiled using gcc 11 and will be linked against libc 2.35 and libstdc++ 3.4.29. Prior releases were compiled using gcc 10. Since Dwarf Fortress itself is compiled with gcc 11, we do not anticipate that this will cause issues for anyone who is able to run Dwarf Fortress itself.

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

Misc Improvements

• Release builds for Linux are now compiled with gcc 11

Highlights

Building planner

The building planner has been updated to properly construct reinforced walls with the correct number and types of components, to support the new facings on catapults and ballistas, and to support the new bolt thrower. As a side benefit, the reinforced wall planner also provides a means to bypass the crash/corruption bug in DF's vanilla material selector for reinforced walls, so if you want to build reinforced walls without the risk of crashing or corrupting your game, you can now use DFHack's building planner to do it.

Cleanconst

The `cleanconst` tool has been updated to skip reinforced walls, since it's our expectation that the mechanic it uses won't properly refund the original build materials on deconstruction.

Announcements

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

Fixes

• "buildingplan": Building costs for reinforced walls are now correct.

• "cleanconst": do not attempt to clean Reinforced constructions

Misc Improvements

• "buildingplan": Added support for bolt throwers and siege engine rotation.

Highlights

Compatibility with DF 53.02

This release is for compatibility with Dwarf Fortress 53.02.

Announcements

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

Misc Improvements

• Core: added "gps" ("graphicst") to the set of globals whose sizes must agree for DFHack to pass initialization checks

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

This is primarily a compatibility release for Dwarf Fortress 53.01.

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

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

Archery practice

Archery practice appears to be finally and fully fixed in 53.01, and so the "fix/archery-practice" tool has been deprecated in this release. You can still use it if you want, and it shouldn't hurt anything if you do, but it's no longer needed.

Announcements

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

• "fix/symbol-unstick": unstick noble symbols that cannot be re-designated.

• "resize-armor": resize armor or clothing item to any creature size.

Fixes

• "autotraining": squads once used for training then disabled now properly are treated as disabled.

Misc Improvements

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

Removed

• "fix/archery-practice": removed from the control panel's bug fixes tab.

This is a beta release. To install, select the beta branch for DFHack in your Steam client.

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

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.

Announcements

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

• "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.