dfhack/docs/plugins/burrows.rst

burrows
=======
**Tags:** `tag/fort`, `tag/auto`, `tag/productivity`, `tag/units`
:dfhack-keybind:`burrow`

:index:`Auto-expand burrows as you dig.
<burrows (plugin); Auto-expand burrows as you dig.>` When a wall inside a burrow
with a name ending in ``+`` is dug out, the burrow will be extended to
newly-revealed adjacent walls. Note that digging 1-wide corridors with the miner
inside the burrow is **SLOW**.

You can also use the ``burrow`` command to
:index:`quickly add units/tiles to burrows.
<burrow; Quickly add units/tiles to burrows.>`

Usage:

``burrow enable auto-grow``
    When a wall inside a burrow with a name ending in '+' is dug out, the burrow
    will be extended to newly-revealed adjacent walls. This final '+' may be
    omitted in burrow name args of other ``burrows`` commands. Note that digging
    1-wide corridors with the miner inside the burrow is SLOW.
``burrow disable auto-grow``
    Disables auto-grow processing.
``burrow clear-unit <burrow> [<burrow> ...]``
    Remove all units from the named burrows.
``burrow clear-tiles <burrow> [<burrow> ...]``
    Remove all tiles from the named burrows.
``burrow set-units target-burrow <burrow> [<burrow> ...]``
    Clear all units from the target burrow, then add units from the named source
    burrows.
``burrow add-units target-burrow <burrow> [<burrow> ...]``
    Add units from the source burrows to the target.
``burrow remove-units target-burrow <burrow> [<burrow> ...]``
    Remove units in source burrows from the target.
``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
    Clear target burrow tiles and adds tiles from the names source burrows.
``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
    Add tiles from the source burrows to the target.
``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
    Remove tiles in source burrows from the target.

In place of a source burrow, you can use one of the following keywords:

- ``ABOVE_GROUND``
- ``SUBTERRANEAN``
- ``INSIDE``
- ``OUTSIDE``
- ``LIGHT``
- ``DARK``
- ``HIDDEN``
- ``REVEALED``

to add tiles with the given properties.
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`burrows`
			`=======`
sync tags spreadsheet to git spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995 sync command - for fname in rst; do name=$(echo $fname \| sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv \| ~/Downloads/csvtotags.sh); sed -ri "s;[]Tags:.;$tagline;" $fname; done contents of csvtotags.sh - fgrep . \| sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' \| awk -F, ' function tag(idx, tagname) { if ($idx == "TRUE") { if (hastag == 1) {printf(", ")} printf("`tag/%s`", tagname) hastag = 1 } } { printf("%s", "Tags: ") hastag = 0 tag(2, "adventure") tag(3, "fort") tag(4, "legends") tag(5, "embark") tag(6, "system") tag(7, "dev") tag(8, "auto") tag(9, "productivity") tag(10, "inspection") tag(11, "design") tag(12, "quickfort") tag(13, "interface") tag(14, "fps") tag(15, "fix") tag(16, "mod") tag(17, "armok") tag(18, "animals") tag(19, "buildings") tag(20, "items") tag(21, "jobs") tag(22, "map") tag(23, "labors") tag(24, "units") tag(25, "stockpiles") tag(26, "trees") printf("\n") } ' 2022-08-05 18:55:33 -06:00			Tags: `tag/fort`, `tag/auto`, `tag/productivity`, `tag/units`
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			:dfhack-keybind:`burrow`
update formatting for plugin docs 2022-07-20 00:11:02 -06:00
ensure all plugins are indexed 2022-07-22 11:14:50 -06:00			:index:`Auto-expand burrows as you dig.
			<burrows (plugin); Auto-expand burrows as you dig.>` When a wall inside a burrow
			with a name ending in ``+`` is dug out, the burrow will be extended to
			`newly-revealed adjacent walls. Note that digging 1-wide corridors with the miner`
			`inside the burrow is SLOW.`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			You can also use the ``burrow`` command to
ensure all plugins are indexed 2022-07-22 11:14:50 -06:00			:index:`quickly add units/tiles to burrows.
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			<burrow; Quickly add units/tiles to burrows.>`
update docs for burrows 2022-07-18 18:09:48 -06:00
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Usage:`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow enable auto-grow``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`When a wall inside a burrow with a name ending in '+' is dug out, the burrow`
			`will be extended to newly-revealed adjacent walls. This final '+' may be`
			omitted in burrow name args of other ``burrows`` commands. Note that digging
some plugins can't be directly enabled by the user 2022-07-29 17:05:49 -06:00			`1-wide corridors with the miner inside the burrow is SLOW.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow disable auto-grow``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Disables auto-grow processing.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow clear-unit <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove all units from the named burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow clear-tiles <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove all tiles from the named burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow set-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Clear all units from the target burrow, then add units from the named source`
			`burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow add-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Add units from the source burrows to the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow remove-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove units in source burrows from the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Clear target burrow tiles and adds tiles from the names source burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Add tiles from the source burrows to the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove tiles in source burrows from the target.`

			`In place of a source burrow, you can use one of the following keywords:`

			- ``ABOVE_GROUND``
			- ``SUBTERRANEAN``
			- ``INSIDE``
			- ``OUTSIDE``
			- ``LIGHT``
			- ``DARK``
			- ``HIDDEN``
			- ``REVEALED``

			`to add tiles with the given properties.`