github-starred/keycastr
2
0
Fork 0
mirror of https://github.com/keycastr/keycastr.git synced 2026-05-15 14:15:50 -06:00
Code Issues 96 Projects Packages Wiki Activity Actions

Updates to README to clarify how to enable accessibility API permissions

Browse source
This commit is contained in:
Andrew Kitchen 2020-04-19 12:20:48 -07:00
parent 85943aa769
commit a67244ac00
1 changed files with 9 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -16,26 +16,21 @@ KeyCastr, an open-source keystroke visualizer.
brew cask install keycastr
```
## Accessibility API access
## Enabling Accessibility API Access
In order to work, KeyCastr must be included in the list of applications with Accessibility API access, under the Security & Privacy system preferences.
KeyCastr requires access to the macOS Accessibility API in order to receive your key events and broadcast the keystrokes you are interested in.
On newer versions of macOS (10.15+) there is a new Input Monitoring menu under Security & Privacy within the System Preferences app, and KeyCastr will appear there automatically the first time you run it. Simply unlock this menu and check the box next to KeyCastr to enable it.
![input_monitoring](assets/input_monitoring.png)
On older versions of macOS, or if for some reason the app doesn't appear under the Input Monitoring menu (or if you want to pre-enable it) then you may manually add it to the list of apps in the Accessibility menu.
![accessibility](assets/accessibility.png)
To add KeyCastr to the list click the <kbd>&plus;</kbd> button and select KeyCastr from the file system.
> NOTE: If KeyCastr is already in the list, then click the <kbd>&minus;</kbd> button and add KeyCastr again to be certain that the right application is chosen.
## Input Monitoring
Also, KeyCastr needs your explicit permission to to monitor inputs. You can set this in the Input Monitoring section under the Security & Privacy system preferences.
![input_monitoring](assets/input_monitoring.png)
To add KeyCastr to the list click the <kbd>&plus;</kbd> button and select KeyCastr from the file system.
> NOTE: If KeyCastr is already in the list, then click the <kbd>&minus;</kbd> button and add KeyCastr again to be certain that the right application is chosen.
If KeyCastr is already in the list, then click the <kbd>&minus;</kbd> button and add KeyCastr again to be certain that the right application is chosen.
## Displaying All Keystrokes
@ -45,8 +40,6 @@ Alternatively, keep this box unchecked to only display modifier keys (e.g. ⇧
![display_all_keystrokes](assets/display_all_keystrokes.png)
## 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: