Skip to content

v1.4.0-prerelease-3

Pre-release
Pre-release
Compare
Choose a tag to compare
@jtroo jtroo released this 07 Jul 00:54
· 454 commits to main since this release
v1.4.0-prerelease-3
14f755f

Changelog (since v1.3.0)

  • BREAKING FIX: kanata now errors on unknown defcfg options instead of silently ignoring them.
  • BREAKING FIX: kanata timer handling accuracy has improved. The accuracy should now be +-1ms of the configuration. It was slow before this version, meaning a value of 100 for a delay/timeout might result in 110 ms instead. This might mean your configured timeouts and delays are now too fast for what you're used to.
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: time handling accuracy is now +- 1ms.
  • Fixed(Linux): kanata hi-res scroll now works properly
  • Fixed(Linux): symlink path was incorrect
  • Fixed(Windows): swiss $ key
  • Fixed(Windows): kprt key behaviour with Interception
  • Fixed(Windows): lsft-arrow workaround now triggers more accurately, breaking fewer use cases
  • Added: chords in defseq
  • 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: defcfg item to delegate transparent keys to first layer
  • Added: include in configuration to include other files
  • Added(Windows): increase kanata process priority for better responsiveness
  • Added(Linux): defcfg items for filtering by device name
  • Added(Linux-X11): defcfg item for setting key repeat delay and rate

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 
5f1118dc6940afce56efa6ea8ec116f54a7ef136658f3ba58d5317e98f7c543b  kanata
8b2a3cac63d06663f9cd199b3a196b37e20cd1ea6a71a90686fc7a6eca5470c9  kanata.exe
d38b30b434c99249735940250c6d87afb75b670fef4f139428c636244effc086  kanata.kbd
7cda850f436c5ab5f8643e4b7c2faa1a55ca6e5d52f7f43cde3e89effa518081  kanata_cmd_allowed
ff34fc8aef5b6ee772462e43f5b3fcf76682bcd28ed9aabfbb0a45313b5cce4e  kanata_cmd_allowed.exe
7bb4651a76b83803b8995b84912e2ec11e5b7a854aa57ec2d0f9085b0610879d  kanata_wintercept.exe
441fcf935270d56032fa3f9db9d8278bde1e81251640d6c2c180a6735d4f444f  kanata_wintercept_cmd_allowed.exe
Assets 10
Loading