Skip to main content

Module package

Module package 

Source
Expand description

Frozen scene packages (PLAN.md section 9c): how saved wallpapers are kept.

A package holds the output of the generator for one scene at one size, not its inputs: for each theme the scene supports, the scene graph (layout, character track, props, emitters, lighting), the palette, the glyph masks and the baked background; plus the activity definition, the character frames the scene can show and the props’ pixel art. Playback reads only the package, never the generator, the activity catalog or the built-in art, so a saved scene plays the same after any of them change.

scene/
├── package.json          format, recipe, size, art, per-theme scene data
├── background-dark.png   indexed, no animated elements
├── background-light.png
└── sprites.png           the character frames, stacked (RGBA)

What is code rather than data (particle motion, lighting bands, the state machine, palette layout) is the package player for format 1; a committed golden package (tests/golden/packages) pins its output.

Structs§

PackageArt
The art a package carries.
ScenePackage
A frozen scene: plays without the generator.

Enums§

PackageError

Constants§

PACKAGE_FORMAT
The package format this build writes. Older formats stay readable.