=== Scroll down for changes

===[[[

The text below is included in docs/dev/Documentation.rst - see that file for more details on the changelog setup.

This is kept in this file as a quick syntax reference.

===help

changelog.txt uses a syntax similar to RST, with a few special sequences:

- ``===`` indicates the start of a comment

- ``#`` indicates the start of a release name (do not include "DFHack")

- ``##`` indicates the start of a section name (this must be listed in ``gen_changelog.py``)

- ``-`` indicates the start of a changelog entry. **Note:** an entry currently must be only one line.

- ``:`` (colon followed by space) separates the name of a feature from a description of a change to that feature.

Changes made to the same feature are grouped if they end up in the same section.

- ``:\`` (colon, backslash, space) avoids the above behavior

- ``- @`` (the space is optional) indicates the start of an entry that should only be displayed in NEWS-dev.rst.

Use this sparingly, e.g. for immediate fixes to one development build in another development build that

are not of interest to users of stable builds only.

- Three ``[`` characters indicate the start of a block (possibly a comment) that

spans multiple lines. Three ``]`` characters indicate the end of such a block.

- ``!`` immediately before a phrase set up to be replaced (see gen_changelog.py) stops that occurrence from being replaced.

Template for new versions:

## New Tools

## New Features

## Fixes

## Misc Improvements

## Documentation

## API

## Lua

## Removed

===end

]]]

================================================================================

======== IMPORTANT: rename this, and add a new "Future" section, BEFORE ========

======== making a new DFHack release, even if the only changes made ========

======== were in submodules with their own changelogs! ========

================================================================================

# Future

## New Tools

## New Features

## Fixes

## Misc Improvements

- `tailor`: corrected a corner case that resulted in existing stock being ignored in some circumstances

## Documentation

## API

## Lua

## Removed

# 50.11-r3

## New Tools

- `burrow`: (reinstated) automatically expand burrows as you dig

## New Features

- `prospect`: can now give you an estimate of resources from the embark screen. hover the mouse over a potential embark area and run `prospect`.

- `burrow`: integrated 3d box fill and 2d/3d flood fill extensions for burrow painting mode

- `buildingplan`: allow specific mechanisms to be selected when linking levers or pressure plates

- `sort`: military and burrow membership filters for the burrow assignment screen

## Fixes

- `stockpiles`: hide configure and help buttons when the overlay panel is minimized

- `caravan`: price of vermin swarms correctly adjusted down. a stack of 10000 bees is worth 10, not 10000

- `sort`: when filtering out already-established temples in the location assignment screen, also filter out the "No specific deity" option if a non-denominational temple has already been established

- RemoteServer: continue to accept connections as long as the listening socket is valid instead of closing the socket after the first disconnect

- `buildingplan`: overlay and filter editor gui now uses ctrl-d to delete the filter to avoid conflict with increasing the filter's minimum quality (shift-x)

- `tailor`: fix crash on Linux where scanned unit is wearing damaged non-clothing (e.g. a crown)

## Misc Improvements

- `buildingplan`: display how many items are available on the planner panel

- `buildingplan`: make it easier to build single-tile staircases of any shape (up, down, or up/down)

- `sort`: allow searching by profession on the squad assignment page

- `sort`: add search for places screens

- `sort`: add search for work animal assignment screen; allow filtering by miltary/squad/civilian/burrow

- `sort`: on the squad assignment screen, make effectiveness and potential ratings use the same scale so effectiveness is always less than or equal to potential for a given unit. this way you can also tell when units are approaching their maximum potential

- `sort`: new overlay on the animal assignment screen that shows how many work animals each visible unit already has assigned to them

- `dreamfort`: Inside+ and Clearcutting burrows now automatically created and managed

## Documentation

- Document the Lua API for the ``dfhack.world`` module

## API

- ``Gui::revealInDwarfmodeMap``: gained ``highlight`` parameter to control setting the tile highlight on the zoom target

- ``Maps::getWalkableGroup``: get the walkability group of a tile

- ``Units::getReadableName``: now returns the *untranslated* name

- ``Burrows::setAssignedUnit``: now properly handles inactive burrows

- ``Gui::getMousePos``: now takes an optional ``allow_out_of_bounds`` parameter so coordinates can be returned for mouse positions outside of the game map (i.e. in the blank space around the map)

- ``Buildings::completebuild``: used to link a newly created building into the world

## Lua

- ``dfhack.gui.revealInDwarfmodeMap``: gained ``highlight`` parameter to control setting the tile highlight on the zoom target

- ``dfhack.maps.getWalkableGroup``: get the walkability group of a tile

- ``dfhack.gui.getMousePos``: support new optional ``allow_out_of_bounds`` parameter

- ``gui.FRAME_THIN``: a panel frame suitable for floating tooltips

- ``dfhack.buildings.completebuild``: expose new module API

# 50.11-r2

## New Tools

- `spectate`: (reinstated) automatically follow dwarves, cycling among interesting ones

- `preserve-tombs`: keep tombs assigned to units when they die

## New Features

- `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", candidate assignment on the "Noble" subtab, and the "Work details" subtab under "Labor"

- `sort`: new search and filter widgets for the "Interrogate" and "Convict" screens under "Justice"

- `sort`: new search widgets for location selection screen (when you're choosing what kind of guildhall or temple to dedicate)

- `sort`: new search widgets for burrow assignment screen and other unit assignment dialogs

- `sort`: new search widgets for artifacts on the world/raid screen

- `sort`: new search widgets for slab engraving menu; can filter for only units that need a slab to prevent rising as a ghost

- `stocks`: hotkey for collapsing all categories on stocks screen

## Fixes

- `buildingplan`: remove bars of ash, coal, and soap as valid building materials to match v50 rules

- `buildingplan`: fix incorrect required items being displayed sometimes when switching the planner overlay on and off

- `zone`: races without specific child or baby names will now get generic child/baby names instead of an empty string

- `zone`: don't show animal assignment link for cages and restraints linked to dungeon zones (which aren't normally assignable)

- `sort`: don't count mercenaries as appointed officials in the squad assignment screen

- `dwarfvet`: fix invalid job id assigned to ``Rest`` job, which could cause crashes on reload

## Misc Improvements

- `overlay`: allow ``overlay_onupdate_max_freq_seconds`` to be dynamically set to 0 for a burst of high-frequency updates

- Help icons added to several complex overlays. clicking the icon runs `gui/launcher` with the help text in the help area

- `orders`: ``recheck`` command now only resets orders that have conditions that can be rechecked

- `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

- `buildingplan`: support filtering cages by whether they are occupied

- `buildingplan`: show how many items you need to make when planning buildings

- `tailor`: now adds to existing orders if possilbe instead of creating new ones

## Documentation

- unavailable tools are no longer listed in the tag indices in the online docs

## API

- added ``Items::getCapacity``, returns the capacity of an item as a container (reverse-engineered), needed for `combine`

## Lua

- added ``GRAY`` color aliases for ``GREY`` colors

- added ``dfhack.items.getCapacity`` to expose the new module API

- ``utils.search_text``: text search routine (generalized from internal ``widgets.FilteredList`` logic)

## 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`

# 50.11-r1

## New Tools

- `tubefill`: (reinstated) replenishes mined-out adamantine

## Fixes

- `autolabor`: ensure vanilla work details are reinstated when the fort or the plugin is unloaded

- ``dfhack.TranslateName()``: fixed crash on certain invalid names, which affected `warn-starving`

- EventManager: Unit death event no longer misfires on units leaving the map

## Misc Improvements

- `digtype`: designate only visible tiles by default, and use "auto" dig mode for following veins

- `digtype`: 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

- `hotkeys`: use vertical bars instead of "!" symbols for the DFHack logo in ascii mode to make it easier to read

- EventManager: guard against potential iterator invalidation if one of the event listeners were to modify the global data structure being iterated over

- EventManager: for ``onBuildingCreatedDestroyed`` events, changed firing order of events so destroyed events come before created events

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

# 50.10-r1

## Fixes

- Linux launcher: allow Steam Overlay and game streaming to function

- `autobutcher`: don't ignore semi-wild units when marking units for slaughter

## Misc Improvements

- 'sort': Improve combat skill scale thresholds

# 50.09-r4

## 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

- `seedwatch`: fix a crash when reading data saved by very very old versions of the plugin

- `gui/mod-manager`: don't continue to display overlay after the raws loading progress bar appears

## Misc Improvements

- `sort`: add sort option for training need on squad assignment screen

- `sort`: filter mothers with infants, units with weak mental fortitude, and critically injured units on the squad assignment screen

- `sort`: display a rating relative to the current sort order next to the visible units on the squad assignment screen

