Skip to content

Installation from Source

Vincent Chernin edited this page Jan 5, 2022 · 66 revisions

Installation from Source

All commands on this page, unless otherwise specified, are expected to be run as an unprivileged user (not root). Whenever root privileges are necessary, sudo will be used. If sudo is unavailable you may become root using su -, at which point you may execute any command as the root user. Use exit to become a normal user again.

Distribution Specifics

Arch Linux

Arch Linux includes a package and PKGBUILD in Community Repository.

Run sudo pacman -S easyeffects to install binary package.

Fedora

sudo dnf builddep easyeffects

Flatpak

It is possible to build your own Flatpak package, using flatpak-builder and a file, called a manifest. We will be building the same package that is built and published on Flathub.

Ensure Flatpak is installed and available on your system. If it is not installed, you can find detailed installation instructions at https://flatpak.org/setup/.

You can find the EasyEffects manifest, patches and other Flatpak specific files on Flathub. To get them run:

git clone https://github.com/flathub/com.github.wwmm.easyeffects.git --recurse-submodules

Then

cd com.github.wwmm.easyeffects

and now you can run flatpak-builder from this directory.

Important: To use Linux Studio Plugins and Zam Plugins, you will have to install org.freedesktop.LinuxAudio.Plugins.LSP and org.freedesktop.LinuxAudio.Plugins.ZamPlugins separately. They are available with Flathub, and are automatically installed when installing the stable Flathub package.

flatpak install org.freedesktop.LinuxAudio.Plugins.LSP org.freedesktop.LinuxAudio.Plugins.ZamPlugins

These used to be bundled in EasyEffects Flatpak (and therefore built with flatpak-builder), but they were removed for simplicity and to avoid duplicating builds in Flathub.

The official Flatpak documentation best describes the build process. It is recommended that you read this in order to understand the build process. The Flatpak Builder section is the most important one. It covers the use of flatpak-builder and how to use it with a manifest.

Consult the Flathub repository, README, and issue tracker if you have any questions or issues.

You can remove the Flatpak build and its configurations with:

flatpak remove com.github.wwmm.easyeffects --delete-data

GNOME Builder

A Flatpak manifest is contained in this repository, so you can clone the repository to easily test builds with GNOME Builder's "build" and "run" buttons.

Note Linux Studio Plugins and Zam Plugins, as well as the background portal (autostart and shutdown on window close switches) do not currently work with GNOME Builder Flatpak test builds.

Download

Clone the git repository.

git clone https://github.com/wwmm/easyeffects.git
cd easyeffects

Optional: Select a release

Substitute v6.2.0 with the latest release.

git checkout v6.2.0

Build & Install

meson _build --prefix=/usr
sudo ninja -C _build install

Note: *If you get the error: wrong parameters to Project(), minimum project name and one language is required you need a newer version of Meson. If one is not provided by your distribution you may install a newer one with pip3.

sudo pip3 install meson

See the official instructions for getting meson for more information.

Installing into a specific directory

This is useful if you are creating a package for a distribution. Substitute $pkgdir with a directory into which you wish to install the files.

meson _build --prefix=/usr
env DESTDIR="$pkgdir" ninja -C _build install

If your distribution of choice provides a package you will have to remember to remove all the files you just added or it could cause conflicts with the package manager. To avoid this headache you can run EasyEffects without installing it on the system or build in the temp folder:

meson _build --prefix=/tmp/pe
cd _build
ninja install
Clone this wiki locally