Fork of river (Wayland compositor, https://codeberg.org/river/river)

Go to file

Isaac Freund 052c8e1dcb transactions: handle preemption take 2 This implementation is far simpler than `c0d7e71` as it takes advantage of wlroots's tracking of pending state. Additionally, we now send frame done events if a view that we are configuring commits with the wrong dimensions. This is necessary in order to trigger a redraw for some clients as well as being a more correct implementation of the protocol.		2020-06-09 20:06:30 +02:00
.github/workflows	Really fix zig fmt CI	2020-06-01 16:20:48 +02:00
contrib	Use tag masks for tag commands and clean up	2020-06-02 16:38:23 +02:00
doc	docs: remove trailing whitespace	2020-06-05 10:56:54 +02:00
example	river-status: simplify example client	2020-06-06 15:07:07 +02:00
include	Clean up some memory leaks	2020-06-02 13:45:56 +02:00
protocol	river-status: add seat status object	2020-06-04 16:55:28 +02:00
river	transactions: handle preemption take 2	2020-06-09 20:06:30 +02:00
riverctl	Split river and riverctl directories	2020-06-01 15:56:50 +02:00
.editorconfig	editorconfig: trim trailing whitespace	2020-06-04 16:54:17 +02:00
.gitignore	Remove outdated entry from gitignore	2020-03-29 13:19:24 +02:00
build.zig	build: install man pages	2020-06-05 13:48:07 +02:00
CONTRIBUTING.md	docs: update commit style guidelines	2020-06-05 00:59:12 +02:00
LICENSE	Relicense to GPL-3.0-or-later	2020-05-02 19:21:10 +02:00
README.md	docs: fix link to Config.zig	2020-06-05 10:34:26 +02:00

README.md

river

river is a dynamic wayland compositor that takes inspiration from dwm and bspwm.

Note: river is currently early in development and may lack some features. If there are specific features blocking you from using river, don't hesitate to open an issue

Design goals

Simplicity and minimalism, river should not overstep the bounds of a window manger.
Dynamic window management based on a stack of views and tags like dwm.
Scriptable configuration and control through a separate binary, riverctl, like bspwm. This works using the custom river-control protocol.

Building

To compile river first ensure that you have the following dependencies installed:

zig 0.6.0
wayland
wayland-protocols
wlroots 0.10.1
xkbcommon
pixman
pkg-config

Note: NixOS users should refer to the Building on NixOS wiki page

Then run, for example, sudo zig build --prefix /usr/local install to build and install the river and riverctl binaries to /usr/local/bin. To enable experimental Xwayland support pass the -Dxwayland=true option.

Usage

River can either be run nested in an X11/wayland session or directly from a tty using KMS/DRM.

River has no keybindings by default; mappings can be created using the map command of riverctl. Generally, creating mappings and other configuration is done with a shell script. River will execute any arbitrary shell command passed with the -c flag during startup. For example:

river -c /path/to/config.sh

An example script with sane defaults is provided here in the contrib directory.

Some configuration options are still hardcoded in Config.zig. Eventually all configuration will be moved to the riverctl binary.

Development

Check out the roadmap if you'd like to see what has been done and what is left to do.

If you are interested in the development of river, please join our matrix channel: #river:matrix.org. You should also read CONTRIBUTING.md if you intend to submit patches.

I can often be found in the #sway-devel IRC channel with the nick ifreund on irc.freenode.net as well, or reached by email at ifreund@ifreund.xyz.

Licensing

river is released under the GNU General Public License version 3, or (at your option) any later version.

The protocols in the protocol directory are released under various licenses by various parties. You should refer to the copyright block of each protocol for the licensing information. The protocols prefixed with river and developed by this project are released under the ISC license (as stated in their copyright blocks).