# ImpactFrames
Anime and manga hit impact frames for any look, behind one call: `ImpactFrames.play(style, opts)` with `style` one of `invert` (the inverted flash), `silhouette` (black subjects on white, white on black, or hard red and white), `radialBurst` (bold rays out of the hit, with or without the dark flip), `colourFlip` (ink, red and paper three-tone), `speedBurst` (manga focus lines closing in on the hit) or `whiteFlash`. `opts` gives the hit as a world point (`at`), an entity (`entity`) or a screen point (`screen`), a `strength`, a `duration`, a `variant`, colours, a `delay` and `localOnly`. Gameplay code calls it where a hit is decided; it shows on every player's screen at once through one small multiplayer message. Each impact is a styleKit Medium block laid on each machine only (`StyleKit.setLocalEntry`) for the few frames it shows, so it costs nothing while idle and works over any stack or none. A photosensitivity limiter is always on: at most 3 full-screen flashes in any second (extra flashes become the non-flashing rays or are dropped), large-area colours held below saturated red, and a per-player `gentle` mode (`setSafety`). `stats()`, `active()`, `stop()`, `styles()` and `takeFlash()` (the shared budget, used by Smears) complete it.
# ImpactFramesDriver
The per-frame step of impactFrames: advances the impact frames showing on this machine (one held drawing at a time) and takes away smear ghosts whose time is up. ImpactFrames spawns it on one hidden, temporary, unsynced entity the first time a hit plays, so the steps run on the engine's own frame whatever started the hit. Never add it by hand; it needs no other component.
# Smear
Put it on anything that moves fast (a fist, a sword, a ball, a dashing character) and it smears the object whenever it moves faster than `minSpeed` metres per second: `style` `stretch`, `multiples`, `streaks`, `stretchAndStreaks` (default) or `multiplesAndStreaks`, at most once per `cooldown` seconds so a long fast move smears in beats. `count`, `length` and `colour` tune it; `inEdit` smears in edit mode too. It needs a `Model` on the object or its children and no other component. It measures the speed on each machine from the object's own motion, so every player sees the smear with nothing sent over the network.
# Smears
Smear frames for fast hits and moves, per object: `Smears.play(entity, style, opts)` with `style` `stretch` (the object drawn stretched back along its motion for a frame or two while the real one is hidden), `multiples` (a few ghost copies trailing it, fading toward a colour) or `streaks` (speed lines behind it). `opts`: `velocity` (or measured by a `Smear` component), `duration`, `count`, `length`, `colour`, `seed`, `localOnly`. Ghosts are temporary, unsynced copies of the object's meshes on each machine, taken away after a few frames by the impactFrames driver; a call on one machine is sent to the others for a synced object. A smear of an object covering more than about a third of the screen spends a flash from the same limiter as impact frames. `stats()` and `clear()` for tests.
# Impact colour flip (styleBlock, Medium)
Anime impact frame: the picture's tones flip to a three colour duotone, ink darks, a red middle band and pale lights, for a red and black hit frame.
Red is a middle band of tones only; the lights go to the pale paper, so the screen is never filled with saturated red.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("colourFlip", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# impactFrame (shader)
The one full-frame pass behind every impactFrames block: an inverted flash, a black and white silhouette, a radial burst, a colour flip, speed-burst focus lines or a white flash, picked by `mode`, centred on the hit point and re-drawn on each held drawing (`phase`). It starts with the styleKit shared header; the blocks `impactInvert`, `impactSilhouette`, `impactRadialBurst`, `impactColourFlip`, `impactSpeedBurst` and `impactWhiteFlash` run it with their own defaults.
# Impact ink splash (styleBlock, Medium)
Sumi-e impact frame for a decisive, bloodless blow: for a beat the whole picture becomes black ink washed on paper, one dry brush stroke is torn through the hit, and (variant `"splash"`, the default) a ragged blot of ink bursts from the hit with long splatter spokes and scattered drops. Variant `"stroke"` is the brush stroke alone, lighter: a knock-out rather than a kill.
Ink and paper only. It never draws red, a wound or anything that reads as blood, so it suits a stealth takedown, a duel's final cut or a boss's last hit in a game that keeps violence stylised. Counts as a full-screen flash, so it goes through the photosensitivity limiter like the other flashing styles.
Play it with `require("~impactFrames.ImpactFrames").play("inkSplash", { at = hitPoint, angle = 0.5, variant = "splash" })` rather than adding it to a stack: ImpactFrames lays it on each machine for the length of the hit (0.6 s by default), centres it on the hit and steps its drawings on the held clock. `angle` tilts the stroke (radians on screen), `lineWidth` thickens it, `clear` sizes the blot, `lines` sets how many splatter spokes, and `ink` / `paper` recolour it (held low in saturation).
Settings are shared by every impactFrames block (see the slash block's README); this block's defaults are in its block.yaml (`mode` 7).
# Impact invert (styleBlock, Medium)
Anime impact frame: the whole picture flips to a hard, cold negative for a beat, with pale rays bursting from the hit, the inverted hit flash.
The negative is desaturated and pushed to high contrast, slightly cold, with sparse pale rays out of the hit point.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("invert", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# Impact radial burst (styleBlock, Medium)
Anime impact frame: bold radial lines burst from the hit point over a darkened negative ground, a shock ring at the centre; without the flip it is rays only.
With `flip` 0 the ground keeps the picture and only the rays are drawn: that variant is not a full-screen flash and is what the limiter downgrades flashes to.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("radialBurst", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# Impact silhouette (styleBlock, Medium)
Anime impact frame: black and white silhouette, the fighters as flat black shapes on white (or white on black), split by depth or brightness, with a hard red and white option.
Polarity 0 is black subjects on white, 1 white on black, 2 black subjects on white with red rays behind them (red is only ever rays, never the whole ground).
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("silhouette", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# Impact slash (styleBlock, Medium)
Anime slash frame: a bright cut tears across the frame through the hit, and the picture on each side of it is knocked apart along the cut and pushed to hard ink and paper, the frame of a sword stroke landing.
The cut runs through the hit point at `angle` (radians on screen; ImpactFrames takes it from `play`'s `angle` option). Each half slides a little along the cut, away from the other, and is reduced to two tones (darks to `ink`, lights to `paper`, `polarity` 1 the reverse); the cut itself is a tapering `paper` blade with thin `accent` echoes beside it. Counts as a full-screen flash.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("slash", { at = hitPoint, angle = 0.5 })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# Impact speed burst (styleBlock, Medium)
Manga focus lines: thin ink speed lines close in from the frame's edges on the hit, leaving a clear oval around it, the speed-line burst.
Lines are ink over the picture and cover the edges only, so it is not a full-screen flash.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("speedBurst", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# Impact white flash (styleBlock, Medium)
Anime impact frame: the whole picture blows out to white for a beat, brightest at the hit, with the subjects left as a faint grey print, the white hit flash.
The paper colour is the flash colour; ImpactFrames keeps it low in saturation.
Settings (shared by every impactFrames block): `mode`, `amount` (1), `centre`, `phase`, `ink`, `paper`, `accent`, `lines`, `lineWidth`, `clear`, `polarity`, `split`, `depthRange`, `threshold`, `flip`, `gentle`, `angle`, `startAt`, `hitLength`, `holdShare`. This block's defaults: see `defaults` in its block.yaml. Play it with `require("~impactFrames.ImpactFrames").play("whiteFlash", { at = hitPoint })` rather than adding it to the shared stack: ImpactFrames lays it on each machine for the length of the hit, centres it, steps its held drawings and keeps it under the flash limit. Added to a stack by hand it draws its first drawing still, which is only useful for tuning.
## What it gives up in motion
It is a screen effect by design, so it is fixed to the screen for the few frames it shows. Its rays and lines are re-drawn on each held drawing (about every other frame at 60 Hz, ImpactFrames' step rate), never per frame, so they step like drawn animation and never crawl. The hit centre is projected again on each drawing, so a moving camera keeps the burst on the hit point. Nothing is carried from frame to frame.
## How it treats content
- Opaque things: drawn over like the rest of the picture; the silhouette and white flash find them by depth (nearer than the hit plus `depthRange`) or by brightness.
- Transparent things (glass, water): not in the depth, so the depth split treats them as what is behind them; the brightness split sees them as drawn.
- Particles and smoke: the same as transparent things: brightness only.
- Sky: ground, never subject, in the depth split; inverted or flipped like any colour.
- Fog: fogged colours are drawn over by tone; fog does not change the depth split.
- Skinned characters: subjects like any opaque thing, shapes taken from the frame of the hit.
- Foliage: subjects by depth; thin leaves keep their shapes at the frame's resolution.
- World text: covered for the length of the hit like everything else; exclude a label with `StyleKit.options({ exclude = { ... } })` to keep it as rendered. Screen UI is drawn after the stack and is never touched.
- Black stays black: not kept, on purpose. An impact frame is a light event and may light an unlit pixel for a few frames (a flash over a night scene), which is why every flashing style goes through the ImpactFrames limiter (at most 3 full-screen flashes a second by default).
- Dim rooms: not a Tone block and declares no `keepDim`: a flash brightens a dim room for its two to six frames and the picture returns exactly as rendered after.
# impactFrames test suite
Checks impactFrames on this machine: the photosensitivity limiter (twenty flashing impacts inside a second draw at most three full-screen flashes and downgrade the other seventeen, a budget of 0 never flashes, `downgrade = false` drops instead, the window refills after a second), that every impact style (the slash frame and the held hit pose included) lays its block and takes it off when it ends, that a hit is laid once with its start on the held clock so its drawings step in the shader, that impact frames ride along with juiceKit hits (a stand-in juice module: a mapped preset lays its impact, an unmapped one none, stopping puts `Juice.play` back exactly), gentle mode, that large-area colours are held below saturated red, that a hit from another player starts at the moment it was sent (and one arriving after its end is dropped), that an unknown style is refused, and that every smear style spawns its ghosts far from the scene and takes them away (stretch hides and shows the object again).
Every impact runs as a dry run (`ImpactFrames.setDryRun(true)`): the limiter, drawings and timing run in full and nothing is drawn, so the suite is safe to run on a screen a person is looking at. What the blocks look like is checked with presented captures, not here. It leaves the scene's shared style stack alone, restores this player's safety settings without writing their saved store, and does not send a real multiplayer message (it needs two peers; the receive path is driven through `ImpactFrames.receive`). Run: `asset.resolve("impactFrames", "testSuite"):run()`.
# styleBlock (asset type)
A styleBlock is one stackable piece of an art style. It sits in one of ten slots (Surface, Light, Fill, Tone, Line, Colour, Ground, Time, Raster, Medium), it states what it reads and what it writes, and the styleKit stack runs it over the whole frame after antialiasing. Any block swaps for any other block of its slot with no other change.
## Folder shape
A block is a plain folder holding the block asset and its shader side by side:
```
blocks/posterize/
posterize.styleBlock/ the block: block.yaml, README.md, .metadata (all required)
posterize.shader/ the post-process shader the stack runs
posterizeField.shader/ optional: the shader that writes a shared field (Ground or Time blocks)
posterize.shaderModule/ optional: the piece a material includes for a chosen set of objects
```
Paths in `block.yaml` are relative to the plain folder. The shader sits beside the `.styleBlock` rather than inside it, because a shader nested inside another asset folder is not listed by the engine and could not be found without a computed lookup that would block publishing.
The quickest way to start one is `StyleKit.newBlock("myTint", { slot = "colour" })` (written to `/zero/source/myBlocks/myTint`, or the `folder` you pass), which writes the whole folder, block and shader, and registers it at once. `asset.create("styleBlock", name, { slot = "line" })` writes only the `.styleBlock` files; write the `<name>.shader` beside it yourself.
## block.yaml
```yaml
name: "Posterize"
slot: colour # surface light fill tone line colour ground time raster medium
version: "1.0.0"
summary: "Cuts the picture into a few flat tone steps."
reads: [frame] # frame depth normal albedo motion ground wobble clock mask soft pigments rendered paper sun
writes: [frame] # frame, and field:ground, field:paper (Ground) or field:wobble (Time) when it has a field
stacking: layer # optional: layer (default) or chain
rank: 10 # optional: StyleKit.add places it before the first block of its slot with a higher rank
keepDim: false # optional: true keeps a dim room dim under this block (the dim guard); defaults to true in the Tone slot, false elsewhere
shader: posterize.shader # relative to the plain folder
field: { name: ground, shader: plainPaperField.shader } # optional, Ground and Time only
include: posterize.shaderModule # optional
settings: # every non-sk_ property of the shader, with what it means
levels: "How many steps each channel keeps."
defaults: # optional: this block's own defaults over the shader's (many blocks, one shader)
levels: 4
quality: # optional per-tier overrides of settings
low: { samples: 4 }
```
A Ground block's `field` may also name a paper-field shader and say that it layers (styleKit 1.2.0):
```yaml
field: { name: ground, shader: paperField.shader, paper: paperTakes.shader, layers: true }
writes: [frame, field:ground, field:paper]
```
- `paper`: a shader that publishes the paper field (`sk_paper`: r thirst -1 hard-sized to +1 thirsty, 0 the standard sheet; g sheen; b fibre; a dark ground 0 to 1) for blocks that read `paper`. It is run only when a live block reads it. A Ground block without one leaves the paper field neutral (every value 0). Add `field:paper` to `writes`.
- `layers: true`: when this block is not the first Ground block in the stack, it lays its ground (and its paper field) over the one before by its strength and mask, instead of being ignored as a later field. Its field shaders receive the field before as `sk_ground` / `sk_paper` and mix over it (`sk_view.y` is 1 when they are layered).
`defaults` lets several blocks share one shader (paperBlocks' seventeen papers run on one): each key must be a setting the shader declares, it overrides the shader's default for this block on every tier (`quality` overrides come after it, an entry's own settings last), and `StyleKit.settingsOf(id)` reports it as the block's default.
The shader's `properties.yaml` starts with the styleKit shared header (the `sk_` properties) and then declares the block's own settings with their defaults and ranges. `StyleKit.checkBlock(id)` reports anything missing.
## Stacking and rank
- `stacking: layer` (the default): every block in a slot reads the slot's input, and later ones are laid over the earlier ones by strength and mask.
- `stacking: chain`: the block reads what the blocks before it in its slot made, so modifier blocks build on each other (a wash, then its granulation, then its darkened edges).
- `rank: <number>`: `StyleKit.add` places the block before the first block of its slot with a higher rank, so a chain lands in its intended order whatever order its blocks are added in. A block with no rank lands before the first block of its slot ranked 100 or more: give finishing blocks that must stay on top (a printed margin, a frame, weather laid over the picture) `rank: 100` and up with `stacking: chain`, and grain or a vignette added later goes under them instead of painting them out.
## Keeping a dark scene dark (keepDim)
`keepDim` (styleKit 1.4.0) asks for the stack's dim guard. While any live block declares it, two small passes run after the chain: they measure the stack's result against the frame as rendered and scale the result down wherever it comes out brighter than a dim room was, so a shading block's sheet and the light between its marks never brighten a dim or unlit room. Every mark keeps its shape, and in daylight or a well lit room the guard hands the result on exactly unchanged.
- Leave it out on a Tone block: every Tone block keeps dim unless it says `keepDim: false`. A new hatching, stipple or dots block gets the guard for free.
- Set `keepDim: true` on a block in another slot that lays a light sheet or light marks over the picture.
- Set `keepDim: false` on a Tone block that is meant to light up the dark (a glow, chalk marks on a black board).
## Published inputs (styleKit 1.8.0)
Beyond the five extra inputs, a block can read a texture another package computes: list `input:<name>` under `reads` and declare an `in_<name>` texture after the shared header. The producer calls `StyleKit.publishInput(name, texture)` on each machine and draws it before the stack runs; with nothing published the block reads black. `StyleKit.checkBlock` refuses a read without its texture and a texture without its read. The guide "Writing your own style block" has the whole recipe.
## Extra inputs
Five inputs come after the shared header, each declared straight after it and bound by the stack only when `reads` lists the matching word:
- `sk_soft` (`reads: soft`): a half-resolution, depth-aware blur of what the block reads, never smearing a nearer thing over a farther one. Read it through the `skSoft` shader module (`sk_soft_at`, `sk_soft_wide`, `sk_soft_depth`, `sk_soft_in_front`). Its width is the stack option `softRadius`.
- `sk_pigments` (`reads: pigments`): the scene's pigment set as a 16 x 1 palette. Read it through the `skPigmentSet` shader module (`skg_has_set`, `skg_pigment`, `skg_shadow`, `skg_light`, `skg_air`, `skg_remix`).
- `sk_rendered` (`reads: rendered`): the frame as it entered the stack, before any block changed it. Read it through the `skRendered` shader module (`sk_rendered_at`). Its use is a light estimate against `sk_albedo` (texture cancels out) or an original colour to restore.
- `sk_paper` (`reads: paper`, a texture, default black): the paper field the Ground blocks publish. Read it through the `skPaper` shader module (`sk_thirst`, `sk_sheen`, `sk_fibre`, `sk_dark_ground`). Where no Ground block publishes it every value is 0, so the block draws as it did without it. A Ground block's own paper-field shader declares it to read the field laid before it, without listing `paper` under reads.
- `sk_sun` (`reads: sun`, a float4): the direction toward the scene's first directional light, `w` 1 when it gives light. Read about once a second. Raking light and sheen use it.
`StyleKit.checkBlock` refuses a block that declares one of them without the word under `reads`, or lists the word without declaring the texture.
When an asset of this type registers on any machine (world load, install, a collaborator's new block arriving), the type's `onRegister` hands it to the styleKit library, so `StyleKit.blocks()` lists it and a stack can use it at once.
## Known limits
- An asset of this type registers when the engine indexes its files, a moment after they are written.
- ZeroMind's description of this can lag one release behind what is installed (#19258).
The package README's Known limits lists the rest.
# frameTiming: animation on ones, twos and threes
**Hand-drawn animation timing for 3D characters.** Put a character on twos and its drawn pose changes 12 times a second, like a drawing in an anime, while its movement, physics, collisions, the camera and the controls keep running at full speed. Ones, twos, threes, fours or any number, per character or for the whole scene, a mixed timing that snaps to full rate for fast moves, and a held hit pose. Every player sees the same drawings.
**Get started:** install frameTiming, then
```luau
require("~frameTiming.FrameTiming").set(character, "twos")
```
animeBlocks and impactFrames bring it along. Version 1.0.4; the history is at the end.
## In five minutes
1. Install **frameTiming** from ZeroMind (search "animation on twos"). animeBlocks brings it along.
2. Put a character on a timing, from any script or once with the `execute` tool:
```luau
local FrameTiming = require("~frameTiming.FrameTiming")
FrameTiming.set(entity.find("Hero"), "twos")
```
or add the `HeldFrames` component to the character in the editor (or in your scene's `build.luau`). For a player, put `HeldFrames` on the body under your `PlayerPrototype`: every player who joins is cloned from it.
3. Press play. The character's poses step; walk it around and the body still moves every frame.
A whole cast at once: `FrameTiming.setDefault("twos", { allSkeletons = true })` holds every animated body in the scene that has no `HeldFrames` of its own.
## Timings
| Preset | What it looks like |
|---|---|
| `ones` | 24 drawings a second: full animation on a film clock. |
| `twos` | 12 drawings a second: the classic anime and feature default. |
| `threes` | 8 drawings a second: limited TV animation, snappy and graphic. |
| `fours` | 6 drawings a second: very limited, a deliberate choppy look. |
| `mixedAction` | Twos while slow, ones once the object moves faster than 4 m/s: smooth fast action. |
| `mixedImpact` | Twos while slow, threes once it moves fast: hard, punchy action poses. |
| `limitedTV` | Threes on a 24 clock: the 8-drawings-a-second TV budget look. |
| `stopMotion` | One pose per step of a 12 fps clock: puppet and stop-motion cadence. |
Or any spec: `FrameTiming.set(e, { onFrames = 3, baseRate = 24, fastOnFrames = 1, fastSpeed = 6 })`.
## The `HeldFrames` component
| Field | Default | Meaning |
|---|---|---|
| `onFrames` | 2 | Frames of the animation clock each drawing is held for: 1 ones, 2 twos, 3 threes, any N. 0 uses the scene default. |
| `baseRate` | 24 | The animation clock in frames a second (24 for anime and film; 0 uses the scene default). Independent of the display rate. |
| `fastOnFrames` | 0 | Mixed timing: frames per drawing while the entity moves faster than `fastSpeed` (1 for smooth fast action, 3 for punchy poses); 0 is off. |
| `fastSpeed` | 4 | Mixed timing: the speed in m/s above which `fastOnFrames` applies (it drops back below 80 percent of it). |
| `holdTransform` | true | Hold the drawn meshes' world pose between steps; the gameplay transform keeps moving. |
| `holdSkeleton` | true | Hold the skinned skeleton's pose between steps; its clips keep playing underneath, so animation events stay on time. |
| `children` | true | Hold the drawn meshes and skeletons under the entity too. |
`HeldFramesScene` (one per scene, made by `setDefault` on a synced entity named "FrameTiming", taken off by `clearDefault`, which returns the default to twos for HeldFrames with `onFrames = 0` and holds no other body) holds the scene default: `onFrames`, `baseRate`, `fastOnFrames`, `fastSpeed`, `allSkeletons`. Both are synced and saved with the scene.
## The module
`set(e, timing, opts?)`, `clear(e)`, `setDefault(timing, { allSkeletons })`, `clearDefault()`, `getDefault()`, `presets()`, `timingOf(e)`, `now()`, `drawing(onFrames, baseRate)`, `holdPose(e, seconds)`, `isHolding(e)`, `measure(e, seconds)`, `stats()`, `resetStats()`, `afterHold(fn)`, `setActiveInEdit(on)`. Each is described in `FrameTiming.module/README.md` and its `--!desc`.
### Held hit pose
`FrameTiming.holdPose(enemy, 0.25)` freezes a character on the drawing of a hit for a quarter of a second while its clips, movement and physics run on underneath; when it lets go it snaps to wherever its animation is by then, the way an anime holds the frame of a blow. impactFrames' `holdPose` style uses it on the hit character and the attacker.
## How it keeps the game at full speed
Nothing the game reads is held. The gameplay entity, its colliders, physics body, scripts and camera are never touched, so movement, physics, raycasts, picking and controls run every frame as before. What is held is only what is drawn:
- **Skeletons:** the AnimGraph driving a held body keeps ticking every frame (clips advance, events fire), but its pose is handed to the armature only on a step of the clock.
- **Drawn subtrees** (children with no collider, body, camera or listener under them, such as an avatar's visual): kept in place in their parent's space between steps, from the parent's current pose each frame, and snapped back onto the gameplay pose on each step.
- **A mesh on the gameplay entity itself** (a physics ball, a scripted prop): drawn by a local, unsynced proxy moved only on steps; the original mesh is hidden.
## Measured
`FrameTiming.measure(entity, seconds)` watches a held entity at the end of every frame and reports how often its gameplay transform moved against how often its drawn pose changed. Measured in the showcase (the Anime Looks world), and checked by the test suite on every run:
- A child mesh of a root moved by a component every frame, on threes: the root moved on 45 of 45 frames, the drawn mesh held still to under 1 cm between steps and landed back on the root within 1 mm on every step (`child mesh holds its world pose between steps`).
- A falling physics ball on twos: its body moved on over 80 percent of frames, its drawn proxy changed only on frames where the 12-a-second drawing index changed, and never more than once per drawing (`physics body moves every frame, drawn pose only on steps`).
- Measured on 12 November 2026 in the showcase, in play, in a client running the game at full speed (a sphere moved by a script every frame, `FrameTiming.measure` over 4 seconds):
| Timing | Game frames a second | Frames the gameplay transform moved | Drawn pose changes a second | Expected (24 a second base) | Changes off a step |
|---|---|---|---|---|---|
| twos | 57.0 | 229 of 229 | 11.7 | 12 | 0 |
| threes | 39.1 | 157 of 157 | 7.97 | 8 | 0 |
So the game (movement, physics, controls, the camera) updates on every frame while the drawing holds each pose for two or three steps of the 24-a-second animation clock. The same probe in the desktop editor, which drew only 9 to 15 frames a second in the heavy forest scene, read 8.3 changes a second on twos: below 24 frames a second every frame already crosses a drawing, so holding on twos only shows once the game runs faster than the drawing rate.
The script cost is reported by `FrameTiming.stats()` (`avgMs`, `peakMs`): a handful of characters costs a few hundredths of a millisecond a frame; it grows with the number of held drawn subtrees (a few property reads and writes each per frame).
## Multiplayer
The timing lives in synced component fields, so every player holds the same objects on the same timing. Steps come from a shared clock (`FrameTiming.now()`): each peer's frame time plus an offset the host broadcasts every two seconds, so two players see the same drawing index at the same moment. The holding itself is done on every machine locally and sends nothing per frame.
Any player can change the timing (since 1.0.3). A synced entity belongs to one player, usually the room's host, and only its owner can write it, so `set`, `clear`, `setDefault` and `clearDefault` on any other player's machine send the change to the room on the `frameTiming.op` channel and the owner applies it for everyone. Before 1.0.3 `setDefault` made the "FrameTiming" holder with a plain spawn, local to the machine that made it, so a timing set there changed on that screen only; 1.0.3 makes the holder synced, and syncs one saved by an older version the next time the scene timing is set.
## Known limits
- **Edit mode does not hold** unless `setActiveInEdit(true)` is called with the clock running, so a save in the editor never catches a counter-moved mesh.
- **A world script that steps once per drawn frame stalls while the editor skips frames** (engine #22740): in a struggling editor the held clock still follows wall time, so drawings are skipped rather than slowed.
- **Non-uniformly scaled, rotated parents** hold their drawn subtrees with per-axis scale, which is exact for uniform scale and close for mild non-uniform scale.
- **Particles, trails and cloth** are not held; they keep the display rate.
## Contents
- `FrameTiming` (module): the runtime and API.
- `HeldFrames` (component): one object's timing.
- `HeldFramesScene` (component): the scene default.
- `tests/frameTiming.testSuite`: the measurements above, the API and the held hit pose.
## Version history
Now **1.0.4** (1.0.4: a short description and a lead that says what it gives and how to start, with the history moved here; 1.0.3: any player can set the timing and everyone sees it, the scene timing lives on a synced entity, and `clearDefault()` takes it off). Built on the engine's own animation graph (`@builtin::systems.anim.AnimGraph`); no animator or character code is edited. Every player sees the same drawings: steps come from one shared clock.
# styleKit
Build your own art style out of stackable look blocks: a look is a stack of small blocks (a wash, an ink line, a paper, a grain) that runs over the whole frame after antialiasing, lives in the scene and looks the same for every player.
Version 1.7.8.
## Install and use
Install **styleKit** from ZeroMind (search "styleKit" or "stackable art style blocks"). Installs with several dependencies can be slow (#21420), so give an install time to finish and check `/zero/source` for the package folder. Then, from the console or any script, stack one of each of the kit's four example blocks:
```luau
local StyleKit = require("~styleKit.StyleKit")
StyleKit.add("posterize") -- Colour: a few flat tone steps
StyleKit.add("duotone", { strength = 0.5 }) -- Colour: two inks, laid half over the posterize
StyleKit.add("depthLine") -- Line: a clean ink outline from depth
StyleKit.add("sketchLine", { strength = 0.6 }) -- Line: soft pencil strokes laid over the outline
print(#StyleKit.describe().entries) -- 4
StyleKit.clear() -- the frame is exactly as rendered again
```
No material is edited. The first `add` makes a synced `StyleStack` entity in the scene, so every player draws the same stack; put a `StyleStack` component in your scene's build to keep a look with the scene.
## The blocks in this package
| Block | Slot | What it does |
|---|---|---|
| `posterize` | Colour | Cuts the picture into a few flat tone steps, like a screen print. |
| `duotone` | Colour | Maps the picture onto a shadow ink and a light ink. |
| `roleGlaze` | Colour | Roles glaze: a transparent glaze of one colour over the objects of one group (a variant), keeping their light and shade. `StyleRoles.use` adds one per group from a role set's `glazes`, so a hero, the enemies and the pickups that share a material still read apart under any look. |
| `depthLine` | Line | A clean, one-sided ink outline from depth plus creases from normals. |
| `sketchLine` | Line | Soft, broken pencil strokes over shape and colour edges, redrawn on the held clock. |
| `sharedView` | Medium | A diagnostic for block authors: shows one shared input in place of the picture. |
Every block lists its slot and its tags (the words a person would search for: `watercolor`, `pencil`, `halftone`, `pixel art`, `chalk`), so you can pick blocks by tag with `StyleKit.blocks({ tag = "pencil" })` or `zero styleKit list --tag pencil`. A block's tags come from its `block.yaml` `tags:` list when it has one, otherwise from its `.metadata` tags.
More blocks come in their own packages and plug straight in: `starterBlocks` has a block for every slot (card surface, light bands, flat wash, surface dots, plain paper, dark board, line boil, chunky pixels, soft grain, vignette), `watercolorBlocks` has ten chained watercolor Fill blocks and a cold-press paper, with pigment sets, whole looks and a hero material, `inkBlocks` has five ink lines, four ink fills, ink colours and whole looks, and `paperBlocks` has seventeen papers (cold press, rough, hot press, rice, newsprint, kraft, parchment, canvas, board, blackboard, green chalkboard, black paper, aged sketchbook, toned grey and tan, ruled notebook, vellum) that publish the paper field and layer by region. `StyleKit.blocks()` lists every block installed. A package can also ship pigment sets (`pigmentSet` assets: `StyleKit.pigmentSets()`) and whole looks (`styleLook` assets: `StyleKit.looks()`) next to its blocks.
## How a stack works
A stack is an ordered list of entries `{ id, block, on, strength, mask, settings }` on a `StyleStack` component. Blocks sit in ten slots that always run in this order:
1. **Surface**: what things are made of.
2. **Light**: how surfaces take light.
3. **Fill**: how areas of colour are laid.
4. **Tone**: marks that carry shade.
5. **Line**: edges.
6. **Colour**: palette and grade.
7. **Ground**: what it is drawn on. The first Ground block publishes the shared ground (and the paper field, when it has one); a later Ground block whose field says `layers: true` lays its ground over the one before by its strength and mask.
8. **Time**: how motion is held. The first Time block publishes the shared wobble.
9. **Raster**: how the image is sampled.
10. **Medium**: what it is seen through.
Any slot can be empty. Any block swaps for any other block of its slot with no other change (`StyleKit.swap(entry, otherBlock)`); strength and mask stay. Inside a slot the list order decides: the first block reads the slot's input, and every later block in the same slot reads the same input and is laid over it by its strength and mask (`stacking: layer`, the default). So two Line blocks with weights 1 and 0.4 blend 60 / 40, and two Fill blocks with complementary masks split the frame. A block whose `block.yaml` says `stacking: chain` reads what the blocks before it in its slot made instead, so modifier blocks build on each other (a wash, then its granulation, then its darkened edges). A block's `rank: <number>` decides where `StyleKit.add` places it: before the first block of its slot with a higher rank, so a chain lands in its painting order whatever order its blocks are added in.
### Keeping a stack
A stack made with these calls is a live edit of the scene, like moving a prop. Save the scene (`layers.active:save()` or the editor's save) and the stack is in its `scene.json`: it comes back on every load and after a restart, the same for every player. `StyleKit.clear()` takes every block off the frame; to get the saved stack back, revert the scene (`tools.use("scene", "revert")`). `scene.reload` keeps live edits by saving them first, so a clear followed by a reload is a saved clear. Keep one StyleStack per scene.
### Shared by every block in a stack
- **One clock.** `sk_time()` and the held clock `sk_held()` / `sk_step()`, stepped at the stack's `holdRate` (8 per second by default). Every wobble and boil runs on the held clock.
- **One set of coordinates that stay on things.** `sk_surface_coord(uv, perMetre)` lays marks on surfaces from world position along each surface's main axis, and on the sky from the view direction, so a pan or a dolly does not drag them.
- **Surface data copied once per frame**: view distance, world position, normal and base colour (`sk_dist`, `sk_world`, `sk_normal`, `sk_albedo`).
- **One ground** (`sk_ground_at`): paper colour and grain height, published by the first Ground block (plain white paper with flat grain when there is none).
- **Layered grounds** (since 1.2.0): a later Ground block whose `block.yaml` field says `layers: true` lays its ground, and its paper field, over the one before by its strength and mask, so regions of a world sit on different papers: `StyleKit.add("paperParchment", { id = "mapRoom", mask = { kind = "sphere", center = { 30, 2, 10 }, radius = 6 } })`. A Ground block without `layers: true` publishes only when it is the first.
- **One paper field** (`sk_paper`, read through `skPaper`, since 1.2.0): how the sheet under each pixel takes paint and ink, for a block that lists `paper` under `reads`: `sk_thirst(uv)` (-1 hard-sized, 0 the standard sheet blocks are tuned on, +1 thirsty), `sk_sheen(uv)`, `sk_fibre(uv)` and `sk_dark_ground(uv)` (1 where the sheet is dark and the picture is made of light marks). A Ground block publishes it with a `field.paper` shader; where none does every value is 0, so a block reading it draws exactly as before. It is only made when some live block reads it. paperBlocks' papers publish it; watercolorBlocks' bleed and edge darkening and every inkBlocks block read it.
- **The scene's sun** (`sk_sun`, a float4, since 1.2.0): for a block that declares it and lists `sun` under `reads`, the direction toward the sun the renderer shades the scene with (`lighting.sun()`), `w` 1 when it gives light (0, and a default direction, when there is none). Read every frame as a table the engine keeps current (nothing in the scene is surveyed), and written to blocks only when its direction (to three decimals) or whether it lights actually changes, so a still sun costs nothing and a moving one reaches blocks on the next frame. Raking light on paper tooth and sheen use it.
- **One wobble** (`sk_wobble_uv`): an offset published by the first Time block (still when there is none). A wash and an ink line that both read it tremble together.
- **One pattern library** (`skPatterns`): noise, fractal noise, cells, dots, hatching, ordered threshold, triplanar noise for materials (`skp_triplanar_fbm`) and brush strokes (`skp_stroke`).
- **One soft field** (`sk_soft`, read through `skSoft`): a half-resolution, depth-aware blur of what a block reads, for a block that lists `soft` under `reads`. Each tap is tested against the centre surface's plane rebuilt from world positions, so a nearer thing is never smeared over a farther one. The stack makes it for the first block that reads it and makes it again whenever a later reader reads a different image; its width is the stack option `softRadius` (reference pixels, 10 by default).
- **One pigment set** (`sk_pigments`, read through `skPigmentSet`): the scene's palette of paints as a 16 x 1 texture, for a block that lists `pigments` under `reads`. `StyleKit.setPigments(id)` changes it for every block and every player at once; with none picked blocks keep the scene's own colours.
- **One rendered frame** (`sk_rendered`, read through `skRendered`): the frame as it entered the stack, for a block that lists `rendered` under `reads`. Light estimates read it against the base colour, so surface texture cancels instead of printing back as shade. With `sk_geo_normal` (a normal rebuilt from world positions, every tier) it lets a block judge light and shape on the low tier and the forward path too.
- **One way to mix paint** (`skPigment`): pigment mixing in transmittance and optical density (log space), two pigments in one wash, glazes that multiply, dilution toward the paper. Pure math, so a full-frame block and a material mix paint the same way.
- **Noise that stays on things and keeps its size** (`skAnchored`): triplanar noise on world position that stays on still things (`sk_anchored_fbm`, `sk_anchored_cells`), and noise that also keeps its size in the picture at any distance by blending two octaves by distance (`sk_scaled_fbm`, `sk_scaled_level`, `sk_surface_plane`, `sk_ref_metres`), for paper tooth, flecks and strokes. `sk_tooth(uv)` reads the shared paper's valleys (0 on a peak, 1 in a valley).
- **Chain stacking** inside a slot (`stacking: chain` and `rank` in `block.yaml`): later blocks build on what the ones before them made.
- **Many blocks, one shader** (`defaults:` in `block.yaml`, since 1.2.0): a block's own defaults over its shader's, so a family of blocks (paperBlocks' seventeen papers) shares one shader and each block is its own starting point. `StyleKit.settingsOf(id)` reports the block's defaults.
- **Swap memory** (since 1.2.0): each stack entry remembers the settings of every block it has held, so `StyleKit.swap("paper", "paperKraft")` then `StyleKit.swap("paper", "inkPaper")` puts back exactly the settings `inkPaper` had, and the frame returns exactly. The memory is kept on the entry in the synced stack, so it is shared and saved with the scene; `load` and `applyLook` write new entries without it.
- **One exit** (`sk_finish`): strength, mask, layer mode, and black stays black: a block never makes light where the frame had none.
- **Strokes for shading blocks** (`skStrokes`, since 1.3.0): hand-laid strokes that build up by tone, for any block that shades with marks (pencil, charcoal, hatching, scribbles). Since 1.4.0 every layer of strokes at one place shares the same patch grid and the same random slant, so layers keep exact angles to each other; outside crossed mode the first two layers run parallel (the second fills between the first) and darker layers cross at clear angles (60 degrees each way, then 30, then square), so soft strokes never beat into broad zebra bands. `sks_layer_d(p, n, tone, dpx, dpy, px_per_ref, st, k)` sizes the strokes across their own width on screen from the position's screen derivatives, so the spacing is the same number of pixels whichever way strokes run and however steeply a surface is seen; prefer it over `sks_layer` wherever derivatives are at hand. Since 1.4.1, `sks_edge_on(facing)` says how much of its stroke pattern a surface keeps from how squarely it faces the eye, and `sks_layer_mean(tone, st, k)` is the average coverage a layer gives: on a floor or a field seen at a low angle, patches of strokes squeeze into rows whose ends read as zebra bands, so mix each layer toward its average there and the ground keeps its value as even rubbed tone.
- **The dim guard** (since 1.4.0): keeps a dark scene dark. See the next section.
### Keep a dark scene dark: the dim guard
A shading block lays marks and a sheet over the picture, and in a dim room the sheet and the light between the marks can end up brighter than the room was. The dim guard stops that, so no shading block (hatching, stipple, dots, pencil, charcoal) brightens a dim or unlit room.
- **When it runs.** When any live block in the stack declares `keepDim`. Every Tone slot block does unless its `block.yaml` says `keepDim: false`; a block in another slot opts in with `keepDim: true`. So a new shading block in the Tone slot gets the guard for free.
- **What it does.** Two small passes after the chain. A meter at an eighth of the chain's resolution records the mean brightness of the stack's result and of the frame as rendered under each of its texels, plus how bright the rendered picture's brightest parts are (a power mean over a fixed 5 by 5 grid) and its overall mean. Then the guard scales the result down wherever, smoothed over about 36 pixels, it is brighter than the rendered frame there (with no allowance since 1.4.4; it was 0.006, about 1.5 of 255). Then it holds each pixel to at most a fifth above the rendered brightness on its darker side: the darkest of four small patches ten pixels off (left, right, above, below), never below the pixel's own rendered brightness. Bare sheet beside a pale prop in a dark-walled room is held to the wall it lies on instead of keeping the prop's brightness and glowing around it, the prop's own edge to the prop, and a patterned surface to its mean, so no texture prints back. It scales rather than clips, so every mark keeps its shape.
- **Only on a dim or unlit picture.** It lets go fully once the picture's mean is 0.42 or above, its brightest parts are at 0.55 or above and some light other than an ambient one is on (daylight, an overcast day, a well lit room), and is fully on below a mean of 0.30 or brightest parts of 0.40. A scene with no light switched on (the engine falls back to a default ambient) counts as unlit however bright that fallback draws it. In a lit frame it hands the result on exactly unchanged. A night street, or a room with dark walls under one lamp, has bright spots but a low mean, so it is guarded.
- **Cost.** Two small passes, only while a block that keeps dim is live. `StyleKit._status().dimGuard` reports whether it ran last frame.
Blocks registered before 1.4.0 (the registry survives hot reloads) get their `keepDim` filled in by the kit, so an upgrade needs no restart.
### Masks
`StyleKit.setMask(entry, mask)` limits a block:
- `{ kind = "depth", near = 0, far = 12, soft = 0.2 }`: by view distance in metres. The soft edges lie outside the band and scale with their own distance: the block fades in over `soft` x `near` metres before `near` and out over `soft` x `far` metres after `far`, so nothing nearer than `near` x (1 - `soft`) is touched, whatever `far` is. The sky lies at the viewing camera's far distance (its `Camera.far`, 8000 m by default): a band whose `far` reaches that distance takes the sky in, a shorter one leaves it out.
- `{ kind = "rect", rect = { x0, y0, x1, y1 } }`: a screen region in 0..1 (top left is 0, 0).
- `{ kind = "sphere", center = { x, y, z }, radius = 5 }`: a region of the world.
- `{ kind = "group", group = 1 }`: the objects in mask group 1, 2 or 3 (`StyleKit.options({ groups = { { id, id }, { id } } })`).
- `invert = true` flips any of them.
`StyleKit.options({ exclude = { "SignBoard" } })` leaves objects (and their children) exactly as rendered: a prop, a world label. Name them: an entry is an entity name or an id, and a scene should store names, because an id written into the stack does not survive the scene being saved and loaded again (the entity comes back under a new id). Entities that arrive later are picked up within half a second. Put labels on a card of their own (a plain white quad behind the words), so the area left out around them is card rather than the raw scene.
### Players, enemies and pickups under one look: style channels
A look treats every object the same unless the object says otherwise. A `StyleChannel` on an object (synced, saved with the scene) says how the look treats it and everything under it:
- **variant**: which variant of the look it gets. A stack entry that names a `variant` draws only on objects of it, and an entry of the same slot that names none leaves those objects to it, so two blocks share one slot by group: one ink for the player, a different ink for the enemies. `"asRendered"` leaves the object exactly as rendered (labels, in-world HUD, a screen inside the world).
- **line**: how heavy its lines and strokes are (1 as the look draws them, 2 twice as heavy, 0 none). Read by styleKit's `depthLine` and `sketchLine`, every inkBlocks line, pencilBlocks' lines (width) and shading (stroke density), and toonBlocks' ink (width).
- **marks**: how much of each kind of mark reaches it, 0 to 1: `line` (Line blocks), `tone` (Tone and Light blocks: hatching, dots, bands), `fill` (Fill, Surface and Colour blocks: washes, cel fills, posterize) and `paper` (Ground blocks: how much paper shows through). Every block honours this with no change of its own: the kit weighs each block by its kind of mark on each object. A block may name its kind in `block.yaml` (`marks: line | tone | fill | paper | none`); otherwise its slot decides, and the Time, Raster and Medium slots are screen-wide.
- **value**: one free value, 0 to 1, a block may use however it likes; 0 changes nothing. The shipped blocks read it as "how much of its own colour the object keeps": watercolorBlocks' wash keeps its colour brighter and purer, inkBlocks' wash keeps its colour through the ink, toonBlocks' ink takes its colour.
- **ink**: the colour of its line, for blocks that take one per object (toonBlocks' ink).
- **role**: a game role (`hero`, `enemy`, `pickup`, ...). The scene's role set fills in every field the object does not set itself. Role sets are `styleRoleSet` assets; the **styleRoles** package ships sixteen roles tuned for six kinds of look.
```luau
local StyleKit = require("~styleKit.StyleKit")
StyleKit.give(entity.findAll("Goblin")[1], "enemy") -- one thing, one change
StyleKit.setChannel(entity.findAll("Coin")[1], { marks = { tone = 0, paper = 0 }, value = 0.8 })
StyleKit.setChannel(entity.findAll("ScoreBoard")[1], { variant = "asRendered" })
StyleKit.add("depthLine", { id = "enemyInk", variant = "enemy", settings = { ink = "#6a0a0a", width = 2.4 } })
StyleKit.setRoles("toonGame") -- the whole game's roles, one change
print(StyleKit.channelOf(entity.findAll("Goblin")[1]).line)
```
An object with no channel, in a scene where none has one, draws exactly as before: the kit makes no object mask and gates no block. Every field is synced on the object's own entity, so every player sees the same roles on the same things, they survive a save and reload, and a change made in play (by any player; a write from a player who does not own the object goes to its owner) reaches everyone. A child with a channel of its own keeps its own; things attached under a role holder later are picked up within ten seconds (at once when its channel changes).
**How it runs.** Objects are grouped by what they ask for into at most eight distinct settings; each setting is one geometry pass into a small image of its own, and one pass packs them into the object mask every block reads (`sk_obj`). A block reads its object through `sk_chan_line(uv)`, `sk_chan_line_near(uv, r)` (the nearest surface within `r` reference pixels, so a line drawn just outside a silhouette belongs to the thing in front), `sk_chan_value(uv)`, `sk_chan_mark(uv, kind)` and `sk_chan_tagged(uv)` from `skCommon`; the gate by kind of mark and variant is applied inside `sk_weight`, so `sk_finish` honours it for every block. Measured on toonBlocks' busy bench (2,500 things, 250 moving, 25 a second spawned and despawned, Comic ink cel), look stack script time a frame:
| | The whole look (median) | average | Toon ink (median) | styleKit (median) |
|---|---|---|---|---|
| Roles off | 0.44 ms | 0.53 ms | 0.11 ms | 0.32 ms |
| 150 things with a role, toon game set | 0.63 ms | 0.78 ms | 0.17 ms | 0.44 ms |
| 600 things with a role, toon game set | 0.93 ms | 1.25 ms | 0.26 ms | 0.64 ms |
| 600 things with a role, before this release (toonBlocks 1.3.5, styleKit 1.6.3) | 1.33 ms | 2.29 ms | 0.60 ms | 0.55 ms |
Measured on 11 November 2026 with toonBlocks' busy bench (`design/roles/bench_roles.luau` in the Style Cookbook world): 2,500 things, 250 of them moving, 25 a second appearing and 25 disappearing, 10 recoloured a second, under the Comic ink cel look; script time the look spends each frame. It ran in a test client of its own drawing 14 to 17 frames a second on a shared, busy desktop, which overstates every per-frame number; your game on its own will measure lower. What changed: toonBlocks 1.3.6 draws every role ink through one shared flood (104 render passes a frame for 600 role holders in nine inks before, 22 now), and styleKit 1.6.4 rebuilds the role mask at most four times a second while roles keep changing. So the whole look stays under a millisecond on the median frame with 600 role holders, and well under one (about 0.6 ms) with the 150 or so a typical level gives roles to. What is left is mostly styleKit queuing its eight mask passes and their selection lists again every frame (#24548): with hundreds of role holders and a slow client the average frame can pass 1 ms. The GPU time of the look did not change measurably.
### Quality
The stack follows the device's quality tier (`renderer.qualityTier()`), and the tiers really change the cost:
- `high` and `medium`: every block pass and every shared input at full resolution. `medium` also applies each block's `quality.medium` settings where it states them.
- `low`: the shared inputs (surface data, ground, wobble) and the block chain itself run at half resolution, a quarter of the pixels for every pass, and blocks take their `quality.low` settings (fewer samples, fewer strokes). The copy of base colour and normals is made on `low` too, at that half resolution (since 1.1.4), so a block judges light and lays marks by the same rules on every tier and a look stays the same look; only the forward render path, which keeps no g-buffer, goes without it. The result is scaled up once at the end, before the UI; excluded objects are put back from the full-size frame, so they stay crisp. Measured on the Lookbook's textured wall at 2097 by 1409 with a wash, a sketch line, paper, boil and dots: 1.64 ms of block passes at full resolution, 0.30 ms on `low` (before the half-size copy, which adds one small compute pass).
On `low`, marks are drawn at half resolution and so are softer: the honest trade for running on a small device. `StyleKit.setQuality("low")` forces a tier on this machine; `StyleKit.setQuality(nil)` follows the device again. The Lookbook measures the cost per pass at each tier.
### Whole frame or inside a material
Every block works on the whole frame with no material edits. Where it means something, a block also ships a shader module a material includes for a chosen set of objects (`include:` in its `block.yaml`), for example starterBlocks' Stepped light, whose `bandedToon` shader bands a material by the same rule. Use a group mask to keep the full-frame pass off those objects.
## API
| Call | What it does |
|---|---|
| `StyleKit.blocks(filter?)` | Every block installed: `{ id, name, slot, tags, summary, reads, writes, settings, package, path }`. Filter by `slot`, `package`, `tag` (one tag or a list, all must match) or `text` (which also searches tags). In the shell: `zero styleKit list`, `zero styleKit list line`, `zero styleKit list --tag pencil`. |
| `StyleKit.block(id)` / `settingsOf(id)` | One block / its settings with docs, defaults (the block's own `defaults:` where it states them) and ranges. |
| `StyleKit.add(id, opts?)` | Add a block (`strength`, `mask`, `settings`, `id`, `index`). Returns `ok, entryId`. |
| `StyleKit.remove(entry)` | Remove an entry (by entry id, block id or position). |
| `StyleKit.swap(entry, id, opts?)` | Swap an entry's block for another of its slot; strength and mask stay. The entry remembers the settings of every block it held, so a block swapped back in gets exactly the settings it had (a block it never held starts from its defaults). `{ keepSettings = true }` carries the current settings across instead; `{ anySlot = true }` allows a swap across slots. |
| `StyleKit.move(entry, index)` | Reorder (orders blocks inside a slot). |
| `StyleKit.setStrength(entry, 0..1)` / `setOn(entry, bool)` | Weight / switch an entry. |
| `StyleKit.setMask(entry, mask?)` | Limit an entry by depth, region or group. |
| `StyleKit.set(entry, { name = value })` | Change settings. Colours take `"#rrggbb"`, `{ r, g, b }` or `{ r, g, b, a }`. |
| `StyleKit.load(entries, opts?)` / `clear()` | Replace the stack's blocks / empty the stack. `opts`: `holdRate`, `markScale`, `pigments`, `softRadius`, `look`; an option left out keeps the stack's current value, so to reproduce a look exactly pass all of its options or use `applyLook`. |
| `StyleKit.options({ holdRate, markScale, exclude, groups, active, pigments, softRadius })` | Stack-wide options. `pigments` is a pigment set id (`""` for none); `softRadius` is the soft field's width in reference pixels (2 to 40, default 10). |
| `StyleKit.pigmentSets(filter?)` / `pigmentSet(id)` | Every pigment set installed: `{ id, name, summary, tags, pigments = { { name, colour, granulation } }, shadow, light, air, package, path }`, filtered by `package`, `tag` or `text` / one set by id. |
| `StyleKit.setPigments(id)` | Pick the pigment set every block that reads pigments mixes from, for the whole stack and every player. `""` picks none, so blocks keep the scene's own colours. |
| `StyleKit.looks(filter?)` / `look(id)` | Every whole look installed (`styleLook` assets): `{ id, name, summary, tags, entries, pigments, holdRate, markScale, package, path }` / one look by id. |
| `StyleKit.applyLook(id, opts?)` | Apply a whole look in one change: its blocks replace the stack and its pigment set, hold rate, mark scale and soft radius are set with them. `{ keep = { "line" } }` keeps the entries of the slots named from the current stack. A look naming a block that is not installed is refused and nothing changes. |
| `StyleKit.describe()` | What is in the stack, in run order, its `pigments`, `look` and `softRadius`, and what the runtime drew last frame. |
| `StyleKit.checkBlock(id)` | Problems with a block against the block rules (empty when it passes). |
| `StyleKit.newBlock(name, { slot, folder })` | Write a working block of your own to start from. |
| `StyleKit.quality()` / `setQuality(tier?)` | The tier the stack draws at / force one here. |
| `StyleKit.setLocal(entry, settings?)` / `localSettings()` | Lay settings over one entry on this machine only, over its synced settings (a tint or a ramp for the level this player is on); nothing is synced or saved, `nil` takes them off / list what is laid here. |
| `StyleKit.setLocalEntry(id, entry?)` / `localEntries()` | Lay a whole entry on this machine only (`{ block, strength, on, mask, settings, variant }`), after the synced stack and ordered by slot like any other: for short local effects such as an impact frame on a hit, which a game keeps in step across players with a message of its own. Never synced or saved; works with no StyleStack in the scene; `nil` removes it. (Contributed by another account as pull request #10, ported onto 1.7.0.) |
| `StyleKit.publishInput(name, texture?)` / `inputs()` / `inputWanted(name)` | Publish a texture another package computes (a heat map, a sonar wave, a thickness map) on this machine for blocks that list `input:<name>` under reads and declare an `in_<name>` texture; `nil` withdraws it (blocks read black). `inputWanted` says whether a live block reads it now, so the producer works only then. Never synced or saved (1.8.0). |
| `StyleKit.setClock(fn?)` | Drive the stack's one clock (boil, grain, wobble) from your own time in seconds, for a cutscene, a recording or the Lookbook; `nil` returns to the shared clock (wall-clock UTC, the same held step on every player's machine). |
| `StyleKit.give(entity, role?)` | Give one object (and everything under it) a game role, for every player and saved with the scene; `nil` takes it away. |
| `StyleKit.setChannel(entity, fields)` / `channelOf(entity)` / `clearChannel(entity)` | Set how the look treats one object: `{ role, variant, line, marks = { line, tone, fill, paper }, value, ink, children }` (-1 or "" gives a field back to the role) / what it gets now, read through the scene's role set, and which object's channel reaches it / take its channel away. |
| `StyleKit.channels()` | Every object a channel reaches with what it gets, and a revision that moves when any of it changes (for runtimes that draw per object). |
| `StyleKit.setVariant(entry, variant?)` | Share a slot by group: the entry draws only on objects of that variant, and the entry of its slot naming none leaves them to it. `add` takes `variant` too. |
| `StyleKit.setRoles(id)` / `roles()` / `roleSets(filter?)` / `roleSet(id)` | Pick the role set for the whole scene and every player ("" follows the look, "none" reads no roles) / the set in use / every installed set / one set, with what it extends laid under it. |
| `StyleKit.lookRoles()` | The set the scene's look suits by itself: what a set written with `extends: look` (a set for a kind of game) is laid over. |
Writes go through the stack's owner, so in play any player can change the shared stack and every player sees the change. The `styleKit` toolbox offers the same from the shell (`zero styleKit list`, `zero styleKit stack`, `zero styleKit add posterize`).
## Writing a block
A block is a plain folder holding `<name>.styleBlock/` (block.yaml, README.md, .metadata) and its `<name>.shader/` (a post-process shader whose `properties.yaml` starts with the styleKit shared header). `newBlock` writes one that works and registers it at once:
```luau
local StyleKit = require("~styleKit.StyleKit")
local path = StyleKit.newBlock("warmTint", { slot = "medium", title = "Warm tint" })
print(path) -- /zero/source/myBlocks/warmTint/warmTint.styleBlock
StyleKit.add("warmTint", { strength = 0.6 }) -- a warm filter over the whole look
StyleKit.set("warmTint1", { tint = "#ffcf8a" }) -- its setting, like any block's
```
Then edit `/zero/source/myBlocks/warmTint/warmTint.shader/shader.wgsl` to make it do what you want; the stack picks up the change as you save. To share blocks, move their folders into the `blocks/` folder of a package of your own (a `<name>.package` folder with its `package.yaml`): a package that holds blocks adds them to every world that installs it, with no code. The guide "Writing your own style block" walks the whole shape every block follows.
A block that shades the picture (hatching, stipple, dots, a pencil shade) belongs in the Tone slot, where it is kept from brightening a dim room by the dim guard with no work of its own. A block in another slot that lays a light sheet or light marks over the picture can ask for the same with `keepDim: true` in its `block.yaml`; a Tone block that should be left alone in the dark says `keepDim: false`.
## Rules every block follows
- It states its slot, what it reads and what it writes, and takes over nothing it does not own (a Ground block alone writes the ground, a Time block alone the wobble).
- Every setting is named, documented in `block.yaml` and has a good default in its shader.
- Marks stay on things unless the medium really is a screen (pixels, grain, a vignette), and they run after antialiasing and upscaling.
- Wobble runs on the held clock.
- Its README says what it gives up in motion and how it treats opaque things, transparent things, particles, sky, fog, skinned characters, foliage and world text.
- With every light off the frame stays black (`sk_finish` holds every block to it), and a dim room stays dim (the dim guard holds every block that keeps dim to it).
- The UI is drawn after the stack, so it stays readable.
- No full-screen flashing above 3 Hz and no fine high-contrast stripes filling the view.
`StyleKit.checkBlock` and the `styleKit` test suite check the rules that can be read from files.
## Guides and workflow
This package carries its guides (search them with the `guides` tool or ZeroMind): combining blocks into your own art style, how to use styleKit, writing your own style block, and a worked example from an empty world to a small stylized game. The `restyleWorld` workflow gives an existing world, scene or kit a new look non-destructively, and the `styleKit` agent skill tells an agent what it can do with blocks.
## What a look costs
GPU milliseconds per frame of the style passes, 3D view drawing at 1893 x 1072 (98% of a 1920 x 1080 frame's pixels), measured with the Lookbook (`zero lookbook cost 1920 1080 true`) over its pan on a desktop GPU. The rest of the frame (scene, shadows, antialiasing) is not counted. Low quality runs the whole chain at half resolution.
| Look | High | Low |
|---|---|---|
| README example: posterize, duotone 0.5, depthLine, sketchLine 0.6 | 0.60 | 0.11 |
| Cookbook: flatWash, depthLine, plainPaper, lineBoil, softGrain 0.6 | 1.03 | 0.21 |
| Comic: lightBands, surfaceDots, depthLine, posterize | 0.41 | 0.10 |
| Chalk: depthLine, darkBoard | 0.43 | 0.10 |
| Retro: posterize, chunkyPixels, softGrain, vignette | 0.22 | 0.07 |
Each block alone, high / low: flatWash 0.45 / 0.07, sketchLine 0.32 / 0.06, darkBoard 0.24 / 0.07, plainPaper 0.23 / 0.07, depthLine 0.19 / 0.04, cardSurface 0.11 / 0.03, lightBands 0.09 / 0.03, surfaceDots 0.09 / 0.03, softGrain 0.09 / 0.03, lineBoil 0.06 / 0.02, chunkyPixels 0.06 / 0.02, posterize 0.05 / 0.02, duotone 0.04 / 0.02, vignette 0.04 / 0.02. A look costs a little less than its blocks added up, because the shared inputs (depth, surface coordinates, ground) are made once per frame for the whole stack.
**Frame rate and the web.** On the web the Cookbook look was measured at about 29 to 30 fps in the Cookbook scene (one sample 25), against about 43 fps with no look, and the low tier did not change it: the look cost about 10 ms a frame there while its passes took about 1 ms of GPU time. That measurement is of styleKit 1.0.6. The cost was not the shading but the work around it, which a browser pays several times over: 15 screen-sized images made up front whatever the look, 11 passes, and engine calls every frame for every effect. 1.0.7 cuts it, measured on desktop: the Cookbook look now makes 7 images on high and 5 on low (was 15), runs 9 passes on high and 8 on low (was 11), and spends 0.19 ms of Luau a frame on high and 0.12 ms on low (was 0.40 ms on both), so low now saves passes and Luau, not only pixels. **Whether 1.0.7 holds 30 fps on the web is not measured yet:** an agent cannot start a browser engine (#20946), and in the desktop editor the whole-frame rate swings more from the editor's own load than the look costs, so no desktop fps is quoted here. `zero lookbook report` now starts with the frame rate in the scene you are in (no look, the look on high, on low, measured in turns), so one run in the web build gives the answer. The web limits it may still meet are open engine issues: #20750 (web frame rate), #17441 (cost of scene-colour features) and #17478 (post tiers on mobile).
## How it runs
The `styleStack` render feature starts on a machine as soon as the scene's stack holds a live block (one that is on, has strength above 0 and is installed), on every player's machine alike. Each frame it copies the base colour and normal from the deferred g-buffer at `afterLighting`, then at `afterScenePost` (after antialiasing and the render-scale upscale, before the UI) it rebuilds world position and distance from depth, publishes the ground and wobble (only when a block of the look publishes them; otherwise blocks read a tiny constant image written every few seconds), runs each slot and hands the result to the screen, blending it over the frame as rendered so excluded objects stay as they were (one pass, no copy of the frame). When a live block keeps dim, the dim guard's two small passes (a meter at an eighth of the chain's resolution, then the guard) run between the last slot and the hand-off. A frame of the Cookbook look runs 9 passes: the copy of base colour and normals (only when a live block reads them, and never on the low tier), world position, the two shared fields, one pass per block, and the hand-off to the screen; the blocks read the scene directly, so there is no copy of the frame first. Only five screen-sized images are made up front (the chain's two, world position and the two fields); the rest are made the first time a look uses them (group masks, excluded objects, the base colour and normal copies). A frame in which nothing the stack draws from has moved (the stack, its options, the tier, the images, the camera anchor, the view, the channels) hands the engine the passes of the frame before as they were and skips the rest of its work; a held clock step writes only the clock. Otherwise the Luau work per frame is a few calls into the engine: uniforms, settings and mask groups are written only when the stack, the tier or the camera's frame inputs change, and the clock only when the held step moves. When the stack holds no live block (after `StyleKit.clear()`, or with every entry off) the kit lets everything of its own go within two frames: every block effect and its internal effects (the dim guard's two among them) are removed from the screen effect list, its screen targets, buffer and mask materials are freed, and the render feature itself ends. `StyleKit.holdsAnything()` then reads false, and the first block added brings it all back.
## Known limits
- **Offscreen captures and render-to-texture cameras do not draw the stack.** The stack runs at `afterScenePost`, which only the presented frame reaches, so `capture` with `source = "main"`, `"entity"` or `"position"` shows the unstyled scene; use `source = "presented"` or `renderer.presentedFrames`. Per-camera post: engine issues #66 and #17427.
- **Depth in a feature's fragment pass reads 0 after post.** `zero_scene_depth` is not bound to a render feature's fragment pass at `afterScenePost`, so the kit copies depth with a compute pass once per frame and blocks read that copy (#17427).
- **G-buffer channels are refused after post**, so base colour and normal are copied at `afterLighting`. On the forward path there is no base colour: Surface and Light blocks fall back to working from brightness alone.
- **Marks on moving objects.** Surface coordinates come from world position, so marks stay put on still things under any camera move, but slide across a moving skinned character or a moving prop. Object-space coordinates need per-object data a full-frame pass does not have, so marks that stay on a moving object can only be drawn inside its material: watercolorBlocks' `watercolorSurface` shader shows how, carrying the object's own position from `vertex_clip` (`local_position`) to the fragment in the vertex colour (applied with `WatercolorHero.paint`).
- **The soft field costs two half-resolution passes each time a reader reads a new image.** In a chain, a later block that reads `soft` reads a different picture from the first one, so the field is made again for it; keep soft readers few, or next to each other on the same input, on small devices.
- **Post effects get one pass each and no history** (#17427): a block cannot read the previous frame or its own last output, so nothing in a block can build up or settle over time.
- **Effect uniforms reset on recompile** without notice; the runtime renews its writes twice a second, so after a shader edit a setting can take up to half a second to come back.
- **One held clock for every player, as close as their clocks are set.** Since 1.1.3 the held clock runs on wall-clock UTC (caught to the frame from `os.time()` ticking over), so every machine shows the same boil step at the same moment; machines whose clocks are set by the network agree to a few hundredths of a second, so two screens differ only in that sliver around each step. A machine whose clock is set wrong boils out of step with the others. `StyleKit.setClock` drives it from a time of your choosing instead, so a cutscene or the Lookbook repeats exactly.
- **Transparent things and particles have no depth**, so lines and surface marks treat them as the opaque surface behind them; each block's README says how.
- **Stage order** (#17426, #17439): blocks rely on `afterScenePost` running after the TAA resolve and the upscale, as the engine documents today.
- **A full-screen pass cannot tell which object a pixel belongs to (#22178), and a geometry pass carries no per-object value (#24549).** Style channels are drawn as at most eight distinct settings, one geometry pass and one small image each, packed by one more pass into the object mask. Objects asking for the same thing share a setting, so a game's sixteen roles fit; a ninth distinct setting is left out (the objects it reaches draw as if they had no channel), and `StyleKit._status().parts` says how many were drawn. Colours per object (an enemy's ink) cannot ride the mask; blocks take them through a variant entry of their own (styleRoles adds one per coloured variant), and toonBlocks' ink, which draws per object, takes the channel's `ink` directly.
- **Every pass is queued again every frame (#24548).** Each mask setting's selection list costs a little script time per selected object every frame; with 600 role holders that is most of the 0.2 to 0.3 ms the channels add.
- **A pass reads no depth unless it also writes the scene picture (#24550)**, so the mask parts test against the scene's depth in their own shader, and a line block finds the object a line belongs to by looking at the nearest surface around it (`sk_chan_line_near`) rather than at a depth the mask pass kept.
- **An unknown blend draws as replace (#24551)**: the mask parts use `opaque` (each part is an image of its own), and nothing in the kit relies on another blend name.
- **A running editor that had styleKit 1.4 open keeps the StyleStack's old fields until it restarts.** It cannot read or write the stack's new `roles` field, so the role set lives on a `StyleRoleSet` component beside the stack (new in 1.5.1), which every client has at once; objects' channels (a component new in 1.5.0) replicate at once too.
- **Edit mode does not share live changes between two editors.** Roles given in one editor reach another through the saved scene; in play every change reaches every player at once.
- **One stack per scene.** With two StyleStack entities in a scene the kit draws the last one it found; keep one, and change it rather than adding a second.
- **After a scene switch** the engine can free the stack's screen targets; the runtime notices within about two seconds and rebuilds them, so the look can be missing for that moment.
- **Switching looks can show picture memory a little above where it began.** Two seconds after the last live block goes, the kit frees every screen image it made (checked with 1.4.4: four looks applied and cleared, five rounds). The engine keeps freed render scratch for reuse until its next collection, so between collections the texture memory reads one or a few screen images above the start (112, 136, 160, then back to 88 MB in one session); `renderer.collect()` brings it back to the same figure every round (64 MB there). It does not grow without end.
- **The dim guard keeps a dim room's level, not every pixel's.** It matches brightness smoothed over about 36 pixels and holds each pixel to a fifth above the render around it, so one light mark can still sit a little lighter than the render right under it while the area around it stays as dark as rendered. In a lit picture (brightest parts at 0.7 or above and a mean of 0.4 or above) it does nothing, so how a block treats daylight is up to the block.
- Post-process shaders have no preview image, so the shader previews in this package are absent.
- **Other engine issues that apply here:** the camera gives no near and far planes (#24514); a two-client editor sometimes refuses to load two different scenes at once (#24666, #24667); a world boot can wait about 30 s on a network handshake before content starts (#24669); installs with several dependencies are slow (#21420); the ZeroMind description can lag one release (#19258); the web build was not checked from here (#20946); two engines on one account collide as one player, so a two-player check needs two accounts (#14448).
## Version history
**1.8.3 (2026-11-13)**: a block added with no `rank` lands before the first block of its slot ranked 100 or more, so a finishing block (a printed margin, a frame, weather laid over the picture) that states `rank: 100` and up with `stacking: chain` stays on top when grain or a vignette is added after it. Before, the later block was appended last and, as a plain layer reading the slot's input, painted the margin out. Blocks with a rank, and every stack already saved, are placed as before.
**1.8.2 (2026-11-13)**: the sky distance a depth mask uses costs the render path nothing. The active camera, its entity and its Camera component were read from inside the render feature's frame (about twice a second: forced on the replay check and again on the full path), where those engine calls can cost far more than from a script: a profile of a 2-3 block look in a large world (about 2,900 entities) put about 24 ms of every second there. The render path now reads only the cached far distance; the lookup runs in a deferred task off the frame, at most every 2 seconds, and a replayed frame takes the full path as soon as the cached value differs from the one it was built with. A camera far-plane change is picked up within about 2 seconds; the frame drawn is unchanged.
**1.8.1 (2026-11-13)**: a still frame costs less script time. (1) A frame in which nothing moved now replays every frame instead of taking the full path every 15th frame: the periodic checks run on cadences of their own, spread over the frames, and send a frame down the full path only when one finds something moved. The renewal backstop (one effect every 30 frames) and the dim guard's rewrite are a few property writes on a replayed frame; each effect's shader-reload count is read in turn (about every 30 frames each); the lighting watch every 15 frames (a change takes the full path and reads the sun again); the sky distance every 60 frames; the neutral fields' backstop write keeps its 240-frame cadence. Target residency, the quality tier and a rebuilt device are read before the replay check as before, and a new effect settling, a driven clock, objects still awaited, a tier change, lost targets and any stack, option, view or channel change still take the full path. (2) A replayed frame allocates nothing: the live-entry list is kept per stack (ordered list, revision and registry), and the anchor and clock are made only when used. (3) The stack's 60-frame backstop copy of an unchanged stack replays like the list it copies (compared by content) instead of forcing a full frame. Measured on the Cookbook's main scene (5 entries, 9 passes, static camera, 12 s): forced full frames went from 58 to 0, mean styleKit render time from 0.20 to 0.17 ms a frame in a headless client; what is left on a replayed frame is almost all the engine's own per-pass enqueue (about 4 µs warm per pass). The frame drawn is unchanged.
**1.8.0 (2026-11-13)**: published inputs. A block can now read a texture another package computes on each machine: the producer calls `StyleKit.publishInput(name, texture)` and every block that lists `input:<name>` under `reads` gets it bound to its `in_<name>` texture (black while nobody publishes it); `StyleKit.inputs()` lists what is published and `StyleKit.inputWanted(name)` says whether a live block (synced stack or local entry) reads it now, so the producer only works while one does. `checkBlock` pairs each `input:` read with its `in_` texture and does not ask for a description or default for `in_` textures. Inputs are never synced or saved. Asked for by sensor-look blocks (thermal, sonar, x-ray) that read a heat map, a sonar wave and a thickness map made by other packages; before this a block could only read styleKit's own fields. The test suite gains "published inputs reach the blocks that read them"; the writing-a-style-block guide and the styleBlock type README describe it. Nothing changes for existing blocks.
**1.7.9 (2026-11-12)**: a look costs the engine less per frame. Measured with the engine's own CPU and GPU time (look off against on, 1920 x 1080, 2,500 things) on animeBlocks' one-pass TV anime look, which went from 10 passes to 5 and from about 0.33 to 0.19 ms of styleKit script a frame. (1) A frame in which nothing the stack draws from has moved (the stack, its local entries and options, the tier, the images, the camera's anchor, the view, the channels) hands the engine the previous frame's passes again and skips the rest of its work; a held clock step writes only `sk_clock`; every 15th frame, a frame with a new effect still settling, a driven clock and objects still awaited take the full path, so every periodic check keeps running. (2) The ground and wobble a look reads when no block of it publishes them are tiny constant images written every few seconds instead of two full-screen passes every frame. (3) Excluded objects: the hand-off blends the styled result over the screen, which still holds the frame as rendered, transparent where an object is kept, so there is no copy of the original frame and no copy before the hand-off (three passes become one; kept objects stay full size and crisp on every tier). (4) When the object mask only keeps objects as rendered (no mask group, no channel), the restore reads the exclusion's own part and the merge pass is skipped; when the merge does run it reads only the parts in use. (5) The stack's own effects are registered the first time a look uses them (the engine surveys every registered effect each frame): the TV anime look holds 4 instead of 10. Checked: excluded objects stay exactly as rendered (a pedestal and a ball excluded on animeBlocks' plaza), and the TV anime look looks as before.
**1.7.8 (2026-11-12)**: quieter on a scene saved before styleKit 1.5. Its StyleStack has no `roles` field (the role set lives on the `StyleRoleSet` component beside it), and setting a role set tried to write the old field as well, logging a refusal each time; once a read has found the field missing, the write is skipped. Found following the Summit Sprint example guide on a fresh fork. Nothing else changed.
**1.7.7 (2026-11-12)**: a role set or look that another player changes (or a pull brings) now reaches this machine at once. The asset type's change hook runs only on the machine that made the change, so every other player kept the old roles and looks until they reloaded; each registered role set and look is now watched, and a change arriving from elsewhere is read again. Checked with two clients: a role set edited in one was read in the other within the same session, with no restart. Nothing else changed.
**1.7.6 (2026-11-12)**: a style channel reports `inkByHand` when its ink was set on the object by hand rather than by its role, so runtimes can draw it as set (toonBlocks 1.4.0 mixes none of the object's own colour into it). Role sets take `noLook:`, the set one written with `extends: look` sits over while no look is on: styleRoles' sets for kinds of game name the toon game set, so a game's hero, enemies and pickups carry their groups (player, enemy, pickup, and with them the variant lines and glazes) from the start rather than only once a look is picked; before, with no look on, a game set gave its hero the variant `hero`, which no line or glaze targets. Nothing else changed.
**1.7.5 (2026-11-12)**: styleKit's checks pass in a world that holds only styleKit (or only styleRoles, which brings it). "Clearing puts the frame back as rendered" loaded starterBlocks' `plainPaper`, so where starterBlocks is not installed the load was refused, nothing drew and the check failed (since 1.7.4 a plain styleKit install no longer brings starterBlocks along); it now stacks styleKit's own `posterize`, `duotone` and `depthLine`. "Block defaults stand over the shader's" skipped itself unless another package's block stated defaults (paperBlocks); it now writes a throwaway block of its own whose block.yaml states `amount: 0.37` over the template shader's 0.5, checks it, and removes it, then checks every other installed block that states defaults. In a fresh world with only styleRoles installed the suite passed 13 of 13 twice, with nothing skipped (it was 11 passed, 1 failed, 1 skipped). No block, shader or runtime changed.
**1.7.4 (2026-11-12)**: styleKit (and everything that brings it, styleRoles first) installs into an empty world again. The styleKit agent skill listed the Lookbook (`lookbookKit.Lookbook`, `lookbookKit.lookbook`) among its dependencies, so every install of styleKit brought lookbookKit along under deps, and lookbookKit's own pin on starterBlocks could not be met there: a fresh world that installed only styleRoles refused it ("is not installed, because it does not run"). The Lookbook stays optional, as the skill and the restyle workflow already said (they use it only where a world has it); it is no longer a dependency. Nothing else changed.
**1.7.3 (2026-11-12)**: fixes on top of 1.7.2, which came in as pull request #12 (another account's, merged). The stand-in search 1.7.2 added ran one name search over the whole scene per object with a channel on every sweep, and every second for 15 s after roles arrive: 0.023 ms each in a 158-thing scene, so 14 ms a sweep with 600 roles, growing with the scene. It now builds one index of stand-ins per prefix with a single glob search (`pk_vis_*`), kept until anything spawns or despawns: 0.0035 ms. And `look(id)` / `pigmentSet(id)` scan again on a miss at most once every 2 s: the role set picker and the roles test ask for looks that are not installed on purpose, and each miss read every look and pigment set the world holds. Checked here: 40 coin stand-ins and their child meshes all take the pickup role.
**1.7.2 (2026-11-12)**: a role reaches pickupsKit coins (from the first second of play), and a look installed after the first scan is found.
- A style channel now also reaches an object's **stand-ins**: root entities named `<prefix><owner id>` that a kit draws in the object's place. pickupsKit pools every pickup's model as its own root, `pk_vis_<pickup id>`, so `StyleRoles.give(coin, "pickup")` (the guide's own example) reached nothing the coin draws: on a pencil level the coins stayed grey, with no gold glaze and no ochre line, while the hero and enemies took theirs. `pk_vis_` is registered by default; `StyleChannels.addStandInPrefix(prefix)` registers another kit's. For 15 seconds after channel owners arrive (a scene load, the start of play), subtrees are swept every second instead of every 10, since pickupsKit builds its visuals a frame or more after the pickups; without that, coins stayed grey for the first 10 seconds of play. On a 16-coin, 2-gem level, 52 of 52 coin and gem models took their role (0 before), and ReadApart's least distance read 19.3 with roles on and 2.5 with roles off.
- `look(id)` and `pigmentSet(id)` scan again on a miss. Looks were scanned once a session and then kept up by per-file registration, so a block package installed into its own folder after another install had first placed it under `deps/` (inkBlocks, brought by pencilBlocks, then installed itself) lost its looks in the move: `applyLook("comicInk")` answered "no look called comicInk" and the RoleSetSwitcher's Ink comic button switched the roles alone, until the editor restarted.
**1.7.0 (2026-11-12)**: groups that share a material read apart under every look, untagged things keep the plain line, and a look switched on never flashes black.
- New block **Roles glaze** (`roleGlaze`, Colour): a glaze of one colour over one variant's objects, keeping each surface's own value (a white surface takes a light tint of it, never paper white). Role sets gain `glazes:` beside `lines:` (merged through `extends` the same way), and styleRoles 1.3.0 adds one glaze per group. On a plain stage where one player, five enemies and five pickups share one white material, the least distance between the groups with roles on went from 4.0 to 18.9 under Picture book, 4.2 to 22.6 under Watercolor, 10.7 to 26.5 under Pencil sketch, 10.1 to 17.4 under Ink drawing, 11.5 to 19.4 under Comic ink and 20.2 to 43.0 under Paper cutout game (styleRoles' README has the table).
- `describe()` reports each entry's `variant`. It did not, and toonBlocks' ink reads its entries from there, so under a toon look every variant line a role set adds was drawn on every object, things with no role included, and the last one won: lamp posts nobody tagged came out in the arena shooter's hazard orange, and in enemy red once the hazard line was removed. Untagged things now keep the look's own line.
- A look's passes run only once every shader they use has compiled; until then the frame is shown as rendered (at most 4 s per new effect). A pass whose shader has not compiled draws nothing, and the next pass then read an image that was still black, so in a fresh engine, where a look's first compile takes seconds, switching to a look could flash the screen black.
- The dim guard lets an object whose style channel asks for a lighter line weight (under 1) lighten in proportion, so a light pencil on one object reads lighter than the rendered frame even in a dim picture (pencilBlocks' per-object weight test: weight 0.3 read 245 against 204 with no channel, where before the guard held it at the rendered 90).
- `StyleKit.setLocalEntry(id, entry?)` and `localEntries()`: a whole entry on this machine only, from pull request #10 (another account's, made on 1.5.1 with seven conflicts; ported by hand, the rest of that pull request was older copies of files this world has since moved on).
**1.6.5 (2026-11-11)**: A new effect's settings, frame values and sun are written every frame for its first three seconds. A value written before an effect's shader had compiled read as the shader's default (#22741) and was written again only by the every-30-frames backstop, one effect at a time, so a look switched on from nothing (a stack with a paper most of all) drew a lighter, half-set picture for two to four seconds and then snapped to the real one. It now draws the settled picture from its first frames (measured: FLIP 0.049 from the settled frame for the first 2.5 to 3.5 s before, 0.000 from the first sample after). Found by running every suite twice in a freshly installed world: paperBlocks' unpaint test and pencilBlocks' shadow-band test read the picture inside that window.
**1.6.4 (2026-11-11)**: the role mask is rebuilt at most four times a second while channels keep changing (enemies spawned and killed every frame in a busy level), where it was rebuilt on every frame something changed; a read for one object (`channelOf`) always sees the latest. With toonBlocks 1.3.6 this takes the look with 600 role holders from 1.33 to 0.93 ms on the median frame (table under Style channels). Every README in the package (each block, look, shader and guide) now ends with a Known limits section naming the engine issues that apply there. It also carries what was prepared as 1.6.3: a role or channel given to a player template (an entity holding a `PlayerPrototype`, such as the `Player` of the engine's player scene) now goes on the template's body, which is what the engine copies into the world for each player who joins. Before, `StyleRoles.give(entity.find("Player"), "hero")` reported success and read back as hero in edit, but the template itself is never in the world, so no actual player, late joiners included, carried the role. `setChannel`, `give`, `clearChannel` and `channelOf` all follow the template to its body. Found by installing the look into a new world and building a small scene from the engine's player template.
**1.6.2 (2026-11-11)**: a look, a block or a role set change works after a play restart. The kit held a handle to the scene's StyleStack across the restart; the old component still answered reads, so the kit kept using it, and every write failed with "the component this proxy names was removed". A write that fails that way now drops every held handle, finds the scene's stack again and runs once more. Found while checking styleRoles 1.1.0 on a fork of Summit Sprint.
**1.6.1 (2026-11-11)**: (released as 1.6.1 because the number 1.6.0 was already taken on ZeroMind) role sets for a kind of game. A set may write `extends: look` to sit over whichever set the scene's look suits (its line weights and inks over that set's, which keeps deciding tone, fill, paper and value), so one set works under every look and follows a look change by itself; variant lines merge the same way, variant by variant. `StyleKit.roleSet(id)` lays such a set over the current look's set, `StyleKit.lookRoles()` names that set, `StyleKit.EXTENDS_LOOK` is the word. New `ChannelProbe` module, a test helper that measures what one object's channel does to the presented frame (used by every block package's tests). A scene's script cost is unchanged (see What it costs).
**1.5.1 (2026-11-11)**: the scene's role set is kept on a `StyleRoleSet` component beside the StyleStack (and in the stack's `roles` field where a client has it). An editor that had styleKit 1.4 open when the update arrived keeps the stack's old fields until it restarts; there `StyleKit.setRoles` used to report success while the write failed, and reading the set logged an error every frame. Both work now. Found by installing the release into a fork of Summit Sprint.
**1.5.0 (2026-11-11)**: one look, and players, enemies and pickups read apart under it. A `StyleChannel` on any object (synced, saved, reaching everything under it) says which variant of the look it gets or `asRendered`, how heavy its line is, how much of the look's line, tone, fill and paper reaches it, one free value and an ink colour, or just names a game role the scene's role set fills in. A new asset type, `styleRoleSet`, holds role sets (with `extends:` for an author's own); `StyleKit.give`, `setChannel`, `channelOf`, `clearChannel`, `channels`, `setRoles`, `roles`, `roleSets`, `roleSet` and `setVariant`, and `variant` on `add`. The object mask (`sk_obj`) now packs exclusion, mask groups and each object's channel; every block is weighed by its kind of mark and its entry's variant inside `sk_weight`, so every installed block honours channels with no change; `sk_chan_*` helpers let a block read line weight and value; `depthLine` and `sketchLine` take the line weight. A scene with no channel draws exactly as before and makes no mask. Writes to another player's object go to its owner. `StyleKit.VERSION` says 1.5.0.
**1.4.24 (2026-11-10)**: less work every frame. The stack's entries are copied and put in order once per change (any property change on any machine moves the stack's revision) instead of every frame, with a fresh copy every 60 frames as a backstop; each effect's shader-reload counter (a name lookup) is read every 30 frames instead of every frame; the quality tier and the render targets' residency are checked every 15 frames (a rebuilt render device is still caught the frame it happens). Measured under toonBlocks' bench with 2,500 things, the style stack takes about 0.23 ms on the median frame on one shared line (0.33 ms with eight per-object ink styles, which was 0.33 ms with more variance on 1.4.23).
**1.4.23 (2026-11-10)**: nothing on a timer looks over the scene. The sun and the light rows are read only when a light or the sky changed (a native watch over the engine's Light and Sky components; before, the "is anything lit" check read the light rows once a second); a scene stack and the objects named in its groups are looked for again only when the entity set changed (before, twice a second while one was missing). The cached writes to every effect are renewed when the render device is
# FrameTiming (module)
The runtime and API of frameTiming: animation held "on ones, twos, threes" per object while the game underneath keeps running at full rate. Games and other packages call it; the `HeldFrames` and `HeldFramesScene` components call `register` / `applyDefault` for you.
- `FrameTiming.set(entity, timing)` / `clear(entity)`: put an object on a timing (a number of frames, a preset name such as `"twos"`, `"threes"`, `"mixedAction"`, or `{ onFrames, baseRate, fastOnFrames, fastSpeed }`) by adding or updating its synced `HeldFrames` component.
- `FrameTiming.setDefault(timing, { allSkeletons })`: the scene-wide timing (a synced `HeldFramesScene` on an entity named `FrameTiming`).
- `FrameTiming.holdPose(entity, seconds)` / `isHolding(entity)`: a held hit pose, the character's drawing frozen on the frame of a hit while its clips, movement and physics run on (impactFrames' `holdPose` style uses it).
- `FrameTiming.now()`, `drawing(onFrames, baseRate)`: the shared animation clock every player steps from.
- `FrameTiming.stats()`, `timingOf(entity)`, `presets()`, `afterHold(fn)`, `setActiveInEdit(on)`: what is held, what it costs, and hooks for tests.
How it holds: a skinned skeleton's AnimGraph keeps ticking every frame but hands its pose to the armature only on a step; a drawn subtree (children with no collider, body, camera or listener) is kept in place in its parent's space by math on the parent's current pose; a mesh on the gameplay entity itself is drawn by a local proxy moved only on steps. Colliders, bodies, scripts and cameras are never touched.
# StyleKit (module)
The styleKit library: the block registry (`blocks`, `block`, `settingsOf`, `checkBlock`), the stack operations every player shares (`add`, `remove`, `swap`, `move`, `setStrength`, `setMask`, `set`, `setOn`, `clear`, `load`, `options`), `describe` for what is in the stack, and quality control (`quality`, `setQuality`). Reach it with `require("~styleKit.StyleKit")` from any script.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# StyleRuntime (module)
The per-machine half of styleKit, called by the styleStack render feature each frame: it keeps one post-process effect per stack entry, fills the shared inputs (clock, quality, surface data, ground, wobble, object mask) and enqueues the passes in slot order after antialiasing. Scripts use `StyleKit`, not this module.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# skCommon (shader module)
The prelude every styleKit block includes. It reads the shared inputs the stack fills each frame (the `sk_` properties of the styleKit shared header): one clock (`sk_time`, `sk_held`, `sk_step`), surface data copied once per frame (`sk_world`, `sk_dist`, `sk_normal`, `sk_albedo`), coordinates that stay on things (`sk_surface_coord`), the shared ground (`sk_ground_at`) and wobble (`sk_wobble_uv`), resolution-independent mark sizes (`sk_ref_uv`), the block's mask (`sk_weight`) and the one exit every block returns through (`sk_finish`: strength, mask, layer mode, and black stays black). Include it with `#include "~styleKit.shaders.skCommon"` after declaring the shared header.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# HeldFrames (component)
Draws the entity it is on (and the drawn meshes and skinned skeletons under it) on ones, twos, threes or any number of frames of a 24-a-second animation clock, while the entity's gameplay transform, colliders, physics body, scripts and camera keep running every frame. Put it on a character root, a player body, a prop or a projectile; it needs no sibling components. Its fields are synced, so every player sees the same drawings, and saved with the scene.
Fields: `onFrames` (frames per drawing, 0 = the scene default), `baseRate` (the animation clock, 24), `fastOnFrames` and `fastSpeed` (mixed timing: switch to another number of frames above a speed, e.g. ones for a dash), `holdTransform`, `holdSkeleton`, `children`. `FrameTiming.set(entity, "twos")` adds or updates it from code.
# HeldFramesScene (component)
The scene-wide default timing for frameTiming. Put one on any entity (`FrameTiming.setDefault("twos", { allSkeletons = true })` makes an entity named `FrameTiming` holding it). Every `HeldFrames` with `onFrames = 0` uses it, and with `allSkeletons` on every animated body in the scene that has no `HeldFrames` of its own is held on it too, so a whole cast goes on twos in one change. Synced and saved with the scene; needs no sibling components.
# frameTiming tests (testSuite)
Checks that a held object changes its drawn pose only on steps of the shared animation clock while the game underneath runs at full rate, measured frame by frame at the end of each frame (straight after the hold is written): a falling physics ball on twos (its body moves on at least 80 percent of frames, its drawn proxy only on steps and at most once per drawing), a child mesh of a root moved by a component on threes (held to under 1 cm between steps, back on the root within 1 mm on each step), the API (`set`, `clear`, presets) and a held hit pose (`holdPose` holds a skeleton for its time and lets go). It spawns temporary entities far from the scene's content and removes them; it leaves the scene's own HeldFrames and default timing alone.
# StyleKit (module)
The styleKit library: the block registry (`blocks`, `block`, `settingsOf`, `checkBlock`), the stack operations every player shares (`add`, `remove`, `swap`, `move`, `setStrength`, `setMask`, `set`, `setOn`, `clear`, `load`, `options`), `describe` for what is in the stack, and quality control (`quality`, `setQuality`). Reach it with `require("~styleKit.StyleKit")` from any script.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# StyleStack (component)
The scene's look: an ordered list of style blocks with each one's strength, mask and settings, plus the stack-wide held clock rate, mark scale, excluded objects and mask groups. It lives on a synced entity in the scene, so it is saved with the scene and every player draws the same stack. Change it with the `StyleKit` module (`add`, `remove`, `swap`, `move`, `setStrength`, `setMask`, `set`, `clear`, `load`, `options`); the runtime redraws on the next frame.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
The package README's Known limits lists the rest.
The full-frame pass of the Depth line style block: one-sided silhouettes from inverse distance and creases from normals.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# Depth line (styleBlock, Line)
Draws a clean ink outline where depth jumps and where surfaces fold, the same weight everywhere, for comic, cartoon and technical drawing looks.
Settings: `width` (1.6 reference px), `ink` (near black), `opacity` (0.9), `silhouette` (1), `crease` (0.6), `threshold` (0.02), `creaseAngle` (0.35), `fadeStart` (40 m), `fadeEnd` (120 m), `grainBreak` (0.2), `wobble` (1). Low quality samples two directions instead of four and draws no creases.
How it reads: silhouettes come from the inverse of the shared view distance, which is linear across any flat surface on screen, so a floor grazing to the horizon draws no false lines; the line lands on the near side of an edge only, so two touching objects never get a doubled outline. Creases come from the shared normals. The ink is broken by the shared ground's grain (`grainBreak`) and follows the shared wobble, so it boils with a wash on one clock and the paper shows through it.
## What it gives up in motion
Lines are found again every frame from the opaque depth, so they do not carry history: a part thinner than a line (wires, fence slats, far railings) can shimmer as it crosses pixels, and a crease drawn from normals pops in and out as a curved surface turns past `creaseAngle`. Line weight is constant on screen, so it does not shrink with distance until `fadeStart`.
## How it treats content
- Opaque things: outlined and creased.
- Transparent things (glass, water): not in the depth, so they get no outline; objects behind glass keep theirs, drawn over the glass colour.
- Particles and smoke: no outline; lines of objects behind smoke stay visible through it.
- Sky: never lined; objects get an outline against it.
- Fog: lines are drawn over fog at full ink until `fadeStart`; lower `fadeEnd` to sink far lines into fog.
- Skinned characters: outlined from their depth each frame, so a fast character keeps a clean line.
- Foliage: alpha-cut leaves are in the depth and get busy outlines; raise `threshold` or mask foliage out with a group mask.
- World text: text drawn as geometry gets outlined like any object, which can make small letters heavy; exclude labels.
- Black stays black: in a frame with no light the line is not drawn.
## Known limits
- It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
- Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
- Its passes are queued again every frame, even when nothing changed (#24548).
The package README's Known limits lists the rest.
The full-frame pass of the Duotone style block: maps brightness onto a shadow ink and a light ink.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# Duotone (styleBlock, Colour)
Maps the picture onto two inks, a shadow colour and a light colour, like a two colour print or a tinted photograph.
Settings: `shadowInk` (deep blue), `lightInk` (warm cream), `contrast` (1.1), `balance` (0), `keepColour` (0.1). Colours are display colours as picked, written as `"#1c2245"` or `{ r, g, b }`.
## What it gives up in motion
Nothing extra: it maps each pixel on its own, so it adds no marks that could slide or flicker. What it gives up is hue: colour-coded gameplay (a red enemy, a green pickup) reads only by brightness, so raise `keepColour` or exclude those objects.
## How it treats content
- Opaque things: mapped by brightness onto the two inks.
- Transparent things (glass, water): mapped as they appear, with what is behind them.
- Particles and smoke: mapped; bright additive sparks become the light ink.
- Sky: mapped; a blue sky turns to the middle of the two inks.
- Fog: mapped; fog pulls distant things toward one ink, which reads as depth.
- Skinned characters: mapped like any surface.
- Foliage: mapped; leaf colour is lost, leaf shape stays.
- World text: mapped; keep labels light on dark or dark on light so they keep their contrast, or exclude them.
- Black stays black: a pixel with no light stays black even though the shadow ink is not black.
## Known limits
- It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
- Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
- Its passes are queued again every frame, even when nothing changed (#24548).
The package README's Known limits lists the rest.
The full-frame pass of the Posterize style block: steps brightness (or each channel) into a few flat levels.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# Posterize (styleBlock, Colour)
Cuts the picture into a few flat tone steps, like a screen print or a poster printed with a small set of inks.
Settings: `levels` (5), `byBrightness` (1), `softness` (0.12), `saturation` (1.1). Low quality draws hard steps (softness 0).
## What it gives up in motion
Smooth gradients become hard steps. When a light changes slowly, a step edge sweeps across a surface instead of the surface fading, and noisy content (fine textures, film grain) flickers between two steps. Keep `softness` above 0.05 where light moves. It holds no marks of its own, so nothing slides or sticks to the screen.
## How it treats content
- Opaque things: stepped by brightness, hue kept.
- Transparent things (glass, water): stepped as they appear, with what is behind them.
- Particles and smoke: stepped like everything else; soft smoke turns into a few bands.
- Sky: stepped; a gradient sky becomes bands.
- Fog: stepped; distance fog becomes a few flat depth bands, which often reads well.
- Skinned characters: stepped like any surface, no extra cost.
- Foliage: stepped; moving leaves can flicker between steps.
- World text: stepped with the rest; light text on dark keeps its contrast. Exclude a label with `StyleKit.options({ exclude = { id } })` to leave it untouched.
- Black stays black: a pixel with no light stays black.
## Known limits
- It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
- Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
- Its passes are queued again every frame, even when nothing changed (#24548).
The package README's Known limits lists the rest.
# pigmentSet (asset type)
A pigment set is a palette of paints that every styleKit block reading `pigments` mixes from: up to eight pigments, each with how much it granulates, plus the pigment shadows pool in, the tint lit areas thin toward and the colour far things lift toward. One change (`StyleKit.setPigments(id)`) re-colours a whole painted look for every player, because the set is named on the scene's synced StyleStack.
## Folder shape
```
earthy.pigmentSet/
pigments.yaml the palette (required)
README.md what it is for and the mood it gives (required)
.metadata { "tags": ["pigment set", "watercolor", "earthy"] } (required)
```
## pigments.yaml
```yaml
name: "Earth pigments"
summary: "Ochres, siennas and umbers with a cool grey: a warm, granulating landscape palette."
tags: [earthy, warm, landscape]
pigments: # up to eight; colour is the masstone as picked (#rrggbb)
- { name: "yellow ochre", colour: "#d1a24a", granulation: 0.35 }
- { name: "burnt sienna", colour: "#a4512b", granulation: 0.5 }
- { name: "ultramarine", colour: "#3c4fa8", granulation: 0.9 }
shadow: { colour: "#4b4470", strength: 0.6 } # what shadows pool toward
light: { colour: "#ffe3b8", strength: 0.5 } # what lit areas thin toward
air: { colour: "#ece6d6", strength: 0.4 } # what distance and fog lift toward
pull: 0.75 # how hard colours are re-mixed from the pigments, 0..1
darkest: 0.05 # the darkest value the set reaches (display, 0..1)
saturation: 1.0 # 1 keeps the pigments' own chroma, lower greys them
```
A block reads the set through the `skPigmentSet` shader module (`skg_remix`, `skg_shadow`, `skg_light`, `skg_air`). With no set picked (`StyleKit.setPigments("")`) blocks keep the scene's own colours. The id is the folder name without `.pigmentSet`; list them with `StyleKit.pigmentSets()`.
## Known limits
- An asset of this type registers when the engine indexes its files, a moment after they are written.
- ZeroMind's description of this can lag one release behind what is installed (#19258).
The package README's Known limits lists the rest.
# skAnchored (shader module)
Stable noise that stays on things, for styleKit blocks. Include after `skCommon` and `skPatterns`.
- `sk_anchored_fbm(uv, perMetre, octaves)`: fractal noise laid on the world position of the surface under the pixel from three sides (no seam where a surface turns; the sky by view direction). Sized in metres: a wash's grading, wet patches.
- `sk_anchored_cells(uv, perMetre)`: one random value per patch (blooms, pools, dry patches).
- `sk_scaled_fbm(uv, refPx, octaves)`: noise that stays on the surface and keeps marks about `refPx` reference pixels across at any distance, by blending two octaves by distance (marks grow into the next octave rather than sliding). Paper tooth, grain, flecks and strokes that should keep their size in the picture.
- `sk_scaled_level(uv, refPx)`, `sk_surface_plane(uv)`, `sk_ref_metres(uv)`: the parts, for drawing your own pattern (cells, strokes) the same way.
For things that move, use `skp_triplanar_fbm` on the object's own position inside a material (`local_position`).
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
·computeshader · pulled in
❒asset styleKit internal: copies base colour and world normal from the deferred g-buffer at afterLighting into scene-space targets the style blocks read after antialiasing.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- The pass is queued again every frame (#24548).
The package README's Known limits lists the rest.
styleKit internal: the dim guard. In a dim or unlit picture it scales the stack's result down wherever it is brighter on average than the frame as rendered, so no look brightens a dim room; marks keep their shape. Off in daylight and lit rooms. Runs when a live block declares `keepDim` (every Tone block does unless it says `keepDim: false`).
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: the dim guard's meter. At an eighth of the chain's resolution it records the mean brightness of the stack's result and of the rendered frame under each texel, and how bright the rendered picture's brightest parts are. `skDimGuard` reads it.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: writes one constant value over a whole target, to reset a shared field that no block in the stack publishes.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: writes selected objects into one channel of the stack's object mask, depth-tested against the scene.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: merges the object mask parts (exclusion, mask groups and the style channels' settings) into the stack's one packed object mask.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skPaper (shader module)
The paper field, for blocks that list `paper` under reads and declare `sk_paper` (a texture, default black) after the shared header. It says how the sheet under each pixel takes paint and ink: `sk_thirst(uv)` (-1 hard-sized, 0 the standard sheet blocks are tuned on, +1 thirsty), `sk_sheen(uv)`, `sk_fibre(uv)` and `sk_dark_ground(uv)` (1 where the picture is made of light marks on a dark sheet). A Ground block publishes it with a `field.paper` shader in its block.yaml; where none does every value is 0, so a block reading it draws exactly as before. The field is only made when some live block reads it, so it costs nothing otherwise. paperBlocks' papers publish it; watercolorBlocks' bleed and edge darkening and every inkBlocks line and fill read it.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skPatterns (shader module)
The one pattern library every styleKit block draws from: hashes, value noise and fractal noise in 2D and 3D, cell (Worley) distance, a round dot screen sized by tone, parallel hatching and a 4x4 ordered threshold. Pure math with no bindings, so a full-frame block and a surface material that includes a block's piece share the same marks. Include it with `#include "~styleKit.shaders.skPatterns"` (the package name reaches it wherever styleKit was installed).
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skPigment (shader module)
Pigment mixing for styleKit blocks and materials: transmittance and optical density, the log-space mix of two pigments in one wash (`skg_mix`), transparent glazes that multiply (`skg_glaze`), diluting paint toward the paper (`skg_dilute`), the same hue at another value (`skg_with_value`), and paint on paper (`skg_on_paper`). Pure math with no bindings, so a full-frame block and a surface material mix paint the same way. It is a plain transmittance model written for styleKit.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skPigmentSet (shader module)
Reads the scene's pigment set (`sk_pigments`) in a styleKit block: the set's pigments with their granulation, its shadow pigment, light tint and air colour, and `skg_remix`, which re-mixes any colour from the set's pigments at the colour's own value. Include it after `skCommon` and `skPigment` in a block that lists `pigments` under `reads` and declares `sk_pigments` (a texture) after the shared header.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
·computeshader · pulled in
❒asset styleKit internal: reconstructs each pixel's world position (relative to a snapped anchor) and view distance from the scene depth after antialiasing, for every style block to share.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- The pass is queued again every frame (#24548).
The package README's Known limits lists the rest.
# skRendered (shader module)
The frame as it entered the style stack, for blocks that list `rendered` under reads and declare `sk_rendered` after the shared header. `sk_rendered_at(uv)` returns it in display code values. Use it for what the renderer said, not what earlier blocks made of it: a light estimate against `sk_albedo` (texture cancels out), or an original colour to restore. Costs one copy of the frame per frame, shared by every block that reads it (and by excluded objects).
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: restores the unstyled frame over objects excluded from the stack.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skSoft (shader module)
Reads the stack's soft field (`sk_soft`) in a styleKit block: a half-resolution, depth-aware blur of what the block reads, with `.a` telling how much of it came from the same surface. `sk_soft_at(uv)` samples it and `sk_soft_wide(uv, px, angle)` reaches further with a ring of taps. Include it after `skCommon` in a block that lists `soft` under `reads` and declares `sk_soft` (a texture) after the shared header. Washes, bleeds, edge darkening and blooms read it, and so can any later block.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
styleKit internal: one direction of the depth-aware soft field (half resolution blur) that blocks reading `soft` get as `sk_soft`.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# skStrokes (shader module)
Hand-laid strokes that build up by tone, shared by every block that shades with marks (pencil, charcoal, conte, ballpoint, hatching, scribbles) and by any material that wants the same marks on one object. Two shared ideas: which way strokes run (`sks_direction`: follow the form, one fixed angle, crossed, scribbled; from the surface normal and world axes only, so strokes never turn as the camera moves) and stacked strokes by tone (`sks_layer`, `sks_stack`: darker tones add strokes on top of the lighter tone's strokes, layer by layer, each stroke fading in at its own threshold). Strokes come in patches laid in 3D cells on the position you pass (world position for still things, the object's own position for a moving one) and keep their size on screen at any distance by blending two octaves. Pure math with no bindings: include it after `skPatterns` with `#include "~styleKit.shaders.skStrokes"`. Used by pencilBlocks' shade blocks and its hero material.
## Known limits
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# styleKit (agent skill)
Teaches an agent to give a world an art style made of stackable look blocks with styleKit: list the installed blocks, read the scene's style stack, add, swap, weight, mask and exclude, keep UI, labels, characters and gameplay colours readable, look at the result on the presented frame, write and check a new block, run the styleKit tests, and measure a look in motion with the Lookbook. Reach for it when someone asks for a look (watercolour, comic, sketch, chalk, retro pixels, paper, ink, grain) or wants to change, tune, remove or extend a world's style stack, and before writing a full-screen post-process effect by hand.
## Known limits
- Installing a package with several dependencies can take a while (#21420).
- ZeroMind's description of this can lag one release behind what is installed (#19258).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# styleBlock (asset type)
A styleBlock is one stackable piece of an art style. It sits in one of ten slots (Surface, Light, Fill, Tone, Line, Colour, Ground, Time, Raster, Medium), it states what it reads and what it writes, and the styleKit stack runs it over the whole frame after antialiasing. Any block swaps for any other block of its slot with no other change.
## Folder shape
A block is a plain folder holding the block asset and its shader side by side:
```
blocks/posterize/
posterize.styleBlock/ the block: block.yaml, README.md, .metadata (all required)
posterize.shader/ the post-process shader the stack runs
posterizeField.shader/ optional: the shader that writes a shared field (Ground or Time blocks)
posterize.shaderModule/ optional: the piece a material includes for a chosen set of objects
```
Paths in `block.yaml` are relative to the plain folder. The shader sits beside the `.styleBlock` rather than inside it, because a shader nested inside another asset folder is not listed by the engine and could not be found without a computed lookup that would block publishing.
The quickest way to start one is `StyleKit.newBlock("myTint", { slot = "colour" })` (written to `/zero/source/myBlocks/myTint`, or the `folder` you pass), which writes the whole folder, block and shader, and registers it at once. `asset.create("styleBlock", name, { slot = "line" })` writes only the `.styleBlock` files; write the `<name>.shader` beside it yourself.
## block.yaml
```yaml
name: "Posterize"
slot: colour # surface light fill tone line colour ground time raster medium
version: "1.0.0"
summary: "Cuts the picture into a few flat tone steps."
reads: [frame] # frame depth normal albedo motion ground wobble clock mask soft pigments rendered paper sun
writes: [frame] # frame, and field:ground, field:paper (Ground) or field:wobble (Time) when it has a field
stacking: layer # optional: layer (default) or chain
rank: 10 # optional: StyleKit.add places it before the first block of its slot with a higher rank
keepDim: false # optional: true keeps a dim room dim under this block (the dim guard); defaults to true in the Tone slot, false elsewhere
shader: posterize.shader # relative to the plain folder
field: { name: ground, shader: plainPaperField.shader } # optional, Ground and Time only
include: posterize.shaderModule # optional
settings: # every non-sk_ property of the shader, with what it means
levels: "How many steps each channel keeps."
defaults: # optional: this block's own defaults over the shader's (many blocks, one shader)
levels: 4
quality: # optional per-tier overrides of settings
low: { samples: 4 }
```
A Ground block's `field` may also name a paper-field shader and say that it layers (styleKit 1.2.0):
```yaml
field: { name: ground, shader: paperField.shader, paper: paperTakes.shader, layers: true }
writes: [frame, field:ground, field:paper]
```
- `paper`: a shader that publishes the paper field (`sk_paper`: r thirst -1 hard-sized to +1 thirsty, 0 the standard sheet; g sheen; b fibre; a dark ground 0 to 1) for blocks that read `paper`. It is run only when a live block reads it. A Ground block without one leaves the paper field neutral (every value 0). Add `field:paper` to `writes`.
- `layers: true`: when this block is not the first Ground block in the stack, it lays its ground (and its paper field) over the one before by its strength and mask, instead of being ignored as a later field. Its field shaders receive the field before as `sk_ground` / `sk_paper` and mix over it (`sk_view.y` is 1 when they are layered).
`defaults` lets several blocks share one shader (paperBlocks' seventeen papers run on one): each key must be a setting the shader declares, it overrides the shader's default for this block on every tier (`quality` overrides come after it, an entry's own settings last), and `StyleKit.settingsOf(id)` reports it as the block's default.
The shader's `properties.yaml` starts with the styleKit shared header (the `sk_` properties) and then declares the block's own settings with their defaults and ranges. `StyleKit.checkBlock(id)` reports anything missing.
## Stacking and rank
- `stacking: layer` (the default): every block in a slot reads the slot's input, and later ones are laid over the earlier ones by strength and mask.
- `stacking: chain`: the block reads what the blocks before it in its slot made, so modifier blocks build on each other (a wash, then its granulation, then its darkened edges).
- `rank: <number>`: `StyleKit.add` places the block before the first block of its slot with a higher rank, so a chain lands in its intended order whatever order its blocks are added in. A block with no rank lands before the first block of its slot ranked 100 or more: give finishing blocks that must stay on top (a printed margin, a frame, weather laid over the picture) `rank: 100` and up with `stacking: chain`, and grain or a vignette added later goes under them instead of painting them out.
## Keeping a dark scene dark (keepDim)
`keepDim` (styleKit 1.4.0) asks for the stack's dim guard. While any live block declares it, two small passes run after the chain: they measure the stack's result against the frame as rendered and scale the result down wherever it comes out brighter than a dim room was, so a shading block's sheet and the light between its marks never brighten a dim or unlit room. Every mark keeps its shape, and in daylight or a well lit room the guard hands the result on exactly unchanged.
- Leave it out on a Tone block: every Tone block keeps dim unless it says `keepDim: false`. A new hatching, stipple or dots block gets the guard for free.
- Set `keepDim: true` on a block in another slot that lays a light sheet or light marks over the picture.
- Set `keepDim: false` on a Tone block that is meant to light up the dark (a glow, chalk marks on a black board).
## Published inputs (styleKit 1.8.0)
Beyond the five extra inputs, a block can read a texture another package computes: list `input:<name>` under `reads` and declare an `in_<name>` texture after the shared header. The producer calls `StyleKit.publishInput(name, texture)` on each machine and draws it before the stack runs; with nothing published the block reads black. `StyleKit.checkBlock` refuses a read without its texture and a texture without its read. The guide "Writing your own style block" has the whole recipe.
## Extra inputs
Five inputs come after the shared header, each declared straight after it and bound by the stack only when `reads` lists the matching word:
- `sk_soft` (`reads: soft`): a half-resolution, depth-aware blur of what the block reads, never smearing a nearer thing over a farther one. Read it through the `skSoft` shader module (`sk_soft_at`, `sk_soft_wide`, `sk_soft_depth`, `sk_soft_in_front`). Its width is the stack option `softRadius`.
- `sk_pigments` (`reads: pigments`): the scene's pigment set as a 16 x 1 palette. Read it through the `skPigmentSet` shader module (`skg_has_set`, `skg_pigment`, `skg_shadow`, `skg_light`, `skg_air`, `skg_remix`).
- `sk_rendered` (`reads: rendered`): the frame as it entered the stack, before any block changed it. Read it through the `skRendered` shader module (`sk_rendered_at`). Its use is a light estimate against `sk_albedo` (texture cancels out) or an original colour to restore.
- `sk_paper` (`reads: paper`, a texture, default black): the paper field the Ground blocks publish. Read it through the `skPaper` shader module (`sk_thirst`, `sk_sheen`, `sk_fibre`, `sk_dark_ground`). Where no Ground block publishes it every value is 0, so the block draws as it did without it. A Ground block's own paper-field shader declares it to read the field laid before it, without listing `paper` under reads.
- `sk_sun` (`reads: sun`, a float4): the direction toward the scene's first directional light, `w` 1 when it gives light. Read about once a second. Raking light and sheen use it.
`StyleKit.checkBlock` refuses a block that declares one of them without the word under `reads`, or lists the word without declaring the texture.
When an asset of this type registers on any machine (world load, install, a collaborator's new block arriving), the type's `onRegister` hands it to the styleKit library, so `StyleKit.blocks()` lists it and a stack can use it at once.
## Known limits
- An asset of this type registers when the engine indexes its files, a moment after they are written.
- ZeroMind's description of this can lag one release behind what is installed (#19258).
The package README's Known limits lists the rest.
# styleKit (toolbox)
Shell and agent face of the styleKit style stack. Every tool acts on the scene's shared stack, so a change reaches every player.
| Tool | What it does |
|---|---|
| `styleKit.list` | Every style block installed, optionally in one slot |
| `styleKit.stack` | What is in the stack, in run order, and what drew last frame |
| `styleKit.add` | Add a block (with an optional strength) |
| `styleKit.remove` | Remove an entry |
| `styleKit.swap` | Swap an entry's block for another of its slot |
| `styleKit.set` | Change a setting, the strength or the on switch |
| `styleKit.clear` | Empty the stack: the frame is as rendered |
| `styleKit.check` | Check blocks against the block rules |
From the shell: `zero styleKit list line`, `zero styleKit add posterize`, `zero styleKit set posterize1 levels 3`.
## Known limits
- The web build was not checked from here (#20946).
- ZeroMind's description of this can lag one release behind what is installed (#19258).
The package README's Known limits lists the rest.
# styleLook (asset type)
A whole look in one change: the blocks of a styleKit stack with their strengths, masks and settings, and the stack options that go with them (pigment set, hold rate, mark scale, soft radius). `StyleKit.applyLook(id)` replaces the scene's stack with it for every player; `StyleKit.applyLook(id, { keep = { "line" } })` keeps the slots you name from the current stack, so a look can change the washes and leave your line alone.
## Folder shape
```
looseAndWet.styleLook/
look.yaml the look (required)
README.md what it is, what it suits, which blocks it uses (required)
.metadata { "tags": ["look", "watercolor"] } (required)
```
## look.yaml
```yaml
name: "Loose and wet"
summary: "Big soft washes that bleed into each other, blooms and pooled shadows; little detail."
tags: [watercolor, loose, wet]
pigments: earthy # a pigmentSet id, or leave it out for the scene's own colours
holdRate: 8
markScale: 1
softRadius: 14
entries: # the same shape StyleKit.load takes
- { id: wash, block: wcWash, settings: { flatten: 0.85 } }
- { id: bleed, block: wcBleed, strength: 0.9 }
- { id: paper, block: wcColdPress }
```
Every block a look names must be installed; `applyLook` refuses a look with a missing block and changes nothing. List looks with `StyleKit.looks()`.
## Known limits
- An asset of this type registers when the engine indexes its files, a moment after they are written.
- ZeroMind's description of this can lag one release behind what is installed (#19258).
The package README's Known limits lists the rest.
·renderfeature · pulled in
❒asset # styleStack (render feature)
Draws the scene's style stack on this machine. Every frame it hands the stack to `StyleKit`, which copies the frame after antialiasing and upscaling, fills the shared inputs (surface data, ground, wobble, object mask, clock), runs each block in slot order and hands the result back before the UI is drawn. With no live block it enqueues nothing, so the frame is exactly what the scene rendered. Started by styleKit itself on every machine; a world never creates it by hand.
## Known limits
- Its passes are queued again every frame, even when nothing changed (#24548).
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- The camera gives no near and far planes, so depth terms are read from the view-projection matrix (#24514).
The package README's Known limits lists the rest.
A plain matte surface lit only by the scene's lights (never the sky's captured light), for styleKit's dim-guard test room.
## Known limits
- A post-process shader has no surface preview image.
- A pass reads the scene's depth only when it also writes the scene picture (#24550), and an unknown blend name draws as replace (#24551).
- A per-object value cannot reach a geometry pass (#24549).
The package README's Known limits lists the rest.
# styleKit (test suite)
Checks the styleKit block registry and the rules every installed block follows, runs every stack operation twice in a row, refuses a swap across slots, checks that clearing the stack takes every pass off the frame and leaves the presented frame as rendered, and writes a new block with `newBlock`, registers it and stacks it. The suite saves the shared stack first and puts it back when it ends. Run: `asset.resolve("styleKit", "testSuite"):run()`.
## Known limits
- Frame tests read the presented frame, so a run needs a drawn view, and a busy machine moves the timing checks (#24548).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# restyleWorld
Give a world, a scene or an installed kit a new art style with styleKit, without breaking or losing anything.
## What it does
1. **Survey.** Reads what is there before changing anything: the scene's entities, the materials in use (toon, outlined, emissive, transparent, pixel-art), the lights and whether they change over time, the screen UI, particles, the player and other characters, world labels, colours that carry gameplay meaning, any stack already in place and the style blocks installed.
2. **Reference.** Saves the unstyled presented frame under `/zero/source/tmp/restyle/<subject>/` and turns the asked look (or a proposed one) into one block choice per slot.
3. **Build.** Builds the stack with one `StyleKit.load` call using readable entry ids, so running it again replaces rather than duplicates.
4. **Tune.** Up to three rounds of comparing presented frames against the look and adjusting settings, strengths, mark scale and hold rate.
5. **Content.** Handles what a full-frame block cannot: excluding world labels, a group mask so characters stay crisp, one owner for outlines on toon or outlined objects, material pieces such as `bandedToon` (only when allowed), transparent things and particles, gameplay colours.
6. **Check.** UI and labels readable, gameplay colours kept, black stays black, no flashing above 3 Hz, the Lookbook's numbers for the new stack against the old one, and the low quality tier.
7. **Report.** Answers with the look, the stack, every exclusion, group and mask, every material change with its old material and the call that restores it, the checks, the Lookbook numbers and how to remove it all.
It is non-destructive: styleKit edits no material, and the whole look comes off with `StyleKit.clear()` or by deleting the `StyleStack` entity. Material changes happen only when the run is started with `allowMaterialChanges = true`, and each is recorded with how to put the old material back.
## What it needs
styleKit installed, with blocks to choose from (starterBlocks gives one in every slot). The Lookbook check uses lookbookKit when the world has it and says so when it does not.
## Starting it
zero workflow start --name restyleWorld --args '{"subject":"main","look":"watercolour with crisp characters"}'
`subject` names the world, scene or kit (default: the loaded scene); `look` is the look in the asker's words (default: the run proposes one); `allowMaterialChanges` lets it change materials on chosen objects (default false).
## Known limits
- Installing a package with several dependencies can take a while (#21420).
- ZeroMind's description of this can lag one release behind what is installed (#19258).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.