Modular status panel for X11 and Wayland, inspired by https://github.com/jaagr/polybar
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.
 
 
 
Daniel Eklöf 2563a233d7 Release 1.6.1 11 months ago
bar bar/xcb: fallback to non-primary monitor 1 year ago
completions log: make more logging options configurable 2 years ago
decorations meson: add 'fcft' dependency to decorations and modules 2 years ago
doc doc: codespell fixes 11 months ago
examples examples: scripts: cpu: fix idle and total calculation 1 year ago
external moduel/river: wip: new module; 'tags' status on Wayland compositor 'river' 1 year ago
modules module/battery: re-open /sys/class/power_supply/<battery>/ every update 11 months ago
particles particle/progress-bar: handle tag_for_name() failing 1 year ago
test Rename project: f00bar -> yambar 2 years ago
.build.yml Rename project: f00bar -> yambar 2 years ago
.gitignore gitignore: subprojects directory 2 years ago
.gitlab-ci.yml ci: log toolchain version information 1 year ago
.gitmodules fcft/tllist: remove git submodules 2 years ago
CHANGELOG.md changelog: prepare for 1.6.1 11 months ago
LICENSE license: MIT 3 years ago
PKGBUILD meson/PKGBUILD: bump to 1.6.1 11 months ago
PKGBUILD.wayland-only meson/PKGBUILD: bump to 1.6.1 11 months ago
README.md readme: fix link to configuration examples 1 year ago
color.h initial commit: wip 3 years ago
config-verify.c config-verify: add conf_verify_list() 1 year ago
config-verify.h config-verify: add conf_verify_list() 1 year ago
config.c config: fix asan signed integer overflow warning 11 months ago
config.h fcft: adjust to fcft-2.0 API changes 2 years ago
decoration.h cairo: replace cairo with pixman in decos, particles and modules 2 years ago
generate-version.sh generate-version: check for .git directory in *src* dir 2 years ago
log.c log: make syslog facility and level configurable, always log filename+lineno 2 years ago
log.h log: make syslog facility and level configurable, always log filename+lineno 2 years ago
main.c main: no need to block SIGCHLD anymore, we don’t use it 1 year ago
meson.build meson/PKGBUILD: bump to 1.6.1 11 months ago
meson_options.txt meson: initial support for building plugins as shared libraries 3 years ago
module.c bar, module: particles may no longer return NULL in instantiate() 1 year ago
module.h modules: move 'content' and 'anchors' to MODULE_COMMON_ATTRS 2 years ago
particle.c particle: reset signals and signal mask when executing an on-click handler 1 year ago
particle.h fcft: adjust to fcft-2.0 API changes 2 years ago
plugin.c module/script: wip: new plugin, reads data from a user provided script/binary 1 year ago
plugin.h plugins: export a const function pointer interface struct 3 years ago
screenshot.png screenshot: update 2 years ago
stride.h font: initial port from cairo scaled fonts to raw freetype + pixman 2 years ago
tag.c codespell: spelling fixes 11 months ago
tag.h Reduce header intra-dependencies 3 years ago
xcb.c misc: xcb_connect() always returns a non-NULL pointer 3 years ago
xcb.h xcb: extern declare cached XCB atoms in header file 2 years ago
yambar.desktop desktop: add Desktop Entry file 2 years ago
yml.c codespell: spelling fixes 11 months ago
yml.h yml: add line/column info to every node 3 years ago

README.md

Yambar

Index

  1. Introduction
  2. Configuration
  3. Modules
  4. Installation
  5. Bugs

Introduction

screenshot

yambar is a lightweight and configurable status panel (bar, for short) for X11 and Wayland, that goes to great lengths to be both CPU and battery efficient - polling is only done when absolutely necessary.

It has a number of modules that provide information in the form of tags. For example, the clock module has a date tag that contains the current date.

The modules do not know how to present the information though. This is instead done by particles. And the user, you, decides which particles (and thus how to present the data) to use.

Furthermore, each particle can have a decoration - a background color or a graphical underline, for example.

There is no support for images or icons. use an icon font (e.g. Font Awesome, or Material Icons) if you want a graphical representation.

There are a number of modules and particles builtin. More can be added as plugins. You can even write your own!

To summarize: a bar displays information provided by modules, using particles and decorations. How is configured by you.

Configuration

Yambar is configured using YAML, in ~/.config/yambar/config.yml. It must define a top-level dictionary named bar:

bar:
  height: 26
  location: top
  background: 000000ff

  right:
    - clock:
        content:
          - string: {text: , font: "Font Awesome 5 Free:style=solid:size=12"}
          - string: {text: "{date}", right-margin: 5}
          - string: {text: , font: "Font Awesome 5 Free:style=solid:size=12"}
          - string: {text: "{time}"}

For details, see the man pages (yambar(5) is a good start).

Example configurations can be found in examples.

Modules

Available modules:

  • alsa
  • backlight
  • battery
  • clock
  • i3 (and Sway)
  • label
  • mpd
  • network
  • removables
  • river
  • script (see script examples)
  • sway-xkb
  • xkb (XCB backend only)
  • xwindow (XCB backend only)

Installation

If you have not installed tllist and fcft as system libraries, clone them into the subprojects directory:

mkdir -p subprojects
pushd subprojects
git clone https://codeberg.org/dnkl/tllist.git
git clone https://codeberg.org/dnkl/fcft.git
popd

To build, first, create a build directory, and switch to it:

mkdir -p bld/release && cd bld/release

Second, configure the build (if you intend to install it globally, you might also want --prefix=/usr):

meson --buildtype=release ../..

Optionally, explicitly disable a backend (or enable, if you want a configuration error if not all dependencies are met) by adding either -Dbackend-x11=disabled|enabled or -Dbackend-wayland=disabled|enabled to the meson command line.

Three, build it:

ninja

Optionally, install it:

ninja install

Bugs

Please report bugs to https://codeberg.org/dnkl/yambar/issues

The report should contain the following:

  • Which Wayland compositor (and version) you are running
  • Yambar version (yambar --version)
  • Log output from yambar (start yambar from a terminal)
  • If reporting a crash, please try to provide a bt full backtrace with symbols (i.e. use a debug build)
  • Steps to reproduce. The more details the better