JakeStanger/ironbar
1
1
Fork 0
mirror of https://github.com/JakeStanger/ironbar.git synced 2024-11-22 14:04:20 +03:00
Code Issues Packages Projects Releases Wiki Activity
Customisable gtk-layer-shell wlroots/sway bar written in rust.
92 Commits 6 Branches 21 Tags 10 MiB
Rust 97.5%
Nix 2%
Shell 0.5%
27f6abad67
Go to file
Jake Stanger 27f6abad67
chore: format and fix clippy warnings
2022-10-16 13:54:48 +01:00
.github/workflows ci: alter changelog categories 2022-09-25 22:50:17 +01:00
.idea chore(intellij): update run configs 2022-09-25 22:50:05 +01:00
examples feat: more positioning options (#23) 2022-10-15 16:27:25 +01:00
src chore: format and fix clippy warnings 2022-10-16 13:54:48 +01:00
.gitignore chore: initial commit 2022-08-14 14:30:13 +01:00
Cargo.lock chore(release): v0.6.0 2022-10-15 18:26:51 +01:00
Cargo.toml fix(logging): file log not capturing panics 2022-10-16 13:42:35 +01:00
CHANGELOG.md docs: update CHANGELOG.md for v0.6.0 [skip ci] 2022-10-15 17:27:37 +00:00
CONTRIBUTING.md feat(logging): IRONBAR_LOG and IRONBAR_FILE_LOG env vars 2022-10-16 13:42:59 +01:00
LICENSE chore: add mit license 2022-08-14 14:32:54 +01:00
README.md feat(logging): IRONBAR_LOG and IRONBAR_FILE_LOG env vars 2022-10-16 13:42:59 +01:00

README.md

Ironbar

Ironbar is a customisable and feature-rich bar for wlroots compositors, written in Rust. It uses GTK3 and gtk-layer-shell.

The bar can be styled to your liking using CSS and hot-loads style changes. For information and examples on styling please see the wiki.

Screenshot of fully configured bar with MPD widget open

Installation

Cargo

⚠ The Cargo version is currently outdated due to restrictions around publishing crates with patched dependencies.

cargo install ironbar

crate

Arch Linux

yay -S ironbar-git

aur package

Source

git clone https://github.com/jakestanger/ironbar.git
cd ironbar
cargo build --release
# change path to wherever you want to install
install target/release/ironbar ~/.local/bin/ironbar

repo

Running

All of the above installation methods provide a binary called ironbar.

You can set the IRONBAR_LOG or IRONBAR_FILE_LOG environment variables to error, warn, info, debug or trace to configure the log output level. These default to IRONBAR_LOG=info and IRONBAR_FILE_LOG=error. File output can be found at ~/.local/share/ironbar/error.log.

Configuration

Ironbar gives a lot of flexibility when configuring, including multiple file formats and options for scaling complexity: you can use a single config across all monitors, or configure different/multiple bars per monitor.

A full configuration guide can be found here.

Styling

To get started, create a stylesheet at .config/ironbar/style.css. Changes will be hot-reloaded every time you save the file.

A full styling guide can be found here.

Project Status

This project is in alpha, but should be usable. Everything that is implemented works and should be documented. Proper error handling is in place so things should either fail gracefully with detail, or not fail at all.

There is currently room for lots more modules, and lots more configuration options for the existing modules. The current configuration schema is not set in stone and breaking changes could come along at any point; until the project matures I am more interested in ease of use than backwards compatibility.

A few bugs do exist, and I am sure there are plenty more to be found.

The project will be actively developed as I am using it on my daily driver. Bugs will be fixed, features will be added, code will be refactored.

Contribution Guidelines

Please check here.

Acknowledgements

  • Waybar - A lot of the initial inspiration, and a pretty great bar.
  • Rustbar - Served as a good demo for writing a basic GTK bar in Rust
  • Smithay Client Toolkit - Essential in being able to communicate to Wayland