codelif/hyprnotify — Gitpedia

<div align="center"> <a href="https://github.com/codelif/hyprnotify"> <img src="assets/logo.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">Hyprnotify</h3> A DBus Implementation for 'hyprctl notify' </div>  <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#arch-linux">Arch Linux</a></li> <li><a href="#other-linux-distributions">Other Linux Distributions</a></li> <li><a href="#building-from-source">Building from Source</a></li> </ul> </li> <li> <a href="#usage">Usage</a> <ul> <li><a href="#command-line-arguments">Command-line arguments</a></li> <li><a href="#examples">Examples</a></li> <li><a href="#custom-hints">Custom Hints</a></li> <li><a href="#note-about-replace-id">Note about `replace-id`</a></li> </ul> </li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details>

About The Project

Hyprnotify is a Freedesktop.org compliant notification daemon implementing hyprctl notify as its backend.

(<a href="#readme-top">back to top</a>)

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:

Add the unstable tarball:

nix
let
  unstableTarball =
    fetchTarball
      https://github.com/NixOS/nixpkgs/archive/nixos-unstable.tar.gz;
in
# ...

Add an overlay to use unstable packages

nix
nixpkgs.config = {
  packageOverrides = pkgs: {
    unstable = import unstableTarball {
      config = config.nixpkgs.config;
    };
  };
};

Add unstable.hyprnotify to your environment.systemPackages

Other Linux Distributions

You can download the release binaries directly from the releases page.

Building from Source

Prerequisites

go compiler
alsa-lib or libasound for sound support
libnotify to send notifications with notify-send (optional)

Compiling

Clone the repo and cd into it

sh
git clone https://github.com/codelif/hyprnotify.git
cd hyprnotify

Build
```
sh
go build ./cmd/hyprnotify
```
Run the binary
```
sh
./hyprnotify
```

(<a href="#readme-top">back to top</a>)

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.

(<a href="#readme-top">back to top</a>)

Roadmap

(<a href="#readme-top">back to top</a>)

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!