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)
552 Commits 1 Branch 0 Tags 3.6 MiB
Zig 92.7%
Shell 3.8%
C 2.7%
Python 0.8%
96d460c477
Go to file
Isaac Freund 96d460c477
riverctl: improve handling of null string options 
Passing an empty string as the value argument for riverctl set-option or
declare-option will set the value to null. The riverctl get-option
command produces no output for both null and empty string values.

This is not perfect as it is unable to distinguish between null and
empty strings through the riverctl CLI. I don't see a better alternative
here however. Forbidding null strings in the river-options protocol
would be one solution, however null strings are useful and more pleasant
to use from code despite being problematic on the CLI.
2021-02-02 18:42:09 +01:00
.github/workflows ci: check fmt of build.zig 2020-12-05 22:54:53 +01:00
contrib build: install example config to /etc/river/init 2020-12-30 20:29:28 +01:00
deps output: add output_title default option 2021-02-02 01:14:06 +01:00
doc output: add output_title default option 2021-02-02 01:14:06 +01:00
example river-options: implement 2021-01-16 23:51:15 +01:00
protocol river-option: compositor may ignore set requests 2021-01-18 01:34:06 +01:00
river river-options: fix setting null string options 2021-02-02 18:16:36 +01:00
riverctl riverctl: improve handling of null string options 2021-02-02 18:42:09 +01:00
rivertile command: s/master/main/g (breaking change) 2020-12-30 18:15:47 +01:00
.editorconfig editorconfig: add scdoc config 2020-06-17 16:22:53 +02:00
.gitignore gitignore: remove outdated ignores 2020-12-31 18:02:44 +01:00
.gitmodules code: switch to custom wlroots/libwayland bindings 2020-12-13 22:53:33 +01:00
AUTHORS meta: make copyright headers more maintainable 2020-11-11 20:33:43 +01:00
build.zig riverctl: implement river-options interface 2021-01-18 22:30:52 +01:00
CONTRIBUTING.md docs: update stance on line length 2021-01-02 12:07:21 +01:00
LICENSE Relicense to GPL-3.0-or-later 2020-05-02 19:21:10 +02:00
README.md docs: use less noisy build option forms 2020-12-31 02:59:40 +01: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.7.1
  • wayland
  • wayland-protocols
  • wlroots 0.12.0
  • xkbcommon
  • libevdev
  • pixman
  • pkg-config
  • scdoc (optional, but required for man page generation)

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

Then run, for example:

zig build -Drelease-safe --prefix /usr 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.

Development

If you are interested in the development of river, please join us at #river on freenode. 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).