Skip to content

v1.1.0
Compare
Choose a tag to compare
@jtroo jtroo released this 26 Nov 22:40
· 650 commits to main since this release
v1.1.0
120f588

Changelog

  • fix incorrect mapping of kp0
  • fix key repeat behaviour with some key actions
  • add cancellable macro
  • allow some actions in macro
  • improve leniency with linux device definitions

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

6acc7f749f57164cc606e94ad02c147252b2f3cbf6195a8e9fbf46ec6979ca23  kanata
8ec9839977fd69806b7507fbfb2a251c106b0e7896f0dd492f5fbe61407e51b4  kanata.exe
395a7a8b4136c8e2e46b4d474896d57cf79f2fd19e4ed554da39ecf7673bc376  kanata.kbd
a11f417b974a139053d7caf57d9ad769d7bb464ec16cf0d743308d54b1fed980  kanata_cmd_allowed
6d79e23b1c2221ad2d9370a9e7894b2913d5664e34461b773dc4f8cc391d70fb  kanata_cmd_allowed.exe
adacdcd2801146c8728f32d9668163ab00397976a2a78391f576430959d691f8  kanata_wintercept.exe
999dce55259272e029dd5ababb871e15ef7e40062db04bfe0eaad939aabfaaa1  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading