steven/beansprout-custom
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
162 commits 3 branches 0 tags 3.3 MiB
Find a file
Ben Buhse 411f679491
 Fix bug where Buffers were never freed 
The issue was that, when reiniting Buffers, the intrusive linkedlist
node was clobbered and we lost reference to it. That meant most of the
Buffers would be memory leaks. Now, we save the node during
reinitializion.
2026-03-06 11:37:21 -06:00
docs Fix bug where Buffers were never freed 2026-03-06 11:37:21 -06:00
examples Add exit_river keybinding 2026-03-06 09:21:07 -06:00
LICENSES Add REUSE licensing for non-code files 2026-02-11 14:50:04 -06:00
man Add exit_river keybinding 2026-03-06 09:21:07 -06:00
protocol Add exit_river keybinding 2026-03-06 09:21:07 -06:00
src Fix bug where Buffers were never freed 2026-03-06 11:37:21 -06:00
.gitignore initial commit 2025-05-03 21:07:26 -05:00
build.zig Add exit_river keybinding 2026-03-06 09:21:07 -06:00
build.zig.zon Add clock to the bar 2026-02-13 12:20:35 -06:00
README.md Add exit_river keybinding 2026-03-06 09:21:07 -06:00
REUSE.toml Add man pages 2026-02-25 16:02:58 -06:00

README.md

beansprout

Single window with gaps Tiled windows

Overview

A tiling window manager for the river Wayland compositor written in Zig. The window manager communicates using the river-window-management-v1 protocol, as well as some of River's additional Wayland protocols.

Beansprout uses a primary/stack tiling layout inspired by dwm with a customizable ratio and primary count. Similarly, beansprout has a 32-bit tag system, rather than workspaces. Each output has its own tags and own primary count/ratio.

Building

Requires Zig 0.15.1 or later.

Dependencies

To compile beansprout, you'll need the dependencies found below. I've listed the package names for Gentoo and Debian/Ubuntu, but they likely exist on all major distros.

Needed at both build-time and runtime:

Dependency Gentoo Name Debian/Ubuntu Name
wayland-client dev-libs/wayland libwayland-dev
pixman x11-libs/pixman libpixman-1-dev
xkbcommon x11-libs/libxkbcommon libxkbcommon-dev
fcft media-libs/fcft libfcft-dev

Only needed at build-time:

Dependency Gentoo Name Debian/Ubuntu Name
wayland-protocols dev-libs/wayland-protocols wayland-protocols

Optional (for building man pages):

Dependency Gentoo Name Debian/Ubuntu Name
scdoc app-text/scdoc scdoc

Note for Gentoo Users

Beansprout is available in my personal ebuild repo. Right now, it's just a live ebuild, but I will add versioned ebuilds once v0.1.0 is released.

Build

Build and install with:

zig build -Doptimize=ReleaseSafe --prefix ~/.local install

Run zig build -h to see a list of all options.

Usage

You can either add beansprout to the river init file or directly run river -c beansprout.

If no keybinds are configured (e.g. missing or broken config), beansprout provides fallback keybinds including Ctrl+Alt+Delete to exit the River session, Super+Shift+R to reload config, and Super+T to spawn a terminal.

If beansprout crashes, you can use River's hardcoded Ctrl+Alt F1–F12 bindings to switch to another TTY. From there, you can kill River or restart beansprout (you will need to set WAYLAND_DISPLAY yourself, e.g. WAYLAND_DISPLAY=wayland-1 beansprout).

Configuration

Beansprout is configured with a KDL file at $XDG_CONFIG_HOME/beansprout/config.kdl. See docs/CONFIGURATION.md for a full reference and examples/config.kdl for an example config.

Licensing

This project follows the REUSE Specification, all files have SPDX copyright and license information and/or are listed under REUSE.toml.

In overview:

  • beansprout's source code is released under the GPL-3.0-only license.
  • beansprout's documentation is released under the CC-BY-4.0 license.
  • beansprout's examples are released under the CC0-1.0 license.

All licenses can be found under LICENSES