@augmentd-labs/canvas-wallpapers

Wallpapers shipped out of the box with the Canvas UIs, plus the manifest that describes them. Kept as its own package so canvas-web, canvas-desktop and any later surface share one copy of the artwork, and so the artwork can carry its own licensing terms separate from the AGPL code around it — see NOTICE.

Contents

files/      full-size renditions (svg / avif / webp / jpg)
thumbs/     480px picker thumbnails (webp)
src/        the manifest and small URL helpers — no runtime dependencies
scripts/    wallpaper.js (add/remove), derive.sh (regenerate renditions),
            copy.js (install into an app)

Using it from an app

Add the dependency and copy the assets into the app's static directory before dev/build:

// apps/<app>/package.json
"dependencies": { "@augmentd-labs/canvas-wallpapers": "workspace:*" },
"scripts": {
  "predev":   "canvas-wallpapers-copy public/wallpapers",
  "prebuild": "canvas-wallpapers-copy public/wallpapers"
}

public/wallpapers/ is a copy, so it belongs in .gitignore.

Then read the catalogue from the manifest:

import { wallpapers, wallpaperUrl, wallpaperThumbUrl } from '@augmentd-labs/canvas-wallpapers'

wallpaperUrl('canvas_1')        // '/wallpapers/files/canvas_1.svg'
wallpaperThumbUrl('canvas_1')   // '/wallpapers/thumbs/canvas_1.webp'

wallpaperUrl returns the first (best) rendition by default. Pass { types: [...] } to narrow it to the formats the client can decode; the last source of every wallpaper is a universally supported format, so there is always a usable fallback.

Each entry also carries scheme (light / dark), background (the dominant colour, usable as an instant placeholder behind the image) and accent — the frost theme in particular expects to sit on a wallpaper rather than a flat desk colour.

Adding and removing wallpapers

node scripts/wallpaper.js add ~/Pictures/aurora.jpg
node scripts/wallpaper.js remove aurora

add prompts for everything an entry needs — id, title, which scheme it suits, its dominant and accent colours (the dominant one is detected from the image and offered as the default), and the attribution: author, source URL and licence. It then renders the renditions and writes the manifest entry, so files, thumbnails and manifest cannot drift apart. remove deletes an id's files and its entry.

Vector sources are kept as .svg; anything else is stored as a .jpg — those are the two source kinds derive.sh renders from. Both are the checked-in originals, and every other rendition is derived, so re-running derive.sh after changing the encoder settings regenerates the lot. It needs rsvg-convert and ImageMagick 7 with AVIF and WebP support.

Two things the script deliberately leaves to a human: prose licence terms go in NOTICE (the script reminds you when the author isn't us), and keeping the set small — these files ship in every build.