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

Go to file

novakane 177b99c6e2 README: add a link to the wiki		2021-07-07 13:20:51 +00:00
.github/workflows	ci: build wlroots from source	2021-06-23 15:35:10 +02:00
completions	completions: typo	2021-07-02 19:11:36 +02:00
contrib	contrib: Update layout.c for river-layout-v2	2021-05-07 00:34:41 +02:00
deps	Revert "build: assert wlroots version at comptime"	2021-06-24 20:21:07 +02:00
doc	cursor: add option to warp on output change	2021-06-26 19:03:49 +02:00
example	example/init: use Mod+Shift E for exit	2021-05-24 00:33:53 +02:00
protocol	river-layout: update to v2	2021-04-27 00:10:20 +02:00
river	render: @panic() if CLOCK_MONOTONIC is not supported	2021-06-27 13:20:36 +02:00
riverctl	code: update to zig 0.8.0	2021-06-05 17:29:58 +00:00
rivertile	rivertile: clamp main_amount	2021-05-19 13:54:54 +02:00
.editorconfig	editorconfig: add scdoc config	2020-06-17 16:22:53 +02:00
.gitignore	code: update to zig 0.8.0	2021-06-05 17:29:58 +00:00
.gitmodules	code: switch to custom wlroots/libwayland bindings	2020-12-13 22:53:33 +01:00
AUTHORS	river: pointer-constraints and relative-pointer	2021-02-22 14:47:31 +01:00
build.zig	Add basic input configuration	2021-06-13 10:37:36 -07:00
CONTRIBUTING.md	doc: add IRC web client link	2021-05-28 17:39:43 +00:00
LICENSE	Relicense to GPL-3.0-or-later	2020-05-02 19:21:10 +02:00
README.md	README: add a link to the wiki	2021-07-07 13:20:51 +00:00

README.md

river

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

Note: river is currently early in development. Expect breaking changes and missing features. If you run into a bug don't hesitate to open an issue

Design goals

Simplicity and minimalism, river should not overstep the bounds of a window manager.
Window management based on a stack of views and tags.
Dynamic layouts generated by external, user-written executables. (A default rivertile layout generator is provided.)
Scriptable configuration and control through a custom wayland protocol and separate riverctl binary implementing it.

Building

On cloning the repository, you must init and update the submodules as well with e.g.

git submodule update --init

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

zig 0.8.0
wayland
wayland-protocols
wlroots 0.14.0
xkbcommon
libevdev
pixman
pkg-config
scdoc (optional, but required for man page generation)

Then run, for example:

zig build -Drelease-safe --prefix ~/.local install

To enable experimental Xwayland support pass the -Dxwayland option as well.

Usage

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

On startup river will look for and run an executable file at one of the following locations, checked in the order listed:

$XDG_CONFIG_HOME/river/init
$HOME/.config/river/init
/etc/river/init

Usually this executable init file will be a shell script invoking riverctl to create mappings and preform other configuration.

An example init script with sane defaults is provided here in the example directory and installed to /etc/river/init.

For complete documentation see the river(1), riverctl(1), and rivertile(1) man pages.

As a supplement to the man pages, see also the FAQ in the wiki for common issues and have a look at the recommended software.

Development

If you are interested in the development of river, please join us at #river on irc.libera.chat. You should also read CONTRIBUTING.md if you intend to submit patches.

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).