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

Configurator (GUI)

Wayscriber has a native configurator for editing settings without touching the config file by hand. It writes authored defaults to config.toml; direct overlay preferences are layered separately as runtime UI state.

Launch

  • Press F11 inside the overlay
  • Or run wayscriber-configurator

If the configurator is not installed, install wayscriber-configurator or point to it with WAYSCRIBER_CONFIGURATOR.

Search and navigation

The search field is meant for direct keyboard use:

  • Start typing after launch to filter settings.
  • Press Ctrl+F to focus search again.
  • Press Escape in search to clear it and keep typing.
  • Search matches tabs, sections, saved sessions, boards, render profiles, presets, and keybinding names.
  • Scoped searches work, for example ui toolbar blur, session lecture, keybinding capture, or preset red.

When a result belongs to a nested settings page, selecting it opens the matching tab or subtab.

What you can change

  • Drawing defaults: color, thickness, marker opacity, fill, font family/weight/style, text background, drag tool bindings
  • Arrow settings: length, angle, head placement
  • Performance: buffer count and vsync
  • UI: dark/light theme, reduced motion, interactive status HUD, help overlay styling, click highlight settings (including highlight ring), frozen badge, and context menu
  • UI toolbar: pill/legacy-panel side layout, layout complexity, top-strip display, section visibility (boards, pages, presets, actions, zoom, step controls), ink-preview cursor, marker opacity slider, preset toasts, per-item visibility, and saved toolbar order
  • History: undo/redo delay playback and Step control defaults
  • Board modes (legacy): enable, default mode, board colors, auto adjust pen color
  • Capture: enable, save directory, filename template, format, clipboard behavior, exit after capture
  • Session: per mode persistence, restore tool state, per output, storage mode, size limits, compression, backups, and named-session catalog management
  • Presets: edit slot definitions and defaults
  • Keybindings: edit all shortcuts by category

Note: full multi-board setup lives under [boards] in config.toml and currently needs manual editing (or the in-app board picker with boards.persist_customizations = true).

Toolbar editing

The UI tab controls broad toolbar behavior such as the default contextual-pill versus legacy-panel layout, Simple/Regular/Advanced complexity, pinned startup state, full/micro top-strip display, icon-only mode, section toggles, context-aware UI, ink-preview cursor, offsets, and force-inline mode.

Under pill mode, the Boards, Pages, Advanced, Zoom, Step, and delay visibility toggles control sections in the top-strip Canvas… popover. The Zoom toggle also controls the persistent bottom-right zoom chip.

The UI -> Toolbar Visibility subtab controls individual toolbar items. Checked means shown. Uncheck an item to remove it from toolbar sizing, drawing, and hit testing. Explicit visibility choices survive changes between the Simple, Regular, and Advanced layout presets.

Order controls are available for:

  • Top tools
  • Top controls
  • Side sections

Use the up/down controls to move an item within its group, or reset a group back to the built-in order. Configurator changes are written as authored defaults to ui.toolbar.items.order in config.toml.

Overlay toolbar customization

The overlay also has toolbar customization. In the default pill layout:

  • Open the top strip’s overflow menu, choose Settings…, then use Customize.
  • Pick a group such as Top tools, Top controls, Side sections, Actions, Pages, Boards, Presets, Tool options, or Sessions.
  • Toggle items to show/hide them.
  • Move supported Top tools, Top controls, and Side sections up/down or drag rows to reorder them.
  • Reset hidden items or reset an order group when you want the defaults back.

Under legacy side_layout = "panel", the same editor remains in the Settings pane. That panel also has a Sections tab and collapsible side-section headers.

Overlay changes to individual item visibility/order, toolbar pins, minimized and pane state, collapsed side sections, and board pins are stored in generated $XDG_DATA_HOME/wayscriber/runtime-ui.toml state. Authored section-visibility toggles still update config.toml. Overlay Settings shows whether runtime persistence is available and provides reset, retry, disk-adoption, and invalid-file recovery actions. See Config File Overview.

The screenshot toolbar button is hidden by default. Enable top.utility.screenshot from Toolbar Visibility or remove it from ui.toolbar.items.hidden in TOML to show it. See Toolbars for the runtime layout and frontend behavior.

Session catalog

The Session tab manages both default persistence settings and the named-session catalog. Named sessions are recorded when they are opened or saved from the CLI, daemon, or overlay Session popover. See Sessions and Session Manager for the full workflow.

Catalog actions:

  • Save Name changes only the display label.
  • Reveal File opens the session file location.
  • Forget removes catalog metadata without deleting the files.
  • Duplicate copies an inactive session to a new named target.
  • Move relocates an inactive session file and its non-lock sidecars.
  • Clear Saved Data removes saved data for that catalog entry.

Duplicate, Move, and Clear are disabled while an overlay, manually started daemon, or background service is active. Stop the overlay or service before doing offline file maintenance from the configurator.

Workflow

  • Reload: re-read the config from disk
  • Defaults: load built-in defaults without saving
  • Save: validate inputs and write the config with a backup