README.md 2.98 KB
Newer Older
1
# wlroots
Drew DeVault's avatar
Drew DeVault committed
2

Simon Ser's avatar
Simon Ser committed
3
Pluggable, composable, unopinionated modules for building a [Wayland]
buffet's avatar
buffet committed
4
compositor; or about 60,000 lines of code you were going to write anyway.
Drew DeVault's avatar
Drew DeVault committed
5

Drew DeVault's avatar
Drew DeVault committed
6
- wlroots provides backends that abstract the underlying display and input
Simon Ser's avatar
Simon Ser committed
7
8
9
  hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends,
  plus any custom backends you choose to write, which can all be created or
  destroyed at runtime and used in concert with each other.
Drew DeVault's avatar
Drew DeVault committed
10
- wlroots provides unopinionated, mostly standalone implementations of many
Simon Ser's avatar
Simon Ser committed
11
12
13
  Wayland interfaces, both from wayland.xml and various protocol extensions.
  We also promote the standardization of portable extensions across
  many compositors.
Drew DeVault's avatar
Drew DeVault committed
14
- wlroots provides several powerful, standalone, and optional tools that
Simon Ser's avatar
Simon Ser committed
15
16
  implement components common to many compositors, such as the arrangement of
  outputs in physical space.
Drew DeVault's avatar
Drew DeVault committed
17
- wlroots provides an Xwayland abstraction that allows you to have excellent
Simon Ser's avatar
Simon Ser committed
18
19
  Xwayland support without worrying about writing your own X11 window manager
  on top of writing your compositor.
Drew DeVault's avatar
Drew DeVault committed
20
- wlroots provides a renderer abstraction that simple compositors can use to
Simon Ser's avatar
Simon Ser committed
21
22
  avoid writing GL code directly, but which steps out of the way when your
  needs demand custom rendering code.
Drew DeVault's avatar
Drew DeVault committed
23

Drew DeVault's avatar
Drew DeVault committed
24
25
26
wlroots implements a huge variety of Wayland compositor features and implements
them *right*, so you can focus on the features that make your compositor
unique. By using wlroots, you get high performance, excellent hardware
morganamilo's avatar
morganamilo committed
27
compatibility, broad support for many wayland interfaces, and comfortable
Drew DeVault's avatar
Drew DeVault committed
28
29
30
31
development tools - or any subset of these features you like, because all of
them work independently of one another and freely compose with anything you want
to implement yourself.

Simon Ser's avatar
Simon Ser committed
32
Check out our [wiki] to get started with wlroots. Join our IRC channel:
33
[#sway-devel on Libera Chat].
Drew DeVault's avatar
Drew DeVault committed
34

35
36
A variety of [wrapper libraries] are available for using it with your favorite
programming language.
37
38
39
40
41

## Building

Install dependencies:

Drew DeVault's avatar
Drew DeVault committed
42
* meson
43
44
* wayland
* wayland-protocols
Simon Ser's avatar
Simon Ser committed
45
46
* EGL and GLESv2 (optional, for the GLES2 renderer)
* Vulkan loader, headers and glslang (optional, for the Vulkan renderer)
Drew DeVault's avatar
Drew DeVault committed
47
* libdrm
48
* GBM
Simon Ser's avatar
Simon Ser committed
49
* libinput (optional, for the libinput backend)
Drew DeVault's avatar
Drew DeVault committed
50
* xkbcommon
51
* udev
52
* pixman
53
* [libseat]
Drew DeVault's avatar
Drew DeVault committed
54
55
56

If you choose to enable X11 support:

57
* xwayland (build-time only, optional at runtime)
58
59
60
61
* libxcb
* libxcb-render-util
* libxcb-wm
* libxcb-errors (optional, for improved error reporting)
62
63
64

Run these commands:

65
66
    meson build/
    ninja -C build/
unrelentingtech's avatar
unrelentingtech committed
67

Drew DeVault's avatar
Drew DeVault committed
68
Install like so:
Tony Crisci's avatar
Tony Crisci committed
69

70
    sudo ninja -C build/ install
Tony Crisci's avatar
Tony Crisci committed
71

Drew DeVault's avatar
Drew DeVault committed
72
## Contributing
Tony Crisci's avatar
Tony Crisci committed
73

Simon Ser's avatar
Simon Ser committed
74
75
76
See [CONTRIBUTING.md].

[Wayland]: https://wayland.freedesktop.org/
Simon Ser's avatar
Simon Ser committed
77
[wiki]: https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/Getting-started
Simon Ser's avatar
Simon Ser committed
78
[#sway-devel on Libera Chat]: https://web.libera.chat/gamja/?channels=#sway-devel
79
[wrapper libraries]: https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/Projects-which-use-wlroots#wrapper-libraries
80
[libseat]: https://git.sr.ht/~kennylevinsen/seatd
Simon Ser's avatar
Simon Ser committed
81
[CONTRIBUTING.md]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/CONTRIBUTING.md