Skip to content

Commit 4614823

Browse files
committed
docs: clarify light passthrough controls
1 parent bd19e48 commit 4614823

4 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -507,9 +507,10 @@ Other desktops/window managers:
507507
- Bind `wayscriber --daemon-toggle` to any global shortcut key you prefer.
508508

509509
Light passthrough controls:
510-
- <kbd>Ctrl+Shift+L</kbd> is a Wayscriber in-overlay shortcut, not an OS/global shortcut. It works while the overlay is focused.
511-
- Once light passthrough is active, normal keyboard and pointer input goes to the app underneath. Bind compositor/global shortcuts to `wayscriber --light-toggle` and `wayscriber --light-draw-toggle` for reliable control.
510+
- <kbd>Ctrl+Shift+L</kbd> is a Wayscriber in-overlay shortcut, not an OS/global shortcut. It works while the overlay is focused, but once passthrough is active Wayscriber may no longer receive that keypress.
511+
- Once light passthrough is active, normal keyboard and pointer input goes to the app underneath. Bind compositor/global shortcuts to `wayscriber --light-toggle` and `wayscriber --light-draw-toggle` for reliable control, including getting back out of passthrough.
512512
- Use `wayscriber --light-draw-on` on press and `wayscriber --light-draw-off` on release for draw-while-held shortcuts.
513+
- Hyprland and KDE examples are in [docs/SETUP.md](docs/SETUP.md#light-passthrough-controls-on-hyprland); the KDE section follows the Hyprland binding example.
513514
- Stock GNOME Wayland does not support this regular-app passthrough mode. Freeze may still work for still-image capture, but it is not a live passthrough replacement. A GNOME Shell extension approach would be needed for true shell-level passthrough.
514515

515516
Use `--no-tray` or `WAYSCRIBER_NO_TRAY=1` if you don't have a system tray; otherwise right-click the tray icon for options:
@@ -736,7 +737,7 @@ The polygon tools are available from the toolbar picker; their default keybindin
736737

737738
</details>
738739

739-
For light passthrough, <kbd>Ctrl+Shift+L</kbd> is the default Wayscriber-level binding only while the overlay has focus. Use compositor/global shortcuts that run `wayscriber --light-toggle` and related light-draw commands once passthrough is active. On stock GNOME Wayland, regular app windows cannot provide the required click-through shell overlay. Freeze may still work for still-image capture, but it is not a live passthrough replacement.
740+
For light passthrough, <kbd>Ctrl+Shift+L</kbd> is the default Wayscriber-level binding only while the overlay has focus. Do not rely on it as the way back out after passthrough starts; use compositor/global shortcuts that run `wayscriber --light-toggle` and related light-draw commands once passthrough is active. On stock GNOME Wayland, regular app windows cannot provide the required click-through shell overlay. Freeze may still work for still-image capture, but it is not a live passthrough replacement.
740741

741742
Arrow labels can auto-number when enabled in the arrow toolbar; reset with <kbd>Ctrl+Shift+R</kbd>. Step markers auto-increment and reset from the toolbar (or bind `reset_step_markers` in `config.toml`). Preset slots can be saved/cleared from the toolbar; edit names and advanced fields in `config.toml`. Blur has no default keyboard shortcut; bind `select_blur_tool` in `config.toml` if you want direct keyboard access.
742743

config.example.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ toggle_presenter_mode = ["Ctrl+Shift+M"]
162162

163163
# Toggle light passthrough mode while the overlay has focus.
164164
# Once passthrough is active, use compositor/global shortcuts that call
165-
# `wayscriber --light-toggle` for reliable control.
165+
# `wayscriber --light-toggle` for reliable control, including exit.
166166
toggle_light_mode = ["Ctrl+Shift+L"]
167167

168168
# Optional in-overlay toggle between light drawing and passthrough.
@@ -581,6 +581,7 @@ show_toast = true
581581
# Light passthrough mode requires layer-shell support:
582582
# - toggle_light_mode enters a minimal click-through overlay while Wayscriber has focus.
583583
# - wayscriber --light-toggle is the reliable compositor/global toggle once passthrough is active.
584+
# Do not rely on the in-overlay Ctrl+Shift+L binding to exit after input is passed through.
584585
# - wayscriber --light-draw-toggle switches between drawing and passthrough.
585586
# - wayscriber --light-draw-on / --light-draw-off support press/release shortcuts.
586587

docs/CONFIG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ show_toast = true
429429

430430
### Light Passthrough Mode
431431

432-
Light mode hides UI chrome and sets the overlay to click-through passthrough until drawing is explicitly enabled. `toggle_light_mode` defaults to <kbd>Ctrl+Shift+L</kbd>, but that is a Wayscriber in-overlay shortcut: it works while the overlay still has focus. Once passthrough is active, normal keyboard and pointer input goes to the app underneath, so compositor/global shortcuts should call the daemon commands below for reliable control.
432+
Light mode hides UI chrome and sets the overlay to click-through passthrough until drawing is explicitly enabled. `toggle_light_mode` defaults to <kbd>Ctrl+Shift+L</kbd>, but that is a Wayscriber in-overlay shortcut: it works while the overlay still has focus. Once passthrough is active, normal keyboard and pointer input goes to the app underneath, so do not rely on <kbd>Ctrl+Shift+L</kbd> as the way back out. Compositor/global shortcuts should call the daemon commands below for reliable control.
433433

434434
This mode requires compositor overlay support through layer-shell. It is disabled on the xdg fallback because regular app windows cannot reliably stay visible as click-through shell overlays while keyboard and pointer input go to apps underneath. On stock GNOME Wayland, Freeze may still work for still-image capture when portal capture is available, but it is not a live passthrough replacement. True passthrough would require a GNOME Shell extension companion.
435435

docs/SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Now press <kbd>Super+D</kbd> to toggle the overlay on/off!
9494
### Light passthrough controls on Hyprland
9595

9696
Light passthrough needs compositor/global shortcuts because Wayscriber deliberately passes keyboard and pointer input to the app below while passthrough is active.
97-
The default <kbd>Ctrl+Shift+L</kbd> binding is a Wayscriber in-overlay shortcut, not an OS-level shortcut; use the bindings below for reliable control after passthrough starts.
97+
The default <kbd>Ctrl+Shift+L</kbd> binding is a Wayscriber in-overlay shortcut, not an OS-level shortcut; do not rely on it to exit after passthrough starts. Use the bindings below for reliable control.
9898

9999
The configurator can install a native Hyprland include file for this. Manual equivalent for Arch + Hyprland:
100100

0 commit comments

Comments
 (0)