From 254da7e17b91e7b49482d7886dbe934cf00e7d8c Mon Sep 17 00:00:00 2001
From: Colin <colin@uninsane.org>
Date: Sat, 16 Sep 2023 02:55:36 +0000
Subject: [PATCH] swaync: document env vars

---
 .../programs/swaynotificationcenter.nix       | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/hosts/common/programs/swaynotificationcenter.nix b/hosts/common/programs/swaynotificationcenter.nix
index e01e9dc78..1b2ded799 100644
--- a/hosts/common/programs/swaynotificationcenter.nix
+++ b/hosts/common/programs/swaynotificationcenter.nix
@@ -131,6 +131,25 @@ in
       hide-on-action = true;
       script-fail-notify = true;
       scripts = {
+        # a script can match regex on these fields. only fired if all listed fields match:
+        # - app-name
+        # - desktop-entry
+        # - summary
+        # - body
+        # - urgency (Low/Normal/Critical)
+        # - category
+        # additionally, the script can be run either on receipt or action:
+        # - run-on = "receive" or "action"
+        # when script is run, these env vars are available:
+        # - SWAYNC_BODY
+        # - SWAYNC_DESKTOP_ENTRY
+        # - SWAYNC_URGENCY
+        # - SWAYNC_TIME
+        # - SWAYNC_APP_NAME
+        # - SWAYNC_CATEGORY
+        # - SWAYNC_REPLACES_ID
+        # - SWAYNC_ID
+        # - SWAYNC_SUMMARY
         sound-im = {
           # trigger notification sound on behalf of these IM clients.
           # TODO: dispatch calls separately!