Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[blueprint] support multiple output file formats #1965

Merged
merged 7 commits into from
Sep 17, 2021
Merged

[blueprint] support multiple output file formats #1965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aac7df1
implement --format option for minimal and pretty
myk002 Sep 10, 2021
4fc0727
use const char *, not std::string for efficiency
myk002 Sep 10, 2021
c785baa
update unit tests
myk002 Sep 10, 2021
bf7405f
only run dig-now over the test area
myk002 Sep 10, 2021
f6eabc3
use vector instead of map for great memory savings
myk002 Sep 11, 2021
985f5d1
clean up, document
myk002 Sep 11, 2021
e4d3514
update docs
myk002 Sep 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/Plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <strategy>``:
Expand All @@ -108,6 +112,17 @@ Options:
"none", which will create a standard quickfort
`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:

The ``--splitby`` flag can take any of the following values:
Expand Down