A Wayland desktop shell with the bar, notifications, OSD, wallpaper, and device controls built in. Written in Rust with GTK4 and Relm4.
Lumen is arranged as a single Rust workspace. The service crates live locally under crates/, so app and service changes can be developed from one checkout.
Configure it in config.toml, through the lumen-settings GUI, or with the lumen config CLI.
Full guides, reference, and walkthroughs are at lumen.cybex.net.
- Getting started - Installation instructions
- Editing config - File layout, live reload, imports, CLI editing
- Bars and layouts - Per monitor layouts, groups, classes
- Themes - Color tokens, theme files
- Custom icons - Installing icons, icon sources
- Custom modules - Shell-backed bar modules
- CLI - Every subcommand
- Config reference - Full config documentation
Lumen isn't packaged for any distro yet, so install it from source. Native packages (AUR and others) are planned.
First install the system dependencies for your distro:
Arch
Install Rust via rustup, then the system libraries:
sudo pacman -S --needed git gtk4 gtk4-layer-shell gtksourceview5 \
libpulse fftw libpipewire systemd-libs clang base-develRuntime daemons for the battery, bluetooth, network, power, and audio modules (skip any you don't need):
sudo pacman -S --needed bluez bluez-utils networkmanager upower \
power-profiles-daemon pipewire wireplumber pipewire-pulse
sudo systemctl enable --now bluetooth NetworkManager upower power-profiles-daemonDebian / Ubuntu
Ubuntu 24.04 LTS does not package libgtk4-layer-shell-dev. Use Ubuntu 25.04+ or Debian 13 (trixie).
Install Rust via rustup, then the system libraries:
sudo apt install git pkg-config cmake libgtk-4-dev libgtk4-layer-shell-dev \
libgtksourceview-5-dev libpulse-dev libfftw3-dev libpipewire-0.3-dev \
libudev-dev clang build-essentialRuntime daemons:
sudo apt install dbus-user-session bluez network-manager \
upower power-profiles-daemon pipewire-pulse wireplumber
sudo systemctl enable --now bluetooth NetworkManager upower power-profiles-daemonFedora
Requires Fedora 42 or later.
Install Rust via rustup, then the system libraries:
sudo dnf install git cmake pkgconf-pkg-config gtk4-devel gtk4-layer-shell-devel \
gtksourceview5-devel pulseaudio-libs-devel fftw-devel pipewire-devel \
systemd-devel clang gccFedora Workstation already ships the runtime daemons. Minimal and Server installs need:
sudo dnf install pipewire-pulseaudio wireplumber NetworkManager bluez upower \
power-profiles-daemon
sudo systemctl enable --now bluetooth NetworkManager upower power-profiles-daemongit clone https://github.com/DigitalPals/Lumen.git Lumen
cd Lumen
cargo install --path lumen
cargo install --path crates/lumen-settings
lumen icons setup
lumen panel startOn a different distro? See lumen.cybex.net/guide/getting-started for the library-version reference.
The config file is at ~/.config/lumen/config.toml. Changes reload on save:
[bar]
location = "top"
scale = 1.25
[[bar.layout]]
monitor = "*"
left = ["dashboard"]
center = ["clock"]
right = ["volume", "network", "bluetooth", "battery"]
[modules.clock]
format = "%H:%M"Every field is documented at lumen.cybex.net/config.
A Wayland compositor that implements the wlr-layer-shell protocol. Compositor-specific modules currently target Hyprland, Niri and Mango; Sway support is planned.
MIT