From fb10fa1b146b4daf87a97f3ac6a3b295ff80481e Mon Sep 17 00:00:00 2001
From: Fuwn <contact@fuwn.me>
Date: Thu, 12 Sep 2024 06:49:05 -0700
Subject: feat: special and wallpaper fields

---
 README.md | 32 ++++++++++++++++++++++++++++++--
 flake.nix | 19 +++++++++++++++----
 2 files changed, 45 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index afb2236..65c2c42 100644
--- a/README.md
+++ b/README.md
@@ -55,15 +55,43 @@ the `pywal-nix` attribute.
     backend = "wal";                    # One of "wal", "colorz", or "colorthief"; Defaults to "wal"
   };
 
-  # Example usage to print out two colour scheme colours
+  # Example usage to print out few colours
   home.packages = [
     (pkgs.writeShellScriptBin "colour-scheme-sample" ''
-      echo '${config.pywal-nix.colourScheme.colour0} ${config.pywal-nix.colourScheme.colour15}'
+      echo '${config.pywal-nix.colourScheme.wallpaper}'
+      echo '${config.pywal-nix.colourScheme.special.background}'
+      echo '${config.pywal-nix.colourScheme.colours.colour9}'
     '')
   ];
 }
 ```
 
+### Colour Scheme
+
+`pywal-nix`'s generated colour scheme is accessible through either the
+`colourScheme` or `colorScheme` set. Likewise, colours are accessible through
+either the `colours` or `colors` sets.
+
+The colour scheme interface generated by `pywal-nix` comes in the following shape:
+
+```typescript
+{
+  wallpaper: string
+
+  special: {
+    background: string
+    foreground: string
+    cursor: string
+  }
+
+  colours: { // or colors
+    colour0: string // or color0
+    // colour1 ... colour14 or color1 ... color15
+    colour15: string // or color15
+  }
+}
+```
+
 ## Pywal
 
 This project includes multiple files from
diff --git a/flake.nix b/flake.nix
index d9b8840..cf8ed09 100644
--- a/flake.nix
+++ b/flake.nix
@@ -67,16 +67,27 @@
             };
 
             colourScheme = lib.mkOption {
-              type = lib.types.attrsOf lib.types.str;
+              type = lib.types.anything;
             };
 
             colorScheme = lib.mkOption {
-              type = lib.types.attrsOf lib.types.str;
+              type = lib.types.anything;
             };
           };
 
-          config.pywal-nix.colourScheme = colourScheme;
-          config.pywal-nix.colorScheme = colourScheme;
+          config.pywal-nix.colourScheme = {
+            wallpaper = config.pywal-nix.wallpaper;
+            colours = colourScheme;
+            colors = colourScheme;
+
+            special = {
+              background = colourScheme.colour0;
+              foreground = colourScheme.colour15;
+              cursor = colourScheme.colour15;
+            };
+          };
+
+          config.pywal-nix.colorScheme = config.pywal-nix.colourScheme;
         };
     });
 }
-- 
cgit v1.2.3