update formatting for plugin docs

develop
myk002 2022-07-19 23:11:02 -07:00
parent 954e246140
commit 1cad77601e
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
19 changed files with 85 additions and 14 deletions

@ -1,6 +1,9 @@
3dveins 3dveins
======= =======
Tags:
:dfhack-keybind:`3dveins`
Rewrites layer veins to expand in 3D space. Existing, flat veins are removed 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. and new 3D veins that naturally span z-levels are generated in their place.
The transformation preserves the mineral counts reported by `prospect`. The transformation preserves the mineral counts reported by `prospect`.
@ -11,7 +14,8 @@ Usage::
The ``verbose`` option prints out extra information to the console. The ``verbose`` option prints out extra information to the console.
Example:: Example
-------
3dveins 3dveins

@ -1,6 +1,9 @@
add-spatter add-spatter
=========== ===========
Tags:
:dfhack-keybind:`add-spatter`
Make tagged reactions produce contaminants. The plugin is intended to give some 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 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 enables itself when you load a world with reactions that include names starting

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

@ -1,6 +1,9 @@
autoclothing autoclothing
============ ============
Tags:
:dfhack-keybind:`autoclothing`
Automatically manage clothing work orders. It allows you to set how many of each Automatically manage clothing work orders. It allows you to set how many of each
clothing type every citizen should have. clothing type every citizen should have.
@ -15,7 +18,8 @@ anything your civilization can produce, such as "dress" or "mitten".
When invoked without a number, it shows the current configuration for that When invoked without a number, it shows the current configuration for that
material and item. material and item.
Examples: Examples
--------
* ``autoclothing cloth "short skirt" 10``: * ``autoclothing cloth "short skirt" 10``:
Sets the desired number of cloth short skirts available per citizen to 10. Sets the desired number of cloth short skirts available per citizen to 10.

@ -1,6 +1,9 @@
autodump-destroy-here autodump-destroy-here
===================== =====================
Tags:
:dfhack-keybind:`autodump-destroy-here`
Destroy items marked for dumping under cursor. If called again before the game 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 is resumed, cancels destruction of the items. This is an alias for the
`autodump` command ``autodump destroy-here``, intended for use as a keybinding. `autodump` command ``autodump destroy-here``, intended for use as a keybinding.

@ -1,6 +1,9 @@
autodump-destroy-item 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 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 the container item list. If called again before the game is resumed, cancels
destruction of the item. destruction of the item.

@ -1,6 +1,9 @@
autodump autodump
======== ========
Tags:
:dfhack-keybind:`autodump`
Quickly designate or teleport items to be dumped. When `enabled <enable>`, this 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`` 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 option is selected for the stockpile, any items placed in the stockpile will
@ -19,7 +22,8 @@ Usage::
enable autodump enable autodump
autodump [<options>] autodump [<options>]
Options: Options
-------
- ``destroy`` - ``destroy``
Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is
@ -35,7 +39,8 @@ Options:
- ``forbidden`` - ``forbidden``
Only process forbidden items (default: only unforbidden). Only process forbidden items (default: only unforbidden).
Examples: Examples
--------
- ``autodump`` - ``autodump``
Teleports all unforbidden items marked for dumping to the cursor position. Teleports all unforbidden items marked for dumping to the cursor position.

@ -1,6 +1,9 @@
autofarm autofarm
======== ========
Tags:
:dfhack-keybind:`autofarm`
Automatically manage farm crop selection. This plugin periodically scans your Automatically manage farm crop selection. This plugin periodically scans your
plant stocks and assigns crops to your farm plots based on which plant stocks 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 are low (as long as you have the appropriate seeds). The target threshold for
@ -24,7 +27,8 @@ following command::
lua "for _,plant in ipairs(df.global.world.raws.plants.all) do if plant.flags.SEED then print(plant.id) end end" lua "for _,plant in ipairs(df.global.world.raws.plants.all) do if plant.flags.SEED then print(plant.id) end end"
Examples: Examples
--------
- ``autofarm default 30`` - ``autofarm default 30``
Set the default threshold to 30. Set the default threshold to 30.

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

@ -1,6 +1,9 @@
autogems autogems
======== ========
Tags:
:dfhack-keybind:`autogems`
Automatically cut rough gems. This plugin periodically scans your stocks of 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. rough gems and creates manager orders for cutting them at a Jeweler's Workshop.

@ -1,6 +1,9 @@
autohauler autohauler
========== ==========
Tags:
:dfhack-keybind:`autohauler`
Automatically manage hauling labors. Similar to `autolabor`, but instead of Automatically manage hauling labors. Similar to `autolabor`, but instead of
managing all labors, ``autohauler`` only addresses hauling labors, leaving the managing all labors, ``autohauler`` only addresses hauling labors, leaving the
assignment of skilled labors entirely up to you. You can use the in-game assignment of skilled labors entirely up to you. You can use the in-game
@ -40,7 +43,8 @@ Usage:
- ``autohauler debug`` - ``autohauler debug``
In the next cycle, output the state of every dwarf. In the next cycle, output the state of every dwarf.
Examples: Examples
--------
- ``autohauler HAUL_STONE haulers`` - ``autohauler HAUL_STONE haulers``
Set stone hauling as a hauling labor (this is already the default). Set stone hauling as a hauling labor (this is already the default).