## Documentation

- add instructions for downloading development builds to the ``Installing`` page

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

# 50.09-r3

## New Features

- `sort`: search, sort, and filter for squad assignment screen

- `zone`: advanced unit assignment screens for cages, restraints, and pits/ponds

- `buildingplan`: one-click magma/fire safety filter for planned buildings

## Fixes

- Core: reload scripts in mods when a world is unloaded and immediately loaded again

- Core: fix text getting added to DFHack text entry widgets when Alt- or Ctrl- keys are hit

- `buildingplan`: ensure selected barrels and buckets are empty (or at least free of lye and milk) as per the requirements of the building

- `orders`: prevent import/export overlay from appearing on the create workorder screen

- `caravan`: corrected prices for cages that have units inside of them

- `tailor`: remove crash caused by clothing items with an invalid ``maker_race``

- ``dialogs.MessageBox``: fix spacing around scrollable text

- `seedwatch`: ignore unplantable tree seeds

- `autobutcher`: fix ``ticks`` commandline option incorrectly rejecting positive integers as valid values

## Misc Improvements

- Surround DFHack-specific UI elements with square brackets instead of red-yellow blocks for better readability

- `autobutcher`: don't mark animals for butchering if they are already marked for some kind of training (war, hunt)

- `hotkeys`: don't display DFHack logo in legends mode since it covers up important interface elements. the Ctrl-Shift-C hotkey to bring up the menu and the mouseover hotspot still function, though.

- `sort`: animals are now sortable by race on the assignment screens

- `createitem`: support creating items inside of bags

## API

- ``Items::getValue()``: remove ``caravan_buying`` parameter since the identity of the selling party doesn't actually affect the item value

- `RemoteFortressReader`: add a ``force_reload`` option to the GetBlockList RPC API to return blocks regardless of whether they have changed since the last request

- ``Units``: new animal propery check functions ``isMarkedForTraining(unit)``, ``isMarkedForTaming(unit)``, ``isMarkedForWarTraining(unit)``, and ``isMarkedForHuntTraining(unit)``

- ``Gui``: ``getAnyStockpile`` and ``getAnyCivzone`` (along with their ``getSelected`` variants) now work through layers of ZScreens. This means that they will still return valid results even if a DFHack tool window is in the foereground.

## Lua

- ``new()``: improved error handling so that certain errors that were previously uncatchable (creating objects with members with unknown vtables) are now catchable with ``pcall()``

- ``dfhack.items.getValue()``: remove ``caravan_buying`` param as per C++ API change

- ``widgets.BannerPanel``: panel with distinctive border for marking DFHack UI elements on otherwise vanilla screens

- ``widgets.Panel``: new functions to override instead of setting corresponding properties (useful when subclassing instead of just setting attributes): ``onDragBegin``, ``onDragEnd``, ``onResizeBegin``, ``onResizeEnd``

- ``dfhack.screen.readTile()``: now populates extended tile property fields (like ``top_of_text``) in the returned ``Pen`` object

- ``dfhack.units``: new animal propery check functions ``isMarkedForTraining(unit)``, ``isMarkedForTaming(unit)``, ``isMarkedForWarTraining(unit)``, and ``isMarkedForHuntTraining(unit)``

- ``dfhack.gui``: new ``getAnyCivZone`` and ``getAnyStockpile`` functions; also behavior of ``getSelectedCivZone`` and ``getSelectedStockpile`` functions has changes as per the related API notes

# 50.09-r2

## New Plugins

- `3dveins`: reinstated for v50, this plugin replaces vanilla DF's blobby vein generation with veins that flow smoothly and naturally between z-levels

- `zone`: new searchable, sortable, filterable screen for assigning units to pastures

- `dwarfvet`: reinstated and updated for v50's new hospital mechanics; allow your animals to have their wounds treated at hospitals

- `dig`: new ``dig.asciiwarmdamp`` overlay that highlights warm and damp tiles when in ASCII mode. there is no effect in graphics mode since the tiles are already highlighted there

## Fixes

- Fix extra keys appearing in DFHack text boxes when shift (or any other modifier) is released before the other key you were pressing

- `logistics`: don't autotrain domestic animals brought by invaders (they'll get attacked by friendly creatures as soon as you let them out of their cage)

- `logistics`: don't bring trade goods to depot if the only caravans present are tribute caravans

- `gui/create-item`: when choosing a citizen to create the chosen items, avoid choosing a dead citizen

- `logistics`: fix potential crash when removing stockpiles or turning off stockpile features

## Misc Improvements

- `stockpiles`: include exotic pets in the "tameable" filter

- `logistics`: bring an autotraded bin to the depot if any item inside is tradeable instead of marking all items within the bin as untradeable if any individual item is untradeable

- `autonick`: add more variety to nicknames based on famous literary dwarves

- ``widgets.EditField``: DFHack edit fields now support cut/copy/paste with the system clipboard with Ctrl-X/Ctrl-C/Ctrl-V

- Suppress DF keyboard events when a DFHack keybinding is matched. This prevents, for example, a backtick from appearing in a textbox as text when you launch `gui/launcher` from the backtick keybinding.

- Dreamfort: give noble suites double-thick walls and add apartment doors

## Documentation

- `misery`: rewrite the documentation to clarify the actual effects of the plugin

## API

- ``Units::getUnitByNobleRole``, ``Units::getUnitsByNobleRole``: unit lookup API by role

- ``Items::markForTrade()``, ``Items::isRequestedTradeGood()``, ``Items::getValue``: see Lua notes below

## Internals

- Price calculations fixed for many item types

## Lua

- ``dfhack.units.getUnitByNobleRole``, ``dfhack.units.getUnitsByNobleRole``: unit lookup API by role

- ``dfhack.items.markForTrade``: mark items for trade

- ``dfhack.items.isRequestedTradeGood``: discover whether an item is named in a trade agreement with an active caravan

- ``dfhack.items.getValue``: gained optional ``caravan`` and ``caravan_buying`` parameters for prices that take trader races and agreements into account

- ``widgets.TextButton``: wraps a ``HotkeyLabel`` and decorates it to look more like a button

# 50.09-r1

## Internals

- Core: update SDL interface from SDL1 to SDL2

# 50.08-r4

## New Plugins

- `logistics`: automatically mark and route items or animals that come to monitored stockpiles. options are toggleable on an overlay that comes up when you have a stockpile selected.

## Fixes

- `buildingplan`: don't include artifacts when max quality is masterful

- `dig-now`: clear item occupancy flags for channeled tiles that had items on them

- `RemoteFortressReader`: fix a crash with engravings with undefined images

## Misc Improvements

- `autonick`: additional nicknames based on burrowing animals, colours, gems, and minerals

- `stockpiles`: added ``barrels``, ``organic``, ``artifacts``, and ``masterworks`` stockpile presets

- `orders`: only display import/export/sort/clear panel on main orders screen

- `orders`: refine order conditions for library orders to reduce cancellation spam

- Blueprint library: dreamfort: full rewrite and update for DF v50

- Blueprint library: pump_stack: updated walkthrough and separated dig and channel steps so boulders can be cleared

- Blueprint library: aquifer_tap: updated walkthrough

- `dig-now`: can now handle digging obsidian that has been formed from magma and water

## Documentation

- `blueprint-library-guide`: update Dreamfort screenshots and links, add ``aquifer_tap`` screenshot

# 50.08-r3

## Fixes

- Fix crash for some players when they launch DF outside of the Steam client

# 50.08-r2

## New Plugins

- `add-spatter`: (reinstated) allow mods to add poisons and magical effects to weapons

- `changeitem`: (reinstated) change item material, quality, and subtype

- `createitem`: (reinstated) create arbitrary items from the command line

- `deramp`: (reinstated) removes all ramps designated for removal from the map

- `flows`: (reinstated) counts map blocks with flowing liquids

- `lair`: (reinstated) mark the map as a monster lair (this avoids item scatter when the fortress is abandoned)

- `luasocket`: (reinstated) provides a Lua API for accessing network sockets

- `work-now`: (reinstated, renamed from ``workNow``) prevent dwarves from wandering aimlessly with "No job" after completing a task

## Fixes

- DFHack screen backgrounds now use appropriate tiles in DF Classic

- RemoteServer: fix crash on malformed json in ``dfhack-config/remote-server.json``

- `autolabor`: work detail override warning now only appears on the work details screen

- `RemoteFortressReader`: ensured names are transmitted in UTF-8 instead of CP437

## Misc Improvements

