waywall

waywall is a Wayland compositor that provides various convenient features (key rebinding, Ninjabrain Bot support, etc) for Minecraft speedrunning. It is designed to be nested within an existing Wayland session and is intended as a successor to resetti.

[!NOTE] waywall is still under development. Some features are missing or may not work as expected.

Installation

waywall is available through some package managers, and prebuilt binary packages are provided for various popular distributions on the Releases page.

For more detailed installation instructions, refer to the documentation.

Building from source

The following dependencies are required only at build time:

• wayland-protocols

The following dependencies are required for both building and running:

• egl
• glesv2
• luajit
• spng
• wayland-client
• wayland-cursor
• wayland-egl
• wayland-server
• xcb
• xcb-composite
• xcb-res
• xcb-xtest
• xwayland
• xkbcommon

To build waywall, clone the repository and run make.

License

waywall is licensed under the GNU General Public License v3 only, no later version.

Attributions

Non-trivial code has been referenced and reused from the following repositories, particularly for Xwayland support. Their licenses can be found in the relevant files.

• weston
• wlroots

waywall bundles a version of the Terminus Font, which is licensed under the Open Font License. See include/util/font.h for more information.

waywall bundles a patched version of GLFW if built with the included building script, GLFW is licensed under the ZLib License. See /usr/share/doc/waywall/glfw-LICENSE.md & /usr/share/doc/waywall/glfw-MAINTAINERS.md for more information.