Skip to content

wallpaper ​

Wallpaper rendering, cycling, and per-monitor overrides.

General ​

FieldTypeDefaultDescription
wallpaperstring""A single image file to use as the wallpaper on all monitors. Leave empty to use cycling and/or per-monitor overrides instead; a monitor none of them gives an image shows the built-in wallpaper.
fit-modeFitMode"fill"How the wallpaper is scaled to the screen. Per-monitor entries in wallpaper.monitors override this.

Cycling ​

FieldTypeDefaultDescription
cycling-directorystring""Directory of images to cycle through. Set it to enable cycling; leave empty to disable. Takes precedence over the single wallpaper image.
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 ​

yaml
wallpaper:
  monitors:
    - name: DP-1
      wallpaper: /home/me/pictures/wall-primary.png
      fit-mode: fill
    - name: HDMI-1
      wallpaper: /home/me/pictures/wall-secondary.png
      fit-mode: fit

Default configuration ​

yaml
wallpaper:
  wallpaper: ""
  fit-mode: fill
  cycling-directory: ""
  cycling-mode: sequential
  cycling-interval-mins: 15
  cycling-same-image: false
  monitors: []

Released under the MIT License.