Fix FPS death with timestream

timestream has a simple premise: when the FPS drops, speed up the world to compensate. It dynamically adjusts the calendar so that time flows at a rate that makes you feel like you're playing at a much higher FPS. It makes the game much more responsive and snappy, even when you have hundreds of units on the map.

With timestream active, you can keep the game running at full speed as long as the vanilla FPS counter stays above 15 FPS. At that point, you'll hit other limitations and you'll start noticing the slowdown.

Trade depot pathability visualization for wagons

Veteran players may remember a feature from Dwarf Fortress in its pre-Steam times: the ability to show where caravan wagons can path on their way to your trade depot. This feature was not brought forward to DF v50, so DFHack offers a replacement. If you are concerned about whether wagons can get to your depot, or if you'd like to identify the choke points, start up gui/pathable and select the "Depot" tab. That will highlight the tiles that wagons can traverse on their way to your trade depot (or any of your trade depots, if you have more than one).

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.

New Tools

• devel/luacov: (reinstated) add Lua script coverage reporting for use in testing and performance analysis
• fix/sleepers: (reinstated) fixes sleeping units belonging to a camp that never wake up.
• timestream: (reinstated) keep the game running quickly even when there are large numbers of units on the map

New Features

• Locale-senstive number formatting: select your preferred format in gui/control-panel. prices and other large numbers in DFHack UIs can be displayed with commas (English formatting), the number formatting used by your system locale, in SI units (e.g. 12.3k), or even in scientific notation
• gui/pathable: new "Depot" mode that shows whether wagons can path to your trade depot

Fixes

• clear-smoke: properly tag smoke flows for garbage collection to avoid memory leak
• overlay: overlay positions are now adjusted according to the configured max interface width percentage in the DF settings
• zone: animal assignment overlay button moved to not conflict with vanilla aquarium/terrarium button on glass cages

Misc Improvements

• empty-bin: select a stockpile, tile, or building to empty all containers in the stockpile, tile, or building
• exterminate:
  • add --limit option to limit number of exterminated creatures
  • add knockout and traumatize method for non-lethal incapacitation
• gui/unit-syndromes: make werecreature syndromes easier to search for
• orders: you can now delete your exported orders from the import dialog

Removed

• adv-fix-sleepers: renamed to fix/sleepers

Lua

• gui.get_interface_rect, gui.get_interface_frame: convenience functions for working with scaled interfaces
• overlay: new attributes: fullscreen and full_interface for overlays that need access to the entire screen or the scaled interface area, respectively
• string:wrap: now preserves inter-word spacing and can return the wrapped lines as a table of strings instead of a single multi-line string