Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of river (Wayland compositor, https://codeberg.org/river/river)
743 Commits 1 Branch 0 Tags 3.6 MiB
Zig 92.7%
Shell 3.8%
C 2.7%
Python 0.8%
196c52885f
Go to file
Leon Henrik Plickat 196c52885f Decrease layout demand timeout to 100ms 
Layout generators are generally pretty fast. The timeout is only reached when
the generator is faulty / stuck. In that case, freezing for 1 second is simply
bad UX.
2021-10-04 11:07:59 +02:00
.github/workflows ci: fix xbps invocation 2021-09-27 19:10:46 +02:00
common common: standardize on -help option 2021-07-24 19:31:04 +02:00
completions river: add send-to-previous-tags command 2021-09-14 22:57:17 +02:00
contrib contrib: update layout.c for river-layout-v3 2021-07-21 14:01:51 +02:00
deps river: implement xdg-activation-v1 2021-08-19 12:58:52 +00:00
doc doc: update my (Isaac's) email address 2021-10-02 13:01:58 +02:00
example river: Allow applying CSD based on window titles 2021-09-07 12:30:53 +00:00
protocol river: implement xdg-activation-v1 2021-08-19 12:58:52 +00:00
river Decrease layout demand timeout to 100ms 2021-10-04 11:07:59 +02:00
riverctl common: standardize on -help option 2021-07-24 19:31:04 +02:00
rivertile common: standardize on -help option 2021-07-24 19:31:04 +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 build: Use pkg-config to handle river protocols 2021-07-28 19:30:50 +00: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 docs: Wayland should always be capitalized 2021-07-26 12:20:48 +02:00

README.md

river

River is a dynamic tiling Wayland compositor with flexible runtime configuration.

Join us at #river on irc.libera.chat. Read our man pages and our wiki.

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

  • Simple and predictable behavior, river should be easy to use and have a low cognitive load.
  • 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

Packaging status

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. 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 invoking riverctl(1) to create mappings, start programs such as a layout generator or status bar, and preform other configuration.

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

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

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