Improve keyboard comfort and usability with advanced customization
BREAKING FIX: change unicode yen key mapping to mean KEY_YEN instead of backslash
BREAKING FIX: clear non-oneshot output chord (e.g. C-a) on next action
on-idle-fakekey actiontoggle option for fake key actionsmovemouse-inherit-accel-state
movemouse-smooth-diagonals
KEY_YEN instead of backslashrpt-any works in more casesmbck/mfwd up/down were switched, making Windows behave strangelyrustix dependencyThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
e77462f7cf98353fca95a37da2d3c083b26421af1fae2a174bded0a41714a415 kanata
5ab1ee4bccc4830c04777b061d1cb93f5c53284608b01b8976f64442a8bc968e kanata.exe
c16f7ff77c65011a800ff5e466242f4960b7628dd72bb6edbda0d4cde9f8f443 kanata.kbd
e7825a5e3f47bf6396903bad333e37826952a6bba7ebfee4449923edf511cf8d kanata_cmd_allowed
82bc0b87ded26414a5e773f7736b71305f731efa68b28c3c4b5297f1b6347b14 kanata_cmd_allowed.exe
60362cb2241c66d3c9619e46b5f03cc051be2bc17a392c1261a6f6f7d33af806 kanata_wintercept.exe
735f6995e3f2e3ad380bc26f089da5c142aa2c2dc46502ca3b04a3783cdd1186 kanata_wintercept_cmd_allowed.exe
BREAKING FIX: change unicode yen key mapping to mean KEY_YEN instead of backslash
KNOWN BUG: deflocalkeys has a bug. You should use a older build, or newer if available. Fixed in latest main branch.
on-idle-fakekey actiontoggle option for fake key actionsKEY_YEN instead of backslashrpt-any works in more casesmbck/mfwd up/down were switched, making Windows behave strangelyThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
39c8e44fb3db41f9657a81068dbb18c06f20df0c462f261dd6436cf41fe26eba kanata
892e66d9e784d7bc1aa8bec09dc1d1146a072e515c0664614368425fc3fc689e kanata.exe
0f817f9244daed39d369609abf1f86840881ee5b72a9307d6e04f9c5ab1347c3 kanata.kbd
0d52fcddf9ab4f66da36407759af66c7ce5f7b5d7cd047d8b46d99dfdcb45310 kanata_cmd_allowed
ce849dffb7233775548cd86306af78c5474ae75d1aca5dfe4ca88db6c1273dd3 kanata_cmd_allowed.exe
3dab543272b985242ab6a4b512e42deacd0710a8a35dad5ad24b1a16dfee1fd7 kanata_wintercept.exe
295332b054d83e658effec7280a2e1457025cb0d692d034ba22b898d4017d5ce kanata_wintercept_cmd_allowed.exe
defcfg options instead of silently ignoring them.defcfg boolean values (e.g. this-is-not-yes) instead of silently ignoring them.$ keykprt key behaviour with Interceptionlsft-arrow workaround now triggers more accurately, breaking fewer use casesdefseq
caps-word
macro-repeat
dynamic-macro-record-stop-truncate
defaliasenvcond
rpt-any
layer-while-held release only when all input keys are releaseddefcfg item to delegate transparent keys to first layerinclude in configuration to include other filesmovemouse-speed, to modify mouse speed at runtimeswitch, a switch-case action evaluatorscnl, sequence cancel, and sequence, per-action sequence timeoutdefcfg items for filtering by device namedefcfg item for setting key repeat delay and rateThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
5138efbacedbbec3dca05bd7fbc207c01afd3772d298081735b08d710ee78380 kanata
ada28db8b19dc8122f07d3daeaee02b5a4338ab977fde99471b01bac1c22dd79 kanata.exe
67666d0dc2c36be672e06e9267762a2be92d24dcd307bac6de33330cee3952bf kanata.kbd
843443b218785cede0ec718704f8c6f9435c28337068c49abeaebdc0373f833b kanata_cmd_allowed
da996710ce838b0667afa7bb24fd4eeca0eb2424109ddace883dcf940b6fd642 kanata_cmd_allowed.exe
eff969faf08d7bbefd717dd66438699dd27e466e323cb5606e8ad8460ae0bd2d kanata_wintercept.exe
fd3a1450d99c3ee9fa7d6d18aa3712daf3f998cafdec51e4f141b26de0dc8eb9 kanata_wintercept_cmd_allowed.exe
defcfg options instead of silently ignoring them.rpt now follows caps-word
$ keykprt key behaviour with Interceptionlsft-arrow workaround now triggers more accurately, breaking fewer use casesdefseq
caps-word
macro-repeat
dynamic-macro-record-stop-truncate
defaliasenvcond
rpt-any
layer-while-held release only when all input keys are releaseddefcfg item to delegate transparent keys to first layerinclude in configuration to include other filesdefcfg items for filtering by device namedefcfg item for setting key repeat delay and rateThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
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
BREAKING CHANGE: kanata now errors on unknown defcfg options instead of silently ignoring them
rpt now follows caps-word
kprt key behaviour with Interceptionlsft-arrow workaround now triggers more accurately, breaking fewer use casescaps-word
macro-repeat
dynamic-macro-record-stop-truncate
defaliasenvcond
rpt-any
layer-while-held release only when all input keys are releaseddefcfg items for filtering by device nameThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
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
kprt key behaviour with Windows Interceptioncaps-word
macro-repeat
dynamic-macro-record-stop-truncate
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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
7f9fe160b5dcef0b6ca312c6d69f157ce832b42503b5b86004d749def3e27be5 kanata
48ba78dae52a53f8707f7bd2bddd60da9b0d57be548181444300898d0abb2fb3 kanata.exe
099fe0ad037600191c30223057f438d57ba9f6d7831c92612c4cd90cf590f1e9 kanata.kbd
7d3a8bd309bfaf0302ea0272b6b29cd1b22b29f524a30c5c56f515fc650332aa kanata_cmd_allowed
8a8f4a3c8417729bef0581f34aae0df1d743b04600439f49b738df3ab47b16f1 kanata_cmd_allowed.exe
a46b6347adcaa3ea9e6dab72f7f744c2cac27963305453f2457e6848668622d7 kanata_wintercept.exe
ba57f2f4b8d48350e52a1e28ce0ae0c6ae91df037e055eb66fc4c02d91f23fa2 kanata_wintercept_cmd_allowed.exe
WARNING: Kanata now errors on invalid top-level config items. Kanata previously would ignore these and they would do nothing. Now they result in errors in the configuration.
deflocalkeys-wintercept
-timeout variants of tap-hold that add a third potential actiontap-hold-release-keys
one-shot variantsdefvar to allow defining variablesfork action that chooses left or right actions based on currently active keysThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
561b58713d9b0967be17e782355766feca3fa9bed45e6b396fa0ba224eba36b5 kanata
a2848d43067de517855ca4321a90d6f3ff3bd0ea221aec52d0d6973df28c8760 kanata.exe
f862b7cad27d5d0bc4e7371bbb106fdb08453682f3729e63d45f62a7308ed7e6 kanata.kbd
5d8566211f0025c508397d7ff33f766ed3bb928556ef54c0ad536a07716bc18c kanata_cmd_allowed
df2cab04eab5cb4fbd57e8ab72b7808e2bb3b93321f9c15a8e4f06dea3e5439d kanata_cmd_allowed.exe
8fd91940772e790027e2e0024fff90db6c9e0b88f4641274dfa59148b663a3ca kanata_wintercept.exe
2ad144c51c62f7af8c73af1d6ffd4454d559d5ccb3aa9e820a7d66d12008e859 kanata_wintercept_cmd_allowed.exe
WARNING: Kanata now errors on invalid top-level config items. Kanata previously would ignore these and they would do nothing. Now they result in errors in the configuration.
deflocalkeys-wintercept
-timeout variants of tap-hold that add a third potential actiontap-hold-release-keys
one-shot variantsdefvar to allow defining variablesThe 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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
a05d8176c2b6ca8a97beab317e1beaafd32fdfb97ed44c6e8bd3d72e439efef2 kanata
ba82f934ec56d54eff9a60262fae35d791b47ca3e23df6b0dce2816e0f5f2e96 kanata.exe
bf71d7a2b05b15bf3d61e68356ec3b054f1c40958fbd564aa126fc9db0652527 kanata.kbd
992ef35db54a5c2b2ffcac04a42e85c7c462f92dfb7c5c0f201e7a273fe8064b kanata_cmd_allowed
86346d482ac3cefc27f366398f08c250e4c8abe73fb030b774ba130246142fd4 kanata_cmd_allowed.exe
f014b7aa701539117934754589bfb2219a915638f70bc380ca4abd5e5e8a24ee kanata_wintercept.exe
7fdb7af98a431005c59dc42733334c5b33ebf59a93a2ab43da4e6004863823cc kanata_wintercept_cmd_allowed.exe
WARNING: Kanata now errors on invalid top-level config items. Kanata previously would ignore these and they would do nothing. Now they result in errors in the configuration.
deflocalkeys-wintercept
-timeout variants of tap-hold that add a third potential actiontap-hold-release-keys
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.
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>
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
7e919063e29c85b6fe6a6bbb5e746da329bb04013a569246a85e1ed7c0bc9a14 kanata
87af0cb1612c55693c4aef62e66eba041863bbc0915954e6b80097e9abf7c93e kanata.exe
b8605a1eb1e1cdfb73ee0cd2cc6fb39a39bc824984f7f31d3c49df9cf9629c1f kanata.kbd
9bd5aa163b5d1cbf8fda84222a3d8626aad8ee6702c72fd1bef6a9c7955caaad kanata_cmd_allowed
5d0f27ee95b1bb054b80c02d781bf3117635fe9a54031f313906e970f2759dfa kanata_cmd_allowed.exe
20bf9b80721b8ef9ebd7fc4bb95e5bd765bad20efc0b7081038f90da64a7388d kanata_wintercept.exe
f40e3938f081897b2670c55d3103f047fd8f032f9934636604c5fd74d66b434e kanata_wintercept_cmd_allowed.exe
WARNING: Kanata now errors on invalid top-level config items
Fix: do not close immediately on error
Fix(Linux): change locking pattern causing unresponsiveness in some cases
Fix(Windows-Interception): correction of deflocalkeys-wintercept
Fix(Windows-Interception): fix issue with Interception driver sending Esc
Fix(Windows-Interception): use Interception mouse movement instead of SendInput
Added: -timeout variants of tap-hold that add a third potential action
Added: pretty errors using the miette crate
Added: make defcfg optional
Added: ensure all keys are released at the end of a dynamic macro
Added(Linux): mouse move support to Linux
Added(Linux): systemd notification when kanata has finished starting up
Added(Windows-Interception): use SendInput for arbitrary-code in Interception as well
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.
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>
You can also set up a toolbar shortcut.
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.
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.
This issue in the Interception driver exists: https://github.com/oblitum/Interception/issues/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.
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.
.zip
"command line installer/install-interception.exe"
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
210f8e84daadb8897d3dc58977d51ce07d4563800d88adf400c95f63171eb02a kanata
f3676580580b9d4df7ece6068d0d6feac9d05ef092cf5b0e961b9b5b3c1d5680 kanata.exe
7e00eb2ff2bfff6fe4cf46eaf48dbe6d87d15fa86041a8306672fbb26718cb54 kanata.kbd
f125165c22b9d830e4d587ff8f1f164c51a9e785c27e9a53f459594db7d2da96 kanata_cmd_allowed
5f4ac0ed29f1eb7811b0f598ad3b995acb60a4ee0e74875393079b7b15e40d2e kanata_cmd_allowed.exe
9b80498acc978d451682f833592aab17cfecdc5a931d608df3ce342593c420e5 kanata_wintercept.exe
096679538b87ede63b450949752a2ce5612766214de4acaa1e13308eb288e7a8 kanata_wintercept_cmd_allowed.exe