Skip to content

Latest commit

 

History

History
199 lines (147 loc) · 6.76 KB

README.md

File metadata and controls

199 lines (147 loc) · 6.76 KB
Raw

Notiflut-Land logo

Notiflut [Work in progress]

This project is a notification center designed specifically for wlroots-based Wayland compositors, implemented using Rust and Flutter. The notification center provides a seamless and intuitive user interface for managing and interacting with notifications on Wayland-based systems.

Screenshots

Notification center sreenshot Notification popup screenshot

Features

Freedesktop specifications

  • actions: The server will provide the specified actions to the user. Even if this cap is missing, actions may still be specified by the client, however the server is free to ignore them.

  • body: Supports body text. Some implementations may only show the summary (for instance, onscreen displays, marquee/scrollers)

  • body-hyperlinks: The server supports hyperlinks in the notifications.

  • body-images: The server supports images in the notifications.

  • body-markup: Supports markup in the body text. If marked up text is sent to a server that does not give this cap, the markup will show through as regular text so must be stripped clientside.

  • icon-static: Supports display of exactly 1 frame of any given image array. This value is mutually exclusive with "icon-multi", it is a protocol error for the server to specify both.

  • persistence: The server supports persistence of notifications. Notifications will be retained until they are acknowledged or removed by the user or recalled by the sender. The presence of this capability allows clients to depend on the server to ensure a notification is seen and eliminate the need for the client to display a reminding function (such as a status icon) of its own.

More

  • notification group
  • Filter notifications
  • support for waybar
  • Media player controller
  • custom styling
  • Widgets (Maybe a bad idea)

requirement

Build daemon

First go to the right folder: cd ./notiflut_daemon

Then you need to generates code from protobuf with this command: dart run rust_in_flutter message

This project also uses well known types for dates. protoc --dart_out=./lib/messages google/protobuf/timestamp.proto google/protobuf/empty.proto

If you have any trouble running these commands look first for help here: https://docs.cunarist.com/rust-in-flutter/

Now you should be able to compile the code with: flutter build linux --release

Installation Guide

  1. Navigate to the Build Scripts Directory:

    cd ./build_scripts

  2. Install Dependencies: If the makepkg -si command fails due to missing dependencies, manually download and install them. You can find dependency information higher in this file.

  3. Build and Install Package: If you have resolved the dependencies, run the following command to build and install the package:

    makepkg -si

    If you needed to install dependencies manually, use the following command instead:

    makepkg -di

    This will build the package and install it along with its dependencies.

how to use

Once notiflut is running, use notiflut_ctl to control it.

Usage: notiflut_ctl <COMMAND>

Commands:
  show    Shows the notification center
  hide    Hides the notification center
  toggle  Toggle the notification center
  status  Get notifications status
  count   get notifications count
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

configuration

The configuration file is typically located in the default XDG configuration directory. In most cases, it should be: $HOME/.config/notiflut/conf.toml

Configuration File Example

do_not_disturb = false

[[emitters_settings]]
name = "spotify"
ignore = true
urgency_low_as = "Critical"
urgency_normal_as = "Normal"
urgency_critical_as = "Low"

Do Not Disturb Mode

  • do_not_disturb: Set this to true to enable "Do Not Disturb" mode and suppress notifications temporarily.

Emitter Settings

  • name: Assign a unique name to each emitter for identification purposes.
  • ignore: Toggle the ignore flag to true if you want to ignore notifications from a specific emitter.
  • Urgency Level Mapping (Low, Normal, Critical): Low -> do not persist in center, Normal -> persist in center, Critical -> persist in center + popup need user action to close.
    • urgency_low_as: Customize the behavior of low urgency notifications. In this example, it's set to "Critical," allowing you to elevate the importance of low urgency notifications.
    • urgency_normal_as: Map normal urgency notifications to a custom urgency (same as urgency low).
    • urgency_critical_as: Map critical urgency notifications to a custom urgency (same as urgency low).

Styling

Here is an example of ~/.config/notiflut/style.toml

[light.notification_center]
background_color = 0xFF000000

[light.popup]
background_color = 0xFF000000

[light.notification]
background_color = 0xFFE0E0E0
border_radius = 10
text_color = 0xFFFFFFFF
border_width = 1
border_color = 0xFFFF00FF
title_text_color = 0xFFFF00FF
subtitle_text_color = 0xFFFF00FF
body_text_color = 0xFF0000FF
button_text_color = 0xFFFF00FF

[dark.notification_center]
background_color = 0x45FFFFFF

[dark.popup]
background_color = 0xFF000000

[dark.notification]
background_color = 0x00000000
border_radius = 10
text_color = 0xFF000000
border_width = 1
border_color = 0xFFFF00FF
title_text_color = 0xFFFF00FF
subtitle_text_color = 0xFFFF00FF
body_text_color = 0xFF0000FF
button_text_color = 0xFFFF00FF

Waybar

Here is an example of a custom module that can be used with Waybar.

    "custom/notification": {
      "tooltip": false,
      "format": "{icon}",
      "format-icons": {
        "0": "",
        "1": "<span foreground='red'><sup>1</sup></span>",
        "2": "<span foreground='red'><sup>2</sup></span>",
        "3": "<span foreground='red'><sup>3</sup></span>",
        "4": "<span foreground='red'><sup>4</sup></span>",
        "5": "<span foreground='red'><sup>5</sup></span>",
        "6": "<span foreground='red'><sup>6</sup></span>",
        "7": "<span foreground='red'><sup>7</sup></span>",
        "8": "<span foreground='red'><sup>8</sup></span>",
        "9": "<span foreground='red'><sup>9</sup></span>",
        "more": "<span foreground='red'><sup>9+</sup></span>"
      },
      "return-type": "json",
      "exec-if": "which notiflut_ctl",
      "exec": "notiflut_ctl status",
      "on-click": "notiflut_ctl toggle",
      "interval": 5,
      "escape": true
    }