input-remapper/readme/macros.md

Macros

key-mapper comes with an optional custom macro language with support for cross-device variables, conditions and named parameters.

Syntax errors are shown in the UI on save. Each k function adds a short delay of 10ms between key-down, key-up and at the end. See usage.md for more info.

Bear in mind that anti-cheat software might detect macros in games.

key

Acts like a pressed key. All names that are available in regular mappings can be used here.

You don't have to use quotes around the symbol constants.

Shorthand: k

key(symbol: str)

Examples:

key(symbol=KEY_A)
key(b).key(space)

wait

Waits in milliseconds before continuing the macro

Shorthand: w

wait(time: int)

Examples:

wait(time=100)
wait(500)

repeat

Repeats the execution of the second parameter a few times

Shorthand: r

repeat(repeats: int, macro: Macro)

Examples:

repeat(1, key(KEY_A))
repeat(repeats=2, key(space))

modify

Holds a modifier while executing the second parameter

Shorthand: m

modify(modifier: str, macro: Macro)

Examples:

modify(Control_L, k(a).k(x))

hold

Executes the child macro repeatedly as long as the key is pressed down.

If a symbol string like KEY_A is provided, it will hold down that symbol as long as the key is pressed down.

Shorthand: h

hold(macro: Macro | str)

Examples:

hold(KEY_A)
hold(key(space))

mouse

Moves the mouse cursor

mouse(direction: str, speed: int)

Examples:

mouse(up, 1)
mouse(left, 2)

wheel

Injects scroll wheel events

wheel(direction: str, speed: int)

Examples:

mouse(up, 1)
mouse(left, 2)

event

Writes an event. Examples for type, code and value can be found via the sudo evtest command

Shorthand: e

event(type: str | int, code: str | int, value: int)

Examples:

event(EV_KEY, KEY_A, 1)
event(2, 8, 1)

set

Set a variable to a value. This variable and its value is available in all injection processes.

Variables can be used in function arguments by adding a $ in front of their name: repeat($foo, key(KEY_A))

Their values are available for other injections/devices as well, so you can make them interact with each other. In other words, using set on a keyboard and if_eq with the previously used variable name on a mouse will work.

set(variable: str, value: str | int)

Examples:

set(foo, 1)
set(foo, "qux")

if_eq

Compare two values and run different macros depending on the outcome.

if_eq(value_1: str | int, value_2: str | int, then: Macro | None, else: Macro | None)

Examples:

set(a, 1).if_eq($a, 1, key(KEY_A), key(KEY_B))
set(a, 1).set(b, 1).if_eq($a, $b, else=key(KEY_B).key(KEY_C))
set(a, "foo").if_eq("foo", $a, key(KEY_A))

if_tap

If the key is tapped quickly, run the then macro, otherwise the second. The third param is the optional time in milliseconds and defaults to 300ms

if_tap(then: Macro | None, else: Macro | None, timeout: int)

Examples:

if_tap(key(KEY_A), key(KEY_B), timeout=500)
if_tap(then=key(KEY_A), else=key(KEY_B))

if_single

If the key that is mapped to the macro is pressed and released, run the then macro.

If another key is pressed while the triggering key is held down, run the else macro.

If a timeout number is provided, the macro will run else if no event arrives for more than the configured number in milliseconds.

if_single(then: Macro | None, else: Macro | None, timeout: int | None)

Examples:

if_single(key(KEY_A), key(KEY_B))
if_single(then=key(KEY_A), else=key(KEY_B))
if_single(key(KEY_A), key(KEY_B), timeout=1000)

Syntax

Multiple functions are chained using ..

Unlike other programming languages, qux(bar()) would not run bar and then qux. Instead, cux can decide to run bar during runtime depending on various other factors. Like repeat is running its parameter multiple times.

Whitespaces, newlines and tabs don't have any meaning and are removed when the macro gets compiled, unless you wrap your strings in "quotes".

Similar to python, arguments can be either positional or keyword arguments. key(symbol=KEY_A) is the same as key(KEY_A).

Using $ resolves a variable during runtime. For example set(a, $1) and if_eq($a, 1, key(KEY_A), key(KEY_B)).