labwc/README.md

labwc

• 1. What is this?
• 2. Build
• 3. Configure
• 4. Run
• 5. Integrate
• 6. Roadmap

1. What is this?

Labwc is a [WIP] free, stacking compositor for Wayland and has the following aims:

• Be light-weight, small and fast
• Have the look and feel of openbox
• Where practicable, use other software to show wall-paper, take screenshots, and so on

It is in early development, so expect bugs and missing features.

Labwc has been inspired and influenced by openbox, sway, cage, wio and rootston

Labwc is based on the wlroots library. The following were considered before choosing wlroots: qtwayland, grefsen, mir and egmde.

2. Build

meson build && ninja -C build

Runtime dependencies include:

• wlroots (>=0.10.0)
• xwayland
• libxml2
• cairo
• pango

For further details see tools/build and wiki/Build.

3. Configure

See rc.xml and themerc comments for details including keybinds.

If you want to override the defaults, copy data/rc.xml to ~/.config/labwc/ and tweak to suit.

Full details in labwc(1) and labwc(5)

4. Run

./build/labwc -s <some-application>

5. Integrate

Suggested apps to use with labwc:

• grim - Take screenshot

6. Roadmap

• Support xwayland
• Parse rc.xml
• Parse themerc
• Read xbm icons
• Show maximize, minimize, close buttons
• Give actions to maximize, minimize, close buttons
• Add grip
• Support layer-shell background (e.g. using swaybg)
• Draw better alt-tab rectangle
• Try restarting and consider catching SIGHUP for --reconfigure
• Implement client-menu
• Implement root-menu

For further details see wiki/Roadmap.