Skip to content

Add documentation for Settings #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidhcefx wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

Add documentation for Settings #335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,18 @@ To troubleshoot, We recommend that you:
to the list
- When macOS prompts you, restart KeyCastr. Or you can do it manually.

## Settings

- Visualizer: Select the desired visualizer type. (Default or Svelte)
- Display Mouse Events:
- With Mouse Pointer will draw a circle around the pointer.
- With Current Visualizer will display mouse clicks as popups.
- Display Mode:
- Commands Keys Only will display keys only with the `super` or `ctrl` key.
- All Modifier Keys will display keys only with the `super`, `ctrl`, `alt` or `shift` key.
- All Keys will display all keys.
- Apply Modifiers will display the keys after applying the modifiers. (eg. `Ω` instead of `alt+Z`)

## Position on Screen

The default position is on the bottom left of your display. To modify the position of displayed keystrokes, click and drag the text like so:
Expand Down