Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

FAQ

Does Wayscriber work on X11

No. Wayscriber is Wayland only.

Do I have to run the daemon

No. Use wayscriber --active for one shot mode.

Where is the config file

Authored defaults live in ~/.config/wayscriber/config.toml. Direct overlay preferences such as toolbar pins, minimized state, individual item visibility/order, and board pins are generated separately at $XDG_DATA_HOME/wayscriber/runtime-ui.toml (normally ~/.local/share/wayscriber/runtime-ui.toml). Inspect or reset that application state from overlay Settings instead of editing it by hand.

Does it work on GNOME and KDE

KDE Plasma/KWin is a known-good layer-shell target. GNOME works through Wayscriber’s xdg-shell/portal fallback, so normal overlay toggling works but light passthrough is disabled and fullscreen/input behavior can vary.

Does Wayscriber phone home

Only to answer “is there a newer release?”, and only if you leave that on. By default, once a day the daemon requests one static file, https://wayscriber.com/latest.json, and compares the version in it to the running build. The request carries no Wayscriber or user identifier, no Wayscriber version, and no query parameters; the HTTP client’s version is suppressed too. Nothing is ever downloaded or installed. Turn it off with [updates] check = false, WAYSCRIBER_DISABLE_UPDATE_CHECK=1, or a build with the check compiled out — see Updating. No other feature contacts the network.