v1.5.0-prerelease-2

Changelog (since v1.4.0)

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

BREAKING FIX: clear non-oneshot output chord (e.g. C-a) on next action

Change log

• Added: on-idle-fakekey action
• Added: toggle option for fake key actions
• Added: error message improvement when list action isnot ina list
• Added: movemouse-inherit-accel-state
• Added: movemouse-smooth-diagonals
• 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
• Fixed (Linux): maybe-fixed an issue around high CPU and memory consumption due to the rustix dependency

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

e77462f7cf98353fca95a37da2d3c083b26421af1fae2a174bded0a41714a415  kanata
5ab1ee4bccc4830c04777b061d1cb93f5c53284608b01b8976f64442a8bc968e  kanata.exe
c16f7ff77c65011a800ff5e466242f4960b7628dd72bb6edbda0d4cde9f8f443  kanata.kbd
e7825a5e3f47bf6396903bad333e37826952a6bba7ebfee4449923edf511cf8d  kanata_cmd_allowed
82bc0b87ded26414a5e773f7736b71305f731efa68b28c3c4b5297f1b6347b14  kanata_cmd_allowed.exe
60362cb2241c66d3c9619e46b5f03cc051be2bc17a392c1261a6f6f7d33af806  kanata_wintercept.exe
735f6995e3f2e3ad380bc26f089da5c142aa2c2dc46502ca3b04a3783cdd1186  kanata_wintercept_cmd_allowed.exe