Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/francma/wob
A lightweight overlay volume/backlight/progress/anything bar for Wayland.
https://github.com/francma/wob
sway swaywm wayland
Last synced: 12 days ago
JSON representation
A lightweight overlay volume/backlight/progress/anything bar for Wayland.
- Host: GitHub
- URL: https://github.com/francma/wob
- Owner: francma
- License: isc
- Created: 2019-07-13T22:26:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T09:26:39.000Z (4 months ago)
- Last Synced: 2024-08-01T03:19:26.482Z (3 months ago)
- Topics: sway, swaywm, wayland
- Language: C
- Homepage:
- Size: 245 KB
- Stars: 877
- Watchers: 6
- Forks: 49
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - Wob
README
# wob — Wayland Overlay Bar
[](https://github.com/francma/wob/actions)
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](https://keys.openpgp.org/vks/v1/by-fingerprint/5C6DA024DDE27178073EA103F4B432D5D67990E3) and published on [GitHub](https://github.com/francma/wob/releases).
## Installation
### Compiling from source
Install dependencies:
- wayland
- [inih](https://github.com/benhoyt/inih)
- wayland-protocols \*
- meson \*
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man page) \*
- [libseccomp](https://github.com/seccomp/libseccomp) (optional: Linux kernel syscall filtering) \*
- [cmocka](https://cmocka.org/) (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
[](https://repology.org/project/wob/versions)
## 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](https://github.com/francma/wob/blob/master/wob.ini.5.scd) for styling and positioning options.
## Examples
See [Contrib space](contrib/README.md).
## Alternatives
- [avizo](https://github.com/misterdanb/avizo) - icons, volume and brightness
- [SwayOSD](https://github.com/ErikReider/SwayOSD) - icons, volume, brightness and keyboard (caps lock, num lock)
- Notification daemon + [custom script](https://github.com/luispabon/sway-dotfiles/blob/master/scripts/notifications/audio-notification.sh)
- [xob - X Overlay Bar](https://github.com/florentc/xob) - X11 only, inspiration for wob
## License
ISC, see [LICENSE](/LICENSE).