Go to file
emersion 1a2727cc38
data-device: send offer on get_data_device
2019-01-24 12:12:55 +01:00
.builds Update FreeBSD build 2019-01-07 08:26:16 +00:00
backend backend/wayland: fix resizing 2019-01-22 21:19:34 +01:00
docs Introduce noop backend 2019-01-17 20:13:55 +10:00
examples Fix indentation in various files 2019-01-21 17:56:19 +01:00
include data-device: remove data_source_send_offer 2019-01-24 12:12:55 +01:00
protocol Merge pull request #1476 from emersion/fullscreen-shell 2019-01-20 09:30:52 -05:00
render Standardize the wlr_box input paramaters 2018-12-21 13:56:10 -05:00
rootston data-device, primary-selection: add request_set_selection 2019-01-24 11:38:23 +01:00
tinywl Fix tinywl linking order (#1463) 2019-01-16 16:39:14 +01:00
types data-device: send offer on get_data_device 2019-01-24 12:12:55 +01:00
util Use ftruncate to set shared memory object's size 2018-11-09 18:29:19 +01:00
xcursor xcursor: Support XDG user data dir location 2018-11-27 23:21:07 +01:00
xwayland data-device: make sources inert, rename cancel to destroy 2019-01-24 12:12:55 +01:00
.editorconfig Remove indent_size from .editorconfig 2018-09-05 11:59:38 +12:00
.gitignore update .gitignore 2018-03-03 15:23:26 +01:00
CONTRIBUTING.md util: add wlr_ prefix to log symbols 2018-07-09 22:49:54 +01: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
glgen.sh Change how glgen.sh outputs files 2018-08-24 19:35:21 +12:00
meson.build build: bump versino to 0.2.0 2018-12-01 11:17:32 +01:00
meson_options.txt meson: yield xwayland option 2019-01-18 09:07:22 +01:00
wlroots.syms Remove symbol versioning from DSO 2018-07-20 11:09:56 +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.