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

Simon Ser's avatar
Simon Ser committed
3
4
Pluggable, composable, unopinionated modules for building a [Wayland]
compositor; or about 50,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.
Drew DeVault's avatar
Drew DeVault committed
33

Simon Ser's avatar
Simon Ser committed
34
35
36
wlroots is developed under the direction of the [sway] project. 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
45
46
* wayland
* wayland-protocols
* EGL
* GLESv2
Drew DeVault's avatar
Drew DeVault committed
47
* libdrm
48
49
* GBM
* libinput
Drew DeVault's avatar
Drew DeVault committed
50
* xkbcommon
51
* udev
52
* pixman
53
* libseat (optional, for seatd support)
54
* systemd (optional, for logind support)
Dudemanguy's avatar
Dudemanguy committed
55
* elogind (optional, for logind support on systems without systemd)
56
* libuuid (optional, for xdg-foreign support)
Drew DeVault's avatar
Drew DeVault committed
57
58
59

If you choose to enable X11 support:

60
* xwayland (build-time only, optional at runtime)
Kurt Kartaltepe's avatar
Kurt Kartaltepe committed
61
62
63
* xcb
* xcb-composite
* xcb-xfixes
64
* xcb-xinput
Simon Ser's avatar
Simon Ser committed
65
* xcb-icccm
Kurt Kartaltepe's avatar
Kurt Kartaltepe committed
66
67
* xcb-image
* xcb-render
Drew DeVault's avatar
Drew DeVault committed
68
* xcb-errors (optional, for improved error reporting)
69
70
71

Run these commands:

72
73
    meson build/
    ninja -C build/
unrelentingtech's avatar
unrelentingtech committed
74

Drew DeVault's avatar
Drew DeVault committed
75
Install like so:
Tony Crisci's avatar
Tony Crisci committed
76

77
    sudo ninja -C build/ install
Tony Crisci's avatar
Tony Crisci committed
78

Drew DeVault's avatar
Drew DeVault committed
79
## Contributing
Tony Crisci's avatar
Tony Crisci committed
80

Simon Ser's avatar
Simon Ser committed
81
82
83
84
85
86
87
See [CONTRIBUTING.md].

[Wayland]: https://wayland.freedesktop.org/
[wiki]: https://github.com/swaywm/wlroots/wiki/Getting-started
[Sway]: https://github.com/swaywm/sway
[wrapper libraries]: https://github.com/search?q=topic%3Abindings+org%3Aswaywm&type=Repositories
[CONTRIBUTING.md]: https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md