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 是一款高度可定制的状态栏,专为 Sway、Hyprland、River 等 Wayland 合成器以及其他基于 wlroots 的环境设计,提供电池、网络、音频、时钟等模块。
这是我需要运行的图形界面应用,还是我要在代码里调用的库?它是一个独立的、基于 GTK 的状态栏应用,作为 Wayland 会话的一部分运行,不是可以嵌入项目中的库或脚本。
我该怎么让它运行起来?通过你的 Linux 发行版包管理器安装(Ubuntu 的 PPA 提供更新的版本),或者自己从源码编译,然后把默认配置和样式表复制到 ~/.config/waybar/ 目录下,再按自己的喜好修改。
我必须用 Sway 这样的特定 Wayland 合成器才能使用它吗?是的。Waybar 专门面向 Wayland/wlroots 合成器,已确认支持 Sway、River、Hyprland、Niri、Mango、DWL 和 Wayfire;它无法在 X11 上运行。
每个功能在所有合成器上都一样吗?不一样。各合成器支持的功能有所不同(例如窗口标题、布局或模式指示器并非处处可用),而且 DWL 的支持需要先额外打一个 IPC 补丁。
Waybar 开箱即用包含哪些模块?它内置了电源与硬件模块(电池、UPower、CPU、内存、磁盘、温度)、连接模块(网络、蓝牙、GPS、WWAN)、音频与媒体模块(PulseAudio、WirePlumber、MPD、MPRIS),以及时钟、系统托盘、空闲抑制器、自定义脚本等桌面相关的附加功能。
我能让它配合我的主题风格吗?可以。它附带默认配置和 CSS 样式表,你可以复制到 ~/.config/waybar/ 目录下;官方的 Styling 指南和社区的 Examples 页面还涵盖了完整的视觉定制方法。
我应该从哪里下载 Waybar?只从官方 GitHub 页面或你所用发行版的官方软件仓库下载。项目明确提醒它没有官方网站,因此任何声称是官网的其他网站都不应被信任。
Creator
Alexays
Size
7.3 MB
Stars
12.1K
Age
8y
Commits · 90 Days