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

Document new blueprint phases and options

develop
Myk 2022-04-01 20:35:17 -07:00
parent 34520e7f01
commit 189da79d10
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Plugins.rst
Unescape Escape View File

@ -60,13 +60,12 @@ requested width and height.
``blueprint 30 40 bedrooms`` ``blueprint 30 40 bedrooms``
Generates blueprints for an area 30 tiles wide by 40 tiles tall, starting Generates blueprints for an area 30 tiles wide by 40 tiles tall, starting
from the active cursor on the current z-level. Output is written to files from the active cursor on the current z-level. Blueprints are written
with names matching the pattern ``bedrooms-PHASE.csv`` in the ``blueprints`` sequentially to ``bedrooms.csv`` in the ``blueprints`` directory.
directory.
``blueprint 30 40 bedrooms dig --cursor 108,100,150`` ``blueprint 30 40 bedrooms dig --cursor 108,100,150``
Generates only the ``bedrooms-dig.csv`` file from the previous example, and Generates only the ``#dig`` blueprint in the ``bedrooms.csv`` file, and
the blueprint start coordinate 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:**
@ -87,13 +86,16 @@ 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
phases; just separate them with a space. phases; just separate them with a space.
:``dig``: Generate quickfort ``#dig`` blueprints. :``dig``: Generate quickfort ``#dig`` blueprints for digging natural stone.
:``carve``: Generate quickfort ``#dig`` blueprints for smoothing and carving.
:``build``: Generate quickfort ``#build`` blueprints for constructions and :``build``: Generate quickfort ``#build`` blueprints for constructions and
buildings. buildings.
:``place``: Generate quickfort ``#place`` blueprints for placing stockpiles. :``place``: Generate quickfort ``#place`` blueprints for placing stockpiles.
:``zone``: Generate quickfort ``#zone`` blueprints for designating zones.
:``query``: Generate quickfort ``#query`` blueprints for configuring rooms. :``query``: Generate quickfort ``#query`` blueprints for configuring rooms.
If no phases are specified, all blueprints are created. 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.
**Options:** **Options:**
@ -101,6 +103,9 @@ If no phases are specified, all blueprints are created.
Use the specified map coordinates instead of the current cursor position for Use the specified map coordinates instead of the current cursor position for
the upper left corner of the blueprint range. If this option is specified, the upper left corner of the blueprint range. If this option is specified,
then an active game map cursor is not necessary. then an active game map cursor is not necessary.
``-e``, ``--engrave``:
Record engravings in the ``carve`` phase. If this option is not specified,
engravings are ignored.
``-f``, ``--format <format>``: ``-f``, ``--format <format>``:
Select the output format of the generated files. See the ``Output formats`` Select the output format of the generated files. See the ``Output formats``
section below for options. If not specified, the output format defaults to section below for options. If not specified, the output format defaults to