Changelog

• Fix a bug in fake keys with incorrect layer assignment in the layout
• Add/fix some keycodes
• Explicitly add support for multiline comment syntax in cfg file
• Windows: Implement preliminary (still buggy) defsrc mouse buttons
• Linux: improve device discovery behaviour
• Add defcustomkeys to help with non-US layouts

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

f2717e53f808e8189550dc8055017e1ea99cd8f05b136bf364a6897c7831667f  kanata
f8ea3ded15ae70c4ee40a390ef8642b789cba11c1512a44dc7bf2ea43deddc6d  kanata.exe
a46566881c2c818761b8c3fe97c62ccc9da972a253060eb253f33ec2b761c4a7  kanata.kbd
d83fc0f1b0ee0ee0a5419dbeebdfee8850c209dddb7c92ada0ab57c48f4545a0  kanata_cmd_allowed
cdd9b63ee6aedc9360b0f23e106c307c84f5c36a5d4726ee7817d03e1bff4185  kanata_cmd_allowed.exe
3fe67cba7e6faa258017a9d8a5cd5590b5ad69ca9f1ba224d02e7245e02805c5  kanata_wintercept.exe
634fb8e53caf77865a7f22782eccd5291fd08da32f6dfa89852a1d8d6fda0cc2  kanata_wintercept_cmd_allowed.exe