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

Drew DeVault's avatar
Drew DeVault committed
3
4
5
Pluggable, composable, unopinionated modules for building a
[Wayland](http://wayland.freedesktop.org/) compositor; or about 40,000 lines of
code you were going to write anyway.
Drew DeVault's avatar
Drew DeVault committed
6

Drew DeVault's avatar
Drew DeVault committed
7
8
9
10
11
12
13
14
- wlroots provides backends that abstract the underlying display and input
	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.
- wlroots provides unopinionated, mostly standalone implementations of many
	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
15
16
17
- wlroots provides several powerful, standalone, and optional tools that
	implement components common to many compositors, such as the arrangement of
	outputs in physical space.
Drew DeVault's avatar
Drew DeVault committed
18
19
20
21
22
23
- wlroots provides an Xwayland abstraction that allows you to have excellent
	Xwayland support without worrying about writing your own X11 window manager
	on top of writing your compositor.
- wlroots provides a renderer abstraction that simple compositors can use to
	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
24

Drew DeVault's avatar
Drew DeVault committed
25
26
27
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
28
compatibility, broad support for many wayland interfaces, and comfortable
Drew DeVault's avatar
Drew DeVault committed
29
30
31
32
33
34
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.

**Status**: prior to 1.0 the API is not stable, but we've done most of the work
and various projects are using wlroots to build Wayland compositors with.
Drew DeVault's avatar
Drew DeVault committed
35

Drew DeVault's avatar
Drew DeVault committed
36
37
38
39
wlroots is developed under the direction of the
[sway](https://github.com/swaywm/sway) project. A variety of wrapper libraries
[are available](https://github.com/swaywm) for using it with your favorite
programming language.
40
41
42
43
44

## Building

Install dependencies:

Drew DeVault's avatar
Drew DeVault committed
45
* meson
46
47
48
49
* wayland
* wayland-protocols
* EGL
* GLESv2
Drew DeVault's avatar
Drew DeVault committed
50
* libdrm
51
52
* GBM
* libinput
Drew DeVault's avatar
Drew DeVault committed
53
* xkbcommon
54
* udev
55
* pixman
56
* systemd (optional, for logind support)
Dudemanguy's avatar
Dudemanguy committed
57
* elogind (optional, for logind support on systems without systemd)
Scott Anderson's avatar
Scott Anderson committed
58
* libcap (optional, for capability support)
Drew DeVault's avatar
Drew DeVault committed
59
60
61

If you choose to enable X11 support:

Kurt Kartaltepe's avatar
Kurt Kartaltepe committed
62
63
64
65
66
* xcb
* xcb-composite
* xcb-xfixes
* xcb-image
* xcb-render
Drew DeVault's avatar
Drew DeVault committed
67
68
69
* x11-xcb
* xcb-errors (optional, for improved error reporting)
* x11-icccm (optional, for improved Xwayland introspection)
Kurt Kartaltepe's avatar
Kurt Kartaltepe committed
70
* xcb-xkb (optional, for improved keyboard handling on the X11 backend)
71
72
73

Run these commands:

Jan Kelling's avatar
Jan Kelling committed
74
75
    meson build
    ninja -C build
unrelentingtech's avatar
unrelentingtech committed
76

77
78
If you use Meson older than 0.48.0 on FreeBSD, you need to pass an extra flag
to prevent a linking error: `meson build -D b_lundef=false`.
Tony Crisci's avatar
Tony Crisci committed
79

Drew DeVault's avatar
Drew DeVault committed
80
Install like so:
Tony Crisci's avatar
Tony Crisci committed
81

Drew DeVault's avatar
Drew DeVault committed
82
	sudo ninja -C build install
Tony Crisci's avatar
Tony Crisci committed
83

Drew DeVault's avatar
Drew DeVault committed
84
## Running the test compositor
Tony Crisci's avatar
Tony Crisci committed
85

Drew DeVault's avatar
Drew DeVault committed
86
87
88
89
90
91
92
93
94
95
96
97
98
wlroots comes with a test compositor called rootston, which demonstrates the
features of the library and is used as a testbed for the development of the
library. It may also be useful as a reference for understanding how to use
various wlroots features.

If you followed the build instructions above the rootston executable can be
found at `./build/rootston/rootston`. To use it, refer to the example config at
[./rootston/rootston.ini.example](https://github.com/swaywm/wlroots/blob/master/rootston/rootston.ini.example)
and place a config file of your own at `rootston.ini` in the working directory
(or in an arbitrary location via `rootston -C`). Other options are available,
refer to `rootston -h`.

## Contributing
Tony Crisci's avatar
Tony Crisci committed
99

Drew DeVault's avatar
Drew DeVault committed
100
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md).