wlroots/README.md

99 lines
3.6 KiB
Markdown
Raw Normal View History

2018-03-04 21:33:45 +00:00
# wlroots
2017-04-25 15:32:52 +00:00
2018-04-13 01:29:45 +00:00
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.
2017-04-25 15:32:52 +00:00
2018-04-13 01:29:45 +00:00
- 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.
2018-04-13 01:33:51 +00:00
- wlroots provides several powerful, standalone, and optional tools that
implement components common to many compositors, such as the arrangement of
outputs in physical space.
2018-04-13 01:29:45 +00:00
- 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.
2017-08-13 12:29:04 +00:00
2018-04-13 01:29:45 +00:00
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
2018-05-03 20:43:54 +00:00
compatibility, broad support for many wayland interfaces, and comfortable
2018-04-13 01:29:45 +00:00
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.
2018-10-12 12:27:09 +00:00
Check out our [wiki](https://github.com/swaywm/wlroots/wiki/Getting-started) to
get started with wlroots.
2017-08-13 12:29:04 +00:00
2018-04-13 01:29:45 +00:00
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.
2017-06-06 14:54:53 +00:00
## Building
Install dependencies:
2018-04-13 01:29:45 +00:00
* meson
2017-06-06 14:54:53 +00:00
* wayland
* wayland-protocols
* EGL
* GLESv2
2018-04-13 01:29:45 +00:00
* libdrm
2017-06-06 14:54:53 +00:00
* GBM
* libinput
2018-04-13 01:29:45 +00:00
* xkbcommon
2017-06-06 14:54:53 +00:00
* udev
2017-08-09 14:24:28 +00:00
* pixman
2017-06-06 14:54:53 +00:00
* systemd (optional, for logind support)
2017-09-22 17:16:11 +00:00
* elogind (optional, for logind support on systems without systemd)
2017-07-03 12:29:03 +00:00
* libcap (optional, for capability support)
2018-04-13 01:29:45 +00:00
If you choose to enable X11 support:
2018-05-05 05:25:11 +00:00
* xcb
* xcb-composite
* xcb-xfixes
* xcb-image
* xcb-render
2018-04-13 01:29:45 +00:00
* x11-xcb
* xcb-errors (optional, for improved error reporting)
* x11-icccm (optional, for improved Xwayland introspection)
2018-05-05 05:25:11 +00:00
* xcb-xkb (optional, for improved keyboard handling on the X11 backend)
2017-06-06 14:54:53 +00:00
Run these commands:
2017-07-17 18:38:28 +00:00
meson build
ninja -C build
2017-10-09 22:23:43 +00:00
2018-04-13 01:29:45 +00:00
Install like so:
2017-11-16 20:39:48 +00:00
2018-04-13 01:29:45 +00:00
sudo ninja -C build install
2017-11-16 20:39:48 +00:00
2018-04-13 01:29:45 +00:00
## Running the test compositor
2017-11-16 20:39:48 +00:00
2018-04-13 01:29:45 +00:00
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
2018-10-12 12:27:09 +00:00
various wlroots features, but it's not considered a production-quality codebase
and is not designed for daily use.
2018-04-13 01:29:45 +00:00
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
2017-11-16 20:39:48 +00:00
2018-04-13 01:29:45 +00:00
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md).