- `autodump`: no longer checks for a keyboard cursor before executing, so ``autodump destroy`` (which doesn't require a cursor) can still function

- Settings: recover gracefully when settings files become corrupted (e.g. by DF CTD)

- `orders`: update orders in library for prepared meals, bins, archer uniforms, and weapons

- `gui/control-panel`: new preference for whether filters in lists search for substrings in the middle of words (e.g. if set to true, then "ee" will match "steel")

- `gui/design`: Improved performance for drawing shapes

- Dreamfort: improve traffic patterns throughout the fortress

- `gui/blueprint`: recording of stockpile layouts and categories is now supported. note that detailed stockpile configurations will *not* be saved (yet)

- Core: new commandline flag/environment var: pass ``--disable-dfhack`` on the Dwarf Fortress commandline or specify ``DFHACK_DISABLE=1`` in the environment to disable DFHack for the current session.

- `overlay`: add links to the quickstart guide and the control panel on the DF title screen

- Window behavior: non-resizable windows now allow dragging by their frame edges by default

- `gui/autodump`: fort-mode keybinding: Ctrl-H (when ``armok`` tools are enabled in `gui/control-panel`)

- Window behavior: if you have multiple DFHack tool windows open, scrolling the mouse wheel while over an unfocused window will focus it and raise it to the top

- `stockpiles`: allow filtering creatures by tameability

## Internals

- ``dfhack.internal``: added memory analysis functions: ``msizeAddress``, ``getHeapState``, ``heapTakeSnapshot``, ``isAddressInHeap``, ``isAddressActiveInHeap``, ``isAddressUsedAfterFreeInHeap``, ``getAddressSizeInHeap``, and ``getRootAddressOfHeapObject``

## Lua

- ``overlay.reload()``: has been renamed to ``overlay.rescan()`` so as not to conflict with the global ``reload()`` function. If you are developing an overlay, please take note of the new function name for reloading your overlay during development.

- ``gui``: changed frame naming scheme to ``FRAME_X`` rather than ``X_FRAME``, and added aliases for backwards compatibility. (for example ``BOLD_FRAME`` is now called ``FRAME_BOLD``)

- ``ensure_keys``: walks a series of keys, creating new tables for any missing values

## Removed

- `orders`: ``library/military_include_artifact_materials`` library file removed since recent research indicates that platinum blunt weapons and silver crossbows are not more effective than standard steel. the alternate military orders file was also causing unneeded confusion.

# 50.08-r1

## Fixes

- `autoclothing`: eliminate game lag when there are many inventory items in the fort

- `buildingplan`: fixed size limit calculations for rollers

- `buildingplan`: fixed items not being checked for accessibility in the filter and item selection dialogs

- `dig-now`: properly detect and complete smoothing designations that have been converted into active jobs

## Misc Improvements

- `buildingplan`: planner panel is minimized by default and now remembers minimized state

- `buildingplan`: can now filter by gems (for gem windows) and yarn (for ropes in wells)

- ``toggle-kbd-cursor``: add hotkey for toggling the keyboard cursor (Alt-K)

- ``version``: add alias to display the DFHack help (including the version number) so something happens when players try to run "version"

- `gui/control-panel`: add preference option for hiding the terminal console on startup

- `gui/control-panel`: add preference option for hiding "armok" tools in command lists

- ``Dwarf Therapist``: add a warning to the Labors screen when Dwarf Therapist is active so players know that changes they make to that screen will have no effect. If you're starting a new embark and nobody seems to be doing anything, check your Labors tab for this warning to see if Dwarf Therapist thinks it is in control (even if it's not running).

- `overlay`: add the DFHack version string to the DF title screen

## Lua

- ``widgets.RangeSlider``: new mouse-controlled two-headed slider widget

- ``gui.ZScreenModal``: ZScreen subclass for modal dialogs

- ``widgets.CycleHotkeyLabel``: exposed "key_sep" and "option_gap" attributes for improved stylistic control.

## Removed

- `title-version`: replaced by an `overlay` widget

# 50.07-r1

## New Plugins

- `faststart`: speeds up the "Loading..." screen so the Main Menu appears faster

## Fixes

-@ `hotkeys`: hotkey hints on menu popup will no longer get their last character cut off by the scrollbar

-@ ``launchdf``: launch Dwarf Fortress via the Steam client so Steam Workshop is functional

- `blueprint`: interpret saplings, shrubs, and twigs as floors instead of walls

- `combine`: fix error processing stockpiles with boundaries that extend outside of the map

-@ `prospector`: display both "raw" Z levels and "cooked" elevations

- `stockpiles`: fix crash when importing settings for gems from other worlds

-@ `stockpiles`: allow numbers in saved stockpile filenames

## Misc Improvements

-@ `buildingplan`: items in the item selection dialog should now use the same item quality symbols as the base game

-@ `buildingplan`: hide planner overlay while the DF tutorial is active so that it can detect when you have placed the carpenter's workshop and bed and allow you to finish the tutorial

- `buildingplan`: can now filter by cloth and silk materials (for ropes)

-@ `buildingplan`: rearranged elements of ``planneroverlay`` interface

-@ `buildingplan`: rearranged elements of ``itemselection`` interface

-@ Mods: scripts in mods that are only in the steam workshop directory are now accessible. this means that a script-only mod that you never mark as "active" when generating a world will still receive automatic updates and be usable from in-game

-@ Mods: scripts from only the most recent version of an installed mod are added to the script path

-@ Mods: give active mods a chance to reattach their load hooks when a world is reloaded

- `gui/control-panel`: bugfix services are now enabled by default

- Core: hide DFHack terminal console by default when running on Steam Deck

## Documentation

- `installing`: updated to include Steam installation instructions

## Lua

- added two new window borders: ``gui.BOLD_FRAME`` for accented elements and ``gui.INTERIOR_MEDIUM_FRAME`` for a signature-less frame that's thicker than the existing ``gui.INTERIOR_FRAME``

# 50.07-beta2

## New Plugins

- `getplants`: reinstated: designate trees for chopping and shrubs for gathering according to type

- `prospector`: reinstated: get stone, ore, gem, and other tile property counts in fort mode.

## Fixes

-@ `buildingplan`: filters are now properly applied to planned stairs

-@ `buildingplan`: existing carved up/down stairs are now taken into account when determining which stair shape to construct

- `buildingplan`: upright spike traps are now placed extended rather than retracted

- `buildingplan`: you can no longer designate constructions on tiles with magma or deep water, mirroring the vanilla restrictions

-@ `buildingplan`: fixed material filters getting lost for planning buildings on save/reload

-@ `buildingplan`: respect building size limits (e.g. roads and bridges cannot be more than 31 tiles in any dimension)

- `tailor`: properly discriminate between dyed and undyed cloth

-@ `tailor`: no longer default to using adamantine cloth for producing clothes

- `tailor`: take queued orders into account when calculating available materials

- `tailor`: skip units who can't wear clothes

- `tailor`: identify more available items as available, solving issues with over-production

## Misc Improvements

- `buildingplan`: filters and global settings are now ignored when manually choosing items for a building, allowing you to make custom choices independently of the filters that would otherwise be used

- `buildingplan`: if `suspendmanager` is running, then planned buildings will be left suspended when their items are all attached. `suspendmanager` will unsuspsend them for construction when it is safe to do so.

- `buildingplan`: add option for autoselecting the last manually chosen item (like `automaterial` used to do)

- `confirm`: adds confirmation for removing burrows via the repaint menu

- `stockpiles`: support applying stockpile configurations with fully enabled categories to stockpiles in worlds other than the one where the configuration was exported from

- `stockpiles`: support partial application of a saved config based on dynamic filtering (e.g. disable all tallow in a food stockpile, even tallow from world-specific generated creatures)

- `stockpiles`: additive and subtractive modes when applying a second stockpile configuration on top of a first

- `stockpiles`: write player-exported stockpile configurations to the ``dfhack-config/stockpiles`` folder. If you have any stockpile configs in other directories, please move them to that folder.

- `stockpiles`: now includes a library of useful stockpile configs (see docs for details)

- `automelt`: now allows metal chests to be melted (workaround for DF bug 2493 is no longer needed)

- `orders`: add minimize button to overlay panel so you can get it out of the way to read long statue descriptions when choosing a subject in the details screen

- `orders`: add option to delete exported files from the import dialog

- `enable`: can now interpret aliases defined with the `alias` command

- Mods: scripts in mods are now automatically added to the DFHack script path. DFHack recognizes two directories in a mod's folder: ``scripts_modinstalled/`` and ``scripts_modactive/``. ``scripts_modinstalled/`` folders will always be added the script path, regardless of whether the mod is active in a world. ``scripts_modactive/`` folders will only be added to the script path when the mod is active in the current loaded world.

