Interface: ProjectConfig

Defined in: project/config.ts:114

Top-level project definition passed to the runtime and player.

Properties

audioTracks?

optional audioTracks?: AudioTrack[]

Defined in: project/config.ts:132

Audio beds laid on the project timeline, independent of any scene — a music track or room tone that plays straight through the cuts. See AudioTrack.

backgrounds?

optional backgrounds?: GlobalLayerConfig[]

Defined in: project/config.ts:146

Nodes drawn under every scene. A scene paints its own fill on top of these, so a background is only visible where that fill is absent (the default) or translucent. Same include/exclude filtering as ProjectConfig.overlays.

fps

fps: number

Defined in: project/config.ts:122

Target frame rate. Defaults to 60 fps.

name

name: string

Defined in: project/config.ts:116

Human-readable project name shown in the player UI.

overlays?

optional overlays?: GlobalLayerConfig[]

Defined in: project/config.ts:139

Nodes drawn over every scene (after the scene's own children and overlay fill), outside its camera transform — watermarks, letterboxing, a grain pass. Narrow them to specific scenes with GlobalLayer's include/exclude.

scenes

scenes: Scene[]

Defined in: project/config.ts:118

Ordered list of scenes that make up the project.

theme?

optional theme?: Theme

Defined in: project/config.ts:124

Visual design tokens (colors, typography) available to all scenes.

variables?

optional variables?: Variables

Defined in: project/config.ts:126

Arbitrary project constants read in scene generators via stage.variables(...).

viewport

viewport: Size2D

Defined in: project/config.ts:120

Output canvas dimensions in pixels. Defaults to 1920×1080.