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)
└── journey-dark-0.png    a journey's moving layers (format 2), one per
                          theme and layer: glyph as grey, shade as alpha

What is code rather than data (particle motion, lighting bands, the state machine, palette layout) is the package player for formats 1 and 2; 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 newest package format this build writes and reads. Older formats stay readable. Format 2 adds a journey’s moving layers; a package without one is still written as format 1, so older versions can play it.