SwayNotificationCenter/README.md

74 lines
1.7 KiB
Markdown
Raw Normal View History

2021-07-28 20:32:43 +03:00
# SwayNotificationCenter
A simple notification daemon with a gui built for Sway (potentially any wm with wlroots).
## Features
- Keyboard shortcuts
2021-07-28 20:32:43 +03:00
- A panel to view previous notifications
2021-07-29 22:38:42 +03:00
- Show album art for notifications like Spotify
2021-07-29 22:37:40 +03:00
- Do not disturb
2021-07-30 19:20:29 +03:00
- Click notification to execute default action
- Show alternative notification actions
2021-07-31 01:37:11 +03:00
- Customization through a CSS file
2021-07-28 20:32:43 +03:00
- The same features as any other basic notification daemon
2021-07-29 11:09:07 +03:00
## Planned Features
- Slick animations 😎
2021-08-01 01:18:12 +03:00
- Other build scripts than a PKGBUILD (debian and/or RHEL systems)
2021-07-29 11:09:07 +03:00
2021-07-28 20:32:43 +03:00
## Install
2021-07-30 23:36:50 +03:00
Arch:
2021-07-30 23:49:36 +03:00
The package is available on the [AUR](https://aur.archlinux.org/packages/swaync-git/)
2021-07-30 23:36:50 +03:00
Other:
2021-07-28 20:32:43 +03:00
```zsh
meson build
ninja -C build
2021-07-30 23:14:17 +03:00
meson install -C build
2021-07-28 20:32:43 +03:00
```
## Run
2021-07-29 12:16:01 +03:00
To start the daemon (remember to kill any other notification daemon before running)
2021-07-28 20:32:43 +03:00
```zsh
2021-07-30 19:59:06 +03:00
./build/src/swaync
2021-07-28 20:32:43 +03:00
```
To toggle the panel
```zsh
2021-07-31 01:37:11 +03:00
./build/src/swaync-client -t
2021-07-28 20:32:43 +03:00
```
## Notification Panel Shortcuts
- Up/Down: Navigate notifications
- Home: Navigate to the latest notification
- End: Navigate to the oldest notification
- Escape/Caps_Lock: Close notification panel
- Return: Execute default action or close notification if none
- Delete/BackSpace: Close notification
- C: Close all notifications
- Buttons 1-9: Execute alternative actions
2021-07-31 01:37:11 +03:00
## Configuring
2021-08-02 19:40:28 +03:00
To customize the appearance of the widgets, you'll need to create a `style.css`
file in `~/.config/swaync/style.css`.
<br>
At the time of writing, creating the file will override the default theme which
is located for most systems at `/etc/xdg/swaync/style.css`
2021-07-31 01:37:11 +03:00
2021-07-29 00:14:38 +03:00
## Screenshots
![Screenshot of desktop notification](./assets/desktop.png)
![Screenshot of panel](./assets/panel.png)
2021-08-01 01:23:34 +03:00
I wonder how this would look with some blur 🤔