river-bsp-layout

Custom River layout manager that creates a Binary Space Partition / Grid layout using river-layout-toolkit

3 Window Example:

+----------------+----------------+
|                |                |
|                |                |
|                +----------------+
|                |                |
|                |                |
+----------------+----------------+

4 Window Example:

+----------------+----------------+
|                |                |
|                |                |
+----------------+----------------+
|                |                |
|                |                |
+----------------+----------------+

Installing

Fedora

dnf copr enable areif-dev/river-bsp-layout

dnf install river-bsp-layout

Other - Cargo

cargo install river-bsp-layout --locked

Building

Make sure you have cargo installed. The recommended means of installation is with rustup.sh from https://www.rust-lang.org/tools/install
Clone this repo with

git clone https://github.com/areif-dev/river-bsp-layout

Enter the cloned directory

cd river-bsp-layout

cargo build --release

Move the compiled binary from target/release/river-bsp-layout to any directory in your $PATH
- With cargo installed, one option would be to move the the binary to $HOME/.cargo/bin

Starting from River init

Assuming you are using a default bash init script, replace the following lines at the end of the file

riverctl default-layout rivertile
rivertile -view-padding 6 -outer-padding 6 &

with

riverctl default-layout bsp-layout
river-bsp-layout --inner-gap 5 --outer-gap 10 --split-perc 0.5 &

CLI Help

Binary space partitioned layout for the tiling Wayland compositor River.

Usage: river-bsp-layout [OPTIONS]

Options:

-i, --inner-gap <DEFAULT_INNER_GAP> The number of pixels to pad each inner edge of a window by default [default: 0]
-l, --ig-left <IG_LEFT> The number of pixels to pad the left inner edge of each window. This Overrides default_inner_gap. Optional
-r, --ig-right <IG_RIGHT> The number of pixels to pad the right inner edge of each window. This Overrides default_inner_gap. Optional
-b, --ig-bottom <IG_BOTTOM> The number of pixels to pad the bottom inner edge of each window. This Overrides default_inner_gap. Optional
-t, --ig-top <IG_TOP> The number of pixels to pad the top inner edge of each window. This Overrides default_inner_gap. Optional
-o, --outer-gap <DEFAULT_OUTER_GAP> The default size of the gap between windows and the edge of the screen [default: 0]
-L, --og-left <OG_LEFT> The number of pixels to place between the left screen edge and any windows. Overrides default_outer_gap for the left side. Optional
-R, --og-right <OG_RIGHT> The number of pixels to place between the right screen edge and any windows. Overrides default_outer_gap for the right side. Optional
-B, --og-bottom <OG_BOTTOM> The number of pixels to place between the bottom screen edge and any windows. Overrides default_outer_gap for the bottom side. Optional
-T, --og-top <OG_TOP> The number of pixels to place between the top screen edge and any windows. Overrides default_outer_gap for the top side. Optional
-s, --split-perc <DEFAULT_SPLIT_PERC> The default percentage of available area that the primary window should occupy after any split takes place [default: 0.5]
-H, --hsplit-perc <H_SPLIT_PERC> The percentage of available area that the primary window should occupy after a horizontal split. This will override the value of default_split_perc only for horizontal splits
-v, --vsplit-perc <V_SPLIT_PERC> The percentage of available area that the primary window should occupy after a vertical split. This will override the value of default_split_perc only for vertical splits
--reverse Reverse the order of the views as well as the order they are added
-h, --help Print help
-V, --version Print version

CLI Examples

In this configuration, all inner gaps are set to 5 pixels, and all outer gaps are set to 10, except the top gap, which is 0, so top windows sit flush with the bar.

This config can be achieved with the following invocation

river-bsp-layout --inner-gap 5 --outer-gap 10 --og-top 0

This config features uniform outer gaps of 10 pixels and inner gaps of 5 pixels on each edge.

river-bsp-layout --inner-gap 5 --outer-gap 10

This config is mostly to demonstrate the possibilities of individually configurable edge gaps.

river-bsp-layout --ig-top 1 --og-bottom 5 --ig-right 10 --og-left 15 --og-top 20 --ig-bottom 25 --og-right 30 --ig-left 35

This run demonstrates the ability to split the screen into unequal chunks whenever a split takes place. This allows for greater focus to be put on your primary window(s)

river-bsp-layout --inner-gap 5 --outer-gap 10 --split-perc 0.61803

riverctl Commands

river-bsp-layout supports the following commands from riverctl send-layout-cmd:

Gap Commands

Sets all outer gaps to 5

riverctl send-layout-cmd bsp-layout "outer-gap 5"

Set only the left outer gap to 5

riverctl send-layout-cmd bsp-layout "og-left 5"

Set only the right outer gap to 5

riverctl send-layout-cmd bsp-layout "og-right 5"

Set only the bottom outer gap to 5

riverctl send-layout-cmd bsp-layout "og-bottom 5"

Set only the top outer gap to 5

riverctl send-layout-cmd bsp-layout "og-top 5"

Sets all inner gaps to 5

riverctl send-layout-cmd bsp-layout "inner-gap 5"

Set only the left inner gap to 5

riverctl send-layout-cmd bsp-layout "ig-left 5"

Set only the right inner gap to 5

riverctl send-layout-cmd bsp-layout "ig-right 5"

Set only the bottom inner gap to 5

riverctl send-layout-cmd bsp-layout "ig-bottom 5"

Set only the top inner gap to 5

riverctl send-layout-cmd bsp-layout "ig-top 5"

Split Percent Commands

Set both vertical and horizontal split percentage to 0.6

riverctl send-layout-cmd "split-perc 0.6"

Set only vertical split percentage to 0.6

riverctl send-layout-cmd "vsplit-perc 0.6"

Set only horizontal split percentage to 0.6

riverctl send-layout-cmd "hsplit-perc 0.6"

Increase vertical split percentage by .01

riverctl send-layout-cmd "inc-vsplit-perc 0.01"

Decrease vertical split percentage by .01

riverctl send-layout-cmd "dec-vsplit-perc 0.01"

Increase horizontal split percentage by .01

riverctl send-layout-cmd "inc-hsplit-perc 0.01"

Decrease horizontal split percentage by .01

riverctl send-layout-cmd "dec-hsplit-perc 0.01"

Reverse Command

Reverse the order that new views are added to the stack

riverctl send-layout-cmd "reverse"

HPsaucii/river-bsp-layout