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)
1,125 Commits 1 Branch 0 Tags 3.6 MiB
Zig 92.7%
Shell 3.8%
C 2.7%
Python 0.8%
4685f6906d
Go to file
tiosgz 4685f6906d
Keyboard: eat key before running mapping 
To see why this is needed, compare the following flows:
  - user: press key 'j' with Super already pressed
  - Keyboard: handle mapping, focusing next view
  - Seat: send wl_keyboard.enter with keys Super and 'j'
  - Keyboard: eat key 'j'
versus:
  - user: press key 'j' with Super already pressed
  - Keyboard: eat key 'j'
  - Keyboard: handle mapping, focusing next view
  - Seat: send wl_keyboard.enter with key Super.

The necessity of this was already mentioned in 1e3b8ed1; however,
without a comment in code, it was removed in 393bfb42 as superfluous.
Hopefully, the newly added comment will prevent such mistakes in the
future.

Fixes https://github.com/riverwm/river/issues/978
2024-02-05 12:33:09 +01:00
.builds build: require at least wlroots 0.17.1 2024-01-01 22:55:15 -06:00
common build: update to Zig 0.11.0 2023-10-16 16:27:03 +02:00
completions keyboard: add the ability to load layout from file 2023-11-09 13:23:07 +01:00
contrib contrib: mention default-layout command in FAQ 2022-10-26 10:29:23 +02:00
deps Keyboard: fix mapping XF86ScreenSaver 2024-01-06 20:36:53 -06:00
doc attach-mode: code/documentation style tweaks 2024-01-13 12:36:20 -06:00
example riverctl: rule-{add,del}: reorder parameters 2023-10-16 17:04:40 +00:00
protocol river-control: mark callback events as destructors 2022-12-31 23:22:47 +01:00
river Keyboard: eat key before running mapping 2024-02-05 12:33:09 +01:00
riverctl build: update to Zig 0.11.0 2023-10-16 16:27:03 +02:00
rivertile rivertile: eliminate an @intCast() 2023-10-26 00:04:11 +02:00
.editorconfig editorconfig: reflect state of bash completion 2023-10-25 19:13:53 +02:00
.gitignore build: update to Zig 0.11.0 2023-10-16 16:27:03 +02:00
.gitmodules code: switch to custom wlroots/libwayland bindings 2020-12-13 22:53:33 +01:00
build.zig river: Implement cursor_shape_v1 2024-01-04 14:14:00 -06:00
CONTRIBUTING.md docs: fix typo in readme 2022-11-17 14:58:08 +01:00
LICENSE Relicense to GPL-3.0-or-later 2020-05-02 19:21:10 +02:00
PACKAGING.md docs: update PACKAGING.md for Zig 0.11 2023-10-25 12:16:50 +02:00
README.md build: require at least wlroots 0.17.1 2024-01-01 22:55:15 -06:00

README.md

river

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

Install from your package manager — Join us at #river on irc.libera.chat — Read our man pages and wiki

Note: river is currently early in development. Expect breaking changes and missing features. Bugs should however be rare at this point, if you run into one 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

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. The "development" versions are required if applicable to your distribution.

  • zig 0.11
  • wayland
  • wayland-protocols
  • wlroots 0.17.1
  • xkbcommon
  • 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 experimental Xwayland support pass the -Dxwayland option as well.

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

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 perform 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 v3.0 only.

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