https://github.com/malisipi/linux-keyboard-osd-notifier

A basic OSD notification that notifies capslock and numlock states
https://github.com/malisipi/linux-keyboard-osd-notifier

caps-lock-indicator indicators kde kde-plasma kde-plasma-6 keyboard linux lock-keys lunaris numlock-indicator osd wayland x11

Last synced: 3 months ago
JSON representation

A basic OSD notification that notifies capslock and numlock states

• Host: GitHub
• URL: https://github.com/malisipi/linux-keyboard-osd-notifier
• Owner: malisipi
• License: mpl-2.0
• Created: 2024-12-17T20:59:18.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-21T14:06:09.000Z (5 months ago)
• Last Synced: 2024-12-30T07:19:36.072Z (5 months ago)
• Topics: caps-lock-indicator, indicators, kde, kde-plasma, kde-plasma-6, keyboard, linux, lock-keys, lunaris, numlock-indicator, osd, wayland, x11
• Language: C++
• Homepage:
• Size: 161 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Linux Keyboard OSD Notifier

> A basic OSD notification and tray indicator that notifies capslock and numlock states

![Showcase](./assets/showcase.png)

![Showcase Tray](./assets/showcase_tray.png)

## Features

- System consistent design (for KDE)

- Supports theming via system preferences

- Works with user-space permissions

- A tray indicator that shows active states of modifier keys

## Why?

Some keyboards have no light for indicating capslock and numlock states *(like mine)*. And there's no way to understand the active state until press the key. And most OEMs won't provide some mini-tools like that for Linux. So I made a OSD Notifier for Linux.

## Working Mechanism

The application is hooking modifier keys via X11 to handle state changes (since Wayland doesn't provide a way without requiring root permissions). And using a Wayland window to show OSD.

## FAQ

- I am using X11 and the application is not working.

    > The application is using Wayland APIs to show OSD window. So application is not supported on your platform.

- I am using Wayland however OSD doesn't shown.

    > Please ensure your system is supporting XWayland and ensure a composer setting is not blocking listening modifier key events to prevent data leaks.

    > If you are using KDE, you can change the behavior via `System Settings > Security & Privacy > Application Permission > Legacy X11 App Support`.

    >

    > ![Legacy X11 App Support](./assets/legacy_x11_app_support.png)

- The Wayland window is stealing focus/keeping on bottom when I press modifier key, how can I prevent that?

    > If you're using KDE, you can import [the window rule](./src/osd.kwinrule) to fix that. Since Wayland doesn't provide a way to set them, you should use a window rule or accept it as is.

## License

This project is licensed by [Mozilla Public License 2.0](./LICENSE)