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

ensure all plugins are indexed

develop
myk002 2022-07-22 10:14:50 -07:00
parent 3175e8b33d
commit d637c87496
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
10 changed files with 42 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,8 +4,8 @@
Tags:
:dfhack-keybind:`3dveins`
:index:`Rewrites layer veins to expand in 3D space.
<3dveins; Rewrites layer veins to expand in 3D space.>` Existing, flat veins
:index:`Rewrite layer veins to expand in 3D space.
<3dveins; Rewrite 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`.
@ -19,6 +19,8 @@ The ``verbose`` option prints out extra information to the console.
Example
-------
::
3dveins
New veins are generated using 3D Perlin noise in order to produce a layout that

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

@ -3,9 +3,10 @@ add-spatter
Tags:
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
enables itself when you load a world with reactions that include names starting
with ``SPATTER_ADD_``. These reactions will then produce contaminants on items
:index:`Make tagged reactions produce contaminants.
<add-spatter; Make tagged reactions produce contaminants.>` Give some use to all
those poisons that can be bought from caravans! The plugin automatically enables
itself when you load a world with reactions that include names starting with
``SPATTER_ADD_``. These reactions will then produce contaminants on items
instead of improvements. The contaminants are immune to being washed away by
water or destroyed by `clean`.

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

@ -3,8 +3,9 @@ autochop
Tags:
Auto-harvest trees when low on stockpiled logs. This plugin can designate trees
for chopping when your stocks are low on logs.
:index:`Auto-harvest trees when low on stockpiled logs.
<autochop; Auto-harvest trees when low on stockpiled logs.>` This plugin can
designate trees for chopping when your stocks are low on logs.
Usage::

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

@ -6,10 +6,11 @@ Tags:
:dfhack-keybind:`autodump-destroy-here`
:dfhack-keybind:`autodump-destroy-item`
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.
:index:`Automatically set items in a stockpile to be dumped.
<autodump (plugin); 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 unforbidden items marked
for dumping to the tile under the cursor. After moving the items, the dump flag

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

@ -4,8 +4,9 @@ autogems
Tags:
: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.
:index:`Automatically cut rough gems. <autogems; 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:

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

@ -3,9 +3,10 @@ automaterial
Tags:
Sorts building materials by recent usage. This makes building constructions
(walls, floors, fortifications, etc) much easier by saving you from having to
trawl through long lists of materials each time you place one.
:index:`Sorts building materials by recent usage.
<automaterial>; Sorts building materials by recent usage.>` This makes building
constructions (walls, floors, fortifications, etc) much easier by saving you
from having to trawl through long lists of materials each time you place one.
It moves the last used material for a given construction type to the top of the
list, if there are any left. So if you build a wall with chalk blocks, the next

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

@ -3,10 +3,11 @@ automelt
Tags:
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
selected for the stockpile, any items placed in the stockpile will automatically
be designated to be melted.
:index:`Quickly designate items to be melted.
<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 selected for the stockpile, any items placed in the stockpile will
automatically be designated to be melted.
Usage::

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

@ -3,10 +3,11 @@ autotrade
Tags:
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
selected for the stockpile, any items placed in the stockpile will automatically
be designated to be traded.
:index:`Quickly designate items to be traded.
<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 selected for the stockpile, any items placed in the
stockpile will automatically be designated to be traded.
Usage::

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

@ -3,7 +3,8 @@ building-hacks
Tags:
Allows mods to create and manage powered workshops.
:index:`Allows mods to create and manage powered workshops.
<building-hacks; Allows mods to create and manage powered workshops.>`
Usage::

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

@ -4,13 +4,14 @@ burrows
Tags:
: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.
: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.
:index:`quickly add units/tiles to burrows.
<burrow; Quickly add units/tiles to burrows.>`
Usage: