Skip to content

Commit ee692ca

Browse files
committed
update readme - add presets info
1 parent 1b253aa commit ee692ca

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,10 @@ Full-screen saves, active-window grabs, and region capture to file or clipboard
8888
Opt-in per board/monitor storage that restores your canvas plus pen color & thickness. One-off overrides via `--resume-session` / `--no-resume-session`; the tray checkmark flips the config on disk.
8989

9090
### Toolbars & UI
91-
Floating toolbars (pin/unpin with <kbd>F2</kbd>/<kbd>F9</kbd>), icon or text modes, color picker, extended palettes, status bar, and in-app help overlay (<kbd>F1</kbd>/<kbd>F10</kbd>).
91+
Floating toolbars (pin/unpin with <kbd>F2</kbd>/<kbd>F9</kbd>), preset slots, icon or text modes, color picker, extended palettes, status bar, and in-app help overlay (<kbd>F1</kbd>/<kbd>F10</kbd>).
92+
93+
### Presets
94+
Save tool + color + size (plus optional fill/opacity/text settings) into 3-5 slots for fast recall. Apply with <kbd>1</kbd>-<kbd>5</kbd>, save with <kbd>Shift+1</kbd>-<kbd>Shift+5</kbd>.
9295

9396
### Presenter Helpers
9497
Click highlights with configurable colors/radius/duration. Screen freeze (<kbd>Ctrl+Shift+F</kbd>) to pause what viewers see while apps keep running. Screen zoom (<kbd>Ctrl+Alt</kbd> + scroll) with lock/pan for callouts.
@@ -358,6 +361,8 @@ Press <kbd>F1</kbd> or <kbd>F10</kbd> at any time for the in-app cheat sheet.
358361
| Help overlay | <kbd>F1</kbd> / <kbd>F10</kbd> |
359362
| Configurator | <kbd>F11</kbd> |
360363
| Status bar | <kbd>F4</kbd> / <kbd>F12</kbd> |
364+
| Apply preset slot | <kbd>1</kbd> - <kbd>5</kbd> |
365+
| Save preset slot | <kbd>Shift+1</kbd> - <kbd>Shift+5</kbd> |
361366
| Toggle click highlight | <kbd>Ctrl+Shift+H</kbd> |
362367
| Toggle freeze | <kbd>Ctrl+Shift+F</kbd> |
363368
| Zoom in/out | <kbd>Ctrl+Alt</kbd> + scroll / <kbd>Ctrl+Alt++</kbd> / <kbd>Ctrl+Alt+-</kbd> |
@@ -366,6 +371,8 @@ Press <kbd>F1</kbd> or <kbd>F10</kbd> at any time for the in-app cheat sheet.
366371
| Pan zoom view | <kbd>Middle drag</kbd> / <kbd>Arrow keys</kbd> |
367372
| Exit | <kbd>Escape</kbd> / <kbd>Ctrl+Q</kbd> |
368373

374+
Preset slots can be saved/cleared from the toolbar; edit names and advanced fields in `config.toml`.
375+
369376
---
370377

371378
## Configuration
@@ -390,6 +397,16 @@ wayscriber-configurator # or press F11
390397
default_color = "red"
391398
default_thickness = 3.0
392399

400+
[presets]
401+
# slot_count: 3-5
402+
slot_count = 5
403+
404+
[presets.slot_1]
405+
name = "Red pen"
406+
tool = "pen"
407+
color = "red"
408+
size = 3.0
409+
393410
[performance]
394411
buffer_count = 3
395412
enable_vsync = true

0 commit comments

Comments
 (0)