labwc/README.md

# labwc

Labwc is a [WIP] free, stacking compositor for Wayland.

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

Labwc 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

- [Dependencies](#dependencies)
- [Roadmap](#roadmap)
- [Inspiration](#inspiration)
- [Design](#design)
- [Configuration](#configuration)
- [Integration](#integration)
- [Build](#build)

## Dependencies

Runtime dependencies include wlroots (>=0.10.0), wayland-protocols,xwayland,
libxml2, glib-2.0, cairo and pango.

## Roadmap

- [x] Support xwayland
- [x] Parse [rc.xml](data/rc.xml)
- [x] Parse [themerc](data/themerc)
- [x] Read xbm icons
- [x] Add 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

## Inspiration

Labwc has been inspired and inflenced by [openbox](https://github.com/danakj/openbox), [sway](https://github.com/swaywm/sway), [cage](https://www.hjdskes.nl/blog/cage-01/), [wio](https://wio-project.org/) and [rootston](https://github.com/swaywm/rootston)

## Design

Labwc is based on the wlroots library.

The following were considered before choosing wlroots: [QtWayland](https://github.com/qt/qtwayland), [grefsen](https://github.com/ec1oud/grefsen), [Mir](https://mir-server.io) and [egmde](https://github.com/AlanGriffiths/egmde).

## Configuration

See [rc.xml](data/rc.xml) and [themerc](data/themerc) comments for details
incl. keybinds.

## Integration

Suggested apps:

- grim - screenshots

## Build

    meson build && ninja -C build

To enable ASAN and UBSAN, run meson with `-Db_sanitize=address,undefined`

For further details see [wiki/Build](https://github.com/labwc/wiki/Build).