@norbert_bodziony/bloub 0.3.0 → 0.6.0

package/README.md

@@ -29,7 +29,7 @@ something done.
 
 ## What's in it
 
-The rail on the left switches between three views. **Customise** offers 8 body
+The rail on the left switches between three views. **Customise** offers 11 body
 shapes, 12 colours and 16 rest expressions, kept between visits. **Animations** is
 a small editor: arrange states into a timeline, set how long each is held, save the
 result. **Settings** holds the language (French, English or Chinese) and the
@@ -118,16 +118,43 @@ editor, Tailwind, export dialogs, video encoder, or application translations.
 Solid runtime. The package supports SolidJS 2, starting with `2.0.0-rc.0`.
 
 Props: `size`, `shape`, `color`, `expression`, `paper`, `frozenAt`, `cycle`,
-`follow`, `gaze`, `ariaLabel`, `block`, `state`, `playing`, `elapsed`, `fps`, and
-`autoPause`. Each playback value has a matching `on...Change` callback. See
-[BloubBot.tsx](src/components/BloubBot.tsx) for the details.
+`follow`, `gaze`, `layer`, `ariaLabel`, `block`, `state`, `playing`, `elapsed`, `fps`,
+`autoPause`, `paused`, and `initialPhase`. Each playback value has a matching `on...Change`
+callback. See [BloubBot.tsx](src/components/BloubBot.tsx) for the details.
+
+`initialPhase` starts the bot at that time of its cycle, in seconds. The component
+reads it once, on mount. Give each bot in a list a different value, and the bots
+do not breathe in step.
 
 An animated bot costs a style recalculation, a layout and a paint per drawn
 frame, so its price is set by how often it draws and by how many of them are on
 screen. `fps` caps the rate — a 40 px avatar in a list is indistinguishable at 30
 from the screen's 120 — and `autoPause`, on by default, stops the loop when the
 bot is off screen or its tab is in the background. Neither changes what the bot
-looks like while someone is watching it.
+looks like while someone is watching it. `paused` stops the loop on the pose on
+screen once it is at rest, and resumes from it: an avatar that animates only on
+hover keeps one instance, rather than swapping a `frozenAt` bot for a live one,
+which jumps between two poses.
+
+### The plush bot
+
+```tsx
+import { PlushBot } from '@norbert_bodziony/bloub/plush'
+
+<PlushBot character="nexo" />
+<PlushBot shape="losange" color="#3b93f0" expression="heureux" state="wink" />
+<PlushBot shape={shape()} transition="pop" />
+```
+
+A felt plush version of the bot, in its own entry so its code and images stay out of
+the main bundle. Six baked characters, or any of the 11 shapes in any colour. Only the
+eyes move: `state` is one of `idle`, `wink`, `wide`, `thinking`, `notify`, `asleep`
+and `failed`, and `expression` takes any of the 16 rest faces. Every change, even inside a fade, blends
+with the engine's own timings. When the body changes (shape, character or colour), it
+turns like a coin and swaps edge-on; `transition` picks another way: `pop`, `warp`,
+`dissolve` or `cut`. `eyeScale` grows the face for small avatars (about 1.3 at
+24–40 px), and `paused` works as on `BloubBot`. The images are separate files that
+your bundler emits; only the ones a bot shows are fetched. [docs/plush.md](docs/plush.md) has the details.
 
 ## Changes