bar-rs

A simple status bar, written using iced-rs (specifically the pop-os fork of iced, which supports the wlr layer shell protocol)

Note

bar-rs is currently undergoing a full rewrite, see #24 for the reasons.
Progress is a bit slow since I am working on some other, smaller projects which I will complete first.
Development is active in the crabbar_rework branch again.

Currently bar-rs supports only a small amount of configuration. It works on Wayland compositors implementing the wlr layer shell protocol, but right now only features Hyprland, Niri and Wayfire modules for active workspace and window display.

For a list of all currently supported modules, see the Wiki

Features

• Dynamic module activation/ordering
• Hot config reloading
• very basic style customization
• basic vertical bar support
• a base set of useful modules
• Module interactivity (popups, buttons)
• hyprland workspace + window modules
• wayfire workspace + window modules
• niri workspace + window modules
• basic bluetooth connections monitoring support
• sway workspace + window modules
• custom modules
• additional modules (wifi, pacman updates...)
• system tray support
• plugin api (for custom rust modules)
• custom fonts
• X11 support
• ...

Installation

On Arch Linux

see packaging/arch

Building from source

# Clone the project
git clone https://github.com/faervan/bar-rs.git
cd bar-rs

# Build the project - This might take a while
cargo build --release

# Install the bar-rs helper script to easily launch and kill bar-rs
bash install.sh

# Optional: Clean unneeded build files afterwards:
find target/release/* ! -name bar-rs ! -name . -type d,f -exec rm -r {} +

# Update the project
git pull

# Build the project - This will be considerably faster if you didn't clean the build files after installing
cargo build --release

# Optional: Clean unneeded build files afterwards:
find target/release/* ! -name bar-rs ! -name . -type d,f -exec rm -r {} +

bar-rs open

./target/release/bar-rs
# or using cargo:
cargo run --release

Configuration

Example configurations can be found in default_config.
See the Wiki for more.

Logs

If bar-rs is launched via the bar-rs script, it's logs are saved to /tmp/bar-rs.log and should only contain anything if there is an error. If an error occurs and all dependencies are installed on your system, please feel free to open an issue

Recommendations + feature requests

If you have an idea on what could improve bar-rs, or you would like to see a specific feature implemented, please open an issue.

Contributing

If you want to contribute, create an issue about the feature you'd like to implement or comment on an existing one. You may also contact me on matrix or discord.

Contributing by creating new modules should be pretty easy and straight forward if you know a bit about rust. You just have to implement the Module and Builder traits for your new module and register it in src/modules/mod.rs.
Take a look at docs.iced.rs for info about what to place in the view() method of the Module trait.

Extra credits

Next to all the great crates this projects depends on (see Cargo.toml) and the cli utils listed in Extra dependencies, bar-rs also uses NerdFont (see assets/3270)