wallpaper-engine

Build Wallpaper Engine web wallpapers with one typed property schema, host-aware runtime APIs, and a simulator that runs in Vite.

Install Quick start

One schema from editor to runtime

Define a shared property record with wallpaper-engine/plugin. The Vite plugin turns it into Wallpaper Engine metadata while TypeScript derives the callback values consumed by your wallpaper.

shared property schema
└── Vite plugin
    ├── build → generated project.json
    └── serve → development simulator (default; `devtools: false` disables it)

Wallpaper Engine or development simulator
└── module-scope host listeners
    └── application + helpers

Typed host contractsModel properties, audio, media, plugins, hardware integrations, and ambient browser globals.

Vite build integrationGenerate project.json, validate previews, and link builds into Wallpaper Engine projects.

Development simulatorDrive property, runtime, audio, and media callbacks without launching Wallpaper Engine.

Tree-shakeable helpersHandle Wallpaper Engine colors, files, audio, media, LED frames, and render pacing.

Start building

Install the package and choose the entry points your wallpaper needs.
Complete the typed quick start.
Browse the API reference for exact public signatures.
Study the consumer demo source.

Project links

Next steps

Start with installation, then follow the quick start to connect one property schema to Vite and your runtime listener.