Merge branch 'DFHack:master' into codex/add-dfhack-script-for-wall-smoothing

Author: unboundlopez

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.34.1
+  rev: 0.36.0
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

changelog.txt

@@ -36,6 +36,66 @@ Template for new versions:
 
 ## Removed
 
+# 53.10-r1
+
+## New Tools
+
+## New Features
+- `gui/notify`: new notification type: missing nemesis records; displays a warning message about game corruption.
+
+## Fixes
+
+## Misc Improvements
+
+## Removed
+
+# 53.07-r1
+
+## New Tools
+- `fix/codex-pages`: add pages to written content that have unspecified page counts.
+- `gui/keybinds`: gui for managing and saving custom keybindings
+
+## New Features
+
+## Fixes
+- `empty-bin`: renamed ``--liquids`` parameter to ``--force`` and made emptying of containers (bags) with powders contingent on that parameter. Previously powders would just always get disposed.
+
+## Misc Improvements
+- `combine`: try harder to find the currently-selected stockpile
+
+## Removed
+
+# 53.06-r1
+
+## New Tools
+
+## New Features
+
+## Fixes
+- `gui/design`: designating a single-level stair construction now properly follows the selected stair type.
+- `gui/design`: adjusted conflicting keybinds, diagonal line reverse becoming ``R`` and bottom stair type becoming ``g``.
+- `modtools/set-personality`: use correct caste trait ranges; fixes `gui/gm-unit` being unable to correctly randomize traits or set traits to caste average
+
+## Misc Improvements
+
+## Removed
+
+# 53.04-r1
+
+## New Tools
+- `gui/siegemanager`: manage your siege engines at a glance.
+
+## New Features
+- `item`: new ``--total-quality`` option for use in conjunction with ``--min-quality`` or ``--max-quality`` to filter items according to their total quality
+
+## Fixes
+
+## Misc Improvements
+- `gui/design`: can now construct reinforced walls
+- `quickfort`: support for reinforced walls and bolt throwers
+
+## Removed
+
 # 53.01-r1
 
 ## New Tools

combine.lua

@@ -736,6 +736,26 @@ local function get_stockpile_here()
     -- return the stockpile as a table
     local stockpiles = {}
     local building = dfhack.gui.getSelectedStockpile(true)
+
+    -- try finding the stockpile by viewed item or first item in itemlist viewsheet.
+    if building == nil then
+        local item = nil
+        if dfhack.gui.getSelectedItem(true) ~= nil then
+            item = dfhack.gui.getSelectedItem(true)
+        elseif tonumber(dfhack.DF_VERSION:match("^0*%.*(%d+%.%d+)")) >= 50.07   -- matchFocusString() in Commit a770a4c
+            and dfhack.gui.matchFocusString("dwarfmode/ViewSheets/ITEM_LIST", dfhack.gui.getDFViewscreen())
+            and df.global.game.main_interface.view_sheets.open == true
+            and df.global.game.main_interface.view_sheets.active_sheet == df.view_sheet_type.ITEM_LIST
+            and #df.global.game.main_interface.view_sheets.viewing_itid > 0
+        then
+            local itemid = df.global.game.main_interface.view_sheets.viewing_itid[0]
+            item = df.item.find(itemid)
+        end
+        local pos = (item) and xyz2pos(dfhack.items.getPosition(item)) or nil
+        building = (pos) and dfhack.buildings.findAtTile(pos) or nil
+        building = (df.building_stockpilest:is_instance(building)) and building or nil
+    end
+
     if not building then qerror('Please select a stockpile.') end
     table.insert(stockpiles, building)
     if opts.verbose > 0 then

docs/combine.rst

@@ -38,7 +38,9 @@ Commands
 ``all``
     Search all stockpiles.
 ``here``
-    Search the currently selected stockpile.
+    Search the currently selected stockpile, or the stockpile that the
+    currently-seelected item is in, or the stockpile that the currently-
+    displayed item-list is in.
 
 Options
 -------

docs/empty-bin.rst

@@ -25,18 +25,20 @@ Examples
 --------
 
 ``empty-bin``
-    Empty the contents of selected containers or all containers in the selected stockpile or building, except containers with liquids, onto the floor.
+   Empty the contents of selected containers or all containers in the selected stockpile or building, except containers with liquids or powders, onto the floor.
 
-``empty-bin --liquids``
-    Empty the contents of selected containers or all containers in the selected stockpile or building, including containers with liquids, onto the floor.
+``empty-bin --force``
+   Empty the contents of selected containers or all containers in the selected stockpile or building, including containers with liquids or powders, onto the floor.
+
+``empty-bin --recursive --force``
+   Empty the contents of selected containers or all containers in the selected stockpile or building, including containers with liquids/powders and containers contents that are containers, such as a bags of seeds or filled waterskins, onto the floor.
 
-``empty-bin --recursive --liquids``
-    Empty the contents of selected containers or all containers in the selected stockpile or building, including containers with liquids and containers contents that are containers, such as a bags of seeds or filled waterskins, onto the floor.
 
 Options
