# ErikReider/SwayOSD

A GTK based on screen display for keyboard shortcuts like caps-lock and volume

Repository: https://github.com/ErikReider/SwayOSD
Canonical: https://ross.abutalabs.com/products/swayosd
Language: Rust
License: GPL-3.0
License Family: copyleft
Topics: on-screen-display, sway, swaywm, wayland
Last push: 2026-06-22T20:40:01+00:00

## Health v2 (maintenance only)
Score: 82/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 88, release rhythm 65, longevity 100
- inputs: {"age_days": 1426, "days_push": 72, "days_rel": 72, "gap_med": 125, "n_releases_24m": 6}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1296, forks 72 (observed 2026-08-28T04:04:16.740056+00:00)

## What it is
SwayOSD is a GTK-based on-screen display (OSD) overlay for Wayland compositors like Sway, showing visual feedback for actions such as volume changes, mute toggles, playback, brightness, and caps/num/scroll lock. It runs as a background server with a client for keybindings and an optional libinput backend that detects lock-key presses automatically.

## Use cases
- show an on-screen volume indicator when changing volume in Sway
- display a caps lock indicator overlay on Wayland
- visualize brightness changes on screen
- show mute state feedback for microphone and speakers
- add an OSD to a minimal Wayland window manager setup

## When to choose
- you use Sway or another Wayland compositor and want OSD feedback for media and lock keys
- you want automatic caps/num/scroll lock detection without manual keybindings
- you need a lightweight, customizable OSD with configurable max volume

## When to avoid
- you are on X11 rather than Wayland
- you already use a desktop environment with a built-in OSD
- you need OSD features beyond volume, brightness, playback, and lock keys

## Facets
- artifact type: application
- maturity: active
- function: gui, developer-tools
- domain: desktop-applications, operating-systems, developer-tools
- platform: rust
- tags: on-screen-display, wayland, swaywm, gtk, volume-indicator, capslock-indicator, brightness-indicator, libinput, linux, desktop

## Member repositories
- ErikReider/SwayOSD (main) score 82

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:16.740056+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:53:55.629046+00:00, confidence not recorded.
  - readme: https://github.com/ErikReider/SwayOSD (fetched 2026-08-28T04:04:16.740056+00:00, sha f609ad67924e)
- Data as of 2026-08-30T08:39:29.467469+00:00.