@algorisys/tinyfly 0.98.0 β†’ 0.99.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -54,14 +54,14 @@ A lightweight, API-driven animation engine and visual editor for creating high-p
54
54
  - **Code-drawn targets** - A `custom` canvas target draws with code (characters, charts, props) while the timeline animates its position, opacity and its own `props`, so drawing stays code and timing stays JSON
55
55
  - **Immediate mode too** - A scene's `background` and `draw(ctx, { time })` functions paint each frame directly, Cairo/Processing-style, and mix freely with timeline targets
56
56
  - **Timing from narration** - `planNarration()` lays spoken lines out from their clip lengths (lead, gap, tail) into cues, scene spans and markers; `voiceNarration()` measures recorded clips with ffmpeg and writes the sample-aligned narration WAV
57
- - **Characters** - A poseable stick figure (`@algorisys/tinyfly/characters`): named poses, facial expressions (brows, eyes that widen, close and look around, mouth shapes), squash and stretch, rubber-hose limbs, blending, walk cycles and talking, all driven by timeline tracks. **Characters v2**: one skeleton in 3D drawn flat, turning front to side to back, resting on whatever touches the ground, reaching for points, in clean, pencil or silhouette looks, and a 🧍 Character element in the editor you pose and keyframe. **Character appearance**: 34 hairstyles, 20 facial-hair styles, glasses, hats and ears as plain data on the head (they turn with it through all eight views), builds from toddler to tall, a recurring cast (`castMember`), and 30 expressions with blush, tears and sweat ([guide](docs/character-appearance.md))
57
+ - **Characters** - A poseable stick figure (`@algorisys/tinyfly/characters`): named poses, facial expressions (brows, eyes that widen, close and look around, mouth shapes), squash and stretch, rubber-hose limbs, blending, walk cycles and talking, all driven by timeline tracks. **Characters v2**: one skeleton in 3D drawn flat, turning front to side to back, resting on whatever touches the ground, reaching for points, in clean, pencil or silhouette looks, and a 🧍 Character element in the editor you pose and keyframe. **Character appearance**: 34 hairstyles, 20 facial-hair styles, glasses, hats and ears as plain data on the head (they turn with it through all eight views), builds from toddler to tall, a recurring cast (`castMember`), 30 expressions with blush, tears and sweat, and hair that swings after a turn or a run and settles (`hairFollowTracks` keys the lag from the character's own tracks, so drawing stays stateless); four-legged animals' ears lay back on a run the way their tails already trail ([guide](docs/character-appearance.md))
58
58
  - **Dance and flips** - The stick figure dances disco, hip hop, breaking toprock, jazz, K-pop, Bollywood, Bhangra, Bharatanatyam (with mudras), the Charleston, tap (foot strikes as data, for tap sounds) and popping (side glide, moonwalk, forward glide, which travel with the planted foot staying put), and does front, back, layout, scissor and side flips, cartwheels, back handsprings, split leaps, toe touches and full splits. Wrists, ankles, foot turn-out, whole-body `spin` and `rise` are pose fields; moves are keyed in beats, so any tempo plays them; styles, grooves and routines are plain JSON (`danceFrame()`, `danceTracks()`, `flipPose()`, `flipTracks()`). In the editor a 🧍 Character dances from the playhead, in time with the music: an Audio element's tempo is detected (`detectTempo()`) or tapped, the timeline shows its beats and bars, and keyframes snap to them. See [docs/dance.md](docs/dance.md)
59
59
  - **Maps** - Animated maps on OpenStreetMap tiles or an offline world outline (also in pencil): the camera flies in, pins drop, routes draw themselves while a marker travels them; a πŸ—Ί Map element in the editor with a one-click trip
60
60
  - **Pencil sketch style** - Hand-drawn strokes with line boil (`sketch` style, `sketchPen`) for a pencil-test, Pencilmation-like look, on the stick figure and on canvas rect / circle / line / path shapes (also from the editor's Properties panel); a `drawOn` track draws any of those shapes on; the wobble is seeded by time, so renders stay deterministic
61
61
  - **The drawing hand** - `drawnPathTarget()` draws a sketched stroke on from a `draw` track while a cartoon hand holds the pencil at its end in a writing grip; the same hand can hold the eraser. `handAt()` gives one hand for a whole scene: it follows each stroke, lifts and glides to the next, and enters and leaves the page
62
62
  - **Erasing** - An eraser rubs out part of a target (`erasable()`, animated by an `erase` track) or of anything drawn in code (`withErased()`); clip-based, so it works in the browser and headless alike
63
63
  - **Cartoon hands** - A hand rig in 3D, drawn flat: thumb and fingers posed by numbers (`index.curl`, `thumb.across`, `spread`, `turn`), ready-made shapes (fist, point, thumbs-up, peace, OK, pinch, wave, pencil grip…), left and right, four or five fingers, in every look; the animator's hand and (opt-in) character gloves are built on it. See [docs/cartoon-hands.md](docs/cartoon-hands.md)
64
- - **Cartoon acting** - `actTracks()` turns the same key poses into acted motion: wind-ups, overshoot that settles or wobbles, joints that overlap (hips lead, wrists drag), eyes that dart ahead and blink on head turns, moving holds and jump squash, in `full`, `snappy` or `limited` styles. Gags come as data (`gag('take')`, double take, wind-up, tremble). A line of action (`bend`) curves the spine, and gaits have personality (bouncy, double bounce, sneak, strut, tired, run). Lip-sync works from text, Latin or Devanagari. `scriptTracks()` compiles a story written as beats (`{ do: 'walk', to: 640 }`, `{ do: 'take' }`, `{ do: 'say', say: '…' }`) into all of it. `cameraTracks()` films it with push-ins, cuts, shakes and follows. The cartoon zip (`{ do: 'zip' }`) has the legs wheel in place before it is gone. Figures can act on code, Animator vs Animation style: `codePanel()` lays a listing out so every line and word is a place in the scene, and beats leap onto lines, point at them and swipe them away (`{ do: 'swipe', target: code.line(7) }`), with the line wiped, knocked off the panel or blurred out of focus on the frames the hand crosses it. Words come loose too: a figure grabs `var` and throws it, kicks another out of a loop, carries a stray `;` to where it belongs, pushes a word along its line (the text closing up behind it), and writes `mut` into a line by hand. A figure standing on a line rides it when a gap above closes (`code.ride()`). Code is one *surface*; `whiteboard()` is another, a board or chalkboard of texts and hand-drawn circles, boxes, underlines and arrows, so a figure can work through a lesson that is not code, `chart()` a third, bar and line charts whose bars a figure points at, highlights and stands on as they grow, and `propSurface()` makes any prop one, so a figure opens a car's door or switches a house's lights on. Places on a surface have names (`line:7`, `token:4:Println`, `term:eq:+ 4`), and `surfaceScript()` takes a whole scene as JSON: beats aim at named places and say what the surface does in answer, at the moment the hand touches or lets go. Props give the story a world: cars, trucks, buses, tractors, carts, train carriages, bikes, motorbikes, trees, houses, a helicopter and a plane, a horse, dogs, cats, cows and birds are 3D rigs drawn with the figures' pens, so they turn toward the camera and boil in pencil, or as line art beside stick figures. They act from beats through the same principles (they rock back before they go, dip on the stop, skid, bump, sway, take off and loop; animals walk, trot and gallop with their feet keeping pace, sit and jump; birds hop, peck, flap and fly up to a perch), with an exaggeration dial, and figures can ride them. See [docs/props.md](docs/props.md). Your own behaviours are plain values: `defineAction()` (from beats or timed pose steps), `defineGait()`, and `persona()` for a recurring character's look, acting style, gait, usual face and stance. In the editor, a Character's **Acting** section acts its keyed poses in a style and adds gags, walks in a gait and lip-synced lines, with drawing on twos as a timeline setting. Characters come in builds (slim, kid, broad, curvy, stocky), and the v2 human has its own line of action, gaits and gags, posed in 3D so they read from every view. It also adds speed lines from earlier frames (`drawStickSmear()`), dust puffs, impact stars, and drawing on twos for video (`drawingRate`). Output is plain keyframes. See [docs/acting.md](docs/acting.md)
64
+ - **Cartoon acting** - `actTracks()` turns the same key poses into acted motion: wind-ups, overshoot that settles or wobbles, joints that overlap (hips lead, wrists drag), eyes that dart ahead and blink on head turns, moving holds and jump squash, in `full`, `snappy` or `limited` styles. Gags come as data (`gag('take')`, double take, wind-up, tremble). A line of action (`bend`) curves the spine, and gaits have personality (bouncy, double bounce, sneak, strut, tired, run). Lip-sync works from text, Latin or Devanagari. `scriptTracks()` compiles a story written as beats (`{ do: 'walk', to: 640 }`, `{ do: 'take' }`, `{ do: 'say', say: '…' }`) into all of it, and `characterScript()` compiles the same beats for a v2 character from the cast, on its own body and stride. `cameraTracks()` films it with push-ins, cuts, shakes and follows. The cartoon zip (`{ do: 'zip' }`) has the legs wheel in place before it is gone. Figures can act on code, Animator vs Animation style: `codePanel()` lays a listing out so every line and word is a place in the scene, and beats leap onto lines, point at them and swipe them away (`{ do: 'swipe', target: code.line(7) }`), with the line wiped, knocked off the panel or blurred out of focus on the frames the hand crosses it. Words come loose too: a figure grabs `var` and throws it, kicks another out of a loop, carries a stray `;` to where it belongs, pushes a word along its line (the text closing up behind it), and writes `mut` into a line by hand. A figure standing on a line rides it when a gap above closes (`code.ride()`). Code is one *surface*; `whiteboard()` is another, a board or chalkboard of texts and hand-drawn circles, boxes, underlines and arrows, so a figure can work through a lesson that is not code, `chart()` a third, bar, line, pie and donut charts whose bars a figure points at, highlights and stands on as they grow, with slices it pulls out or kicks loose as pieces, several series with a legend, and axis titles, and `propSurface()` makes any prop one, so a figure opens a car's door or switches a house's lights on, kicks a wheel loose (parts are pieces), and rides on the roof as the car lifts (anchors and parts are floors). Boards write in a handwriting font, bend arrows round what is in the way, and come as ruled paper too. In the editor, a 🧍 Character's **Beats** box compiles a story into its tracks, aimed at a ⌨ **Code** element's lines, and riders drive or pedal (`RIDING_POSES.driving`, `pedallingKeys`). Places on a surface have names (`line:7`, `token:4:Println`, `term:eq:+ 4`), and `surfaceScript()` takes a whole scene as JSON: beats aim at named places and say what the surface does in answer, at the moment the hand touches or lets go. Props give the story a world: cars, trucks, buses, tractors, carts, train carriages, bikes, motorbikes, trees, houses, a helicopter and a plane, a horse, dogs, cats, cows and birds are 3D rigs drawn with the figures' pens, so they turn toward the camera and boil in pencil, or as line art beside stick figures. They act from beats through the same principles (they rock back before they go, dip on the stop, skid, bump, sway, take off and loop; animals walk, trot and gallop with their feet keeping pace, sit and jump; birds hop, peck, flap and fly up to a perch), with an exaggeration dial, and figures can ride them. See [docs/props.md](docs/props.md). Your own behaviours are plain values: `defineAction()` (from beats or timed pose steps), `defineGait()`, and `persona()` for a recurring character's look, acting style, gait, usual face and stance. In the editor, a Character's **Acting** section acts its keyed poses in a style and adds gags, walks in a gait and lip-synced lines, with drawing on twos as a timeline setting. Characters come in builds (slim, kid, broad, curvy, stocky), and the v2 human has its own line of action, gaits and gags, posed in 3D so they read from every view. It also adds speed lines from earlier frames (`drawStickSmear()`), dust puffs, impact stars, and drawing on twos for video (`drawingRate`). Output is plain keyframes. See [docs/acting.md](docs/acting.md)
65
65
  - **Pencil story example** - `examples/pencil-story-hindi/index.html` tells a short Hindi story (ΰ€ͺΰ₯ΰ€―ΰ€Ύΰ€Έΰ€Ύ ΰ€°ΰ€Ύΰ€Ήΰ€—ΰ₯€ΰ€°, the thirsty traveller) Pencilmation-style with the browser bundle alone: the hand draws the scene and writes the narration, then rubs out the pot
66
66
  - **Captions** - `toSRT()` / `toWebVTT()` from narration cues or from a timeline's markers
67
67
 
@@ -90,7 +90,7 @@ A lightweight, API-driven animation engine and visual editor for creating high-p
90
90
  - **Media in embeds** - Exported/embedded HTML carries the media, and the player auto-discovers and syncs it (`[data-tinyfly-media]`), so audio/video play in time wherever the animation is embedded
91
91
 
92
92
  ### Visual Editor
93
- - **AI prompt β†’ animation** - Describe an animation in plain language ("a title that fades up with a shine", "three cards sliding in one after another") and generate a fully editable timeline. Bring your own API key for **OpenAI, Google Gemini, or Anthropic** β€” keys stay in your browser and are sent directly to the provider. The model emits tinyfly's JSON schema, which loads through the same path as the editable examples, so generated animations are ordinary keyframes you can tweak
93
+ - **AI prompt β†’ animation** - Describe an animation in plain language ("a title that fades up with a shine", "three cards sliding in one after another") and generate a fully editable timeline. Bring your own API key for **OpenAI, Google Gemini, or Anthropic** β€” keys stay in your browser and are sent directly to the provider. The model emits tinyfly's JSON schema, which loads through the same path as the editable examples, so generated animations are ordinary keyframes you can tweak. Ask for a story and it casts a character (`cast: 'grandma'`) and writes its beats (walk, look, a take, a line, a zip) rather than keyframes; the beats compile on load with `characterScript()` and stay on the element
94
94
  - **Any canvas / aspect ratio** - The preview artboard follows the project canvas (DOM, Canvas, and SVG renderers) and fits-to-view, so a vertical 9:16 promo or any custom size previews at true proportions; samples can declare their own canvas size
95
95
  - **Device-frame preset** - One click stamps a device mockup (rounded body, camera/notch, and a rounded video "screen") sized to the canvas, in **Phone / Landscape / Tablet** variants β€” drop a screen-recording into the screen's source for an app promo
96
96
  - **Timeline view** - Visual keyframe editing with drag-and-drop
@@ -100,7 +100,7 @@ A lightweight, API-driven animation engine and visual editor for creating high-p
100
100
  - **Loop check** - `tinyfly video scene.mjs --loop-check` renders five frames and says whether a video loops: whether the frame at the duration matches the first, and whether the last β†’ first seam looks like any other step (exit 1 when it does not). `--frames 0,79,88` renders stills at chosen frames. See [docs/video-rendering.md](docs/video-rendering.md#loops)
101
101
  - **Bloom** - `bloom: true` on a video scene adds a deterministic glow around bright things (bright pass, blur, add; no `ctx.filter`), and 3D materials take `emissive` light that shines in the dark and feeds it. `applyBloom(ctx)` works on any 2D canvas. See [docs/video-rendering.md](docs/video-rendering.md#bloom)
102
102
  - **Light trails** - `trailSamples` + `drawTrail` draw comets and light streaks on any 2D canvas: a tapering, fading band with a round head, smooth at any speed, and deterministic (the trail is where the thing was, asked of the timeline, not a frame history). 3D scenes get `line` and `trail` objects whose segments sort by depth among the meshes. See [docs/video-rendering.md](docs/video-rendering.md#light-trails) and [docs/scene-3d.md](docs/scene-3d.md#lines-and-trails)
103
- - **3D scenes** - `@algorisys/tinyfly/scene-3d`: cameras, lights and meshes (box, sphere, cylinder, cone, torus, floor, any SVG path extruded) as JSON in metres, animated by ordinary tracks (`stage/box`), cut between cameras with one keyframe, drawn on a plain canvas with flat, smooth or toon shading, ink outlines and fog: in the browser, in Workers, and to MP4 in Node. Characters stand in scenes and dance, seen by any camera, in their pen looks (clean, pencil) or as solid figures (`characterObjects`); props (cars, houses, trees, animals, birds) stand in them by preset name (`propObjects`), sorted a column at a time so figures walk round them rightly, and lit by the scene's lights (a sunset, a night with lit windows). Both are scripted in world metres (`propScript3D`, `characterScript3D`): drive or walk to a point or along a path, wheels and feet keeping pace with the ground. In the editor, a 🧊 3D Scene element builds them without code: add shapes, characters and lights, key them, dance from the playhead, cut between cameras. No WebGL needed (about 7 KB gzipped, its own entry and CDN script); for big or tangled scenes the optional WebGL2 renderer (`@algorisys/tinyfly/scene-3d/webgl`) adds a depth buffer and light per pixel. See [docs/scene-3d.md](docs/scene-3d.md)
103
+ - **3D scenes** - `@algorisys/tinyfly/scene-3d`: cameras, lights, meshes (box, sphere, cylinder, cone, torus, floor, any SVG path extruded) and props from the catalog (also from the editor's 3D Scene palette) as JSON in metres, animated by ordinary tracks (`stage/box`), cut between cameras with one keyframe, drawn on a plain canvas with flat, smooth or toon shading, ink outlines and fog: in the browser, in Workers, and to MP4 in Node. Characters stand in scenes and dance, seen by any camera, in their pen looks (clean, pencil) or as solid figures (`characterObjects`); props (cars, houses, trees, animals, birds) stand in them by preset name (`propObjects`), sorted a column at a time so figures walk round them rightly, and lit by the scene's lights (a sunset, a night with lit windows). Both are scripted in world metres (`propScript3D`, `characterScript3D`): drive or walk to a point or along a path, wheels and feet keeping pace with the ground. In the editor, a 🧊 3D Scene element builds them without code: add shapes, characters and lights, key them, dance from the playhead, cut between cameras. No WebGL needed (about 7 KB gzipped, its own entry and CDN script); for big or tangled scenes the optional WebGL2 renderer (`@algorisys/tinyfly/scene-3d/webgl`) adds a depth buffer and light per pixel. See [docs/scene-3d.md](docs/scene-3d.md)
104
104
  - **3D transforms** - Cards, images, text and shapes turn in 3D (`rotateX`, `rotateY`, `z`, `perspective`, `backfaceVisibility`) and land on the same pixels in DOM, SVG, Canvas (true perspective, also headless) and WebGL, checked against each browser's own CSS. One documented transform order everywhere; Tilt / Turn / Depth / Perspective fields in the editor; 3D Card Flip and Cover Flow samples. Quaternion tracks with `interpolation: "slerp"` turn without gimbal lock; the engine's `vec3`, `quat` and `mat4` helpers are plain arrays. The first steps of [3D support](docs/3d-support-plan.md). See [docs/3d-rotations.md](docs/3d-rotations.md)
105
105
  - **Shape morph** - πŸŒ€ Tween one path into another over the timeline (engine-level path interpolation); plays in every renderer, export, and embed
106
106
  - **Grid, snapping & guides** - β–¦ 20px grid, 🧲 snapping of drag/resize to grid/element-edges/artboard with live alignment guides, and πŸ“ rulers with draggable guides
@@ -237,7 +237,7 @@ GSAP-shaped functions at the top level. Teaching embeds are included: add
237
237
  itself.
238
238
 
239
239
  ```html
240
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly.iife.js"></script>
240
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly.iife.js"></script>
241
241
  <script>
242
242
  tinyfly.to('.box', { x: 200, rotate: 90, duration: 1, ease: 'power2.out' })
243
243
 
@@ -273,7 +273,7 @@ A teaching figure needs no code at all:
273
273
  <script type="application/json" data-tinyfly-timeline>{ …timeline JSON with markers… }</script>
274
274
  <figcaption>Appending to a full slice</figcaption>
275
275
  </figure>
276
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly.iife.js" data-tinyfly-auto></script>
276
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly.iife.js" data-tinyfly-auto></script>
277
277
  ```
278
278
 
279
279
  See [Teaching Animations](docs/teaching.md).
@@ -372,7 +372,7 @@ Without a build step, the player bundle puts the same functions on a `tinyfly` g
372
372
  <div data-tinyfly="box" style="width: 60px; height: 60px; background: #4a9eff;"></div>
373
373
  </div>
374
374
 
375
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-player.iife.js"></script>
375
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-player.iife.js"></script>
376
376
  <script>
377
377
  tinyfly.play('#animation', './animation.json', { loop: -1 })
378
378
  </script>
@@ -481,7 +481,7 @@ Or skip the code entirely with declarative embeds (see [Teaching Animations](doc
481
481
  <svg viewBox="0 0 720 200">…</svg>
482
482
  <script type="application/json" data-tinyfly-timeline>{ …timeline JSON… }</script>
483
483
  </figure>
484
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-embed.iife.js" data-tinyfly-auto></script>
484
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-embed.iife.js" data-tinyfly-auto></script>
485
485
  ```
486
486
 
487
487
  ### Audio / Video Sync
package/docs/acting.md CHANGED
@@ -253,6 +253,42 @@ leaves, with a time, a scene x and y and a length, ready for `drawDustPuff`.
253
253
  Any beat can also take `onto` (a scene y): the figure is carried to that floor
254
254
  over the beat, as when the line it stands on moves up.
255
255
 
256
+ ### On a v2 character
257
+
258
+ `characterScript(target, who, beats, options)` compiles the same beats for a
259
+ v2 `character()` (see [Character Appearance](character-appearance.md)), so a
260
+ cast member acts the story the stick figure does:
261
+
262
+ ```js
263
+ import { character, castMember, characterScript, characterTarget, hairFollowTracks } from '@algorisys/tinyfly/characters'
264
+
265
+ const amy = character(castMember('youngWoman', 170))
266
+ const script = characterScript('amy', amy, [
267
+ { do: 'walk', to: 330, mood: 'happy' },
268
+ { do: 'say', say: 'Is that box ticking?', mood: 'worried' },
269
+ { do: 'take' },
270
+ { do: 'zip', to: -200 },
271
+ ], { from: 90, style: 'snappy' })
272
+ const tracks = [...script.tracks, ...hairFollowTracks('amy', script.tracks, amy)]
273
+ const targets = { amy: characterTarget({ x: 90, y: 300, character: amy }) }
274
+ ```
275
+
276
+ It takes every `scriptTracks` option but `height` (the character's own is
277
+ used) and returns the same result: tracks, `duration`, `lines`, `beats`,
278
+ `effects`, and the key poses on the human body. The stick-figure script plans
279
+ the story (timing, where the figure is, which way it faces, its gait, its
280
+ speech); its key poses are taken onto the human body, mirrored when it faces
281
+ left (so `turn` runs negative that way); the human acting pass then winds up,
282
+ overshoots and overlaps on this body, and the lines are lip-synced over its
283
+ mouth. The walk phase is rekeyed to the character's own stride (its height and
284
+ legs: a child takes shorter steps), so its feet stay planted. The `walk`,
285
+ `walking` and `gait` tracks step the gait as the target draws
286
+ (`characterPoseOf(props)` folds them into the pose, for drawing by hand). Hands
287
+ reach in the stick figure's proportions, so a `grab` or a `point` lands near
288
+ its target on the human body, not exactly on it. Your own gaits go in
289
+ `options.gaits` for the script and `gaits` on `characterTarget` so the drawing
290
+ knows them too.
291
+
256
292
  ## Your own actions, gaits and personas
257
293
 
258
294
  Behaviours of your own are plain values passed where they are used; nothing
@@ -501,7 +537,7 @@ lists the problems without compiling.
501
537
  ### Whiteboards
502
538
 
503
539
  `whiteboard()` is a second surface, for lessons that are not code: a board
504
- (or `theme: 'chalkboard'`) whose texts and hand-drawn marks are declared as
540
+ (or `theme: 'chalkboard'`, or `'lines'`, ruled paper with a margin) whose texts and hand-drawn marks are declared as
505
541
  data, each with an id, and named as places like a code panel's lines:
506
542
 
507
543
  ```js
@@ -535,11 +571,17 @@ everywhere. Colours are theme names (`red`, `blue`, `green`, `orange`, and
535
571
  `yellow` on chalk) or any CSS colour. The Board Lesson demo solves an
536
572
  equation this way.
537
573
 
574
+ The boards write in a handwriting font, Patrick Hand, when the page loads it
575
+ (the editor and the examples do, from Google Fonts), else the system's own
576
+ hand. An arrow bows a little as a hand draws it; it bends round any text it
577
+ would cross, and `bend` (a fraction of its length, + to its left) sets the bow.
578
+
538
579
  ### Charts
539
580
 
540
- `chart()` is a surface for talking through data: a bar or line chart whose
541
- values are declared as data, scaled once when it is made (`max`, or a round
542
- number above the largest value).
581
+ `chart()` is a surface for talking through data: a bar, line, pie or donut
582
+ chart whose values are declared as data. Bar and line charts are scaled once
583
+ when they are made (`max`, or a round number above the largest value); a pie
584
+ shares its circle by value.
543
585
 
544
586
  ```js
545
587
  const sales = chart({
@@ -559,13 +601,26 @@ surfaceScript('hero', { sales }, [
559
601
  ], { from: 640, ground: 400, height: 90, facing: -1 })
560
602
  ```
561
603
 
562
- Its places are `bar:ID` (on a bar chart) or `point:ID` (on a line chart),
563
- `label:ID`, `value:ID` and `box`, and they follow the values:
564
- `sales.anchor('bar:q4', time)` is the bar as it stands then. Its edits:
565
- `set` (a new `value`; the value label counts along), `show` (grow a
566
- `hidden` bar in from the axis, or draw the line out to a point; `on: false`
567
- takes it back) and `highlight`. A bar's top is a floor: a figure standing on
568
- it is carried up and down as it grows and shrinks, as in the Chart Talk demo.
604
+ Its places are `bar:ID` (on a bar chart), `point:ID` (on a line chart) or
605
+ `slice:ID` (on a pie or donut), `label:ID`, `value:ID` and `box`, and they
606
+ follow the values: `sales.anchor('bar:q4', time)` is the bar as it stands
607
+ then. Its edits: `set` (a new `value`; the value label counts along, and a
608
+ pie re-shares its circle), `show` (grow a `hidden` bar in from the axis, draw
609
+ the line out to a point, or open a slice; `on: false` takes it back),
610
+ `highlight`, and on a pie `pull` (the slice stands out from the centre). A
611
+ bar's top is a floor: a figure standing on it is carried up and down as it
612
+ grows and shrinks, as in the Chart Talk demo.
613
+
614
+ A slice can come loose: `traffic.piece('slice:other')` is a piece, and
615
+ `fling`, `follow` and `move` carry it off as they do a term on a board, so a
616
+ figure can kick the smallest slice out of the pie.
617
+
618
+ Several series (`series: [{ id: 'plan' }, { id: 'actual', color }]`, each
619
+ datum with `values: { plan: 40, actual: 46 }`) draw grouped bars or one line
620
+ per series, with a legend (`legend:SERIES` is a place too). Their places and
621
+ edits take the series after the id: `bar:q1:actual`. Axis titles go in
622
+ `axis: { x, y }`. A pie shows one series. The Pies & Series card shows all of
623
+ it.
569
624
 
570
625
  ### Props as surfaces
571
626
 
@@ -591,6 +646,14 @@ surfaceScript('hero', { home: homeSurface }, [
591
646
  ], { from: 40, ground: floor, height: 100 })
592
647
  ```
593
648
 
649
+ A prop's parts come loose too: `carSurface.piece('part:wheel-0-left')` is a
650
+ piece, and `fling`, `follow` and `move` carry it off, drawn where it went
651
+ (or as edits from a beat: `then: { edit: 'fling', anchor: 'part:wheel-0-left',
652
+ at: 'contact' }` on a `kick`). Every anchor and part is also a floor: a figure
653
+ that leaps `onto: { surface: 'car', anchor: 'anchor:roof' }` is carried as the
654
+ car lifts, drives or is squashed, the way a bar carries it on a chart. The Kick
655
+ the Tyre card does both.
656
+
594
657
  A prop stands on its middle, and seen from a little above its front comes
595
658
  forward of that line. A figure that walks on the prop's own `y` is inside
596
659
  its footprint and seems to walk through the wall; walk it on the prop's
@@ -695,5 +758,5 @@ timeline plays: editor previews, players, embeds and exports.
695
758
  ## Not yet
696
759
 
697
760
  - A code panel in the editor (a Code element whose lines and words snap beats)
698
- - Beat scripts for v2 characters (`scriptTracks` drives the stick figure)
699
- - Follow-through on hair, tails and ears (character-system milestones 3 and 5)
761
+ - Beat scripts' hands reaching in the v2 character's own proportions (a `grab`
762
+ lands near its target, not on it)
@@ -1,7 +1,7 @@
1
1
  # Character Appearance
2
2
 
3
- Hair, facial hair, glasses, hats, ears, builds, a ready-made cast, held items
4
- and meeting hands for the v2 character (`character()` in `@algorisys/tinyfly/characters`). Every choice
3
+ Hair, facial hair, glasses, hats, ears, builds, a ready-made cast, held items,
4
+ meeting hands and hair that swings for the v2 character (`character()` in `@algorisys/tinyfly/characters`). Every choice
5
5
  is plain data, so a character can be saved, synced, generated by a language
6
6
  model and changed one field at a time.
7
7
 
@@ -117,6 +117,52 @@ Every style is the same few fields (`resolveHair(spec)` fills them all in):
117
117
 
118
118
  A style stays a starting point: any style suits anyone.
119
119
 
120
+ ## Hair in motion
121
+
122
+ Hair that hangs (long hair, ponytails, braids) lags behind the head: it swings
123
+ round after a turn, streams back on a run, drops on a jump and lifts on the
124
+ landing. The roots stay on the head; the ends move, more the further they hang.
125
+ Short hair, buns, beards and hats stay put.
126
+
127
+ The lag is three pose fields, so it keys, saves and mirrors like any other:
128
+
129
+ | Field | Meaning |
130
+ |---|---|
131
+ | `hair.swing` | Swung round the head toward the character's left (+) or right (βˆ’), degrees |
132
+ | `hair.trail` | Streaming back behind the head (+) or thrown forward (βˆ’), head radii |
133
+ | `hair.lift` | Lifted (+) or dropped (βˆ’), head radii |
134
+
135
+ You rarely set them by hand. `hairFollowTracks` works them out from the
136
+ character's own tracks (the target's `x` and `y`, the pose's `turn` and
137
+ `head.turn`), each on a spring that chases the head, the way a prop's `follow`
138
+ trails a car's antenna or a dog's tail:
139
+
140
+ ```js
141
+ const tracks = characterPoseTracks('maya', keys)
142
+ tracks.push(...hairFollowTracks('maya', tracks, maya))
143
+ // Nothing is added for hair with nothing to swing. A `hair.swing` track written
144
+ // by hand (a flick) keeps its values, with the lag added on.
145
+ ```
146
+
147
+ Code that poses a character every frame keys the lag once for its loop, then
148
+ reads it at each frame's time:
149
+
150
+ ```js
151
+ const lag = hairFollow((t) => ({ x: xAt(t), y: yAt(t), turn: turnAt(t) }), { end: 8000, headRadius: 24 })
152
+ drawCharacter(ctx, maya, humanPose({ turn: turnAt(t), ...hairMotionAt(lag, t) }), t)
153
+ ```
154
+
155
+ `hairFollow` options: `stiffness` (default 70, higher follows the head more
156
+ tightly), `damping` (6, lower swings longer), `amount` (1; 0 pins the hair) and
157
+ `step` (33 ms between keys). `hairFollowTracks` also takes `settle`, how long
158
+ the hair keeps moving after the last key (1500 ms). The springs step in fixed
159
+ 1 ms steps, so the same motion always gives the same keys, and the drawing
160
+ itself keeps no state between frames.
161
+
162
+ Four-legged animals get the same treatment for free: their `ears` control
163
+ (pricked forward +, laid back βˆ’) and `tail` both trail the animal's motion on a
164
+ spring in every `propScript`.
165
+
120
166
  ## Facial hair
121
167
 
122
168
  `facialHair` takes a style name or `{ moustache, beard, color }` (the colour
@@ -278,4 +324,6 @@ exported to video and GIF.
278
324
 
279
325
  Outlines are traced from the same numbers every time (no randomness, no state
280
326
  between frames), so a frame at a given time always draws the same, and the
281
- pencil look's boil stays seeded as before.
327
+ pencil look's boil stays seeded as before. Hair in motion keeps to this: the
328
+ lag is keyed ahead of time from the motion (`hairFollow`), not accumulated
329
+ while drawing.
@@ -43,7 +43,9 @@ left to right:
43
43
  is a reassuring, tap-friendly manual save (handy on tablets).
44
44
  - **New** β€” start a fresh project (prompts if you have unsaved changes).
45
45
  - **AI** β€” show or hide the AI prompt bar, where you describe an animation and
46
- click **Generate**.
46
+ click **Generate**. A brief with a story in it ("grandma walks up to a ticking
47
+ box, jumps, and runs off") gets a 🧍 Character from the cast with a beat
48
+ script, compiled into its tracks on load (the beats stay on the element).
47
49
  - **My Animations** β€” open the gallery of every project you've saved (thumbnails,
48
50
  open / duplicate / delete). See [Project Management](#project-management).
49
51
  - **Examples** β€” every ready-made animation on one page (`/examples`). Open one in
@@ -78,6 +80,8 @@ Shapes, text, images, video, lines, arrows and paths are added from the
78
80
  | **Group** | Container that groups multiple elements |
79
81
  | **🧍 Character** | A posable figure: pick a view, a pose and a face, and keyframe them to animate (see [Characters](#characters)) |
80
82
  | **πŸ—Ί Map** | An animated map: places, a route between them, and a camera (see [Maps](#maps)) |
83
+ | **🧊 3D Scene** | A real 3D scene seen through its camera: meshes, lights, characters and props (see [3D Scenes](#3d-scenes)) |
84
+ | **⌨ Code** | A code panel whose lines a Character's beats aim at and change (see [Code](#code)) |
81
85
 
82
86
  Polygon and star are **parametric** paths: change the sides/points/inner ratio in
83
87
  the Property Panel and the shape regenerates, and they rescale cleanly when you
@@ -213,12 +217,39 @@ Dances and flips are written as they are, and turn acting off.
213
217
  (`drawingRate` in the JSON), so previews, players and exports all hold the
214
218
  same way.
215
219
 
220
+ - **Beats**: a story written as beats, compiled in the chosen style into the
221
+ character's tracks and kept on the element (`beats` in the JSON). Write them
222
+ as JSON (`[{ "do": "walk", "to": 320, "mood": "happy" }, { "do": "say",
223
+ "say": "Hello!" }, { "do": "take" }]`) and click **🎬 Run beats**; the
224
+ timeline grows to fit. A beat can aim at a **⌨ Code** element's lines
225
+ (`"target": { "surface": "Code 1", "anchor": "line:2" }`, also for `to`,
226
+ `toward` and `onto`) and change them (`"then": { "surface": "Code 1",
227
+ "edit": "highlight", "anchor": "line:2", "at": "contact" }`): the edits
228
+ become tracks on that element. Problems are named by beat (an unknown
229
+ action, mood or place) before anything is written. The AI prompt bar writes
230
+ beats this way too.
231
+
216
232
  See [Cartoon Acting](acting.md).
217
233
 
218
234
  Characters show in the DOM and Canvas previews and in GIF / WebP / MP4
219
235
  export. They are not part of exported HTML or embeds yet, and the SVG preview
220
236
  does not draw them.
221
237
 
238
+ ### Code
239
+
240
+ A **⌨ Code** element is a code panel (`codePanel()` from code): a listing with
241
+ line numbers, drawn by code into its box, which grows to fit its lines. In the
242
+ property panel: the **Language** (JavaScript, TypeScript, Python, Go, Rust,
243
+ C#, plain), **Font size**, **Line numbers**, **Hidden lines** (typed in later)
244
+ and the **Listing** itself.
245
+
246
+ Its lines are places. A Character's **Beats** aim at them and change them
247
+ (highlight, strike, remove, type, fling a token…), and those edits are tracks
248
+ on the Code element named `line.N.highlight`, `line.N.strike`, `line.N.wipe`,
249
+ `line.N.reveal` and so on, which you can also key by hand. Code panels show in
250
+ the DOM and Canvas previews and in GIF / WebP / MP4 export. See [Acting on
251
+ code](acting.md#acting-on-code) for the same from code.
252
+
222
253
  ### Maps
223
254
 
224
255
  A **πŸ—Ί Map** fills the canvas with a map of the world. In the property panel:
@@ -253,8 +284,8 @@ camera: it starts with a camera at three-quarters, a key light, a floor and a
253
284
  red box. In the property panel:
254
285
 
255
286
  - **Objects**: pick one to edit. **Add** puts a box, sphere, cylinder, cone,
256
- ring, star (an extruded path), character or light on the next free spot;
257
- βœ• removes the picked one (not the scene's camera).
287
+ ring, star (an extruded path), character, prop or light on the next free
288
+ spot; βœ• removes the picked one (not the scene's camera).
258
289
  - **Transform**: X, Y, Z (metres, +y up), Tilt X, Turn Y, Roll Z and Scale.
259
290
  **β—† Key transform at playhead** keys all of them; once a value is animated
260
291
  (β—† by its name), changing it keys it at the playhead.
@@ -263,6 +294,12 @@ red box. In the property panel:
263
294
  - **Characters**: a look (*Clean*, *Pencil*, *Silhouette* drawn by their pens
264
295
  in perspective, or *Solid*) and **πŸ•Ί Dance from playhead** with any dance
265
296
  style.
297
+ - **Props**: which prop from the catalog (car, truck, bus, tractor, cart, train
298
+ car, bike, motorbike, tree, house, helicopter, airplane, horse, dog, cat, cow,
299
+ songbird, crow, chicken), its look (*Clean*, *Pencil*, *Silhouette*, or
300
+ *Mesh*, lit with the scene) and style (*Solid* or *Stick* line art). Its
301
+ controls (`car.door`, `car.wheelSpin`, `dog.tail`…) are tracks on the
302
+ element.
266
303
  - **Cameras**: field of view, **Look through this camera**, and **βœ‚ Cut to
267
304
  this camera at playhead**, which keys the shot change.
268
305
  - **Camera** view presets (*Front*, *ΒΎ*, *Side*, *Top*) and the scene's
@@ -1066,7 +1103,7 @@ The dialog shows the generated HTML/JavaScript code with a **Copy Code** button.
1066
1103
  **Steps to embed:**
1067
1104
  1. Build the player: `npm run build:player`
1068
1105
  2. Copy `lib/player/tinyfly-player.iife.js` to your project (or load
1069
- `https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-player.iife.js`
1106
+ `https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-player.iife.js`
1070
1107
  instead; see [Deployment](DEPLOYMENT.md))
1071
1108
  3. Copy the generated code into your HTML
1072
1109
  4. Adjust the script `src` path if needed
package/docs/examples.md CHANGED
@@ -694,7 +694,7 @@ For simple website embedding without a build system.
694
694
  </html>
695
695
  ```
696
696
 
697
- Build the player with `npm run build:player` to generate `lib/player/tinyfly-player.iife.js`, or load it from the CDN: `https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-player.iife.js`.
697
+ Build the player with `npm run build:player` to generate `lib/player/tinyfly-player.iife.js`, or load it from the CDN: `https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-player.iife.js`.
698
698
 
699
699
  ---
700
700
 
@@ -185,7 +185,7 @@ with a GSAP-style call (durations are in seconds here):
185
185
  ```html
186
186
  <div class="box" style="width:60px;height:60px;background:#4a9eff"></div>
187
187
 
188
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly.iife.js"></script>
188
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly.iife.js"></script>
189
189
  <script>
190
190
  tinyfly.to('.box', { x: 200, duration: 1 })
191
191
  </script>
@@ -74,7 +74,7 @@ Without a build step, the all-in-one bundle exposes the same functions on a
74
74
  global β€” `tinyfly.to()`, `tinyfly.timeline()` and so on:
75
75
 
76
76
  ```html
77
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly.iife.js"></script>
77
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly.iife.js"></script>
78
78
  <script>
79
79
  tinyfly.to('.box', { x: 200, duration: 1 })
80
80
  </script>
package/docs/llm-guide.md CHANGED
@@ -54,7 +54,10 @@ and `outfit: { shirt, trousers }`. `castMember('grandpa', 300)` gives a whole
54
54
  ready-made character to start from. Expressions come from `HUMAN_EXPRESSIONS`
55
55
  and are pose fields, as are the face marks `blush`, `tears` and `sweat` (0–1),
56
56
  so any face goes with any action or view. Hair and hats turn with the head:
57
- don't draw a different hairstyle per view. Put things in hands with `holding`
57
+ don't draw a different hairstyle per view. Hanging hair swings on its own:
58
+ after the character's tracks add `hairFollowTracks(target, tracks, who)` (or,
59
+ posing per frame, `hairFollow` once and `hairMotionAt(keys, t)` each frame)
60
+ rather than keying `hair.swing` by hand. Put things in hands with `holding`
58
61
  (`{ right: 'mug' }`, `{ both: 'parcel' }`; the pose field `held.both` lets go),
59
62
  and for two characters touching use `meetHands('handshake', a, b)` with the
60
63
  two standing `meetingSpacing(…)` apart, never two separate clips. See
@@ -110,7 +113,11 @@ scriptTracks: 2 problem(s) in the beats:
110
113
 
111
114
  - **Beat scripts**: `scriptTracks()` throws on errors. `checkBeats(beats)`
112
115
  returns errors and warnings without throwing, and from the command line:
113
- `npx @algorisys/tinyfly check beats.json`.
116
+ `npx @algorisys/tinyfly check beats.json`. For a v2 `character()` use
117
+ `characterScript(target, who, beats, options)`: the same beats and checks,
118
+ compiled for the human body and a `characterTarget` (its `walk`, `walking`
119
+ and `gait` tracks step the gait as it draws); add
120
+ `hairFollowTracks(target, tracks, who)` after it.
114
121
  - **Tracks**: `checkTracks(tracks, targets)` finds tracks aimed at targets
115
122
  that aren't there, properties a target can't animate (`rotation` β†’ `rotate`),
116
123
  keys out of time order, values of the wrong kind and values out of range.
package/docs/maps.md CHANGED
@@ -14,8 +14,8 @@ On a page with no build step, load the maps add-on after the browser bundle; it
14
14
  adds to the same `tinyfly` global:
15
15
 
16
16
  ```html
17
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly.iife.js"></script>
18
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-maps.iife.js"></script>
17
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly.iife.js"></script>
18
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-maps.iife.js"></script>
19
19
  ```
20
20
 
21
21
  It is a separate script because the offline world map it carries adds about
package/docs/scene-3d.md CHANGED
@@ -271,7 +271,9 @@ a cart's `seat`) as the prop moves, turns, bobs with its stride and pitches,
271
271
  writing the rider's `x`, `y`, `z` and `rotateY`; `mount: { from: [x, z] }` and
272
272
  `dismount: { to: [x, z] }` hop it on and off. `spliceTracks(riderTracks, ride, { from, to })`
273
273
  puts the ride into the rider's script, which holds the riding pose
274
- (`RIDING_POSES.astride` or `.seated`) meanwhile and `place`s it where it got
274
+ (`RIDING_POSES.astride`, `.seated`, `.driving` with the hands on a wheel, or
275
+ `.cycling`; `pedallingKeys({ start, end, cadence })` keys the legs round the
276
+ pedals on the cycling pose) meanwhile and `place`s it where it got
275
277
  off. A character in a scene is drawn part by part, each part at its own depth
276
278
  (`characterPartsInView`), so a leg astride a horse shows on each side of it.
277
279
  A seat inside a closed cabin (a car's) is not handled yet: its glass is opaque
package/docs/teaching.md CHANGED
@@ -25,7 +25,7 @@ path for all of that:
25
25
  </figure>
26
26
 
27
27
  <!-- once, anywhere on the page (a site-wide footer is fine) -->
28
- <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.98.0/cdn/tinyfly-embed.iife.js" data-tinyfly-auto></script>
28
+ <script src="https://cdn.jsdelivr.net/gh/algorisys-oss/tinyfly@v0.99.0/cdn/tinyfly-embed.iife.js" data-tinyfly-auto></script>
29
29
  ```
30
30
 
31
31
  Every `[data-tinyfly-embed]` mounts when the page is ready, with no per-post