---------------
+-------
 
 ``-r``, ``--recursive``
-    Recursively empty containers.
-``-l``, ``--liquids``
-    Move contained liquids (DRINK and LIQUID_MISC) to the floor, making them unusable.
+   Recursively empty containers.
+
+``-f``, ``--force``
+   Move contained liquid and powders (DRINK, LIQUID_MISC and POWDER_MISC) to the floor, making them unusable.

docs/fix/codex-pages.rst

@@ -0,0 +1,44 @@
+fix/codex-pages
+===============
+
+.. dfhack-tool::
+    :summary: Add pages to written content that have no pages.
+    :tags: fort bugfix items
+
+Add pages to codices, quires, and scrolls that do not have specified page counts.
+
+Usage
+-----
+
+``fix/codex-pages [this|site|all]``
+
+Pages will be added to written works that do not have properly specified page
+counts. The number of pages to be added will be determined mainly by the type
+of the written content, modified by its writing style and the strength of the
+style, with weighted randomization.
+
+Options
+-------
+
+``this``
+    Add pages to the selected codex, quire, or scroll item.
+
+``site``
+    Add pages to all written works that are currently in the player's fortress.
+
+``all``
+    Add pages to all written works to have ever existed in the world.
+
+Note
+----
+
+This tool mitigates :bug:`9268` by generating new, randomized information for
+written content that do not have the start and end pages specified in their
+data structure. It cannot retrieve page count from written content that was
+already missing the page count information.
+
+Also, unbound quires and scrolls do not display the number of pages they contain
+in their item description even if the data structure of their written content
+holds the information. However, once a quire that has written content with
+appropriately specified page count information is bound into a codex, its page
+count will be properly displayed in the resulting codex's item description.

docs/gui/design.rst

@@ -45,7 +45,7 @@ Shapes
     - Spacing can be increased/decreased using 'T'/'t'.
     - They can be inverted using 'i'.
 - Diagonal
-    - Direction can be reversed using 'r'.
+    - Direction can be reversed using 'R'.
     - Spacing can be increased/decreased using 'T'/'t'.
     - They can be inverted using 'i'.
 - Line

docs/gui/keybinds.rst

@@ -0,0 +1,30 @@
+gui/keybinds
+============
+
+.. dfhack-tool::
+   :summary: Manage your dfhack keybinds visually.
+   :tags: dfhack
+
+This tool allows you to create, edit, save, and delete custom keybinds that
+run dfhack commands.
+
+Usage
+-----
+
+::
+
+    gui/keybinds
+
+Focus Strings
+-------------
+
+Keybinds may have a focus filter applied, enabling or disabling the keybind
+based on the current open menu or gamemode. More information on the percise
+format can be found in `keybinding`.
+
+Saved Keybinds
+--------------
+
+If saved, all currently active keybinds are stored in a dfhack init script at
+``dfhack-config/init/dfhack.auto.keybinds.init``. The save does not remove any
+keybinds set in other init scripts, nor created in-game.

docs/gui/siegemanager.rst

@@ -0,0 +1,16 @@
+gui/siegemanager
+================
+
+.. dfhack-tool::
+   :summary: Manage siege engines at a glance
+   :tags: buildings interface productivity
+
+This interface provides a list of siege engines, their ammo count, and current active
+jobs whilst providing shortcuts to configure their firing/standy mode and view them in-world.
+
+Usage
+-----
+
+::
+
+    gui/siegemanager

docs/item.rst

@@ -49,7 +49,8 @@ Examples
     flood-fill to create a burrow covering an entire cavern layer).
 
 ``item melt -t weapon -m steel --max-quality 3``
-    Designate all steel weapons whose quality is at most superior for melting.
+    Designate all steel weapons whose core quality is at most superior for
+    melting.
 
 ``item hide -t boulder --scattered``
     Hide all scattered boulders, i.e. those that are not in stockpiles.
@@ -121,6 +122,11 @@ Options
     Only include items whose quality level is at most ``integer``. Useful
     values are 0 (ordinary) to 5 (masterwork).
 
+``--total-quality``
+    Only applies to ``--min-quality`` and ``--max-quality`` options. Filter items
+    according to their total quality (to include improvements) of instead of
+    their core quality.
+
 ``--stockpiled``
     Only include items that are in stockpiles. Does not include empty bins,
     barrels, and wheelbarrows assigned as storage and transport for stockpiles.
@@ -201,8 +207,12 @@ the filter is described.
     see above).
 
 * ``condition_quality(tab, lower, upper, negate)``
-    Selects items with quality between ``lower`` and ``upper`` (Range 0-5, see
-    above).
+    Selects items with core quality between ``lower`` and ``upper`` (Range 0-5,
+    see above).
+
+* ``condition_overall_quality(tab, lower, upper, negate)``
+    Selects items with total quality between ``lower`` and ``upper`` (Range 0-5,
+    see above).
 
 * ``condition_stockpiled(tab, negate)``
     Corresponds to ``--stockpiled``.