Skip to content

v1.4.0-prerelease-2

Pre-release
Pre-release
Compare
Choose a tag to compare
@jtroo jtroo released this 23 May 03:04
· 493 commits to main since this release
v1.4.0-prerelease-2
e57f626

Changelog (since v1.3.0)

BREAKING CHANGE: kanata now errors on unknown defcfg options instead of silently ignoring them

Change log
  • Fixed: macro with delay at end now behaves correctly
  • Fixed: rpt now follows caps-word
  • Fixed: trigger error on duplicate file name
  • Fixed(Linux): kanata hi-res scroll now works properly
  • Fixed(Windows): kprt key behaviour with Interception
  • Fixed(Windows): lsft-arrow workaround now triggers more accurately, breaking fewer use cases
  • Added: caps-word
  • Added: macro-repeat
  • Added: dynamic-macro-record-stop-truncate
  • Added: defaliasenvcond
  • Added: config directory discovery for kanata cfg file
  • Added: rpt-any
  • Added: flag to remove kanata startup delay
  • Added: chord output key(s)/layer-while-held release only when all input keys are released
  • Added(Linux): defcfg items for filtering by device name

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 
afcaabe2ddbcb66edaeaaa5e3eec67dec8aa0bc42fc1830562bf0fb87fb902f8  kanata
4eb35425e2ce1ec89e30781e2048b7ca573db58f85d70621c77074e9ba0e20f9  kanata.exe
898e67be5eb3d4b679ac5f3e1604d0ed1459246cc8390ff5c2bead600e39f386  kanata.kbd
c09887e9efb47d276c161b27d0397cd7b774d5b74abfb268767381ef19b09ab7  kanata_cmd_allowed
bb44413f0992e3256bed248615a391c4f3060d4e8626c5f4d6ef15baeaf3968d  kanata_cmd_allowed.exe
b3ee781ecd0f42cf65f0c82379fb714ecb3bd9be1514a711fd756656e5041be5  kanata_wintercept.exe
f3102551b64134885e33efe1c93ca47ca89f8c8fbdd89850bb81971407e56408  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading