All keys, A to Z#

Every key a document can write, in a panel, a scene, an artwork contract or a puppet file, with the line its card opens on – the same one an editor shows on hover – and the release it appeared in. A name in angle brackets is the author’s: cast.<id>.pose is pose under any cast member.

Key

In

What it is

Since

anchors

puppet

Named attachment points, such as mouth and eyes, each on a joint.

0.13

anchors.<anchor>.joint

puppet

The joint it rides along with.

0.13

anchors.<anchor>.offset

puppet

Where it is from that joint, in the puppet’s own units, before posing.

0.13

camera

panel, scene

How the cast is framed: the shot, and the camera’s height.

0.1

camera.angle

panel, scene

The camera’s height: low looks up, leaving little air above the head; high looks down, leaving more.

0.1

camera.shot

panel, scene

How tightly the camera frames the cast, named by where the frame cuts the body, from long_shot to extreme_close_up. The tightest it may go: the camera steps back when the cast does not fit.

0.1

caption

panel, scene

A caption: a box in which the panel speaks in its own voice, with no tail.

0.4

caption.by

panel, scene

Who is speaking, for a spoken caption only: any name, in the cast or not.

0.4

caption.kind

panel, scene

What the box is doing: locale for a place and time, monologue for an inner voice, spoken for speech from off panel, editorial for the writer’s voice.

0.4

caption.prefer

panel, scene

Where the box would like to sit, one of nine zones of the panel. Left out, where reading starts: top_left, or top_right read right to left.

0.4

caption.text

panel, scene

What the box says, as one string; line breaks are computed. A word between underscores, _word_, is stressed.

0.4

caption.tone

panel, scene

What the box is filled with: paper, pale, ink, which is lettered in paper, or warm, yellow under palette: tinted.

0.6

cast

panel, scene

Who is in the panel: each actor id, chosen by the author, and the puppet that plays them or the figure a picture draws. Their order means nothing.

0.1

cast.<id>.at

panel, scene

Where along the panel’s width the figure would like to stand. A preference: non-overlap and left_of override it.

0.1

cast.<id>.expression

panel, scene

An expression the puppet declares, by name.

0.5

cast.<id>.facing

panel, scene

Which way the figure is turned, left or right, gaze and all.

0.1

cast.<id>.figure

panel, scene

A figure the panel’s picture draws, by the name its artwork contract gives it. Written instead of reference, and with none of the keys that pose or place a puppet.

0.12

cast.<id>.marks

panel, scene

Emanata drawn around the character – plewds, squeans, grawlixes, briffits – in any order, each once. They compose with the expression.

0.8

cast.<id>.pose

panel, scene

A pose the puppet declares, by name.

0.1

cast.<id>.reference

panel, scene

The puppet to draw: a shipped puppet’s name, or the path of a .puppet.yaml file, relative to the document. Written instead of figure.

0.1

columns[].panels

scene

The panels in the column, read top to bottom.

0.10

columns[].panels[].height

scene

The panel’s share of its column’s height, relative to the others in it.

0.10

columns[].width

scene

The column’s share of its tier’s width, relative to the other columns.

0.10

description

panel, scene

What the panel shows, in words, for a reader who cannot see it. Carried into the SVG as its accessible name and never interpreted. Not inherited: a panel drawn over: another is a different picture. Left out, one is generated from the shot, the setting and the cast.

0.12

direction

panel, scene

Which way the comic is read: ltr from the top left, rtl from the top right, as manga are – panels, pages and the balloons in a panel. Its progression, not its text: the words in a balloon still read left to right. Written once for the whole document; the scene is never mirrored.

0.12

expressions

puppet

Named expressions, each a state of brow, eyes and mouth.

0.13

expressions.<expression>.brow

puppet

The brows’ state.

0.13

expressions.<expression>.eyes

puppet

The eyes’ state.

0.13

expressions.<expression>.mouth

puppet

The mouth’s state.

0.13

face

puppet

Where the face is, and what is drawn in it.

0.13

face.features

puppet

What is drawn inside the face, by feature. Empty for a plain round head.

0.13

face.features.<feature>.joint

puppet

The joint the feature rides, practically always head.

0.13

face.features.<feature>.offset

puppet

Where the feature is from that joint, in the puppet’s own units, before posing.

0.13

face.features.<feature>.size

puppet

How big the feature is drawn, in the puppet’s own units: an eye’s radius, a brow’s or a mouth’s half-width, a nose’s length.

0.13

face.joint

puppet

The joint the face is centred on: the head, unless the puppet says otherwise.

0.13

face.offset

puppet

Where the face’s centre is from that joint, in the puppet’s own units.

0.13

face.radius

puppet

The face’s radius, in the puppet’s own units: the circle no balloon covers.

0.13

figures

artwork contract

Each figure the picture draws, by the name a cast member’s figure gives it. Every face here is kept clear of lettering, cast or not.

0.12

figures.<name>.body

artwork contract

The figure’s silhouette, a polygon in pixels, which a balloon pays to cover: half as much over its own speaker.

0.12

figures.<name>.face

artwork contract

The figure’s face: a disc no balloon, caption or sound effect may cover.

0.12

figures.<name>.face.center

artwork contract

The face’s centre, [x, y] in the picture’s pixels, from its top left.

0.12

figures.<name>.face.radius

artwork contract

How far the face reaches, in pixels. Generous is safer than tight: no lettering overlaps this disc, and a tail stops on its edge.

0.12

figures.<name>.mouth

artwork contract

Where the tail of a line the figure speaks ends, or the place a sound it makes comes from, in pixels. Left out, a tail aims at the face’s centre.

0.12

gaze

puppet

Where the puppet’s line of sight starts.

0.13

gaze.origin

puppet

The anchor the line of sight starts at, conventionally eyes. It must be declared.

0.13

insets[].at

scene

The corner of its parent the inset sits in, a gutter in from both edges.

0.10

insets[].read

scene

When the inset is read: after its parent, or before it.

0.10

insets[].size

scene

The inset’s width and height, as a fraction of its parent’s: above 0, at most 0.5.

0.10

insets[].use

scene

The name of a panel under panels:, set into this one.

0.10

joints

puppet

The skeleton, by joint name.

0.13

joints.<joint>.offset

puppet

Where it is from its parent in the rest pose, in the puppet’s own units.

0.13

joints.<joint>.parent

puppet

The joint it hangs from. Left out for the root.

0.13

keep_out

artwork contract

Regions lettering should stay off, each a polygon in pixels: a sign, a hand, what the panel is about. A cost, not a rule.

0.12

landmarks

puppet

Each vertical body landmark, as a distance down from the top of the head, in head units: the crop lines a shot type names.

0.13

landmarks.head_top

puppet

The origin every other landmark is measured down from.

0.13

lettering

panel, scene

How the lettering is set: the dialogue type size, and the font files.

0.11

lettering.font

panel, scene

The font files to letter in, relative to the document: one file for every face, or one for each. Left out, Source Sans Pro.

0.11

lettering.font.bold_italic

panel, scene

The font file a stressed word, _word_, is lettered in. Left out, it is italic, or regular when there is no italic, and a note says so.

0.11

lettering.font.display

panel, scene

The font file sound effects are lettered in. Left out, the shipped display face, Bangers, whatever the other faces are.

0.11

lettering.font.italic

panel, scene

The font file every caption but a spoken one is lettered in. Left out, they are set in regular.

0.11

lettering.font.regular

panel, scene

The font file dialogue and spoken captions are lettered in, relative to the document. Written alone, as font: fonts/Comic.ttf, it letters every face.

0.11

lettering.size

panel, scene

The dialogue type size, in panel units; captions keep 30 parts in 35 of it. Left out, 3.5% of the height the panel letters against: its own, or one tier of a three-tier page.

0.11

name

puppet

The name a cast member’s reference uses.

0.13

over

scene

Name of a panel to inherit from. Only the differences need stating: mappings merge recursively and lists replace.

0.1

page

scene

The format every page shares: its size, margin, gutters and bleed.

0.10

page.bleed

scene

How far the printed sheet runs past the trim on every side, so art that reaches the edge can be cut cleanly: 30 is 3 mm. Paper around the page; nothing on it moves.

0.13

page.gutter

scene

The gap between two panels, or two columns, side by side in a tier.

0.10

page.margin

scene

The blank border inside the page’s edge, on all four sides.

0.10

page.size

scene

The page’s width and height: the trim, the size the printed page is cut to, in the units a panel uses. Printed, a unit is a tenth of a millimetre.

0.10

page.tier_gutter

scene

The gap between two tiers, and between two panels stacked in a column. Wider than gutter, as in print, so a tier reads as one row.

0.10

pages

scene

The pages, in order, each a list of tiers top to bottom.

0.10

pages[].tiers

scene

The page’s tiers, top to bottom.

0.10

palette

panel, scene

What the panel is drawn in: mono, the value ladder in grey, or tinted, each value in a colour with the same lightness. Colour never changes a value, so a tinted panel is, in monochrome, the mono one. Inherited like any default; a panel may have its own.

0.13

panel

panel, scene

The panel’s frame: its size and margin, in panel units.

0.1

panel.margin

panel, scene

An inset on all four sides, in panel units. Balloons, captions and sound effects keep inside it; figures may run past it, as comics let them.

0.1

panel.size

panel, scene

The panel’s width and height, [width, height], in panel units: everything else is measured against them. Printed, a unit is a tenth of a millimetre.

0.1

panels

scene

Panels in reading order. Each may inherit from another with over.

0.1

panels[].bleed

scene

Run the frame past the trim to the bleed line, with no border there: true on every side that reaches the page’s margin, or a list of those sides.

0.13

panels[].insets

scene

Panels set into its corners, and drawn over it.

0.10

panels[].use

scene

The name of a panel under panels:. Writing the name alone means {use: name}.

0.10

panels[].width

scene

The panel’s share of its tier’s width, relative to its neighbours.

0.10

parts

puppet

The shapes the body is drawn from, back to front.

0.13

parts[].at

puppet

The joint it is centred on.

0.13

parts[].from

puppet

The joint the bone starts at.

0.13

parts[].offset

puppet

Where its centre is from that joint, in the puppet’s own units.

0.13

parts[].radius

puppet

Its radius, in the puppet’s own units.

0.13

parts[].to

puppet

The joint the bone ends at.

0.13

parts[].width

puppet

How thick it is drawn, in the puppet’s own units.

0.13

poses

puppet

Named poses, each a set of joint angles.

0.13

root

puppet

The joint every other one hangs from.

0.13

root_landmark

puppet

The landmark the root joint sits at.

0.13

say

panel, scene

A line of dialogue, in a balloon whose tail points at the speaker.

0.1

say.by

panel, scene

Who speaks: an actor id in the cast, whose mouth the tail points at. With off_panel, the name of somebody nobody draws.

0.1

say.kind

panel, scene

The balloon the line is carried in: speech, thought, whisper or shout.

0.1

say.off_panel

panel, scene

The speaker is outside the panel: true, or the side of the frame they are on. The tail ends on the frame there.

0.11

say.prefer

panel, scene

Where the balloon would like to sit, one of nine zones of the panel. The weakest placement term: face avoidance and reading order override it.

0.1

say.size

panel, scene

small for a line muttered, said under the breath or weakly: smaller type, in a balloon that keeps its room.

0.11

say.text

panel, scene

The line, as one string; the compiler breaks it into lines. A word between underscores, _word_, is stressed, and lettered in bold italic.

0.1

script

panel, scene

What is said and heard, in the order it is read: say for a balloon, caption for a box, sfx for a sound effect.

0.1

setting

panel, scene

Where and when the panel happens: a named place, tonal masses or a picture behind the cast, with the time of day and the weather.

0.6

setting.fit

panel, scene

How the picture fills the panel: cover fills it and crops what overhangs, equally on both sides; contain shows the whole picture. Left out, cover.

0.12

setting.horizon

panel, scene

Where the ground meets what is behind it, which every mass is composed against: high shows more ground, low less.

0.6

setting.image

panel, scene

A picture drawn elsewhere, behind the cast: a PNG or JPEG file, relative to the document. Only its size is read. Written instead of place and masses.

0.12

setting.masses

panel, scene

The backdrop as tonal masses, back to front: what a place expands into, written out. Write this, place or image, never two of them.

0.6

setting.masses[].kind

panel, scene

What the mass is made of, which decides its silhouette: seven outdoor kinds of stuff and five indoor.

0.6

setting.masses[].plane

panel, scene

How far back the mass sits, which decides its value and its draw order. A foreground mass is drawn over the cast.

0.6

setting.masses[].spans

panel, scene

How much of the panel’s width the mass covers: all of it, or its left, center or right part.

0.6

setting.place

panel, scene

A named place, which stands for the list of masses it expands into. Write this, masses or image, never two of them.

0.6

setting.time

panel, scene

When the panel happens, which sets the two ends of the value ladder: the foreground’s value and the atmosphere’s.

0.6

setting.weather

panel, scene

What the air is doing: fog veils the backdrop; rain and snow veil it as cloud, and fall over everything, the cast included.

0.6

sfx

panel, scene

A sound effect: letters lettered into the picture, with no balloon.

0.11

sfx.arc

panel, scene

How far the line of letters bends, in degrees, from -120 to 120: positive bows its middle up, negative down.

0.11

sfx.from

panel, scene

Written from: the actor id the sound comes from, which it is placed near.

0.11

sfx.hollow

panel, scene

true letters the effect as an outline with no fill, so the art shows through: an open effect.

0.11

sfx.prefer

panel, scene

Where the effect would like to sit, one of nine zones of the panel: on its own, or as a pull on an effect that has a from.

0.11

sfx.rotate

panel, scene

How far the effect is turned clockwise, in degrees, from -45 to 45.

0.11

sfx.size

panel, scene

How loud: small, medium or large, lettered at 1.6, 2.6 or 4 times the dialogue type size.

0.11

sfx.text

panel, scene

The sound, lettered exactly as written, in the display face.

0.11

size

artwork contract

The picture’s size in pixels, [width, height], as it was measured. It must be the picture’s own.

0.12

staging

panel, scene

How the cast stand to each other, as sentences: alice left_of bob. One relation each.

0.1

staging[].object

panel, scene

The other actor id. For looking_at, it may be somebody heard from off panel.

0.1

staging[].predicate

panel, scene

How the subject stands to the object: left_of, right_of, in_front_of, behind, looking_at or ground_shared_with.

0.1

staging[].subject

panel, scene

The actor id the relation is about.

0.1

tiers[].columns

scene

In place of panels: columns side by side, each a stack of panels read top to bottom before the next.

0.10

tiers[].height

scene

The tier’s share of the page’s height, relative to the other tiers.

0.10

tiers[].panels

scene

The panels in the tier, in reading order: left to right, or right to left for a comic read that way.

0.10

tiers[].slant

scene

How far the gutters between the tier’s panels lean, in degrees, from -30 to 30. Positive leans the top of each gutter to the right.

0.10

units_per_head

puppet

How many of the puppet’s own units one head height is.

0.13