v1.5.0-prerelease-1

Changelog (since v1.4.0)

BREAKING FIX: change unicode yen key mapping to mean KEY_YEN instead of backslash

KNOWN BUG: deflocalkeys has a bug. You should use a older build, or newer if available. Fixed in latest main branch.

Change log

• Added: on-idle-fakekey action
• Added: toggle option for fake key actions
• Fixed: avoid crash in an error case of macro parsing
• Fixed: change unicode yen key mapping to mean KEY_YEN instead of backslash
• Fixed: rpt-any works in more cases
• Fixed (Windows-Interception): mbck/mfwd up/down were switched, making Windows behave strangely

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

Instructions

Download kanata.exe. Optionally, download kanata.kbd. With the two files in the same directory, you can double-click the exe to start kanata. Kanata does not start a background process, so the window needs to stay open after startup. See this discussion for tips to run kanata in the background.

You need to run kanata.exe via cmd or powershell to use a different configuration file:

kanata.exe --cfg <cfg_file>

Linux

Instructions

Download kanata.

Run it in a terminal and point it to a valid configuration file. Kanata does not start a background process, so the window needs to stay open after startup. See this discussion for how to set up kanata with systemd.

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

Explanation

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

Explanation and instructions

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

Sums

39c8e44fb3db41f9657a81068dbb18c06f20df0c462f261dd6436cf41fe26eba  kanata
892e66d9e784d7bc1aa8bec09dc1d1146a072e515c0664614368425fc3fc689e  kanata.exe
0f817f9244daed39d369609abf1f86840881ee5b72a9307d6e04f9c5ab1347c3  kanata.kbd
0d52fcddf9ab4f66da36407759af66c7ce5f7b5d7cd047d8b46d99dfdcb45310  kanata_cmd_allowed
ce849dffb7233775548cd86306af78c5474ae75d1aca5dfe4ca88db6c1273dd3  kanata_cmd_allowed.exe
3dab543272b985242ab6a4b512e42deacd0710a8a35dad5ad24b1a16dfee1fd7  kanata_wintercept.exe
295332b054d83e658effec7280a2e1457025cb0d692d034ba22b898d4017d5ce  kanata_wintercept_cmd_allowed.exe