From 413917e9c669ad099e45458d37bb0308f77359f3 Mon Sep 17 00:00:00 2001 From: myk002 Date: Sat, 11 Sep 2021 23:17:41 -0700 Subject: [PATCH] update docs --- docs/Plugins.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 89cf0ec18..4f9f12e2d 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -100,6 +100,10 @@ Options: 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, then an active game map cursor is not necessary. +:``-f``, ``--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``: Show command help text. :``-t``, ``--splitby ``: @@ -108,6 +112,17 @@ Options: "none", which will create a standard quickfort `multi-blueprint ` 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: The ``--splitby`` flag can take any of the following values: