keycastr README

The project's README from github.com/keycastr/keycastr. As one markdown file: README.md.

KeyCastr

KeyCastr, an open source keystroke visualizer.

header image

KeyCastr enables you to share your keystrokes when creating screencasts, presenting, or collaborating with others. You can choose to display command keys, all modified keys, or all keystrokes, and there is also an option to include mouse clicks.

It is also possible to develop your own visualizer on top of KeyCastr -- pull requests are welcome!

display preferences

Installation

Download the latest release from GitHub

Or, install using homebrew

brew install --cask keycastr

Granting Permissions

KeyCastr requires your permission to receive events from macOS in order to broadcast your keystrokes and mouse clicks.

On newer versions of macOS (10.15+) there is an 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

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

To add KeyCastr to the list click the + button and select KeyCastr from the file system, or drag it in using Finder.

If KeyCastr is already in the list you can remove it with the − button and add it again in order to be certain that the right copy of the application is specified.

Troubleshooting permissions

There are two likely causes for the app seeming not to work:

  1. Not receiving keystroke events from macOS due to security settings
  2. The window being offscreen.

Sometimes switching from the Default to the Svelte visualizer can help you figure out which problem it is.

To troubleshoot, We recommend that you:

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:

reposition

Security Concerns

Any application in the Accessibility or Input Monitoring sections of the Security & Privacy pane in macOS's Preferences.app is capable of receiving all your input events. We encourage you to inspect these lists carefully, remove applications which you don't believe need to monitor your input, and ask tough questions of the companies which produce the software you use.

KeyCastr is completely free and open source, and does not employ any networking mechanisms other than that included with the ubiquitous Sparkle framework for managing application updates. KeyCastr will never receive or display your passwords, so long as the website or application you are using treats password entry as secure, e.g. <input type="password"> or equivalent.

History and Credits

License

BSD 3-Clause

KeyCastr has been freely available for the Mac since 2009.

keycastr (keycastr/keycastr)

Searching Database…

15.2K ·GitHub
这是什么?KeyCastr 是一款适用于 macOS 的开源按键可视化工具,可以在屏幕上显示你的按键和鼠标点击,适合用于录制屏幕教程、演示或结对编程。
这是独立应用,还是我要添加到项目里的库?这是一款独立的 macOS 桌面应用,以悬浮层的形式显示在屏幕上,而不是供其他程序调用的库或插件。
我需要授予 macOS 任何特殊权限吗?需要。你必须在「安全性与隐私」偏好设置中,为 KeyCastr 启用「输入监控」(旧版 macOS 则是「辅助功能」),这样它才能接收你的按键事件。
安装后如果好像不能用了,我该怎么办?常见的两个问题:一是权限设置导致 macOS 阻止了事件访问;二是显示窗口跑到了屏幕外。README 建议的做法是:退出应用,在「输入监控」中移除后重新添加,然后重启应用。
在旧版 macOS 上也能用吗,还是只支持最新版本?两者都支持:在 macOS 10.15 及以上版本,使用「输入监控」面板;在更旧的版本上,则需要手动将它添加到「辅助功能」列表中。
把输入监控权限交给 KeyCastr 安全吗?README 认为是安全的:KeyCastr 完全开源,除了 Sparkle 的更新检查外不使用网络,而且永远不会显示安全密码输入框。
我能自定义显示的内容吗,比如只显示修饰键,还是显示所有按键?可以。你可以选择只显示命令键、所有带修饰键的组合,或是所有按键,还可以选择是否同时显示鼠标点击。
我能把按键显示区域移动到屏幕的其他位置吗?可以。默认显示在屏幕左下角,但你可以点击并拖动文字,把它放到任意位置。
我能为 KeyCastr 开发自定义的可视化样式吗?可以。README 明确欢迎开发者基于 KeyCastr 创建自己的可视化效果,并欢迎为此提交 Pull Request。
这个项目已经存在多久了?KeyCastr 自 2009 年起就在 Mac 上免费提供,最初由 sdeken 编写,之后由多位贡献者维护。
What are similar projects?mac-mouse-fix, rumps, Mouser, codenotch, tendedero, pliss, forel, rooms
Creator
keycastr
Size
60.1 MB
Stars
15.2K
Age
17y
Commits · 90 Days