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 9f2197ca1c
Merge branch 'config-unsigned-ints'
2 weeks ago
.builds ci: build on alpine/latest, not edge 8 months ago
bar bar/wayland: handle failure to set initial size in setup() 2 weeks ago
completions main: add -d,--log-level=info|warning|error|none 4 months ago
decorations decos: verify: all integer options are supposed to be unsigned 2 weeks ago
doc doc: script: add missing column in options table 2 weeks ago
examples example: battery: map ‘unknown’ to ‘discharging’ 1 month ago
external module/foreign-toplevel: initial support 3 months ago
modules modules: verify: use conf_verify_unsigned() for options that should be >= 0 2 weeks ago
particles particles: verify: use conf_verify_unsigned() for options that should be >= 0 2 weeks ago
subprojects subprojects: use meson wrap files for tllist+fcft 11 months ago
test Rename project: f00bar -> yambar 2 years ago
.gitignore subprojects: use meson wrap files for tllist+fcft 11 months ago
.gitlab-ci.yml ci: build on alpine/latest, not edge 8 months ago
.gitmodules fcft/tllist: remove git submodules 2 years ago
.woodpecker.yml ci: also build release branches 1 month ago
CHANGELOG.md changelog: integer options incorrectly allowed < 0 values 2 weeks ago
LICENSE license: MIT 3 years ago
PKGBUILD meson/pkgbuild: bump version to 1.7.0 3 months ago
PKGBUILD.wayland-only meson/pkgbuild: bump version to 1.7.0 3 months ago
README.md ci: codeberg CI 2 months ago
color.h initial commit: wip 3 years ago
config-verify.c conf: bar/border: verify: all integer options are supposed to be unsigned 2 weeks ago
config-verify.h config-verify: add conf_verify_unsigned() 2 weeks ago
config.c Add layer option 3 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: handle git repo not having any tags 2 months ago
log.c log: LOG_ERRNO: include numeric value of errno 3 months ago
log.h log: pull in log.{c,h} from foot 4 months ago
main.c main: cast sig_atomic_t to long, to fix the printf portability 2 months ago
meson.build wayland: unbreak build without memfd_create 2 months ago
meson_options.txt Make libmpdclient an optional dependency 3 months ago
module.c particle: remove cairo context from begin_expose() 2 years ago
module.h module: add ‘description()’ to the module interface 5 months ago
particle.c signal: add the signal header needed for the signal functions 2 months ago
particle.h particles: verify: use conf_verify_unsigned() for options that should be >= 0 2 weeks ago
plugin.c deco: new decoration, ‘border’ 1 month 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 tag: add kib/mib/gib formatters 3 months ago
tag.h Add support binding on-click handlers to other buttons than LEFT 5 months 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 yml: silence unused variable warning with Clang 13 2 months ago
yml.h yml: add line/column info to every node 3 years ago

README.md

CI status

Yambar

Packaging status

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

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