summaryrefslogtreecommitdiff
path: root/README.md
blob: 4c18872ad2a9804af2eb8d55599b35143d09366e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# i3bar-river

This is a port of `i3bar` for [river](https://github.com/riverwm/river).

## i3bar compatibility

I've tested [`i3status-rs`](https://github.com/greshake/i3status-rust), [`bumblebee-status`](https://github.com/tobi-wan-kenobi/bumblebee-status) and [`py3status`](https://github.com/ultrabug/py3status) and everything seems usable.

A list of things that are missing (for now):
- `border[_top|_right|_bottom|_left]`
- Click events lack some info (IDK if anyone actually relies on `x`, `y`, `width`, etc.)
- Multiple seat support (river doesn't support this either, so it's fine for now)
- HiDPI
- Tray icons

## Advantages

- `river` support (obviously)
- `short_text` switching is "progressive" (see https://github.com/i3/i3/issues/4113)

## Installation

External dependencies: `libpango1.0-dev`.

Just clone the repo and use `cargo` to build the project:

```
git clone https://github.com/MaxVerevkin/i3bar-river
cd i3bar-river
cargo install --path .
```

Then add this to the end of your river init script:

```
riverctl spawn i3bar-river
```

## Configuration

The configuration file should be stored in `$XDG_CONFIG_HOME/i3bar-river/config.toml` or `~/.config/i3bar-river/config.toml`.

Example configuration (every parameter is optional):

```toml
background = "#282828"
color = "#ffffff"
separator = "#9a8a62"
tag_fg = "#d79921"
tag_bg = "#282828"
tag_focused_fg = "#1d2021"
tag_focused_bg = "#689d68"
tag_urgent_fg = "#282828"
tag_urgent_bg = "#cc241d"
font = "JetBrainsMono Nerd Font 10"
height = 20
command = "i3status-rs"
```