Skip to content
Get started

SDK: Defaults

Every default of the piece API that is a constant in the code, with what it holds and the option that changes it. This file is written from those constants (pnpm docs:defaults), so its values are the code's. A default that is one plain value is also named where its option is documented. A command's defaults are in allyhub help <command>; a starter component's are props with defaults, in its source.

The presets (PRESETS): pixels, and the edges an interface over the video may cover (ctx.dims.safe), changed by format: { format, safe }. A WIDTHxHEIGHT format covers none.

Format Pixels Covered: top, bottom, left, right
16x9 1920 × 1080 60, 90, 80, 80
9x16 1080 × 1920 150, 400, 40, 140
1x1 1080 × 1080 50, 90, 40, 40
4x5 1080 × 1350 60, 120, 40, 40

Frames per second of a video. video({ fps }).

Value: 30

Seconds loading a version may take (AK-P002). video({ loadLimit }).

Value: 10

Seconds one moment may take to draw (AK-P003). video({ seekLimit }).

Value: 30

How many seek limits loading waits for its layers’ work (ctx.wait).

Value: 4

The built-in look, clean, which allyhub.config.ts’s look is laid over. Its colours and fonts are the --ak-color-* and --ak-font-* CSS variables.

Key Value
name "clean"
color.bg "#ffffff"
color.fg "#16181d"
color.accent "#2f5bea"
color.muted "#5d6470"
color.surface "#f3f4f6"
font.display "\"Inter Variable\", \"Noto Sans SC\", \"Noto Sans CJK SC\", sans-serif"
font.body "\"Inter Variable\", \"Noto Sans SC\", \"Noto Sans CJK SC\", sans-serif"
font.mono "ui-monospace, \"SF Mono\", Menlo, monospace"
font.emoji "\"Noto Color Emoji\""
motion.beat 0.5
sfx {}

What a chart is drawn with unless it says otherwise (each key’s option is in slides.md). margin and letter are how the stage lays it out, and not in the file.

Key Value
fontSize 12
titleScale 1.2
gapWidth 150
holeSize 50
margin 6
gridline "#D9D9D9"
axisLine "#BFBFBF"
letter 0.55
lineWidth 2.25
gridWidth 0.75
marker 5

A deck’s theme fonts where its code sets none (prs.theme.fonts): standard fonts every PowerPoint, Keynote and Google Slides has, drawn by fonts of the same metrics.

Key Value
major "Arial"
minor "Arial"
major_east_asian "Microsoft YaHei"
minor_east_asian "Microsoft YaHei"
code "Courier New"

A new master’s text styles (master.text_styles: title_style, body_style, other_style, nine levels each), as PowerPoint’s Office master has them: a title’s 44 pt in the theme’s major font at 0.9 lines, a body’s bulleted levels at 28, 24, 20 and 18 pt with their indents, other text 18 pt. Lengths are EMU (Pt(44) is 558800). A master’s, a layout’s or a placeholder’s list_style sets its own. A subtitle placeholder (PP_PLACEHOLDER.SUBTITLE) starts with Office’s Title Slide levels over the body style: no bullet, each level 0.5 in from the last, no hanging indent; its list_style changes them.

Key Value
title [{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":0,"bullet":null,"font":{"name":"+mj-lt","size":558800,"color":"dk1"}}]
body [{"alignment":"l","line_spacing":{"lines":0.9},"space_before":127000,"bullet":"•","bullet_font":"Arial","margin_left":228600,"indent":-228600,"font":{"name":"+mn-lt","size":355600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":685800,"indent":-228600,"font":{"name":"+mn-lt","size":304800,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":1143000,"indent":-228600,"font":{"name":"+mn-lt","size":254000,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":1600200,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":2057400,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":2514600,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":2971800,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":3429000,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","line_spacing":{"lines":0.9},"space_before":63500,"bullet":"•","bullet_font":"Arial","margin_left":3886200,"indent":-228600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}}]
other [{"alignment":"l","margin_left":0,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":457200,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":914400,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":1371600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":1828800,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":2286000,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":2743200,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":3200400,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}},{"alignment":"l","margin_left":3657600,"font":{"name":"+mn-lt","size":228600,"color":"dk1"}}]

What text has where not even a master’s text styles say: 18 pt in the theme’s minor font, single spacing.

Key Value
alignment "l"
line_spacing.lines 1
space_before 0
space_after 0
indent 0
font.name "+mn-lt"
font.size 228600
font.color "dk1"

A text frame’s insets where none are set (margin_left…), as python-pptx and PowerPoint have them.

Key Value
left 91440
top 45720
right 91440
bottom 45720

A text box add_textbox makes, as python-pptx makes it: no wrapping, the shape fitted to its text. Set word_wrap and auto_size to change it.

Key Value
word_wrap false
auto_size "shape"

A shape add_shape makes, as python-pptx makes it (the theme’s styles it is drawn by): filled and outlined in accent 1 (0.5 pt), its text light 1 in its middle, its one empty paragraph centred (text set with text replaces it, and is not). Its fill, line and text_frame change it.

Key Value
fill "accent1"
line "accent1"
line_width 6350
font_color "lt1"
vertical_anchor "ctr"
alignment "ctr"

A connector add_connector makes (a straight line, an elbow, a curve), as python-pptx makes it: the theme’s second line, 1 pt, in accent 1, with no fill and no text. A connector in a deck’s slides file (geometry: line, straightConnector1, bentConnector2 to 5, curvedConnector2 to 5) has it too. Its line changes it.

Key Value
line "accent1"
line_width 12700

A shape’s shadow where a shadow in a deck’s slides file or shape.shadow says nothing: color, blur and distance (EMU), angle (degrees clockwise from the right), transparency (a share).

Key Value
color.rgb "#000000"
blur 50800
distance 38100
angle 45
transparency 0.6

A slide’s window on the stage’s clock, seconds: a still of it is drawn at its end, when what moves in its components has settled. It is also how long a component moves, which its dur changes (in the slides file, or add_component’s { dur }): its slide rests no sooner, and a PowerPoint file’s video of it is that long.

Value: 4

A doc’s <Component> frame’s width, pixels at 1×, when it gives no width.

Value: 720

A <Component> frame’s height over its width, when it gives no height.

Value: 0.5625

A <Chart>’s colours, a series (a pie’s slice) each, in turn: the page’s accent (else this list’s first) takes the first, the same colour lighter (CHART_SECOND_TONE) the second, then this list; its colors take them in order. A <Chart>’s frame is a <Component>’s: COMPONENT_WIDTH wide and COMPONENT_ASPECT high when it gives no width or height; its legend is beside a pie, over more than one series and absent for one, unless legend says.

Value: ["#2A78D6","#EB6834","#1BAF7A","#EDA100","#E87BA4","#008300"]

A <Chart>’s text and title sizes, points.

Key Value
size 10
title 13

A doc’s cover on paper: a band across the top of the first page, edge to edge, this many millimetres high (Letter is 215.9 wide); its picture fills it at its cover-y.

Value: 64

A doc’s page when its front matter does not set it: the paper (paper), its margins in mm (margins), the text’s size in pt (size), its line height (line-height), first-line indent in characters (text-indent), the space between paragraphs in em (paragraph-spacing), each heading’s size as a multiple of the text’s (a heading’s size), and the footer (footer; page-numbers: false drops it). A preset sets these as its convention does, under the doc’s own keys.

Key Value
paper "letter"
margins.top 18
margins.right 20
margins.bottom 18
margins.left 20
size 11
lineHeight 1.15
textIndent 0
paragraphSpacing 0.5
headingScale.1 1.75
headingScale.2 1.45
headingScale.3 1.15
headingScale.4 1
headingScale.5 1
headingScale.6 1
headingScale.title 2.3
footer.left "{title}"
footer.right "{page} / {pages}"

How sharp a doc’s pictures are on paper: each is drawn again at no more than this many dots an inch of the page it is set on (Word’s Default resolution), a JPEG where it has no transparent pixel; front matter’s picture-dpi sets it, picture-dpi: false prints them as they are.

Value: 220

What allyhub inspect pages lists without --all: a heading with fewer lines than headingLines after it on its page (--heading-lines), a paragraph whose last line holds shortChars letters or fewer (--short-line).

Key Value
headingLines 3
shortChars 2

A pie’s or a doughnut’s frame when it gives no width or height: at most this many pixels wide, and this high over its width, so its legend stays beside it.

Key Value
width 560
aspect 0.6

A bar or column chart’s bars: the gap between groups, % of a bar (Office’s gap_width), and within a clustered group a sliver apart (Office’s overlap, %).

Key Value
gap 80
overlap -8

A sheet’s iterative calculation, Excel’s own limits: how many rounds at most, and the change under which it stops. The workbook file’s iteration: { max_iterations, max_change }.

Key Value
max_iterations 100
max_change 0.001

What a .pptx or .xlsx given to allyhub slides import or allyhub sheet import may unzip to, by what the file claims, before anything is inflated: its parts, and its bytes, which --max-unzipped sets in MB.

Key Value
parts 10000
bytes 1610612736

A part’s length without speech, and the seconds before its first word and after its last. part({ dur, lead, tail }), video({ defaults: { part } }), defineConfig({ defaults: { part } }).

Key Value
dur 4
lead 0.2
tail 0.3

A transition’s window in seconds, the share of it before the join, a slide’s, push’s or wipe’s way, and a zoom’s scale. part({ transition: { dur, split, direction, scale } }).

Key Value
dur 0.4
split 0.5
direction "left"
scale 1.2

How a room tone fill meets the take: the seconds measured each side of a join, the least of the take’s own room measured, the cross-fade, the most gain in dB. take(…).roomTone({ match, gainDb, limitDb, fade }).

Key Value
near 0.3
least 0.1
fade 0.04
limitDb 6

Seconds a word, and a Chinese, Japanese or Korean character, take to say: how long a line is estimated to last before it has sound.

Key Value
word 0.38
cjk 0.22

How the subtitles allyhub render writes are cut when no layer asked ctx.captions() for other cues.

Key Value
maxChars 42
maxCharsCjk 16
minSeconds 0.8
maxSeconds 6
gapFrames 2

Each stem’s loudness target in LUFS, the music’s dip under words and its fades in seconds. video({ mix }).

Key Value
speech -16
music -20
musicAlone -16
sfx -22
footage -16
footageUnderSpeech -22
duck.db -8
duck.attack 0.3
duck.release 1
duck.hold 2
musicFade.in 0.3
musicFade.out 1.5

The master’s loudness in LUFS and its true-peak ceiling in dBTP. video({ master }).

Key Value
lufs -14
truePeak -3

How the master reaches its targets: the limiter’s attack and release, its oversampling, the gain’s corrections and their tolerance. Mechanics, not options.

Key Value
attack 0.002
release 0.04
oversample 4
rounds 4
tolerance 0.1

A seam’s cross-fade between stretches, beats a bar, and the seam of the whole file looped. music: { seam, meter }.

Key Value
seam 0.03
meter 4
loopSeam 0.25

A compressor’s settings, its threshold in dB over the sound’s loudness. music: { compress }, a sound effect’s shape: { compress }.

Key Value
ratio 2
knee 6
attack 0.01
release 0.15
window 0.01

The presets mic names: video({ mic }), part({ mic }), a setup’s name or { setup, …changes }. A response is [Hz, dB] points, a band [low, high] in Hz.

Each setup: its microphone, room, room tone, automatic gain and finishing.

Key Value
studio.pattern "cardioid"
studio.distance 0.2
studio.angle 0
studio.below 0
studio.response [[125,-3.5],[250,-3],[500,-0.5],[1000,0],[2000,-2],[4000,-1.5],[8000,-4],[12500,-4]]
studio.band [20,20000]
studio.stereo false
studio.room false
studio.noise false
studio.agc false
studio.post "finish"
phone.pattern "omni"
phone.distance 0.35
phone.angle 0
phone.below 25
phone.response [[125,-8.5],[250,-3.5],[500,-0.5],[1000,0],[2000,0],[4000,0],[8000,-3.5],[12500,-2.5]]
phone.band [100,16000]
phone.stereo 0.1
phone.room.preset "bedroom"
phone.room.rt60 0.2
phone.noise.tilt -4
phone.noise.rumble 8
phone.noise.top 16000
phone.noise.below 42
phone.agc.target 0
phone.agc.most 10
phone.agc.attack 0.3
phone.agc.release 1.5
phone.agc.window 2
phone.agc.gate -25
phone.post false
lav.pattern "omni"
lav.distance 0.22
lav.angle 0
lav.below 70
lav.response [[125,-2],[250,-3],[500,0.5],[1000,0],[2000,-1],[4000,-1],[8000,-3.5],[12500,-4]]
lav.band [70,18000]
lav.stereo false
lav.room.preset "bedroom"
lav.room.rt60 0.13
lav.noise.tilt -4
lav.noise.rumble 4
lav.noise.top 18000
lav.noise.below 50
lav.agc false
lav.post "finish"

Each room a setup or mic: { room } names.

Key Value
bedroom.size [3.4,2.6,4]
bedroom.walls "plasterboard"
bedroom.floor "carpet"
bedroom.ceiling "plasterboard-ceiling"
bedroom.rt60 0.4
bedroom.talker [1.5,1.2,1.5]
bedroom.order 3
living-room.size [5,2.7,6]
living-room.walls "plasterboard"
living-room.floor "wood"
living-room.ceiling "plasterboard-ceiling"
living-room.rt60 0.55
living-room.talker [2.2,1.2,2.5]
living-room.order 3
office.size [4,2.8,5]
office.walls "plasterboard"
office.floor "carpet-thin"
office.ceiling "ceiling-tiles"
office.rt60 0.45
office.talker [1.8,1.2,2]
office.order 3
kitchen.size [3,2.6,4]
kitchen.walls "tiles"
kitchen.floor "tiles"
kitchen.ceiling "plasterboard-ceiling"
kitchen.rt60 0.75
kitchen.talker [1.4,1.6,1.6]
kitchen.order 3
treated.size [3,2.6,3.5]
treated.walls "foam"
treated.floor "carpet"
treated.ceiling "foam"
treated.rt60 0.2
treated.talker [1.4,1.2,1.4]
treated.order 3
car.size [1.4,1.15,1.9]
car.walls "glass"
car.floor "upholstery"
car.ceiling "upholstery"
car.rt60 0.08
car.talker [0.45,0.85,0.9]
car.order 6
outdoor.size [60,30,60]
outdoor.walls "hard"
outdoor.floor "hard"
outdoor.ceiling "hard"
outdoor.rt60 0.4
outdoor.talker [30,1.6,30]
outdoor.open true
outdoor.order 1

Each finishing chain a setup or mic: { post } names.

Key Value
finish.highpass 70
finish.eq []
finish.deess.hz 5500
finish.deess.threshold -12
finish.deess.ratio 3
finish.deess.attack 0.002
finish.deess.release 0.06
finish.compress.threshold -3
finish.compress.ratio 4
finish.compress.knee 6
finish.compress.attack 0.005
finish.compress.release 0.3
finish.compress.window 0.01
phone-app.highpass 90
phone-app.eq [{"type":"peak","hz":300,"db":-2,"q":1},{"type":"peak","hz":4000,"db":3,"q":0.8},{"type":"highshelf","hz":10000,"db":1}]
phone-app.deess.hz 5500
phone-app.deess.threshold -12
phone-app.deess.ratio 3
phone-app.deess.attack 0.002
phone-app.deess.release 0.06
phone-app.compress.threshold 0
phone-app.compress.ratio 3
phone-app.compress.knee 6
phone-app.compress.attack 0.005
phone-app.compress.release 0.12
phone-app.compress.window 0.01

A camera filming the picture: a mark’s values when it is asked for without them. video({ capture }).

Key Value
bloom.threshold 0.8
bloom.radius 24
bloom.strength 0.35
exposure.drift 0.12
exposure.period 6
grain.amount 0.02
grain.size 1.2
grain.shadows 1.8
grain.highlights 0.6
grain.chroma 0.35
grain.chromaSize 3
grain.static false

How allyhub render and an editor’s Export encode an mp4 when nothing chooses otherwise, ready to share on social media: H.264’s crf, and the most video bitrate in kbit/s for a frame of width × height at fps, scaled by the pixels a second of the video’s own (16000 at 1080p 60, 32000 at 4K 30). --param crf, --param max-bitrate (0 for none).

Key Value
crf 20
maxKbps 8000
width 1920
height 1080
fps 30

The softness of the person’s edge, px at 1080p. footage({ background: { feather } }).

Value: 2

How far the person’s edge is pulled in, px at 1080p. footage({ background: { shrink } }).

Value: 4

How a still fills its box (CSS’s object-fit), and the point of it at the same point of the box, as shares (CSS’s object-position). picture({ fit, position }); a deck’s Crop to Fill and Fit centre it the same way.

Key Value
fit "cover"
position [0.5,0.5]

A board whose height grows with what it holds: the height its layers are laid out at before it is measured (the least it is), and the most it grows to, px; its resolution (ppi) and colour profile, metadata for print and PSD. board({ height: "auto", minHeight, maxHeight, resolution, colorProfile }).

Key Value
minHeight 64
maxHeight 16384
resolution 72
colorProfile "sRGB IEC61966-2.1"

What every layer is when it says nothing: its blend mode (a group’s passThrough), opacity and fill opacity (percent), clipping, visibility, and a mask’s alpha mode, density (percent), feather (px) and inversion. Each layer’s blendMode, opacity, fillOpacity, clipping, visible, mask.

Key Value
blendMode "normal"
groupBlendMode "passThrough"
opacity 100
fillOpacity 100
clipping false
visible true
mask.mode "alpha"
mask.density 100
mask.feather 0
mask.invert false

Each layer style’s settings when it gives none, Photoshop’s own: blend mode, colour, opacity (percent), the light’s angle (degrees counter-clockwise from the right), distance, size, spread and choke (px and percent), a bevel’s depth, altitude and highlight and shadow. A layer’s effects: { dropShadow: { … } }.

Key Value
dropShadow.blendMode "multiply"
dropShadow.color "#000000"
dropShadow.opacity 75
dropShadow.angle 120
dropShadow.distance 5
dropShadow.spread 0
dropShadow.size 5
innerShadow.blendMode "multiply"
innerShadow.color "#000000"
innerShadow.opacity 75
innerShadow.angle 120
innerShadow.distance 5
innerShadow.choke 0
innerShadow.size 5
outerGlow.blendMode "screen"
outerGlow.color "#ffffbe"
outerGlow.opacity 75
outerGlow.spread 0
outerGlow.size 5
innerGlow.blendMode "screen"
innerGlow.color "#ffffbe"
innerGlow.opacity 75
innerGlow.choke 0
innerGlow.size 5
innerGlow.source "edge"
stroke.blendMode "normal"
stroke.color "#000000"
stroke.opacity 100
stroke.size 3
stroke.position "outside"
colorOverlay.blendMode "normal"
colorOverlay.color "#ff0000"
colorOverlay.opacity 100
gradientOverlay.blendMode "normal"
gradientOverlay.opacity 100
gradientOverlay.gradient.stops [{"color":"#000000","location":0},{"color":"#ffffff","location":100}]
gradientOverlay.gradient.style "linear"
gradientOverlay.gradient.angle 90
gradientOverlay.gradient.scale 100
gradientOverlay.gradient.reverse false
patternOverlay.blendMode "normal"
patternOverlay.opacity 100
patternOverlay.scale 100
satin.blendMode "multiply"
satin.color "#000000"
satin.opacity 50
satin.angle 19
satin.distance 11
satin.size 14
satin.invert true
bevelEmboss.style "innerBevel"
bevelEmboss.technique "smooth"
bevelEmboss.depth 100
bevelEmboss.direction "up"
bevelEmboss.size 5
bevelEmboss.soften 0
bevelEmboss.angle 120
bevelEmboss.altitude 30
bevelEmboss.highlightMode "screen"
bevelEmboss.highlightColor "#ffffff"
bevelEmboss.highlightOpacity 75
bevelEmboss.shadowMode "multiply"
bevelEmboss.shadowColor "#000000"
bevelEmboss.shadowOpacity 75

Each adjustment’s numbers when it gives none, Photoshop’s: they change nothing, but Invert’s, Threshold’s (128), Black & White’s sliders and Photo Filter’s colour and density. adjustment({ kind, … }).

Key Value
levels.inputBlack 0
levels.inputWhite 255
levels.gamma 1
levels.outputBlack 0
levels.outputWhite 255
curves.rgb [[0,0],[255,255]]
brightnessContrast.brightness 0
brightnessContrast.contrast 0
brightnessContrast.useLegacy true
hueSaturation.hue 0
hueSaturation.saturation 0
hueSaturation.lightness 0
hueSaturation.colorize false
vibrance.vibrance 0
vibrance.saturation 0
colorBalance.shadows [0,0,0]
colorBalance.midtones [0,0,0]
colorBalance.highlights [0,0,0]
colorBalance.preserveLuminosity true
blackAndWhite.reds 40
blackAndWhite.yellows 60
blackAndWhite.greens 40
blackAndWhite.cyans 60
blackAndWhite.blues 20
blackAndWhite.magentas 80
photoFilter.color "#ec8a00"
photoFilter.density 25
photoFilter.preserveLuminosity true
invert {}
threshold.level 128
gradientMap.gradient.stops [{"color":"#000000","location":0},{"color":"#ffffff","location":100}]
gradientMap.reverse false
exposure.exposure 0
exposure.offset 0
exposure.gammaCorrection 1

A type layer’s style when it gives none: size (px), weight, colour, tracking (thousandths of an em), leading (auto: autoLeading of the size, Photoshop’s 120%) and justification. textLayer({ textItem: { characterStyle, paragraphStyle } }).

Key Value
size 48
weight 400
color "#000000"
tracking 0
leading "auto"
autoLeading 1.2
justification "left"

A shape’s fill, its stroke’s colour, width (px), alignment, cap, join and opacity, a rectangle’s radius and a polygon’s sides. shape({ fill, stroke, radius, sides }).

Key Value
fill.color "#000000"
stroke.color "#000000"
stroke.width 1
stroke.alignment "center"
stroke.cap "butt"
stroke.join "miter"
stroke.opacity 100
radius 0
sides 5

The longest side a board takes, px: what one picture the stage draws holds. A hard limit, not an option.

Value: 16384

An image’s files: JPEG’s quality, and AVIF’s (as libaom’s constant quality, 63 − 0.63 × it), 0–100; a WebP without one keeps every pixel. allyhub render --param quality=…. A board’s picture’s pixels per board pixel, from 0.25 to 4: --param scale=…, or width=… / height=… in pixels.

Key Value
jpegQuality 90
avifQuality 60
scale 1

An image’s PSD: psd, or psb (Photoshop’s large document format); a board is at most 16384 px a side, which a PSD holds. allyhub render --type psd --param psd=psb.

Key Value
format "psd"

How marked() draws each inline mark. marked(line, styles).

Key Value
strong.fontWeight 700
em.color "var(--ak-color-accent)"
strike.textDecoration "line-through"
code.fontFamily "var(--ak-font-mono)"
code.fontSize "0.9em"

The font size step, in px, fitLines() stops at. fitLines(el, { precision }).

Value: 0.5

A person’s input: a hand’s aimed movement (reach) and a mouse cursor’s (cursor, the same without a hand’s errors), a press, a drag, a scroll, typing. Each input function’s options.

Key Value
reach.overshoot 0.06
reach.peak 0.38
reach.vary 0.5
reach.fitts.a 0.2
reach.fitts.b 0.15
reach.scatter 0.1
reach.jitter 0.02
reach.bow 0.06
reach.tremor.px 0.3
reach.tremor.frequency 9
reach.seed 1
cursor.reach.overshoot 0
cursor.reach.peak 0.38
cursor.reach.vary 0
cursor.reach.fitts.a 0.2
cursor.reach.fitts.b 0.15
cursor.reach.scatter 0
cursor.reach.jitter 0
cursor.reach.bow 0
cursor.reach.tremor.px 0
cursor.reach.tremor.frequency 9
cursor.reach.seed 1
cursor.after 0.3
size 40
dwell 0.12
hold 0.1
drag.settle 0.08
drag.release 0.06
drag.fitts.a 0.25
drag.fitts.b 0.2
drag.tremor.px 0.8
drag.tremor.frequency 8
tap.slide 1.2
tap.grow 0.03
wheel.notch 100
wheel.animate 0.15
wheel.interval 0.05
wheel.pause 0.25
wheel.burst 4
flick.contact 0.12
flick.decay 0.4995
flick.band 800
flick.spring 0.12
typing.cps 9
typing.spread 0.35
typing.word 1.5
typing.mark 2
typing.think.chance 0.08
typing.think.seconds 0.35
typing.notice 0.3
typing.backspace 0.07
typing.seed 1

How routeConnections() routes, and the connector component with it: how far a line keeps from every box and runs straight out of a side (margin), what a bend costs as so much length (bend), how far apart lines sharing a channel are set (spread), what crossing another line costs as so much length (cross: a line goes round rather than across only where that is shorter). routeConnections(boxes, connections, { margin, bend, spread, cross, bounds }); a connector’s line.

Key Value
margin 16
bend 48
spread 8
cross 120

A scenery() layer’s drawing scale, its name and its depth of field’s levels. scenery(s, { quality: { scale }, name }).

Key Value
scale 1
name "scenery"
focusLevels 8

A screen of graphic layers: its picture’s size in px and its background. screen(layers, { size, background }).

Key Value
size [1920,1080]
background "#000000"

How the renderer is made, and a camera’s depth of field. defineScenery({ renderer }).

Key Value
antialias false
transmissionScale 0.25
focus.samples 64
focus.maxRadius 64

A camera’s lens (mm, 35 mm equivalent), the frame the lens is measured on, its near and far planes, up and roll. CameraState.

Key Value
lens 26
lensFrame "diagonal"
near 0.05
far 500
up [0,1,0]
roll 0

A phone’s main camera held in a hand: its lens, sensor and hand. phoneCamera(changes).

Key Value
lens.lens 26
lens.lensFrame "phone"
lens.aperture 8
sensor.photosites 4032
sensor.lens 0.35
sensor.moire 1
sensor.chroma 0.3
sensor.distortion -0.03
sensor.grade.room.curve [[0,0],[0.25,0.21],[0.5,0.47],[0.75,0.78],[1,1]]
sensor.grade.room.saturation 1.08
sensor.grade.screen.curve [[0,0],[0.36,0.1],[0.51,0.16],[0.67,0.46],[0.8,0.84],[1,1]]
sensor.grade.screen.saturation 1.25
sensor.grade.screen.hue 5
sensor.grade.screen.balance [1,0.97,1]
sensor.grade.share [0.5,0.8]
hand.angle 0.25
hand.roll 0.6
hand.shift 0.001
hand.sway 0.65
hand.tremor.angle 0.1
hand.tremor.frequency 8.5
hand.drift.angle 0.15
hand.drift.shift 0.001
hand.drift.period 8
hand.stabilizer.strength 0.7
hand.stabilizer.cutoff 1.5
hand.autofocus {}
hand.exposure {}

A camera path’s options. path(points, opts).

Key Value
start 0
ahead 1
alpha 0.5

How fitCamera() frames what it is given. fitCamera(opts).

Key Value
fill 1
axis "both"
adjust "distance"

An aimed movement’s shape. aimed(opts).

Key Value
overshoot 0.08
peak 0.38
primary 0.72
vary 0.5
seed 1
index 0

A hand holding the camera. handheld(camera, opts).

Key Value
angle 0.25
roll 0.5
shift 0.003
sway 0.7
tremor.angle 0.02
tremor.frequency 9
tremor.spread 1.5
tremor.vary 0.12
tremor.swell 0.3
tremor.period 3
drift.angle 0.15
drift.shift 0.002
drift.period 8
reframe.duration 0.5
reframe.overshoot 0.1
reframe.peak 0.36
reframe.bow 0.1
reframe.vary 0.5
jolt.turn [0.15,-0.35,0.1]
jolt.ring 5
jolt.decay 0.09
jolt.vary 0.3
seed 1

The stabiliser’s strength and cut-off. handheld(camera, { stabilizer }).

Key Value
strength 0.8
cutoff 1.5

Focus hunting after a cut, a reframe or a jolt. handheld(camera, { autofocus }).

Key Value
miss -0.02
hunt 0.12
rate 2.3
decay 0.3
after.cut 1
after.reframe 0.7
after.jolt 0.3

Exposure following a new framing. handheld(camera, { exposure }).

Key Value
delay 0.15
settle 0.7
cut 0.25
breathe 0.03
period 3

A camera’s sensor filming a screen (moiré). scenery(s, { sensor }).

Key Value
photosites 4032
lens 0.35
moire 1
chroma 0.3
distortion -0.03

A screen’s physical pixels, which the sensor films. screen(…, { pixels }).

Key Value
density 2
rows 0.15
mesh 0.09

The light a screen drawn in the scenery casts. screen(…, { inScenery: { light } }).

Key Value
cells [8,5]
specular true
base null

How a screen’s depth of field is drawn.

Key Value
levels 8
samples 65
sharp 0.05

A screen’s glass. screen(…, { glass }).

Key Value
reflectance 0.04
roughness 0.05
scale 1

A scenery’s baked light. defineScenery({ bake }); allyhub scenery bake bakes it.

Key Value
density 40
maxSize 2048
minTexels 128
islandTexels 16
ownUv true
samples 16
bounces 4
denoise.radius 3
denoise.distance 0.02
clamp 40
tile 256
posedAt [0.5,1,2,4,8,16,32]
probeSize 256

Meshing a distance field: meshField of @allyhub/model.

Key Value
project 3
maxSamples 40000000
Was this page helpful?