Log inGet started
Package

comicWorld.workflow

Newest version

README.md

comicWorld

Turn an existing world, scene or installed kit into a comic book look with comicBlocks, toneScreens and comicPanels, without destroying anything.

What it does

  1. Survey. Reads what is there before changing anything: the scene, the style stack now, the lights and whether they change over time, the screen UI, particles, the player and other characters, world labels, transparent things, toon or outlined objects, colours that carry gameplay meaning, how fast the camera moves, and which comic packages are installed.
  2. Record. Saves the stack exactly as StyleKit.describe() reports it (entries and options) and ComicPanels.state(), and the unstyled presented frame under /zero/source/tmp/comic/<subject>/, so everything can be put back.
  3. Pick. Turns the asked look (or a proposed one) into one of the eleven comic looks: goldenAgeFourColour, comicNoir, sundayStrip, dailyStrip, modernFlatColour, oneColourSpot, popArtDots, misprintedPulp, twoColourSpotPrint, mangaScreentone, pulpCover; chooses page screens (fast camera) or screens on surfaces (slow camera) and any swaps.
  4. Apply. One StyleKit.applyLook call, keeping the existing Line entries when keepLine is set (and the Medium slot when panels are asked for), then up to three rounds of tuning against presented frames with StyleKit.set.
  5. Panels. Only when panels names a layout: ComicPanels.setLayout(layout, { cameras }) and ComicPanels.matchLook(), checked with ComicPanels.state() and a presented capture.
  6. Readability. Excludes world labels, gives the player and enemies roles, groups and masks characters and toon objects, keeps gameplay colours apart (spot hue, masks or exclusion), checks the UI, that black stays black and that nothing flashes faster than 3 Hz.
  7. Measure. The Lookbook's numbers against the stack from before when lookbookKit is installed, or presented frames before and after a pan; the GPU passes from zero profiler gpu (rows labelled post.sk.) and the whole frame from zero profiler cost; the low quality tier.
  8. Report. Answers with the look, the stack before and after, the tuning, the panels, every exclusion, group, mask and role, the checks, the numbers, the problems left, and the calls that undo it all: StyleKit.load(before.entries, { ... }) for the old stack, StyleKit.clear(), ComicPanels.off(), clearing exclusions and groups, and StyleKit.clearChannel(id) for each role.

It is non-destructive: the comic packages edit no material and this run changes none. The look comes off with StyleKit.clear() (or by deleting the StyleStack entity) and the panels with ComicPanels.off().

What it needs

comicBlocks installed (it brings styleKit, toneScreens, toonBlocks, paperBlocks and starterBlocks; inkBlocks is optional), and comicPanels when panels are asked for. The motion check uses lookbookKit when the world has it and falls back to presented frames in a pan when it does not.

Starting it

zero workflow start --name comicWorld --args '{"subject":"main","look":"golden age with heavy dots"}'
zero workflow start --name comicWorld --args '{"look":"comicNoir","keepLine":true}'
zero workflow start --name comicWorld --args '{"look":"sunday strip","panels":"several:threeTier"}'
  • subject: the world, a scene name or an installed kit (default: the loaded scene).
  • look: the comic look in the asker's words or a look id (default: the run proposes one).
  • keepLine: true keeps the Line entries already in the stack (default false).
  • panels: a ComicPanels layout id for one camera through the panels, or several:<layout> for per-player extra cameras (default: no panels).

Known limits

  • Extra panel views get the panel page's own print treatment, not the look's blocks: the stack runs only on the presented frame (styleKit Known limit #17427).
  • Installing packages with several dependencies can take a while (#21420).
  • The web build was not checked from here (#20946).