Rename plugin id to felixzsh.key-visualizer

omarchy plugin validate rejects the omarchy.* namespace: it is reserved
for first-party plugins. Use the third-party <user>.<name> convention.
This commit is contained in:
felixzsh
2026-08-11 09:58:37 -05:00
parent 96446661b3
commit 64e44c299b
3 changed files with 21 additions and 6 deletions
+19 -4
View File
@@ -22,16 +22,31 @@ running.
## Install ## Install
Validate the folder first (optional but handy for plugin authors):
```bash ```bash
omarchy plugin add https://github.com/YOU/omarchy-keycaster omarchy plugin validate ./omarchy-keycaster
omarchy plugin enable omarchy.key-visualizer
``` ```
Then add it — a local path works as well as a git URL (`plugin add` clones
with git, and `git clone` accepts local paths):
```bash
omarchy plugin add /path/to/omarchy-keycaster --enable
# or once published:
# omarchy plugin add https://github.com/YOU/omarchy-keycaster --enable
```
`--enable` enables it right away; without it, enable later with
`omarchy plugin enable felixzsh.key-visualizer`. If you added from a local path,
`omarchy plugin update felixzsh.key-visualizer` pulls your local changes into the
installed copy.
Then load the capture script into Hyprland's Lua config. Add this line at the Then load the capture script into Hyprland's Lua config. Add this line at the
bottom of `~/.config/hypr/hyprland.lua`: bottom of `~/.config/hypr/hyprland.lua`:
```lua ```lua
dofile(os.getenv("HOME") .. "/.config/omarchy/plugins/omarchy.key-visualizer/key-visualizer.lua") dofile(os.getenv("HOME") .. "/.config/omarchy/plugins/felixzsh.key-visualizer/key-visualizer.lua")
``` ```
Reload Hyprland: Reload Hyprland:
@@ -61,7 +76,7 @@ The panel starts with the shell, so it works after the next login too.
## Customize ## Customize
Everything lives in the plugin directory Everything lives in the plugin directory
(`~/.config/omarchy/plugins/omarchy.key-visualizer/`); saved changes reload (`~/.config/omarchy/plugins/felixzsh.key-visualizer/`); saved changes reload
automatically. automatically.
| Want to change... | Edit | | Want to change... | Edit |
+1 -1
View File
@@ -7,7 +7,7 @@
-- --
-- Install: add one line to ~/.config/hypr/hyprland.lua (at the bottom): -- Install: add one line to ~/.config/hypr/hyprland.lua (at the bottom):
-- --
-- dofile(os.getenv("HOME") .. "/.config/omarchy/plugins/omarchy.key-visualizer/key-visualizer.lua") -- dofile(os.getenv("HOME") .. "/.config/omarchy/plugins/felixzsh.key-visualizer/key-visualizer.lua")
-- --
-- then reload Hyprland (`hyprctl reload`). Requires Hyprland with Lua -- then reload Hyprland (`hyprctl reload`). Requires Hyprland with Lua
-- config support (0.56+). -- config support (0.56+).
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"schemaVersion": 1, "schemaVersion": 1,
"id": "omarchy.key-visualizer", "id": "felixzsh.key-visualizer",
"name": "Key Visualizer", "name": "Key Visualizer",
"version": "1.0.0", "version": "1.0.0",
"description": "Shows the keys you press on screen. Great for keybinding tutorials, demos, and screencasts.", "description": "Shows the keys you press on screen. Great for keybinding tutorials, demos, and screencasts.",