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

update docs

develop
myk002 2021-09-11 23:17:41 -07:00 committed by Myk
parent 2bbd4ab79e
commit 413917e9c6
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Plugins.rst
Unescape Escape View File

@ -100,6 +100,10 @@ Options:
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.
:``-f``, ``--format <format>``:
Select the output format of the generated files. See the ``Output Formats``
section below for options. If not specified, the output format defaults to
"minimal", which will produce a small, fast ``.csv`` file.
:``-h``, ``--help``: :``-h``, ``--help``:
Show command help text. Show command help text.
:``-t``, ``--splitby <strategy>``: :``-t``, ``--splitby <strategy>``:
@ -108,6 +112,17 @@ 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:
Here are the values that can be passed to the ``--format`` flag:
:minimal:
Creates ``.csv`` files with minimal file size that are fast to read and
write. This is the default.
:pretty:
Makes the blueprints in the ``.csv`` files easier to read and edit with a 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: