# 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
# styleRoles: players, enemies and pickups that read apart under one look
One art style over a whole game, and the hero, the monsters and the coins still read as three different things. styleRoles gives you sixteen game roles to pick from, in sixteen sets: seven tuned for each kind of look in the Style Cookbook (a toon game, an ink comic, a watercolor storybook, a pencil sketch, pen and chalk, a paper cutout, and line and wash) and nine for a kind of game (a bright platformer, a tense arena shooter, an adventure or RPG with friends and foes, a racer, a horror game, a calm cozy one, a retro arcade one, a strategy or tower defence game and a stealth game) that sit over whichever look is on. Give a thing a role in one call; switch the whole game from one set of roles to another in one call; check on the frame the player sees how far apart the groups read; write your own set when none of them fits.
Version **1.4.2**. Depends on styleKit 1.7.8 (style channels, sets that extend the look, the Roles glaze block). Works with every styleKit block package: toonBlocks, inkBlocks, watercolorBlocks, pencilBlocks, paperBlocks and starterBlocks.
## Install and use
Install **styleRoles** from ZeroMind (search "players enemies pickups read apart" or "styleRoles"). It brings styleKit. The shortest way to see it work, in any scene with a styleKit look on:
```luau
local StyleRoles = require("~styleRoles.StyleRoles")
StyleRoles.give(entity.find("Goblin"), "enemy") -- a heavier line in red ink
StyleRoles.give(entity.find("Coin"), "pickup") -- bright, keeps its own colour
```
The scene picks the role set that suits its look by itself, so that is all it takes. A whole game, with the set picked by hand:
```luau
local StyleKit = require("~styleKit.StyleKit")
local StyleRoles = require("~styleRoles.StyleRoles")
StyleKit.applyLook("comicInkCel") -- any look (toonBlocks here)
StyleRoles.use("toonGame") -- the whole game's roles: one change
StyleRoles.give(entity.find("Player"), "hero") -- one thing, one change
StyleRoles.give(entity.find("Goblin"), "enemy")
StyleRoles.giveAll({ "Coin1", "Coin2", "Coin3" }, "pickup")
StyleRoles.give(entity.find("Dragon"), "boss")
StyleRoles.give(entity.find("ScoreSign"), "asRendered") -- a label left exactly as rendered
print(StyleRoles.of(entity.find("Goblin")).line) -- what it gets under the current set
StyleRoles.use("inkComic") -- same roles, now tuned for an ink comic
```
A role sits on the object as a synced `StyleChannel` component (part of styleKit), so you can also add it from the editor's inspector: add `styleKit.StyleChannel` to an entity and type its `role`. Everything under the object takes the role with it (a character's mesh, a sword in its hand); a child with a role of its own keeps its own.
Things with no role look exactly as they did before. A scene where nothing has a role makes no extra passes at all.
## The roles
| Role | For | What it does in most sets |
|---|---|---|
| `hero` | the player's own character | the clearest thing on screen: a bold clean line, little paper or grain |
| `partner` | a co-op partner or second player | like the hero, a little lighter, keeps a touch of its own colour |
| `enemy` | a common enemy | a heavier, darker line, often in its own ink colour |
| `elite` | a tougher enemy | heavier still |
| `boss` | a boss | the heaviest line in the scene |
| `pickup` | a coin, gem or health pickup | bright and clean: little shade, keeps its own colour |
| `rarePickup` | a rare pickup or power-up | the brightest thing on screen, no shading at all |
| `usable` | a lever, door, switch, chest | a clear line, lighter shading |
| `objective` | a goal, flag, exit | like usable, a little stronger |
| `hazard` | spikes, saws, lava | a strong line, keeps a warning colour |
| `projectile` | bullets, arrows, fireballs | thin line, no shading, full colour |
| `friendly` | a shopkeeper or villager | a softer, warmer line |
| `prop` | crates, barrels, walls | a thin quiet line so it stays behind the cast |
| `ghost` | faded, ghosted or inactive things | a faint line, little shading |
| `distant` | the far backdrop | the lightest line, sinks into the page |
| `asRendered` | labels, signs, in-world HUD | left exactly as rendered, no look at all |
Each role picks a **variant** of the look (player, enemy, pickup, interactive, hazard, friendly, background, or asRendered), a **line** weight (1 is the look as drawn), how much of each kind of **mark** reaches it (line, tone, fill, paper showing through, each 0 to 1), a **value** (every shipped block reads it as "how much of its own colour the thing keeps") and an **ink** colour for blocks that colour lines per object.
## The sixteen sets
### Sets for a kind of look
| Set | Use it with | What it does |
|---|---|---|
| `toonGame` | toonBlocks looks (Comic ink cel, Saturday morning, Clear line, ...) | hero in bold navy ink, enemies in heavy dark red, boss heaviest, coins outlined in their own colour without hard bands |
| `inkComic` | inkBlocks looks (Comic ink, Ink drawing, Noir, ...) | hero crisp, enemies in a heavy deep line and darker wash, coins keep their gold through the ink; adds an ink line per variant |
| `watercolorStorybook` | watercolorBlocks looks (Picture book, Watercolor, ...) | hero crisp with little wash and no paper showing, enemies in deep washes, coins bright and pure |
| `pencilSketch` | pencilBlocks' graphite, charcoal, coloured pencil, blueprint and storybook looks | hero clean, enemies shaded dark and close, props sparse, coins keep their colour among the graphite |
| `paperCutout` | paperBlocks grounds under any look | hero printed clean, enemies on the paper's grain, coins as bright clean card |
| `lineAndWash` | Urban sketch, Brush and wash | ink lines per variant over a wash; pickups bright, props pale |
| `penAndChalk` | Ballpoint notebook, Technical sketch, Margin doodles, Conte figure study | the pencil set retuned for one-colour media: players light with a green line, enemies packed dark in near-black, pickups hatched in their own colour with a heavy orange line |
### Sets for a kind of game
| Set | For | What it does |
|---|---|---|
| `brightPlatformer` | jump-and-run, kids' games | hero in a bold royal blue, enemies in tomato red, coins gold and power-ups magenta so they pop, hazards hot orange, scenery thin and soft |
| `arenaShooter` | tense arena and action shooters | enemies in a very heavy hot red line, bosses heaviest, your side thin cool cyan, ammo and health acid yellow, scenery pushed back with less tone |
| `rpgFriendsAndFoes` | adventures and RPGs | the hero and the party in blues and greens, townsfolk and quest givers in warm gold, foes in wine red deepening to purple for elites and bosses, loot gold, rare items violet |
| `racing` | racers and karts | your car electric blue, teammates sky blue, rivals orange-red with the leader heaviest, boosts nitro green, checkpoints green, the track side thin so it streams past |
| `spooky` | horror, Halloween, haunted | the hero in cold moonlight blue, monsters sickly green, elites bruise violet, the boss near-black and heavy, treasure candle gold, spirits pale and faint |
| `cozy` | farming, life sims, calm games | soft, near-even lines in warm faded colours: the player in denim blue, neighbours olive, pests only gently apart in muted plum, harvest honey, tools sage |
| `retro` | arcade, 8-bit and 16-bit style, pixel games | chunky, nearly even outlines in loud console colours: the hero lime green, allies sky blue, enemies hot magenta, the boss a deep violet slab, coins and power-ups orange and pink, scenery flat and dark |
| `strategy` | strategy, tower defence, tactics | your units royal blue, allies teal, enemy units crimson with elites and the commander heavier, resources gold, build spots cyan, the map thin and quiet |
| `stealth` | stealth, heists, infiltration | you in cool cyan, guards amber warming to red for the alert ones and the boss, cameras and lasers hot red, keys and loot pale gold, everything else low |
Each of these `extends: look`: its line weights and inks sit over the set the look suits (toon game under a toon look, pencil sketch under a pencil look), which keeps deciding how much shading, wash and paper reach each role and what the value does. So all seven work under every look, they fill the same roles, they follow a look change by themselves, and a game swaps from one to another with the same one call: `StyleRoles.use("racing")`. The role names fit any game: `partner` is a co-op player, an ally or a companion, `friendly` any NPC on your side, `enemy` / `elite` / `boss` small enemies, tough ones and bosses, `pickup` a coin, `rarePickup` a power-up, `usable` anything you can use.
Each set's own README holds its full table. With no set picked, the stack takes the set that suits its look by itself (each set names the looks and packages it is for), so giving roles is often all you do.
`StyleRoles.use(id)` does two things: picks the set (`StyleKit.setRoles(id)`) and, where the set colours a variant's line (enemies in red ink), adds a copy of the stack's first Line entry drawn only on that variant, in that ink, replacing the copies the last set added. `StyleRoles.use(id, { lines = false })` picks the roles alone. `StyleKit.setRoles("none")` turns every role off at once, to compare.
The Role Showcase scene in the Style Cookbook world shows all of this: a hero and partner, three grunts, an elite and a boss, coins, gems, a power-up, a lever, a goal flag, a saw blade, a shopkeeper, props, a ghost, a far backdrop and a sign kept as rendered, with a panel that switches between the seven look sets (each with its look), the seven game sets (keeping the look) and "Roles off". Put the same panel in your own scene with `entity.spawn("RoleSwitcher").component.add("styleRoles.RoleSetSwitcher", {})`.
## Write your own set
A role set is a `styleRoleSet` asset: a folder holding `roles.yaml`, a `README.md` and a `.metadata`. Start from a shipped one with `extends:` and write only what differs:
```yaml
name: My platformer
summary: Toon game roles, with enemies drawn twice as heavy and coins without paper.
extends: toonGame
forLooks: [comicInkCel]
lines:
enemy: { ink: "#4a0030" } # enemies' line in plum ink (StyleRoles.use adds the line)
roles:
enemy: { line: 2.4 }
pickup: { marks: { paper: 0 }, value: 1 }
checkpoint: # a role of your own
summary: A checkpoint flag.
variant: interactive
line: 1.8
marks: { line: 1, tone: 0.5, fill: 1, paper: 1 }
value: 0.7
```
Save it as `mySets/myPlatformer.styleRoleSet/roles.yaml` anywhere in your world; it registers on every machine at once. `StyleRoles.use("myPlatformer")`. Every field a role leaves out comes from the set it extends; a role name the set does not know is read as a variant name.
## API
| Call | What it does |
|---|---|
| `StyleRoles.use(setId, opts?)` | Switch the whole game to a role set in one change, with its variant lines and its glazes (a Roles glaze per group: blue for the players, red for the enemies, gold for the pickups, in each medium's own colours). `""` follows the look. `{ lines = false }` switches the roles alone. |
| `StyleRoles.give(entity, role?)` | Give one object (and everything under it) a role; `nil` takes it away. |
| `StyleRoles.giveAll(list, role?)` | The same for a list of entities, ids or names; returns how many. |
| `StyleRoles.of(entity)` | The role it carries and what it gets now: `{ role, variant, asRendered, line, marks, value, ink, owner }`. |
| `StyleRoles.sets()` / `roles(setId?)` | Every installed set / one set's roles in picker order. |
| `StyleRoles.clear()` | Put the scene back as it was before roles: every StyleChannel removed, the variant lines taken off, the set cleared. |
| `StyleRoles.ROLES` | The sixteen role names. |
| `StyleRoles.GENRES` | The nine sets for a kind of game. `StyleRoles.sets()` marks each set `kind = "look"` or `"game"`. |
| `ReadApart.measure(groups?)` | The squint test, measured: how far apart players, enemies and pickups read on the presented frame (CIE Lab distance of each group's averaged part of the frame; 1 to 3 with roles off, about 8 and more reads at a glance). `require("~styleRoles.ReadApart")`. |
Lower-level: styleKit's `StyleKit.setChannel(entity, { line, marks, value, ink, variant })` sets any field by hand over the role, and `StyleKit.add(block, { variant = "enemy" })` adds a block drawn only on one variant (two inks in one slot).
The `RoleSetSwitcher` component puts up the on-screen set picker; its `looks` field maps each set to the look its button also applies.
## Multiplayer
Roles live on each object as a synced component, and the role set on the scene's synced StyleStack, so every player sees the same roles on the same things, roles are saved with the scene and come back on reload, and a role changed in play reaches every player at once (a change made by a player who does not own the object is sent to its owner). Verified with two clients in play: a role given in one reached the other within 1.5 seconds.
## How far apart the groups read, look by look
The Role Showcase scene under each look, with the role set the look picks, measured with ReadApart on the presented frame (the least CIE Lab distance between the players, the enemies and the pickups; with no roles the groups sit 1 to 3 apart, told apart at a glance is about 8 and more):
| Look | Set | Roles on | Roles off |
|---|---|---|---|
| Comic ink cel (toon) | toonGame | 59.3 | 48.3 |
| Comic ink | inkComic | 14.3 | 2.5 |
| Picture book (watercolor) | watercolorStorybook | 19.4 | 16.3 |
| Paper cutout game | paperCutout | 19.6 | 14.4 |
| Urban sketch (line and wash) | lineAndWash | 13.2 | 14.2 |
| Pencil sketch | pencilSketch | 9.3 | 1.2 |
| Charcoal study | pencilSketch | 21.4 | 2.0 |
| Coloured pencil wash | pencilSketch | 19.8 | 18.6 |
| Storybook pencil | pencilSketch | 27.7 | 22.1 |
| Blueprint | pencilSketch | 14.2 | 0.4 |
| White charcoal night | pencilSketch | 17.2 | 8.0 |
| Field notes on kraft | pencilSketch | 26.5 | 24.3 |
| Bold ink sketch | pencilSketch | 19.7 | 3.0 |
| Conte figure study | penAndChalk | 10.1 | 1.0 |
| Margin doodles | penAndChalk | 8.6 | 2.5 |
| Technical sketch | penAndChalk | 6.9 | 1.0 |
| Ballpoint notebook | penAndChalk | 6.0 | 1.6 |
Two blocks in one slot, one for the player and one for the enemies: `docs/shared_slot_player_enemy.jpg` (how-to guide, step 6). Pictures of the same square: `docs/showcase_toon.jpg` (toon), `docs/showcase_ink.jpg` (ink comic), `docs/showcase_pencil.jpg` (pencil sketch with roles) beside `docs/showcase_pencil_off.jpg` (the same look with roles off, where everything is one grey), and `docs/showcase_ballpoint.jpg` (ballpoint with the pen and chalk set). Under pencil the players stay light with a blue outline, the enemies are packed dark with a heavy red one, and the coins keep their colour; with roles off all three are the same grey. The measure script is `design/roles/read_apart_showcase.luau` in the Style Cookbook world. Ballpoint and technical sketch are the closest pairs left (players and pickups both stay light in a one-colour pen).
## What it costs
| | 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.
## Known limits
- **At most eight distinct settings per scene (#22178, #24549).** A full-screen pass cannot tell which object a pixel belongs to, and a geometry pass carries no per-object value, so objects are grouped by what they ask for and each group is one extra drawing pass. Sixteen roles fit easily because roles sharing a setting share a pass; a ninth distinct setting draws as if it had no role (`StyleKit._status().parts` says how many were drawn).
- **Passes are queued again every frame (#24548)**, which is most of the cost above.
- **A pass reads no depth unless it also writes the scene picture (#24550)**, so a line drawn just outside a silhouette is matched to the nearest surface around it; at the very edge of two overlapping role holders a line can take the one in front.
- **An unknown blend draws as replace (#24551)**: the mask passes use `opaque` on purpose.
- **Post effects share no per-camera inputs (#17427)**: a second camera (a minimap, a split screen) reads the roles of the main view's mask.
- **Ink colours per object reach only toonBlocks' ink directly.** Other line blocks take a per-variant colour through the extra line `StyleRoles.use` adds.
- **Two engines on one account collide as one player (#14448)**, so the multiplayer check used two clients of different players; the web check in a browser engine is yours to run (#20946).
- **An editor that had styleKit 1.4 open when the update arrived** keeps the old StyleStack fields until it restarts; styleKit 1.5.1 keeps the role set on a `StyleRoleSet` component beside the stack, so switching sets works there too.
- **Installs with several dependencies are slow (#21420)**, and the ZeroMind description can lag a release (#19258).
- Other engine issues noted while building this: #22478, #24593.
- **Other engine issues that apply here:** 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); the web build was not checked from here (#20946).
## How far apart they read
**On a plain stage (1.3.0).** One player, five enemies and five pickups, all eleven in the same plain white material, under a sun: what a person sees the first time they try it in a fresh world, and the hardest case, because only the look and the roles tell the groups apart. Measured with `ReadApart` on the presented frame (least CIE Lab distance between the three groups; about 8 and more reads at a glance) by `design/roles/read_apart_fresh.luau` in the Style Cookbook world on 12 November 2026. "Before" is styleRoles 1.2.3 on styleKit 1.6.5, the release a person tried and found the ink, pencil and watercolor groups hard to tell apart.
| Look | Set | Roles off | Roles on, before | Roles on, now |
|---|---|---|---|---|
| Comic ink | inkComic | 0.6 | 11.5 | 19.4 |
| Ink drawing | inkComic | 0.2 | 10.1 | 17.4 |
| Pencil sketch | pencilSketch | 1.8 | 10.7 | 26.5 |
| Watercolor | watercolorStorybook | 0.6 | 4.2 | 22.6 |
| Picture book | watercolorStorybook | 0.5 | 4.0 | 18.9 |
| Paper cutout game | paperCutout | 7.8 | 20.2 | 43.0 |
What changed: every set for a kind of look but the toon one now carries `glazes`, which `StyleRoles.use` lays as a Roles glaze over each group (styleKit 1.7.0): the players in blue, the enemies in red and a little deeper, the pickups in gold and a little lighter, in each medium's own colours (ultramarine, alizarin and gamboge for watercolor; the animator's blue, red and ochre pencils; the comic's spot colours; coloured card). The weights, marks and line inks the sets already gave are kept, so a squint now sees three colours as well as three weights. With every group in one grey, a heavier line and a darker shade alone left the hero and the enemies 4 apart under watercolor. The toon set needs no glaze (59 apart on the Role Showcase). The styleRoles suite checks this table's looks every run ("tells the three groups apart under every family of look, better than with roles off": 12 or more with roles on, and 8 or more above roles off).
**On the Role Showcase (1.2.x, before glazes).**
Measured with `ReadApart` on the Role Showcase (two players, five enemies, eight pickups, all plain white or metal materials, which is the hard case: only the look tells them apart), least distance between the three groups:
| Look | Roles off | Its own set | Notes |
|---|---|---|---|
| Pencil sketch | 1.2 | 6.4 | players-enemies 12.8, enemies-pickups 8.9 (was 1.1 to 2 before 1.1.0) |
| Ink comic | 1.4 | 2.3 | enemies now drawn in a heavy crimson line (the ink set used to turn it black); pickups 7 to 9 from both |
| Pencil sketch + a game set | 1.2 | 4.3 (cozy) to 8.7 (platformer) | racing 8.2, arena 5.7, rpg 5.8 |
| Ink comic + a game set | 1.4 | 1.7 (cozy) to 8.2 (platformer) | racing 6.7, spooky 5.8, arena 5.4 |
Toon, watercolor, paper and line-and-wash looks keep the scene's own colours, so their groups already sit 12 to 40 apart with roles off and the roles widen that. Cozy is soft on purpose. A game whose cast has its own colours reads further apart than this all-white cast.
## Guides and workflow
- **Make players, enemies and pickups read apart with one look** (`guides/make-players-enemies-and-pickups-read-apart`): the how-to.
- **Example: styling a piece of Summit Sprint with game roles** (`guides/example-summit-sprint-roles`): a small platformer styled step by step.
- **restyleWithRoles** (`workflows/restyleWithRoles.workflow`): give an existing game roles in stages, every stage undoable.
- **styleRoles** agent skill (`skills/styleRoles.agentSkill`): what an agent in a world with this installed can do.
## Version history
**1.4.2 (2026-11-12)**: the Summit Sprint example guide followed step by step on a fresh fork with this release, and corrected where it differed: inkBlocks 1.2.8 and earlier were refused there (1.2.9 installs), the game's styleKit reads the new version straight after the update, the `roles` line the log can still show once after reopening is harmless, a role given to each pickup reaches its coin model (checked: 41 of 41, with the tip that a role on the model itself wins, so clear its channel to move it), and there are eight other sets for a kind of game, not six. Pins styleKit 1.7.8. Nothing else changed.
**1.4.1 (2026-11-12)**: a roles-on look-over of every family. Toon game set: pickups and rare pickups mixed most of the object's own colour into their line (value 0.8 and 1), so on a light object the gold ink came out a pale grey; now 0.3 and 0.4 with slightly heavier lines (1.5 and 1.8), and the gold and violet read. Watercolor storybook set: the hero, meant to be the clearest thing on screen, was the faintest figure (value 0.35 kept a light body near white); now 0.15 with a fuller player glaze (amount 0.85, lightness 0.85), and the plain-stage squint test went from 20.8 to 22.1. Paper cutout set: the player glaze (amount 0.6, lightness 1.05) left the hero nearly invisible on cream card, and the pickup glaze (lightness 1.12) turned the coins cream; both deepened, and Parchment map went from 28.4 to 34.4. The read-apart guide's expected numbers were measured again on the current release, the three paper looks and the two new game sets included. Pins styleKit 1.7.7.
**1.4.0 (2026-11-12)**: more choice and clearer defaults and guides. Two new sets for kinds of game, **Strategy** (tower defence, real-time strategy, tactics: your units royal blue, allies teal, enemy units crimson, resources gold, build spots cyan) and **Stealth** (you in cool cyan, guards in amber warming to red for the alert ones, cameras and lasers hot red, loot pale gold), so nine sets for kinds of game and sixteen in all, every one swapped in with `StyleRoles.use`. Every set for a kind of game names `noLook: toonGame` (styleKit 1.7.6), so its roles carry their groups before a look is on. The paper cutout set follows paperBlocks' three looks (Paper cutout game, Chalkboard lesson, Parchment map). The how-to guide gains a table of which role to give what in a game, a squint test section with the numbers to expect for each family of look, and a checklist for something that does not pick up its role (stand-ins such as pickupsKit's coins, a look missing after a second family, the switcher's corner, no look on). The read-apart test measures the paper look from paperBlocks, which now ships it. Pins styleKit 1.7.6.
**1.3.7 (2026-11-12)**: pins styleKit 1.7.5, whose checks pass in a world that holds only styleRoles and styleKit (1.7.4's "clearing puts the frame back as rendered" used a starterBlocks paper such a world does not have). Nothing else changed.
**1.3.6 (2026-11-12)**: pins styleKit 1.7.4, so styleRoles installs on its own into an empty world (1.3.5 was refused there: styleKit's agent skill brought lookbookKit, whose starterBlocks pin an empty world could not meet). Nothing else changed.
**1.3.5 (2026-11-12)**: pins styleKit 1.7.3 (the faster stand-in index and the throttled look rescan on top of #12's fixes). The switcher's corner fix and the pencil sketch set's README from 1.3.4 were checked here: the panel lays out at the top right (x 1014 to 1264 of 1280, 16 from the top), the full-screen box around it takes no pointer (a click in the middle of the screen reaches the game), and the README table matches roles.yaml row for row.
**1.3.4 (2026-11-12)**: the RoleSetSwitcher panel sits in the corner it names. Its default, `topRight`, drew at top left over the game's own HUD: a screen's root node is laid out from the top left whatever its `right` or `bottom` say, so the panel is now pinned inside a full-screen root. The pencil sketch set's README table now matches its `roles.yaml` (it still listed the weights and marks from before 1.3.0: pickups with no shading and value 0, where the set draws them in coloured pencil with value 1 and line 2). Pins styleKit 1.7.2, which makes a role given to a pickupsKit coin reach the coin's model and finds a look that a later install moved.
**1.3.2 (2026-11-12)**: the read-apart test now runs on what the packages ship. Its paper look, Paper cutout game, lived only in the Style Cookbook world's own folders, so in a world that installed the packages alone `applyLook` found nothing and that step measured the look before it; the look now ships in toonBlocks 1.3.10 (which brings paperBlocks), and the paper cutout set names it in `forLooks`, so it follows that look by itself. The test checks that each look applied and that the stack reports it before measuring, names in its log any look whose package is not installed and leaves it out (skipped only when none is). No other change.
**1.3.1 (2026-11-12)**: the Summit Sprint example guide run again step by step on a fresh fork with 1.3.0: step 4 now names the four glazes `use` adds, step 5 what the roles reach (917 things in 7 distinct settings) and what you see (the player in a blue glaze and line, the only coloured figure on the ink page), and step 2 says to open the world again after updating the game's styleKit even when `VERSION` already reads right (on the run it read 1.7.0 at once, yet `use` added no lines until the world was opened again). No code changed.
**1.3.0 (2026-11-12)**: groups that share a material read apart under every look. The ink comic, pencil sketch, pen and chalk, watercolor storybook, line and wash and paper cutout sets carry `glazes` (a colour per group), which `use` adds as Roles glaze entries beside the variant lines and `clear` takes off; the sets for kinds of game inherit them through `extends: look`. On a plain stage of one player, five enemies and five pickups in one white material, the least distance between the groups with roles on rose from 4.2 to 22.6 under Watercolor, 10.7 to 26.5 under Pencil sketch, 10.1 to 17.4 under Ink drawing and 20.2 to 43.0 under Paper cutout game (table above). Two tests: the plain stage under six looks, roles off and on; and things with no role keeping the plain line under Comic ink cel with the arena shooter set (they were drawn in the hazard line's orange; the cause was in styleKit and is fixed in 1.7.0). Pins styleKit 1.7.0.
**1.2.3 (2026-11-11)**: pins styleKit 1.6.5 (styleKit 1.6.5 draws a newly switched-on look's settled picture from its first frames instead of a lighter, half-set one for two to four seconds; lookbookKit 1.0.44 finds its Lookbook scene where it is installed). Nothing else changed.
**1.2.2 (2026-11-11)**: a frame test for two blocks sharing one slot (a blue depthLine drawn only on the player and a red sketchLine only on the enemies, under a black line for everything else; with their variants swapped the colours swap), and a picture of it on the Role Showcase (`docs/shared_slot_player_enemy.jpg`: an ink brush line for the player, an ink pen line for the enemies). The how-to guide's example of it now passes `setInk = 0`, without which a look that picks an ink set (Comic ink) overrode the colours. No code changed.
**1.2.1 (2026-11-11)**: the Summit Sprint example run again on a fresh fork with styleRoles 1.2.0, styleKit 1.6.4 and toonBlocks 1.3.6 (the player, hazards, platforms, checkpoints, coins and scenery all took their roles under the toon look), and its text brought up to date: the versions to check, what to do when an older styleKit is already in the game, and the seven sets for a kind of game. The how-to guide names the horror and retro sets in its opening. No code changed.
**1.2.0 (2026-11-11)**: a retro arcade set for a kind of game (`retro`), and a pen and chalk set for a kind of look (`penAndChalk`, picked by the ballpoint, technical sketch, margin doodle and conte looks, where the pencil set's blue and red leads sank into the medium: players and pickups now read 6 to 10 apart there, from 3 to 6). `ReadApart.byRole` found no groups (it read an `owner` field `StyleKit.channels()` does not give); fixed. A table of how far apart the groups read under every look and pictures of the Role Showcase (`docs/`). The cost measured again with toonBlocks 1.3.6 and styleKit 1.6.4. Pins styleKit 1.6.4 (a role given to a player template reaches every player; the role mask rebuilt at most four times a second). 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.
**1.1.3 (2026-11-11)**: the cost measured again with 2,500 things, with and without roles, and written into the how-to guide's "Cost and limits" with a table (roles off 0.41 ms, 600 roles 1.27 to 1.39 ms median, after toonBlocks 1.3.4 halved the passes the toon ink draws for role lines). No code changed.
**1.1.2 (2026-11-11)**: the test suite passes in a world where styleRoles is the only package installed. The "follows the look" test now runs on two role sets and look names of its own instead of pencilBlocks' and inkBlocks' looks, and the pencil squint test stands down with its reason where pencilBlocks is not installed. Run twice in a fresh world: 6 of 7 pass, 1 skipped (the pencil test), none failed. No code outside the tests changed.
**1.1.1 (2026-11-11)**: `ReadApart.measure` keeps the part of a thing inside the frame when it stands at the edge of the screen (a player close to the camera made the whole measure fail), and the Summit Sprint example guide gains the bright platformer step and the note that a game which already ships an older styleKit must update it. Pins styleKit 1.6.2.
**1.1.0 (2026-11-11)**: six role sets for kinds of game (bright platformer, harsh arena shooter, RPG friends and foes, racing, spooky, calm cozy), each laid over the set the look suits (styleKit 1.6.1's `extends: look`), so every one works under every look and a game swaps between them with one call; `StyleRoles.GENRES`, and `sets()` marks each set's kind. The pencil sketch set retuned to read at a squint (players light with a blue lead, enemies packed dark with a heavy red lead, pickups in their own colour in coloured pencil with an ochre lead) with pencilBlocks 1.3.0; the ink comic set given spot colour (blue hero, crimson enemies) with inkBlocks 1.2.0. `use` hands a variant's ink to pencil lines (`lead`) and keeps an ink line's own ink when an ink pigment set is picked (`setInk = 0`), which made the ink comic set's enemy line black before. New `ReadApart` module, the squint test measured on the presented frame. The switcher panel lists the game sets under "Kind of game". Tests: 7 of 7 (new: game sets over a look's set, a game set follows a look change, the squint test under pencil).
**1.0.1 (2026-11-11)**: the example guide (styling the Stump Run of Summit Sprint, run on a fork) and a pin on styleKit 1.5.1, which keeps the role set working in an editor that had an older styleKit open.
**1.0.0 (2026-11-11)**: first release. Sixteen roles in six sets (toon game, ink comic, watercolor storybook, pencil sketch, paper cutout, line and wash), `StyleRoles.use`, `give`, `giveAll`, `of`, `clear`, the RoleSetSwitcher panel, the how-to and example guides, the restyle workflow and the agent skill. Tests: 4 of 4 pass.