Supplemental Linux® From Scratch (System V Edition) - Version #f128

Chapter 19. Wayfire

Wayfire-0.10.1

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.

[Note]

Note

An Internet connection is needed for building this package. The system certificate store may need to be set up with make-ca before building this package.

Wayfire Dependencies

Required

Cairo, GBM (libgbm or Mesa), GLM, FreeType2, libdrm, libevdev, libinput, libjpeg-turbo, libpng, libxkbcommon, nlohmann-json-3.12.0, OpenGL + EGL + GLESv2 (libglvnd or Mesa; Mesa's GL is not supported), Pango (with Cairo), Pixman, Wayland, Wayland-Protocols, wlroots-0.19.2, and yyjson-0.12.0

Recommended

wf-config-0.10.0 (if not installed, it will be downloaded from the internet) and Xorg Libraries

Optional

doxygen, libnotify, doctest (for tests), and libinotify

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

Remove some useless static libraries as the root user: 

rm -vf /usr/lib/libwftouch.a \
       /usr/lib/libwayfire-{move-drag-interface,workspace-wall}.a

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

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

Command Explanations

--buildtype=release: Specify a buildtype suitable for stable releases of the package, as the default may produce unoptimized binaries.

-D use_system_wfconfig=enabled: This parameter ensures the system-installed wf-config-0.10.0 is used during compilation.

-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

Copy the default configuration 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, examine the list of Installed Plugins below.

Contents

Installed Programs: wayfire
Installed Libraries: libwayfire-blur-base and libwf-utils
Installed Plugins: alpha, animate, autostart, blur, command, cube, decoration, default-config-backend, 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, vk-color-management, vswitch, wayfire-shell, window-rules, wm-actions, wobbly, wrot, wsets, xdg-activation, xkb-bindings, and zoom
Installed Directories: /usr/include/wayfire, /usr/lib/wayfire, and /usr/share/wayfire

Short Descriptions

wayfire

is the Wayfire compositor

libwayfire-blur-base

provides basic functions for blur implementations in Wayfire

libwf-utils

contains several functions used by Wayfire and its libraries