14 Jan 11:02

e41f249

DFHack 50.11-r5rc2 Pre-release

Pre-release

Q: How do I download DFHack?

A: Either add to your Steam library from our Steam page or scroll to the latest release on our GitHub releases page, expand the "Assets" list, and download the file for your platform (e.g. dfhack-XX.XX-rX-Windows-64bit.zip. If you are on Windows and are manually installing from the zip file, please remember to right click on the file after downloading, open the file properties, and select the "Unblock" checkbox. This will prevent issues with Windows antivirus programs.

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

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!

New features in need of feedback and testing

gui/control-panel, gui/autobutcher, confirm, uniform-unstick, gui/mass-remove, gui/reveal, gui/biomes, gui/teleport

gui/control-panel layout overhaul

The control panel received a significant overhaul. Tools are now categorized into subtabs, gathering the automation, bugfix, and gameplay tools into sublists. The file format for storing control panel configuration has changed as well. When you load this release of DFHack, your previous control panel settings should be seamlessly migrated to the new format. The main behavior change is that some things that were only configured globally (like the tools on the now-gone "Maintenance" tab) are now configurable per-fort. There is also more information about what things are. For example, each overlay now has a short description.

What do you think of the new layout and tab structure? Is it easier to find the tools you're looking for? Do you feel more confident about enabling new things?

gui/autobutcher mousification

gui/autobutcher finally got updated with modern widgets and mouse gestures. You can now select fields to edit by double clicking on them. The list of livestock now also shows you the total counts per race, and the list of race targets is sortable and filterable. What do you think? Is it easier to use than the previous version? Pro tip: to unmark the slaughter tag from all animals of a particular race, double click on the number in the "Butchering ordered" column.

confirm rewrite and new prompts

The confirm framework has been completely rewritten, and thanks to many good suggestions on Reddit, there are now a wide variety of new confirmation prompts that protect you from accidentally invoking irreversible and highly impactful UI operations (like disbanding a squad or deconstructing the trade depot while merchants are using it). Is there anything you think we've missed? What do you think of the new confirmation prompts? Is it easy to pause them when you want to (e.g. when deleting a bunch of manager orders)?

uniform-unstick uniform fixing tool

When you look at your squad equipment, there will be a new button that says "Detect conflicts". This will bring up a report of squad equipment problems, such as squad members being assigned to conflicting labors like mining or hunting, or the same piece of equipment being assigned to multiple squad members, or even citizens being members of squads from different forts (this can happen with migrants from forts that you have retired). There's a button at the top of the report that attempts to fix all the problems. Does it work for you? Do your forever-yellow equipment icons finally turn green? Remember to click "Update equipment" after running the fixer so that new equipment gets assigned to units that need it.

gui/mass-remove now easier to use

gui/mass-remove is our tool for easily removing multiple buildings and other things. It gained much more configurability, so you can now, for example, have it just remove planned buildings and ignore fully built ones. It can also cancel removal of buildings and constructions via area select. It has a global hotkey for quick access: Ctrl-M while on the main fort map. Give it a try and tell us if it works well for you when you need to remove a bunch of stuff.

gui/reveal for temporary xray vision

I've seen people talk on Reddit and the Discord servers about how to plan your fort layout after you embark but before you unpause. Frequently, I see people advising use of reveal to see where the caverns are so you can plan your fort around them. This is always followed by the warning "Remember to run unreveal before you unpause! Otherwise the caverns get "discovered" early and then if you unreveal later then parts that you dug out will be hidden again and things get weird."

To make this process less error-prone, we now have gui/reveal. It reveals the map when it comes up and forces the game to pause while the gui/reveal window is open. You can scan around the map and designate digging for your fort. When you right click on the little gui/reveal window to close it, the map is hidden again, and you can play the game as normal.

You can choose to keep the map revealed, of course, but the more common case where only a temporary reveal is desired is much easier to handle now.

gui/biomes for biome boundary visualization

If you have embarked at the intersection of two or more biomes, you may have trouble finding a place for your farm plots so that you can grow the crops you want. gui/biomes can show you where the boundaries are, and will also give you information about the biomes themselves, such as their wildness rating.

gui/teleport for mouse-driven unit teleporting

Another painful process I've seen discussed on Reddit relates to when a unit gets into an impossible situation, like when they dodge into a wall or (sometimes) into the unexplored regions of a cavern and they can't get out. This tends to tank your FPS and make the game unplayable. The commandline teleport command does exist, but it's a multi-step process. You have to find the unit ID of the rogue unit, enable the keyboard cursor, get the position of where to teleport the unit to, and feed all that information into the teleport command. Now, with gui/teleport, it's point and click. It also comes with some handy filters for when you're trying to rescue friendly units from among hostiles. You can area select and only pick out the citizens and friendly units.

Announcements

Plugin ABI version bump, PSAs

Plugin ABI version bump

If you are developing an external plugin for DFHack, be aware that the plugin binary interface (ABI) has changed to support the new site-local persistence model. See changes to the sample code in https://github.com/DFHack/dfhack/tree/develop/plugins/examples for details.

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.

Many 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 do not compile yet and are not available 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

control-panel: new commandline interface for control panel functions
gui/biomes: visualize and inspect biome regions on the map
gui/reveal: temporarily unhide terrain and then automatically hide it again when you're ready to unpause
gui/teleport: mouse-driven interface for selecting and teleporting units
uniform-unstick: (reinstated) force squad members to drop items that they picked up in the wrong order so they can get everythin...

Assets 4

05 Jan 11:01

github-actions

50.11-r5rc1

bb9bc27

DFHack 50.11-r5rc1 Pre-release

Pre-release

Q: How do I download DFHack?

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

New features in need of feedback and testing

gui/control-panel, gui/autobutcher, confirm, uniform-unstick, gui/mass-remove

gui/control-panel layout overhaul

What do you think of the new layout and tab structure? Is it easier to find the tools you're looking for? Do you feel more confident about enabling new things?

gui/autobutcher mousification

confirm rewrite and new prompts

uniform-unstick uniform fixing tool

When you look at your squad equipment, there will be a new button that says "Detect conflicts". This will bring up a report of squad equipment problems, such as squad members being assigned to conflicting labors like mining or hunting, or the same piece of equipment being assigned to multiple squad members. There's a button at the top of the report that attempts to fix all the problems. Does it work for you? Do your forever-yellow equipment icons finally turn green? Remember to click "Update equipment" after running the fixer so that new equipment gets assigned to units that need it.

gui/mass-remove now easier to use

gui/mass-remove is our tool for easily removing multiple buildings and other things. It gained much more configurability, so you can now, for example, have it just remove planned buildings and ignore fully built ones. It now also has a global hotkey for quick access: Ctrl-M while on the main fort map. Give it a try and tell us if it works well for you when you need to remove a bunch of stuff.

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.

Changelog

New tools, fixes, and improvements

New Tools

control-panel: new commandline interface for control panel functions
uniform-unstick: (reinstated) force squad members to drop items that they picked up in the wrong order so they can get everything equipped properly

New Features

gui/mass-remove: new global keybinding: Ctrl-M while on the fort map
sort: search and sort for the "choose unit to elevate to the barony" screen. units are sorted by the number of item preferences they have and the units are annotated with the items that they have preferences for
uniform-unstick: add overlay to the squad equipment screen to show a equipment conflict report and give you a one-click button to fix

Fixes

ban-cooking: fix banning creature alcohols resulting in error
confirm: properly detect clicks on the remove zone button even when the unit selection screen is also open (e.g. the vanilla assign animal to pasture panel)
misery: fix error when changing the misery factor
reveal: now avoids revealing blocks that contain divine treasures, encased horrors, and deep vein hollows (so the surprise triggers are not triggered prematurely)
sort:
- fix mouse clicks falling through the squad assignment overlay panel when clicking on the panel but not on a clickable widget
- fix potential crash when removing jobs directly from the Tasks info screen
warn-stranded:
- Automatically ignore citizens who are gathering plants or digging to avoid issues with gathering fruit via stepladders and weird issues with digging
- Update onZoom to use df's centering functionality

Misc Improvements

wherever units are listed in DFHack tools, properties like "agitated" or (-trained-) are now shown
autochop: better error output when target burrows are not specified on the commandline
confirm:
- updated confirmation dialogs to use clickable widgets and draggable windows
- added confirmation prompt for right clicking out of the trade agreement screen (so your trade agreement selections aren't lost)
- added confirmation prompts for irreversible actions on the trade screen
- added confirmation prompt for deleting a uniform
- added confirmation prompt for convicting a criminal
- added confirmation prompt for re-running the embark site finder
- added confirmation prompt for reassigning or clearing zoom hotkeys
- added confirmation prompt for exiting the uniform customization page without saving
gui/autobutcher: interface redesigned to better support mouse control
gui/control-panel:
- reduce frequency for warn-stranded check to once every 2 days
- tools are now organized by type: automation, bugfix, and gameplay
gui/launcher: now persists the most recent 32KB of command output even if you close it and bring it back up
gui/mass-remove:
- can now differentiate planned constructions, stockpiles, and regular buildings
- can now remove zones
gui/quickcmd: clickable buttons for command add/remove/edit operations
work-now: now saves its enabled status with the fort

Structures

alert_button_announcement_id: now int32_t vector (contains report ids)
announcement_alertst: defined
announcement_alert_type: enum defined
announcement_type: added alert_type enum attribute
markup_text_boxst: updated based on information from Bay12
markup_text_linkst, markup_text_wordst, script_environmentst: defined
``...

Assets 4

22 Nov 19:41

github-actions

50.11-r4

eb14a3f

DFHack 50.11-r4

Q: How do I download DFHack?

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

This is a quick release that addresses some small but important bug fixes and quality of life improvements. See the Changelog below 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.

Changelog

New tools, fixes, and improvements

New tools

build-now: (reinstated) instantly complete unsuspended buildings that are ready to be built

Fixes

RemoteServer: don't shut down the socket prematurely, allowing continuing connections from, for example, dfhack-run
buildingplan: fix choosing the wrong mechanism (or something that isn't a mechanism) when linking a lever and manually choosing a mechanism, but then canceling the selection
combine: prevent stack sizes from growing beyond quantities that you would normally see in vanilla gameplay
sort:
- fix potential crash when exiting and re-entering a creatures subtab with a search active
- prevent keyboard keys from affecting the UI when search is active and multiple keys are hit at once
tailor: fix corner case where existing stock was being ignored, leading to over-ordering

Misc Improvements

buildingplan:
- save magma safe mechanisms for when magma safety is requested when linking levers and pressure plates to targets
- when choosing mechanisms for linking levers/pressure plates, filter out unreachable mechanisms
caravan: enable searching within containers in trade screen when in "trade bin with contents" mode
sort: when searching on the Tasks tab, also search the names of the things the task is associated with, such as the name of the stockpile that an item will be stored in

Assets 4

16 Nov 16:32

github-actions

50.11-r3

ed9e6c8

DFHack 50.11-r3

Q: How do I download DFHack?

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

Highlights

Selection dimension indicator, Choose mechanisms for linking, Burrows!

Selection dimension indicator

At long last, we have a measurement tooltip that follows the cursor when you are designating an area, for example when painting burrows, stockpiles, or digging designations.

Choose mechanisms for linking

Have you ever needed to link a lever to a floodgate or bridge that will be holding back magma, and then been frustrated when you found you had no control over whether a magma-safe mechanism was chosen to make the link?

The mechanism linking dialog is now integrated with buildingplan, giving you quick filters for autoselecting a mechanism based on how much heat it will need to withstand or letting you choose a specific mechanism from your stock. This feature is available for linking both levers and pressure plates.

Burrows!

Burrows got a lot of attention in this release. In DF, burrows are useful for defining areas that limit:

where assigned units perform tasks
where civilians can go for protection during an emergency (using gui/civ-alert)
where woodcutters harvest (or clearcut) trees (using gui/autochop)
where squad members gather to defend against threats

but they can be a bit of a pain to work with. For example, setting up the burrow area across a multi-level fortress requires tedious box selection on every z-level. And when you have a 'Safe/Inside' burrow, it's difficult to remember to extend the burrow whenever you do some digging and expand your living area.

Also, if you have your units assigned to burrows for job purposes, it's also difficult to manage who is assigned where. Notably, if a unit dies while assigned to a burrow, you can't unassign that (dead) unit from the burrow and your count of assigned units will be inaccurate.

In light of all this, DFHack now provides a wide range of new burrow-related capabilities that should make them more fun and efficient to use.

Special thanks to Black-Talon for excellent suggestions and significant help with testing these features!

3D box select

First of all, the vanilla box select that was limited to painting a single z-level at a time is replaced with a 3D selection box that can paint a burrow across your fort's z-levels at once!

Flood fill

Second, if you double click on a tile, you'll get a handy flood fill. This means that if you double click on the floor inside of your fort, the selection will flood to your entire fort on that level. The selection will include the adjacent walls so they can be smoothed and engraved by units that are assigned to the burrow itself.

Hold down Shift when you double click and you'll allow the flood to expand across z-levels. You can define a burrow for your entire fort with one shift-double click! The flood stops at forbidden doors and closed bridges, so it won't include the caverns if you have them blocked off. If you do accidentally include the caverns, erase a boundary between your fort and the caverns and shift-double click on the cavern side to remove just the cavern tiles from your burrow, just like the bucket tool in a painting app.

Auto-expanding burrows

Third, you can set a burrow to auto-expand as you dig. If you name a burrow with a trailing plus symbol (+), like "Inside+", then as your miners dig, the burrow will automatically expand to include the newly exposed tiles. Make sure to include the surrounding walls in your original burrow designation so the auto expansion checks know which wall tiles to monitor.

Search filters

Fourth, there are updated unit search and filters for easier unit burrow assignment. The search widgets on the burrow assignment screen have gained the ability to filter by burrow membership, so you can easily add or remove one burrow's members when working with another burrow.

Supporting tools

There are also supporting tools that make burrows more useful. If you turn on dead-units-burrow in the gui/control-panel "Maintenance" tab, then units will automatically be removed from your burrows when they die. The quickfort blueprinting tool can now create new burrows and add tiles to existing ones. It can even register a burrow with gui/civ-alert or autochop, saving you some manual steps when you are laying down plans for your fortress. The Dreamfort set of quickfort blueprints takes advantage of this to set up more of your fort for you automatically.

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.

Generated release notes

New tools, fixes, and improvements

New Tools

burrow: (reinstated) automatically expand burrows as you dig
sync-windmills: synchronize or randomize movement of active windmills
trackstop: (reimplemented) integrated overlay for changing track stop and roller settings after construction

New Features

buildingplan: allow specific mechanisms to be selected when linking levers or pressure pl...

Assets 4

19 Oct 15:08

github-actions

50.11-r2

fa78ec5

DFHack 50.11-r2

Q: How do I install DFHack?

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

Highlights

Search! Search! Search!, Preserve tomb assignments, Collapse all for stocks screen, Automatic tomb zones, Stranded citizen alert

Search! Search! Search!

We finally have search widgets for many of the screens with long lists. No longer will you need to scroll endlessly to find Bim Zasitisos, Cook. You can just type "bim", or "cook", or maybe "knifedales", since that's what "Zasitisos" translates to and it's the name you see in some contexts. You can also search by the name of the job they're currently doing. Or hey, search for "forgotten" on the "Others" tab to see which forgotten beasts you've actually forgotten about in the caverns:

For each screen, you can click on the search field to focus it or hit the keyboard hotkey (Alt-s) and start typing. Just like all DFHack text entry fields, you can hit Ctrl-x to clear the text or Ctrl-v to paste from your operating system clipboard.

Remember that you can search for more than just the name. Some examples:

Search for "steel short sword" when choosing artifacts to send a raid for
Search for "appraisal" when choosing a broker

Some screens come with additional filters. For example, in the "Engrave slab" menu, you can click a button and see just the units that you need to engrave a slab for to prevent ghosts. Similarly, when choosing which guildhall or temple to establish, you can now filter out the ones that you've already established. Now you can create chapels for each of the 40 deities that your dwarves somehow find time to worship and be confident that you aren't wasting space on duplicates.

The Justice tabs in particular received the most filtering capabilities. You can now easily see just the high-risk visitors you should be paying attention to (e.g. intelligent undead or professional criminals).

In all, DFHack has added search widgets to more than 30 screens/lists:

Info -> Creatures -> Citizens
Info -> Creatures -> Pets/Livestock
Info -> Creatures -> Pets/Livestock -> Overall Training
Info -> Creatures -> Pets/Livestock -> Assign Trainer
Info -> Creatures -> Others
Info -> Creatures -> Dead/Missing
Info -> Tasks
Info -> Labor -> Work details
Info -> Nobles -> Choose candidate
Info -> Objects -> Artifacts
Info -> Objects -> Symbols
Info -> Objects -> Named objects
Info -> Objects -> Written content
Info -> Justice -> * -> Interrogate
Info -> Justice -> * -> Convict
Location selector -> Temple
Location selector -> Guildhall
Unit selector -> Bedroom
Unit selector -> Office
Unit selector -> Dining hall
Unit selector -> Tomb
Unit selector -> Workshop worker
Unit selector -> Occupation
Unit selector -> Burrow
Unit selector -> Squad kill order
Unit selector -> Squad assignment
Stoneworker's workshop -> Engrave slab -> Choose unit to memorialize

In addition, DFHack assists these workflows with searchable/filterable selection dialogs:

Zone -> Pasture -> Assignment
Zone -> Pit -> Assignment
Cage -> Assignment
Restraint -> Assignment
Pedestal -> Choose item for display
Trade depot -> Bring items to depot
Trade depot -> Trade

Preserve tomb assignments

Have you noticed that your nobles don't actually get buried in the nice tombs you assigned to them while they were alive and demanding nice tombs? This is because DF loses track of that assignment when they die, which is amusingly and tragically ironic.

Enable preserve-tombs in the DFHack gui/control-panel ("Fort" and "Autostart" tabs) to keep track of those tomb assignments and ensure they are actually used for their intended purposes.

Single click collapse all for stocks screen

Often, you just want to know how many of each category of thing you have. The group info bars have that information, but you need to click on each of them to collapse them to see more than one of them at a time. Now there is a solution to collapse all visible groups with one click. There is now a button off the right side of the stocks panel that says "collapse all". Click that button or hit the hotkey (Ctrl-x) to collapse everything down to a single line each.

Automatic tomb zone creation

Setting up tombs is a chore. You have to place the coffins, and then for each coffin, you have to declare a Tomb zone. With the burial command, you can get those Tomb zones created for you automatically. Just run the command after you place the coffins to get the Tomb zones for free. No extra clicks!

Get notified for stranded citizens

Have you ever closed off the caverns and only later noticed that you had dwarves trapped down there? With warn-stranded, you can get notified quickly that you have citizens that can't reach their peers. You'll then have enough time to organize a rescue mission before they start starving. It also catches units stuck in trees or in pits.

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.

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.

Generated release notes

New tools, fixes, and improvements

New Tools

add-recipe: (reinstated) add reactions to your civ (e.g. for high boots if your civ didn't start with the ability to make high boots)
burial: (reinstated) create tomb zones for unzoned coffins
fix/corrupt-jobs: prevents crashes by automatically removing corrupted jobs
preserve-tombs: keep tombs assigned to units when they die
spectate: (reinstated) automatically follow dwarves, cycling among interesting ones

New Scripts

warn-stranded: new repeatable maintenance script to check for stranded units, similar to warn-starving

New Features

burial: new options to configure automatic burial and limit scope to the current z-level
drain-aquifer:
- gained ability to drain just above or below a certain z-level
- new option to drain all layers except for the first N aquifer layers, in case you want some aquifer layers but not too many
gui/control-panel: drain-aquifer --top 2 added as an autostart option
logistics: automelt now optionally supports melting masterworks; click on gear icon ...

Assets 4

12 Oct 19:31

github-actions

50.11-r2rc1

db08110

DFHack 50.11-r2rc1 Pre-release

Pre-release

Q: How do I download DFHack?

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

If installing from Steam, remember to switch to the beta branch in the properties for DFHack in the Steam client.

Highlights

Search! Search! Search!, Preserve tomb assignments

Search! Search! Search!

We finally have search widgets for many of the screens with long lists. No longer will you need to scroll endlessly to find Bim Zasitisos, Cook. You can just type "bim", or "cook", or maybe "knifedales", since that's what "Zasitisos" translates to and it's the name you see in some contexts. Or hey, search for "forgotten" on the "Others" tab to see which forgotten beasts you've forgotten about in the caverns:

Search units on the Citizens tab:

Search (and filter) interview candidates on the Justice tab:

Search artifacts on the world screen (for raids):

Search religions for dedicating a new temple:

So far, here are the screens that are covered:

Info -> Creatures -> Citizens
Info -> Creatures -> Pets/Livestock
Info -> Creatures -> Pets/Livestock -> Overall Training
Info -> Creatures -> Pets/Livestock -> Assign Trainer
Info -> Creatures -> Others
Info -> Creatures -> Dead/Missing
Info -> Tasks
Info -> Labor -> Work details
Info -> Objects -> Artifacts
Info -> Objects -> Symbols
Info -> Objects -> Named objects
Info -> Objects -> Written content
Info -> Justice -> * -> Interrogate
Info -> Justice -> * -> Convict
Location selector -> Temple
Location selector -> Guildhall
Unit selector -> Bedroom
Unit selector -> Office
Unit selector -> Dining hall
Unit selector -> Tomb
Unit selector -> Workshop worker
Unit selector -> Occupation
Unit selector -> Burrow
Unit selector -> Squad kill order

Plus the screens that were already covered in previous DFHack versions:

Unit selector -> Squad assignment
Zone -> Pasture -> Animal assignment
Zone -> Pit -> Animal assignment
Building -> Cage -> Animal assignment
Building -> Restraint -> Animal assignment

Preserve tomb assignments

Enable preserve-tombs in the DFHack gui/control-panel ("Fort" and "Autostart" tabs) to keep track of those tomb assignments and ensure they are actually used for their intended 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.

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.

Generated release notes

New tools, fixes, and improvements

New Tools

add-recipe: (reinstated) add reactions to your civ (e.g. for high boots if your civ didn't start with the ability to make high boots)
preserve-tombs: keep tombs assigned to units when they die
spectate: (reinstated) automatically follow dwarves, cycling among interesting ones

New Features

drain-aquifer:
- gained ability to drain just above or below a certain z-level
- new option to drain all layers except for the first N aquifer layers, in case you want some aquifer layers but not too many
gui/control-panel: drain-aquifer --top 2 added as an autostart option
logistics: automelt now optionally supports melting masterworks; click on gear icon on stockpiles overlay frame
sort:
- new search widgets for Info panel tabs, including all "Creatures" subtabs, all "Objects" subtabs, "Tasks", and the "Work details" subtab under "Labor"
- new search and filter widgets for the "Interrogate" and "Convict" screens under "Justice"
- new search widgets for location selection screen (when you're choosing what kind of guildhall or temple to dedicate)
- new search widgets for burrow assignment screen and other unit assignment dialogs
- new search widgets for artifacts on the world/raid screen

Fixes

gui/sandbox: fix scrollbar moving double distance on click
hide-tutorials: fix the embark tutorial prompt sometimes not being skipped
suspendmanager: fix errors when constructing near the map edge
zone: don't show animal assignment link for cages and restraints linked to dungeon zones (which aren't normally assignable)

Misc Improvements

orders: recheck command now only resets orders that have conditions that can be rechecked
overlay: allow overlay_onupdate_max_freq_seconds to be dynamically set to 0 for a burst of high-frequency updates
sort: added help button for squad assignment search/filter/sort
zone: animals trained for war or hunting are now labeled as such in animal assignment screens

Removed

FILTER_FULL_TEXT: moved from gui.widgets to utils; if your full text search preference is lost, please reset it in gui/control-panel

Lua

added GRAY color aliases for GREY colors
utils.search_text: text search routine (generalized from internal widgets.FilteredList logic)

Structures

add new global: translate_name
artifact_rumor_locationst: defined
viewscreen_worldst: defined types for view_mode and artifacts_arl fields
world_view_mode_type: defined

Assets 4

03 Oct 07:10

github-actions

50.11-r1

942cbe2

DFHack 50.11-r1

Q: How do I download DFHack?

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

Highlights

Display furniture item selector, Scrolling for the unit list when embarking

Display furniture item selector

The vanilla screen for choosing which items you want to display on a pedestal or display case requires quite a bit of scrolling and clicking to use. It is also hard to figure out how the items you have assigned will affect the value of the room. There is now an alternate dialog that should make the process much easier and less opaque:

You can search items by name (including book titles), filter by quality (e.g. see only artifacts), and sort by name, value, or where the item is currently assigned for display.

If the pedestal is in a guildhall or temple, there is also a convenient indicator for whether you've added enough value to bump the guildhall or temple to the next tier. For example, if you need to provide your citizens with a grand guildhall, the indicator will change from "Guildhall" to "Grand guildhall" when you've assigned items with enough value.

Scrolling for the unit list when embarking

Some people have already experimented with the newly re-added startdwarf script, which allows you to change the number of dwarves you embark with, and have found that the DF embark screen doesn't support scrolling for the unit list. This means that if you embark with more dwarves than can fit on your screen, you cannot select them to configure their skills.

We now have a DFHack-added scrollbar so you can scroll up and down through the list and configure each of your extra dwarves:

Note that the vanilla screen was not intended to be scrolled, so the behavior of the list is a little odd. When you select a dwarf to configure, the list will jump so that the dwarf you selected is at the top of the screen. This can be a little disorienting, but the dwarf is still configurable, and all dwarves are accessible.

Announcements

Mouse event definitions have changed for scripts, PSAs

Mouse event definitions have changed for scripts

This only affects modders and players who are writing their own DFHack scripts and who react to mouse events like _MOUSE_L or _MOUSE_L_DOWN. Everyone else can skip reading this.

Back in the pre-v50 days, when the mouse was much less used in DF, I made a mistake in how I interpreted DF's handling of mouse button state. The result is that DFHack has been representing mouse state incorrectly to the Lua scripts. This hasn't been much of a problem since all the scripts were written to misinterpret the state the same way. However, now that DFHack tools are integrating more closely with the vanilla DF UI, the difference in interpretation of mouse state is causing conflicts.

The _MOUSE_L event now correctly fires when the mouse button has just been clicked, and the _MOUSE_L_DOWN event now correctly fires when the mouse button is held down. The previous definitions were backwards.

If you have written your own script and you refer to mouse events in your onInput(keys) function, you can update to the new definitions by swapping references to _MOUSE_L with _MOUSE_L_DOWN and vice versa. Similarly for _MOUSE_R and _MOUSE_M, if you happen to use them. My apologies for breaking scripts. This is something we try not to do very often, though hopefully this change will make up for the hassle by allowing scripts to integrate more smoothly with vanilla DF widgets. Thanks!

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.

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.

Generated release notes

New tools, fixes, and improvements

New Tools

startdwarf: (reinstated) set number of starting dwarves
tubefill: (reinstated) replenishes mined-out adamantine

New Features

A new searchable, sortable, filterable dialog for selecting items for display on pedestals and display cases
startdwarf: overlay scrollbar so you can scroll through your starting dwarves if they don't all fit on the screen

Fixes

EventManager: Unit death event no longer misfires on units leaving the map
autolabor: ensure vanilla work details are reinstated when the fort or the plugin is unloaded
suspendmanager: fixed a bug where floor grates, bars, bridges etc. wouldn't be recognised as walkable, leading to unnecessary suspensions in certain cases.
dfhack.TranslateName(): fixed crash on certain invalid names, which affected warn-starving

Misc Improvements

EventManager:
- guard against potential iterator invalidation if one of the event listeners were to modify the global data structure being iterated over
- for onBuildingCreatedDestroyed events, changed firing order of events so destroyed events come before created events
devel/inspect-screen: display total grid size for UI and map layers
digtype:
- designate only visible tiles by default, and use "auto" dig mode for following veins
- added options for designating only current z-level, this z-level and above, and this z-level and below
hotkeys:
- make the DFHack logo brighten on hover in ascii mode to indicate that it is clickable
- use vertical bars instead of "!" symbols for the DFHack logo in ascii mode to make it easier to read
suspendmanager: now suspends constructions that would cave-in immediately on completion

Lua

mouse key events are now aligned with internal DF semantics: _MOUSE_L indicates that the left mouse button has just been pressed and _MOUSE_L_DOWN indicates that the left mouse button is being held down. similarly for _MOUSE_R and _MOUSE_M. 3rd party scripts may have to adjust.

Structures

add new global: start_dwarf_count

Assets 4

19 Sep 22:47

lethosor

50.10-r1.1

8d03dd4

DFHack 50.10-r1.1

This release fixes a crash on startup when using the Windows Itch build of DF. All other functionality is identical to 50.10-r1.

For release notes and full instructions, see the 50.10-r1 release notes: https://github.com/DFHack/dfhack/releases/tag/50.10-r1

Assets 4

19 Sep 16:56

github-actions

50.10-r1

8e86c5c

DFHack 50.10-r1

Warning to Windows Itch users: this build will crash on startup for you. Please download DFHack 50.10-r1.1 instead. All other builds are unaffected (Windows Steam/Classic and all Linux builds).

Q: How do I download DFHack?

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

Announcements

Linux support, PSAs

Linux support

As of DF 50.10, both DF and DFHack can run natively on Linux. If you're subscribed to DF and DFHack on Steam, here's how to switch over:

In the Steam client, open the properties for Dwarf Fortress
Select the "Compatibility" section and deselect "Force the use of a specific Steam Play compatibility tool"
- If you're on Steam Deck, instead of turning off the compatibility layer, choose "Steam Linux Runtime" as the compatibility layer instead.
DF should update with the Linux native version

You can tell if you did it right if you no longer have Dwarf Fortress.exe in your DF directory and instead have dwarfort, which is the Linux binary.

Then, turn off/adjust the compatibility layer for DFHack as well. dfhooks.dll will disappear and you'll get libdfhooks.so and the dfhack script in its place.

Sometimes, Steam says you've got the Linux version, but when you look you see you still have Dwarf Fortress.exe instead of dwarfort. Try re-enabling the Proton compatibility layer and then turning off the compatibility layer again until it "sticks".

The DFHack terminal console works differently on Linux

You can run DF with DFHack from the Steam client without issues. However, if you want an external DFHack terminal console, you have to run from the commandline with the ./dfhack launcher script.

On Windows (or in Windows emulation), you could use the show command to pop up an external DFHack terminal console. You would use this for running DFHack commands from outside the game window, and the external terminal is the only way to run commandline-interactive DFHack commands like tiletypes and the interactive mode of the lua interpreter.

Linux has a different method of providing a terminal console. You can't spawn it dynamically like you can on Windows. You have to start DF from the commandline, and the terminal from which you ran ./dfhack becomes the terminal console. This should be a familiar process to many Linux users (most Linux commands work this way), but the change is jarring if you're not expecting it. We're also looking into providing a virtual console that doesn't depend on an existing system console so you can still get a console even if you run from Steam, but that work is far from being completed.

You can still launch from Steam if you want to. Many tools log information and errors to the console, though, so if you run into strange issues, it might be useful to try running from the commandline to see if there is diagnostic output there that can help you.

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.

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.

Highlights

This is just a compatibility release; please see the release notes for 50.09-r3 and 50.09-r4 for significant recent changes to DFHack.

Generated release notes

New tools, fixes, and improvements

Fixes

'fix/general-strike: fix issue where too many seeds were getting planted in farm plots
Linux launcher: allow Steam Overlay and game streaming to function
autobutcher: don't ignore semi-wild units when marking units for slaughter

Assets 4

14 Sep 20:32

github-actions

50.09-r4

ca32e6a

DFHack 50.09-r4

Q: How do I download DFHack?

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

For Linux support, please configure your Steam client to subscribe to the DF beta release branch and the DFHack 50.10-beta release branch (or download the DFHack 50.10-beta1 release from GitHub).

Announcements

PSAs

Please see the release notes for DFHack 50.09-r3 for extensive information on Linux support.

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.

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.

Highlights

Squad assignment sort improvements, Smooth/carve designation indicators for ASCII mode

Squad assignment sort improvements

Units now have a rating displayed next to them. The ratings are the values used for the current sort, and are colored based on how "good" the unit is according to the sort option. The "stress face" graphics are used for the "stress" and the new "need for training" sorts to indicate how dire the need is.

There are also a few new filters. You can now choose whether mothers with infants, units with weak mental fortitude (who would then become unduly stressed by military service), and critically injured units are shown as candidates.

Smooth/carve designation indicators for ASCII mode

ASCII mode has been missing any indication of smoothing/engraving/track carving/fortification carving designations. DFHack will now automatically add in visual indicators so you can see what you have designated. They will flash between an icon indicating the designation type and the priority you have set the designation for, similar to how the information was displayed in older versions of DF.

Generated release notes

New tools, fixes, and improvements

New Features

dig: new overlay for ASCII mode that visualizes designations for smoothing, engraving, carving tracks, and carving fortifications

Fixes

buildingplan: make the construction dimensions readout visible again
gui/mod-manager: don't continue to display overlay after the raws loading progress bar appears
seedwatch: fix a crash when reading data saved by very very old versions of the plugin

Misc Improvements

autofish: changed --raw argument format to allow explicit setting to on or off
caravan: move goods to depot screen can now see/search/trade items inside of barrels and pots
gui/launcher: show tagged tools in the autocomplete list when a tag name is typed
sort:
- add sort option for training need on squad assignment screen
- filter mothers with infants, units with weak mental fortitude, and critically injured units on the squad assignment screen
- display a rating relative to the current sort order next to the visible units on the squad assignment screen

API

overlay: overlay widgets can now declare a version attribute. changing the version of a widget will reset its settings to defaults. this is useful when changing the overlay layout and old saved positions will no longer be valid.

Lua

argparse.boolean: convert arguments to lua boolean values.

Structures

Identified a number of previously anonymous virtual methods in itemst

Documentation

add instructions for downloading development builds to the Installing page

Assets 4

Releases: DFHack/dfhack

DFHack 50.11-r5rc2

Q: How do I download DFHack?

New features in need of feedback and testing

gui/control-panel layout overhaul

gui/autobutcher mousification

confirm rewrite and new prompts

uniform-unstick uniform fixing tool

gui/mass-remove now easier to use

gui/reveal for temporary xray vision

gui/biomes for biome boundary visualization

gui/teleport for mouse-driven unit teleporting

Announcements

Plugin ABI version bump

PSAs

Changelog

New Tools

DFHack 50.11-r5rc1

Q: How do I download DFHack?

New features in need of feedback and testing

gui/control-panel layout overhaul

gui/autobutcher mousification

confirm rewrite and new prompts

uniform-unstick uniform fixing tool

gui/mass-remove now easier to use

Announcements

PSAs

Changelog

New Tools

New Features

Fixes

Misc Improvements

Structures

DFHack 50.11-r4

Q: How do I download DFHack?

Announcements

PSAs

Changelog

New tools

Fixes

Misc Improvements

DFHack 50.11-r3

Q: How do I download DFHack?

Highlights

Selection dimension indicator

Choose mechanisms for linking

Burrows!

3D box select

Flood fill

Auto-expanding burrows

Search filters

Supporting tools

Announcements

PSAs

Generated release notes

New Tools

New Features

DFHack 50.11-r2

Q: How do I install DFHack?

Highlights

Search! Search! Search!

Preserve tomb assignments

Single click collapse all for stocks screen

Automatic tomb zone creation

Get notified for stranded citizens

Announcements

PSAs

Generated release notes

New Tools

New Scripts

New Features

DFHack 50.11-r2rc1

Q: How do I download DFHack?

Highlights

Search! Search! Search!

Preserve tomb assignments

Announcements

PSAs

Generated release notes

New Tools