Linux® From Scratch - Quality of Life (System V Edition) - Version #9162

Chapter 13. Wayfire

Wayfire-0.9.0

Introduction to Wayfire

Wayfire is a Wayland compositor which takes a lot of effects from the now deprecated Compiz Xorg compositor. It aims to be customizable, yet lightweight. Unlike other compositors, it is also 3D and supports multiple perspectives for seeing windows.

Wayfire Dependencies

Required

Cairo, GBM (GBM from Mesa or Mesa; only the normal installation is required for either), GLM-1.0.1, FreeType2, hwdata, libdisplay-info, libdrm, libevdev, libinput, libjpeg-turbo, libpng, libxkbcommon, nlohmann-json-3.11.3, OpenGL (libglvnd or Mesa; only the normal installation is required for either), Pango (with Cairo), Pixman, seatd, Wayland, and Wayland-Protocols

Recommended

wf-config-0.9.0 (if not installed, it will be downloaded from the internet), XCB Utilities, Xorg Libraries, and Xwayland

Optional

doctest (for tests) and wlroots (the newest version cannot be used)

Installation of Wayfire

Install Wayfire by running the following commands: 

mkdir build &&
cd    build &&

meson setup --prefix=/usr                  \
            --buildtype=release            \
            -D use_system_wfconfig=enabled \
            -D tests=disabled              \
            .. &&

ninja

Now, as the root user: 

ninja install

Copy the default configuration file to /usr/share/wayfire as the root user: 

cp -v ../wayfire.ini /usr/share/wayfire

Command Explanations

-D use_system_wfconfig=enabled: This parameter ensures the system-installed wf-config-0.9.0.

-D tests=disabled: This parameter disables building unit tests.

Configuring Wayfire

Config Files

~/.config/wayfire.ini. The default version is in /usr/share/wayfire and will not be used and must be copied to ~/.config

Configuration Information

Create the config file: 

cp /usr/share/wayfire/wayfire.ini ~/.config

Now inspect the file and make any changes to suit your workflow. If you need to know which plugins are installed, check for the Installed Plugins below [3].

Contents

Installed Programs: wayfire
Installed Libraries: libwayfire-blur-base.so, libwf-util.so, and libwftouch.a
Installed Plugins: alpha, animate, autostart, blur, command, cube, decoration, default-config-backend, demo-ipc, expo, extra-gestures, fast-switcher, fisheye, foreign-toplevel, grid, gtk-shell, idle, input-method-v1, invert, ipc-rules, ipc, move, oswitch, place, preserve-output, resize, scale, scale-title-filter, session-lock, shortcuts-inhibit, simple-tile, stipc, switcher, swipe, vswitch, wayfire-shell, window-rules, wm-actions, wobbly, wrot, wsets, xdg-activation, xkb-bindings, and zoom
Installed Directories: /usr/lib/wayfire

Short Descriptions

wayfire

is the Wayfire compositor

libwayfire-blur-base.so

provides basic functions for blur implementations in Wayfire

libwf-utils.so

contains several functions used by Wayfire and its libraries

libwftouch.a

is the static library for Wayfire touch functionality


[3] The real names look like lib<PLUGIN>.so in /usr/lib/wayfire