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 4efb7df7db
Merge branch 'doc-fix-alsa'
4 days ago
.builds ci: run codespell on CHANGELOG.md 2 months ago
bar bar/xcb: fallback to non-primary monitor 2 months ago
completions log: make more logging options configurable 1 year ago
decorations meson: add 'fcft' dependency to decorations and modules 1 year ago
doc doc: yambar-modules-alsa: change highlighting 4 days ago
examples Merge branch 'dwltags-script' 5 days ago
external moduel/river: wip: new module; 'tags' status on Wayland compositor 'river' 7 months ago
modules module/script: fix typo in memcmp() 2 weeks ago
particles particle/progress-bar: handle tag_for_name() failing 3 months ago
subprojects subprojects: use meson wrap files for tllist+fcft 2 months ago
test Rename project: f00bar -> yambar 1 year ago
.gitignore subprojects: use meson wrap files for tllist+fcft 2 months ago
.gitlab-ci.yml ci: run codespell on CHANGELOG.md 2 months ago
.gitmodules fcft/tllist: remove git submodules 1 year ago
CHANGELOG.md changelog: add reference to the issue 1 week ago
LICENSE license: MIT 2 years ago
PKGBUILD meson/PKGBUILD: bump to 1.6.1 1 month ago
PKGBUILD.wayland-only meson/PKGBUILD: bump to 1.6.1 1 month ago
README.md subprojects: use meson wrap files for tllist+fcft 2 months ago
color.h initial commit: wip 2 years ago
config-verify.c config-verify: add conf_verify_list() 8 months ago
config-verify.h config-verify: add conf_verify_list() 8 months ago
config.c config: fix asan signed integer overflow warning 1 month ago
config.h fcft: adjust to fcft-2.0 API changes 10 months ago
decoration.h cairo: replace cairo with pixman in decos, particles and modules 1 year ago
generate-version.sh generate-version: check for .git directory in *src* dir 1 year ago
log.c log: make syslog facility and level configurable, always log filename+lineno 1 year ago
log.h log: make syslog facility and level configurable, always log filename+lineno 1 year ago
main.c main: no need to block SIGCHLD anymore, we don’t use it 3 months ago
meson.build meson/PKGBUILD: bump to 1.6.1 1 month ago
meson_options.txt meson: initial support for building plugins as shared libraries 1 year ago
module.c particle: remove cairo context from begin_expose() 1 year ago
module.h modules: move 'content' and 'anchors' to MODULE_COMMON_ATTRS 1 year ago
particle.c particle: reset signals and signal mask when executing an on-click handler 3 months ago
particle.h fcft: adjust to fcft-2.0 API changes 10 months ago
plugin.c module/script: wip: new plugin, reads data from a user provided script/binary 3 months ago
plugin.h plugins: export a const function pointer interface struct 2 years ago
screenshot.png screenshot: update 1 year ago
stride.h font: initial port from cairo scaled fonts to raw freetype + pixman 1 year ago
tag.c codespell: spelling fixes 2 months ago
tag.h Reduce header intra-dependencies 2 years ago
xcb.c misc: xcb_connect() always returns a non-NULL pointer 2 years ago
xcb.h xcb: extern declare cached XCB atoms in header file 9 months ago
yambar.desktop desktop: add Desktop Entry file 1 year ago
yml.c yml: don’t crash when (trying to) merge anchors that aren’t dictionaries 2 weeks ago
yml.h yml: add line/column info to every node 2 years ago

README.md

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