Go to file
Simon Ser f81aa6a172 build: use summary instead of message 2020-04-21 15:33:53 +02:00
.builds build: Add 'auto' to logind-provider combo option 2020-03-24 14:11:39 +01:00
backend build: use dicts instead of get_variable 2020-04-21 15:26:45 +02:00
contrib build: replace version with soversion 2020-01-24 11:17:03 +01:00
docs backend/drm: add env variable to disable modifiers 2020-01-24 19:43:51 +01:00
examples build: use dicts instead of get_variable 2020-04-21 15:26:45 +02:00
include Document the events of wlr_layer_surface 2020-04-17 15:44:07 +02:00
protocol build: use dicts instead of get_variable 2020-04-21 15:26:45 +02:00
render render: only expose linux-dmabuf if EGL extension is supported 2020-04-09 00:16:03 +00:00
tinywl tinywl: remove redundant create output global call 2020-04-15 12:40:20 +02:00
types seat: add check for NULL keyboard 2020-04-14 12:12:48 +02:00
util util/log: improve time prefix 2020-03-07 00:25:01 +01:00
xcursor xcursor: also look for cursor themes under ${datadir}/icons by default 2020-03-04 10:02:31 +01:00
xwayland xwayland: remove underscore prefix from atom names 2020-03-06 21:34:44 +01: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 Simplify globals implementation by removing destructors 2019-11-25 09:01:46 -05:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
README.md Update READMEs per tinywl merge 2019-01-03 10:10:03 -05:00
meson.build build: use summary instead of message 2020-04-21 15:33:53 +02:00
meson_options.txt build: Add 'auto' to logind-provider combo option 2020-03-24 14:11:39 +01: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.

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
  • systemd (optional, for logind support)
  • elogind (optional, for logind support on systems without systemd)
  • libcap (optional, for capability support)

If you choose to enable X11 support:

  • xcb
  • xcb-composite
  • xcb-xfixes
  • xcb-xinput
  • xcb-image
  • xcb-render
  • x11-xcb
  • xcb-errors (optional, for improved error reporting)
  • x11-icccm (optional, for improved Xwayland introspection)

Run these commands:

meson build
ninja -C build

Install like so:

sudo ninja -C build install

Contributing

See CONTRIBUTING.md.