jtroo/kanata v1.13.0-prerelease-1

on GitHub

• fix!: virtual keys ignore press when already pressed (#2207)

• feat: add gamepad input (#2186)

• feat: add log-layer-changes-name-only in defcfg (#2209)

• feat: stdout and stderr announcements only appear if not empty (#2173)

• feat: use ColorChoice::Auto instead of AlwaysAnsi (#2172)

• feat(macos): route mouse buttons through the virtual HID pointing device (#2155)

• feat(macos): support VirtualHIDDevice v8 (#2123)

• feat(parser): add macOS spotlight/launchpad/missionctrl key names (#2139)

• feat(win): add opt to disable keystate sync (#2122)

• fix: avoid panic in unicode atom (#2146)

• fix(mouse): resume a still-held scroll when another one is released (#2210)

• fix(mouse): resume a still-held movement when another one is released (#2197)

• fix(mouse): reset movemouse-accel on direction reversal with inherit-accel-state (#2190)

• fix(mwheel): clear mwheel in deceleration state on mod press (#2187)

• fix(mwheel): assign inertial state for left/right (#2116)

• fix(one-shot): end one-shot-release when activator key is re-pressed on another layer (#2049) (#2174)

• fix(tap-hold): stop the queue scan at the waiting key's own release (#2168)

• fix(macos): actually suppress mapped mouse events (#2156)

• fix(macos): accumulate move_mouse deltas from the last posted position (#2159)

• fix(parser): consume value in non-applicable deflocalkeys variant (#2152)

• fix(parser): enforce movemouse and mwheel distance bounds (#2151)

• fix(parser): resolve variables in definputdevices (#2150)

• fix(parser): take the empty-string fast-path in sref_str (#2143)

• fix(parser): reject OOB win hwid cleanly instead of panic (#2141)

• fix(parser): reject invalid zippy output mappings (#2112)

• fix(parser): set device detect mode for mouse keys in deflayermap (#2140)

• fix(linux): detect repeated device hotplug (#2129)

• fix(macos): handle device names containing embedded NULs (#2132)

• fix(require-prior-idle): add fudge to same-event check (#2117)

• fix(windows): treat kpenter as VK_RETURN for held VKs (#2107)

Download the appropriate kanata-windows-variant.zip file for your machine CPU. Extract and move the desired binary variant to its intended location. Optionally, download kanata.kbd. With the two files in the same directory, you can double-click the extracted .exe file 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 via cmd or powershell to use a different configuration file:

kanata_windows_binaryvariant.exe --cfg <cfg_file>

Binary variants

Explanation of items in the binary variant:

• x64 vs. arm64:
  • Select x64 if your machine's CPU is Intel or AMD. If ARM, use arm64.
• tty vs gui:
  • tty runs in a terminal, gui runs as a system tray application
• cmd_allowed vs. not
  • cmd_allowed allows the cmd actions; otherwise, they are compiled out of the application
• winIOv2 vs. wintercept
  • winIOv2 uses the LLHOOK and SendInput Windows mechanisms to intercept and send events.
  • wintercept uses the Interception driver. Beware of its known issue that disables keyboards and mice until system reboot: Link to issue.
    • you will need to install the driver using the release or from the copy in this repo.
    • the benefit of using this driver is that it is a lower-level mechanism than Windows hooks, and kanata will work in more applications.

wintercept installation

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 suspect 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:

Example:

C:\Users\my_user\Documents\
    kanata_windows_wintercept_x64.exe
    kanata.kbd
    interception.dll

kanata_passthru_x64.dll

The Windows kanata_passthru_x64.dll file allows using Kanata as a library within AutoHotkey to avoid conflicts between keyboard hooks installed by both. You can channel keyboard input events received by AutoHotkey into Kanata's keyboard engine and get the transformed keyboard output events (per your Kanata config) that AutoHotkey can then send to the OS.

To make use of this, take kanata_passthru_x64.dll, then the simulated_passthru_ahk folder with a brief example, place the dll there, open kanata_passthru.ahk to read what the example does and then double-click to launch it.

Download the kanata-linux-x64.zip file.

Extract and move the desired binary variant to its intended location. Run the binary 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.

Example:

chmod +x kanata   # may be downloaded without executable permissions
sudo ./kanata_linux_x64 --cfg <cfg_file>`

To avoid requiring sudo, follow the instructions here.

Binary variants

Explanation of items in the binary variant:

• cmd_allowed vs. not
  • cmd_allowed allows the cmd actions; otherwise, they are compiled out of the application

The supported Karabiner driver version in this release is v6.2.0.

WARNING: macOS does not support mouse as input. The mbck and mfwd mouse button actions are also not operational.

Binary variants

Explanation of items in the binary variant:

• x64 vs. arm64:
  • Select x64 if your machine's CPU is Intel. If ARM, use arm64.
• cmd_allowed vs. not
  • cmd_allowed allows the cmd actions; otherwise, they are compiled out of the application

Instructions for macOS 11 and newer

You must use the Karabiner driver version v6.2.0.

Please read through this issue comment:

#1264 (comment)

Also have a read through this discussion:

#1537

At some point it may be beneficial to provide concise and accurate instructions within this documentation. The maintainer (jtroo) does not own macOS devices to validate; please contribute the instructions to the file docs/release-template.md if you are able.

Install Karabiner driver for macOS 10 and older:

• Install the Karabiner kernel extension.

After installing the appropriate driver for your OS (both macOS <=10 and >=11)

Download the appropriate kanata-macos-variant.zip for your machine CPU.

Extract and move the desired binary variant to its intended location. Run the binary 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.

Example:

chmod +x kanata_macos_arm64   # may be downloaded without executable permissions
sudo ./kanata_macos_arm64 --cfg <cfg_file>`

Add permissions

If Kanata is not behaving correctly, you may need to add permissions. Please see this issue: link to macOS permissions issue.