Commands List
This list provides an alphabetic summary of all the commands specific to protograf.
Remember that using certain commands with a lowercase initial defers their activation to later in the script!
This list is not intended to be used for learning, but just provides a handy cross-reference to the detailed information for that command.
Hint
protograf is a small, specialised tool; but its part of a much greater Python language “ecosystem”, and so commands and tools from the Python language — or other Python packages — can be used to further enhance your own script.
Arc * - a geometric shape that can be drawn on a page
Arrow * - a geometric shape that can be drawn on a page
Blueprint - a grid of lines that can be drawn on a page (see also further customisation options)
Bezier * - a geometric shape that can be drawn on a page
BGG - access boardgame data from BGG (typically for display on one or more cards)
Circle * - a geometric shape that can be drawn on a page (see also further customisation options)
Chord * - a geometric shape that can be drawn on a page
Common - set the properties that will be exactly the same for any shape using them (see also Default)
Counter - details for a counter that is part of a countersheet
countersheet - details for a countersheet, containing one or more counters
Create - start of a script; define the paper size, output filename, margins, units, fill color etc.
Cross * - a geometric shape that can be drawn on a page
Cube * - create isometric and shaded view of a cube
Data - provides a set of information for a deck of cards countersheet - typically sourced from a CSV or Excel file, or a Google Sheet
D6 * - create top-down view of a six-sided die
Default - set the properties that can be used by any number of shapes and overridden by them (see also Common)
DiamondLocations- defines an ordered series of row and column locations that create a diamond grid of shapes - the grid itself is not displayed; it is used in a Layout command
Domino * - create top-down view of a domino
Dot * - a geometric shape that can be drawn on a page
DotGrid - a set, or group, of dots that can be drawn on a page
Ellipse * - a geometric shape that can be drawn on a page
Extract - allows portions of pages to be extracted as PNG images
IconFont - set the font properties for any referenced Unicode symbols embedded in subsequent Text
Grid - a set, or group, of lines that can be drawn on a page
group - a way to reference a stack of shapes that all need to be drawn together on a card
Hexagon * - a geometric shape that can be drawn on a page (see also further customisation options)
Hexagons - a set, or group, of hexagons that can be drawn on a page (see also hexagonal grids)
Image - an external image to be shown on a page or card
L - short for Lookup; a way to access data in a set from another card in a deck
Layout - used in conjuction with a location-based grid and specifies the shapes that are to be drawn at that grid’s locations
Line * - a geometric shape that can be drawn on a page
Lines - a set, or group, of lines that can be drawn on a page
LinkLine - a line joining one or more hexagons inside a hexagonal grid
Load - at the start of a script; define an existing PDF file to be loaded
Matrix - a way to create a set of data, inside a script, for use in a deck of cards
PageBreak - set the start of a new page in the document; not required for a Deck
Pentomino * - a compound shape made up of five squares
Pod * - a geometric shape that can be drawn on a page
Point - a command to set both x- and y- values for a position
Polygon * - a geometric shape that can be drawn on a page
Polyline * - a geometric shape that can be drawn on a page
Polyomino * - a compound shape made up of one or more squares
Polyshape * - an irregular geometric shape that can be drawn on a page
Random - generate a random number within a range
Repeat - repeat the drawing of a shape across a rectangular grid pattern
Rectangle * - a geometric shape that can be drawn on a page (see also further customisation options)
Rectangles - a set, or group, of rectangles that can be drawn on a page
RectangularLocations - defines an ordered series of row and column locations that create a rectangular grid of shapes - the grid itself is not displayed; it is used in a Layout command.
Rhombus * - a geometric shape that can be drawn on a page
S - short for Selection; the way to draw a shape on a card depending on a condition
Save - end of a script; set the export image file type and filenames, as well as resolution
Sector * - a geometric shape that can be drawn on a page
Sequence - lay out a number of items in a straight line
Square * - a geometric shape that can be drawn on a page
Stadium * - a geometric shape that can be drawn on a page
Star * - a geometric shape that can be drawn on a page
Starfield - a set, or group, of dots that can be drawn on a page
T - short for Template; the way to access an item in a column from a set of data for a card
Table - a grid of rectangles that can be drawn on a page and used to display Text or Images
Tetromino * - a compound shape made up of four squares
Text * - a shape containing text that can be displayed on a page
Today - display - as text - the current date and time
Track - draw any number of shapes at the vertices of another shape
Trapezoid * - a geometric shape that can be drawn on a page
Triangle * - a geometric shape that can be drawn on a page
TriangularLocations- defines an ordered series of row and column locations that create a triangular grid of shapes - the grid itself is not displayed; it is used in a Layout command
Important
Commands marked with an asterisk (*) can be given with a uppercase or
lowercase initial (Commmand vs command); the former meaning that
the shape should be drawn directly at that point in the script; and the
latter that it should be “stored” to be drawn later. This is especially
relevant when specifying card designs.