Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codelif/hyprnotify
DBus Implementation of Freedesktop Notification spec for 'hyprctl notify'
https://github.com/codelif/hyprnotify
dbus desktop-notifications freedesktop freedesktop-notifications hyprland notifications notify notify-send
Last synced: about 1 month ago
JSON representation
DBus Implementation of Freedesktop Notification spec for 'hyprctl notify'
- Host: GitHub
- URL: https://github.com/codelif/hyprnotify
- Owner: codelif
- License: apache-2.0
- Created: 2024-03-29T19:21:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T07:43:35.000Z (4 months ago)
- Last Synced: 2024-08-07T11:28:13.649Z (4 months ago)
- Topics: dbus, desktop-notifications, freedesktop, freedesktop-notifications, hyprland, notifications, notify, notify-send
- Language: Go
- Homepage:
- Size: 6.34 MB
- Stars: 43
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - hyprnotify
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Go][golang-shield]][golang-url]
Hyprnotify
A DBus Implementation for 'hyprctl notify'
Table of Contents
## About The Project
Hyprnotify is a [Freedesktop.org](https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html) compliant notification daemon implementing `hyprctl notify` as its backend.
## Getting Started
To get hyprnotify you can either download the binary build by github actions. Or build it locally.
### Arch Linux
`hyprnotify` is available on the AUR. You can install it with a AUR helper like `yay`.
```sh
yay -S hyprnotify
```
### NixOS
`hyprnotify` is available on NixOS unstable.
It is quite simple to add:
1. Add the unstable tarball:
```nix
let
unstableTarball =
fetchTarball
https://github.com/NixOS/nixpkgs/archive/nixos-unstable.tar.gz;
in
# ...
```
2. Add an overlay to use unstable packages
```nix
nixpkgs.config = {
packageOverrides = pkgs: {
unstable = import unstableTarball {
config = config.nixpkgs.config;
};
};
};
```
3. Add `unstable.hyprnotify` to your `environment.systemPackages`
### Other Linux Distributions
You can download the release binaries directly from the [releases](https://github.com/codelif/hyprnotify/releases) page.
### Building from Source
#### Prerequisites
- `go` compiler
- `alsa-lib` or `libasound` for sound support
- `libnotify` to send notifications with `notify-send` (optional)
#### Compiling
1. Clone the repo and cd into it
```sh
git clone https://github.com/codelif/hyprnotify.git
cd hyprnotify
```
2. Build
```sh
go build ./cmd/hyprnotify
```
3. Run the binary
```sh
./hyprnotify
```
## Usage
Execute the daemon:
```sh
hyprnotify
```
### Command-line arguments
| Argument | Remark |
|:-------------------:|:--------------------------------------------:|
|`--font-size` or `-f`| Set custom default font size (default is 13) |
|`--fixed-font-size` | Ignores font size hints |
|`--no-sound` or `-s` | Enable silent mode |
|`--help` | Displays help text |
> [!IMPORTANT]
> It is recommended to set the Hyprland default `font-family` to be `monospace` on hyprland.conf misc section. Otherwise you may experience unusual spacing and padding. See here: https://wiki.hyprland.org/Configuring/Variables/#misc
### Examples
Send a notification:
```sh
notify-send "Hello, World!"
```
Send a notification with body text:
```sh
notify-send "Chat?" "Is this real"
```
Add a font-size hint:
```sh
notify-send "This is very big!" -h int:x-hyprnotify-font-size:40
```
Add an urgency hint and last for 20 seconds:
```sh
notify-send "This is serious stuff!" -u critical -t 20000
```
### Custom Hints
| Hint | Example | Remark |
|:-----------------------:|:-----------------------------------:|:--------------------------------:|
| `x-hyprnotify-font-size`| `int:x-hyprnotify-font-size:30` | font size for notification |
| `x-hyprnotify-color` | `string:x-hyprnotify-color:#ff30fa` | hex color code for notif. color |
| `x-hyprnotify-icon` | `int:x-hyprnotify-icon:3` | icon identifier for notification |
#### `x-hyprnotify-icon`
| ID | Icon | Preview |
|:--:|:-------|:-------:|
|`0` |WARNING ||
|`1` |INFO ||
|`2` |HINT ||
|`3` |ERROR ||
|`4` |CONFUSED||
|`5` |OK ||
### Note about `replace-id`:
When using `replace-id` with `notify-send`
```sh
notify-send --replace-id=10 "Hello"
```
All the notifications with IDs more than `replace-id` will also be deleted. (11, 12, 13...) \
This is due to the inherent design of `hyprctl dismissnotify`. So, it is not fixable.\
\
Due to this, it is advisable to use it to replace only the latest notification.
## Roadmap
- [x] Implement the DBus Specification
- [x] Replace shell command invocation with IPC
- [x] Hints Support:
- [x] urgency
- [x] font-size
- [x] color
- [x] icon
- [ ] Add support for sound
- [x] Default sound support
- [ ] sound hints
- [x] Fix race condition in `CloseNotification` Signal
- [ ] Scrap the Project
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Apache-2.0 License. See `LICENSE` for more information.
## Contact
Harsh Sharma - [@codelif_](https://x.com/codelif_) - [email protected]
Project Link: [https://github.com/codelif/hyprnotify](https://github.com/codelif/hyprnotify)
## Acknowledgments
* [hyprwm community](https://github.com/hyprwm/Hyprland) for Hyprland (special thanks to [vaxry](https://github.com/vaxerski))
* [go](https://go.dev) for go
* [Freedesktop.org Desktop Notification Specification](https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html)
[contributors-shield]: https://img.shields.io/github/contributors/codelif/hyprnotify.svg?style=for-the-badge
[contributors-url]: https://github.com/codelif/hyprnotify/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/codelif/hyprnotify.svg?style=for-the-badge
[forks-url]: https://github.com/codelif/hyprnotify/network/members
[stars-shield]: https://img.shields.io/github/stars/codelif/hyprnotify.svg?style=for-the-badge
[stars-url]: https://github.com/codelif/hyprnotify/stargazers
[issues-shield]: https://img.shields.io/github/issues/codelif/hyprnotify.svg?style=for-the-badge
[issues-url]: https://github.com/codelif/hyprnotify/issues
[license-shield]: https://img.shields.io/github/license/codelif/hyprnotify.svg?style=for-the-badge
[license-url]: https://github.com/codelif/hyprnotify/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[golang-shield]: https://img.shields.io/badge/Golang-00ADD8?style=for-the-badge&logo=go&logoColor=FFFFFF
[golang-url]: https://go.dev