DFHack 52.02-r1
[h2]Highlights[/h2]
[h3]Compatibility with 52.01[/h3]
This is primarily a compatibility release with DF 52.02.
[h2]Announcements[/h2]
[h3]Notice about DFHack co-saves and "portable mode"[h3]
DF 52.01 added a toggle for "portable mode". If set to "on" DF saves games in the install folder the way it did in prior versions. If set to "off" DF saves games instead in a user profile folder, the location of which varies by operating system. DFHack 52.01-r1 did not correctly adjust for this change in save game location when portable mode is off; as a result, DFHack cosaves (which store per-world and per-fortress customizations) were not loaded or saved properly with DFHack 52.01-r1. This has been corrected in DFHack 52.02-r1. If you have lost a cosave file, you can copy it from the old save location to the new save location manually (while DF is not running). DFHack cosaves are named with filenames starting with "dfhack" in the same folder as the DF save itself.
If you experience issues with DFHack not loading cosaves in 51.02 or later, please feel free to open an issue report on GitHub or contact us on our Discord for assistance.
[h3]PSAs[/h3]
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
[h2]Fixes[/h2]
[h3]Compatibility with 52.01[/h3]
This is primarily a compatibility release with DF 52.02.
[h2]Announcements[/h2]
[h3]Notice about DFHack co-saves and "portable mode"[h3]
DF 52.01 added a toggle for "portable mode". If set to "on" DF saves games in the install folder the way it did in prior versions. If set to "off" DF saves games instead in a user profile folder, the location of which varies by operating system. DFHack 52.01-r1 did not correctly adjust for this change in save game location when portable mode is off; as a result, DFHack cosaves (which store per-world and per-fortress customizations) were not loaded or saved properly with DFHack 52.01-r1. This has been corrected in DFHack 52.02-r1. If you have lost a cosave file, you can copy it from the old save location to the new save location manually (while DF is not running). DFHack cosaves are named with filenames starting with "dfhack" in the same folder as the DF save itself.
If you experience issues with DFHack not loading cosaves in 51.02 or later, please feel free to open an issue report on GitHub or contact us on our Discord for assistance.
[h3]PSAs[/h3]
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
[h2]Fixes[/h2]
- Honor the "portable mode" preference setting for locating save folders. Fixes DFHack cosaves not working in most cases.
- ``embark-anyone``: Validate viewscreen before using, Avoids a crash.