Docs
esc
Crownpaper · GuidesIntroductionCrownpaper is the GPU wallpaper daemon for CrownOS and other Wayland desktops.
Crownpaper · GuidesQuickstartBuild Crownpaper, start the daemon and change your wallpaper from the command line.
Crownpaper · GuidesConfigurationChoose the startup wallpaper, tune transitions and control how much memory Crownpaper keeps.
Crownpaper · API ReferenceProtocol overviewTalk to the Crownpaper daemon over crownos-ipc with a typed Rust client.
Crownpaper · API ReferencesetTransition the desktop to a new wallpaper.
Crownpaper · API ReferencepreloadDecode wallpapers into the GPU cache so a later set is instant.
Crownpaper · API ReferencepingA round trip that proves the daemon is alive and has drained everything sent before it.
Crownpaper · API ReferenceChangedPushed to every subscriber with the wallpaper that is now on screen.
Download

Get started

Quickstart

Build Crownpaper, start the daemon and change your wallpaper from the command line.

This guide takes you from a fresh clone to a running daemon in a few minutes.

Requirements

DependencyWhy it is needed
A Wayland compositorwlr-layer-shell, wp_viewporter and linux-dmabuf
A Vulkan GPU driverRenders the transition
libturbojpegFast JPEG decoding, found through pkg-config
FFmpeg and VA-API driversOnly for video wallpapers

Install

  1. Clone the sibling crates

    Crownpaper builds against crownos-ipc and crownos-config, expected next to it.

    git clone https://github.com/Crown-OS/crownpaper.git
git clone https://github.com/Crown-OS/crownos-ipc.git
git clone https://github.com/Crown-OS/crownos-config.git

  2. Build and install both binaries

    cd crownpaper
cargo build --release
install -Dm755 target/release/crownpaper target/release/crownpaper-video -t ~/.local/bin

  3. Start the daemon

    crownpaper daemon --image ~/Pictures/wallpaper.jpg --duration 1.2

    Without --image the daemon reads wallpaper from ~/.config/crownos/appearance.ron.

Change the wallpaper

Set
crownpaper set ~/Pictures/dunes.webp -d 0.8