Skip to content

Add Keyviz Plugin - #448

Closed
h-jangra wants to merge 3 commits into
noctalia-dev:mainfrom
h-jangra:main
Closed

Add Keyviz Plugin#448
h-jangra wants to merge 3 commits into
noctalia-dev:mainfrom
h-jangra:main

Conversation

@h-jangra

Copy link
Copy Markdown

Plugin

  • Id: h-jangra/keyviz
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

Displays typed keys and modifier combinations as translucent keycaps on an overlay HUD. Includes a background event listener service, bar widget, shortcut toggle, and IPC commands.

External dependencies

  • python3: Runs the background input listener script (scripts/listener.py), which reads Linux input events from /dev/input/event*. Requires read access to these devices, typically through the input group.

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against: v5.0.0
  • Plugin API level: 13

Screenshots / Videos

image

Checklist

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the [README template](https://github.com/noctalia-dev/community-plugins/blob/main/README_TEMPLATE.md), documents every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the [thumbnail generator](https://assets.noctalia.dev/plugins/thumbnail-generator.html).
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request was automatically closed because its description no longer contains
every part of the pull request template
that this repository requires.

Missing:

  • the - **Id:** field
  • the - **Noctalia version tested against:** field
  • the - **Plugin API level:** field
  • the checklist entry: New plugin
  • the checklist entry: Update to an existing plugin (version bumped in plugin.toml)
  • the checklist entry: Tested on Niri
  • the checklist entry: Tested on Hyprland
  • the checklist entry: Tested on Sway
  • the checklist entry: Tested on another compositor:
  • the checklist entry: The directory name matches the part of id after the / in plugin.toml exactly.
  • the checklist entry: It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • the checklist entry: README.md follows the README template, documents every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • the checklist entry: I created thumbnail.webp with the thumbnail generator.
  • the checklist entry: version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • the checklist entry: Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • the checklist entry: I did not edit catalog.toml; CI generates it.
  • the checklist entry: This PR touches exactly one plugin directory.
  • the checklist entry: The code is readable and not obfuscated, minified, or generated.
  • the checklist entry: It does not download and execute remote code.
  • the checklist entry: Every network call, filesystem write, and spawned process is something the description above accounts for.
  • the checklist entry: I have the right to publish this code under the license declared in plugin.toml.
  • exactly one checked plugin type: New plugin or Update to an existing plugin
  • at least one checked compositor testing entry

Please add the items listed above back to the description, keeping their exact wording, then
reopen the pull request. Reopening re-runs this check. Draft pull requests may leave boxes
unchecked. Before a pull request is ready for review, exactly one plugin type, at least one
tested compositor, and every item under Checklist and Code review attestation must be checked.

@github-actions github-actions Bot closed this Aug 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant