erx96/KOverlay

Description

Click‑through, always‑on‑top overlay panel for Wayland desktops built with Qt 6 + QML + LayerShellQt. Perfect for sticky notes, cheat sheets, keybindings, or any text you want visible above apps — without stealing focus. Supports live‑reloading from a config file. Toggle from a global shortcut, stays above everything, passes all mouse/keyboard through.

Installation Instructions

KOverlay (Wayland overlay panel)

Click-through, always-on-top overlay for KDE/Wayland (Qt 6 + QML + LayerShellQt). Great for sticky notes, cheat sheets, and keybindings. Live-reloads from a config file.

COPR note: This repository is not part of Fedora or Red Hat.

Enable repo & install

sudo dnf copr enable erx96/KOverlay
sudo dnf install koverlay

Run

QT_QPA_PLATFORM=wayland koverlay --show --screen-index 0

• --screen-index selects the monitor (0..N-1; 0 is typically primary).

Toggle via DBus (useful for global shortcuts)

qdbus org.erx.KOverlay /Overlay org.erx.KOverlay.Toggle
# also available: Show, Hide

Configuration (hot-reloading)

Config file: ~/.config/koverlay/config.ini (override with KOVERLAY_CONFIG). Supported keys under [overlay]:

• text (multiline supported), or textFile (path)
• fontFamily, fontSize
• textColor, bold
• panelOpacity (0.0–1.0, background only)

Example:

[overlay]
text="""
⌨ Keybindings:
• Super+Enter — Terminal
• Ctrl+Alt+H — Toggle Overlay
"""
fontFamily=Fira Code
fontSize=22
textColor=#FFCC00
bold=false
panelOpacity=0.30

Autostart (optional)

Create ~/.config/autostart/koverlay.desktop:

[Desktop Entry]
Type=Application
Name=KOverlay
Exec=koverlay --show
X-KDE-StartupNotify=false
OnlyShowIn=KDE;

Requirements

Wayland session (KDE/KWin recommended). Runtime deps are pulled automatically (layer-shell-qt, qt6-qtbase, qt6-qtdeclarative, qt6-qtwayland).

Active Releases

The following unofficial repositories are provided as-is by owner of this project. Contact the owner directly for bugs or issues (IE: not bugzilla).

Release	Architectures	Repo Download
Fedora 42	x86_64 (2)*	Fedora 42 (4 downloads)
Fedora 43	x86_64 (0)*	Fedora 43 (3 downloads)

* Total number of downloaded packages.