docs: standardize and validate plugin READMEs

2026-07-15 21:56:42 -04:00
parent 1148c2d698
commit c057379c91
17 changed files with 700 additions and 70 deletions
@@ -1,16 +1,48 @@
-iio-lock — Orientation Lock for 2‑in‑1 Devices
+# iio-lock

-iio-lock is a small bar widget and panel plugin for Noctalia that provides manual control over screen orientation.
-It works by stopping and restarting the iio-hyprland service (or similar IIO rotation tools), preventing automatic rotation while the lock is active.
+iio-lock provides orientation controls for 2-in-1 devices, allowing automatic
+screen rotation to be locked and manual output transforms to be selected.

-This is useful on 2‑in‑1 touch laptops, where automatic rotation may not always be desired — such as when using the device in tablet mode, drawing, or note‑taking.
+## Plugin

-Supported WM and Tools
-Hyprland / iio‑hyprland — Working and tested
-Sway / iio‑sway — Unverified (experimental)
+| Field | Value |
+| --- | --- |
+| ID | `nikolaj-zwergius/iio_lock` |
+| Entries | Bar widgets: `iio-lock`, `lock-panel`; panel: `panel`; shortcut: `toggle`; service: `iio-service` |

-External commands
-This plugin shells out to:
-    -pgrep
-    -pkill
-    -iio-hyprland (or the user‑configured tool)
+## Requirements
+
+The plugin supports Hyprland with `iio-hyprland` and `hyprctl`. Sway support
+uses `iio-sway` and `swaymsg` and is currently experimental. The helper
+commands `pgrep` and `pkill` must also be available on `PATH`.
+
+## Usage
+
+Add the `iio-lock` widget to toggle the orientation lock with a left click and
+open the transform panel with a right click. The `lock-panel` widget opens the
+transform panel with a left click. You can also add the `toggle` shortcut under
+Settings → Control Center shortcuts.
+
+Open the transform panel directly with:
+
+```sh
+noctalia msg panel-toggle nikolaj-zwergius/iio_lock:panel
+```
+
+Locking stops the configured IIO rotation helper; unlocking starts it again.
+The panel applies the selected transform to the chosen output.
+
+## Settings
+
+| Setting | Type | Default | Description |
+| --- | --- | --- | --- |
+| `iio` | `select` | `iio-hyprland` | Automatic rotation helper to start and stop. |
+| `transform-order` | `string` | `0,1,2,3` | Transform values shown by the panel, in order. |
+| `vm` | `select` | `hyprland` | Selects the Hyprland or Sway command backend. |
+| `locked` | `glyph` | `lock` | Glyph used while orientation is locked. |
+| `unlocked` | `glyph` | `lock-open-2` | Glyph used while orientation is unlocked. |
+
+## Notes
+
+Hyprland is the tested backend. Verify the configured rotation helper works on
+its own before using the plugin, especially on Sway and similar compositors.