-
Notifications
You must be signed in to change notification settings - Fork 129
Documentation (Script Options)
Peter edited this page Aug 10, 2018
·
21 revisions
usage: dominion_dividers [-h] [--outfile OUTFILE] [--papersize PAPERSIZE]
[--language {nl_du,en_us,it,cz,de,fr}]
[--orientation {horizontal,vertical}] [--size SIZE]
[--sleeved] [--order {expansion,global,colour,cost}]
[--front {card,rules,blank}]
[--back {card,rules,blank,none}] [--count] [--types]
[--tab-side {left,right,left-alternate,right-alternate,centre,full}]
[--tab-name-align {left,right,centre,edge,center}]
[--tabwidth TABWIDTH] [--cost {tab,body-top,hide}]
[--set-icon {tab,body-top,hide}] [--no-tab-artwork]
[--use-text-set-icon] [--expansion-dividers]
[--centre-expansion-dividers]
[--expansion-dividers-long-name]
[--expansions [EXPANSIONS [EXPANSIONS ...]]]
[--fan [FAN [FAN ...]]] [--edition {1,2,latest,all}]
[--upgrade-with-expansion]
[--base-cards-with-expansion] [--special-card-groups]
[--no-trash] [--curse10] [--start-decks]
[--include-blanks] [--exclude-events]
[--exclude-landmarks] [--wrapper]
[--thickness THICKNESS] [--sleeved-thick]
[--sleeved-thin] [--notch-length NOTCH_LENGTH]
[--notch] [--minmargin MINMARGIN] [--cropmarks]
[--linewidth LINEWIDTH] [--back-offset BACK_OFFSET]
[--back-offset-height BACK_OFFSET_HEIGHT]
[--vertical-gap VERTICAL_GAP]
[--horizontal-gap HORIZONTAL_GAP] [--no-page-footer]
[--num-pages NUM_PAGES] [--tabs-only] [--info]
[--info-all] [--preview]
[--preview-resolution PREVIEW_RESOLUTION]
[--cardlist CARDLIST] [--write-json]
Generate Dominion Dividers
optional arguments:
-h, --help show this help message and exit
Basic Divider Options:
Basic choices for the dividers.
--outfile OUTFILE, -o OUTFILE
The output file name. (default: dominion_dividers.pdf)
--papersize PAPERSIZE
The size of paper to use; '<%f>x<%f>' (size in cm), or
'A4', or 'LETTER'. If not specified, it will default
to system defaults, and if the system defaults are not
found, then to 'LETTER'. (default: None)
--language {nl_du,en_us,it,cz,de,fr}, -l {nl_du,en_us,it,cz,de,fr}
Language of divider text. (default: en_us)
--orientation {horizontal,vertical}
Either horizontal or vertical divider orientation.
(default: horizontal)
--size SIZE Dimentions of the cards to use with the dividers
'<%f>x<%f>' (size in cm), or 'normal' = '9.1x5.9', or
'sleeved' = '9.4x6.15'. (default: normal)
--sleeved Same as --size=sleeved. (default: False)
--order {expansion,global,colour,cost}
Sort order for the dividers: 'global' will sort by
card name; 'expansion' will sort by expansion, then
card name; 'colour' will sort by card type, then card
name; 'cost' will sort by expansion, then card cost,
then name. (default: expansion)
Divider Body:
Changes what is displayed on the body of the dividers.
--front {card,rules,blank}
Text to print on the front of the divider; 'card' will
print the text from the game card; 'rules' will print
additional rules for the game card; 'blank' will not
print text on the divider. (default: card)
--back {card,rules,blank,none}
Text to print on the back of the divider; 'card' will
print the text from the game card; 'rules' will print
additional rules for the game card; 'blank' will not
print text on the divider; 'none' will prevent the
back pages from printing. (default: rules)
--count Display the card count on the body of card dividers
and the randomizer count on the body of expansion
dividers. (default: False)
--types Display card type on the body of the divider.
(default: False)
Divider Tab:
Changes what is displayed on on the Divider Tab.
--tab-side {left,right,left-alternate,right-alternate,centre,full}
Alignment of tab; 'left'/'right' forces all tabs to
left/right side; 'left-alternate' will start on the
left and then toggle between left and right for the
tabs; 'right-alternate' will start on the right and
then toggle between right and left for the tabs;
'centre' will force all label tabs to the centre;
'full' will force all label tabs to be full width of
the divider. (default: right-alternate)
--tab-name-align {left,right,centre,edge,center}
Alignment of text on the tab; The 'edge' option will
align the card name to the outside edge of the tab, so
that when using tabs on alternating sides, the name is
less likely to be hidden by the tab in front (edge
will revert to left when tab_side is full since there
is no edge in that case). (default: left)
--tabwidth TABWIDTH Width in cm of stick-up tab (ignored if --tab_side is
'full' or --tabs_only is used). (default: 4.0)
--cost {tab,body-top,hide}
Where to display the card cost; may be set to 'hide'
to indicate it should not be displayed, or given
multiple times to show it in multiple places.
(default: ['tab'])
--set-icon {tab,body-top,hide}
Where to display the set icon; may be set to 'hide' to
indicate it should not be displayed, or given multiple
times to show it in multiple places. (default:
['tab'])
--no-tab-artwork Don't show background artwork on tabs. (default:
False)
--use-text-set-icon Use text/letters to represent a card's set instead of
the set icon. (default: False)
Expansion Dividers:
Adding separator dividers for each expansion.
--expansion-dividers Add dividers describing each expansion set. A list of
cards in the expansion will be shown on the front of
the divider. (default: False)
--centre-expansion-dividers
Centre the tabs on expansion dividers. (default:
False)
--expansion-dividers-long-name
Use the long name with edition information on the
expansion divider tab. Without this, the shorter
expansion name is used on the expansion divider tab.
(default: False)
Divider Selection:
What expansions are used, and grouping of dividers.
--expansions [EXPANSIONS [EXPANSIONS ...]], --expansion [EXPANSIONS [EXPANSIONS ...]]
Limit dividers to only the specified expansions. If no
limits are set, then all expansions are included.
Expansion names can also be given in the language
specified by the --language parameter. Any expansion
with a space in the name must be enclosed in double
quotes. This may be called multiple times. Values are
not case sensitive. Wildcards may be used: '*' any
number of characters, '?' matches any single
character, '[seq]' matches any character in seq, and
'[!seq]' matches any character not in seq. For
example, 'dominion*' will match all expansions that
start with 'dominion'. Choices available in all
languages include: adventures, alchemy, base,
cornucopia, dark ages, dominion1stEdition,
dominion2ndEdition, dominion2ndEditionUpgrade,
empires, guilds, hinterlands, intrigue1stEdition,
intrigue2ndEdition, intrigue2ndEditionUpgrade, promo,
prosperity, seaside, nocturne (default: None)
--fan [FAN [FAN ...]]
Add dividers from the specified fan made expansions.
If this option is not used, no fan expansions will be
included. Fan made expansion names can also be given
in the language specified by the --language parameter.
Any fan expansion with a space in the name must be
enclosed in double quotes. This may be called multiple
times. Values are not case sensitive. Wildcards may be
used: '*' any number of characters, '?' matches any
single character, '[seq]' matches any character in
seq, and '[!seq]' matches any character not in seq.
Choices available in all languages include: animals
(default: None)
--edition {1,2,latest,all}
Editions to include: '1' is for all 1st Editions; '2'
is for all 2nd Editions; 'latest' is for the latest
edition for each expansion; 'all' is for all editions
of expansions; This can be combined with other options
to refine the expansions to include in the output.
(default: all)
--upgrade-with-expansion
Include any new edition upgrade cards with the
expansion being upgraded. (default: False)
--base-cards-with-expansion
Print the base cards as part of the expansion (i.e., a
divider for 'Silver' will be printed as both a
'Dominion' card and as an 'Intrigue 1st Edition'
card). If this option is not given, all base cards are
placed in their own 'Base' expansion. (default: False)
--special-card-groups
Group cards that generally are used together (e.g.,
Shelters, Tournament and Prizes, Urchin/Mercenary,
etc.). (default: False)
--no-trash Exclude Trash from cards. (default: False)
--curse10 Package Curse cards into groups of ten cards.
(default: False)
--start-decks Include four start decks with the Base cards.
(default: False)
--include-blanks Include a few dividers with extra text. (default:
False)
--exclude-events Group all 'Event' cards across all expansions into one
divider. (default: False)
--exclude-landmarks Group all 'Landmark' cards across all expansions into
one divider. (default: False)
Card Sleeves/Wrappers:
Generating dividers that are card sleeves/wrappers.
--wrapper Draw sleeves (aka wrapper) for the cards instead of a
divider for the cards. (default: False)
--thickness THICKNESS
Thickness of a stack of 60 cards (Copper) in
centimeters. Typically unsleeved cards are 2.0, thin
sleeved cards are 2.4, and thick sleeved cards are
3.2. This is only valid with the --wrapper option.
(default: 2.0)
--sleeved-thick Same as --size=sleeved --thickness 3.2. (default:
False)
--sleeved-thin Same as --size=sleeved --thickness 2.4. (default:
False)
--notch-length NOTCH_LENGTH
Length of thumb notch on wrapper in centimeters (a
value of 0.0 means no notch on wrapper). This can make
it easier to remove the actual cards from the wrapper.
This is only valid with the --wrapper option.
(default: 0.0)
--notch Same as --notch_length thickness 1.5. (default: False)
Printing:
Changes how the Dividers are printed.
--minmargin MINMARGIN
Page margin in cm in the form '<%f>x<%f>', left/right
x top/bottom). (default: 1x1)
--cropmarks Print crop marks on both sides, rather than tab
outlines on the front side. (default: False)
--linewidth LINEWIDTH
Width of lines for card outlines and crop marks.
(default: 0.1)
--back-offset BACK_OFFSET
Back page horizontal offset points to shift to the
right. Only needed for some printers. (default: 0)
--back-offset-height BACK_OFFSET_HEIGHT
Back page vertical offset points to shift upward. Only
needed for some printers. (default: 0)
--vertical-gap VERTICAL_GAP
Vertical gap between dividers in centimeters.
(default: 0.0)
--horizontal-gap HORIZONTAL_GAP
Horizontal gap between dividers in centimeters.
(default: 0.0)
--no-page-footer Do not print the expansion name at the bottom of the
page. (default: False)
--num-pages NUM_PAGES
Stop generating dividers after this many pages, -1 for
all. (default: -1)
--tabs-only Draw only the divider tabs and no divider outlines.
Used to print the divider tabs on labels. (default:
False)
--info Add a page that has all the options used for the file.
(default: False)
--info-all Same as --info, but includes pages with all the
possible options that can be used. (default: False)
--preview Only generate a preview png image of the first page
(default: False)
--preview-resolution PREVIEW_RESOLUTION
resolution in DPI to render preview at, for --preview
option (default: 150)
Miscellaneous:
These options are generally not used.
--cardlist CARDLIST Path to file that enumerates each card to be printed
on its own line. (default: None)
--write-json Write json version of card definitions and extras.
(default: False)
Source can be found at 'https://github.com/sumpfork/dominiontabs'. An online
version can be found at 'http://domtabs.sandflea.org/'.