Waybar/README.md

# 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)

> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>
> Available in [all major distributions](https://github.com/Alexays/Waybar/wiki/Installation)<br>
> *Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)*

#### Current features
- Sway (Workspaces, Binding mode, Focused window name)
- River (Mapping mode, Tags, Focused window name)
- Hyprland (Window Icons, Workspaces, Focused window name)
- DWL (Tags, Focused window name) [requires dwl ipc patch](https://github.com/djpohly/dwl/wiki/ipc)
- Tray [#21](https://github.com/Alexays/Waybar/issues/21)
- Local time
- Battery
- UPower
- Power profiles daemon
- Network
- Bluetooth
- Pulseaudio
- Privacy Info
- Wireplumber
- Disk
- Memory
- Cpu load average
- Temperature
- MPD
- Custom scripts
- Custom image
- Multiple output configuration
- And many more customizations

#### Configuration and Styling

[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).

### 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)

An Ubuntu PPA with more recent versions is available
[here](https://launchpad.net/~nschloe/+archive/ubuntu/waybar).


#### Building from source

```bash
$ git clone https://github.com/Alexays/Waybar
$ cd Waybar
$ meson build
$ ninja -C build
$ ./build/waybar
# If you want to install it
$ ninja -C build install
$ waybar
```

**Dependencies**

```
gtkmm3
jsoncpp
libsigc++
fmt
wayland
chrono-date
spdlog
libgtk-3-dev [gtk-layer-shell]
gobject-introspection [gtk-layer-shell]
libgirepository1.0-dev [gtk-layer-shell]
libpulse [Pulseaudio module]
libnl [Network module]
libappindicator-gtk3 [Tray module]
libdbusmenu-gtk3 [Tray module]
libmpdclient [MPD module]
libsndio [sndio module]
libevdev [KeyboardState module]
xkbregistry
upower [UPower battery module]
```

**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 \
  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
```


Contributions welcome!<br>
Have fun :)<br>
The style guidelines are [Google's](https://google.github.io/styleguide/cppguide.html)

## License

Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).
rm travis-ci shield 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)`
Update README.md 2018-08-08 21:58:43 +00:00
Update README.md 2018-08-10 10:28:54 +00:00			`> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>`
Clear README.md from duplicated list of distributions It doesn’t make sense to keep the list in README.md when we maintain it in Wiki as well. 2023-12-07 06:53:45 +00:00			`> Available in [all major distributions](https://github.com/Alexays/Waybar/wiki/Installation)<br>`
Update README.md 2019-06-11 11:55:35 +00:00			`> Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)`
chore(README): add preview 2018-08-08 22:06:10 +00:00
add repo info to README 2020-08-08 11:17:56 +00:00			`#### Current features`
chore: update README 2018-11-16 09:06:24 +00:00			`- Sway (Workspaces, Binding mode, Focused window name)`
README.md: add river/mode to feature list 2022-06-02 14:36:18 +00:00			`- River (Mapping mode, Tags, Focused window name)`
chore: update Hyprland's featureset in readme 2024-01-08 23:31:15 +00:00			`- Hyprland (Window Icons, Workspaces, Focused window name)`
Add dwl/window module 2024-03-14 20:07:45 +00:00			`- DWL (Tags, Focused window name) [requires dwl ipc patch](https://github.com/djpohly/dwl/wiki/ipc)`
Update README.md 2019-04-16 11:42:49 +00:00			`- Tray [#21](https://github.com/Alexays/Waybar/issues/21)`
Update README.md 2018-08-08 21:58:43 +00:00			`- Local time`
			`- Battery`
Added UPower to README 2022-07-31 08:56:42 +00:00			`- UPower`
Introduce power-profiles-daemon module We introduce a module in charge to display and toggle on click the power profiles via power-profiles-daemon. https://gitlab.freedesktop.org/upower/power-profiles-daemon This daemon is pretty widespread. It's the component used by Gnome and KDE to manage the power profiles. The power management daemon is a pretty important software component for laptops and other battery-powered devices. We're using the daemon DBus interface to: - Fetch the available power profiles. - Track the active power profile. - Change the active power profile. The original author recently gave up maintenance on the project. The Upower group took over the maintenance burden… …and created a new DBus name for the project. The old name is still advertised for now. We use the old name for compatibility sake: most distributions did not release 0.20, which introduces this new DBus name. We'll likely revisit this in the future and point to the new bus name. See the inline comment for more details. Given how widespread this daemon is, I activated the module in the default configuration. 2024-02-18 21:06:21 +00:00			`- Power profiles daemon`
Update README.md 2018-08-10 10:28:54 +00:00			`- Network`
Update README.md 2020-04-17 07:09:30 +00:00			`- Bluetooth`
chore(README): update preview 2018-08-09 21:57:11 +00:00			`- Pulseaudio`
Added documentation 2023-11-04 13:12:45 +00:00			`- Privacy Info`
Update README.md 2022-11-24 19:37:30 +00:00			`- Wireplumber`
chore: update README 2019-09-25 08:27:51 +00:00			`- Disk`
Update README.md 2018-08-10 10:28:54 +00:00			`- Memory`
			`- Cpu load average`
feat(temperature): update README 2019-03-13 15:56:13 +00:00			`- Temperature`
feat: Add basic support for MPD 2019-04-16 14:34:37 +00:00			`- MPD`
fix(README): typo 2018-08-10 14:29:37 +00:00			`- Custom scripts`
Update README.md 2022-11-24 19:51:54 +00:00			`- Custom image`
Update README.md 2019-02-01 20:52:38 +00:00			`- Multiple output configuration`
Fixed English mechanics: grammar, punctuation, and styling. 2022-03-08 23:52:20 +00:00			`- And many more customizations`
Update README.md 2018-08-10 10:28:54 +00:00
add repo info to README 2020-08-08 11:17:56 +00:00			`#### Configuration and Styling`
Update README.md 2018-08-08 21:58:43 +00:00
Update README.md 2018-08-10 10:28:54 +00:00			`[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).`

add repo info to README 2020-08-08 11:17:56 +00:00			`### Installation`

			`Waybar is available from a number of Linux distributions:`

README: tweak repology badge * Change repology badge header * Use 3 columns instead of 1 to display badge 2024-03-15 15:05:55 +00:00			`[![Packaging status](https://repology.org/badge/vertical-allrepos/waybar.svg?columns=3&header=Waybar%20Downstream%20Packaging)](https://repology.org/project/waybar/versions)`
add repo info to README 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`
Update README.md 2018-08-09 12:00:08 +00:00
			```bash
Update README.md 2018-08-10 10:28:54 +00:00			`$ git clone https://github.com/Alexays/Waybar`
chore: update README 2018-11-16 09:07:20 +00:00			`$ cd Waybar`
Update README.md 2018-08-10 10:28:54 +00:00			`$ meson build`
			`$ ninja -C build`
			`$ ./build/waybar`
Update README.md 2018-12-28 23:06:59 +00:00			`# If you want to install it`
			`$ ninja -C build install`
			`$ waybar`
			```

			`Dependencies`

			```
			`gtkmm3`
			`jsoncpp`
			`libsigc++`
Add fmt dependency to README.md 2019-01-25 15:38:38 +00:00			`fmt`
Update README.md 2018-12-28 23:06:59 +00:00			`wayland`
Add missing dependencies to README 2020-04-19 00:30:08 +00:00			`chrono-date`
			`spdlog`
add dependencies of gtk-layer-shell to readme 2019-12-28 14:19:42 +00:00			`libgtk-3-dev [gtk-layer-shell]`
			`gobject-introspection [gtk-layer-shell]`
			`libgirepository1.0-dev [gtk-layer-shell]`
Update README.md 2018-12-28 23:06:59 +00:00			`libpulse [Pulseaudio module]`
			`libnl [Network module]`
Add missing dependencies to README 2020-04-19 00:30:08 +00:00			`libappindicator-gtk3 [Tray module]`
Update README.md 2018-12-28 23:06:59 +00:00			`libdbusmenu-gtk3 [Tray module]`
feat: Add basic support for MPD 2019-04-16 14:34:37 +00:00			`libmpdclient [MPD module]`
sndio: Add module. - can control sndio: change volume, toggle mute - appearance is somewhat dynamic: takes muted status into account - uses polling inside sleeper thread to update values - uses sioctl_* functions, requires sndio>=1.7.0. 2020-09-06 17:44:13 +00:00			`libsndio [sndio module]`
Basic keyboard state module 2021-02-07 20:05:11 +00:00			`libevdev [KeyboardState module]`
add Debian build dependency to README 2021-12-14 18:28:13 +00:00			`xkbregistry`
Added UPower to README 2022-07-31 08:56:42 +00:00			`upower [UPower battery module]`
Update README.md 2018-08-09 12:00:08 +00:00			```

Add build dependencies 2020-05-02 11:06:15 +00:00			`Build dependencies`

			```
			`cmake`
			`meson`
			`scdoc`
			`wayland-protocols`
			```

Fixed English mechanics: grammar, punctuation, and styling. 2022-03-08 23:52:20 +00:00			`On Ubuntu, you can install all the relevant dependencies using this command (tested with 19.10 and 20.04):`
Provide easy bootstrap command for Ubuntu-users 2019-12-09 12:20:29 +00:00
			```
readme: adding libspdlog-dev to list of ubuntu dependencies, also sorting and cleaning up list to make it easier to read and copy 2020-03-05 13:57:19 +00:00			`sudo apt install \`
			`clang-tidy \`
			`gobject-introspection \`
			`libdbusmenu-gtk3-dev \`
Basic keyboard state module 2021-02-07 20:05:11 +00:00			`libevdev-dev \`
readme: adding libspdlog-dev to list of ubuntu dependencies, also sorting and cleaning up list to make it easier to read and copy 2020-03-05 13:57:19 +00:00			`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 \`
add Debian build dependency to README 2021-12-14 18:28:13 +00:00			`scdoc \`
Added UPower to README 2022-07-31 08:56:42 +00:00			`upower \`
add Debian build dependency to README 2021-12-14 18:28:13 +00:00			`libxkbregistry-dev`
Provide easy bootstrap command for Ubuntu-users 2019-12-09 12:20:29 +00:00			```


Fixed English mechanics: grammar, punctuation, and styling. 2022-03-08 23:52:20 +00:00			`Contributions welcome!<br>`
			`Have fun :)<br>`
			`The style guidelines are [Google's](https://google.github.io/styleguide/cppguide.html)`
Update README.md 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).`