Changelog (since v1.2.0)
- Fix name of
deflocalkeys-wintercept - Fix Windows Interception driver randomly pressing
esc - Fix dynamic macro behaviour keys held at end of macro
- Add Linux systemd notification for kanata startup
- Add Linux support for existing move mouse actions
Sample configuration file
The attached kanata.kbd file is tested to work with the current version. The one in the main branch of the repository may have extra features that are not supported in this release.
Windows
Download kanata.exe. Optionally, download kanata.kbd. With the two files in the same directory, you can double-click the exe to start kanata.
You need to run kanata.exe via cmd or powershell to use a different configuration file:
kanata.exe --cfg <cfg_file>
You can also set up a toolbar shortcut.
Linux
Download kanata.
Run it in a terminal and point it to a valid configuration file:
chmod +x kanata # may be downloaded without executable permissions
sudo ./kanata --cfg <cfg_file>`
To avoid requiring sudo, follow the instructions here.
cmd_allowed variants
The binaries with the name cmd_allowed are conditionally compiled with the cmd action enabled.
Using the regular binaries, there is no way to get the cmd action to work. This action is restricted behind conditional compilation because I consider the action to be a security risk that should be explicitly opted into and completely forbidden by default.
wintercept variants
Warning: known issue
This issue in the Interception driver exists: oblitum/Interception#25. This will affect you if you put your PC to sleep instead of shutting it down, or if you frequently plug/unplug USB devices.
Description
These variants use the Interception driver instead of Windows hooks. You will need to install the driver using the assets from the linked website or from the copy in this repo. The benefit of using this driver is that it is a lower-level mechanism than Windows hooks. This means kanata will work in more applications, including administrator-privileged apps.
Steps to install the driver
- extract the
.zip - run a shell with administrator privilege
- run the script
"command line installer/install-interception.exe" - reboot
Additional installation steps
The above steps are those recommended by the interception driver author. However, I have found that those steps work inconsistently and sometimes the dll stops being able to be loaded. I think it has something to do with being installed in the privileged location of system32\drivers.
To help with the dll issue, you can copy the following file in the zip archive to the directory that kanata starts from: Interception\library\x64\interception.dll.
E.g. if you start kanata from your Documents folder, put the file there:
C:\Users\my_user\Documents\
kanata_wintercept.exe
kanata.kbd
interception.dll
sha256 checksums
ee1f270d84d210793d24aa66972a8667de6ce0590ad134ee07e5928e9aa2259d kanata
b2b5fdb02fa172415de206fd8981aabbaee4725db12cd32163a4669d8c648e6b kanata.exe
c63c995ad8d6231245fb1102f614b96ee2ae96421af72309ae8bc98b96d51f89 kanata.kbd
a00167cb2fb96e410d4d73a9d460bafe41e006cb93ff89ecb576f250965c2679 kanata_cmd_allowed
7985a5b6cbb635899b6d7326cd149b6aa0e3a75e9f0aebda87d9f657de408947 kanata_cmd_allowed.exe
c307da3e2e6697a1c0dec9f4c3af12185ffc8a1687f8440cb0d7229998e341b9 kanata_wintercept.exe
6d3b5bcb353ba9a55fe7d76e0005e6089a520e34bd430537a03e6102065898c5 kanata_wintercept_cmd_allowed.exe