The xwaykeyz keymapper is a smart key remapper for Linux (and X11) written in Python. It's similar to xmodmap but allows far more flexible remappings. Several Wayland environments are supported, but some of the Wayland environments require the assistance of Toshy, a project that uses this keymapper to provide Mac-like keyboard shortcut remapping. See the Toshy README for a full list of the supported Wayland environments when xwaykeyz is installed via Toshy. The Toshy installer will accept a special --barebones-config argument that will leave you with a clean config file without any of the Mac-like remapping, so Toshy can also be used as just a management interface to more easily work with the keymapper while Toshy provides some of the Wayland support components.
This project was forked from keyszer, which currently has no Wayland support, just like xkeysnail, and keyszer was in turn forked from xkeysnail, which no longer seems to be actively maintained.
Most of the references in this README to keyszer will be updated at some point to be more relevant for xwaykeyz.
Feel free to pronounce xwaykeyz however you want: Ex-Way-Keys, Sway-Keys, or Zway-Keyzzzzzz...
Xwaykeyz works at quite a low level, close to the hardware. It grabs input directly from the kernel's evdev input devices ( /dev/input/event*) and then creates an emulated uinput virtual keyboard device to inject those inputs back into the kernel. During this process the input stream is transformed on the fly as necessary to remap keys. As a side effect of how it works, the keymapper has no idea what your keyboard layout/language is, and this can cause small or large problems for non-US layout users. The only fix for this currently is modifying the key.py key definition file, which works fine in many cases where only a few keys need to be swapped.
Note that the problem with non-US layouts is generally restricted to keys or shortcuts that get remapped by the config, so general typing is not affected, and if your config doesn't happen to remap a key that is different from the typical US layout, this issue may never really affect your usage of the keymapper. It is highly variable how much of a problem this is.
Some progress has been made attempting to use xkbcommon to be able to change the key definitions according to the user's specified layout, but there is a lot of work still not done to make that happen. It's even more difficult to try to get the user's layout changes on-the-fly, for users who need to switch between multiple layouts.
Upgrading from xkeysnail
- Some configuration changes will be needed.
- A few command line arguments have changed.
- For xkeysnail 0.4.0 see UPGRADING_FROM_XKEYSNAIL.md.
- For xkeysnail (Kinto variety) see USING_WITH_KINTO.md and Using with Kinto v1.2-13.
Note
It is highly recommended to to consider migrating from Kinto to Toshy, since Toshy is intrinsically designed to work with this particular fork of the original xkeysnail keymapper used by Kinto, and Toshy components are currently required for supporting some of the Wayland environments.
- Low-level library usage (
evdevanduinput) allows remapping to work from the console all the way into X11 (or Wayland). - High-level and incredibly flexible remapping mechanisms:
- per-application keybindings - bindings that change depending on the active X11 application or window
- multiple stroke keybindings -
Ctrl+x Ctrl+ccould map toCtrl+q - very flexible output -
Ctrl-scould type out:save, and then hit enter - stateful key combos - build Emacs style combos with shift/mark
- multipurpose bindings - a regular key can become a modifier when held
- arbitrary functions - a key combo can run custom Python function (as user)
New Features (since xkeysnail 0.4.0)
- simpler and more flexible configuration scripting APIs
- better debugging tools
- configurable
EMERGENCY EJECThotkey - configurable
DIAGNOSTIChotkey
- configurable
- fully supports running as semi-privileged user (using
rootis now deprecated) - adds
includeto allow config to pull in other Python files - adds
throttle_delaysto allow control of output speed of macros/combos - adds
immediatelyto nested keymaps (initial action) - adds
CommandandCmdaliases for Super/Meta modifierMetaalias removed due to confusion with old refs toAltkey
- add
Ccombo helper (eventually to replaceK) - supports custom modifiers via
add_modifier(such asHyper) - supports
Fnas a potential modifier (on hardware where it works) - adds
bindhelper to support persistent holds across multiple combos- most frequently used for macOS style
Cmd-Tabapp switching
- most frequently used for macOS style
- adds
--checkfor checking the config file for issues - adds
wm_namecontext for all conditionals (PR #40) - adds
device_namecontext for all conditionals (including keymaps) - (fix)
xmodmapcannot be used until some keys are first pressed on the emulated output - (fix) ability to avoid unintentional Alt/Super false keypresses in many setups (suspend)
- (fix) fixes multi-combo nested keymaps (vs Kinto's
xkeysnail) - (fix) properly cleans up pressed keys before termination
- individually configurable timeouts (
multipurposeandsuspend) - (fix) removed problematic
launchmacro - (fix) suspend extra keys during sequential sequences to create less key "noise"
- (fix) handle X Display errors without crashing or bugging out
New Features (since forking from keyszer)
- Support for several Wayland environments when installed via Toshy
- Without Toshy,
xwaykeyznatively supports only:- X11/Xorg sessions (with any desktop environment/window manager)
- Hyprland - [via
hyprpy] - Pantheon - [via D-Bus queries to Gala WM]
- sway - [via
i3ipc]
- With Toshy,
xwaykeyzcan support:- X11/Xorg sessions (with any desktop environment/window manager)
- Cinnamon 6.0 or later - [uses Toshy custom shell extension]
- COSMIC desktop environment - [uses Toshy D-Bus service]
- GNOME 3.38 or later - [needs 3rd-party shell extension]
- Hyprland - [via
hyprpyorwlrootsmethod] - Niri - [via
wlrootsmethod] - Plasma 5 (KDE) - [uses Toshy KWin script and D-Bus service]
- Plasma 6 (KDE) - [uses Toshy KWin script and D-Bus service]
- Qtile - [via
wlrootsmethod] - sway - [via
i3ipcorwlrootsmethod] - Wayland compositors with
zwlr_foreign_toplevel_manager_v1interface- See Wiki article on Toshy repo for usage of this method with unknown compositors that may be compatible
- Full list and requirements kept updated in Toshy README
- (fix) Negated high CPU usage while holding a key (by not processing "repeats")
- (enh) Added API to specify devices from inside the config file (instead of CLI arg)
This section will slowly move down the README as I update each section of the README to reflect that this is a README for xwaykeyz which has been forked from keyszer and renamed.
Requires Python 3.
Just download the source and install.
git clone https://github.com/RedBearAK/xwaykeyz.git
cd xwaykeyz
pip3 install --user --upgrade .
Using a Python venv might be the simplest way to get started:
git clone https://github.com/RedBearAK/xwaykeyz.git
cd xwaykeyz
python -m venv .venv
source .venv/bin/activate
pip3 install -e .
./bin/xwaykeyz -c config_file
Xwaykeyz requires read/write access to:
/dev/input/event*- to grab input from yourevdevinput devices/dev/uinput- to provide an emulated keyboard to the kernel
It's best to create an entirely isolated user to run the keymapper. Group or ACL based permissions can be used to provide this user access to the necessary devices. You'll need only a few udev rules to ensure that the input devices are all given correct permissions.
First, lets make a new user:
sudo useradd keymapper
...then use udev and ACL to grant our new user access:
Manually edit /etc/udev/rules.d/90-keymapper-acl.rules to include the following:
KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m user:keymapper:rw /dev/input/%k"
KERNEL=="uinput", SUBSYSTEM=="misc", RUN+="/usr/bin/setfacl -m user:keymapper:rw /dev/uinput"
...or do it by copypasting these lines into a shell:
cat <<EOF | sudo tee /etc/udev/rules.d/90-keymapper-acl.rules
KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m user:keymapper:rw /dev/input/%k"
KERNEL=="uinput", SUBSYSTEM=="misc", RUN+="/usr/bin/setfacl -m user:keymapper:rw /dev/uinput"
EOF
Many distros already have an input group; if not, you can create one. Next, add a new user that's a member of that group:
sudo useradd keymapper -G input
...then use udev to grant our new user access (via the input group):
Manually edit /etc/udev/rules.d/90-keymapper-input.rules to include the following:
SUBSYSTEM=="input", GROUP="input"
KERNEL=="uinput", SUBSYSTEM=="misc", GROUP="input"
...or do it by copypasting these lines into a shell:
cat <<EOF | sudo tee /etc/udev/rules.d/90-keymapper-input.rules
SUBSYSTEM=="input", GROUP="input"
KERNEL=="uinput", SUBSYSTEM=="misc", GROUP="input"
EOF
For a sample systemd service file for running Keyszer as a service please see keyszer.service.
This may be appropriate in some limited development scenarios, but is not recommended. Giving the active, logged in user access to evdev and uinput potentially allows all keystrokes to be logged and could allow a malicious program to take over (or destroy) your machine by injecting input into a Terminal session or other application.
It would be better to open a terminal, su to a dedicated keymapper user and then run Keyszer inside that context, as shown earlier.
Don't do this, it's dangerous, and unnecessary. A semi-privileged user with access to only the necessary input devices is a far better choice.
keyszer
A successful startup should resemble:
xwaykeyz v1.3.1
(--) CONFIG: /home/yourusername/.config/xwaykeyz/config.py
(+K) Grabbing Apple, Inc Apple Keyboard (/dev/input/event3)
(--) Ready to process input.
Specifying the environment
Xwaykeyz internally has multiple "window context providers", to get the application class and window title in X11/Xorg and the various Wayland environments it supports. For the keymapper to know which of the providers to use, there is an environment API function that can be used to inject the necessary information into the keymapper at startup.
environ_api(
session_type = 'session_type', # This will be 'x11' or 'wayland'
wl_desktop_env = 'a_wayland_de', # 'wlroots', 'kde', 'cinnamon', 'gnome', etc.
)For X11/Xorg, the desktop environment argument in this API is unnecessary, and ignored if provided (set to None internally), and then the keymapper will use the X11/Xorg window context provider. For Wayland, it is usually essential to specify the desktop environment or window manager name in order to pick the correct window context provider inside the keymapper. There are now several different Wayland providers for specific DEs/WMs, and one (wlroots) that may be able to cover a dozen or more less common Wayland compositors (e.g., Niri, Qtile, and similar).
With the Toshy project that uses xwaykeyz, there is an environment module that the config file uses to grab all the relevant details about the user's environment. This allows Toshy to automatically adapt to moving from one DE or WM to another (on the same Linux system). The user in most cases never has to specify anything about their environment. This Toshy environment module is frequently updated to identify even more DEs/WMs automatically.
The reason the environment scraping module from Toshy is not integrated directly into the keymapper itself is primarily because the main keyszer dev did not want to deal with its complexity when I introduced it. Which was not entirely irrational or unwise. It was more involved than I had predicted, to make it mostly reliable on multiple Linux distros, and able to correctly detect many different desktop environments. And it is still evolving.
If the user does not use multiple desktop environments (or window managers), it is perfectly fine to specify the environment statically with the API function call in the config file.
Limiting Devices
Limit remapping to specific devices using either a command-line option (--devices) with one or more device path or device name arguments, or with the devices_api() function from inside the config file. The results will be the same.
With --devices CLI option:
keyszer --devices /dev/input/event3 'Topre Corporation HHKB Professional'
The full path or complete device name may be used. Device name is usually better to avoid USB device numbering jumping around after a reboot, etc...
With the devices_api() API function in the config file:
devices_api(
only_devices = [
'Some Device Name',
'Other Device Name',
'/dev/input/event3', # Path or name can be used, but paths can change
]
)Other CLI Options:
-c,--config- location of the configuration file-w,--watch- watch for new keyboard devices to hot-plug-v- increase verbosity greatly (to help with debugging)--list-devices- list out all available input devices
By default we look for the configuration in ~/.config/xwaykeyz/config.py. You can override this location using the -c/--config switch. The configuration file is written in Python.
For an example configuration please see example/config.py.
The configuration API:
timeouts(multipurpose, suspend)throttle_delays(key_pre_delay_ms, key_post_delay_ms)environ_api(session_type = 'session_type', wl_desktop_env = 'desktop_environment')- See abovedevices_api(only_devices=['List of Device Names','One or more devices'])- See abovewm_class_match(re_str)not_wm_class_match(re_str)add_modifier(name, aliases, key/keys)modmap(name, map, when_conditional)multipurpose_modmap(name, map, when_conditional)keymap(name, map, when_conditional)conditional(condition_fn, map)- used to wrap maps, applying them conditionallydump_diagnostics_key(key)emergency_eject_key(key)include(relative_filename)
Include a sub-configuration file into the existing config. This file is loaded and executed at the point of inclusion and shares the same global scope as the existing config. These files should be present in the same directory as your main configuration.
include("os.py")
include("apps.py")
include("deadkeys.py")Configures the timing behavior of various aspects of the keymapper.
multipurpose- The number of seconds before a held multi-purpose key is assumed to be a modifier (even in the absence of other keys).suspend- The number of seconds modifiers are "suspended" and withheld from the output waiting to see whether if they are part of a combo or if they may be the actual intended output.
Defaults:
timeouts(
multipurpose = 1,
suspend = 1,
)Configures the speed of virtual keyboard keystroke output to deal with issues that occur in various situations with the timing of modifier key presses and releases being misinterpreted.
key_pre_delay_ms- The number of milliseconds to delay the press-release keystroke of the "normal" key after pressing modifier keys.key_post_delay_ms- The number of milliseconds to delay the next key event (modifier release) after the "normal" key press-release event.
Defaults:
throttle_delays(
key_pre_delay_ms = 0, # default: 0 ms, range: 0 to 150 ms, suggested: 1-50 ms
key_post_delay_ms = 0, # default: 0 ms, range: 0 to 150 ms, suggested: 1-100 ms
)Use the throttle delays if you are having the following kinds of problems:
- Shortcut combos seeming to behave unreliably, sometimes as if the unmapped shortcut (or part of the unmapped shortcut) is being pressed at the same time.
- Macros of sets of keystrokes, or strings or Unicode sequences processed by the keymapper into keystrokes, having various kinds of failures, such as:
- Missing characters
- Premature termination of macro
- Shifted or uppercase characters coming out as unshifted/lowercase
- Unshifted or lowercase characters coming out as shifted/uppercase
- Unicode sequences failing to complete and create the desired Unicode character
Suggested values to try if you are in a virtual machine and having major problems with even common shortcut combos:
- key_pre_delay_ms: 40
- key_post_delay_ms: 70
The post delay seems a little more effective in testing, but your situation may be different. For a bare-metal install where you are just having a few glitches in macro output, try much smaller delays:
- key_pre_delay_ms: 0.1
- key_post_delay_ms: 0.5
These are just examples that have worked fairly well in current testing on machines that have had these issues.
Configures a key that when hit will dump additional diagnostic information to STDOUT.
dump_diagnostics_key(Key.F15) # defaultConfigures a key that when hit will immediately terminate keyszer; useful for development, recovering from bugs, or badly broken configurations.
emergency_eject_key(Key.F16) # defaultAllows you to add custom modifiers and then map them to actual keys.
add_modifier("HYPER", aliases = ["Hyper"], key = Key.F24)Note: Just adding HYPER doesn't necessarily make it work with your software, you may still need to configure X11 setup to accept the key you choose as the "Hyper" key.
Helper to make matching conditionals (and caching the compiled regex) just a tiny bit simpler.
keymap("Firefox",{
# ... keymap here
}, when = wm_class_match("^Firefox$"))The negation of wm_class_match, matches only when the regex does NOT match.
Maps a single physical key to a different key. A default modmap will always be overruled by any conditional modmaps that apply. when_conditional can be passed to make the modmap conditional. The first modmap found that includes the pressed key and matches the when_conditional will be used to remap the key.
modmap("default", {
# mapping caps lock to left control
Key.CAPSLOCK: Key.LEFT_CTRL
})If you don't create a default (non-conditional) modmap a blank one is created for you. For modmap both sides of the pairing will be Key literals (not combos).
Used to bestow a key with multiple-purposes, both for regular use and for use as a modifier.
multipurpose_modmap("default",
# Enter is enter if pressed and immediately released...
# ...but Right Control if held down and paired with other keys.
{Key.ENTER: [Key.ENTER, Key.RIGHT_CTRL]}
)Defines a keymap of input combos mapped to output equivalents.
keymap("Firefox", {
# when Cmd-S is input instead send Ctrl-S to the output
C("Cmd-s"): C("Ctrl-s"),
}, when = lambda ctx: ctx.wm_class == "Firefox")Because of the when conditional this keymap will only apply for Firefox.
The argument mappings is a dictionary in the form of { combo: command, ...} where combo and command take following forms:
combo: Combo to map, specified byK(combo_str)- For the syntax of combo specifications, see Combo Specifications.
command: one of the followingK(combo_str): Type a specific key combo to the output.[command1, command2, ...]: Execute multiple commands sequentially.{ ... }: Sub-keymap. Used to define Multiple Stroke Keys.escape_next_key: Escape the next key pressed.ignore_key: Ignore the key that is pressed next. (often used to disable native combos)bind: Bind an input and output modifier together such that the output is not lifted until the input is.- arbitrary function: The function is executed and the returned value (if any) is used as a command.
The argument name specifies the keymap name. Every keymap has a name - using default is suggested for a non-conditional keymap.
Applies a map conditionally, only when the fn function evaluates True. The below example is a modmap that is only active when the current WM_CLASS is Terminal.
conditional(
lambda ctx: ctx.wm_class == "Terminal",
modmap({
# ...
})
)The context object passed to the fn function has several attributes:
wm_class- the WM_CLASS of the [input] focused X11 windowwm_name- the WM_NAME of the [input] focused X11 windowdevice_name- name of the device where an input originatedcapslock_on- state of CapsLock (boolean)numlock_on- state of NumLock (boolean)
Note: The same conditional fn can always be passed directly to modmap using the when argument.
TODO: need docs (See issue #8)
The Combo specification in a keymap is written in the form of C("(<Modifier>-)*<Key>").
<Modifier> is one of the following:
CorCtrl-> Control keyAlt-> Alt keyShift-> Shift keySuper,Win,Command,Cmd,Meta-> Super/Windows/Command keyFn-> Function key (on supported keyboards)
You can specify left/right modifiers by adding the prefixes L or R.
<Key> is any key whose name is defined in key.py.
Some combo examples:
C("LC-Alt-j"): left Control, Alt,jC("Ctrl-m"): Left or Right Control,mC("Win-o"): Cmd/Windows,oC("Alt-Shift-comma"): Alt, Left or Right Shift, comma
To use multiple stroke keys, simply define a nested keymap. For example, the
following example remaps C-x C-c to C-q.
keymap("multi stroke", {
C("C-x"): {
C("C-c"): C("C-q"),
}
})If you'd like the first keystroke to also produce it's own output, immediately can be used:
keymap("multi stroke", {
C("C-x"): {
# immediately output "x" when Ctrl-X is pressed
immediately: C("x"),
C("C-c"): C("C-q"),
}
})From a terminal session run evtest and select your keyboard's input device. Now hit the key in question.
Event: time 1655723568.594844, type 1 (EV_KEY), code 69 (KEY_NUMLOCK), value 1
Event: time 1655723568.594844, -------------- SYN_REPORT ------------
Above I've just pressed "clear" on my numpad and see code 69 (KEY_NUMLOCK) in the output. For Keyszer this would translate to Key.NUMLOCK. You can also browse the full list of key names in the source.
Note
The Toshy project has a custom function in its config that will show a dialog with the app class and window title in X11/Xorg and compatible Wayland environments. The xprop command will only work in X11/Xorg.
Use the xprop command from a terminal:
xprop WM_CLASS _NET_WM_NAME WM_NAME
...then click an application window.
Use the second WM_CLASS value (in this case Google-chrome) when matching context.wm_class.
terminals = ["gnome-terminal","konsole","io.elementary.terminal","sakura"]
terminals = [term.casefold() for term in terminals]
USING_TERMINAL_RE = re.compile("|".join(terminals), re.IGNORECASE)
modmap("not in terminal", {
Key.LEFT_ALT: Key.RIGHT_CTRL,
# ...
}, when = lambda ctx: ctx.wm_class.casefold() not in terminals
)
modmap("terminals", {
Key.RIGHT_ALT: Key.RIGHT_CTRL,
# ...
}, when = lambda ctx: USING_TERMINAL_RE.search(ctx.wm_class)
)Can I remap the keyboard's Fn key?
It depends. Most laptops do not allow this as the Fn keypress events are not directly exposed to the operating system. On some keyboards, it's just another key. To find out you can run evtest. Point it to your keyboard device and then hit a few keys; then try Fn. If you get output, then you can map Fn. If not, you can't.
Here is an example from a full size Apple keyboard I have:
Event: time 1654948033.572989, type 1 (EV_KEY), code 464 (KEY_FN), value 1
Event: time 1654948033.572989, -------------- SYN_REPORT ------------
Event: time 1654948033.636611, type 1 (EV_KEY), code 464 (KEY_FN), value 0
Event: time 1654948033.636611, -------------- SYN_REPORT ------------
What if my keyboard seems laggy or is not repeating keys fast enough?
You likely need to set the [virtual] keyboards repeat rate to match your actual keyboard.
Here is the command I use:
xset r rate 200 20
For best results your real keyboard and Keyszer [virtual] keyboard should have matching repeat rates. That seems to work best for me. Anytime you restart keyszer you'll need to reconfigure the repeat rate because each time a new virtual keyboard device is created... or maybe it's that there is only a single repeat rate and every time you "plug in" a new keyboard it changes?
If you could shed some light on this, please get in touch.
Does Keyszer support FreeBSD/NetBSD or other BSDs?
Not at the moment, perhaps never. If you're an expert on the BSD kernel's input layers please join the discussion. I'm at the very least open to the discussion to find out if this is possible, a good idea, etc...
Does this work with Wayland?
Not yet. This is desires but seems impossible at the moment until there is a standardized system to quickly and easily determine the app/window that has input focus on Wayland, just like we do so easily on X11.
Is keyszer compatible with Kinto.sh?
That is certainly the plan. The major reason Kinto.sh required it's own fork has been resolved. Kinto.sh should simply "just work" with keyszer (with a few tiny config changes). In fact, hopefully it works better than before since many quirks with the Kinto fork should be resolved. (such as nested combos not working, etc)
Reference:
- Kinto GitHub issue regarding the transition.
- Instructions on altering your
kinto.pyconfig slightly. See USING_WITH_KINTO.md.
How can I help or contribute?
Please open an issue to discuss how you'd like to get involved or respond on one of the existing issues. Also feel free to open new issues for feature requests. Many issues are tagged good first issue or help welcome.
keyszer is distributed under GPL3. See LICENSE.