## Documentation

- `modding-guide`: guide updated to include information for 3rd party script developers

- the ``untested`` tag has been renamed to ``unavailable`` to better reflect the status of the remaining unavaialable tools. most of the simply "untested" tools have now been tested and marked as working. the remaining tools are known to need development work before they are available again.

## Lua

- ``widgets.Label``: tokens can now specify a ``htile`` property to indicate the tile that should be shown when the Label is hovered over with the mouse

- ``widgets.Label``: click handlers no longer get the label itself as the first param to the click handler

- ``widgets.CycleHotkeyLabel``: options that are bare integers will no longer be interpreted as the pen color in addition to being the label and value

- ``widgets.CycleHotkeyLabel``: option labels and pens can now be functions that return a label or pen

# 50.07-beta1

## Fixes

-@ `buildingplan`: items are now attached correctly to screw pumps and other multi-item buildings

-@ `buildingplan`: buildings with different material filters will no longer get "stuck" if one of the filters currently matches no items

- `showmood` properly count required number of bars and cloth when they aren't the main item for the strange mood

## Misc Improvements

-@ `buildingplan`: can now filter by clay materials

-@ `buildingplan`: remember choice per building type for whether the player wants to choose specific items

-@ `buildingplan`: you can now attach multiple weapons to spike traps

-@ `buildingplan`: can now filter by whether a slab is engraved

-@ `buildingplan`: add "minimize" button to temporarily get the planner overlay out of the way if you would rather use the vanilla UI for placing the current building

-@ `buildingplan`: add ``buildingplan reset`` command for resetting all filters to defaults

-@ `buildingplan`: rename "Build" button to "Confirm" on the item selection dialog and change the hotkey from "B" to "C"

- `blueprint`: now writes blueprints to the ``dfhack-config/blueprints`` directory

- `blueprint-library-guide`: library blueprints have moved from ``blueprints`` to ``hack/data/blueprints``

- `blueprint-library-guide`: player-created blueprints should now go in the ``dfhack-config/blueprints`` folder. please move your existing blueprints from ``blueprints`` to ``dfhack-config/blueprints``. you don't need to move the library blueprints -- those can be safely deleted from the old ``blueprints`` directory.

-@ `showmood`: clarify how many bars and/or cloth items are actually needed for the mood

## Removed

-@ `buildingplan`: "heat safety" setting is temporarily removed while we investigate incorrect item matching

# 50.07-alpha3

## Fixes

-@ ``widgets.HotkeyLabel``: don't trigger on click if the widget is disabled

- ``dfhack.job.isSuitableMaterial``: now properly detects lack of fire and magma safety for vulnerable materials with high melting points

- `dig-now`: fixed multi-layer channel designations only channeling every second layer

## Misc Improvements

- `dig-now`: added handling of dig designations that have been converted into active jobs

- `buildingplan`: entirely new UI for building placement, item selection, and materials filtering!

## API

- Gui focus strings will no longer get the "dfhack/" prefix if the string "dfhack/" already exists in the focus string

- ``Military``: New module for military functionality

- ``Military``: new ``makeSquad`` to create a squad

- ``Military``: changed ``getSquadName`` to take a squad identifier

- ``Military``: new ``updateRoomAssignments`` for assigning a squad to a barracks and archery range

- ``Maps::GetBiomeType`` renamed to ``Maps::getBiomeType`` for consistency

- ``Maps::GetBiomeTypeRef`` renamed to ``Maps::getBiomeTypeRef`` for consistency

## Lua

- ``dfhack.job.attachJobItem()``: allows you to attach specific items to a job

- ``dfhack.screen.paintTile()``: you can now explicitly clear the interface cursor from a map tile by passing ``0`` as the tile value

- ``widgets.Label``: token ``tile`` properties can now be functions that return a value

- ``widgets.CycleHotkeyLabel``: add ``label_below`` attribute for compact 2-line output

-@ ``widgets.FilteredList``: search key matching is now case insensitive by default

-@ ``gui.INTERIOR_FRAME``: a panel frame style for use in highlighting off interior areas of a UI

- ``maps.getBiomeType``: exposed preexisting function to Lua

## Removed

-@ ``gui.THIN_FRAME``: replaced by ``gui.INTERIOR_FRAME``

- `automaterial`: all functionality has been merged into `buildingplan`

# 50.07-alpha2

## Fixes

-@ `nestboxes`: fixed bug causing nestboxes themselves to be forbidden, which prevented citizens from using them to lay eggs. Now only eggs are forbidden.

-@ `autobutcher`: implemented work-around for Dwarf Fortress not setting nicknames properly, so that nicknames created in the in-game interface are detected & protect animals from being butchered properly. Note that nicknames for unnamed units are not currently saved by dwarf fortress - use ``enable fix/protect-nicks`` to fix any nicknames created/removed within dwarf fortress so they can be saved/reloaded when you reload the game.

-@ `seedwatch`: fix saving and loading of seed stock targets

- `autodump`: changed behaviour to only change ``dump`` and ``forbid`` flags if an item is successfully dumped.

-@ `autochop`: generate default names for burrows with no assigned names

- ``Buildings::StockpileIterator``: fix check for stockpile items on block boundary.

- `tailor`: block making clothing sized for toads; make replacement clothing orders use the size of the wearer, not the size of the garment

-@ `confirm`: fix fps drop when enabled

-@ `channel-safely`: fix an out of bounds error regarding the REPORT event listener receiving (presumably) stale id's

## Misc Improvements

- `autobutcher`: logs activity to the console terminal instead of making disruptive in-game announcements

- DFHack tool windows that capture mouse clicks (and therefore prevent you from clicking on the "pause" button) now unconditionally pause the game when they open (but you can still unpause with the keyboard if you want to). Examples of this behavior: `gui/quickfort`, `gui/blueprint`, `gui/liquids`

- `showmood`: now shows the number of items needed for cloth and bars in addition to the technically correct but always confusing "total dimension" (150 per bar or 10,000 per cloth)

-@ Stopped mouse clicks from affecting the map when a click on a DFHack screen dismisses the window

- `confirm`: configuration data is now persisted globally.

- `tailor`: add support for adamantine cloth (off by default); improve logging

## API

- ``Gui::any_civzone_hotkey``, ``Gui::getAnyCivZone``, ``Gui::getSelectedCivZone``: new functions to operate on the new zone system

- Units module: added new predicates for ``isGeldable()``, ``isMarkedForGelding()``, and ``isPet()``

## Lua

- ``dfhack.gui.getSelectedCivZone``: returns the Zone that the user has selected currently

- ``widgets.FilteredList``: Added ``edit_on_change`` optional parameter to allow a custom callback on filter edit change.

- ``widgets.TabBar``: new library widget (migrated from control-panel.lua)

# 50.07-alpha1

## Fixes

- ``Units::isFortControlled``: Account for agitated wildlife

-@ Fix right click sometimes closing both a DFHack window and a vanilla panel

-@ Fixed issue with scrollable lists having some data off-screen if they were scrolled before being made visible

-@ `channel-safely`: fixed bug resulting in marker mode never being set for any designation

-@ `automelt`: fixed bug related to lua stack smashing behavior in returned stockpile configs

-@ `autochop`: fixed bug related to lua stack smashing behavior in returned stockpile configs

-@ `nestboxes`: now cancels any in-progress hauling jobs when it protects a fertile egg

-@ Fix persisted data not being written on manual save

-@ `nestboxes`: now scans for eggs more frequently and cancels any in-progress hauling jobs when it protects a fertile egg

## Misc Improvements

-@ `automelt`: is now more resistent to vanilla savegame corruption

-@ `hotkeys`: DFHack logo is now hidden on screens where it covers important information when in the default position (e.g. when choosing an embark site)

- `misery`: now persists state with the fort

-@ `autodump`: reinstate ``autodump-destroy-item``, hotkey: Ctrl-K

- `autodump`: new hotkey for ``autodump-destroy-here``: Ctrl-H

-@ `dig`: new hotkeys for vein designation on z-level (Ctrl-V) and vein designation across z-levels (Ctrl-Shift-V)

-@ `clean`: new hotkey for `spotclean`: Ctrl-C

- `autobutcher`: changed defaults from 5 females / 1 male to 4 females / 2 males so a single unfortunate accident doesn't leave players without a mating pair

- `autobutcher`: now immediately loads races available at game start into the watchlist

-@ replaced DFHack logo used for the hover hotspot with a crisper image

-@ `orders`: recipe for silver crossbows removed from ``library/military`` as it is not a vanilla recipe, but is available in ``library/military_include_artifact_materials``

