wob — Wayland Overlay Bar

A lightweight overlay volume/backlight/progress/anything bar for wlroots based Wayland compositors (requires support for wlr_layer_shell_unstable_v1).

Release signatures

Releases are signed with 5C6DA024DDE27178073EA103F4B432D5D67990E3 and published on GitHub.

Installation

Compiling from source

Install dependencies:

• wayland
• inih
• wayland-protocols *
• meson *
• scdoc (optional: man page) *
• libseccomp (optional: Linux kernel syscall filtering) *
• cmocka (optional: tests) *

* compile-time dependency

Run these commands:

git clone [email protected]:francma/wob.git
cd wob
meson build
ninja -C build
sudo ninja -C build install

From packages

Usage

Launch wob in a terminal, enter a value (positive integer), press return.

wob

General case

You may manage a bar for audio volume, backlight intensity, or whatever, using a named pipe. Create a named pipe, e.g. /tmp/wobpipe, on your filesystem using.

mkfifo /tmp/wobpipe

Connect the named pipe to the standard input of a wob instance.

tail -f /tmp/wobpipe | wob

Set up your environment so that after updating audio volume, backlight intensity, or whatever, to a new value like 43, it writes that value into the pipe:

echo 43 > /tmp/wobpipe

Adapt this use-case to your workflow (scripts, callbacks, or keybindings handled by the window manager).

See wob.ini.5 for styling and positioning options.

Examples

See Contrib space.

Alternatives

• avizo - icons, volume and brightness
• SwayOSD - icons, volume, brightness and keyboard (caps lock, num lock)
• Notification daemon + custom script
• xob - X Overlay Bar - X11 only, inspiration for wob

License

ISC, see LICENSE.