SwayOSD

SwayOSD

A OSD window for common actions like volume, playback and capslock.

This is my first time coding in Rust so fixes and improvements are appreciated :)

Features:

• LibInput listener Backend for these keys:
  • Caps Lock
  • Num Lock
  • Scroll Lock
  • Audio playback
• Input and output volume change indicator
• Input and output mute change indicator
• Audio playback indicator
• Customizable maximum Volume
• Capslock change (Note: doesn't change the caps lock state)
• Brightness change indicator

Images

Install:

There's a new LibInput watcher binary shipped with SwayOSD (swayosd-libinput-backend) which can automatically detect key presses, so no need for binding key combos. The supported keys are listed above in Features

Through Meson

# Please note that the command below might require `--prefix /usr` on some systems
meson setup build --buildtype release
meson compile -C build
meson install -C build

Fedora

The package is available on COPR:

dnf copr enable erikreider/swayosd
dnf install swayosd

Fedora Silverblue (and other rpm-ostree variants)

The package can be layered over the base image after adding the Copr repo as an ostree repo:

sudo curl -sL -o /etc/yum.repos.d/_copr:copr.fedorainfracloud.org:erikreider:swayosd.repo https://copr.fedorainfracloud.org/coprs/erikreider/swayosd/repo/fedora-$(rpm -E %fedora)/erikreider-swayosd-fedora-$(rpm -E %fedora).repo
rpm-ostree install swayosd

Arch Linux

• extra: swayosd
• AUR: swayosd-git (thanks to @jgmdev! Don't report AUR packaging issues here)

Debian / Ubuntu

Starting with Debian trixie and Ubuntu Plucky swayosd is available via apt.

• swayosd

Usage:

SwayOSD Frontend

swayosd-server must be running in the background. Use swayosd-client to send commands and display the OSD.

SwayOSD LibInput Backend (Optional)

Used for notifying when caps-lock, scroll-lock, and num-lock is changed.

Using Systemd: sudo systemctl enable --now swayosd-libinput-backend.service

Other users can run: pkexec swayosd-libinput-backend

Sway examples

Start Server

# OSD server
exec swayosd-server

Add Client bindings

…

Notes on using --device:

• It is for audio and BrightnessCtl devices only.
• If it is omitted, the default audio / first BrightnessCtl device is used.
• It only changes the target device for the current action that changes the volume / brightness.
• You can list your input audio devices using pactl list short sources, for outputs replace sources with sinks.
• You can list your brightness devices using brightnessctl -l, for backlights, use brightnessctl -l -c backlight.

Notes on using --player:

• It is for playerctl only.
• If it is omitted, the default playerctld device is used.
• Use playerctl -l for available players.
• Special operators are "all", "shift" and "unshift". The last two call playerctld [un]shift; use to cycle players.

Notes on using --monitor:

• By default, without using --monitor the osd will be shown on all monitors
• On setups with multiple monitors, if you only want to show the osd on the focused monitor, you can do so with the help of window manager specific commands:

# Sway
swayosd-client --monitor "$(swaymsg -t get_outputs | jq -r '.[] | select(.focused == true).name')" --output-volume raise

# Hyprland
swayosd-client --monitor "$(hyprctl monitors -j | jq -r '.[] | select(.focused == true).name')" --output-volume raise

Theming

Since SwayOSD uses GTK, its appearance can be changed. Initially scss is used, which GTK does not support, so we need to use plain css. The style conifg file is in ~/.config/swayosd/style.css (it is not automatically generated). For reference you can check this and this.

Brightness Control

Some devices may not have permission to write /sys/class/backlight/*/brightness. So using the provided packaged udev rules + adding the user to video group by running sudo usermod -a -G video $USER, everything should work as expected.

Development

Setup and build

meson setup build
meson compile -C build

Set the environment

# Sets the correct environment variables
meson devenv -C build -w .
# Now you can start nvim, vscode, etc in the current shell