- `stonesense`: added an ``INVERT_MOUSE_Z`` option to invert the mouse wheel direction

## Documentation

## API

## Lua

- `overlay`: overlay widgets can now specify focus paths for the viewscreens they attach to so they only appear in specific contexts. see `overlay-dev-guide` for details.

- ``widgets.CycleHotkeyLabel``: Added ``key_back`` optional parameter to cycle backwards.

- ``widgets.HotkeyLabel``: Added ``setLabel`` method to allow easily updating the label text without mangling the keyboard shortcut.

- ``widgets.HotkeyLabel``: Added ``setOnActivate`` method to allow easily updating the ``on_activate`` callback.

- ``widgets.FilteredList``: Added ``case_sensitive`` optional paramter to determine if filtering is case sensitive.

# 50.05-alpha3.1

## Fixes

-@ `seedwatch`: fix parameter parsing when setting targets

# 50.05-alpha3

## New Plugins

- `autoslab`: automatically create work orders to engrave slabs for ghostly dwarves

## Fixes

-@ DF screens can no longer get "stuck" on transitions when DFHack tool windows are visible. Instead, those DF screens are force-paused while DFHack windows are visible so the player can close them first and not corrupt the screen sequence. The "PAUSE FORCED" indicator will appear on these DFHack windows to indicate what is happening.

-@ allow launcher tools to launch themselves without hanging the game

-@ fix issues with clicks "passing through" some DFHack window elements to the screen below

- `getplants`: trees are now designated correctly

- `autoclothing`: fixed a crash that can happen when units are holding invalid items.

-@ `orders`: fix orders in library/basic that create bags

- `orders`: library/military now sticks to vanilla rules and does not add orders for normally-mood-only platinum weapons. A new library orders file ``library/military_include_artifact_materials`` is now offered as an alternate ``library/military`` set of orders that still includes the platinum weapons.

- `autochop`: fixed a crash when processing trees with corrupt data structures (e.g. when a trunk tile fails to fall when the rest of the tree is chopped down)

## Misc Improvements

-@ DFHack windows can now be "defocused" by clicking somewhere not over the tool window. This has the same effect as pinning previously did, but without the extra clicking.

- `getplants`: ID values will now be accepted regardless of case

-@ Windows now display "PAUSE FORCED" on the lower border if the tool is forcing the game to pause

-@ New borders for DFHack tool windows -- tell us what you think!

-@ `autoclothing`: merged the two separate reports into the same command.

- `automelt`: stockpile configuration can now be set from the commandline

- `channel-safely`: new monitoring for cave-in prevention

-@ `gui/control-panel`: you can now configure whether DFHack tool windows should pause the game by default

- `gui/control-panel`: new global hotkey for quick access: Ctrl-Shift-E

-@ `hotkeys`: clicking on the DFHack logo no longer closes the popup menu

- `nestboxes`: now saves enabled state in your savegame

- `gui/launcher`: sped up initialization time for faster window appearance

- `orders`: orders plugin functionality is now accessible via an `overlay` widget when the manager orders screen is open

- `gui/quickcmd`: now has its own global keybinding for your convenience: Ctrl-Shift-A

- `seedwatch`: now persists enabled state in the savegame, automatically loads useful defaults, and respects reachability when counting available seeds

-@ `quickfort`: planned buildings are now properly attached to any pertinent overlapping zones

## Documentation

- `compile`: instructions added for cross-compiling DFHack for Windows from a Linux Docker builder

-@ Quickstart guide has been updated with info on new window behavior and how to use the control panel

## API

- ``Buildings::containsTile()``: no longer takes a ``room`` parameter since that's not how rooms work anymore. If the building has extents, the extents will be checked. otherwise, the result just depends on whether the tile is within the building's bounding box.

- ``Units::getCitizens()``: gets a list of citizens, which otherwise you'd have to iterate over all units the world to discover

- ``Screen::Pen``: now accepts ``top_of_text`` and ``bottom_of_text`` properties to support offset text in graphics mode

- `overlay`: overlay widgets can now specify a default enabled state if they are not already set in the player's overlay config file

- ``Lua::Push``: now supports ``std::unordered_map``

## Lua

- `helpdb`: new function: ``helpdb.refresh()`` to force a refresh of the database. Call if you are a developer adding new scripts, loading new plugins, or changing help text during play

- `helpdb`: changed from auto-refreshing every 60 seconds to only refreshing on explicit call to ``helpdb.refresh()``. docs very rarely change during a play session, and the automatic database refreshes were slowing down the startup of `gui/launcher` and anything else that displays help text.

- ``widgets.Label``: ``label.scroll()`` now understands ``home`` and ``end`` keywords for scrolling to the top or bottom

- ``widgets.List``: new callbacks for double click and shift double click

- ``dfhack.units.getCitizens()``: gets a list of citizens

-@ ``gui.ZScreen``: new attribute: ``defocusable`` for controlling whether a window loses keyboard focus when the map is clicked

- ``widgets.Label``: token ``tile`` properties can now be either pens or numeric texture ids

- `tiletypes`: now has a Lua API! ``tiletypes_setTile``

## Removed

- `autohauler`: no plans to port to v50, as it just doesn't make sense with the new work detail system

# 50.05-alpha2

## Fixes

-@ `autofarm`: don't duplicate status line entries for crops with no current supply

-@ `orders`: allow the orders library to be listed and imported properly (if you previously copied the orders library into your ``dfhack-config/orders`` directory to work around this bug, you can remove those files now)

- `tailor`: now respects the setting of the "used dyed clothing" standing order toggle

# 50.05-alpha1

## Fixes

- ``widgets.WrappedLabel``: no longer resets scroll position when window is moved or resized

## Misc Improvements

- Scrollable widgets now react to mouse wheel events when the mouse is over the widget

- the ``dfhack-config/scripts/`` folder is now searched for scripts by default

- `hotkeys`: overlay hotspot widget now shows the DFHack logo in graphics mode and "DFHack" in text mode

