• Table of Contents
  • Eruption
  • Supported Devices
    • Keyboard devices
    • Mouse devices
  • Important Information
  • Design Overview
  • Installation
    • Arch Linux and derivatives like ArcoLinux or Manjaro
    • Fedora based
    • Ubuntu or Pop!_OS
    • From Source
  • After Setup
    • Support for Audio Playback and Capture
  • The eruption-process-monitor Daemon
    • Examples
    • Removing a rule
  • Further Reading
  • Contributing

A Linux user-mode input and LED driver for keyboards, mice and other devices

• ROCCAT Vulcan 100/12x series keyboard (fully supported)
• ROCCAT Vulcan Pro TKL series keyboard (98% supported as of version 0.1.19, experimental)
• ROCCAT Vulcan TKL series keyboard (work-in-progress, as of version 0.1.20, experimental, untested)
• ROCCAT Vulcan Pro series keyboard (work-in-progress, as of version 0.1.20, experimental, untested)

• ROCCAT Kone Pure Ultra
• ROCCAT Kone Aimo (experimental)
• ROCCAT Kone Aimo Remastered (experimental)
• ROCCAT Kova AIMO (experimental)

Please see DEVICES.md for further information

This project is still in an early stage of development, and thus may contain some, possibly serious bugs.

If you ever need to forcefully disable the Eruption daemon you may do so by adding the following text snippet to the bootloader's (e.g. GRUB) kernel command line:

 systemd.mask=eruption.service

Or with systemctl to mask the service:

 $ sudo systemctl mask eruption.service

You can always re-enable the Eruption service with the command:

 $ sudo systemctl unmask eruption.service

Eruption is a Linux daemon written in Rust, consisting of a core, an integrated Lua interpreter and additional plugin components. Its intended usage is to execute Lua scripts that may react to certain events on the system like e.g. "Key pressed" and subsequently control the AIMO LEDs on the keyboard. Plugins may export additional functionality to the Lua scripting engine. Multiple Lua scripts may be run in parallel. Each Lua scripts "submitted color map" will be combined with all other scripts "submitted color maps" using a compositor that does an alpha blending step on each color map, prior to sending the resulting final color map to the keyboard.

 $ paru -Syu aur/eruption-git

 $ sudo dnf copr enable x3n0m0rph59/eruption
 $ sudo dnf install eruption-git

 $ sudo add-apt-repository ppa:x3n0m0rph59/eruption
 $ sudo apt update
 $ sudo apt install eruption-git

To activate Eruption now, you may either reboot your system or manually start the daemon with the command:

 $ sudo systemctl start eruption.service

Note: You don't have to enable the eruption service, since it is started by an udev rule as soon as a compatible keyboard device is plugged into your system.

 $ git clone https://github.com/X3n0m0rph59/eruption.git
 $ cd eruption
 $ cargo build --all --release

 $ sudo target/release/eruption -c support/config/eruption.conf

Please refer to INSTALL.md for further information.

You may want to try the Eruption Profile Switcher GNOME Shell extension, for easy switching of profiles on the fly.

If you want Eruption to be able to play back sound effects, or use one of the audio visualizer Lua scripts, then you have to perform a few additional steps.

Please refer to SETUP_AUDIO.md for detailed instructions.

As of Eruption 0.1.19, automatic switching of profiles and slots is now supported via the eruption-process-monitor daemon. It gathers data via multiple sensor plugins and matches this data against a rule engine. It currently supports executing actions on process execution, as well as on X11 "window focus changed" events.

To enable the daemon please run the command:

systemctl --user enable --now eruption-process-monitor.service

To list all rules, run the command:

eruption-process-monitor rules list

Switch to spectrum-analyzer-swirl.profile when a YouTube tab is active in Google Chrome:

eruption-process-monitor rules add window-name '.*YouTube.*Google Chrome' spectrum-analyzer-swirl.profile

Switch to profile3.profile when a YouTube tab is active in Mozilla Firefox:

eruption-process-monitor rules add window-name '.*YouTube.*Mozilla Firefox' profile3.profile

To list all supported sensors and actions please run the command:

eruption-process-monitor rules add help

$ eruption-process-monitor rules list
  0: On window focused: Name: '.*YouTube.*Mozilla Firefox' => Switch to profile: spectrum-analyzer-swirl.profile (enabled: false, internal: false)
  1: On window focused: Name: 'Skype' => Switch to profile: vu-meter.profile (enabled: false, internal: false)
  2: On window focused: Name: 'Left 4 Dead 2.*' => Switch to profile: gaming.profile (enabled: true, internal: false)
  3: On window focused: Name: '.*YouTube.*Google Chrome' => Switch to profile: spectrum-analyzer-swirl.profile (enabled: true, internal: false)
  4: On window focused: Instance: '.*' => Switch to profile: profile1.profile (enabled: true, internal: true)

To remove a rule, please run the following command:

 $ eruption-process-monitor rules remove 1

This will remove the rule for the window named Skype from the ruleset.

Please see DOCUMENTATION.md for a more thorough explanation of what Eruption is, and how to use and customize it properly.

For further information about the supported Lua functions and libraries, please refer to the developer documentation LIBRARY.md.

For a detailed documentation on how to write your own macros, please refer to MACROS.md

Contributions are welcome! Please see src/scripts/examples/*.lua directory for Lua scripting examples.