Skip to content

Configuration file guide

Robin Lange edited this page Oct 28, 2019 · 2 revisions

Configuration file guide

The configuration file can take any extension, but each line must have the following syntax :

<keycodes> <mode> <mode options>
  • <keycodes> is a comma-separated list of decimal keycodes identifying the keys to apply the desired parameters to.

    • You can find the keycode of a key using the xev utility (part of xorg-xev in Archlinux, x11-utils in Ubuntu) : launch xev from the terminal, press the desired key and look for "keycode" in the KeyPress event.
    • You can specify a range of keycodes, example : 15-23
    • There are a few built-in aliases you can use in lieu of keycodes :
      • all : the whole keyboard
      • f_row: F1-F12 row
      • arrows : directional arrows
      • numrow : numerical row (above letters), including symbols
      • numpad : numerical pad, including symbols, numlock, Enter
      • characters : letters+characters except numrow
    • The Function key (Fn) does not have a keycode, so it is identified by the special alias fn.
    • You can mix keycodes, keycode ranges and aliases. Example : 45,arrows,79-82,fn,18
  • <mode> : RGB mode for the selected keys. For now only the steady mode (fixed color) is available.

  • <mode options> : for steady mode, the desired color in HTML notation. Example : 00ff00 (green)

If the same key is configured differently by multiple lines, the lowest line takes priority.

Lines prefixed with # are ignored.

Examples

All keys white except yellow arrows and orange "Fn" key.

all steady ffffff
arrows steady ffff00
fn steady ffc800

Only WASD keys (for US layout) lit up in red.

25,38,39,40 steady ff0000
Clone this wiki locally