nordic-dev.net/wlroots
2
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2024-11-21 14:42:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
f440c60128
wlroots/tinywl
History
Kirill Primak c752270be7 tinywl: drop focused surface check for interactive ops 
This serves as a bad example: compositors should validate serials from
events instead. Also, the current implementation segfaults if
focused_surface is NULL.
2024-09-20 10:48:32 +00:00
..
.gitignore tinywl: Update .gitignore 2024-07-29 11:39:34 -04:00
LICENSE CC0 2018-08-15 19:17:20 -04:00
Makefile tinywl: Edit Makefile for bmake compatibility 2024-07-29 11:39:34 -04:00
meson.build tinywl: depend on the server xdg-shell header 2024-01-09 21:39:02 +03:00
README.md tinywl: remove outdated non-feature from README.md 2022-04-01 14:22:28 +00:00
tinywl.c tinywl: drop focused surface check for interactive ops 2024-09-20 10:48:32 +00:00

README.md

TinyWL

This is the "minimum viable product" Wayland compositor based on wlroots. It aims to implement a Wayland compositor in the fewest lines of code possible, while still supporting a reasonable set of features. Reading this code is the best starting point for anyone looking to build their own Wayland compositor based on wlroots.

Building TinyWL

TinyWL is disconnected from the main wlroots build system, in order to make it easier to understand the build requirements for your own Wayland compositors. Simply install the dependencies:

  • wlroots
  • wayland-protocols

And run make.

Running TinyWL

You can run TinyWL with ./tinywl. In an existing Wayland or X11 session, tinywl will open a Wayland or X11 window respectively to act as a virtual display. You can then open Wayland windows by setting WAYLAND_DISPLAY to the value shown in the logs. You can also run ./tinywl from a TTY.

In either case, you will likely want to specify -s [cmd] to run a command at startup, such as a terminal emulator. This will be necessary to start any new programs from within the compositor, as TinyWL does not support any custom keybindings. TinyWL supports the following keybindings:

  • Alt+Escape: Terminate the compositor
  • Alt+F1: Cycle between windows

Limitations

Notable omissions from TinyWL:

  • HiDPI support
  • Any kind of configuration, e.g. output layout
  • Any protocol other than xdg-shell (e.g. layer-shell, for panels/taskbars/etc; or Xwayland, for proxied X11 windows)
  • Optional protocols, e.g. screen capture, primary selection, virtual keyboard, etc. Most of these are plug-and-play with wlroots, but they're omitted for brevity.