Go to file

Simon Ser d0560e2597 contributing: add link to IRC web chat		2021-05-26 22:21:06 +02:00
.builds	ci: Add libseat-dev to alpine	2021-04-14 23:25:07 +02:00
backend	backend/x11: use common renderer and allocator	2021-05-21 22:13:54 +02:00
docs	render: introduce WLR_RENDERER in wlr_renderer_autocreate_with_drm_fd	2021-04-20 21:14:27 +02:00
examples	Flush events in virtual pointer example	2021-05-22 13:36:30 +02:00
include	backend/x11: use common renderer and allocator	2021-05-21 22:13:54 +02:00
protocol	build: move wayland-protocols dep to protocol/	2021-05-01 12:33:50 +02:00
render	render: relax stride check in wlr_texture_from_pixels	2021-05-19 11:13:42 -04:00
tinywl	Stop specifying xkb_rule_names	2021-04-19 17:33:28 +02:00
types	screencopy-v1: stop using wlr_client_buffer	2021-05-17 16:22:43 +02:00
util	util/uuid: replace with util/token, remove libuuid	2021-04-11 19:09:36 +02:00
xcursor	xcursor: fix CVE-2013-2003	2021-05-02 17:04:59 +02:00
xwayland	xwayland: actually use Xwayland from pkg-config	2021-05-12 10:55:15 +02:00
.editorconfig	Set .editorconfig ident_size	2019-01-25 11:37:46 +01:00
.gitignore	Remove rootston	2019-08-09 08:34:59 +09:00
CONTRIBUTING.md	contributing: add link to IRC web chat	2021-05-26 22:21:06 +02:00
LICENSE	Update LICENSE year (MIT license)	2018-04-12 21:29:59 -04:00
README.md	readme: fix broken IRC web client link	2021-05-26 22:19:41 +02:00
meson.build	build: move wayland-protocols dep to protocol/	2021-05-01 12:33:50 +02:00
meson_options.txt	render: make GLES2 renderer optional	2021-04-17 16:39:40 +02:00
wlroots.syms	util: add wlr_output_destroy_safe	2020-02-17 20:52:37 +01:00

README.md

wlroots

Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 50,000 lines of code you were going to write anyway.

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.
wlroots provides several powerful, standalone, and optional tools that implement components common to many compositors, such as the arrangement of outputs in physical space.
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.

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 compatibility, broad support for many wayland interfaces, and comfortable 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.

Check out our wiki to get started with wlroots. Join our IRC channel: #sway-devel on Libera Chat.

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.

Building

Install dependencies:

meson
wayland
wayland-protocols
EGL
GLESv2
libdrm
GBM
libinput
xkbcommon
udev
pixman
libseat

If you choose to enable X11 support:

xwayland (build-time only, optional at runtime)
libxcb
libxcb-render-util
libxcb-wm
libxcb-errors (optional, for improved error reporting)

Run these commands:

meson build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Contributing

See CONTRIBUTING.md.