Waybar/README.md

126 lines
3.0 KiB
Markdown
Raw Normal View History

2021-08-23 06:02:08 +00: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 21:58:43 +00:00
2018-08-10 10:28:54 +00:00
> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>
> Available in [all major distributions](https://github.com/Alexays/Waybar/wiki/Installation)<br>
2019-06-11 11:55:35 +00:00
> *Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)*
2018-08-08 22:06:10 +00:00
2020-08-08 11:17:56 +00:00
#### Current features
2018-11-16 09:06:24 +00:00
- Sway (Workspaces, Binding mode, Focused window name)
- River (Mapping mode, Tags, Focused window name)
- Hyprland (Window Icons, Workspaces, Focused window name)
2024-03-14 20:07:45 +00:00
- DWL (Tags, Focused window name) [requires dwl ipc patch](https://github.com/djpohly/dwl/wiki/ipc)
2019-04-16 11:42:49 +00:00
- Tray [#21](https://github.com/Alexays/Waybar/issues/21)
2018-08-08 21:58:43 +00:00
- Local time
- Battery
2022-07-31 08:56:42 +00:00
- UPower
- Power profiles daemon
2018-08-10 10:28:54 +00:00
- Network
2020-04-17 07:09:30 +00:00
- Bluetooth
2018-08-09 21:57:11 +00:00
- Pulseaudio
2023-11-04 13:12:45 +00:00
- Privacy Info
2022-11-24 19:37:30 +00:00
- Wireplumber
2019-09-25 08:27:51 +00:00
- Disk
2018-08-10 10:28:54 +00:00
- Memory
- Cpu load average
2019-03-13 15:56:13 +00:00
- Temperature
2019-04-16 14:34:37 +00:00
- MPD
2018-08-10 14:29:37 +00:00
- Custom scripts
2022-11-24 19:51:54 +00:00
- Custom image
2019-02-01 20:52:38 +00:00
- Multiple output configuration
- And many more customizations
2018-08-10 10:28:54 +00:00
2020-08-08 11:17:56 +00:00
#### Configuration and Styling
2018-08-08 21:58:43 +00:00
2018-08-10 10:28:54 +00:00
[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).
2020-08-08 11:17:56 +00:00
### Installation
Waybar is available from a number of Linux distributions:
[![Packaging status](https://repology.org/badge/vertical-allrepos/waybar.svg?columns=3&header=Waybar%20Downstream%20Packaging)](https://repology.org/project/waybar/versions)
2020-08-08 11:17:56 +00:00
An Ubuntu PPA with more recent versions is available
[here](https://launchpad.net/~nschloe/+archive/ubuntu/waybar).
#### Building from source
2018-08-09 12:00:08 +00:00
```bash
2018-08-10 10:28:54 +00:00
$ git clone https://github.com/Alexays/Waybar
2018-11-16 09:07:20 +00:00
$ cd Waybar
$ meson setup build
2018-08-10 10:28:54 +00:00
$ ninja -C build
$ ./build/waybar
2018-12-28 23:06:59 +00:00
# If you want to install it
$ ninja -C build install
$ waybar
```
**Dependencies**
```
gtkmm3
jsoncpp
libsigc++
2019-01-25 15:38:38 +00:00
fmt
2018-12-28 23:06:59 +00:00
wayland
2020-04-19 00:30:08 +00:00
chrono-date
spdlog
libgtk-3-dev [gtk-layer-shell]
gobject-introspection [gtk-layer-shell]
libgirepository1.0-dev [gtk-layer-shell]
2018-12-28 23:06:59 +00:00
libpulse [Pulseaudio module]
libnl [Network module]
2020-04-19 00:30:08 +00:00
libappindicator-gtk3 [Tray module]
2018-12-28 23:06:59 +00:00
libdbusmenu-gtk3 [Tray module]
2019-04-16 14:34:37 +00:00
libmpdclient [MPD module]
libsndio [sndio module]
2021-02-07 20:05:11 +00:00
libevdev [KeyboardState module]
2021-12-14 18:28:13 +00:00
xkbregistry
2022-07-31 08:56:42 +00:00
upower [UPower battery module]
2018-08-09 12:00:08 +00:00
```
2020-05-02 11:06:15 +00: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 20:05:11 +00: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 18:28:13 +00:00
scdoc \
2022-07-31 08:56:42 +00:00
upower \
2021-12-14 18:28:13 +00: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 10:28:54 +00:00
## License
Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).