riverwm/river

Overview

River is a non-monolithic Wayland compositor. Unlike other Wayland compositors, river does not combine the compositor and window manager into one program. Instead, users can choose any window manager implementing the river-window-management-v1 protocol.

Read my blog post, Separating the Wayland Compositor and Window Manager, for an in-depth explanation.

There is a list of compatible window managers on our wiki.

If you are looking for the old dynamic tiling version of river, see river-classic.

Links

• Protocol Docs
• tinyrwm example window manager
• Wiki
• IRC: #river on irc.libera.chat (logs)
• Zulip (new)
• Issue Tracker
• Code of Conduct

Features

River defers all window management policy to a separate window manager implementing the river-window-management-v1 protocol. This includes window position/size, pointer/keyboard bindings, focus management, window decorations, desktop shell graphics, and more.

River itself provides frame perfect rendering, good performance, support for many Wayland protocol extensions, robust Xwayland support, the ability to hot-swap window managers, and more.

The river-window-management-v1 protocol and other river protocol extensions are stable. We do not break window managers.

Motivation

Why split the window manager to a separate process?

• Significantly lower the barrier to entry for writing a Wayland window manager.
• Allow implementing Wayland window managers in high-level garbage collected languages without impacting compositor performance and latency.
• Allow hot-swapping between window managers without restarting the compositor and all Wayland programs.
• Promote diversity and experimentation in window manager design.

Building

Note: If you are packaging river for distribution, see PACKAGING.md.

To compile river first ensure that you have the following dependencies installed. The "development" versions are required if applicable to your distribution.

• zig 0.16
• wayland
• wayland-protocols
• wlroots 0.20
• xkbcommon 1.12 or newer
• libevdev
• pixman
• pkg-config
• scdoc (optional, but required for man page generation)

Then run, for example:

zig build -Doptimize=ReleaseSafe --prefix ~/.local install

To enable Xwayland support pass the -Dxwayland option as well. Run zig build -h to see a list of all options.

Usage

River can either be run nested in an X11/Wayland session or directly from a tty using KMS/DRM. Simply run the river command.

On startup river will run an executable file at $XDG_CONFIG_HOME/river/init if such an executable exists. If $XDG_CONFIG_HOME is not set, ~/.config/river/init will be used instead.

Usually this executable is a shell script which starts the user's window manager and any other long-running programs.

See also:

• The river(1) man page
• The wiki FAQ
• The list of compatible window managers
• The list of useful companion software

Strict No LLM / No AI Policy

Use of generative AI/LLMs is strictly forbidden for all contributions to river.

This includes bug reports and comments on the issue tracker.

Hacking

See ARCHITECTURE.md for an overview of the code base.

See CONTRIBUTING.md for information on submitting patches.

Donate

If my work on river adds value to your life please consider setting up a recurring donation through liberapay. This is the best way to make river's development sustainable in the long term.

You can also support me with a one-time or monthly donation on github sponsors or ko-fi though I prefer liberapay as it is run by a non-profit.

Thank you for your support!

Funding

River is funded in part through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme.

Learn more at the NLnet project page.

Licensing

This project follows the REUSE Specification, all files have SPDX copyright and license information.

In overview:

• River's source code is released under the GPL-3.0-only license.
• River's Wayland protocols are released under the MIT license.
• River's logo and documentation are released under the CC-BY-SA-4.0 license.