MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs up to the end of the b's

develop
myk002 2022-07-22 00:05:53 -07:00
parent b3679bef25
commit 6b9803daaf
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
24 changed files with 116 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/plugins/3dveins.rst
Unescape Escape View File

@ -4,9 +4,11 @@
Tags:
:dfhack-keybind:`3dveins`
Rewrites layer veins to expand in 3D space. Existing, flat veins are removed
and new 3D veins that naturally span z-levels are generated in their place.
The transformation preserves the mineral counts reported by `prospect`.
:index:`Rewrites layer veins to expand in 3D space.
<3dveins; Rewrites layer veins to expand in 3D space.>` Existing, flat veins
are removed and new 3D veins that naturally span z-levels are generated in
their place. The transformation preserves the mineral counts reported by
`prospect`.
Usage::

1
docs/plugins/add-spatter.rst
Unescape Escape View File

@ -2,7 +2,6 @@ add-spatter
===========
Tags:
:dfhack-keybind:`add-spatter`
Make tagged reactions produce contaminants. The plugin is intended to give some
use to all those poisons that can be bought from caravans. It automatically

1
docs/plugins/autochop.rst
Unescape Escape View File

@ -2,7 +2,6 @@ autochop
========
Tags:
:dfhack-keybind:`autochop`
Auto-harvest trees when low on stockpiled logs. This plugin can designate trees
for chopping when your stocks are low on logs.

5
docs/plugins/autoclothing.rst
Unescape Escape View File

@ -4,8 +4,9 @@ autoclothing
Tags:
:dfhack-keybind:`autoclothing`
Automatically manage clothing work orders. It allows you to set how many of each
clothing type every citizen should have.
:index:`Automatically manage clothing work orders.
<autoclothing; Automatically manage clothing work orders.>` It allows you to
set how many of each clothing type every citizen should have.
Usage::

13
docs/plugins/autodump-destroy-here.rst
Unescape Escape View File

@ -1,13 +0,0 @@
autodump-destroy-here
=====================
Tags:
:dfhack-keybind:`autodump-destroy-here`
Destroy items marked for dumping under cursor. If called again before the game
is resumed, cancels destruction of the items. This is an alias for the
`autodump` command ``autodump destroy-here``, intended for use as a keybinding.
Usage::
autodump-destroy-here

16
docs/plugins/autodump-destroy-item.rst
Unescape Escape View File

@ -1,16 +0,0 @@
autodump-destroy-item
=====================
Tags:
:dfhack-keybind:`autodump-destroy-item`
Destroy the selected item. The item may be selected in the :kbd:`k` list or in
the container item list. If called again before the game is resumed, cancels
destruction of the item.
This command is intended for use as a keybinding. See the `autodump` command
for other dumping/destroying options.
Usage::
autodump-destroy-item

37
docs/plugins/autodump.rst
Unescape Escape View File

@ -3,15 +3,17 @@ autodump
Tags:
:dfhack-keybind:`autodump`
:dfhack-keybind:`autodump-destroy-here`
:dfhack-keybind:`autodump-destroy-item`
Quickly designate or teleport items to be dumped. When `enabled <enable>`, this
plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``autodump``
option is selected for the stockpile, any items placed in the stockpile will
automatically be designated to be dumped.
Automatically set items in a stockpile to be dumped. When `enabled <enable>`,
this plugin adds an option to the :kbd:`q` menu for stockpiles. When the
``autodump`` option is selected for the stockpile, any items placed in the
stockpile will automatically be designated to be dumped.
When invoked as a command, it can instantly move all items designated to be
dumped to the tile under the cursor. After moving the items, the dump flag is
unset and the forbid flag is set, just as if it had been dumped normally. Be
When invoked as a command, it can instantly move all unforbidden items marked
for dumping to the tile under the cursor. After moving the items, the dump flag
is unset and the forbid flag is set, just as if it had been dumped normally. Be
aware that dwarves that are en route to pick up the item for dumping may still
come and move the item to your dump zone.
@ -21,6 +23,15 @@ Usage::
enable autodump
autodump [<options>]
autodump-destroy-here
autodump-destroy-item
``autodump-destroy-here`` is an alias for ``autodump destroy-here`` and is
intended for use as a keybinding.
``autodump-destroy-item`` destroys only the selected item. The item may be
selected in the :kbd:`k` list or in the container item list. If called again
before the game is resumed, cancels destruction of the item.
Options
-------
@ -28,10 +39,10 @@ Options
- ``destroy``
Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is
called again with this option before the game is resumed, it cancels
the destroy action.
pending destroy actions.
- ``destroy-here``
As ``destroy``, but only the selected item in the :kbd:`k` list, or inside a
container.
:index:`Destroy items marked for dumping under the cursor.
<autodump-destroy-here; Destroy items marked for dumping under the cursor.>`
- ``visible``
Only process items that are not hidden.
- ``hidden``
@ -43,6 +54,10 @@ Examples
--------
- ``autodump``
Teleports all unforbidden items marked for dumping to the cursor position.
:index:`Teleports items marked for dumping to the cursor position.
<autodump; Teleports items marked for dumping to the cursor position.>`
- ``autodump destroy``
Destroys all unforbidden items marked for dumping
- ``autodump-destroy-item``
:index:`Destroys the selected item.
<autodump-destroy-item; Destroys the selected item.>`

