Skip to content

v1.2.1-prerelease-1
Compare
Choose a tag to compare
@jtroo jtroo released this 12 Feb 21:37
· 641 commits to main since this release
v1.2.1-prerelease-1
5472afd
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
  • Attempted fix for dynamic macro layer change behaviour

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 ggopted 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

29099ac0dbd8e80cb7e8f9db57555cc0393636ffa777674770de4d82b5a1e04c  kanata
cc1c7b9a9dbc42c4b7a253ace011f20bb9b3600f3665085e59dbb7e5a603d539  kanata.exe
c63c995ad8d6231245fb1102f614b96ee2ae96421af72309ae8bc98b96d51f89  kanata.kbd
57ad2771a1283a12e653bc736fe97b2d6af0ddd63485e8236915a447915f699c  kanata_cmd_allowed
edd06155374da9b2a892e80dba9c17063af36f9c3975697183ddcf0458e09b5b  kanata_cmd_allowed.exe
73ba997bca47d535aeaec1f39cc6a4293668778af299eb963b4dc0ff9e09040d  kanata_wintercept.exe
09c6d50d24bb827ed227bf55daf5e0679e0ab248d4fd6983b7ffd766ca0e3525  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading