mirrors/labwc
1
0
Fork 0
mirror of https://github.com/labwc/labwc.git synced 2025-10-29 05:40:24 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
A Wayland window-stacking compositor https://labwc.github.io
283 commits 6 branches 29 tags 16 MiB
Find a file
Johan Malm cfc6e18cdc Make xwayland support optional
2020-12-30 10:29:21 +00:00
docs docs/rc.xml: use Clearlooks-3.4 2020-11-23 21:23:33 +00:00
include Make xwayland support optional 2020-12-30 10:29:21 +00:00
protocols Update layer-shell protocol 1.2 -> 1.3 2020-10-28 21:08:21 +00:00
src Make xwayland support optional 2020-12-30 10:29:21 +00:00
.gitignore desktop: rename desktop_cycle_view() 2020-10-31 14:46:33 +00:00
LICENSE Initial commit 2019-05-11 21:21:58 +01:00
meson.build Make xwayland support optional 2020-12-30 10:29:21 +00:00
meson_options.txt Make xwayland support optional 2020-12-30 10:29:21 +00:00
README.md Make xwayland support optional 2020-12-30 10:29:21 +00:00

README.md

labwc

1. What is this?

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

It has the following aims:

  • Be light-weight, small and fast
  • Have the look and feel of 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

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

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

The following were considered before choosing wlroots: qtwayland, grefsen, mir and egmde.

2. Build

meson build && ninja -C build

Dependencies include:

  • meson, ninja
  • wlroots (>=0.11.0)
  • wayland (>=1.16)
  • wayland-protocols
  • xwayland, xcb (optional)
  • libinput (>=1.14)
  • libxml2
  • cairo, pango, glib-2.0
  • xcb
  • xkbcommon

Disable xwayland with meson -Dxwayland=disabled build

For further details see wiki/Build.

3. Configure

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

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

See full details in the following:

4. Run

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

If you have not created an rc.xml configuration file, default keybinds will be:

  • Alt-tab: cycle window
  • Alt-F2: cycle window
  • Alt-F3: launch dmenu
  • Alt-escape: exit

5. Integrate

Suggested apps to use with labwc:

6. Roadmap

No acceptance criteria exists, but the following list indicates the inteded high level roadmap:

  • Optionally support xwayland
  • Parse openbox config files (rc.xml, autostart, environment)
  • Parse openbox themes files and associated xbm icons
  • Show maximize, iconify, close buttons
  • Catch SIGHUP to re-load config file and theme
  • Support layer-shell protocol ('exclusive' not yet implemented)
  • Support root-menu and parse menu.xml (very simple implementation, not submenus yet)
  • Support damage tracking to reduce CPU usage
  • Support 'maximize'
  • Support wlr-output-management protocol and kanshi
  • Support foreign-toplevel protocol (e.g. to integrate with wlroots panels/bars)
  • Implement client-menu
  • Support on-screen display (osd), for example to support alt-tab window list
  • Support HiDPI
  • Support libinput configuration (tap is enabled for the time being)

7. Scope

In order to keep the code base clean and maintainable, simplicy is favoured over full specification adherence.

In-scope

Refer to these wiki pages for a more detailed scope definition against the openbox documentation.

Track progress against the above specification.

Out-of-scope

The following items are out-of-scope:

  • 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