| .github/workflows | ||
| include | ||
| protocol | ||
| src | ||
| .gitignore | ||
| build.zig | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
river
river is a dynamic wayland compositor that takes inspiration from dwm and bspwm.
Note: river is currently early in development and not yet ready for the average end user
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 socket and separate
binary,
riverctl, like bspwm.
Packaging status
River is available from the AUR. Note that river is still pre-0.1.0 and may lack features you deem necessary.
Building
To compile river first ensure that you have the following dependencies installed:
Then simply use zig build to build and zig build run to run.
River can either be run nested in an X11/wayland session or directly from a tty using KMS/DRM.
Keybinds are similar to the defaults of dwm, but using the "logo key" instead of alt. Check out the comments in config.zig for a complete list of bindings. Note that the terminal emulator is currently hardcoded to alacritty.
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.