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 )
2020-11-23 21:22:47 +00:00
- [7. Scope ](#7-scope )
2020-09-01 19:45:36 +01:00
## 1. What is this?
2020-11-01 22:21:24 +00:00
Labwc is a [WIP] free, stacking compositor for Wayland based on wlroots.
It has the following aims:
2020-07-07 21:45:44 +01:00
- Be light-weight, small and fast
2020-11-23 21:22:47 +00:00
- Have the look and feel of [openbox ](https://github.com/danakj/openbox ) albeit
with smaller feature set
- Where practicable, use clients to show wall-paper, take screenshots, and so on
- Stay in keeping with wlroots and sway in terms of approach and coding style
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-11-01 22:21:24 +00:00
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-09-01 19:45:36 +01:00
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-11-01 22:21:24 +00:00
Dependencies include:
2020-08-17 21:26:03 +01:00
2020-11-01 22:21:24 +00:00
- meson, ninja
2020-12-23 18:38:49 +00:00
- wlroots (>=0.11.0)
2020-12-21 18:51:31 +00:00
- wayland (>=1.16)
- wayland-protocols
2020-12-30 10:29:21 +00:00
- xwayland, xcb (optional)
2020-12-21 18:51:31 +00:00
- libinput (>=1.14)
2020-08-17 21:26:03 +01:00
- libxml2
2020-11-01 22:21:24 +00:00
- cairo, pango, glib-2.0
2020-10-07 21:40:53 +01:00
- xcb
- xkbcommon
2020-12-30 10:29:21 +00:00
Disable xwayland with `meson -Dxwayland=disabled build`
2020-10-07 21:40:53 +01:00
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-11-01 22:21:24 +00:00
- Alt-F2: cycle window
- Alt-F3: launch dmenu
2020-09-11 21:01:47 +01:00
- Alt-escape: exit
2020-09-01 19:45:36 +01:00
## 5. Integrate
Suggested apps to use with labwc:
2020-10-28 21:06:30 +00:00
- [grim ](https://github.com/emersion/grim ) - Screenshoter
- [wf-recorder ](https://github.com/ammen99/wf-recorder ) - Screen-recorder
- [swaybg ](https://github.com/swaywm/swaybg ) - Background image
2020-09-30 17:18:20 +01:00
- [waybar ](https://github.com/Alexays/Waybar ) - Panel
2020-10-28 21:06:30 +00:00
- [bemenu ](https://github.com/Cloudef/bemenu ) - Launcher
- [fuzzel ](https://codeberg.org/dnkl/fuzzel ) - Launcher
- [wofi ](https://hg.sr.ht/~scoopta/wofi ) - Launcher
2020-09-01 19:45:36 +01:00
## 6. Roadmap
2020-05-18 21:01:01 +01:00
2020-11-01 22:21:24 +00:00
No acceptance criteria exists, but the following list indicates the inteded high level roadmap:
2020-12-30 10:29:21 +00:00
- [x] Optionally support xwayland
2020-11-01 22:21:24 +00:00
- [x] Parse openbox config files (rc.xml, autostart, environment)
2020-12-23 18:38:49 +00:00
- [x] Parse openbox themes files 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-11-01 22:21:24 +00:00
- [x] Support layer-shell protocol ('exclusive' not yet implemented)
- [ ] Support root-menu and parse menu.xml (very simple implementation, not submenus yet)
2020-12-30 10:29:21 +00:00
- [ ] Support damage tracking to reduce CPU usage
2020-09-21 19:51:16 +01:00
- [ ] Support 'maximize'
2020-11-01 22:21:24 +00:00
- [ ] Support wlr-output-management protocol and [kanshi ](https://github.com/emersion/kanshi.git )
2020-09-21 19:51:16 +01:00
- [ ] Support foreign-toplevel protocol (e.g. to integrate with wlroots panels/bars)
2020-06-19 22:09:29 +01:00
- [ ] Implement client-menu
2020-11-01 22:21:24 +00:00
- [ ] Support on-screen display (osd), for example to support alt-tab window list
- [ ] Support HiDPI
2020-12-30 10:29:21 +00:00
- [ ] Support libinput configuration (tap is enabled for the time being)
2020-05-18 21:01:01 +01:00
2020-11-23 21:22:47 +00:00
## 7. Scope
2020-11-01 22:21:24 +00:00
In order to keep the code base clean and maintainable, simplicy is favoured over full specification adherence.
2020-11-23 22:14:32 +00:00
### In-scope
2020-12-23 18:38:49 +00:00
Refer to these wiki pages for a more detailed scope definition against the openbox documentation.
2020-12-21 18:51:31 +00:00
- [configuration ](https://github.com/johanmalm/labwc/wiki/Scope-configuration )
2020-12-23 18:38:49 +00:00
- [theme specification ](https://github.com/johanmalm/labwc/wiki/Scope-theme-specification )
2020-12-21 18:51:31 +00:00
- [actions ](https://github.com/johanmalm/labwc/wiki/Scope-actions )
2020-11-23 22:14:32 +00:00
2020-12-23 18:38:49 +00:00
Track [progress ](https://github.com/johanmalm/labwc/wiki/Scope-progress ) against the above specification.
2020-11-23 22:14:32 +00:00
### Out-of-scope
2020-11-01 22:21:24 +00:00
The following items are out-of-scope:
2020-09-21 19:51:16 +01:00
2020-11-01 22:21:24 +00:00
- Icons (except window buttons)
- Animations
- Gradients on window decorations and menus
- Any theme option (probably at least half of them) not required to reasonably render common themes
- Any configuration option not required to provide a simple openbox-like experience
- Multiple desktops
2020-09-21 19:51:16 +01:00