9
docs/plugins/autofarm.rst
Unescape Escape View File

@ -4,10 +4,11 @@ autofarm
Tags:
:dfhack-keybind:`autofarm`
Automatically manage farm crop selection. This plugin periodically scans your
plant stocks and assigns crops to your farm plots based on which plant stocks
are low (as long as you have the appropriate seeds). The target threshold for
each crop type is configurable.
:index:`Automatically manage farm crop selection.
<autofarm; Automatically manage farm crop selection.>` This plugin periodically
scans your plant stocks and assigns crops to your farm plots based on which
plant stocks are low (as long as you have the appropriate seeds). The target
threshold for each crop type is configurable.
Usage:

12
docs/plugins/autogems-reload.rst
Unescape Escape View File

@ -1,12 +0,0 @@
autogems-reload
===============
Tags:
:dfhack-keybind:`autogems-reload`
Reloads the autogems configuration file. You might need to do this if you have
manually modified the contents while the game is running.
Usage::
autogems-reload

14
docs/plugins/autogems.rst
Unescape Escape View File

@ -2,14 +2,20 @@ autogems
========
Tags:
:dfhack-keybind:`autogems`
:dfhack-keybind:`autogems-reload`
Automatically cut rough gems. This plugin periodically scans your stocks of
rough gems and creates manager orders for cutting them at a Jeweler's Workshop.
Usage::
Usage:
enable autogems
- ``enable autogems``
Enables the plugin
- ``autogems-reload``
:index:`Reloads the autogems configuration file.
<autogems-reload; Reloads the autogems configuration file.>` You might need
to do this if you have manually modified the contents while the game is
running.
Run `gui/autogems` for a configuration UI, or access the new ``Auto Cut Gems``
Run `gui/autogems` for a configuration UI, or access the ``Auto Cut Gems``
option from the Current Workshop Orders screen (:kbd:`o`-:kbd:`W`).

9
docs/plugins/autohauler.rst
Unescape Escape View File

@ -4,10 +4,11 @@ autohauler
Tags:
:dfhack-keybind:`autohauler`
Automatically manage hauling labors. Similar to `autolabor`, but instead of
managing all labors, ``autohauler`` only addresses hauling labors, leaving the
assignment of skilled labors entirely up to you. You can use the in-game
`manipulator` UI or an external tool like Dwarf Therapist to do so.
:index:`Automatically manage hauling labors.
<autohauler; Automatically manage hauling labors.>` Similar to `autolabor`, but
instead of managing all labors, ``autohauler`` only addresses hauling labors,
leaving the assignment of skilled labors entirely up to you. You can use the
in-game `manipulator` UI or an external tool like Dwarf Therapist to do so.
Idle dwarves who are not on active military duty will be assigned the hauling
labors; everyone else (including those currently hauling) will have the hauling

6
docs/plugins/autolabor.rst
Unescape Escape View File

