Log inGet started
World

Style Cookbook: Mix Your Own Art Style from Stackable Look Blocks

README.md

Blackboard (paperBlocks, Ground)

Dark slate blackboard with chalk dust and ghosts of old wiping, dead matte: the picture reads as light chalk marks on dark. Dark slate with a fine sharp grain, dusty smears of old wiping and chalk specks; no sheen at all.

local StyleKit = require("~styleKit.StyleKit")
StyleKit.swap("paper", "paperBlackboard")   -- replaces the stack's paper in one change

What it does to each kind of block

  • Watercolor: Transparent watercolor cannot show on slate, so the board turns the painted picture into chalk: its lights become chalk marks (keeping a third of their colour, like coloured chalk) that catch the grain, its darks are bare board. Washes read as soft chalk tone; granulation and dry brush read as chalk breaking on the grain.
  • Ink: Ink blocks that read the paper field draw in light chalk instead of dark ink, so lines show; a block that does not read it would draw dark lines that vanish into the board.
  • Lights: Everything you see is put on. The board shows only where the scene has light, so with every light off it is black, not slate.

Its defaults

tint #2a2e2d, toothHeight 0.4, toothSharpness 0.75, toothSize 3, fibre 0, fibreLength 4, fibreTone 0, mottle 0.25, thirst 0.05, emboss 0.15, sheen 0, lights 0.6, lightColour #ecebe3, lightTint 0.35, lightsFrom 0.15, dust 0.6. Every other shared setting is at the shared default (no weave, ruling, foxing or dust).

How it moves and what it covers

  • Motion: the tooth, fibres, weave, blotches and spots are laid on the surfaces they cover (world position along each surface's main axis), so they stay on still things when the camera pans, dollies or zooms; each keeps about the same size in the picture by growing into the next octave rather than sliding, and anything finer than about two drawn pixels fades to its mean, so the distance never shimmers. On a moving prop or a skinned character the sheet slides across it (a full-frame pass has no per-object position).
  • Sky and fog: the sky gets the same sheet, laid on the view direction, so it stays put as you turn; fog is part of the picture and is laid on the paper like any other colour.
  • Transparent things and particles have no depth of their own, so the sheet under them is the sheet of the surface behind.
  • Foliage takes the sheet like any surface; very fine leaves read through its tooth.
  • World text and UI: the screen UI is drawn after the stack and stays readable; world labels take the paper unless they are left out (StyleKit.options({ exclude = { "LabelName" } }), ideally on a card of their own).
  • Black stays black: every pixel returns through styleKit's shared exit and the sheet only multiplies or is lit by the scene's own light, so with every light off the frame is black, never paper coloured.
  • Low quality: the same picture at half resolution; parts too fine for the smaller image are laid as their average instead of aliasing.

Swapping

Every paperBlocks paper shares the same settings, so StyleKit.swap("paper", "<other paper>") changes the sheet in one change and swapping back to the paper you had (inkPaper, wcColdPress, plainPaper or another paperBlocks paper) puts back exactly the settings it had. Keep your tuning across papers with StyleKit.swap("paper", "<other paper>", { keepSettings = true }).

Known limits

  • It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
  • Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
  • Its passes are queued again every frame, even when nothing changed (#24548).

The package README's Known limits lists the rest.