@dopaminefx/effect-aurora 0.1.0

package/dist/aurora.dope.json

@@ -0,0 +1,417 @@
+{
+    "fmt": "dopamine-effect",
+    "v": "1.0.0",
+    "id": "dopamine.success.aurora",
+    "meta": {
+        "name": "Aurora",
+        "description": "Hanging curtains of polar light that drape across the upper field, sway and sweep, then gently brighten and fade.",
+        "tags": [
+            "success",
+            "ambient",
+            "aurora",
+            "directional",
+            "curtain"
+        ]
+    },
+    "controls": {
+        "mood": {
+            "type": "enum",
+            "label": "Mood",
+            "default": "serene",
+            "options": [
+                "serene",
+                "celebratory",
+                "electric"
+            ],
+            "ui": "segmented"
+        },
+        "intensity": {
+            "type": "scalar",
+            "label": "Intensity",
+            "default": 0.7,
+            "min": 0,
+            "max": 1,
+            "step": 0.01,
+            "ui": "slider",
+            "help": "Brightness, curtain coverage and band height."
+        },
+        "whimsy": {
+            "type": "scalar",
+            "label": "Whimsy",
+            "default": 0.4,
+            "min": 0,
+            "max": 1,
+            "step": 0.01,
+            "ui": "slider",
+            "help": "Photoreal soft volumetric curtains (0) to stylized hard cel / posterized ribbons (1)."
+        },
+        "seed": {
+            "type": "int",
+            "label": "Seed",
+            "default": null,
+            "nullable": true,
+            "help": "Null = unique palette per fire; pin to reproduce."
+        },
+        "target": {
+            "type": "selector",
+            "label": "Target",
+            "default": "document.body"
+        }
+    },
+    "baselines": {
+        "serene": {
+            "durationMs": 3200,
+            "lightness": 0.86,
+            "chroma": 0.1,
+            "hueCenter": 168,
+            "hueRange": 70,
+            "coverage": 0.55,
+            "bandY": 0.66,
+            "bandHeight": 0.28,
+            "sway": 0.06,
+            "striation": 0.6,
+            "rays": 0.35,
+            "overshoot": 0.4
+        },
+        "celebratory": {
+            "durationMs": 2600,
+            "lightness": 0.85,
+            "chroma": 0.16,
+            "hueCenter": 190,
+            "hueRange": 200,
+            "coverage": 0.7,
+            "bandY": 0.64,
+            "bandHeight": 0.31,
+            "sway": 0.08,
+            "striation": 0.72,
+            "rays": 0.5,
+            "overshoot": 0.7
+        },
+        "electric": {
+            "durationMs": 2100,
+            "lightness": 0.84,
+            "chroma": 0.23,
+            "hueCenter": 320,
+            "hueRange": 150,
+            "coverage": 0.85,
+            "bandY": 0.62,
+            "bandHeight": 0.34,
+            "sway": 0.11,
+            "striation": 0.88,
+            "rays": 0.7,
+            "overshoot": 1
+        }
+    },
+    "palette": {
+        "model": "oklch",
+        "space": "linear-srgb",
+        "generator": "golden-angle",
+        "goldenAngleDeg": 137.50776405003785,
+        "stops": 3,
+        "hueSpread": 0.22,
+        "lightness": {
+            "baseline": "lightness",
+            "perStop": [
+                0,
+                0.06,
+                -0.05
+            ]
+        },
+        "chroma": {
+            "from": {
+                "mul": [
+                    {
+                        "baseline": "chroma"
+                    },
+                    {
+                        "lerp": [
+                            "intensity",
+                            0.7,
+                            1.5
+                        ]
+                    }
+                ]
+            },
+            "perStop": [
+                0,
+                0.02,
+                -0.01
+            ]
+        },
+        "seed": {
+            "deterministic": true,
+            "source": "controls.seed",
+            "prng": "mulberry32"
+        },
+        "perMood": {
+            "serene": {
+                "hueCenter": 165,
+                "hueRange": 110,
+                "lightness": 0.84,
+                "chroma": 0.11
+            },
+            "celebratory": {
+                "hueCenter": 200,
+                "hueRange": 300,
+                "lightness": 0.83,
+                "chroma": 0.17
+            },
+            "electric": {
+                "hueCenter": 320,
+                "hueRange": 180,
+                "lightness": 0.82,
+                "chroma": 0.24
+            }
+        }
+    },
+    "tempo": {
+        "durationMs": {
+            "from": {
+                "round": {
+                    "mul": [
+                        {
+                            "baseline": "durationMs"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                1.1,
+                                0.9
+                            ]
+                        }
+                    ]
+                }
+            }
+        },
+        "frame": {
+            "amp": {
+                "envelope": [
+                    {
+                        "input": "life"
+                    },
+                    {
+                        "param": "overshoot"
+                    }
+                ]
+            },
+            "extras": {
+                "sweep": {
+                    "mul": [
+                        0.02,
+                        {
+                            "div": [
+                                {
+                                    "input": "animMs"
+                                },
+                                1000
+                            ]
+                        },
+                        {
+                            "sub": [
+                                1,
+                                {
+                                    "mul": [
+                                        0.5,
+                                        {
+                                            "input": "life"
+                                        }
+                                    ]
+                                }
+                            ]
+                        }
+                    ]
+                }
+            }
+        },
+        "reducedMotion": {
+            "peakMs": 520,
+            "holdMs": 520
+        }
+    },
+    "geometry": {
+        "kind": "directional",
+        "viewBox": [
+            0,
+            0,
+            100,
+            100
+        ]
+    },
+    "render": {
+        "params": {
+            "exposure": {
+                "type": "float",
+                "from": {
+                    "lerp": [
+                        "intensity",
+                        0.85,
+                        1.55
+                    ]
+                }
+            },
+            "overshoot": {
+                "type": "float",
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "overshoot"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                0.7,
+                                1.2
+                            ]
+                        }
+                    ]
+                }
+            },
+            "coverage": {
+                "type": "float",
+                "clamp01": true,
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "coverage"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                0.7,
+                                1.25
+                            ]
+                        }
+                    ]
+                }
+            },
+            "bandY": {
+                "type": "float",
+                "from": {
+                    "baseline": "bandY"
+                }
+            },
+            "bandHeight": {
+                "type": "float",
+                "clamp01": true,
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "bandHeight"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                0.85,
+                                1.15
+                            ]
+                        }
+                    ]
+                }
+            },
+            "sway": {
+                "type": "float",
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "sway"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                0.85,
+                                1.2
+                            ]
+                        }
+                    ]
+                }
+            },
+            "striation": {
+                "type": "float",
+                "clamp01": true,
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "striation"
+                        },
+                        {
+                            "lerp": [
+                                "whimsy",
+                                0.9,
+                                1.1
+                            ]
+                        }
+                    ]
+                }
+            },
+            "rays": {
+                "type": "float",
+                "clamp01": true,
+                "from": {
+                    "mul": [
+                        {
+                            "baseline": "rays"
+                        },
+                        {
+                            "lerp": [
+                                "intensity",
+                                0.8,
+                                1.2
+                            ]
+                        }
+                    ]
+                }
+            },
+            "style": {
+                "type": "float",
+                "from": {
+                    "control": "whimsy"
+                }
+            }
+        },
+        "shadowHeightFrac": {
+            "mul": [
+                {
+                    "param": "bandHeight"
+                },
+                0.6
+            ]
+        },
+        "consts": {
+            "MAX_CURTAINS": 7
+        },
+        "config": {
+            "usesOrigin": false
+        },
+        "backends": {
+            "webgl2": {
+                "stage": "fullscreen-triangle",
+                "blend": "screen",
+                "shader": {
+                    "program": "aurora"
+                }
+            }
+        },
+        "fallbackOrder": [
+            "webgl2"
+        ]
+    },
+    "binding": {
+        "note": "CROSS-PLATFORM uniform-binding contract. Which render.params are NOT shader uniforms, the seed-keyed scatter field, the per-frame/host extras, and the texture samplers — one source of truth for the web u<Name> list, the Swift struct + packer, and the MSL struct. SHIPS in the portable .dope (the runtime derives its uniform bindings from it); the toolchain consumes it too for the Metal struct codegen. Only `x-build`, `slug` and `kind` stay toolchain-only.",
+        "excludeParams": [
+            "style",
+            "overshoot",
+            "durationMs"
+        ],
+        "scatterKey": "auroraSeed",
+        "scatterWeb": "uSeed",
+        "extras": [
+            {
+                "name": "sweep",
+                "type": "float",
+                "web": "uSweep",
+                "note": "accumulated sideways sweep (fraction of width)"
+            }
+        ],
+        "samplers": []
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Aurora — a calm success / ambient effect rendered through the generic
+ * fullscreen pass runner.
+ *
+ * Hanging CURTAINS of polar light drape across the upper field, sway and sweep
+ * sideways, then gently brighten and fade. It is DIRECTIONAL/curtain — a
+ * horizontal band of vertical light ribbons with soft vertical striations —
+ * deliberately NOT a radial bloom (it composes across the whole upper surface,
+ * so it ignores the anchor: no origin).
+ *
+ * FULLY DATA-DRIVEN (P2): everything that isn't the GLSL lives in
+ * aurora.dope.json — the mood→params mapping + palette (the loader), AND the
+ * per-frame logic: `tempo.frame` (the envelope amp + the accumulated sideways
+ * sweep), `render.shadowHeightFrac`, `render.consts`, `render.config` and the
+ * uniform `binding` contract. `registerDopeEffect` interprets that data through
+ * the generic pass runner; this module is just the shader + the registration
+ * call.
+ *
+ * Feeling mapping:
+ *   - mood     → palette + baselines: serene = cool green/teal/blue,
+ *                celebratory = balanced multi-hue, electric = vivid magenta/teal.
+ *   - intensity→ brightness (uExposure) + curtain coverage/height (uCoverage,
+ *                uBandHeight, ribbon count) + drift (uSway) + overshoot.
+ *   - whimsy   → uStyle: photoreal soft volumetric curtains (0) → stylized hard
+ *                cel / posterized ribbons (1); the pass runner also snaps the
+ *                clock "on twos" as style rises.
+ */
+import { type EffectFactory, type PassParams } from "@dopaminefx/core";
+/** Resolved aurora params: the loader output + the named scatter seed. */
+export interface AuroraParams extends PassParams {
+    exposure: number;
+    overshoot: number;
+    coverage: number;
+    bandY: number;
+    bandHeight: number;
+    sway: number;
+    striation: number;
+    rays: number;
+    auroraSeed: number;
+}
+export declare const aurora: EffectFactory<AuroraParams>;
+export default aurora;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,EAAiC,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAKtG,0EAA0E;AAC1E,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,eAAO,MAAM,MAAM,EAGgB,aAAa,CAAC,YAAY,CAAC,CAAC;AAE/D,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,39 @@
+/**
+ * Aurora — a calm success / ambient effect rendered through the generic
+ * fullscreen pass runner.
+ *
+ * Hanging CURTAINS of polar light drape across the upper field, sway and sweep
+ * sideways, then gently brighten and fade. It is DIRECTIONAL/curtain — a
+ * horizontal band of vertical light ribbons with soft vertical striations —
+ * deliberately NOT a radial bloom (it composes across the whole upper surface,
+ * so it ignores the anchor: no origin).
+ *
+ * FULLY DATA-DRIVEN (P2): everything that isn't the GLSL lives in
+ * aurora.dope.json — the mood→params mapping + palette (the loader), AND the
+ * per-frame logic: `tempo.frame` (the envelope amp + the accumulated sideways
+ * sweep), `render.shadowHeightFrac`, `render.consts`, `render.config` and the
+ * uniform `binding` contract. `registerDopeEffect` interprets that data through
+ * the generic pass runner; this module is just the shader + the registration
+ * call.
+ *
+ * Feeling mapping:
+ *   - mood     → palette + baselines: serene = cool green/teal/blue,
+ *                celebratory = balanced multi-hue, electric = vivid magenta/teal.
+ *   - intensity→ brightness (uExposure) + curtain coverage/height (uCoverage,
+ *                uBandHeight, ribbon count) + drift (uSway) + overshoot.
+ *   - whimsy   → uStyle: photoreal soft volumetric curtains (0) → stylized hard
+ *                cel / posterized ribbons (1); the pass runner also snaps the
+ *                clock "on twos" as style rises.
+ */
+import { AURORA_FRAGMENT_SRC, AURORA_VERTEX_SRC } from "./aurora-shader.js";
+import { parseDope, registerDopeEffect } from "@dopaminefx/core";
+import doc from "./aurora.dope.json";
+const DOPE = parseDope(doc);
+// The whole factory (resolve / create / reducedMotion / program registration)
+// is data: aurora.dope.json interpreted by the core backbone.
+export const aurora = registerDopeEffect(DOPE, {
+    vertex: AURORA_VERTEX_SRC,
+    fragment: AURORA_FRAGMENT_SRC,
+});
+export default aurora;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAuC,MAAM,kBAAkB,CAAC;AACtG,OAAO,GAAG,MAAM,oBAAoB,CAAC;AAErC,MAAM,IAAI,GAAG,SAAS,CAAC,GAAa,CAAC,CAAC;AAetC,8EAA8E;AAC9E,8DAA8D;AAC9D,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,EAAE;IAC7C,MAAM,EAAE,iBAAiB;IACzB,QAAQ,EAAE,mBAAmB;CAC9B,CAA6D,CAAC;AAE/D,eAAe,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@dopaminefx/effect-aurora",
+  "version": "0.1.0",
+  "description": "Aurora — hanging curtains of polar light, a calm ambient success effect for Dopamine.",
+  "keywords": [
+    "dopamine-effect"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "sideEffects": [
+    "./src/index.ts",
+    "./dist/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@dopaminefx/core": "^0.1.0"
+  },
+  "license": "MIT",
+  "author": "10in30",
+  "homepage": "https://github.com/10in30/dopamine#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/10in30/dopamine.git",
+    "directory": "effects/aurora/web"
+  },
+  "bugs": {
+    "url": "https://github.com/10in30/dopamine/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}