aether-dice 0.1.0 → 0.2.0

package/README.md

@@ -63,7 +63,7 @@ const result = await dice.roll(
 | Option | Type | Default | Description |
 |---|---|---|---|
 | `container` | `HTMLElement` | — | Element the canvas overlay mounts into (required). |
-| `assetPath` | `string` | — | Base URL for textures/wasm assets. |
+| `assetPath` | `string` | bundle-relative | Base URL for textures (env/normal maps). Defaults to the `assets/` folder shipped next to the bundle, so npm/jsDelivr consumers need no config; override with your own hosted path. |
 | `theme` | `string \| object` | `'aether'` | Built-in theme name or a theme object. |
 | `scale` | `number` | `6` | Die size. |
 | `gravity` | `number` | `40` | Physics gravity. |
@@ -121,9 +121,19 @@ new AetherDice({ theme: {                          // custom (merged over aether
   bloomStrength: 1.5,          // overall bloom amount
   bloomRadius:   0.6,          // bloom spread
   bloomThreshold:0,            // luminance cutoff (0 = bloom all edge light)
+  envMap:        'env.png',    // environment map for reflections (null to disable)
+  envIntensity:  1.0,          // reflection strength
+  normalMap:     'surface-normal.png', // subtle surface detail (null to disable)
+  normalScale:   0.25,         // normal map strength
 }});
 ```
 
+`envMap` and `normalMap` are filenames resolved against `assetPath`. AetherDice ships
+default `env.png` (a studio environment giving the metallic dice reflections) and
+`surface-normal.png` (a faint cast-glass surface) in its `assets/` folder; set either to
+`null` to skip it. Textures load during `init()` and failures are non-fatal — the dice
+just render without that map.
+
 ### Built-in themes
 
 | Preview | Name | Look |
@@ -166,8 +176,26 @@ result to verify determinism.
 ## Distribution
 
 Published to npm and consumable via jsDelivr. The public API above is the semver
-stability contract. Ship `dist/aether-dice.esm.js` + `assets/`; consumers point
-`assetPath` at the hosted assets.
+stability contract. The build emits `dist/aether-dice.esm.js` + `dist/assets/`, and both
+ship in the npm tarball — the bundle resolves its default `assetPath` relative to itself,
+so textures load with no configuration. Override `assetPath` only if you host the assets
+elsewhere (e.g. a different CDN).
+
+### Releasing
+
+One command runs the whole flow — preflight, quality gate, version bump + tag, push,
+npm publish, and a GitHub release with the bundle attached:
+
+```bash
+npm run release                # patch  (0.1.0 -> 0.1.1)
+npm run release -- minor       # minor  (0.1.0 -> 0.2.0)
+npm run release -- major       # major
+npm run release -- 1.2.3       # explicit version
+npm run release -- patch --dry-run   # preflight + gate + pack preview, no changes
+```
+
+It aborts before mutating anything if the tree is dirty, the branch isn't `main`, the
+branch is behind `origin`, npm isn't authenticated, or lint/tests/build fail.
 
 ## License