INSTALL.md

Table of Contents

• Table of Contents
• How to build and install Eruption from source
  • Install build dependencies
    • On Arch-based distros
    • On Fedora-based distros
    • On OpenSuse-based distros
    • On Debian-based distros
  • Clone the project and build the release binaries
  • Install Eruption
  • Run Eruption

How to build and install Eruption from source

To build Eruption from source you need to have git and rust installed, and you need to install the build dependencies of Eruption as well. You need at least the current stable release of rust (MSRV: 1.64). You probably may want to use https://rustup.rs/.

Install build dependencies

On Arch-based distros

sudo pacman -Sy libevdev hidapi systemd-libs dbus libpulse lua lua-socket gtksourceview4
sudo pacman -Sy gcc pkgconf make cmake protobuf xorg-server-devel libxrandr gtk3

On Fedora-based distros

sudo dnf install cmake systemd dbus hidapi libevdev lua gtksourceview4 lua-socket-compat
sudo dnf install protobuf-devel systemd-devel dbus-devel hidapi-devel libevdev-devel libusbx-devel \
  pulseaudio-libs-devel lua-devel libX11-devel libXrandr-devel gtk3-devel gtksourceview4-devel

On OpenSuse-based distros

sudo zypper in cmake gcc libdbus-c++-devel libgudev-1_0-devel libX11-devel xorg-x11-devel \
    libhidapi-devel lua54-devel libevdev-devel protobuf-devel gtk3-devel gtksourceview4-devel

On Debian-based distros

sudo apt install build-essential cmake protobuf-compiler libprotobuf-dev \
  libsystemd-dev libusb-1.0-0-dev libhidapi-dev \
  libevdev-dev libudev-dev libdbus-1-dev libpulse-dev liblua5.4-dev libx11-dev \
  libxrandr-dev libgtk-3-dev libgdk-pixbuf2.0-dev libatk1.0-dev \
  libpango1.0-dev libcairo2-dev libgtksourceview-4-dev

Clone the project and build the release binaries

git clone https://github.com/X3n0m0rph59/eruption.git
cd eruption
make

Install Eruption

sudo make install

Run Eruption

To activate Eruption now, manually start the daemons with the following command:

make start

Finally, if you want to use one of the audio visualizer profiles, then please select an audio device monitor e.g. using pavucontrol.

Switch to a profile that utilizes the audio API of Eruption:

eruptionctl switch profile spectrum-analyzer-swirl.profile

Then use pavucontrol to assign a monitor of an audio device to the Eruption audio grabber.

NOTE: You have to select a profile that makes use auf the audio grabber first, otherwise the eruption-audio-proxy will not open an audio device for recording, and therefore will not be listed