Style Cookbook: Mix Your Own Art Style from Stackable Look Blocks
- ..
- .metadata237 B
- README.md3.7 KB
- workflow.js27.2 KB
- workflow.yaml2.7 KB
README.md
inkWorld
Turn an existing world, scene or installed kit into an ink drawing with inkBlocks and styleKit, without breaking or losing anything.
What it does
- Survey. Reads what is there before changing anything: the scene's entities, the materials in use (toon materials with their own outline, emissive, glass and water, bright colours that carry meaning), the lights and whether they change over time, the screen UI, particles, the player and other characters, world labels, any stack already in place (kept so it can be put back), and the ink blocks, whole looks and ink sets installed.
- Reference. Saves the plain presented frame under
/zero/source/tmp/ink/<subject>/and generates a reference ink drawing of the same view with image generation (theimage_genservice), so the tuning has a target to look at. - Choose. Picks a whole look (
inkDrawing,brushAndWash,noirInk,comicInk,sketchbookPen) and an ink colour (inkBlack,inkSepia,inkBrown,inkBlueBlack,inkRedBrown,inkWhiteOnDark,inkRedAccent), or the ink blocks one by one, with a reason for each. - Build. Builds the stack in one call that replaces rather than duplicates:
StyleKit.applyLook(id)thenStyleKit.setPigments(id), orStyleKit.load(entries, { pigments, holdRate, softRadius }). - Tune. Up to three rounds of comparing presented frames against the reference drawing and the asked look, adjusting line weight and distance falloff, wash steps and mist, pools, ink colour and boil.
- Content. Puts the player and moving characters in a mask group and keeps the surface-mark fills off them; gives each outline one owner over toon materials (a group mask on the Line entry, or the kit's own outline switched off, recorded with its restore call); leaves labels a player must read out by name; keeps gameplay colours and screen UI readable.
- Check. UI and labels readable, gameplay colours kept, black stays black, no flashing above 3 Hz and no fine high-contrast stripes, the Lookbook's numbers for the new stack against the old one, and the low quality tier.
- Report. Answers with the look, the ink colour, the stack before and after, every exclusion, group and mask, every outline or material change with the call that restores it, the checks, the Lookbook numbers and how to remove it all.
It is non-destructive: the stack edits no material and comes off with StyleKit.clear() (or by deleting the StyleStack entity), and the report gives the exact StyleKit.load(...) call that puts back the stack from before the run. The one change outside the stack it may make is switching a toon kit's own outline off on chosen objects (ToonInk.set(object, false)), and each one is reported with ToonInk.set(object, true) to put it back.
What it needs
inkBlocks installed (it comes with styleKit and holds its own paper and boil). The reference drawing uses the image_gen service (it spends credits; the run carries on without one if generation fails, and says so). The Lookbook check uses lookbookKit when the world has it and says so when it does not.
Starting it
zero workflow start --name inkWorld --args '{"subject":"main","look":"brush and wash in mist with a crisp player"}'
subject names the world, scene or kit (default: the loaded scene); look is the drawing in the asker's words (default: the run proposes one).
Known limits
- Installing a package with several dependencies can take a while (#21420).
- ZeroMind's description of this can lag one release behind what is installed (#19258).
- The web build was not checked from here (#20946).
The package README's Known limits lists the rest.