Skip to content

v1.2.1-prerelease-3
Compare
Choose a tag to compare
@jtroo jtroo released this 22 Feb 18:23
· 610 commits to main since this release
v1.2.1-prerelease-3
321c9a6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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
  • Fix a locking pattern that causes unresponsiveness
  • 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. 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>

You can also set up a toolbar shortcut.

Linux

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

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

9a84895422609218e3e95f6ca88444bc757e716415081e26d9fb5aafaf427a39  kanata
7322e556ad882590c384fe1ecf70494b52ba6d8298f1e88dbba32db72f5ebf79  kanata.exe
8babac087df964c680f1a506b3ed4dc5a983d6b39832d76cc1d3b1b9b48131f7  kanata.kbd
1940c28742447c236d1f2f573a7892510b7fc4886d0e2fd95fe38e4f0314a431  kanata_cmd_allowed
62c84b662945b7774029f4a7a54ad27edfd39862fcbb278ab687d6faf888e9dc  kanata_cmd_allowed.exe
2af3646b91a117ebeacf93b47789eebe49fc5eb25e6d504ee14c29de110cced7  kanata_wintercept.exe
fbb5616a8b3788b63658af5d12619b71a9103bca75b2539f7be347a6d2bdc6fb  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading