Skip to content
Example compositor based on wlroots
C Meson
Branch: master
Clone or download
Pull request Compare This branch is 6 commits ahead of swaywm:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
include
protocol
.build.yml
.gitignore
LICENSE
README.md
bindings.c
config.c
cursor.c
desktop.c
ini.c
input.c
keyboard.c
layer_shell.c
main.c
meson.build
meson_options.txt
output.c
render.c
rootston.ini.example
seat.c
switch.c
text_input.c
view.c
virtual_keyboard.c
xdg_shell.c
xdg_shell_v6.c
xwayland.c

README.md

Note: this project is effectively abandoned. It may serve as a useful reference at times, but it's not being kept up-to-date. The last thing you should do is fork it to make your own compositor and you certainly should not package it for your distro.

If you are looking for a better reference or jumping-off point, check out tinywl. There is also a list of resources for getting started with wlroots available, as well as a list of other projects using wlroots, whose code is likely a better reference.

Historical readme:

rootston

Rootston is the "big" wlroots test compositor. It implements basically every feature of wlroots and may be useful as a reference for new compositors. However, it's mostly used as a testbed for wlroots development and does not have particularly clean code and is not particularly well designed: proceed with a grain of salt. It is not designed for end-users.

Running rootston

If you followed the build instructions in ../README.md, the rootston executable can be found at build/rootston/rootston. To use it, refer to the example config at 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.

You can’t perform that action at this time.