KeyScripten.app

This app is the programmable keyboard macro system for Mac OSX. You can write any keyboard handler by JavaScript.

This app contains some of the bundled plugins:

• implementation of the Toshiyuki Masui san's Dynamic Macro

How do I use this?

SystemTray

This application run on the system tray. You can configure/add new script on this configuration window.

Accessibility permission

You need to allow the accessibility option here. Because this application captures all keyboard input.

If there's a problem, you may need to remove the application from the accessibility permission list.

How do I implement my own script?

Here's a script implementation guide:

https://github.com/tokuhirom/KeyScripten/blob/main/HOW_TO_WRITE_SCRIPT.md

How it works?

There's a CGEventTapCreate function on mac osx. This function provides the feature to retrieve the user's input. This application forwards the event to JavaScript code. And so, your javascript code can send any keyboard events to the OS.

Hacking

How do I build this?

npm install
npm run tauri build

Release process

• Update version field in src-tauri/tauri.conf.json5.
• Create new GitHub release s in draft.

LICENSE

The MIT License (MIT)

Copyright © 2023 Tokuhiro Matsuno, http://64p.org/ <tokuhirom@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

THANKS TO

I refer the rdev to implement this application: https://github.com/Narsil/rdev/blob/main/LICENSE

LIMITATIONS

• If you want to use symbols as a shortcut key with JIS keyboard, maybe there's an issue on some keys...
  • I don't have a JIS keyboard. patches welcome.