mirror of
https://github.com/labwc/labwc.git
synced 2025-11-03 09:01:51 -05:00
183 lines
6.6 KiB
Markdown
183 lines
6.6 KiB
Markdown
# labwc
|
|
|
|
- [1. What is this?](#1-what-is-this)
|
|
- [2. Build](#2-build)
|
|
- [3. Install](#3-install)
|
|
- [4. Configure](#4-configure)
|
|
- [5. Run](#5-run)
|
|
- [6. Integrate](#6-integrate)
|
|
- [7. Roadmap](#7-roadmap)
|
|
- [8. Contribute](#7-contribute)
|
|
|
|
## 1. What is this?
|
|
|
|
Labwc stands for Lab Wayland Compositor, with lab indicating a sense of experimentation and treading new ground.
|
|
|
|
It is a wlroots-based stacking compositor aiming to be light-weight and independent, with a focus on simply stacking windows well and rendering some window decorations. It relies on clients for wall-paper, panels, screenshots, and so on to create a full desktop environment.
|
|
|
|
Labwc tries to stay in keeping with wlroots and sway in terms of general approach and coding style.
|
|
|
|
In order to avoid re-inventing configuration & theme syntax, [openbox-3.4] specification is used. This does not mean that labwc is an openbox clone but rather that configuration files will look and feel familiar.
|
|
|
|
| video link | date | content
|
|
| -------------- | ------------| -------
|
|
| [Video (1:10)] | 05-Aug-2021 | window gymnastics, theming and waybar
|
|
| [Video (3:42)] | 25-Feb-2021 | setting background and themes; xwayland/xdg-shell windows
|
|
|
|
<a href="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot3.png">
|
|
<img src="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot3x.png" width="256px" height="179px">
|
|
</a>
|
|
|
|
So far, labwc supports the following:
|
|
|
|
- [x] Config files (rc.xml, autostart, environment)
|
|
- [x] Theme files and xbm icons
|
|
- [x] Damage tracking to reduce CPU usage
|
|
- [x] A basic root-menu (configured with menu.xml)
|
|
- [x] HiDPI
|
|
- [x] wlr-output-management protocol
|
|
- [x] layer-shell protocol
|
|
- [x] foreign-toplevel protocol (e.g. to integrate with panels and bars)
|
|
- [x] Optionally xwayland
|
|
|
|
## 2. Build
|
|
|
|
meson build/
|
|
ninja -C build/
|
|
|
|
Dependencies include:
|
|
|
|
- meson, ninja, gcc/clang
|
|
- wlroots (master)
|
|
- wayland (>=1.19)
|
|
- wayland-protocols
|
|
- libinput (>=1.14)
|
|
- libxml2
|
|
- cairo, pango, glib-2.0
|
|
- xkbcommon
|
|
- xwayland, xcb (optional)
|
|
|
|
Disable xwayland with `meson -Dxwayland=disabled build/`
|
|
|
|
For further details see [wiki/Build].
|
|
|
|
## 3. Install
|
|
|
|
See [wiki/Install](https://github.com/johanmalm/labwc/wiki/Install).
|
|
|
|
## 4. Configure
|
|
|
|
Labwc uses the files listed below for configuration and theming.
|
|
|
|
| file | user over-ride location | man page
|
|
| ------------- | ----------------------------------------------- | --------
|
|
| [rc.xml] | ~/.config/labwc/ | [labwc-config(5)], [labwc-actions(5)]
|
|
| [menu.xml] | ~/.config/labwc/ | [labwc-menu(5)]
|
|
| [autostart] | ~/.config/labwc/ | [labwc(1)]
|
|
| [environment] | ~/.config/labwc/ | [labwc-environment(5)]
|
|
| [themerc] | ~/.local/share/themes/\<theme-name\>/openbox-3/ | [labwc-theme(5)]
|
|
|
|
The example [rc.xml] has been kept simple. For all options and default values, see [rc.xml.all]
|
|
|
|
Configuration and theme files are re-loaded on receiving SIGHUP (e.g. `killall -SIGHUP labwc`)
|
|
|
|
For keyboard settings, see [environment] and [xkeyboard-config(7)]
|
|
|
|
For themes, search the internet for "openbox themes" and place them in `~/.local/share/themes/`. Some good starting points include:
|
|
|
|
- https://github.com/addy-dclxvi/openbox-theme-collections
|
|
- https://github.com/the-zero885/Lubuntu-Arc-Round-Openbox-Theme
|
|
- https://bitbucket.org/archlabslinux/themes/
|
|
- https://github.com/BunsenLabs/bunsen-themes
|
|
|
|
## 5. Run
|
|
|
|
./build/labwc [-s <command>]
|
|
|
|
Click on the background to launch a menu.
|
|
|
|
If you have not created an rc.xml config file, default binds will be:
|
|
|
|
| combination | action
|
|
| ------------------- | ------
|
|
| `alt`-`tab` | activate next window
|
|
| `alt`-`escape` | exit
|
|
| `super`-`return` | alacritty
|
|
| `alt`-`F3` | bemenu
|
|
| `alt`-`F4` | close window
|
|
| `super`-`a` | toggle maximize
|
|
| `alt`-`mouse-left` | move window
|
|
| `alt`-`mouse-right` | resize window
|
|
| `alt`-`arrow` | move window to edge
|
|
|
|
## 6. Integrate
|
|
|
|
Suggested apps to use with labwc:
|
|
|
|
- Screen shooter: [grim]
|
|
- Screen recorder: [wf-recorder]
|
|
- Background image: [swaybg]
|
|
- Panel: [waybar]
|
|
- Launchers: [bemenu], [fuzzel], [wofi]
|
|
- Output managers: [kanshi], [wlr-randr]
|
|
- Screen locker: [swaylock]
|
|
|
|
## 7. Roadmap
|
|
|
|
A lot of emphasis is put on code simplicy when considering features.
|
|
|
|
The main development effort if focused on producing a solid foundation for a
|
|
stacking compositor rather than adding configuration and theming options.
|
|
|
|
See [acceptance criteria] for details.
|
|
|
|
High-level summary of items which are not inteded to be implemented:
|
|
|
|
- Icons (except window buttons)
|
|
- Animations
|
|
- Gradients for decoration and menus
|
|
- Any theme option not required to reasonably render common themes (it's amazing
|
|
how few options are actually required).
|
|
|
|
## 8. Contribute
|
|
|
|
Let's try to stick to this [coding style]
|
|
|
|
[openbox-3.4]: https://github.com/danakj/openbox
|
|
|
|
[rc.xml]: docs/rc.xml
|
|
[rc.xml.all]: docs/rc.xml.all
|
|
[menu.xml]: docs/menu.xml
|
|
[autostart]: docs/autostart
|
|
[environment]: docs/environment
|
|
[themerc]: docs/themerc
|
|
|
|
[labwc(1)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc.1.scd
|
|
[labwc-config(5)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-config.5.scd
|
|
[labwc-menu(5)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-menu.5.scd
|
|
[labwc-environment(5)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-environment.5.scd
|
|
[labwc-theme(5)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-theme.5.scd
|
|
[labwc-actions(5)]: https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-actions.5.scd
|
|
[xkeyboard-config(7)]: https://manpages.debian.org/testing/xkb-data/xkeyboard-config.7.en.html
|
|
|
|
[wiki/Build]: https://github.com/johanmalm/labwc/wiki/Build
|
|
|
|
[grim]: https://github.com/emersion/grim
|
|
[wf-recorder]: https://github.com/ammen99/wf-recorder
|
|
[swaybg]: https://github.com/swaywm/swaybg
|
|
[waybar]: https://github.com/Alexays/Waybar
|
|
[bemenu]: https://github.com/Cloudef/bemenu
|
|
[fuzzel]: https://codeberg.org/dnkl/fuzzel
|
|
[wofi]: https://hg.sr.ht/~scoopta/wofi
|
|
[kanshi]: https://github.com/emersion/kanshi.git
|
|
[wlr-randr]: https://github.com/emersion/wlr-randr.git
|
|
[swaylock]: https://github.com/swaywm/swaylock
|
|
|
|
[acceptance criteria]: https://github.com/johanmalm/labwc/wiki/Acceptance-criteria
|
|
[complete]: https://github.com/johanmalm/labwc/wiki/Minimum-viable-product-complete-items
|
|
[outstanding]: https://github.com/johanmalm/labwc/wiki/Minimum-viable-product-outstanding-items
|
|
|
|
[Video (1:10)]: https://youtu.be/AU_M3n_FS-E
|
|
[Video (3:42)]: https://youtu.be/rE1bQjSVJzg
|
|
|
|
[coding style]: https://git.sr.ht/~sircmpwn/cstyle
|