Skip to content

v1.2.0-prerelease-1

Pre-release
Pre-release
Compare
Choose a tag to compare
@jtroo jtroo released this 31 Jan 17:38
· 594 commits to main since this release
v1.2.0-prerelease-1
7b1a927

Changelog

  • Fix a bug in fake keys with incorrect layer assignment in the layout
  • Fix sequence timeout
  • Fix some keycodes, add new ones
  • Fix support for multiline comment syntax in cfg file
  • Fix memory leak in live reload
  • Improve device discovery behaviour in Linux
  • Add support for defsrc mouse buttons in Windows
  • Add deflocalkeys to help with non-US layouts
  • Add tap-dance-eager
  • Add mouse movement actions
  • Add sending an initial LayerChange message to newly connected TCP clients
  • Add dynamic macro
  • Add different sequence input modes
  • Add sending arbitrary keycodes

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

7d7ec47503d19741fd021573ac343559ce950a8067e8fc316499512c52442874  kanata
1d6fcdf189228fea15dd3a400165c8570dddcf2286a263a5751b6bd361c79bbd  kanata.exe
684835d4fe5532451572246a8522106b95f825ae97e3b290a284c084598f8863  kanata.kbd
c0d8d5dab606af8a1dff7fc4303a48587b2a5163bbb2fec7c3fe27fdfd1420df  kanata_cmd_allowed
a2783f993ad7cf242a4f7190853d8ee345cecd1bf050b89891a301490f84eee7  kanata_cmd_allowed.exe
2893d894deeb61bdae99a071a3f5d9cbc2b48997c572373172aa056844da7fdb  kanata_wintercept.exe
7436fd23759a76f080df560aade39e0d108ad84d82add9cc9e683fc28b40979f  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading