5.8 KiB
Examples
Examples for particular devices and/or use cases:
Event Names
- Alphanumeric
a
toz
and0
to9
- Modifiers
Alt_L
Control_L
Control_R
Shift_L
Shift_R
- Mouse buttons
BTN_LEFT
BTN_RIGHT
BTN_MIDDLE
BTN_SIDE
... - Multimedia keys
KEY_NEXTSONG
KEY_PLAYPAUSE
XF86AudioMicMute
... - Mouse scroll
wheel(down, 1)
wheel(up, 1)
- Mouse move
mouse(left, 1)
mouse(right, 1)
mouse(up, 1)
mouse(down, 1)
Macros
k(BTN_LEFT)
a single mouse-clickk(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 + xk(1).h(k(2)).k(3)
writes 1 2 2 ... 2 2 3 while the key is pressede(EV_REL, REL_X, 10)
moves the mouse cursor 10px to the rightmouse(right, 4)
which keeps moving the mouse while pressed. Made out ofh(e(...))
internallywheel(down, 1)
keeps scrolling down while heldset(foo, 1)
set "foo" to 1ifeq(foo, 1, k(x), k(y))
if "foo" is 1, write x, otherwise yh()
does nothing as long as your key is held downh(a)
holds down "a" as long as the key is pressed, just like a regular non-macro mappingif_tap(k(a), k(b))
writes a if the key is tapped, otherwise bif_tap(k(a), k(b), 1000)
writes a if the key is released within a second, otherwise bif_single(k(a), k(b))
writes b if another key is pressed, or a if the key is released and no other key was pressed in the meantime.
Combinations Spanning Multiple Devices
For regular combinations on only single devices it is not required to configure macros. See readme/usage.md.
Keyboard space
set(foo, 1).h(space).set(foo, 0)
Mouse middle
if_eq($foo, 1, h(a), h(BTN_MIDDLE))
Apply both presets. If you press space on your keyboard, it will write a space exactly like it used to. If you hold down space and press the middle button of your mouse, it will write "a" instead. If you just press the middle button of your mouse it behaves like a regular middle mouse button.
Explanation
h(space)
makes your key work exactly like if it was mapped to "space".
It will inject a key-down event if you press it, does nothing as long you
hold your key down, and injects a key-up event after releasing.
set(foo, 1).set(foo, 0)
sets "foo" to 1 and then sets "foo" to 0.
set
and if_eq
work on shared memory, so all injections will see your
variables. Combine both to get a key that works like a normal key, but that also
works as a modifier for other keys of other devices. ifeq($foo, 1, ..., ...)
runs the first param if foo is 1, or the second one if foo is not 1.
Scroll and Click on a Keyboard
Seldom used PrintScreen, ScrollLock and Pause keys on keyboards with TKL (ten key less) layout are easily accessible by the right hand thanks to the missing numeric block, so they can be mapped to mouse scroll and click events:
- Print:
wheel(up, 1)
- Pause:
wheel(down, 1)
- Scroll Lock:
BTN_LEFT
- Menu:
BTN_RIGHT
- F12:
KEY_LEFTCTRL + w
In contrast to libinput's ScrollMethod
button
which requires the scroll
button to belong to the same (mouse) device, clicking and scrolling events mapped
to a keyboard key can fully cooperate with events from a real mouse, e.g.
drag'n'drop by holding a (mapped) keyboard key and moving the cursor by mouse.
Mapping the scrolling to a keyboard key is also useful for trackballs without a scroll ring.
In contrast to a real scroll wheel, holding a key which has mouse wheel event mapped produces linear auto-repeat, without any acceleration. Using a PageDown key for fast scrolling requires only a small adjustment of the right hand position.
Scroll on a 3-Button Mouse
Cheap 3-button mouse without a scroll wheel can scroll using the middle button:
- Button MIDDLE:
wheel(down, 1)
Click on Lower Buttons of Trackball
Trackball with 4 buttons (e.g. Kensington Wireless Expert Mouse) with lower 2 buttons by default assigned to middle and side button can be remapped to provide left and right click on both the upper and lower pairs of buttons to avoid readjusting a hand after moving the cursor down:
- Button MIDDLE: BTN_LEFT
- Button SIDE: BTN_RIGHT
Scroll on Foot Pedals
While Kinesis Savant Elite 2 foot pedals can be programmed to emit key press or mouse click events, they cannot emit scroll events themselves. Using the pedals for scrolling while standing at a standing desk is possible thanks to remapping:
- Button LEFT:
wheel(up, 1)
- Button RIGHT:
wheel(down, 1)
Gamepads
Joystick movements will be translated to mouse movements, while the second joystick acts as a mouse wheel. You can swap this in the user interface. All buttons, triggers and D-Pads can be mapped to keycodes and macros.
The D-Pad can be mapped to W, A, S, D for example, to run around in games, while the joystick turns the view (depending on the game).
Tested with the XBOX 360 Gamepad. On Ubuntu, gamepads worked better in Wayland than with X11.
Sequence of Keys with Modifiers
Alt+TAB, Enter, Alt+TAB:
m(Alt_L, k(tab)).w(250).k(KP_Enter).k(key_UP).w(150).m(Alt_L, k(tab))
Emitting Unavailable Symbols
For example Japanese letters without overwriting any existing key of your system-layout. Only works in X11.
xmodmap -pke > keyboard_layout
mousepad keyboard_layout &
Find a code that is not mapped to anything, for example keycode 93 =
,
and map it like keycode 93 = kana_YA
. See this gist
for available symbols.
xmodmap keyboard_layout
key-mapper-gtk
"kana_YA" should be in the dropdown of available symbols now. Map it to a key and press apply. Now run
xmodmap keyboard_layout
again for the injection to use that xmodmap as well. It should be possible to write "ヤ" now when pressing the key.