Merge branch 'DFHack:master' into create-item

Author: Tjudge1

.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.29.1
+  rev: 0.29.2
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

changelog.txt

@@ -31,23 +31,30 @@ Items will now spawn correctly, and will be of the creature type and creature ca
 # Future
 
 ## New Tools
-- `embark-anyone`: allows you to embark as any civilisation, including dead, and non-dwarven ones
-- `idle-crafting`: Allow dwarfs to automatically satisfy their need to craft objects.
-- `gui/family-affairs`: (reinstated) inspect or meddle with pregnancies, marriages, or lover relationsips
+- `embark-anyone`: allows you to embark as any civilization, including dead and non-dwarven ones
+- `idle-crafting`: allow dwarves to independently satisfy their need to craft objects
+- `gui/family-affairs`: (reinstated) inspect or meddle with pregnancies, marriages, or lover relationships
 
 ## New Features
 - `caravan`: DFHack dialogs for trade screens (both ``Bring goods to depot`` and the ``Trade`` barter screen) can now filter by item origins (foreign vs. fort-made) and can filter bins by whether they have a mix of ethically acceptable and unacceptable items in them
 - `caravan`: If you have managed to select an item that is ethically unacceptable to the merchant, an "Ethics warning" badge will now appear next to the "Trade" button. Clicking on the badge will show you which items that you have selected are problematic. The dialog has a button that you can click to deselect the problematic items in the trade list.
 - `confirm`: If you have ethically unacceptable items selected for trade, the "Are you sure you want to trade" confirmation will warn you about them
+- `quickfort`: ``#zone`` blueprints now integrated with `preserve-rooms` so you can create a zone and automatically assign it to a noble or administrative role
+- `position`: option to copy cursor position to clipboard
 
 ## Fixes
-- `timestream`: ensure child growth events (e.g. becoming an adult) are not skipped over
-- `empty-bin`: ``--liquids`` option correctly emptying containers filled with LIQUID_MISC
-- `gui/design`: Update Line & Freeform tools to not overcount tiles
+- `timestream`: ensure child growth events (e.g. becoming an adult) are not skipped
+- `empty-bin`: ``--liquids`` option now correctly empties containers filled with LIQUID_MISC (like lye)
+- `gui/design`: don't overcount "affected tiles" for Line & Freeform drawing tools
 
 ## Misc Improvements
-- `gui/sitemap`: show whether a unit is friendly, hostile, or wildlife
+- `gui/sitemap`: show whether a unit is friendly, hostile, or wild
 - `gui/sitemap`: show whether a unit is caged
+- `gui/control-panel`: include option for turning off dumping of old clothes for `tailor`, for players who have magma pit dumps and want to save old clothes from being dumped into the magma
+- `position`: report current historical era (e.g., "Age of Myth")
+
+## Documentation
+- `gui/embark-anywhere`: add information about how the game determines world tile pathability and instructions for bridging two landmasses
 
 ## Removed
 

docs/gui/embark-anywhere.rst

@@ -11,8 +11,13 @@ embark in an inaccessible location on top of a mountain range? Go for it! Want
 to try a brief existence in the middle of the ocean? Nobody can stop you! Want
 to tempt fate by embarking *inside of* a necromancer tower? !!FUN!!
 
+If you are using this tool to create a fort that will bridge two disconnected
+areas of land, see `So you want to bridge a gap?`_ below for tips and caveats.
+
 Any and all consequences of embarking in strange locations are up to you to
-handle (possibly with other `armok <armok-tag-index>` tools).
+handle (possibly with other `armok <armok-tag-index>` tools). In particular,
+embarking in inaccessible locations will prevent migrants, caravans, and
+visitors from arriving.
 
 Usage
 -----
@@ -21,9 +26,37 @@ Usage
 
     gui/embark-anywhere
 
