Create an Image Wallpaper

A kind: image wallpaper is a static image displayed fullscreen on the desktop. Just fluxlay.yaml and the image file — no build, no JS.

Set up the directory

mkdir my-photo-wallpaper && cd my-photo-wallpaper

Put your image file in the project directory.

    • photo.png
    • fluxlay.yaml

Supported formats: .png, .jpg, .jpeg, .webp, .gif.

Create the manifest

fluxlay.yaml
schemaVersion: 1
name: My Photo Wallpaper
slug: my-photo-wallpaper
version: 0.1.0
kind: image
source: ./photo.png
description: A static image wallpaper.

source is required.

Build

pnpm fluxlay build

This produces a .fluxlay package. No HTML is bundled — the Fluxlay desktop app generates fullscreen image-display HTML at delivery time.

Notes

  • Images are scaled to fit the desktop resolution. Provide a high enough source resolution (e.g. 3840×2160 or higher for 4K).
  • Custom properties and shell commands are not available.
  • For long-lived animated GIFs, watch out for file size.

See the Manifest Reference for details.