|
4 years ago | |
---|---|---|
DEBIAN | 4 years ago | |
bin | 4 years ago | |
data | 4 years ago | |
keymapper | 4 years ago | |
readme | 4 years ago | |
scripts | 4 years ago | |
tests | 4 years ago | |
.coveragerc | 4 years ago | |
.gitignore | 4 years ago | |
.pylintrc | 4 years ago | |
HISTORY.md | 4 years ago | |
LICENSE | 4 years ago | |
MANIFEST.in | 4 years ago | |
README.md | 4 years ago | |
setup.py | 4 years ago |
README.md
Key Mapper
A tool to change and program the mapping of your input device buttons.
Usage
To open the UI to modify the mappings, look into your applications menu
and search for 'Key Mapper' in settings. You can also start it via
key-mapper-gtk
. It works with both Wayland and X11.
If stuff doesn't work, check the output of key-mapper-gtk -d
and feel free
to open up an issue here.
Macros
It is possible to write timed macros into the center column:
k(1).k(2)
1, 2r(3, k(a).w(500))
a, a, a with 500ms pausem(Control_L, k(a).k(x))
CTRL + a, CTRL + x
Documentation:
r
repeats the execution of the second parameterw
waits in millisecondsk
writes a single keystrokem
holds a modifier while executing the second parameter.
executes two actions behind each other
Syntax errors are logged to the console.
Names
For a list of supported keystrokes and their names for the middle column,
check the output of xmodmap -pke
- Alphanumeric
a
toz
and0
to9
- Modifiers
Alt_L
Control_L
Control_R
Shift_L
Shift_R
If you can't find what you need, consult linux/input-event-codes.h for KEY and BTN names
- Mouse buttons
BTN_LEFT
BTN_RIGHT
BTN_MIDDLE
BTN_SIDE
... - Multimedia keys
KEY_NEXTSONG
KEY_PLAYPAUSE
... - Macro special keys
KEY_MACRO1
KEY_MACRO2
...
Gamepads
Tested with the XBOX 360 Gamepad.
- Joystick movements will be translated to mouse movements
- The second joystick acts as a mouse wheel
- Buttons can be mapped to keycodes or macros
- The D-Pad only works as two buttons - horizontal and vertical
Installation
After your installation, independent of the method, you should add yourself
to the input
and plugdev
groups so that you can read information from your
devices. You have to start the application via sudo otherwise.
sudo usermod -a -G plugdev,input $USER
# log out and back in or restart, the two groups should be visible with:
groups
Manjaro/Arch
pacaur -S key-mapper-git
Ubuntu/Debian
wget "https://github.com/sezanzeb/key-mapper/releases/"\
"download/0.1.0/python3-key-mapper_0.1.0-1_all.deb"
sudo dpkg -i python3-key-mapper_0.1.0-1_all.deb
Git/pip
Depending on your distro, maybe you need to use both methods with --force to get all your files properly in place and overwrite a previous installation of key-mapper.
# method 1
sudo pip install git+https://github.com/sezanzeb/key-mapper.git
# method 2
git clone https://github.com/sezanzeb/key-mapper.git
cd key-mapper && sudo python3 setup.py install
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
- basic support for gamepads as keyboard and mouse combi
- map D-Pad and Joystick directions as buttons, joystick purpose via config
- automatically load presets when devices get plugged in after login
Tests
pylint keymapper --extension-pkg-whitelist=evdev
sudo pip install . && coverage run tests/test.py
coverage combine && coverage report -m
To read events, evtest
is very helpful.