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
341 commits 6 branches 29 tags 16 MiB
Find a file
Johan Malm 3a11005d72 Add NEWS.md and update README.md
2021-03-06 11:45:45 +00:00
docs Convert man pages from md to scd 2021-03-05 22:14:02 +00:00
include Handle wlr_surface->events.new_subsurface 2021-03-02 20:37:23 +00:00
protocols Update layer-shell protocol 1.3 -> 1.4 (issue #18) 2021-02-28 17:32:58 +00:00
src main.c: add -v, -V, -d command line options 2021-03-06 11:38:17 +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 main.c: add -v, -V, -d command line options 2021-03-06 11:38:17 +00:00
meson_options.txt Add man-pages option like swaywm/sway@ba16f16e4d 2021-03-04 06:35:15 +00:00
NEWS.md Add NEWS.md and update README.md 2021-03-06 11:45:45 +00:00
README.md Add NEWS.md and update README.md 2021-03-06 11:45:45 +00:00

README.md

labwc

1. What is this?

Labwc is a wlroots-based stacking compositor for Wayland.

It has the following aims:

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

Video (3:42) showing features

2. Build

meson build/
ninja -C build/

Dependencies include:

  • meson, ninja, gcc/clang
  • wlroots (0.11.0 - 0.12.0)
  • wayland (>=1.16)
  • 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. Configure

If you want to override the defaults, create the following files:

See full details in the following:

4. Run

./build/labwc [-s <command>]

Click on the background to launch a menu.

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

  • Alt-tab: cycle window
  • Alt-F3: launch bemenu
  • Alt-escape: exit

5. Integrate

Suggested apps to use with labwc:

6. Roadmap

The following list indicates the intended high level roadmap:

  • Optionally support xwayland
  • Parse openbox config files (rc.xml, autostart, environment)
  • Parse openbox themes files and associated xbm icons
  • Support maximize, iconify, close buttons
  • Catch SIGHUP to re-load config file and theme
  • Support layer-shell protocol
    • Support layer-shell applications
    • Support 'exclusive' zone
  • Support damage tracking to reduce CPU usage
  • Support menus
    • Parse menu.xml and generate root-menu
    • Separators and titles
    • Submenus
    • Pipe-menus
    • Client menus
  • Support wlr-output-management protocol and kanshi
  • Support foreign-toplevel protocol (e.g. to integrate with wlroots panels/bars)
  • 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.

The exact acceptance criteria have not yet been defined, but the following wiki pages give an indication of the intended scope definition against the openbox specification.

The following items are likely to be 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