# ShowcaseEmitter
Replays a juiceKit effect preset at the entity it sits on, every `interval` seconds, in edit and in play, so a one-shot burst (sparks, smoke, fire, magic) reads as a running emitter. Needs juiceKit installed and nothing else on the entity; its position is where the effect plays.
Fields: `preset` (a juiceKit vfx preset such as `vfxSparks` or `vfxSmoke`), `interval` (seconds), `look` (`cartoon`, `realistic`, `pixel`, `scifi`) and `scale`. Each machine plays its own copy (`scope = "local"`), so nothing crosses the network.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
The package README's Known limits lists the rest.
# ShowcasePreview
Draws barsKit's bars while authoring. barsKit's `Bar` steps and draws from `update` on the game clock, which edit mode holds still, so in edit mode this component steps every registered bar on the real clock (the kit's `_step` hook, the one its tests use), builds the kit's HUD tree (`build`) and draws it into a screen of its own (`lookbookShowcase_bars`). In play it removes that screen and the `Bar` draws itself.
Put it on any entity in a scene that has `barsKit.Bar` components. It has no fields. World bars are placed with the engine's `worldToScreen`, so in edit they sit over their target as seen from the camera the engine projects with, not from an offscreen capture's own camera.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
The package README's Known limits lists the rest.
# LookbookPath
The Lookbook's one repeatable camera path, as pure functions of lookbook time T. The same T gives the same pose on every machine.
- `LookbookPath.LENGTH`: the core path, 26 seconds. `LookbookPath.TOTAL()`: core plus every extension stop.
- `LookbookPath.STOPS`: ordered `{ id, title, tests, t0, t1, center = {x,y,z}, extension }`. Twelve core stops stand along +X, 30 m apart. The camera cuts at each stop's `t0` and moves smoothly inside the stop.
- `LookbookPath.pose(T)`: `{ position, lookAt, fov, stop, segment }`, T clamped to 0..TOTAL().
- `LookbookPath.segments()`: the special stretches a measurer reads, each `{ t0, t1, stop, note }`: `pan`, `dolly`, `orbit`, `zoom` (fov 60 to 6), `slowLight`, `sunRotate`, `zeroLights` (every light off, black frame), `excluded`, plus each extension stop under its id.
- `LookbookPath.extend({ id, title, tests, center, seconds, keys = { { t, position, lookAt, fov } } })`: add a stop after the core path, keys relative to the stop and eased smoothly. The same id again replaces it. `LookbookPath.unextend(id)` removes it.
- `LookbookPath.lookRotation(position, lookAt)`: the quaternion `{x, y, z, w}` that aims a camera (looking down -Z) at a point.
- `LookbookPath.WALL`, `ROOM`, `DEPTH_EYE`, `DEPTH_DISTANCES`: the geometry the path aims at, which the Lookbook scene's build reads.
Pan, dolly and orbit move at constant speed; zoom is even in image scale (interpolated on log tan(fov/2)); the other moves ease in and out.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.
# ShowcaseMenu
Shows one menusKit screen (title by default) in a chosen look and layout. Put it on any entity; it needs menusKit installed.
In play it opens the screen through the kit (`Menus.setup` and `Menus.show`), and the kit's own host draws it and reads input as in any game: Play closes it. In edit the kit draws nothing by design, so this component draws the kit's screen tree (`Menus.build`) into a screen of its own (`lookbookShowcase_menu`) at the kit's layer, which is what offscreen captures and the Lookbook see while authoring. With `backdrop = "none"` (the default) it leaves out the screen's full-screen backdrop in that edit drawing, so the scene stays visible around the menu panel.
Fields: `screen`, `theme`, `layout`, `title`, `backdrop`.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
The package README's Known limits lists the rest.
# ShowcaseIdle
Loops one animation clip on the skinned body under the entity it sits on (an engine humanoid avatar spawned with an `Asset` component, for example), in edit and in play, so a standing character idles instead of holding its bind pose. It uses the engine's AnimGraph with a one-clip graph and needs no character controller.
Fields: `clip` (default the character controller's standing idle) and `speed`.
## Known limits
- Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
- A world boot can wait about 30 s on a network handshake before any content starts (#24669).
- A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).
The package README's Known limits lists the rest.
# lookbookShowcaseKit
Adds a showcase stop to the Lookbook: a small set built from published kits (masonry, toon, retro, weathering, glass and water, particles, a health bar over a skinned character, a menu screen and a kit sky) and a 7 second orbit around it after the Lookbook's core path, so a style stack is judged on mixed materials, transparency, particles, world UI and screen UI at once.
Version 1.0.52. Depends on lookbookKit 1.0.53 and the published kits listed below.
## Install and use
Installs with several dependencies can be slow (#21420), so give an install time to finish and check `/zero/source` for the package folder. Install lookbookShowcaseKit beside lookbookKit, and install the kits listed below from ZeroMind (each as its own install; a fresh install of each brings its own dependencies). Then, in the scene that holds the Lookbook (inside `content()` of its `build.luau`), or from the console:
```luau
local ShowcaseStop = require("~lookbookShowcaseKit.ShowcaseStop")
ShowcaseStop.build({ 420, 0, 0 }, { sky = false }) -- the set, 90 m past the last core stop
ShowcaseStop.register() -- the 7 s orbit, after the core path
```
- `build(origin?, opts?)` spawns the set under one root (`LookbookShowcaseSet`) facing +Z, after removing the set it built before, so it is safe to run again. `opts.sky = false` leaves out the sky clock, `opts.menu = false` leaves out the menu screen, `opts.hour` sets the hour the clock holds (default 16.5).
- `register(origin?)` adds the `showcase` stop with `LookbookPath.extend`; `unregister()` takes it off. `clear()` removes the set.
- Open the `LookbookShowcase` scene (`lookbookShowcaseKit.LookbookShowcase`) to see the set alone at the origin, with the normal player (humanoid body, orbiting follow camera, a spawn facing the set), a sun and an ambient light, and an empty shared `StyleStack` to stack looks on.
In the Lookbook pass `{ sky = false }`: the sky clock is one per scene and drives the scene's sun and ambient light, which the Lookbook animates itself (the rotating sun and the every-light-off moment). In `LookbookShowcase` the clock runs with the defaults.
## What it holds
| Asset | What it does |
|---|---|
| `ShowcaseStop` (module) | `build`, `clear`, `register`, `unregister`. |
| `ShowcaseEmitter` (component) | Replays a juiceKit effect preset on an interval, in edit and in play. |
| `ShowcaseMenu` (component) | Shows a menusKit screen; in edit it draws the kit's screen tree itself, without the full-screen backdrop. |
| `ShowcasePreview` (component) | Steps and draws barsKit's bars in edit mode, where the game clock is held. |
| `ShowcaseIdle` (component) | Loops an idle clip on the humanoid with a one-clip AnimGraph. |
| `LookbookShowcase` (scene) | The set alone, with the normal player setup and an empty style stack. |
## Kits and assets used
Every kit was installed fresh from ZeroMind into this world as its own install.
| Kit (install name) | Version | Asset guid | World guid | Installed at | What the set uses |
|---|---|---|---|---|---|
| masonryMaterials (Brick and Mortar) | 2.0.0 | c93d1342-55ce-48e4-b8b8-65078a38840e | 202c4393-4736-470d-b686-b9a6142d2a7a | `/source/masonryMaterials.package` | `pavingSlabs` floor, `brickRunning` back wall, `brickFlemish` piers, `concreteSmooth` wall cap and glass foot, `concreteStained` basin rim, `pavingBrickHerringbone` step |
| toonMaterials (Ink and Gouache) | 1.0.4 | aafbaae5-5d94-4661-b8d4-688eeed11d1b | f17aab57-41f4-46b7-b5f5-7a0ec0ea7e6c | `/source/toonMaterials.package` | `toonBrick` cottage walls, `paintedRoofTiles` roof, `toonPlanks` door, `toonStone` chimney, `toonWood` window frame; the `ToonProp` component (ink outline, world-scale mapping) |
| retroMaterials (Pixel and Scanline) | 1.0.2 | 3af3436c-590e-4549-a0d9-b1880c237aeb | b883de81-1a46-4792-9bbe-61cddc185468 | `/source/retroMaterials.package` | `retroPlanks16` crates, `voxelOre` block, `crtTelevision` panel, `ps1Concrete` stand |
| weatheringMaterials (Wear and Tear) | 1.0.11 | cb4ddc77-61d5-4420-9e6b-c3c560cf8d92 | 5e63a079-af91-4d33-8af2-30aa60071a36 | `/source/weatheringMaterials.package` | the `Weathered` component with overlays `mossCreep` and `creviceGrime` (wall), `risingDamp` (piers), `toonDirtPatches` (cottage), `sootStains` (chimney), `dirtFilm` and `scratches` (crate), `settledDust` (CRT), `waterStains` (basin rim) |
| glassLiquidsMaterials (Looking Glass) | 1.0.5 | d98f6085-4434-488c-a864-f28762580a72 | 5ea0a517-cfec-4772-9ff6-6e6d73f8bb3f | `/source/glassLiquidsMaterials.package` | `glassClear` window pane and bottle, `glassTintedGreen` standing panel, `waterStill` basin water, `honey` in the bottle |
| materialLibraryKit (Swatchbook, brought by the four collections) | 1.3.1 | 0d7f3e76-0699-44fd-b0ac-2cb37822b648 | a8c1db81-44f9-4da4-a9a5-4dc8095cdd7f | `/source/deps/a8c1db81-44f9-4da4-a9a5-4dc8095cdd7f/materialLibraryKit.package` | `Materials.get(id).material` to fetch every material above by name |
| juiceKit (Juicebox) | 1.2.2 | eed55f6d-afaf-4767-83c5-539ef91e0dc5 | 46548c0c-2e82-486f-8dc1-d05797c98aaf | `/source/juiceKit.package` | `Juice.play` with `vfxSparks` (over the CRT, every 0.9 s) and `vfxSmoke` (chimney, every 1.6 s), realistic look |
| barsKit (Gaugeworks) | 1.3.0 | c154eb07-ce7c-48ca-8232-4ce1a8754214 | d9f6c7f4-b6e3-4865-958f-8b9ed971056d | `/source/barsKit.package` | the `Bar` component, look `stacked` (shield on health), world placement over the character; the `hud` module for the edit-mode preview |
| SecondWind (Second Wind, brought by barsKit) | 1.2.0 | 5da0a53c-5953-4adc-80fb-f5afb02f6568 | 7a497fbf-1b4e-4655-8abf-e588fa7caa5c | `/source/deps/7a497fbf-1b4e-4655-8abf-e588fa7caa5c/SecondWind.package` | the `Vitals` component on the character: shield model, 100 health, 60 shield, invulnerable |
| menusKit (Press Start Studio) | 1.3.1 | 61aaf7c0-6b6e-4451-9141-a5ef7a087272 | 37a0d1f9-9896-4626-b140-43fea7fbedeb | `/source/menusKit.package` | the title screen in the `cozy` look and `rail` layout (`Menus.setup`, `Menus.show`, `Menus.build`) |
| worldClockKit (Skyclock) | 1.4.0 | da911599-3bdf-4c1e-a4c3-ce13364692bf | a77932ae-c366-4a6a-9fa4-2984fcad8efa | `/source/worldClockKit.package` | one `WorldClock` (realistic sky, clear weather, paused at 16:30, sound off) |
| Engine humanoid | builtin | - | - | `@builtin::avatars.humanoid` | the skinned character, idling on `A_Idle_Standing_Masc` from the engine's character controller |
## The example stack over these kits
What the styleKit README's first example (posterize, duotone at 0.5, depth line, sketch line at 0.6) does to this set, measured on presented frames of the stop with and without the stack:
- **Reads well.** The brick wall and piers take light pencil lines along their mortar (the depth line's crease pass follows the normals), which suits brick. The humanoid gets a crisp silhouette. The menu screen and the health bar are drawn after the stack and come out unchanged.
- **Double outlines on the toon cottage.** The toon collection draws its own ink hull (ToonProp), and the depth line draws a second, thinner line along the same roof eaves and corners. One owner per edge: put the toon props in a mask group and give the Line block `mask = { kind = "group", group = 1, invert = true }`, or switch the kit's outline off.
- **Fighting palettes.** Duotone at half strength pulls the kits' own colours toward its two inks: chroma drops from 6.2 to 3.8 on the toon brick, from 5.3 to 2.8 on the green glass and from 6.3 to 4.8 on the CRT screen. Over painted kits, leave the Colour slot empty or limit it with a group mask.
- **Particles.** The smoke puffs pick up a faint sketch ring, since the sketch line reacts to colour edges and smoke has no depth.
- **Smudges on flat masonry.** The paving slabs and the concrete basin rim carry stains in their textures, and the sketch line's crease pass draws them as dark smudges. Lower the sketch line's `crease`, or mask it to the characters, where a clean floor matters.
- **World UI.** The health bar is a screen drawn after the stack, placed over the character's head, so the stack never touches it and its green and blue stay exact.
- **Kit behaviour, not the stack:** the menu kit's full backdrop dims the whole set while its title screen shows in play, and the weathering kit's moss and grime overlays on the back wall do not show in edit.
## Seeing the health bar and the menu in the editor
The health bar and the menu are screens drawn into a scene camera's picture. The editor's fly camera is not a scene camera, so in the editor view neither shows. To see them while authoring, look through the scene's player camera:
```luau
local ShowcaseStop = require("~lookbookShowcaseKit.ShowcaseStop")
ShowcaseStop.preview() -- look through the player camera: the menu and the health bar show
ShowcaseStop.preview(false) -- back to the editor's fly camera
```
In play both show without any of this.
**Why masonry now, and stone before.** Versions up to 1.0.3 built the floor and walls from stoneMaterials (Bedrock), a stone collection that was installed in place of the masonry kit you asked for, without saying so. That was a mistake: the masonry collection exists (masonryMaterials 2.0.0) and is what this stop is meant to show. From 1.0.4 the set uses masonry only, stoneMaterials is no longer a dependency and has been removed from this world, and every material is named with its collection (`masonry/brickRunning`, `toon/toonBrick`), because the masonry kit also ships a `toonBrick` and a bare name would pick whichever collection registered last.
## Known limits
- **The health bar and the shield are play-mode features.** SecondWind's `Vitals` ticks only in play, so in edit the character reads full health and no shield (the bar shows health alone); in play the shield fills. barsKit's `Bar` only draws in play; `ShowcasePreview` draws it in edit by stepping the kit's bars on the real clock. World bars are placed with the engine's `worldToScreen`, so an offscreen capture from a camera of its own does not place the bar over the head.
- **The menu covers the set in play.** In play menusKit's own host draws the title screen with its full-screen backdrop and holds the player's input until Play is picked. The edit drawing (what the Lookbook sees while authoring) leaves the backdrop out by removing the node whose id ends in `_bg` from the kit's tree; a change to that tree in menusKit would bring the backdrop back.
- **Wall moss and crevice grime did not show** in edit-mode captures although both shells were built with their overlay materials; the cottage's cartoon dirt, the crate's dirt and the dust show. In edit the `Weathered` component's task waits while gameplay is paused.
- **The sky clock owns the scene's lights.** One `WorldClock` per scene; it drives the scene's sun and ambient light, which is why the Lookbook should build the set with `{ sky = false }`.
- **Offscreen captures do not draw the style stack** (styleKit runs after post); judge looks on the stop from presented frames.
- The particles are juiceKit bursts replayed on a timer, so they come in pulses rather than as a steady stream.
- **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); installs with several dependencies are slow (#21420); the ZeroMind description can lag one release (#19258); the web build was not checked from here (#20946).
## Version history
**1.0.51 (2026-11-12)**: pins lookbookKit 1.0.52, styleKit 1.7.8 (styleKit 1.7.8 logs no second refusal for the old roles field on a scene saved before styleKit 1.5). Nothing else changed.
**1.0.50 (2026-11-12)**: pins lookbookKit 1.0.51 (styleKit 1.7.7: a role set or look another player changes reaches everyone in the session). Nothing else changed.
**1.0.49 (2026-11-12)**: pins lookbookKit 1.0.50 (styleKit 1.7.6: an ink set by hand on one object reads as set, and a set for a kind of game carries its groups before a look is picked). Nothing else changed.
**1.0.48 (2026-11-12)**: pins lookbookKit 1.0.49 (styleKit 1.7.5: its checks pass where styleKit is installed alone). Nothing else changed.
**1.0.47 (2026-11-12)**: pins lookbookKit 1.0.48 (styleKit 1.7.4: installs on its own into an empty world again). Nothing else changed.
**1.0.46 (2026-11-12)**: pins lookbookKit 1.0.47 (styleKit 1.7.3: a role reaches what a kit draws in an object's place (pickupsKit's coins), and looks installed after the first scan are found). Nothing else changed.
**1.0.45 (2026-11-12)**: pins lookbookKit 1.0.46 (styleKit 1.7.0: role sets' glazes tell groups sharing a material apart, things with no role keep the plain line under a toon look, a look switched on never flashes black while its shaders compile). Nothing else changed.
**1.0.44 (2026-11-11)**: pins lookbookKit 1.0.45 (lookbookKit 1.0.45 brings its Lookbook scene with it when it is installed as another package's dependency, so the toonBlocks, inkBlocks and paperBlocks unlit-frame tests and `zero lookbook` run in an installed world). Nothing else changed.
**1.0.43 (2026-11-11)**: pins lookbookKit 1.0.44 (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.0.42 (2026-11-11)**: pins lookbookKit 1.0.43 (styleKit 1.6.4 puts a role given to a player template on the body every joining player is copied from and rebuilds the role mask at most four times a second, and toonBlocks 1.3.6 starts its toon ink by itself and draws every role ink through one shared flood). 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.0.41 (2026-11-11)**: pins lookbookKit 1.0.42 (styleKit 1.6.2 finds the scene's stack again when the one it held was removed (after a play restart a look or role set change failed with "the component this proxy names was removed")). Nothing else changed.
**1.0.40 (2026-11-11)**: pins lookbookKit 1.0.41. Nothing else changed.
**1.0.39 (2026-11-11)**: pins lookbookKit 1.0.40 (styleKit 1.5.1 keeps the scene's role set working in an editor that had an older styleKit open). Nothing else changed.
**1.0.38 (2026-11-11)**: pins lookbookKit 1.0.39. Nothing else changed.
**1.0.34 (2026-11-08)**: moves to the engine's current built-in library (@builtin e89b9db), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins lookbookKit 1.0.35. Nothing else changed.
**1.0.33 (2026-11-08)**: moves to the engine's current built-in library (@builtin edb50c2), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins lookbookKit 1.0.34. Nothing else changed.
**1.0.32 (2026-11-08)**: pins toonMaterials 1.0.11 (was 1.0.4), built on materialLibraryKit 1.4.3 and the current engine library. Nothing else changed.
**1.0.31 (2026-11-08)**: moves to the engine's current built-in library (@builtin f4425a5), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins lookbookKit 1.0.33. Nothing else changed.
**1.0.30 (2026-11-08)**: moves to the engine's current built-in library (@builtin f39f044), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins lookbookKit 1.0.32. Nothing else changed.
**1.0.29 (2026-11-08)**: pins lookbookKit 1.0.31; the package's description now reads as a store listing (what you get and how to start), without a version number or a list of changes.
**1.0.28 (2026-11-08)**: pins lookbookKit 1.0.30. Nothing else changed.
**1.0.27 (2026-11-08)**: pins lookbookKit 1.0.29. Nothing else changed.
**1.0.26 (2026-11-08)**: moves to the engine's current built-in library (@builtin f110cb3), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.28. Nothing else changed.
**1.0.25 (2026-11-08)**: moves to the engine's current built-in library (@builtin a29b227), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.27. Nothing else changed.
**1.0.24 (2026-11-08)**: moves to the engine's current built-in library (@builtin c61f473), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.26. Nothing else changed.
**1.0.23 (2026-11-07)**: moves to the engine's current built-in library (@builtin 7ca1f19), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.25. Nothing else changed.
**1.0.22 (2026-11-07)**: keeps its pins with the Cookbook's other packages, which moved to the engine's current built-in library (@builtin fdc9a99). Pins lookbookKit 1.0.24. Nothing else changed.
**1.0.21 (2026-11-07)**: moves to the engine's current built-in library (@builtin 7e13a48), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.23. Nothing else changed.
**1.0.20 (2026-11-07)**: moves to the engine's current built-in library (@builtin 2809239), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.22. Nothing else changed.
**1.0.19 (2026-11-07)**: pins lookbookKit 1.0.21. No change to the stop.
**1.0.18 (2026-11-07)**: moves to the engine's current built-in library (@builtin 278f02f), whose update rewrote small reference files inside the package. No block, look or shader changed. Pins lookbookKit 1.0.20.
**1.0.17 (2026-11-07)**: moves to the engine's current built-in library (@builtin 6656162), whose update rewrote small reference files inside the package. No block, look or shader changed. Pins lookbookKit 1.0.19.
**1.0.16 (2026-11-07)**: moves to the engine's current built-in library (@builtin 808b4a1), whose update rewrote small reference files inside the package. Pins lookbookKit 1.0.18. No block, look or shader changed.
**1.0.15 (2026-11-07)**: depends on lookbookKit 1.0.17; no change to the stop.
**1.0.14 (2026-11-07)**: depends on lookbookKit 1.0.16; no change to the stop.
**1.0.13 (2026-11-03)**: depends on lookbookKit 1.0.15; no change to the stop.
**1.0.12 (2026-11-02)**: needs lookbookKit 1.0.14 (runs that finish on their own); nothing in the stage changed.
**1.0.11 (2026-11-02)**: needs lookbookKit 1.0.13; nothing in the stage changed.
**1.0.10 (2026-11-02)**: needs lookbookKit 1.0.12 (which needs styleKit 1.2.3); nothing in the stage changed.
**1.0.9 (2026-11-01)**: built on lookbookKit 1.0.11 (runs state their view size and refuse one whose view changed size).
**1.0.8 (2026-11-01)**: documentation only: install notes describe how installing works (install from ZeroMind search; installs with several dependencies can be slow) without naming internal ticket numbers.
**1.0.7 (2026-11-01)**: documentation only: the install note says how installing works today (install from ZeroMind search; installs with several dependencies can be slow).
**1.0.6 (2026-10-31)**: store listing rewritten for creators; built on lookbookKit 1.0.5.
**1.0.5 (2026-10-31)**: built on lookbookKit 1.0.4.
**1.0.4 (2026-10-31)**: the set is built from the masonry collection (masonryMaterials 2.0.0) as asked, in place of stoneMaterials, which is removed; every material is named with its collection; `ShowcaseStop.preview()` shows the health bar and the menu in the editor; findings redone on the masonry.
**1.0.3 (2026-10-31)**: the LookbookShowcase scene is built and saved (it held only a placeholder before).
**1.0.2 (2026-10-31)**: the LookbookShowcase scene file loads standalone.
**1.0.1 (2026-10-31)**: findings for the example stack over the kits; depends on lookbookKit 1.0.1.
**1.0.0 (2026-10-31)**: first release.
# lookbookKit
The Lookbook: a scripted test scene with one repeatable 26-second camera path whose stops each test one way a look fails, plus the code that plays it over any style stack, saves the same frames for side-by-side comparison and measures stability with real numbers.
Version 1.0.53. Depends on styleKit 1.7.8 and starterBlocks 1.0.49 (the tests, the combination test and the reference looks use its blocks).
## Install and use
Install **lookbookKit** from ZeroMind (search "lookbookKit" or "style lookbook test scene"); it brings styleKit and starterBlocks along (the Lookbook's tests, combination test and reference looks use starterBlocks' blocks). Installs with several dependencies can be slow (#21420), so give an install time to finish and check `/zero/source` for the package folder. Every call below loads the `Lookbook` scene first when it is not loaded (`Lookbook.ensureScene()`), so you can start from any scene:
```luau
local Lookbook = require("~lookbookKit.Lookbook")
local StyleKit = require("~styleKit.StyleKit")
StyleKit.load({ { block = "posterize" }, { block = "depthLine" } })
local shots = Lookbook.run({ label = "posterInk" }) -- the same frames, as PNGs
local numbers = Lookbook.measure({ dt = 1 / 15 }) -- stability numbers, styled and unstyled
print(numbers.stylized.all.warpedDiff, numbers.stylized.markStuck, numbers.passMs.high.total)
local cmp = Lookbook.compare({ { block = "depthLine" } }, { { block = "sketchLine" } }) -- two stacks side by side
print(cmp.sideBySide[1].file) -- stack A on the left, B on the right
Lookbook.combos("depthLine") -- the combination test
```
From the shell: `zero lookbook measure`, `zero lookbook run myLook`, `zero lookbook combos depthLine`.
## The stops
One camera path, 26 seconds, the same every time (everything that moves is driven by the Lookbook's clock, so the same moment gives the same frame):
| # | Stop | What it tests |
|---|---|---|
| 1 | Textured wall | A fine texture under a pan, a dolly, an orbit and a 10x zoom: marks that slide, swim or keep their screen size. |
| 2 | Flat grey wall under a slow light change | Banding and steps sweeping across a flat surface as light changes slowly. |
| 3 | Thin geometry | Wires and fence slats thinner than a line: shimmer and broken lines. |
| 4 | Floor grazing to the horizon | False lines and mark noise on a surface seen edge-on. |
| 5 | Fast skinned character | Lines and marks on a fast, deforming body. |
| 6 | Contact and intersection | Double outlines and halos where objects touch and cut through each other. |
| 7 | Wind-blown foliage | Busy edges and flicker on swaying leaf cards. |
| 8 | Transparency | Glass, water and smoke over lined objects. |
| 9 | Rotating sun, moving spot, zero lights | Light-dependent blocks under moving light, and a moment with every light off, where the frame must stay black. |
| 10 | Depth planes with fog and sky | Planes from 5 to 160 m in fog: line fading, mark size with distance, sky treatment. |
| 11 | Mixed animation rates | Objects stepping at 6, 12, 24 and 60 per second beside smooth motion and the held clock. |
| 12 | Excluded object, world label and UI | An object the stack must leave alone, a label in the world, and screen UI that must stay readable. |
`LookbookPath.segments()` names the moments the measurements read: `pan`, `dolly`, `orbit`, `zoom`, `slowLight`, `sunRotate`, `zeroLights`, `excluded`. Packages can add stops after the core path with `LookbookPath.extend(stop)` (lookbookShowcaseKit adds one built from published kits).
## The numbers
Everything is measured on the frame the player saw, after antialiasing, the upscale and the stack, before the UI, by the `lookbookProbe` render feature on the GPU, and read back:
- **warpedDiff**: the mean difference (0..255) between each frame and the one before it, warped along the motion vectors, with newly revealed pixels left out (`revealedShare` says how many). A stable look scores close to the unstyled frame; boil and grain raise it on purpose.
- **marks / marksWarped / marksSameSpot / markStuck**: the stack's own marks are the frame the player saw less the frame before the stack. `marks` is how strong their fine detail is; `marksWarped` and `marksSameSpot` correlate it with the previous frame along motion and on the same screen spot. During the pan, **markStuck** = sameSpot less warped: clearly negative when the marks stay on things (plain paper reads about -0.52), clearly positive when they are stuck to the screen. **markStuckBy** gives the same score for every move of the path that has marks to score (`pan`, `orbit`, `dolly`, `zoom` and the rest of `LookbookPath.segments()`). Absent when a stack leaves no marks of its own: an empty stack has none.
- **detailWarped / detailSameSpot**: how well fine detail (a pixel less the mean of its four neighbours) correlates with the previous frame along motion, and on the same screen spot. During the pan, **screenStuck** = same spot minus warped: positive means marks stay on the screen instead of on things.
- **zoomMarks**: the typical size of fine marks (pixels between detail sign changes) at the start and the end of the 10x zoom. Marks that stay on things grow with the zoom (`growth` well above 1); marks stuck to the screen keep their size (`growth` near 1).
- **passMs**: GPU milliseconds per style pass (`post.sk.<entry>.<block>`) and their total, measured over the pan at each quality tier asked for (high and low by default).
- **baseline**: the same numbers for the unstyled frame, measured in the same run.
- **missed**: frames the probe could not read back (0 in every run so far); a run with misses is not comparable.
How a run steps: the probe itself places the camera and the clock one `dt` step per drawn frame, and measures every frame against the frame before it, so the camera moves on every frame as a player's does and two runs place the same poses and measure the same frames, whatever the frame rate. Two runs of the same stack give identical numbers.
`Lookbook.compare(a, b)` photographs the same moments for both stacks (`<folder>/a`, `<folder>/b`), writes one side-by-side picture per moment (`<folder>/side_<T>_<stop>.png`, A left, B right) and measures both (`numbers.a`, `numbers.b`; pass `numbers = false` to skip).
`Lookbook.combos(blockId)` puts the block with one partner from every other slot (partners at strength 0.6), plays the pan, then swaps the block for a sibling of its slot and plays it again. A round fails when an entry did not run, the engine logged errors, or no frame was measured.
## Cost per look, and measuring on the web
`Lookbook.cost()` (shell: `zero lookbook cost 1920 1080`) times every style pass of a look over the pan, high and low quality, with the 3D view drawing at the size you ask for: in the editor the window is grown until the view itself is that size, so the numbers are for a real 1080p picture. The cost table for this release is in styleKit's README under "What a look costs".
**On the web**, one command does the whole report. Open this world in a browser engine, and in its shell run:
```
zero lookbook report
```
It first measures the frame rate in the scene you are in (`Lookbook.frameRate()`: no look, the Cookbook look on high, on low, taken in turns so a machine that speeds up or slows down meanwhile affects all three alike), then loads the Lookbook scene, measures the Cookbook stack over the full path (stability numbers beside the unstyled frame), prices every reference look at 1920 x 1080, writes `/zero/source/tmp/lookbook/report_<platform>.md` and `.json`, and puts the previous scene back. `zero lookbook report true` adds every block alone. A desktop run of the same command writes `report_native.md`, so the two sit side by side. The numbers do not depend on the frame rate (one measured step per drawn frame), so a slower browser gives the same stability numbers and only the milliseconds differ.
## Parts
- `Lookbook.scene`: the stops, the player setup, a synced empty StyleStack, the `LookbookCamera` the runner routes to the viewport, the excluded object `LookbookExcluded`, the world label and the screen panel.
- `LookbookPath`: the path (`LENGTH`, `STOPS`, `pose(T)`, `segments()`, `extend`).
- `LookbookClock`: the Lookbook's time; `LookbookAnimator`: the component that moves everything from it.
- `Lookbook`: `run`, `compare`, `measure`, `combos`, `frameAt`, `frameRate`, `cost`, `report`, `keyTimes`, `last`, `ensureScene`, `restoreScene`.
- `lookbookProbe` render feature and the `lbStore` / `lbMeasure` compute shaders.
- `lookbook` toolbox (`measure`, `run`, `combos`, `cost`, `report`) and the `lookbook` test suite.
## Known limits
- The runner takes the viewport (`camera.setEditorOverride`) while it plays and gives it back after; do not drive the editor camera meanwhile.
- A call made from another scene loads the Lookbook scene and leaves it loaded; `ensureScene` returns the scene it replaced and `restoreScene` puts it back (the test suite does both).
- The numbers are taken one step per drawn frame at the `dt` you pass, so they do not depend on the frame rate; compare stacks measured with the same `dt`. Two runs of the same stack give the same numbers to every printed digit.
- The smoke in the transparency stop is moving cards, since the engine's particle effects cannot be driven by the Lookbook's clock frame by frame.
- Offscreen captures do not draw the stack (styleKit runs after post); the Lookbook therefore always reads presented frames.
- **Other engine issues that apply here:** every render pass is queued again every frame, so script cost grows with the passes a look queues (#24548); a two-client editor sometimes refuses to load two different scenes at once (#24666, #24667); installs with several dependencies are slow (#21420); the ZeroMind description can lag one release (#19258); the web build was not checked from here (#20946).
## Version history
**1.0.52 (2026-11-12)**: pins starterBlocks 1.0.49, styleKit 1.7.8 (styleKit 1.7.8 logs no second refusal for the old roles field on a scene saved before styleKit 1.5). Nothing else changed.
**1.0.51 (2026-11-12)**: pins starterBlocks 1.0.48, styleKit 1.7.7 (styleKit 1.7.7: a role set or look another player changes reaches everyone in the session). Nothing else changed.
**1.0.50 (2026-11-12)**: pins starterBlocks 1.0.47, styleKit 1.7.6 (styleKit 1.7.6: an ink set by hand on one object reads as set, and a set for a kind of game carries its groups before a look is picked). Nothing else changed.
**1.0.49 (2026-11-12)**: pins starterBlocks 1.0.46, styleKit 1.7.5 (styleKit 1.7.5: its checks pass where styleKit is installed alone). Nothing else changed.
**1.0.48 (2026-11-12)**: pins starterBlocks 1.0.45, styleKit 1.7.4 (styleKit 1.7.4: installs on its own into an empty world again). Nothing else changed.
**1.0.47 (2026-11-12)**: pins starterBlocks 1.0.44, styleKit 1.7.3 (styleKit 1.7.3: a role reaches what a kit draws in an object's place (pickupsKit's coins), and looks installed after the first scan are found). Nothing else changed.
**1.0.46 (2026-11-12)**: pins starterBlocks 1.0.43, styleKit 1.7.0 (styleKit 1.7.0: role sets' glazes tell groups sharing a material apart, things with no role keep the plain line under a toon look, a look switched on never flashes black while its shaders compile). Nothing else changed.
**1.0.45 (2026-11-11)**: a world that gets lookbookKit as another package's dependency (toonBlocks, pencilBlocks) now gets the Lookbook scene too. An install brings the parts of a dependency its users reference, and nothing named the scene, so such a world held the Lookbook's modules and no scene: `ensureScene`, the unlit-frame tests of toonBlocks, inkBlocks and paperBlocks, and `zero lookbook` all failed with "not found". `Lookbook.sceneName()` now lists the kit's scenes with literal selectors (`asset.list({ type = "scene", path = ... })`), which records the scene as the module's dependency, and finds it installed by the name it shares with the module. Checked in a freshly made world: 1.0.44 installed no scene.
**1.0.44 (2026-11-11)**: `Lookbook.sceneName()`, the Lookbook scene's name where the kit is authored and where it is installed, used by `ensureScene` and `restoreScene`. (Meant to fix the unlit-frame tests in an installed world; it did not, because the scene was not installed at all: 1.0.45 fixes that.) Pins styleKit 1.6.5 and starterBlocks 1.0.42.
**1.0.43 (2026-11-11)**: pins starterBlocks 1.0.41, styleKit 1.6.4 (styleKit 1.6.4 puts a role given to a player template on the body every joining player is copied from and rebuilds the role mask at most four times a second, and toonBlocks 1.3.6 starts its toon ink by itself and draws every role ink through one shared flood). 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.0.42 (2026-11-11)**: pins starterBlocks 1.0.40, styleKit 1.6.2 (styleKit 1.6.2 finds the scene's stack again when the one it held was removed (after a play restart a look or role set change failed with "the component this proxy names was removed")). Nothing else changed.
**1.0.41 (2026-11-11)**: pins starterBlocks 1.0.39, styleKit 1.6.1. Nothing else changed.
**1.0.40 (2026-11-11)**: pins starterBlocks 1.0.38, styleKit 1.5.1 (styleKit 1.5.1 keeps the scene's role set working in an editor that had an older styleKit open). Nothing else changed.
**1.0.39 (2026-11-11)**: pins styleKit 1.5.0 and starterBlocks 1.0.37. Nothing else changed.
**1.0.35 (2026-11-08)**: moves to the engine's current built-in library (@builtin e89b9db), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins styleKit 1.4.21, starterBlocks 1.0.33. Nothing else changed.
**1.0.34 (2026-11-08)**: moves to the engine's current built-in library (@builtin edb50c2), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins styleKit 1.4.20 and starterBlocks 1.0.32. Nothing else changed.
**1.0.33 (2026-11-08)**: moves to the engine's current built-in library (@builtin f4425a5), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins styleKit 1.4.19 and starterBlocks 1.0.31. Nothing else changed.
**1.0.32 (2026-11-08)**: moves to the engine's current built-in library (@builtin f39f044), whose update rewrote small reference files inside the package (a world on an older built-in library is hidden from players). Pins styleKit 1.4.18 and starterBlocks 1.0.30. Nothing else changed.
**1.0.31 (2026-11-08)**: pins styleKit 1.4.15 and starterBlocks 1.0.29; the package's description now reads as a store listing (what you get and how to start), without a version number or a list of changes.
**1.0.30 (2026-11-08)**: pins styleKit 1.4.14 and starterBlocks 1.0.28. Nothing else changed.
**1.0.29 (2026-11-08)**: pins styleKit 1.4.13 and starterBlocks 1.0.27. Nothing else changed.
**1.0.28 (2026-11-08)**: moves to the engine's current built-in library (@builtin f110cb3), whose update rewrote small reference files inside the package. Pins styleKit 1.4.12, starterBlocks 1.0.26. Nothing else changed.
**1.0.27 (2026-11-08)**: moves to the engine's current built-in library (@builtin a29b227), whose update rewrote small reference files inside the package. Pins styleKit 1.4.11, starterBlocks 1.0.25. Nothing else changed.
**1.0.26 (2026-11-08)**: moves to the engine's current built-in library (@builtin c61f473), whose update rewrote small reference files inside the package. Pins styleKit 1.4.10, starterBlocks 1.0.24. Nothing else changed.
**1.0.25 (2026-11-07)**: moves to the engine's current built-in library (@builtin 7ca1f19), whose update rewrote small reference files inside the package. Pins styleKit 1.4.8, starterBlocks 1.0.23. Nothing else changed.
**1.0.24 (2026-11-07)**: keeps its pins with the Cookbook's other packages, which moved to the engine's current built-in library (@builtin fdc9a99). Pins styleKit 1.4.7, starterBlocks 1.0.22. Nothing else changed.
**1.0.23 (2026-11-07)**: moves to the engine's current built-in library (@builtin 7e13a48), whose update rewrote small reference files inside the package. Pins styleKit 1.4.6, starterBlocks 1.0.21. Nothing else changed.
**1.0.22 (2026-11-07)**: moves to the engine's current built-in library (@builtin 2809239), whose update rewrote small reference files inside the package. Pins starterBlocks 1.0.20, styleKit 1.4.5. Nothing else changed.
**1.0.21 (2026-11-07)**: the marks score reads the stack's marks again. The probe takes the stack's marks as the frame less the frame before the stack, and it mapped each pixel to the other image as a whole pixel times one size over the other; on current engine builds that product comes out a hair under the whole number, and truncating it read the frame before the stack one pixel to the left and up. The "marks" were then the picture's own one-pixel gradient, which sits on the screen, so every stack scored as stuck to the screen (plain paper +0.95, with an empty stack still showing marks of strength 15). It now samples at the pixel's centre: an empty stack has no marks, plain paper reads -0.52 and pencilBlocks' Pencil sketch -0.52. This was also the cause of the old known limit that the score swung with a few pixels of view size, which is gone. New `markStuckBy`: the score for every move of the path, not only the pan.
**1.0.20 (2026-11-07)**: moves to the engine's current built-in library (@builtin 278f02f), whose update rewrote small reference files inside the package. No block, look or shader changed. Pins starterBlocks 1.0.19, styleKit 1.4.4.
**1.0.19 (2026-11-07)**: moves to the engine's current built-in library (@builtin 6656162), whose update rewrote small reference files inside the package. No block, look or shader changed. Pins starterBlocks 1.0.18, styleKit 1.4.3.
**1.0.18 (2026-11-07)**: moves to the engine's current built-in library (@builtin 808b4a1), whose update rewrote small reference files inside the package. Pins starterBlocks 1.0.17, styleKit 1.4.2. No block, look or shader changed.
**1.0.17 (2026-11-07)**: depends on styleKit 1.4.1 and starterBlocks 1.0.16; no change to the Lookbook.
**1.0.16 (2026-11-07)**: depends on styleKit 1.4.0 and starterBlocks 1.0.15; no change to the Lookbook. Measured on engine build d4061d2, the "marks on things" number reads positive for pencil looks whether they run on pencilBlocks 1.0.4 or 1.1.0 (Pencil sketch +0.68 and +0.67), where it read about -0.5 on 2026-11-03; the stack's marks are taken from the frame before the stack, and how that frame is taken on this build has not been checked yet.\n\n**1.0.15 (2026-11-03)**: depends on styleKit 1.3.0 and starterBlocks 1.0.14; no change to the Lookbook.
**1.0.14 (2026-11-02)**: a run no longer stalls when nobody touches the engine. The renderer draws only frames that show something new unless told otherwise; once it judged the picture still it declined frames, and a run, which steps one camera pose per drawn frame, sat waiting (often around step 90 of 780) until a click or a tool call woke it, then went on with its frames drawn at uneven moments, which also moved its numbers. `measure`, `run` and `frameAt` now hold every-frame drawing (`renderer.setDrawEveryFrame(true)`) for their whole length and put the previous setting back when they end, however they end.
**1.0.13 (2026-11-02)**: needs styleKit 1.2.4 and starterBlocks 1.0.13; no block changed.
**1.0.12 (2026-11-02)**: needs styleKit 1.2.3, which keeps the scene's sun on a block after its shader compiles (a fresh install could draw sun-lit blocks without their sun); no block changed.
**1.0.11 (2026-11-01)**: `Lookbook.measure` states the 3D view size its motion numbers were measured at (`result.size`), and refuses a run whose view changed size halfway (an editor panel opening or the window resized), since every number depends on that size; built on styleKit 1.2.2, whose sun no longer carries over from the run before.
**1.0.10 (2026-11-01)**: documentation only: install notes describe how installing works (install from ZeroMind search; installs with several dependencies can be slow) without naming internal ticket numbers.
**1.0.9 (2026-11-01)**: documentation only: the install note says how installing works today (install from ZeroMind search; installs with several dependencies can be slow).
**1.0.8 (2026-11-01)**: the report and `Lookbook.cost` also price the ink looks (brush and wash, comic) and line and wash wherever every block they name is installed (inkBlocks, watercolorBlocks), and the report adds the brush-and-wash ink look to its frame-rate table, so `zero lookbook report` in a web build gives the ink numbers too. Worlds without those kits get the same rows as before.
**1.0.7 (2026-11-01)**: a measurement also waits until no shader has compiled and no GPU pipeline has been built for a whole second after its stack loads, so the first run after a scene load no longer measures frames drawn before the stack's shaders were ready.
**1.0.6 (2026-11-01)**: every measurement waits until the stack it loads has finished compiling and the picture has settled before it starts, so the first run after a stack change no longer measures half-styled frames and two runs give the same numbers.
**1.0.5 (2026-10-31)**: store listing rewritten for creators; built on styleKit 1.0.8 and starterBlocks 1.0.6.
**1.0.4 (2026-10-31)**: depends on starterBlocks as well as styleKit, as it always used both; `Lookbook.frameRate()` measures the frame rate in the scene you are in (no look, high, low, in turns), and `zero lookbook report` starts with it, so a web run states its frame rate.
**1.0.3 (2026-10-31)**: the probe steps and measures one frame per drawn frame, so two runs give identical numbers; `markStuck` tells marks on things from marks on the screen; `compare` writes side-by-side pictures and both stacks' numbers; `run` and `compare` save frames again; every call loads the Lookbook scene itself; `cost` and `report` for 1080p and web numbers; the Lookbook panel no longer dims every frame; new tests for repeatability, stuck marks and combined stacks.
**1.0.2 (2026-10-31)**: runs drive the stack's clock with the Lookbook's time, so a stack with boil or grain gives the same numbers run after run; the probe measures nearly every frame instead of about half; GPU timings are read only once the profiler's window holds the tier alone.
**1.0.1 (2026-10-31)**: `frameAt`, the test suite, frames after a cut left out of the numbers, a run camera of its own, GPU timings counted only for the stack being measured.
**1.0.0 (2026-10-31)**: first release.