README.md

Hyprnotify

A DBus Implementation for 'hyprctl notify'

Table of Contents

1. About The Project
2. Getting Started
   • Arch Linux
   • Other Linux Distributions
   • Building from Source
3. Usage
   • Command-line arguments
   • Examples
   • Custom Hints
   • Note about `replace-id`
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

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

(back to top)

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.

yay -S hyprnotify

NixOS

hyprnotify is available on NixOS unstable. It is quite simple to add:

1. Add the unstable tarball:

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

2. Add an overlay to use unstable packages

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

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

2. Build

   go build ./cmd/hyprnotify

3. Run the binary

   ./hyprnotify

(back to top)

Usage

Execute the daemon:

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:

notify-send "Hello, World!"

Send a notification with body text:

notify-send "Chat?" "Is this real"

Add a font-size hint:

notify-send "This is very big!" -h int:x-hyprnotify-font-size:40

Add an urgency hint and last for 20 seconds:

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

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.

(back to top)

Roadmap

• Implement the DBus Specification
• Replace shell command invocation with IPC
• Hints Support:
  • urgency
  • font-size
  • color
  • icon
• Add support for sound
  • Default sound support
  • sound hints
• Fix race condition in CloseNotification Signal
• Scrap the Project

(back to top)

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

(back to top)

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

(back to top)

Contact

Harsh Sharma - @codelif_ - harsh@codelif.in

Project Link: https://github.com/codelif/hyprnotify

(back to top)

Acknowledgments

• hyprwm community for Hyprland (special thanks to vaxry)
• go for go
• Freedesktop.org Desktop Notification Specification

(back to top)