Waybar README

The project's README from github.com/Alexays/Waybar. As one markdown file: README.md.

Waybar

License Donate CI Release

Waybar

Highly customizable Wayland bar for Sway and wlroots-based compositors.
Available in all major distributions.

Installation · Wiki · Configuration · Styling · Examples · FAQ

Features

Compositor integration

Compositor Workspaces / Tags Window Layout Language Mode
Sway ✅ ✅ ✅ ✅
River ✅ ✅ ✅ ✅
Hyprland ✅ ✅ ✅ ✅
Niri ✅ ✅ ✅
Mango ✅ ✅ ✅ ✅ ✅
DWL ✅ ✅
Wayfire ✅ ✅

DWL requires the dwl IPC patch.

Modules

…and more. Every module is documented on the wiki (see the Modules sidebar).

Getting started

git clone https://github.com/Alexays/Waybar
cd Waybar
meson setup build
ninja -C build
./build/waybar          # run without installing

Waybar launches with a sensible default config. To make it yours, copy the default config and stylesheet into ~/.config/waybar/ and edit them. The Configuration and Styling guides cover every option, and Examples has ready-to-use community setups.

Installation

Waybar is packaged by most distributions:

Packaging status

An Ubuntu PPA with more recent versions is available here.

Building from source

git clone https://github.com/Alexays/Waybar
cd Waybar
meson setup build
ninja -C build
ninja -C build install   # optional
Runtime dependencies
gtkmm3       jsoncpp      libsigc++    fmt          wayland
chrono-date  spdlog       xkbregistry  libgtk-3-dev upower

libpulse             [Pulseaudio module]
libnl                [Network module]
libappindicator-gtk3 [Tray module]
libdbusmenu-gtk3     [Tray module]
libmpdclient         [MPD module]
libsndio             [sndio module]
libevdev             [KeyboardState module]
Build dependencies
cmake   meson   scdoc   wayland-protocols
Install dependencies — Ubuntu
sudo apt install \
  clang-tidy gobject-introspection libdbusmenu-gtk3-dev libevdev-dev \
  libfmt-dev libgirepository1.0-dev libgtk-3-dev libgtkmm-3.0-dev \
  libinput-dev libjsoncpp-dev libmpdclient-dev libnl-3-dev libnl-genl-3-dev \
  libpulse-dev libsigc++-2.0-dev libspdlog-dev libwayland-dev scdoc upower \
  libxkbregistry-dev
Install dependencies — Arch
pacman -S --asdeps \
  gtkmm3 jsoncpp libsigc++ fmt wayland chrono-date spdlog gtk3 \
  gobject-introspection libgirepository libpulse libnl libappindicator-gtk3 \
  libdbusmenu-gtk3 libmpdclient sndio libevdev libxkbcommon upower meson \
  cmake scdoc wayland-protocols glib2-devel

Contributing

Contributions are welcome — see CONTRIBUTING.md. The style guidelines are Google's C++ style.

Docs live in the man pages. Module documentation is written in man/ (scdoc) and auto-synced to the wiki. Edit the man page, not the wiki — see .github/wiki.

[!CAUTION] Distributions of Waybar are only released on the official GitHub page.
Waybar does not have an official website. Do not trust any site claiming to be official.

License

Waybar is licensed under the MIT license. See LICENSE for details.

Waybar (Alexays/Waybar)

Searching Database…

12.1K ·GitHub
Что это такое?Waybar — это легко настраиваемая панель статуса для композиторов Wayland, таких как Sway, Hyprland, River и других конфигураций на основе wlroots, с модулями для таких вещей, как батарея, сеть, звук и часы.
Это GUI-приложение, которое я запускаю, или библиотека, которую я подключаю в своем коде?Это самостоятельная панель на основе GTK, которая работает в составе сеанса Wayland, а не библиотека и не скрипт, который встраивается в проект.
Как его запустить?Установите его через менеджер пакетов вашего Linux-дистрибутива (в Ubuntu есть PPA с более новыми сборками) или соберите из исходников самостоятельно, затем скопируйте конфигурацию и таблицу стилей по умолчанию в ~/.config/waybar/ и отредактируйте их под себя.
Нужен ли мне конкретный композитор Wayland, например Sway, чтобы им пользоваться?Да — Waybar рассчитан именно на композиторы Wayland/wlroots, официально поддерживаются Sway, River, Hyprland, Niri, Mango, DWL и Wayfire; на X11 он не работает.
Работают ли все функции одинаково на каждом композиторе?Нет — набор функций зависит от композитора (например, заголовок окна, индикаторы раскладки или режима есть не везде), а для поддержки DWL сначала нужно применить дополнительный патч IPC.
Какие модули входят в Waybar по умолчанию?В комплект входят модули для питания и железа (батарея, UPower, CPU, память, диск, температура), для подключения (сеть, Bluetooth, GPS, WWAN), для звука и медиа (PulseAudio, WirePlumber, MPD, MPRIS), а также дополнительные модули для рабочего стола: часы, системный трей, ингибитор простоя и пользовательские скрипты.
Можно ли настроить его оформление под мою тему?Да, в комплект входят конфигурация и CSS-таблица стилей по умолчанию, которые копируются в ~/.config/waybar/; руководство по стилям и страница с примерами от сообщества описывают полную настройку внешнего вида.
Откуда скачать Waybar?Только с официальной страницы на GitHub или из официального репозитория пакетов вашего дистрибутива — в проекте прямо сказано, что у него нет официального сайта, поэтому любым другим сайтам, которые называют себя официальными, не стоит доверять.
Creator
Alexays
Size
7.3 MB
Stars
12.1K
Age
8y
Commits · 90 Days