- `script-paths`: removed "raw" directories from default script paths. now the default locations to search for scripts are ``dfhack-config/scripts``, ``save/*/scripts``, and ``hack/scripts``

- ``init.d``: directories have moved from the ``raw`` subfolder (which no longer exists) to the root of the main DF folder or a savegame folder

## Documentation

- `overlay-dev-guide`: added troubleshooting tips and common development workflows

- added DFHack architecture diagrams to the dev intro

- added DFHack Quickstart guide

## API

- ``Gui::getDwarfmodeDims``: now only returns map viewport dimensions; menu dimensions are obsolete

- ``Gui::getDFViewscreen``: returns the topmost underlying DF viewscreen

- ``Screen::Pen``: now accepts ``keep_lower`` and ``write_to_lower`` properties to support foreground and background textures in graphics mode

## Lua

- Removed ``os.execute()`` and ``io.popen()`` built-in functions

- ``gui.View``: ``visible`` and ``active`` can now be functions that return a boolean

- ``widgets.Panel``: new attributes to control window dragging and resizing with mouse or keyboard

- ``widgets.Window``: Panel subclass with attributes preset for top-level windows

- ``widgets.CycleHotkeyLabel``: now supports rendering option labels in the color of your choice

- ``widgets.CycleHotkeyLabel``: new functions ``setOption()`` and ``getOptionPen()``

- ``widgets.ToggleHotkeyLabel``: now renders the ``On`` option in green text

- ``widgets.Label``: tiles can now have an associated width

- `overlay`: ``OverlayWidget`` now inherits from ``Panel`` instead of ``Widget`` to get all the frame and mouse integration goodies

- ``dfhack.gui.getDFViewscreen()``: returns the topmost underlying DF viewscreen

- ``gui.ZScreen``: Screen subclass that implements window raising, multi-viewscreen input handling, and viewscreen event pass-through so the underlying map can be interacted with and dragged around while DFHack screens are visible

- ``gui.View``: new function ``view:getMouseFramePos()`` for detecting whether the mouse is within (or over) the exterior frame of a view

- ``gui.CLEAR_PEN``: now clears the background and foreground and writes to the background (before it would always write to the foreground)

- ``gui.KEEP_LOWER_PEN``: a general use pen that writes associated tiles to the foreground while keeping the existing background

## Removed

- ``fix-job-postings`` from the `workflow` plugin is now obsolete since affected savegames can no longer be loaded

- Ruby is no longer a supported DFHack scripting language

# 0.47.05-r8

## New Plugins

- `overlay`: plugin is transformed from a single line of text that runs `gui/launcher` on click to a fully-featured overlay injection framework. It now houses a popup menu for keybindings relevant to the current DF screen, all the widgets previously provided by `dwarfmonitor` (e.g. the current date and number of happy/unhappy dwarves), the overlay that highlights suspended buildings when you pause, and others. See `overlay-dev-guide` for details.

- `channel-safely`: auto-manage channel designations to keep dwarves safe

## Fixes

- `automaterial`: fix the cursor jumping up a z level when clicking quickly after box select

- `buildingplan`: fix crash when canceling out of placement mode for a building with planning mode enabled and subsequently attempting to place a building that does not have planning mode enabled and that has no pertinent materials available

- `gui/create-item`: prevent materials list filter from intercepting sublist hotkeys

- `mousequery`: fix the cursor jumping up z levels sometimes when using TWBT

- `tiletypes`: no longer resets dig priority to the default when updating other properties of a tile

- `automaterial`: fix rendering errors with box boundary markers

- `autolabor`, `autohauler`: properly handle jobs 241, 242, and 243

- `autofarm`: flush output so status text is visible immediately after running the command

- `hotkeys`: correctly detect hotkeys bound to number keys, F11, and F12

- `labormanager`: associate quern construction with the correct labor

- ``EventManager``: fix a segmentation fault with the ``REPORT`` event

- ``EventManager``: fix the ``JOB_STARTED`` event only sending events to the first handler listed instead of all registered handlers

- Core: ensure ``foo.init`` always runs before ``foo.*.init`` (e.g. ``dfhack.init`` should always run before ``dfhack.something.init``)

## Misc Improvements

- `autolabor`, `autohauler`: refactored to use DFHack's messaging system for info/debug/trace messages

- `blueprint`: new ``--smooth`` option for recording all smoothed floors and walls instead of just the ones that require smoothing for later carving

- `blueprint`: record built constructions in blueprints

- `blueprint`: record stockpile/building/zone names in blueprints

- `blueprint`: record room sizes in blueprints

- `blueprint`: generate meta blueprints to reduce the number of blueprints you have to apply

- `blueprint`: support splitting the output file into phases grouped by when they can be applied

- `blueprint`: when splitting output files, number them so they sort into the order you should apply them in

- `dwarfmonitor`: widgets have been ported to the overlay framework and can be enabled and configured via the `gui/overlay` UI

- `ls`: indent tag listings and wrap them in the rightmost column for better readability

- `ls`: new ``--exclude`` option for hiding matched scripts from the output. this can be especially useful for modders who don't want their mod scripts to be included in ``ls`` output.

- `hotkeys`: hotkey screen has been transformed into an interactive `overlay` widget that you can bring up by moving the mouse cursor over the hotspot (in the upper left corner of the screen by default). Enable/disable/reposition the hotspot in the `gui/overlay` UI. Even if the hotspot is disabled, the menu can be brought up at any time with the Ctrl-Shift-C hotkey.

- `hotkeys`: now supports printing active hotkeys to the console with ``hotkeys list``

- `digtype`: new ``-z`` option for digtype to restrict designations to the current z-level and down

- UX: List widgets now have mouse-interactive scrollbars

- UX: You can now hold down the mouse button on a scrollbar to make it scroll multiple times.

- UX: You can now drag the scrollbar up and down to scroll to a specific spot

- `orders`: replace shell craft orders in the standard orders list you get with ``orders import library/basic`` with orders for shell leggings. They have a slightly higher trade price. Also, "shleggings" is just hilarious.

- `spectate`: new ``auto-unpause`` option for auto-dismissal of announcement pause events (e.g. sieges).

- `spectate`: new ``auto-disengage`` option for auto-disengagement of plugin through player interaction whilst unpaused.

- `spectate`: new ``tick-threshold`` option for specifying the maximum time to follow the same dwarf

- `spectate`: new ``animals`` option for sometimes following animals

- `spectate`: new ``hostiles`` option for sometimes following hostiles

- `spectate`: new ``visiting`` option for sometimes following visiting merchants, diplomats or plain visitors

- `spectate`: added persistent configuration of the plugin settings

- `gui/cp437-table`: new global keybinding for the clickable on-screen keyboard for players with keyboard layouts that prevent them from using certain keys: Ctrl-Shift-K

- `quickfort-library-guide`: improved layout of marksdwarf barracks in the example Dreamfort blueprints

## Documentation

- `overlay-dev-guide`: documentation and guide for injecting functionality into DF viewscreens from Lua scripts and creating interactive overlay widgets

- ``dfhack.gui.revealInDwarfmodeMap``: document ``center`` bool for Lua API

## API

- ``Gui::anywhere_hotkey``: for plugin commands bound to keybindings that can be invoked on any screen

- ``Gui::autoDFAnnouncement``, ``Gui::pauseRecenter``: added functionality reverse-engineered from announcement code

- ``Gui::revealInDwarfmodeMap``: Now enforce valid view bounds when pos invalid, add variant accepting x, y, z

- ``Lua::PushInterfaceKeys()``: transforms viewscreen ``feed()`` keys into something that can be interpreted by lua-based widgets

- ``Lua::Push()``: now handles maps with otherwise supported keys and values

- Units module: added new predicates for:

- ``isUnitInBox()``

- ``isAnimal()``

- ``isVisiting()`` any visiting unit (diplomat, merchant, visitor)

- ``isVisitor()`` ie. not merchants or diplomats

- ``isInvader()``

- ``isDemon()`` returns true for unique/regular demons

- ``isTitan()``

- ``isMegabeast()``

- ``isGreatDanger()`` returns true if unit is a demon, titan, or megabeast

- ``isSemiMegabeast()``

- ``isNightCreature()``

- ``isDanger()`` returns true if is a 'GreatDanger', semi-megabeast, night creature, undead, or invader

- Units module: modified predicates:

- ``isUndead()`` now optionally ignores vampires instead of always ignoring vampires

- ``isCitizen()`` now optionally ignores insane citizens instead of always ignoring insane citizens

- Units module: new action timer API for speeding up of slowing down units

- Constructions module: added ``insert()`` to insert constructions into the game's sorted list.

- MiscUtils: added the following string transformation functions (refactored from ``uicommon.h``): ``int_to_string``, ``ltrim``, ``rtrim``, and ``trim``; added ``string_to_int``

## Lua

- ``widgets.Scrollbar``: new scrollbar widget that can be paired with an associated scrollable widget. Integrated with ``widgets.Label`` and ``widgets.List``.

- ``widgets.List``: new ``getIdxUnderMouse()`` function for detecting the list index under the active mouse cursor. this allows for "selection follows mouse" behavior

- ``widgets.List``: shift-clicking now triggers the ``submit2`` attribute function if it is defined

- ``dfhack.constructions.findAtTile()``: exposed preexisting function to Lua.

- ``dfhack.constructions.insert()``: exposed new function to Lua.

- ``widgets.Panel``: new ``frame_style`` and ``frame_title`` attributes for drawing frames around groups of widgets

- ``widgets.EditField``: now allows other widgets to process characters that the ``on_char`` callback rejects.

- ``widgets.FilteredList``: now provides a useful default search key for list items made up of text tokens instead of plain text

- ``widgets.ResizingPanel``: now accounts for frame inset when calculating frame size

- ``widgets.HotkeyLabel``: now ignores mouse clicks when ``on_activate`` is not defined

- ``gui.Screen.show()``: now returns ``self`` as a convenience

- ``gui.View.getMousePos()`` now takes an optional ``ViewRect`` parameter in case the caller wants to get the mouse pos relative to a rect that is not the frame_body (such as the frame_rect that includes the frame itself)

- Lua mouse events now conform to documented behavior in `lua-api` -- ``_MOUSE_L_DOWN`` will be sent exactly once per mouse click and ``_MOUSE_L`` will be sent repeatedly as long as the button is held down. Similarly for right mouse button events.

## Internals

- Constructions module: ``findAtTile`` now uses a binary search intead of a linear search

- MSVC warning level upped to /W3, and /WX added to make warnings cause compilations to fail.

## Removed

- `resume`: functionality (including suspended building overlay) has moved to `unsuspend`

# 0.47.05-r7

## New Plugins

- `autonestbox`: split off from `zone` into its own plugin. Note that to enable, the command has changed from ``autonestbox start`` to ``enable autonestbox``.

- `autobutcher`: split off from `zone` into its own plugin. Note that to enable, the command has changed from ``autobutcher start`` to ``enable autobutcher``.

- `overlay`: display a "DFHack" button in the lower left corner that you can click to start the new GUI command launcher. The `dwarfmonitor` weather display had to be moved to make room for the button. If you are seeing the weather indicator rendered over the overlay button, please remove the ``dfhack-config/dwarfmonitor.json`` file to fix the weather indicator display offset.

## New Internal Commands

- `tags`: new built-in command to list the tool category tags and their definitions. tags associated with each tool are visible in the tool help and in the output of `ls`.

## Fixes

- `autochop`: designate largest trees for chopping first, instead of the smallest

- ``dfhack.run_script``: ensure the arguments passed to scripts are always strings. This allows other scripts to call ``run_script`` with numeric args and it won't break parameter parsing.

- `dig-now`: Fix direction of smoothed walls when adjacent to a door or floodgate

- ``job.removeJob()``: ensure jobs are removed from the world list when they are canceled

- `quickfort`: `Dreamfort <quickfort-blueprint-guide>` blueprint set: declare the hospital zone before building the coffer; otherwise DF fails to stock the hospital with materials

- ``dfhack.buildings.findCivzonesAt``: no longer return duplicate civzones after loading a save with existing civzones

## Misc Improvements

- Init scripts: ``dfhack.init`` and other init scripts have moved to ``dfhack-config/init/``. If you have customized your ``dfhack.init`` file and want to keep your changes, please move the part that you have customized to the new location at ``dfhack-config/init/dfhack.init``. If you do not have changes that you want to keep, do not copy anything, and the new defaults will be used automatically.

- History files: ``dfhack.history``, ``tiletypes.history``, ``lua.history``, and ``liquids.history`` have moved to the ``dfhack-config`` directory. If you'd like to keep the contents of your current history files, please move them to ``dfhack-config``.

- `do-job-now`: new global keybinding for boosting the priority of the jobs associated with the selected building/work order/unit/item etc.: Alt-N

- `gui/workorder-details`: new keybinding on the workorder details screen: ``D``

- `keybinding`: support backquote (\`) as a hotkey (and assign the hotkey to the new `gui/launcher` interface)

- `ls`: can now filter tools by substring or tag. note that dev scripts are hidden by default. pass the ``--dev`` option to show them.

- `manipulator`: add a library of useful default professions

- `manipulator`: move professions configuration from ``professions/`` to ``dfhack-config/professions/`` to keep it together with other dfhack configuration. If you have saved professions that you would like to keep, please manually move them to the new folder.

- ``materials.ItemTraitsDialog``: added a default ``on_select``-handler which toggles the traits.

- `orders`: added useful library of manager orders. see them with ``orders list`` and import them with, for example, ``orders import library/basic``

- `prospect`: add new ``--show`` option to give the player control over which report sections are shown. e.g. ``prospect all --show ores`` will just show information on ores.

- `seedwatch`: ``seedwatch all`` now adds all plants with seeds to the watchlist, not just the "basic" crops.

- UX: You can now move the cursor around in DFHack text fields in ``gui/`` scripts (e.g. `gui/blueprint`, `gui/quickfort`, or `gui/gm-editor`). You can move the cursor by clicking where you want it to go with the mouse or using the Left/Right arrow keys. Ctrl+Left/Right will move one word at a time, and Alt+Left/Right will move to the beginning/end of the text.

- UX: You can now click on the hotkey hint text in many ``gui/`` script windows to activate the hotkey, like a button. Not all scripts have been updated to use the clickable widget yet, but you can try it in `gui/blueprint` or `gui/quickfort`.

- UX: Label widget scroll icons are replaced with scrollbars that represent the percentage of text on the screen and move with the position of the visible text, just like web browser scrollbars.

- `quickfort`: `Dreamfort <quickfort-blueprint-guide>` blueprint set improvements: set traffic designations to encourage dwarves to eat cooked food instead of raw ingredients

## Documentation

- Added `modding-guide`

- Update all DFHack tool documentation (300+ pages) with standard syntax formatting, usage examples, and overall clarified text.

- Group DFHack tools by `tag <tools>` so similar tools are grouped and easy to find

## API

- Removed "egg" ("eggy") hook support (Linux only). The only remaining method of hooking into DF is by interposing SDL calls, which has been the method used by all binary releases of DFHack.

- Removed ``Engravings`` module (C++-only). Access ``world.engravings`` directly instead.

- Removed ``Notes`` module (C++-only). Access ``ui.waypoints.points`` directly instead.

- Removed ``Windows`` module (C++-only) - unused.

- ``Constructions`` module (C++-only): removed ``t_construction``, ``isValid()``, ``getCount()``, ``getConstruction()``, and ``copyConstruction()``. Access ``world.constructions`` directly instead.

- ``Gui::getSelectedItem()``, ``Gui::getAnyItem()``: added support for the artifacts screen

- ``Units::teleport()``: now sets ``unit.idle_area`` to discourage units from walking back to their original location (or teleporting back, if using `fastdwarf`)

## Lua

- History: added ``dfhack.getCommandHistory(history_id, history_filename)`` and ``dfhack.addCommandToHistory(history_id, history_filename, command)`` so gui scripts can access a commandline history without requiring a terminal.

- Added ``dfhack.screen.hideGuard()``: exposes the C++ ``Screen::Hide`` to Lua

- ``helpdb``: database and query interface for DFHack tool help text

- ``tile-material``: fix the order of declarations. The ``GetTileMat`` function now returns the material as intended (always returned nil before). Also changed the license info, with permission of the original author.

- ``utils.df_expr_to_ref()``: fixed some errors that could occur when navigating tables

- ``widgets.EditField``: new ``onsubmit2`` callback attribute is called when the user hits Shift-Enter.

- ``widgets.EditField``: new function: ``setCursor(position)`` sets the input cursor.

- ``widgets.EditField``: new attribute: ``ignore_keys`` lets you ignore specified characters if you want to use them as hotkeys

- ``widgets.FilteredList``: new attribute: ``edit_ignore_keys`` gets passed to the filter EditField as ``ignore_keys``

- ``widgets.Label``: ``scroll`` function now interprets the keywords ``+page``, ``-page``, ``+halfpage``, and ``-halfpage`` in addition to simple positive and negative numbers.

- ``widgets.HotkeyLabel``: clicking on the widget will now call ``on_activate()``.

- ``widgets.CycleHotkeyLabel``: clicking on the widget will now cycle the options and trigger ``on_change()``. This also applies to the ``ToggleHotkeyLabel`` subclass.

# 0.47.05-r6

## Fixes

- `eventful`: fix ``eventful.registerReaction`` to correctly pass ``call_native`` argument thus allowing canceling vanilla item creation. Updated related documentation.

- `eventful`: renamed NEW_UNIT_ACTIVE event to UNIT_NEW_ACTIVE to match the ``EventManager`` event name

- `eventful`: fixed UNIT_NEW_ACTIVE event firing too often

- ``job.removeJob()``: fixes regression in DFHack 0.47.05-r5 where items/buildings associated with the job were not getting disassociated when the job is removed. Now `build-now` can build buildings and `gui/mass-remove` can cancel building deconstruction again

- ``widgets.CycleHotkeyLabel``: allow initial option values to be specified as an index instead of an option value

## Misc Improvements

- `confirm`: added a confirmation dialog for removing manager orders

- `confirm`: allow players to pause the confirmation dialog until they exit the current screen

- `dfhack-examples-guide`: refine food preparation orders so meal types are chosen intelligently according to the amount of meals that exist and the number of aviailable items to cook with

- `dfhack-examples-guide`: reduce required stock of dye for "Dye cloth" orders

- `dfhack-examples-guide`: fix material conditions for making jugs and pots

- `dfhack-examples-guide`: make wooden jugs by default to differentiate them from other stone tools. this allows players to more easily select jugs out with a properly-configured stockpile (i.e. the new ``woodentools`` alias)

- `quickfort-alias-guide`: new aliases: ``forbidsearch``, ``permitsearch``, and ``togglesearch`` use the `search-plugin` plugin to alter the settings for a filtered list of item types when configuring stockpiles

- `quickfort-alias-guide`: new aliases: ``stonetools`` and ``woodentools``. the ``jugs`` alias is deprecated. please use ``stonetools`` instead, which is the same as the old ``jugs`` alias.

- `quickfort-alias-guide`: new aliases: ``usablehair``, ``permitusablehair``, and ``forbidusablehair`` alter settings for the types of hair/wool that can be made into cloth: sheep, llama, alpaca, and troll. The ``craftrefuse`` aliases have been altered to use this alias as well.

- `quickfort-alias-guide`: new aliases: ``forbidthread``, ``permitthread``, ``forbidadamantinethread``, ``permitadamantinethread``, ``forbidcloth``, ``permitcloth``, ``forbidadamantinecloth``, and ``permitadamantinecloth`` give you more control how adamantine-derived items are stored

- `quickfort`: `Dreamfort <quickfort-blueprint-guide>` blueprint set improvements: automatically create tavern, library, and temple locations (restricted to residents only by default), automatically associate the rented rooms with the tavern

- `quickfort`: `Dreamfort <quickfort-blueprint-guide>` blueprint set improvements: new design for the services level, including were-bitten hospital recovery rooms and an appropriately-themed interrogation room next to the jail! Also fits better in a 1x1 embark for minimalist players.

## API

- ``word_wrap``: argument ``bool collapse_whitespace`` converted to enum ``word_wrap_whitespace_mode mode``, with valid modes ``WSMODE_KEEP_ALL``, ``WSMODE_COLLAPSE_ALL``, and ``WSMODE_TRIM_LEADING``.

## Lua

- ``gui.View``: all ``View`` subclasses (including all ``Widgets``) can now acquire keyboard focus with the new ``View:setFocus()`` function. See docs for details.

- ``materials.ItemTraitsDialog``: new dialog to edit item traits (where "item" is part of a job or work order or similar). The list of traits is the same as in vanilla work order conditions "``t`` change traits".

- ``widgets.EditField``: the ``key_sep`` string is now configurable

- ``widgets.EditField``: can now display an optional string label in addition to the activation key

- ``widgets.EditField``: views that have an ``EditField`` subview no longer need to manually manage the ``EditField`` activation state and input routing. This is now handled automatically by the new ``gui.View`` keyboard focus subsystem.

- ``widgets.HotkeyLabel``: the ``key_sep`` string is now configurable

# 0.47.05-r5

## New Plugins

- `spectate`: "spectator mode" -- automatically follows dwarves doing things in your fort

## New Tweaks

- `tweak`: ``partial-items`` displays percentage remaining for partially-consumed items such as hospital cloth

## Fixes

- `autofarm`: removed restriction on only planting "discovered" plants

- `cxxrandom`: fixed exception when calling ``bool_distribution``

- `luasocket`: return correct status code when closing socket connections so clients can know when to retry

## Misc Improvements

- `autochop`: only designate the amount of trees required to reach ``max_logs``

- `autochop`: preferably designate larger trees over smaller ones

- `blueprint`: ``track`` phase renamed to ``carve``

- `blueprint`: carved fortifications and (optionally) engravings are now captured in generated blueprints

- `cursecheck`: new option, ``--ids`` prints creature and race IDs of the cursed creature

- `debug`: DFHack log messages now have configurable headers (e.g. timestamp, origin plugin name, etc.) via the ``debugfilter`` command of the `debug` plugin

- `debug`: script execution log messages (e.g. "Loading script: dfhack_extras.init" can now be controlled with the ``debugfilter`` command. To hide the messages, add this line to your ``dfhack.init`` file: ``debugfilter set Warning core script``

- `dfhack-examples-guide`: add mugs to ``basic`` manager orders

- `dfhack-examples-guide`: ``onMapLoad_dreamfort.init`` remove "cheaty" commands and new tweaks that are now in the default ``dfhack.init-example`` file

- ``dfhack.init-example``: recently-added tweaks added to example ``dfhack.init`` file

- `dig-now`: handle fortification carving

- `EventManager`: add new event type ``JOB_STARTED``, triggered when a job first gains a worker

- `EventManager`: add new event type ``UNIT_NEW_ACTIVE``, triggered when a new unit appears on the active list

- `gui/create-item`: Added "(chain)" annotation text for armours with the [CHAIN_METAL_TEXT] flag set

- `manipulator`: tweak colors to make the cursor easier to locate

- `stocks`: allow search terms to match the full item label, even when the label is truncated for length

- `tweak`: ``stable-cursor`` now keeps the cursor stable even when the viewport moves a small amount

## Documentation

- add more examples to the plugin example skeleton files so they are more informative for a newbie

- `confirm`: correct the command name in the plugin help text

- `cxxrandom`: added usage examples

- ``Lua API.rst``: added ``isHidden(unit)``, ``isFortControlled(unit)``, ``getOuterContainerRef(unit)``, ``getOuterContainerRef(item)``

- `lua-string`: document DFHack string extensions (``startswith()``, ``endswith()``, ``split()``, ``trim()``, ``wrap()``, and ``escape_pattern()``)

- `quickfort-blueprint-guide`: added screenshots to the Dreamfort case study and overall clarified text

- `remote-client-libs`: add new Rust client library

- update download link and installation instructions for Visual C++ 2015 build tools on Windows

- update information regarding obtaining a compatible Windows build environment

## API

- add functions reverse-engineered from ambushing unit code: ``Units::isHidden()``, ``Units::isFortControlled()``, ``Units::getOuterContainerRef()``, ``Items::getOuterContainerRef()``

- ``Job::removeJob()``: use the job cancel vmethod graciously provided by The Toady One in place of a synthetic method derived from reverse engineering

## Lua

- `custom-raw-tokens`: library for accessing tokens added to raws by mods

- ``dfhack.units``: Lua wrappers for functions reverse-engineered from ambushing unit code: ``isHidden(unit)``, ``isFortControlled(unit)``, ``getOuterContainerRef(unit)``, ``getOuterContainerRef(item)``

- ``dialogs``: ``show*`` functions now return a reference to the created dialog

- ``dwarfmode.enterSidebarMode()``: passing ``df.ui_sidebar_mode.DesignateMine`` now always results in you entering ``DesignateMine`` mode and not ``DesignateChopTrees``, even when you looking at the surface (where the default designation mode is ``DesignateChopTrees``)

- ``dwarfmode.MenuOverlay``: if ``sidebar_mode`` attribute is set, automatically manage entering a specific sidebar mode on show and restoring the previous sidebar mode on dismiss

- ``dwarfmode.MenuOverlay``: new class function ``renderMapOverlay`` to assist with painting tiles over the visible map

- ``ensure_key``: new global function for retrieving or dynamically creating Lua table mappings

- ``safe_index``: now properly handles lua sparse tables that are indexed by numbers

- ``string``: new function ``escape_pattern()`` escapes regex special characters within a string

- ``widgets``: unset values in ``frame_inset`` table default to ``0``

- ``widgets``: ``FilteredList`` class now allows all punctuation to be typed into the filter and can match search keys that start with punctuation

- ``widgets``: minimum height of ``ListBox`` dialog is now calculated correctly when there are no items in the list (e.g. when a filter doesn't match anything)

- ``widgets``: if ``autoarrange_subviews`` is set, ``Panel``\s will now automatically lay out widgets vertically according to their current height. This allows you to have widgets dynamically change height or become visible/hidden and you don't have to worry about recalculating frame layouts

- ``widgets``: new class ``ResizingPanel`` (subclass of ``Panel``) automatically recalculates its own frame height based on the size, position, and visibility of its subviews

- ``widgets``: new class ``HotkeyLabel`` (subclass of ``Label``) that displays and reacts to hotkeys

- ``widgets``: new class ``CycleHotkeyLabel`` (subclass of ``Label``) allows users to cycle through a list of options by pressing a hotkey

- ``widgets``: new class ``ToggleHotkeyLabel`` (subclass of ``CycleHotkeyLabel``) toggles between ``On`` and ``Off`` states

- ``widgets``: new class ``WrappedLabel`` (subclass of ``Label``) provides autowrapping of text

- ``widgets``: new class ``TooltipLabel`` (subclass of ``WrappedLabel``) provides tooltip-like behavior

# 0.47.05-r4

## Fixes

- `blueprint`: fixed passing incorrect parameters to `gui/blueprint` when you run ``blueprint gui`` with optional params

- `blueprint`: key sequences for constructed walls and down stairs are now correct

- `tailor`: fixed some inconsistencies (and possible crashes) when parsing certain subcommands, e.g. ``tailor help``

- `tiletypes-here`, `tiletypes-here-point`: fix crash when running from an unsuspended core context

## Misc Improvements

- Core: DFHack now prints the name of the init script it is running to the console and stderr

- `automaterial`: ensure construction tiles are laid down in order when using `buildingplan` to plan the constructions

- `blueprint`: all blueprint phases are now written to a single file, using `quickfort` multi-blueprint file syntax. to get the old behavior of each phase in its own file, pass the ``--splitby=phase`` parameter to ``blueprint``

- `blueprint`: you can now specify the position where the cursor should be when the blueprint is played back with `quickfort` by passing the ``--playback-start`` parameter

- `blueprint`: generated blueprints now have labels so `quickfort` can address them by name

- `blueprint`: all building types are now supported

- `blueprint`: multi-type stockpiles are now supported

- `blueprint`: non-rectangular stockpiles and buildings are now supported