@ -4,8 +4,10 @@ autolabor
Tags:
:dfhack-keybind:`autolabor`
Automatically manage dwarf labors. Autolabor attempts to keep as many dwarves as
possible busy while allowing dwarves to specialize in specific skills.
:index:`Automatically manage dwarf labors.
<autolabor; Automatically manage dwarf labors.>` Autolabor attempts to keep as
many dwarves as possible busy while allowing dwarves to specialize in specific
skills.
Autolabor frequently checks how many jobs of each type are available and sets
labors proportionally in order to get them all done quickly. Labors with

1
docs/plugins/automaterial.rst
Unescape Escape View File

@ -2,7 +2,6 @@ automaterial
============
Tags:
:dfhack-keybind:`automaterial`
Sorts building materials by recent usage. This makes building constructions
(walls, floors, fortifications, etc) much easier by saving you from having to

1
docs/plugins/automelt.rst
Unescape Escape View File

@ -2,7 +2,6 @@ automelt
========
Tags:
:dfhack-keybind:`automelt`
Quickly designate items to be melted. When `enabled <enable>`, this plugin adds
an option to the :kbd:`q` menu for stockpiles. When the ``automelt`` option is

1
docs/plugins/autotrade.rst
Unescape Escape View File

@ -2,7 +2,6 @@ autotrade
=========
Tags:
:dfhack-keybind:`autotrade`
Quickly designate items to be traded. When `enabled <enable>`, this plugin adds
an option to the :kbd:`q` menu for stockpiles. When the ``autotrade`` option is

7
docs/plugins/blueprint.rst
Unescape Escape View File

@ -4,9 +4,10 @@ blueprint
Tags:
:dfhack-keybind:`blueprint`
Record a live game map in a quickfort blueprint. With ``blueprint``, you can
export the structure of a portion of your fortress in a blueprint file that you
(or anyone else) can later play back with `quickfort`.
:index:`Record a live game map in a quickfort blueprint.
<blueprint; Record a live game map in a quickfort blueprint.>` With
``blueprint``, you can export the structure of a portion of your fortress in a
blueprint file that you (or anyone else) can later play back with `quickfort`.
Blueprints are ``.csv`` or ``.xlsx`` files created in the ``blueprints``
subdirectory of your DF folder. The map area to turn into a blueprint is either

1
docs/plugins/building-hacks.rst
Unescape Escape View File

@ -2,7 +2,6 @@ building-hacks
==============
Tags:
:dfhack-keybind:`building-hacks`
Allows mods to create and manage powered workshops.

13
docs/plugins/buildingplan.rst
Unescape Escape View File

@ -4,12 +4,13 @@ buildingplan
Tags:
:dfhack-keybind:`buildingplan`
Plan building construction before you have materials. This plugin adds a
planning mode for building placement. You can then place furniture,
constructions, and other buildings before the required materials are available,
and they will be created in a suspended state. Buildingplan will periodically
scan for appropriate items, and the jobs will be unsuspended when the items are
available.
:index:`Plan building construction before you have materials.
<buildingplan; Plan building construction before you have materials.>` This
plugin adds a planning mode for building placement. You can then place
furniture, constructions, and other buildings before the required materials are
available, and they will be created in a suspended state. Buildingplan will
periodically scan for appropriate items, and the jobs will be unsuspended when
the items are available.
This is very useful when combined with manager work orders or `workflow` -- you
can set a constraint to always have one or two doors/beds/tables/chairs/etc.

49
docs/plugins/burrow.rst
Unescape Escape View File

@ -1,49 +0,0 @@
burrow
======
Tags:
:dfhack-keybind:`burrow`
Quick commands for burrow control. Allows manipulating burrows and automated
burrow expansion while digging.
Usage:
- ``burrows 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. Be sure to also
run ``enable burrow`` for this feature to work.
- ``burrows disable auto-grow``
Disables auto-grow processing.
- ``burrows clear-unit <burrow> [<burrow> ...]``
Remove all units from the named burrows.
- ``burrows clear-tiles <burrow> [<burrow> ...]``
Remove all tiles from the named burrows.
- ``burrows set-units target-burrow <burrow> [<burrow> ...]``
Clear all units from the target burrow, then add units from the named source
burrows.
- ``burrows add-units target-burrow <burrow> [<burrow> ...]``
Add units from the source burrows to the target.
- ``burrows remove-units target-burrow <burrow> [<burrow> ...]``
Remove units in source burrows from the target.
- ``burrows set-tiles target-burrow <burrow> [<burrow> ...]``
Clear target burrow tiles and adds tiles from the names source burrows.
- ``burrows add-tiles target-burrow <burrow> [<burrow> ...]``
Add tiles from the source burrows to the target.
- ``burrows 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.

