@dopaminefx/effect-fail 0.1.0

package/src/fail.dope.json

@@ -0,0 +1,523 @@
+{
+  "fmt": "dopamine-effect",
+  "v": "1.0.0",
+  "id": "dopamine.error.fail",
+  "meta": {
+    "name": "Fail Stamp",
+    "description": "A failure/denied moment — the emotional opposite of the success effects. A red/amber cross is stamped in over a recoiling error flare with a sharp hit + shake, then desaturates and collapses. Short and punchy.",
+    "tags": [
+      "error",
+      "fail",
+      "denied",
+      "negative"
+    ]
+  },
+  "controls": {
+    "mood": {
+      "type": "enum",
+      "label": "Mood",
+      "default": "error",
+      "options": [
+        "try-again",
+        "error",
+        "denied"
+      ],
+      "ui": "segmented"
+    },
+    "intensity": {
+      "type": "scalar",
+      "label": "Severity",
+      "default": 0.7,
+      "min": 0,
+      "max": 1,
+      "step": 0.01,
+      "ui": "slider",
+      "help": "How hard the failure lands: flare heat/size, shake amount, recoil."
+    },
+    "whimsy": {
+      "type": "scalar",
+      "label": "Whimsy",
+      "default": 0.5,
+      "min": 0,
+      "max": 1,
+      "step": 0.01,
+      "ui": "slider",
+      "help": "Photoreal flare (0) to desaturated RGB-split glitch collapse (1)."
+    },
+    "seed": {
+      "type": "int",
+      "label": "Seed",
+      "default": null,
+      "nullable": true,
+      "help": "Null = unique error palette per fire; pin to reproduce."
+    },
+    "origin": {
+      "type": "point",
+      "label": "Origin",
+      "default": "center"
+    },
+    "target": {
+      "type": "selector",
+      "label": "Target",
+      "default": "document.body"
+    }
+  },
+  "baselines": {
+    "try-again": {
+      "durationMs": 900,
+      "lightness": 0.78,
+      "chroma": 0.13,
+      "hueCenter": 70,
+      "hueRange": 40,
+      "shakeAmount": 0.5
+    },
+    "error": {
+      "durationMs": 760,
+      "lightness": 0.72,
+      "chroma": 0.17,
+      "hueCenter": 40,
+      "hueRange": 36,
+      "shakeAmount": 0.85
+    },
+    "denied": {
+      "durationMs": 640,
+      "lightness": 0.66,
+      "chroma": 0.21,
+      "hueCenter": 22,
+      "hueRange": 30,
+      "shakeAmount": 1.25
+    }
+  },
+  "palette": {
+    "model": "oklch",
+    "space": "linear-srgb",
+    "generator": "golden-angle",
+    "goldenAngleDeg": 137.50776405003785,
+    "stops": 3,
+    "hueSpread": 0.18,
+    "lightness": {
+      "baseline": "lightness",
+      "perStop": [
+        0,
+        0.06,
+        -0.05
+      ]
+    },
+    "chroma": {
+      "from": {
+        "mul": [
+          {
+            "baseline": "chroma"
+          },
+          {
+            "lerp": [
+              "intensity",
+              0.8,
+              1.4
+            ]
+          }
+        ]
+      },
+      "perStop": [
+        0,
+        0.02,
+        -0.01
+      ]
+    },
+    "seed": {
+      "deterministic": true,
+      "source": "controls.seed",
+      "prng": "mulberry32",
+      "note": "Algorithmic OKLCH biased to error reds/ambers: a narrow hueRange around a hot hueCenter keeps every fire inside the red/amber error band while still being generated (unique per fire)."
+    },
+    "perMood": {
+      "try-again": {
+        "hueCenter": 70,
+        "hueRange": 40,
+        "lightness": 0.78,
+        "chroma": 0.13
+      },
+      "error": {
+        "hueCenter": 40,
+        "hueRange": 36,
+        "lightness": 0.72,
+        "chroma": 0.17
+      },
+      "denied": {
+        "hueCenter": 22,
+        "hueRange": 30,
+        "lightness": 0.66,
+        "chroma": 0.21
+      }
+    }
+  },
+  "tempo": {
+    "durationMs": {
+      "from": {
+        "round": {
+          "mul": [
+            {
+              "baseline": "durationMs"
+            },
+            {
+              "lerp": [
+                "intensity",
+                1.15,
+                0.85
+              ]
+            }
+          ]
+        }
+      }
+    },
+    "frame": {
+      "amp": {
+        "lt": [
+          {
+            "clamp01": {
+              "input": "life"
+            }
+          },
+          0.05,
+          {
+            "easeOutCubic": {
+              "div": [
+                {
+                  "clamp01": {
+                    "input": "life"
+                  }
+                },
+                0.05
+              ]
+            }
+          },
+          {
+            "lt": [
+              {
+                "clamp01": {
+                  "input": "life"
+                }
+              },
+              0.55,
+              1,
+              {
+                "pow": [
+                  {
+                    "clamp01": {
+                      "sub": [
+                        1,
+                        {
+                          "div": [
+                            {
+                              "sub": [
+                                {
+                                  "clamp01": {
+                                    "input": "life"
+                                  }
+                                },
+                                0.55
+                              ]
+                            },
+                            0.45
+                          ]
+                        }
+                      ]
+                    }
+                  },
+                  1.7
+                ]
+              }
+            ]
+          }
+        ]
+      },
+      "extras": {
+        "stamp": {
+          "sub": [
+            1,
+            {
+              "pow": [
+                {
+                  "sub": [
+                    1,
+                    {
+                      "clamp01": {
+                        "div": [
+                          {
+                            "input": "elapsedMs"
+                          },
+                          170
+                        ]
+                      }
+                    }
+                  ]
+                },
+                5
+              ]
+            }
+          ]
+        },
+        "shake": {
+          "lt": [
+            0,
+            {
+              "input": "elapsedMs"
+            },
+            {
+              "mul": [
+                {
+                  "sin": {
+                    "mul": [
+                      {
+                        "div": [
+                          {
+                            "input": "elapsedMs"
+                          },
+                          300
+                        ]
+                      },
+                      3.141592653589793,
+                      7
+                    ]
+                  }
+                },
+                {
+                  "exp": {
+                    "div": [
+                      {
+                        "sub": [
+                          0,
+                          {
+                            "input": "elapsedMs"
+                          }
+                        ]
+                      },
+                      {
+                        "mul": [
+                          300,
+                          0.35
+                        ]
+                      }
+                    ]
+                  }
+                },
+                {
+                  "param": "shakeAmount"
+                }
+              ]
+            },
+            0
+          ]
+        }
+      }
+    },
+    "reducedMotion": {
+      "peakMs": 200,
+      "holdMs": 320
+    },
+    "note": "The negative, punchy counterpart to the held-breath success envelope: frame.amp is the slam/hold/collapse fail envelope; stamp (the ✗ slash-in over 170 ms) and shake (a damped ~3.5-oscillation recoil over 300 ms) run on the REAL un-stepped clock (elapsedMs) on every platform."
+  },
+  "geometry": {
+    "kind": "radial",
+    "viewBox": [
+      0,
+      0,
+      100,
+      100
+    ],
+    "outlines": {
+      "cross": {
+        "role": "deny-glyph",
+        "source": "baked-sdf",
+        "note": "GEOMETRY SEAM: the ✗ icon is driven by this svgPath, baked to the inline SDF below (scripts/bake-sdf.mjs). The fail shader samples it (uSdfTex). Swap the path + re-bake to change the rejected icon with no shader edit. Two diagonal bars (a clean cross).",
+        "svgPath": "M 24 24 L 76 76 M 76 24 L 24 76",
+        "sdf": {
+          "size": 64,
+          "range": 18,
+          "viewBox": [
+            0,
+            0,
+            100,
+            100
+          ],
+          "data": "data:application/octet-stream;base64,RFMAQP/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////59PHw8vX6///////////////////////////////////69fLw8fT5/////////////////////////////vPq497b2tzf5e32//////////////////////////////bt5d/c2tve4+rz/v//////////////////////+Ovg1s7IxcTGytDY4+/8/////////////////////////O/j2NDKxsTFyM7W4Ov4////////////////////9ufZzcK5s6+usLS7xdDd6/r/////////////////////+uvd0MW7tLCur7O5ws3Z5/b/////////////////+OfXyLqupZ2ZmJqfp7G+zNvr+v//////////////////+uvbzL6xp5+amJmdpa66yNfn+P///////////////uvZyLepm5CIg4KEipOfrbzL2+v6////////////////+uvby7ytn5OKhIKDiJCbqbfI2ev+//////////////PgzbqpmIl9c21sbnaAjZ2svMvb6/r/////////////+uvby7ysnY2Adm5sbXN9iZipus3g8//////////////q1sKum4l5al9YVVlibn2Nnay8y9vr+v//////////+uvby7ysnY19bmJZVVhfanmJm67C1ur////////////54865pZB9alpMQj9ET15ufY2drLzL2+v6////////+uvby7ysnY19bl5PRD9CTFpqfZCluc7j+f//////////9N7Is52Ic19MOi0pMD9OXm59jZ2svMvb6/r/////+uvby7ysnY19bl5OPzApLTpMX3OInbPI3vT///////////Hbxa+Zg21YQi0bEx8vP05ebn2Nnay8y9vr+v//+uvby7ysnY19bl5OPy8fExstQlhtg5mvxdvx///////////w2sSumIJsVT8pEwAQHy8/Tl5ufY2drLzL2+v6+uvby7ysnY19bl5OPy8fEAATKT9VbIKYrsTa8P//////////8tzGsJqEbllEMB8QABAfLz9OXm59jZ2svMvb6+vby7ysnY19bl5OPy8fEAAQHzBEWW6EmrDG3PL///////////XfyrSfinZiTz8vHxAAEB8vP05ebn2Nnay8y9vby7ysnY19bl5OPy8fEAAQHy8/T2J2ip+0yt/1///////////65dC7p5OAbl5OPy8fEAAQHy8/Tl5ufY2drLzLy7ysnY19bl5OPy8fEAAQHy8/Tl5ugJOnu9Dl+v///////////+3YxbGfjX1uXk4/Lx8QABAfLz9OXm59jZ2svLysnY19bl5OPy8fEAAQHy8/Tl5ufY2fscXY7f/////////////249C+rZ2NfW5eTj8vHxAAEB8vP05ebn2NnaysnY19bl5OPy8fEAAQHy8/Tl5ufY2drb7Q4/b//////////////+/dzLysnY19bl5OPy8fEAAQHy8/Tl5ufY2dnY19bl5OPy8fEAAQHy8/Tl5ufY2drLzM3e/////////////////869vLvKydjX1uXk4/Lx8QABAfLz9OXm59jY19bl5OPy8fEAAQHy8/Tl5ufY2drLzL2+v8//////////////////rr28u8rJ2NfW5eTj8vHxAAEB8vP05ebn19bl5OPy8fEAAQHy8/Tl5ufY2drLzL2+v6////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Tl5ubl5OPy8fEAAQHy8/Tl5ufY2drLzL2+v6///////////////////////669vLvKydjX1uXk4/Lx8QABAfLz9OXl5OPy8fEAAQHy8/Tl5ufY2drLzL2+v6//////////////////////////rr28u8rJ2NfW5eTj8vHxAAEB8vP05OPy8fEAAQHy8/Tl5ufY2drLzL2+v6////////////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Py8fEAAQHy8/Tl5ufY2drLzL2+v6///////////////////////////////669vLvKydjX1uXk4/Lx8QABAfLy8fEAAQHy8/Tl5ufY2drLzL2+v6//////////////////////////////////rr28u8rJ2NfW5eTj8vHxAAEB8fEAAQHy8/Tl5ufY2drLzL2+v6////////////////////////////////////+uvby7ysnY19bl5OPy8fEAAQEAAQHy8/Tl5ufY2drLzL2+v6///////////////////////////////////////669vLvKydjX1uXk4/Lx8QAAAQHy8/Tl5ufY2drLzL2+v6////////////////////////////////////////+uvby7ysnY19bl5OPy8fEAAAEB8vP05ebn2Nnay8y9vr+v//////////////////////////////////////+uvby7ysnY19bl5OPy8fEAAQEAAQHy8/Tl5ufY2drLzL2+v6////////////////////////////////////+uvby7ysnY19bl5OPy8fEAAQHx8QABAfLz9OXm59jZ2svMvb6/r/////////////////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8vHxAAEB8vP05ebn2Nnay8y9vr+v//////////////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Py8fEAAQHy8/Tl5ufY2drLzL2+v6////////////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Tk4/Lx8QABAfLz9OXm59jZ2svMvb6/r/////////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Tl5eTj8vHxAAEB8vP05ebn2Nnay8y9vr+v//////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Tl5ubl5OPy8fEAAQHy8/Tl5ufY2drLzL2+v6////////////////////+uvby7ysnY19bl5OPy8fEAAQHy8/Tl5ufX1uXk4/Lx8QABAfLz9OXm59jZ2svMvb6/r//////////////////Ovby7ysnY19bl5OPy8fEAAQHy8/Tl5ufY2NfW5eTj8vHxAAEB8vP05ebn2Nnay8y9vr/P///////////////+/dzLysnY19bl5OPy8fEAAQHy8/Tl5ufY2dnY19bl5OPy8fEAAQHy8/Tl5ufY2drLzM3e////////////////bj0L6tnY19bl5OPy8fEAAQHy8/Tl5ufY2drKydjX1uXk4/Lx8QABAfLz9OXm59jZ2tvtDj9v/////////////t2MWxn419bl5OPy8fEAAQHy8/Tl5ufY2drLy8rJ2NfW5eTj8vHxAAEB8vP05ebn2Nn7HF2O3////////////65dC7p5OAbl5OPy8fEAAQHy8/Tl5ufY2drLzLy7ysnY19bl5OPy8fEAAQHy8/Tl5ugJOnu9Dl+v//////////9d/KtJ+KdmJPPy8fEAAQHy8/Tl5ufY2drLzL29vLvKydjX1uXk4/Lx8QABAfLz9PYnaKn7TK3/X///////////LcxrCahG5ZRDAfEAAQHy8/Tl5ufY2drLzL2+vr28u8rJ2NfW5eTj8vHxAAEB8wRFluhJqwxtzy///////////w2sSumIJsVT8pEwAQHy8/Tl5ufY2drLzL2+v6+uvby7ysnY19bl5OPy8fEAATKT9VbIKYrsTa8P//////////8dvFr5mDbVhCLRsTHy8/Tl5ufY2drLzL2+v6///669vLvKydjX1uXk4/Lx8TGy1CWG2Dma/F2/H///////////TeyLOdiHNfTDotKTA/Tl5ufY2drLzL2+v6//////rr28u8rJ2NfW5eTj8wKS06TF9ziJ2zyN70///////////54865pZB9alpMQj9ET15ufY2drLzL2+v6////////+uvby7ysnY19bl5PRD9CTFpqfZCluc7j+f///////////+rWwq6biXlqX1hVWWJufY2drLzL2+v6///////////669vLvKydjX1uYllVWF9qeYmbrsLW6v/////////////z4M26qZiJfXNtbG52gI2drLzL2+v6//////////////rr28u8rJ2NgHZubG1zfYmYqbrN4PP//////////////uvZyLepm5CIg4KEipOfrbzL2+v6////////////////+uvby7ytn5OKhIKDiJCbqbfI2ev+///////////////459fIuq6lnZmYmp+nsb7M2+v6///////////////////669vMvrGnn5qYmZ2lrrrI1+f4//////////////////bn2c3CubOvrrC0u8XQ3ev6//////////////////////rr3dDFu7Swrq+zucLN2ef2////////////////////+Ovg1s7IxcTGytDY4+/8/////////////////////////O/j2NDKxsTFyM7W4Ov4///////////////////////+8+rj3tva3N/l7fb/////////////////////////////9u3l39za297j6vP+////////////////////////////+fTx8PL1+v//////////////////////////////////+vXy8PH0+f////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8="
+        }
+      }
+    }
+  },
+  "content": {
+    "note": "No word set for the fail effect — the ✗ cross is the whole message. Kept here for symmetry with the other effects' content blocks.",
+    "tokens": [
+      "✗"
+    ]
+  },
+  "render": {
+    "params": {
+      "exposure": {
+        "type": "float",
+        "from": {
+          "lerp": [
+            "intensity",
+            0.9,
+            1.6
+          ]
+        }
+      },
+      "severity": {
+        "type": "float",
+        "from": {
+          "control": "intensity"
+        }
+      },
+      "shakeAmount": {
+        "type": "float",
+        "from": {
+          "mul": [
+            {
+              "baseline": "shakeAmount"
+            },
+            {
+              "lerp": [
+                "intensity",
+                0.7,
+                1.3
+              ]
+            }
+          ]
+        }
+      },
+      "style": {
+        "type": "float",
+        "from": {
+          "control": "whimsy"
+        }
+      }
+    },
+    "shadowHeightFrac": 0.42,
+    "pass": {
+      "note": "PER-PASS uniforms (evaluated once per pass, never per frame): the ✗ box half-size + SDF stroke/range in device px, sized to the TARGETED element (targetMinDimPx falls back to the full canvas when untargeted). sdfRange/sdfViewBoxW come from the cross sampler's baked-SDF metadata; sdfOn is deliberately NOT here — the web aux-texture binding flips it, natives keep the analytic ✗ at 0.",
+      "boxPx": {
+        "mul": [
+          0.15,
+          {
+            "input": "targetMinDimPx"
+          }
+        ]
+      },
+      "sdfStrokePx": {
+        "mul": [
+          0.15,
+          {
+            "input": "targetMinDimPx"
+          },
+          0.13
+        ]
+      },
+      "sdfRangePx": {
+        "mul": [
+          {
+            "input": "sdfRange"
+          },
+          {
+            "div": [
+              {
+                "mul": [
+                  2,
+                  {
+                    "mul": [
+                      0.15,
+                      {
+                        "input": "targetMinDimPx"
+                      }
+                    ]
+                  }
+                ]
+              },
+              {
+                "max": [
+                  {
+                    "input": "sdfViewBoxW"
+                  },
+                  0.000001
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "consts": {},
+    "config": {
+      "usesOrigin": true
+    },
+    "backends": {
+      "webgl2": {
+        "stage": "fullscreen-triangle",
+        "blend": "screen",
+        "shader": {
+          "program": "fail"
+        }
+      }
+    },
+    "fallbackOrder": [
+      "webgl2"
+    ]
+  },
+  "binding": {
+    "note": "CROSS-PLATFORM uniform-binding contract. Which render.params are NOT shader uniforms, the seed-keyed scatter field (no scatterWeb — the fail shader reads no seed uniform), 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",
+      "shakeAmount",
+      "seed"
+    ],
+    "scatterKey": "failSeed",
+    "extras": [
+      {
+        "name": "stamp",
+        "type": "float",
+        "web": "uStamp",
+        "note": "stampProgress(animMs)"
+      },
+      {
+        "name": "shake",
+        "type": "float",
+        "web": "uShake",
+        "note": "signed recoil shake (-1..1)"
+      },
+      {
+        "name": "sdfOn",
+        "type": "float",
+        "web": "uSdfOn",
+        "note": "1 = drive the cross from the baked SDF"
+      },
+      {
+        "name": "sdfRangePx",
+        "type": "float",
+        "web": "uSdfRangePx",
+        "note": "device px mapping to the SDF 0..1 range"
+      },
+      {
+        "name": "sdfStrokePx",
+        "type": "float",
+        "web": "uSdfStrokePx",
+        "note": "half stroke width (device px)"
+      },
+      {
+        "name": "boxPx",
+        "type": "float",
+        "web": "uBoxPx",
+        "note": "half-size (device px) of the ✗ box"
+      }
+    ],
+    "samplers": [
+      {
+        "web": "uSdfTex",
+        "name": "sdfTex",
+        "texture": 1,
+        "outline": "cross",
+        "on": "sdfOn",
+        "note": "Declarative SDF source: the baked geometry.outlines.cross SDF binds here on web (flipping the sdfOn extra to 1); the native runtimes don't bind aux textures yet — sdfOn stays 0 and the shader's analytic two-bar ✗ renders."
+      }
+    ]
+  }
+}

package/src/index.ts

@@ -0,0 +1,56 @@
+/**
+ * Fail / error effect — the emotional OPPOSITE of the three success effects.
+ *
+ * A red/amber ✗ cross is STAMPED in over a recoiling error flare with a sharp
+ * hit + damped shake, then desaturates and collapses. Short and punchy, not a
+ * celebratory bloom.
+ *
+ * FULLY DATA-DRIVEN: the params/palette/tempo come from fail.dope.json via the
+ * loader; the per-frame logic — the slam/hold/collapse `amp`, the 170 ms stamp
+ * and the damped recoil shake — is `tempo.frame` (stamp/shake run on the REAL
+ * un-stepped `elapsedMs`, matching the Swift/Android ports); and the ✗ plumbing
+ * that used to be code hooks is now data too: `render.pass` declares the
+ * box/stroke/range pixel uniforms (sized to `targetMinDimPx`) and the
+ * `binding.samplers` `outline`/`on` source declares the baked-SDF aux texture
+ * (geometry seam). The only hand-written web sources left are this
+ * registration shim (the fail moods are web-runtime-only) and the shader.
+ */
+
+import { FAIL_FRAGMENT_SRC, FAIL_VERTEX_SRC } from "./fail-shader.js";
+import {
+  registerDopeEffect,
+  registerMood,
+  parseDope,
+  type RGB,
+  type EffectFactory,
+  type PassParams,
+} from "@dopaminefx/core";
+import doc from "./fail.dope.json";
+
+const DOPE = parseDope(doc as object);
+
+/** Register the fail-appropriate moods so they light up the registry (energy). */
+registerMood("try-again", { hueCenter: 70, hueRange: 40, lightness: 0.78, chroma: 0.13, energy: 0.2 });
+registerMood("error", { hueCenter: 40, hueRange: 36, lightness: 0.72, chroma: 0.17, energy: 0.55 });
+registerMood("denied", { hueCenter: 22, hueRange: 30, lightness: 0.66, chroma: 0.21, energy: 1.0 });
+
+/** The fail render params (the loader bag + the typed fields the shader reads). */
+export interface FailParams extends PassParams {
+  seed: number;
+  palette: [RGB, RGB, RGB];
+  exposure: number;
+  severity: number;
+  shakeAmount: number;
+  style: number;
+  failSeed: number;
+}
+
+// The whole factory (resolve / frame / pass uniforms / SDF aux texture /
+// shadow / bindings / program registration) is data: fail.dope.json
+// interpreted by the core backbone.
+export const fail = registerDopeEffect(DOPE, {
+  vertex: FAIL_VERTEX_SRC,
+  fragment: FAIL_FRAGMENT_SRC,
+}) as EffectFactory<PassParams> as EffectFactory<FailParams>;
+
+export default fail;