Key Mapper

A Linux tool to change and program the mapping of your input device buttons.

Ubuntu/Debian • Manjaro/Arch • Git

Usage

To open the UI to modify the mappings, use:

key-mapper-gtk

You can also start it via your applications menu.

To keep injecting the mapping after closing the window, the daemon needs to be running. If it doesn't already after logging in, you can use:

key-mapper-service

It works with both Wayland and X11.

Macros

It is possible to write timed macros into the center column:

k(1).k(2) 1, 2
r(3, k(a).w(500)) a, a, a with 500ms pause
m(Control_L, k(a).k(x)) CTRL + a, CTRL + x

Documentation:

r repeats the execution of the second parameter
w waits in milliseconds
k writes a single keystroke
m holds a modifier while executing the second parameter
. executes two actions behind each other

For a list of supported keystrokes and their names, check the output of xmodmap -pke

Installation

Ubuntu/Debian

dpkg -i $(wget TODO)
usermod -a -G input $USER
usermod -a -G plugdev $USER

Manjaro/Arch

TODO

pacaur -S key-mapper-git

Git

git clone https://github.com/sezanzeb/key-mapper.git
cd key-mapper
sudo python3 setup.py install
usermod -a -G input $USER
usermod -a -G plugdev $USER

Depending on how those packages are called in your distro, you need the following dependencies:

python3-setuptools python3-evdev python3-dbus

Tests

pylint keymapper --extension-pkg-whitelist=evdev
sudo python3 setup.py install && python3 tests/test.py

Roadmap

show a dropdown to select valid devices
creating presets per device
renaming presets
show a mapping table
make that list extend itself automatically
read keycodes with evdev
inject the mapping
keep the system defaults for unmapped buttons
button to stop mapping and using system defaults
highlight changes and alert before discarding unsaved changes
automatically load presets on login for plugged in devices
make sure it works on wayland
support timed macros, maybe using some sort of syntax
add to the AUR, provide .deb file
automatically load presets when devices get plugged in after login

2.6 KiB Raw Blame History