@ -1,6 +1,9 @@
autolabor autolabor
========= =========
Tags:
:dfhack-keybind:`autolabor`
Automatically manage dwarf labors. Autolabor attempts to keep as many dwarves as Automatically manage dwarf labors. Autolabor attempts to keep as many dwarves as
possible busy while allowing dwarves to specialize in specific skills. possible busy while allowing dwarves to specialize in specific skills.
@ -49,7 +52,8 @@ dwarfs that meet any of these conditions:
We stop assigning dwarves when we reach the maximum allowed. We stop assigning dwarves when we reach the maximum allowed.
Advanced usage: Advanced usage
--------------
- ``autolabor <labor> <minimum> [<maximum>] [<talent pool>]`` - ``autolabor <labor> <minimum> [<maximum>] [<talent pool>]``
Set range of dwarves assigned to a labor, optionally specifying the size of Set range of dwarves assigned to a labor, optionally specifying the size of
@ -68,7 +72,8 @@ Advanced usage:
See `autolabor-artisans` for a differently-tuned setup. See `autolabor-artisans` for a differently-tuned setup.
Examples: Examples
--------
- ``autolabor MINE 5`` - ``autolabor MINE 5``
Keep at least 5 dwarves with mining enabled. Keep at least 5 dwarves with mining enabled.

@ -1,6 +1,9 @@
automaterial automaterial
============ ============
Tags:
:dfhack-keybind:`automaterial`
Sorts building materials by recent usage. This makes building constructions Sorts building materials by recent usage. This makes building constructions
(walls, floors, fortifications, etc) much easier by saving you from having to (walls, floors, fortifications, etc) much easier by saving you from having to
trawl through long lists of materials each time you place one. trawl through long lists of materials each time you place one.

@ -1,6 +1,9 @@
automelt automelt
======== ========
Tags:
:dfhack-keybind:`automelt`
Quickly designate items to be melted. When `enabled <enable>`, this plugin adds 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 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 selected for the stockpile, any items placed in the stockpile will automatically

@ -1,6 +1,9 @@
autotrade autotrade
========= =========
Tags:
:dfhack-keybind:`autotrade`
Quickly designate items to be traded. When `enabled <enable>`, this plugin adds 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 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 selected for the stockpile, any items placed in the stockpile will automatically

@ -1,6 +1,9 @@
blueprint blueprint
========= =========
Tags:
:dfhack-keybind:`blueprint`
Record a live game map in a quickfort blueprint. With ``blueprint``, you can 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 export the structure of a portion of your fortress in a blueprint file that you
(or anyone else) can later play back with `quickfort`. (or anyone else) can later play back with `quickfort`.
@ -16,7 +19,8 @@ Usage::
blueprint <width> <height> [<depth>] [<name> [<phases>]] [<options>] blueprint <width> <height> [<depth>] [<name> [<phases>]] [<options>]
blueprint gui [<name> [<phases>]] [<options>] blueprint gui [<name> [<phases>]] [<options>]
Examples: Examples
--------
- ``blueprint gui`` - ``blueprint gui``
Runs `gui/blueprint`, the interactive frontend, where all configuration for Runs `gui/blueprint`, the interactive frontend, where all configuration for
@ -30,7 +34,8 @@ Examples:
the start of the blueprint area is set to a specific value instead of using the start of the blueprint area is set to a specific value instead of using
the in-game cursor position. the in-game cursor position.
Positional Parameters: Positional parameters
---------------------
- ``width`` - ``width``
Width of the area (in tiles) to translate. Width of the area (in tiles) to translate.
@ -46,7 +51,8 @@ Positional Parameters:
some characters other than numbers so the name won't be confused with the some characters other than numbers so the name won't be confused with the
optional ``depth`` parameter. optional ``depth`` parameter.
Phases: Phases
------
If you want to generate blueprints only for specific phases, add their names to If you want to generate blueprints only for specific phases, add their names to
the commandline, anywhere after the blueprint base name. You can list multiple the commandline, anywhere after the blueprint base name. You can list multiple
@ -68,7 +74,8 @@ phases; just separate them with a space.
If no phases are specified, phases are autodetected. For example, a ``#place`` If no phases are specified, phases are autodetected. For example, a ``#place``
blueprint will be created only if there are stockpiles in the blueprint area. blueprint will be created only if there are stockpiles in the blueprint area.
Options: Options
-------
- ``-c``, ``--cursor <x>,<y>,<z>`` - ``-c``, ``--cursor <x>,<y>,<z>``
Use the specified map coordinates instead of the current cursor position for Use the specified map coordinates instead of the current cursor position for
@ -98,7 +105,8 @@ Options:
"none", which will create a standard quickfort "none", which will create a standard quickfort
`multi-blueprint <quickfort-packaging>` file. `multi-blueprint <quickfort-packaging>` file.
Output formats: Output formats
--------------
Here are the values that can be passed to the ``--format`` flag: Here are the values that can be passed to the ``--format`` flag:
@ -109,7 +117,8 @@ Here are the values that can be passed to the ``--format`` flag:
Makes the blueprints in the ``.csv`` files easier to read and edit with a Makes the blueprints in the ``.csv`` files easier to read and edit with a
text editor by adding extra spacing and alignment markers. text editor by adding extra spacing and alignment markers.
Splitting output into multiple files: Splitting output into multiple files
------------------------------------
The ``--splitby`` flag can take any of the following values: The ``--splitby`` flag can take any of the following values:

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

@ -1,6 +1,9 @@
buildingplan buildingplan
============ ============
Tags:
:dfhack-keybind:`buildingplan`
Plan building construction before you have materials. This plugin adds a Plan building construction before you have materials. This plugin adds a
planning mode for building placement. You can then place furniture, planning mode for building placement. You can then place furniture,
constructions, and other buildings before the required materials are available, constructions, and other buildings before the required materials are available,

@ -1,6 +1,9 @@
burrows burrows
======= =======
Tags:
:dfhack-keybind:`burrows`
Quick commands for burrow control. Allows manipulating burrows and automated Quick commands for burrow control. Allows manipulating burrows and automated
burrow expansion while digging. burrow expansion while digging.