Breadway/breadpaper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Wallpaper manager for the bread desktop
33 commits 1 branch 15 tags 202 KiB
Find a file
Breadway 8d8be6ebb1 Add per-output wallpaper set, persist, and theme 
Two monitors can keep different wallpapers. `set --output` targets one
awww output, writes that output's bread-theme files, and updates
~/.config/breadpaper/current.json without clobbering the other. Global
set still runs wal + bread-theme reload and stamps every known output.
`apply` and listen-on-monitor-connect restore the saved map. The library
picker binds to its monitor and applies to that output.
2026-08-16 13:06:17 +08:00
.forgejo/workflows CI: run stable release on hestia and refuse unsigned bakery index 2026-08-16 00:50:22 +08:00
.github/workflows fix: move release workflow to Forgejo, add LICENSE 2026-06-17 14:45:56 +08:00
ci ci: build inside bread-ecosystem's shared Arch container 2026-08-05 19:14:49 +08:00
packaging Add GTK wallpaper library 2026-08-16 00:26:50 +08:00
src Add per-output wallpaper set, persist, and theme 2026-08-16 13:06:17 +08:00
.gitignore Track AGENTS.md 2026-08-15 22:03:30 +08:00
AGENTS.md Track AGENTS.md 2026-08-15 22:03:30 +08:00
bakery.toml Add GTK wallpaper library 2026-08-16 00:26:50 +08:00
Cargo.lock Add per-output wallpaper set, persist, and theme 2026-08-16 13:06:17 +08:00
Cargo.toml Add per-output wallpaper set, persist, and theme 2026-08-16 13:06:17 +08:00
config.example.toml Add GTK wallpaper library 2026-08-16 00:26:50 +08:00
CONTRIBUTING.md CONTRIBUTING.md: document single-trunk + RC-tag release model 2026-07-31 11:08:41 +08:00
EVENTS.md Add per-output wallpaper set, persist, and theme 2026-08-16 13:06:17 +08:00
LICENSE fix: move release workflow to Forgejo, add LICENSE 2026-06-17 14:45:56 +08:00
README.md Add per-output wallpaper set, persist, and theme 2026-08-16 13:06:17 +08:00

README.md

breadpaper

Wallpaper setter for the bread desktop. One command sets the wallpaper via awww, generates a palette with pywal (wal), and runs bread-theme reload. Two monitors can keep different wallpapers (and per-output bread-theme files); the last path per output is stored in ~/.config/breadpaper/current.json.

set / get / apply stay one-shot CLI. breadpaper library (alias browse) opens a GTK picker over the wallpaper directories. It is not a slideshow daemon.

Dependencies

Must be on $PATH for set:

  • awww — Wayland wallpaper (awww img)
  • wal — palette generation (python-pywal)
  • bread-theme — theme reload (bakery package, not breadd)

library also needs GTK4 (the window loads bread-theme's shared stylesheet and follows the monitor it sits on). get without --output still reads the path pywal stored at ~/.cache/wal/wal. get --output NAME reads ~/.config/breadpaper/current.json.

Install

bakery install breadpaper

From source:

cargo build --release
install -Dm755 target/release/breadpaper ~/.local/bin/breadpaper

Usage

breadpaper <path>                 # shorthand for `set` (all outputs)
breadpaper <path> --output NAME   # one output
breadpaper set <path>             # awww + wal + bread-theme reload (all)
breadpaper set <path> --output NAME
breadpaper get                    # print ~/.cache/wal/wal
breadpaper get --output NAME      # path from current.json
breadpaper apply                  # restore current.json
breadpaper library                # GTK picker (alias: browse)
breadpaper library --dir PATH     # also scan PATH (repeatable)
breadpaper listen                 # honor bread.command.paper.set / .library

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

Library

breadpaper library scans these directories (missing ones are skipped):

  1. ~/Pictures/Wallpapers
  2. /usr/share/backgrounds/bos

Override the list in ~/.config/breadpaper/config.toml:

library_dirs = [
    "~/Pictures/Wallpapers",
    "/usr/share/backgrounds/bos",
]

BREADPAPER_LIBRARY_DIRS (colon-separated) overrides the file. --dir appends extra roots for that invocation. Clicking a thumbnail applies to the monitor the picker is on (set --output); if the output cannot be resolved it falls back to all outputs.

Bread events

After a successful set, breadpaper emits bread.paper.changed if breadd is running (silent no-op if it isn't). breadpaper listen is the optional long-running subscriber for bread.command.paper.set and bread.command.paper.library; it does not start by itself. Lua modules can still bread.exec("breadpaper set …") or bread.exec("breadpaper library"). See EVENTS.md.

License

MIT — see LICENSE.