diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f43ecd8 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# wallpaper-switcher + +An Openbox (or labwc) pipe menu that lists the `.png` and `.webp` files in +`~/.wallpapers` and sets the one you pick with `swaybg`. + +## Build + +Needs SBCL. The only dependency is UIOP, which ships with ASDF, so Quicklisp +is not required. + + make # builds ./wallpaper-switcher + make test + make install # copies it to ~/.local/bin (override with PREFIX=...) + +## Menu setup + +In `menu.xml`: + +```xml +<menu id="wallpapers" label="Wallpapers" execute="wallpaper-switcher" /> +``` + +Then reference `wallpapers` from your root menu and reconfigure Openbox. + +## Configuration + +Optional. Put it in `$XDG_CONFIG_HOME/wallpaper-switcher/config` (usually +`~/.config/wallpaper-switcher/config`): + +``` +# Where to look (~ and $HOME are expanded). Subdirectories are not searched. +directory = ~/.wallpapers + +# Shell command run when an item is picked. %f is the file (already quoted +# for the shell), %% is a literal %. +command = pkill -x swaybg; swaybg -m fill -i %f & + +# File extensions to include, matched without regard to case. +extensions = png webp +``` + +Command-line options override the file: + + wallpaper-switcher --directory ~/Pictures/walls --command 'swaybg -m fit -i %f &' + wallpaper-switcher --config /path/to/other/config |
