2019-05-12 21:44:41 +01:00
# labwc
2020-09-01 19:45:36 +01:00
- [1. What is this? ](#1-what-is-this )
- [2. Build ](#2-build )
- [3. Configure ](#3-configure )
- [4. Run ](#4-run )
- [5. Integrate ](#5-integrate )
- [6. Roadmap ](#6-roadmap )
## 1. What is this?
2020-07-08 16:57:41 +01:00
Labwc is a [WIP] free, stacking compositor for Wayland and has the following aims:
2020-07-07 21:45:44 +01:00
- Be light-weight, small and fast
2020-09-01 19:45:36 +01:00
- Have the look and feel of [openbox ](https://github.com/danakj/openbox )
2020-06-05 21:07:05 +01:00
- Where practicable, use other software to show wall-paper, take screenshots,
2020-07-07 21:45:44 +01:00
and so on
2019-05-12 21:44:41 +01:00
2020-07-08 16:57:41 +01:00
It is in early development, so expect bugs and missing features.
2020-09-01 19:45:36 +01:00
Labwc has been inspired and influenced 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 )
2020-07-08 16:57:41 +01:00
2020-09-01 19:45:36 +01:00
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 ).
2020-10-12 16:27:35 +01:00
2020-07-08 16:57:41 +01:00
2020-09-01 19:45:36 +01:00
## 2. Build
2019-05-12 21:44:41 +01:00
2020-09-01 19:45:36 +01:00
meson build & & ninja -C build
2020-05-30 21:28:17 +01:00
2020-10-15 21:08:49 +01:00
Build dependencies include:
2020-08-17 21:26:03 +01:00
2020-10-15 21:08:49 +01:00
- meson
2020-08-17 21:26:03 +01:00
- wlroots (>=0.10.0)
2020-10-15 21:08:49 +01:00
- wayland
- wayland-protocols
2020-08-17 21:26:03 +01:00
- xwayland
- libxml2
- cairo
- pango
2020-10-15 21:08:49 +01:00
- glib-2.0
2020-10-07 21:40:53 +01:00
- xcb
- xkbcommon
For further details see [wiki/Build ](https://github.com/johanmalm/labwc/wiki/Build ).
2020-09-01 19:45:36 +01:00
## 3. Configure
2020-09-03 21:06:08 +01:00
If you want to override the defaults, copy data/rc.xml to ~/.config/labwc/ and tweak to suit.
2020-09-28 21:09:19 +01:00
See [rc.xml ](docs/rc.xml ) and [themerc ](docs/themerc ) comments for details including keybinds.
2020-09-01 19:45:36 +01:00
2020-09-03 21:06:08 +01:00
See full details in the following:
2020-09-01 19:45:36 +01:00
2020-09-03 21:06:08 +01:00
- [labwc(1) ](docs/labwc.1.md )
- [labwc-config(5) ](docs/labwc-config.5.md )
- [labwc-theme(5) ](docs/labwc-theme.5.md )
- [labwc-actions(5) ](docs/labwc-actions.5.md )
2020-09-01 19:45:36 +01:00
## 4. Run
./build/labwc -s < some-application >
2020-09-11 21:01:47 +01:00
If you have not created an rc.xml configuration file, default keybinds will be:
- Alt-tab: cycle window
2020-09-21 20:02:29 +01:00
- Alt-F2: cycle window (useful if running under X11 and alt-tab is already bound to something)
2020-09-11 21:01:47 +01:00
- Alt-F3: launch dmenu (if installed)
- Alt-escape: exit
2020-09-01 19:45:36 +01:00
## 5. Integrate
Suggested apps to use with labwc:
- [grim ](https://github.com/emersion/grim ) - Take screenshot
2020-09-21 20:02:29 +01:00
- [wf-recorder ](https://github.com/ammen99/wf-recorder ) - Record screen
2020-09-30 17:18:20 +01:00
- [swaybg ](https://github.com/swaywm/swaybg ) - Set background image
- [waybar ](https://github.com/Alexays/Waybar ) - Panel
2020-09-01 19:45:36 +01:00
## 6. Roadmap
2020-05-18 21:01:01 +01:00
2020-05-22 21:13:43 +01:00
- [x] Support xwayland
2020-10-08 20:50:20 +01:00
- [x] Parse ~/.config/labwc/{rc.xml,autostart,environment}
2020-10-09 19:56:48 +01:00
- [x] Parse /usr/share/themes/`<name>` /openbox-3/themerc and associated xbm icons
2020-09-21 19:51:16 +01:00
- [x] Show maximize, iconify, close buttons
2020-10-08 20:50:20 +01:00
- [x] Catch SIGHUP to re-load config file and theme
2020-09-30 17:18:20 +01:00
- [x] Support layer-shell protocol (partial)
2020-09-21 19:51:16 +01:00
- [ ] Support 'maximize'
- [ ] Show window title
- [ ] Support foreign-toplevel protocol (e.g. to integrate with wlroots panels/bars)
- [ ] Support damage control to reduce CPU usage
2020-06-19 22:09:29 +01:00
- [ ] Implement client-menu
- [ ] Implement root-menu
2020-09-21 19:51:16 +01:00
- [ ] Support on-screen display (OSD), for example to support alt-tab window list
2020-09-30 17:18:20 +01:00
- [ ] Support [kanshi ](https://github.com/emersion/kanshi.git )
2020-05-18 21:01:01 +01:00
2020-07-09 22:41:54 +01:00
For further details see [wiki/Roadmap ](https://github.com/johanmalm/labwc/wiki/Roadmap ).
2020-09-21 19:51:16 +01:00
Based on development so far, it looks like only a modest fraction of all theme and configuration options are required to adequately render most common themes and provide a pretty openbox-like experience.
It is likely that only a subset of the full specification will be implemented in order to keep the code base simpler and cleaner.
