Bug fixes

A bug in buildingplan which made some controls invisible has been fixed.

API changes and improvements

Some of our Lua and C++ APIs have been updated in this release; see the changelog for details. Notably, several MaterialInfo constants have been removed, which may impact third party plugins and scripts. Developers of third party plugins and scripts should be aware of these.

PSAs

As always, remember that, just like the vanilla DF game, DFHack tools can also have bugs. It is a good idea to save often and keep backups of the forts that you care about.

Some DFHack tools that worked in previous (pre-Steam) versions of DF have not been updated yet and are marked with the "unavailable" tag in their docs. If you try to run them, they will show a warning and exit immediately. You can run the command again to override the warning (though of course the tools may not work). We make no guarantees of reliability for the tools that are marked as "unavailable".

The in-game interface for running DFHack commands (gui/launcher) will not show "unavailable" tools by default. You can still run them if you know their names, or you can turn on dev mode by hitting Ctrl-D while in gui/launcher and they will be added to the autocomplete list. Some tools listed as "unavailable" in the docs do not compile yet and are not accessible at all, even when in dev mode.

If you see a tool complaining about the lack of a cursor, know that it's referring to the keyboard cursor (which used to be the only real option in Dwarf Fortress). You can enable the keyboard cursor by entering mining mode or selecting the dump/forbid tool and hitting Alt-K (the DFHack keybinding for toggle-kbd-cursor). We're working on making DFHack tools more mouse-aware and accessible so this step isn't necessary in the future.

Fixes

• buildingplan: restore planner UI elements: hollow constructions, only engraved slabs, only empty cages, weapon count

Misc Improvements

• EventManager: add safety check to potentially avoid a DFHack crash when DF's reports table is out of order

API

• DFSDL: added obtain_library_handle and obtain_image_library_handle so that a plugin can obtain DFHack's already-open handle to these libs instead of having to do it itself.
• Materials: MaterialInfo constants NUM_BUILTIN, GROUP_SIZE, CREATURE_BASE, FIGURE_BASE, PLANT_BASE, and END_BASE removed. New plugins should use appropriate members of the df::builtin_mats enum.
• Screen: new functions paintMapPortTile and readMapPortTile to write and read world and region map tiles.

Lua

• Added Screen::paintMapPortTile as dfhack.screen.paintMapPortTile
• Added Screen::readMapPortTile as dfhack.screen.readMapPortTile
• Deprecated gui.materials.CREATURE_BASE and gui.materials.PLANT_BASE - scripts should instead use df.builtin_mats.CREATURE_1 and df.builtin_mats.PLANT_1, respectively.

Structures

• changed codegen to use std::array for fixed-length arrays instead of C-style arrays