This is a general purpose hotkey plugin for interception-tools. It allows to remap arbitrary hotkeys with a configurable set of modifiers.
This is still work in progress! If you have feature requests or bugs, feel free to write an issue!
Currently, is is available for Arch in the AUR. You can install it from there.
Install interception-tools according to their readme for your distro.
Then, install Rust, check out this repository, build it and copy the executable to a folder on your $PATH.
git clone https://github.com/Lixissimus/fluent.git
cd fluent
cargo build --release
cp target/release/fluent /usr/binCopy fluent.yaml from the directory structure of the data/ dir in this repo to the corresponding location in your system.
This ensures that udevmon (this tool is part of interception-tools) starts the plugin for every connected keyboard.
The hotkey config is read from /etc/interception/fluent.conf.
The format is line-oriented and supports comments:
modifiers = ctrl_left, alt_left, shift_left, ctrl_right, alt_right, shift_right, capslock
bind = capslock, j -> left
bind = alt_left, capslock, j -> shift_left, left
bind = capslock, k -> down
If modifiers is omitted, the default Ctrl, Alt, and Shift modifiers are used.
modifiers is an optional element.
If not specified, this defaults to ctrl_left/right, alt_left/right, and shift_left/right.
Modifiers are important, because a hotkey triggers as soon as the first non-modifier key is pressed.
Every key on the keyboard can be configured as a modifier.
Note: Currently, modifiers that are part of any configured hotkey are not forwarded to the system currently while a match is still possible.
E.g. in the above example config, alt_left will not be forwarded when pushed alone.
Only once a non-modifier that is not c is pressed, alt_left is sent to the system, because it is not handled by fluent.
Each bind defines a trigger sequence on the left side of -> and a send
sequence on the right side. The trigger sequence must consist of any number of
modifiers and a single non-modifier key. Keys are comma-separated.
If you are unsure about the namings of the keys, check src/keys.rs.
Before enabling the background service, it is recommended to test your config in a foreground process where you directly see errors.
Run the following as root.
Switch into a root shell using sudo su, because both intercept and uinput need to run as root.
Search for your keyboard by running ls -l /dev/input/by-id.
Also, add the sleep 1 in the beginning of the command, otherwise it might already process the key-up event of your return key, which results in weird behavior.
sleep 1 && intercept -g /dev/input/by-id/YOUR_KEYBOARD-event-kbd | fluent | uinput -d /dev/input/by-id/usb-Razer_Razer_BlackWidow_Elite-event-kbd If you want to log what the plugin is doing, check the output of ls -l /dev/input before running the command.
Then run the command and check the output again.
There should be one new /dev/input/eventXX.
This is the virtual device created by uinput.
You can now run sudo evtest /dev/input/eventXX and you will see all the events produced by your config.
udevmon can be used to automatically start the plugin for all connected keyboards.
See the interception-tools documentation for more details.
A default configuration comes with the plugin and is installed in /etc/interception/udevmon.d/fluent.yaml.
Start the background service:
sudo systemctl start udevmon.serviceEnable automatic start on system start:
sudo systemctl enable udevmon.serviceBy default, one instance of the plugin is started for each connected keyboard.
This is configured in /etc/interception/udevmon.d/fluent.yaml.
Check the documentation of the interception-tools for more details if you want to modify this file.
- notify interception maintainer of new plugin
- add cli arguments and help output
- allow to send multiple key combination
- allow to trigger commands
- vizualize state machine for documentation
- add different modes to enable vim-like configurations
- maybe publish current mode on DBus to enable plugins e.g. for waybar to show current mode