waybar/README.md

125 lines
3.2 KiB
Markdown
Raw Normal View History

2021-08-23 08:02:08 +02:00
# Waybar [![Licence](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Paypal Donate](https://img.shields.io/badge/Donate-Paypal-2244dd.svg)](https://paypal.me/ARouillard)<br>![Waybar](https://raw.githubusercontent.com/alexays/waybar/master/preview-2.png)
2018-08-08 23:58:43 +02:00
2018-08-10 12:28:54 +02:00
> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>
2023-08-14 12:42:33 +02:00
> Available in Arch [extra](https://www.archlinux.org/packages/extra/x86_64/waybar/) or
[AUR](https://aur.archlinux.org/packages/waybar-git/), [Gentoo](https://packages.gentoo.org/packages/gui-apps/waybar), [openSUSE](https://build.opensuse.org/package/show/X11:Wayland/waybar), and [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=waybar).<br>
2019-06-11 13:55:35 +02:00
> *Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)*
2018-08-09 00:06:10 +02:00
2020-08-08 13:17:56 +02:00
#### Current features
2018-11-16 10:06:24 +01:00
- Sway (Workspaces, Binding mode, Focused window name)
- River (Mapping mode, Tags, Focused window name)
2022-08-18 15:16:28 +02:00
- Hyprland (Focused window name)
2023-04-11 03:50:21 +02:00
- DWL (Tags) [requires dwl ipc patch](https://github.com/djpohly/dwl/wiki/ipc)
2019-04-16 13:42:49 +02:00
- Tray [#21](https://github.com/Alexays/Waybar/issues/21)
2018-08-08 23:58:43 +02:00
- Local time
- Battery
2022-07-31 10:56:42 +02:00
- UPower
2018-08-10 12:28:54 +02:00
- Network
2020-04-17 09:09:30 +02:00
- Bluetooth
2018-08-09 23:57:11 +02:00
- Pulseaudio
2022-11-24 20:37:30 +01:00
- Wireplumber
2019-09-25 10:27:51 +02:00
- Disk
2018-08-10 12:28:54 +02:00
- Memory
- Cpu load average
2019-03-13 16:56:13 +01:00
- Temperature
2019-04-16 16:34:37 +02:00
- MPD
2018-08-10 16:29:37 +02:00
- Custom scripts
2022-11-24 20:51:54 +01:00
- Custom image
2019-02-01 21:52:38 +01:00
- Multiple output configuration
- And many more customizations
2018-08-10 12:28:54 +02:00
2020-08-08 13:17:56 +02:00
#### Configuration and Styling
2018-08-08 23:58:43 +02:00
2018-08-10 12:28:54 +02:00
[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).
2020-08-08 13:17:56 +02:00
### Installation
Waybar is available from a number of Linux distributions:
[![Packaging status](https://repology.org/badge/vertical-allrepos/waybar.svg)](https://repology.org/project/waybar/versions)
An Ubuntu PPA with more recent versions is available
[here](https://launchpad.net/~nschloe/+archive/ubuntu/waybar).
#### Building from source
2018-08-09 14:00:08 +02:00
```bash
2018-08-10 12:28:54 +02:00
$ git clone https://github.com/Alexays/Waybar
2018-11-16 10:07:20 +01:00
$ cd Waybar
2018-08-10 12:28:54 +02:00
$ meson build
$ ninja -C build
$ ./build/waybar
2018-12-29 00:06:59 +01:00
# If you want to install it
$ ninja -C build install
$ waybar
```
**Dependencies**
```
gtkmm3
jsoncpp
libsigc++
2019-01-25 16:38:38 +01:00
fmt
2018-12-29 00:06:59 +01:00
wayland
2020-04-19 02:30:08 +02:00
chrono-date
spdlog
libgtk-3-dev [gtk-layer-shell]
gobject-introspection [gtk-layer-shell]
libgirepository1.0-dev [gtk-layer-shell]
2018-12-29 00:06:59 +01:00
libpulse [Pulseaudio module]
libnl [Network module]
2020-04-19 02:30:08 +02:00
libappindicator-gtk3 [Tray module]
2018-12-29 00:06:59 +01:00
libdbusmenu-gtk3 [Tray module]
2019-04-16 16:34:37 +02:00
libmpdclient [MPD module]
libsndio [sndio module]
2021-02-07 21:05:11 +01:00
libevdev [KeyboardState module]
2021-12-14 19:28:13 +01:00
xkbregistry
2022-07-31 10:56:42 +02:00
upower [UPower battery module]
2018-08-09 14:00:08 +02:00
```
2020-05-02 13:06:15 +02:00
**Build dependencies**
```
cmake
meson
scdoc
wayland-protocols
```
On Ubuntu, you can install all the relevant dependencies using this command (tested with 19.10 and 20.04):
```
sudo apt install \
clang-tidy \
gobject-introspection \
libdbusmenu-gtk3-dev \
2021-02-07 21:05:11 +01:00
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 \
2021-12-14 19:28:13 +01:00
scdoc \
2022-07-31 10:56:42 +02:00
upower \
2021-12-14 19:28:13 +01:00
libxkbregistry-dev
```
Contributions welcome!<br>
Have fun :)<br>
The style guidelines are [Google's](https://google.github.io/styleguide/cppguide.html)
2018-08-10 12:28:54 +02:00
## License
Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).