Skip to content

wallpaper

Wallpaper rendering, cycling, and per-monitor overrides.

General

FieldTypeDefaultDescription
engine-enabledbooltrueEnable the awww wallpaper engine. Disable to use an external wallpaper tool while keeping color extraction and theming.

Transitions

FieldTypeDefaultDescription
transition-typeTransitionType"simple"Transition animation type.
transition-durationTransitionDuration0.7Transition animation duration in seconds.
transition-fpsTransitionFps60Transition animation frame rate.

Cycling

FieldTypeDefaultDescription
cycling-enabledboolfalseEnable automatic wallpaper cycling.
cycling-directorystring""Directory containing wallpaper images for cycling.
cycling-modeCyclingMode"sequential"Wallpaper cycling order.
cycling-interval-minsCyclingInterval15Time between wallpaper changes in minutes.
cycling-same-imageboolfalseShow the same cycling wallpaper on all monitors. Only affects shuffle mode since sequential already displays the same image.

Per-monitor overrides

FieldTypeDefaultDescription
monitorsarray of MonitorWallpaperConfig[]Per-monitor wallpaper and fit mode settings. Each entry targets a monitor by connector name. See [MonitorWallpaperConfig] for the available fields.
More about monitors

Example

toml
[[wallpaper.monitors]]
name = "DP-1"
wallpaper = "/home/me/pictures/wall-primary.png"
fit-mode = "fill"

[[wallpaper.monitors]]
name = "HDMI-1"
wallpaper = "/home/me/pictures/wall-secondary.png"
fit-mode = "fit"

Default configuration

toml
[wallpaper]
engine-enabled = true
transition-type = "simple"
transition-duration = 0.699999988079071
transition-fps = 60
cycling-enabled = false
cycling-directory = ""
cycling-mode = "sequential"
cycling-interval-mins = 15
cycling-same-image = false
monitors = []

Released under the MIT License.