Very resourcefriendly and feature-rich replacement for i3status, written in pure Rust
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Aaron Jacobs 4d2e595097
Merge pull request #269 from dywedir/update-nix
2 months ago
img Updated picture in README 1 year ago
src Wind direction (#262) 2 months ago
.gitignore add Cargo.lock since we are making an executable 1 year ago
.travis.yml Make Travis consider compiler warnings a build failure 1 year ago
Cargo.lock Update nix crate to 0.11 2 months ago
Cargo.toml Update nix crate to 0.11 2 months ago
LICENSE Initial commit 1 year ago
README.md Overhauls the README to a more modern style. 3 months ago
blocks.md Wind direction (#262) 2 months ago
example_config.toml Adding alert/warning to example config 1 year ago
example_icon.toml Actually use block configs 1 year ago
example_theme.toml Actually use block configs 1 year ago
rustfmt.toml run rustfmt on the codebase 1 year ago

README.md

i3status-rust

demo1

i3status-rs is a feature-rich and resource-friendly replacement for i3status, written in pure Rust. It provides a way to display “blocks” of system information (time, battery status, volume, etc) on the i3 bar. It is also compatible with sway.

For a list of available blocks, see the block documentation. Further information can be found on the Wiki.

Requirements

The Rust language and the cargo package manager are required to build the binary.

We also require Libdbus 1.6 or higher. On some older systems this may require installing libdbus-1-dev. See #194 if you are having dbus-related compilation issues.

Compilation is only tested with very recent stable versions of rustc. If you use a distro with older Rust packages, consider using rustup to install a newer toolchain.

Most blocks assume you are running Linux, and some have their own system requirements; these are mentioned in the block documentation.

Optional:

  • Font Awesome is required for icons="awesome". Version 5 of the font is causing some issues (see #130), so for now we recommend version 4. If you have access to the AUR, check out ttf-font-awesome-4.
  • Powerline Fonts are required for all themes using the powerline arrow char.
  • gperftools is used by development builds to profile block performance and find bottlenecks.

Getting Started

We strongly recommend using the development version. Older versions are not supported at this time.

If you are using Arch Linux, you can install from the AUR: i3status-rust-git.

Otherwise, you can install from source:

$ git clone https://github.com/greshake/i3status-rust
$ cd i3status-rust && cargo build --release
# Optional:
$ cp target/release/i3status-rs ~/bin/i3status-rs

Now you need to create a configuration. Edit the example configuration to your liking and put it to a sensible place (e.g. ~/.config/i3/status.toml).

Next, edit your i3 bar configuration to use i3status-rust. For example:

bar {
    font pango:DejaVu Sans Mono, FontAwesome 12
    position top
    status_command path/to/i3status-rs path/to/config.toml
    colors {
        separator #666666
        background #222222
        statusline #dddddd
        focused_workspace #0088CC #0088CC #ffffff
        active_workspace #333333 #333333 #ffffff
        inactive_workspace #333333 #333333 #888888
        urgent_workspace #2f343a #900000 #ffffff
    }
}

In order to use the built-in support for the Font Awesome icon set, you will need to include it in the font parameter, as above. Check to make sure that “FontAwesome” will correctly identify the font by using fc-match, e.g.

$ fc-match FontAwesome
fontawesome-webfont.ttf: "FontAwesome" "Regular"

(Note that the name of the Font Awesome font may have changed in version 5. See #130 for some discussion.)

Finally, reload i3: i3 reload.

Contributing

We welcome new contributors looking to implement new blocks or add features to existing blocks. If you are interested in doing so, it’s generally a good idea to file an issue for discussion first.

License

This project is licensed under the GPLv3. See the LICENSE.md file for details.