-The command will only work when you are on the screen where you can choose your
-embark site. The DFHack logo is not displayed on that screen since its default
-position conflicts with the vanilla embark size selection panel. Remember that
-you can bring up DFHack's `context menu <hotkeys>` with
-:kbd:`Ctrl`:kbd:`Shift`:kbd:`C` or the
-`in-game command launcher <gui/launcher>` directly with the backtick key (\`).
+The command will only work when you are on the screen where you can choose the
+embark site for your fort.
+
+So you want to bridge a gap?
+----------------------------
+
+A popular use case for this tool is to create a fort (or a series of forts) that
+bridges two disconnected landmasses so sites on the two landmasses can reach
+each other (that is, they can send raiding parties and/or engage in trade).
+
+However, the way this works is not entirely intuitive.
+
+A single large embark is not necessarily going to functionally connect the two
+shores so that armies can cross the gap. You could still choose to use this
+approach to build a continuous constructed bridge in fort mode for later use as
+an *adventurer* in adventure mode, but it will not be usable by the other
+characters/armies in the world.
+
+The DF world map is divided into blocks of 16x16 tiles. When you are choosing
+where to embark and you move the mouse so that your embark area "shadow" moves
+over a little bit -- that's one "tile". An embark area can span block
+boundaries, and there is no indication on the map where those boundaries are.
+
+The way DF determines world pathability is to check if the ground is continuous
+**or** if the enclosing 16x16 block contains the upper left tile of a fort
+embark area.
+
+In order for a connection to be formed for armies, one fort upper left corner
+must exist in each 16x16 block that contains part of the gap.
+
+Therefore, the simplest solution for making a "bridge" that armies can use (but
+walking adventurers cannot) is to make a 1x1 fort every 16 tiles across the
+water gap, starting on land on one shore and finishing on land on the opposite
+shore. That will ensure that every 16x16 block in the gap is covered by a fort.

docs/gui/seedwatch.rst

@@ -5,11 +5,11 @@ gui/seedwatch
     :summary: Manages seed and plant cooking based on seed stock levels.
     :tags: fort auto plants
 
-This is the configuration interface for the `seedwatch` plugin. You can configure
-a target stock amount for each seed type. If the number of seeds of that type falls
-below the target, then the plants and seeds of that type will be protected from
-cookery. If the number rises above the target + 20, then cooking will be allowed
-again.
+This is the configuration interface for the `seedwatch` plugin. You can
+configure a target stock amount for each seed type. If the number of seeds of
+that type falls below the target, then the plants and seeds of that type will
+be protected from cookery. If the number rises above the target + 20, then
+cooking will be allowed again.
 
 Usage
 -----

docs/position.rst

@@ -5,13 +5,30 @@ position
     :summary: Report cursor and mouse position, along with other info.
     :tags: fort inspection map
 
-This tool reports the current date, clock time, month, and season. It also
-reports the cursor position (or just the z-level if no cursor), window size, and
-mouse location on the screen.
+This tool reports the current date, clock time, month, season, and historical
+era. It also reports the keyboard cursor position (or just the z-level if no
+active cursor), window size, and mouse location on the screen.
+
+Can also be used to copy the current keyboard cursor position for later use.
 
 Usage
 -----
 
 ::
 
-    position
+    position [--copy]
+
+Examples
+--------
+
+``position``
+    Print various information.
+``position -c``
+    Copy cursor position to system clipboard.
+
+Options
+-------
+
+``-c``, ``--copy``
+    Copy current keyboard cursor position to the clipboard in format ``0,0,0``
+    instead of reporting info. For convenience with other tools.

fix/dry-buckets.lua

@@ -1,7 +1,15 @@
+local argparse = require("argparse")
+
+local quiet = false
+
 local emptied = 0
 local in_building = 0
 local water_type = dfhack.matinfo.find('WATER').type
 
+argparse.processArgsGetopt({...}, {
+    {'q', 'quiet', handler=function() quiet = true end},
+})
+
 for _,item in ipairs(df.global.world.items.other.IN_PLAY) do
     local container = dfhack.items.getContainer(item)
     if container
@@ -19,7 +27,9 @@ for _,item in ipairs(df.global.world.items.other.IN_PLAY) do
     end
 end
 
-print('Emptied '..emptied..' buckets.')
-if emptied > 0 then
-    print(('Unclogged %d wells.'):format(in_building))
+if not quiet then
+    print('Emptied '..emptied..' buckets.')
+    if emptied > 0 then
+        print(('Unclogged %d wells.'):format(in_building))
+    end
 end

gui/quickfort.lua

@@ -63,7 +63,7 @@ function BlueprintDialog:init()
                     text_pen=COLOR_GREY,
                 },
                 widgets.ToggleHotkeyLabel{
-                    frame={t=0, l=12},
+                    frame={t=0, l=12, w=20},
                     key='CUSTOM_ALT_L',
                     label='Library:',
                     options=options,
@@ -72,7 +72,7 @@ function BlueprintDialog:init()
                     on_change=self:callback('update_setting', 'show_library')
                 },
                 widgets.ToggleHotkeyLabel{
-                    frame={t=0, l=35},
+                    frame={t=0, l=35, w=19},
                     key='CUSTOM_ALT_H',
                     label='Hidden:',
                     options=options,