Skip to content
faervan edited this page Jan 6, 2025 · 14 revisions

Welcome to the bar-rs wiki!

While the configuration options aren't extensive at the moment, it's still good to know what tools you've got!

Config path

On Linux, the config path is $XDG_DATA_HOME/bar-rs/bar-rs.ini or $HOME/.local/share/bar-rs/bar-rs.ini

Example:
/home/alice/.config/bar-rs/bar-rs.ini

If it isn't, you may check here

Syntax

bar-rs uses an ini-like configuration, which should be pretty easy to understand and use.

It looks like this:

[section]
key = value

Data types

Data type Description Examples
bool Either yes or no true or false, 1 or 0, enabled or disabled...
Color A color as defined in the CSS Color Module Level 4 rgba(255, 0, 0, 0.5), blue, rgb(255, 255, 255)
String Just a String DP-1
float A floating point number 20, 5.8
Value list A list of values, separated by commas 20, 5, 20

General

The general section contains three options:

Option Description Data type Default
monitor The monitor on which bar-rs should be. You might also have to set a hyprland rule for this. String eDP-1
hot_reloading Whether bar-rs should monitor the config file for changes bool true
close_on_fullscreen Whether bar-rs should automatically close it's window when the active workspace is in fullscreen mode bool true

Example:

[general]
monitor = DP-1
hot_reloading = true
close_on_fullscreen = true

General Styling

Some of these options might get overwritten by module-specific settings.

Option Description Data type Default
background Background color of the status bar Color rgba(0, 0, 0, 0.5)
spacing Space between the modules, can be different for left, center and right Value list (float) 20, 20, 20
font_size Default font size float 16
icon_size Default icon size float 20
text_color Default text color Color white
icon_color Default icon color Color white

Example:

[style]
background = rgba(0, 0, 0, 0.5)
spacing = 20, 5, 20
font_size = 16
icon_size = 20
text_color = white
icon_color = white

Modules

The [module] section sets the enabled modules for each side:

Example:

[modules]
left = hyprland.workspaces, hyprland.window
center = date, time
right = media, volume, cpu, memory

The following modules are currently available:

Module Description
cpu Shows the current CPU usage
memory Shows the current memory usage
time Shows the local time
date Shows the local date
battery Shows the current capacity and remaining time
media Shows the currently playing media as reported by playerctl
volume Shows the current audio volume as reported by wpctl, updated by pactl
hyprland.window Shows the name of the currently focused window
hyprland.workspaces Shows the currently open workspaces

To configure modules individually use a section name like this:

[module:{{name}}]

where {{name}} is the name of the module, e. g. cpu

All modules accept font_size, icon_size, text_color and icon_color.
hyprland.workspaces additionally accepts active_color and active_background

Example:

[module:time]
icon_size = 24

[module:hyprland.workspaces]
active_color = black
active_background = rgba(255, 255, 255, 0.5)

Clone this wiki locally