52
docs/plugins/burrows.rst
Unescape Escape View File

@ -2,17 +2,57 @@ burrows
=======
Tags:
:dfhack-keybind:`burrows`
:dfhack-keybind:`burrow`
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.
Usage::
You can also use the ``burrow`` command to
:index:`Quickly add units/tiles to burrows.
<burrow; Quickly add units/tiles to burrows.>`
enable burrows
burrows enable auto-grow
Usage:
Both of the above commands need to be run for the auto-grow functionality to
work. See the `burrow` command for more burrow-related tools.
- ``enable burrows``
Enable the plugin for the auto-grow feature (see
``burrow enable auto-grow`` below)
- ``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. Be sure to also
run ``enable burrows`` for this feature to work.
- ``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.

20
docs/plugins/digl.rst
Unescape Escape View File

@ -1,20 +0,0 @@
dig
===
This plugin makes many automated or complicated dig patterns easy.
Basic commands:
:digv: Designate all of the selected vein for digging.
:digvx: Also cross z-levels, digging stairs as needed. Alias for ``digv x``.
:digl: Like ``digv``, for layer stone. Also supports an ``undo`` option
to remove designations, for if you accidentally set 50 levels at once.
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
:dfhack-keybind:`digv`
.. note::
All commands implemented by the `dig` plugin (listed by ``ls dig``) support
specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``,
where ``#`` is a number from 1 to 7. If a priority is not specified, the
priority selected in-game is used as the default.

20
docs/plugins/diglx.rst
Unescape Escape View File

@ -1,20 +0,0 @@
dig
===
This plugin makes many automated or complicated dig patterns easy.
Basic commands:
:digv: Designate all of the selected vein for digging.
:digvx: Also cross z-levels, digging stairs as needed. Alias for ``digv x``.
:digl: Like ``digv``, for layer stone. Also supports an ``undo`` option
to remove designations, for if you accidentally set 50 levels at once.
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
:dfhack-keybind:`digv`
.. note::
All commands implemented by the `dig` plugin (listed by ``ls dig``) support
specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``,
where ``#`` is a number from 1 to 7. If a priority is not specified, the
priority selected in-game is used as the default.

20
docs/plugins/digv.rst
Unescape Escape View File

@ -1,20 +0,0 @@
dig
===
This plugin makes many automated or complicated dig patterns easy.
Basic commands:
:digv: Designate all of the selected vein for digging.
:digvx: Also cross z-levels, digging stairs as needed. Alias for ``digv x``.
:digl: Like ``digv``, for layer stone. Also supports an ``undo`` option
to remove designations, for if you accidentally set 50 levels at once.
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
:dfhack-keybind:`digv`
.. note::
All commands implemented by the `dig` plugin (listed by ``ls dig``) support
specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``,
where ``#`` is a number from 1 to 7. If a priority is not specified, the
priority selected in-game is used as the default.

20
docs/plugins/digvx.rst
Unescape Escape View File

@ -1,20 +0,0 @@
dig
===
This plugin makes many automated or complicated dig patterns easy.
Basic commands:
:digv: Designate all of the selected vein for digging.
:digvx: Also cross z-levels, digging stairs as needed. Alias for ``digv x``.
:digl: Like ``digv``, for layer stone. Also supports an ``undo`` option
to remove designations, for if you accidentally set 50 levels at once.
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
:dfhack-keybind:`digv`
.. note::
All commands implemented by the `dig` plugin (listed by ``ls dig``) support
specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``,
where ``#`` is a number from 1 to 7. If a priority is not specified, the
priority selected in-game is used as the default.