@algorisys/tinyfly 0.97.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 +10 -10
- package/docs/acting.md +76 -13
- package/docs/character-appearance.md +329 -0
- package/docs/editor-guide.md +54 -9
- package/docs/examples.md +1 -1
- package/docs/getting-started.md +1 -1
- package/docs/gsap-compat.md +1 -1
- package/docs/llm-guide.md +29 -2
- package/docs/maps.md +2 -2
- package/docs/props.md +8 -6
- package/docs/scene-3d.md +3 -1
- package/docs/teaching.md +1 -1
- package/lib/addons/characters.js +5911 -4230
- package/lib/browser/tinyfly.iife.js +14 -14
- package/lib/browser/tinyfly.js +8545 -6864
- package/lib/browser/tinyfly.umd.js +14 -14
- package/lib/types/characters/acting/character-script.d.ts +44 -0
- package/lib/types/characters/acting/index.d.ts +1 -0
- package/lib/types/characters/capabilities.d.ts +15 -0
- package/lib/types/characters/cast.d.ts +284 -0
- package/lib/types/characters/character.d.ts +35 -5
- package/lib/types/characters/chart.d.ts +52 -14
- package/lib/types/characters/hair-follow.d.ts +76 -0
- package/lib/types/characters/hands/held-items.d.ts +88 -0
- package/lib/types/characters/hands/index.d.ts +1 -0
- package/lib/types/characters/head/ears.d.ts +10 -0
- package/lib/types/characters/head/facial-hair.d.ts +118 -0
- package/lib/types/characters/head/glasses.d.ts +24 -0
- package/lib/types/characters/head/hair.d.ts +586 -0
- package/lib/types/characters/head/hats.d.ts +58 -0
- package/lib/types/characters/head/head-look.d.ts +56 -0
- package/lib/types/characters/head/index.d.ts +5 -0
- package/lib/types/characters/head/shell.d.ts +64 -0
- package/lib/types/characters/index.d.ts +5 -1
- package/lib/types/characters/interactions.d.ts +69 -0
- package/lib/types/characters/props/draw.d.ts +9 -0
- package/lib/types/characters/props/families/animals.d.ts +6 -0
- package/lib/types/characters/props/prop-surface.d.ts +14 -3
- package/lib/types/characters/props/ride-3d.d.ts +31 -2
- package/lib/types/characters/props/target.d.ts +5 -1
- package/lib/types/characters/species/human-motion.d.ts +5 -2
- package/lib/types/characters/species/human.d.ts +113 -4
- package/lib/types/characters/wardrobe/basic-outfit.d.ts +19 -5
- package/lib/types/characters/whiteboard.d.ts +13 -1
- package/llms-full.txt +549 -56
- package/llms.txt +29 -28
- package/package.json +1 -1
- package/skills/tinyfly/SKILL.md +18 -4
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
|
|
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
|
|
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
|
|
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
|
|
@@ -153,7 +153,7 @@ A lightweight, API-driven animation engine and visual editor for creating high-p
|
|
|
153
153
|
- [Deployment](docs/DEPLOYMENT.md) — Hosting, Docker, and CDN configuration
|
|
154
154
|
- [2D Animation Roadmap](docs/2d-animation-roadmap.md) — Adobe Animate gap analysis and phased plan (symbols/library, camera, onion skinning, …)
|
|
155
155
|
|
|
156
|
-
**Feature guides:** [Symbols & Library](docs/symbols-and-library.md) · [Camera](docs/camera.md) · [Polygon & Star](docs/polygon-star.md) · [Pen tool](docs/pen-tool.md) · [Shape morph](docs/shape-morph.md) · [Grid & snapping](docs/grid-and-snapping.md) · [Onion skinning](docs/onion-skinning.md) · [Sprite-sheet export](docs/sprite-sheet-export.md)
|
|
156
|
+
**Feature guides:** [Character appearance](docs/character-appearance.md) · [Symbols & Library](docs/symbols-and-library.md) · [Camera](docs/camera.md) · [Polygon & Star](docs/polygon-star.md) · [Pen tool](docs/pen-tool.md) · [Shape morph](docs/shape-morph.md) · [Grid & snapping](docs/grid-and-snapping.md) · [Onion skinning](docs/onion-skinning.md) · [Sprite-sheet export](docs/sprite-sheet-export.md)
|
|
157
157
|
|
|
158
158
|
**Docs for LLMs:** the repo root has [`llms.txt`](llms.txt), an [llmstxt.org](https://llmstxt.org) index of these docs, and [`llms-full.txt`](llms-full.txt): every doc, the course, and the capability catalog in one file. Both ship in the npm package with the docs and an agent skill (`skills/tinyfly/SKILL.md`), so an assistant finds them in `node_modules` at the installed version. `npx @algorisys/tinyfly capabilities` prints the catalog: every pose, expression, gag, gait, beat action, canvas property and code-panel edit, read from the library, so a name in it is accepted and a name not in it is rejected with the name probably meant (`tinyfly check beats.json`, `checkTracks`). The built editor also serves `/llms.txt`, `/llms-full.txt` and each page as raw markdown at `/docs/<page>.md`.
|
|
159
159
|
|
|
@@ -189,7 +189,7 @@ for what you import:
|
|
|
189
189
|
| `@algorisys/tinyfly/teach` | `lesson()` step builder and diagram primitives (cells, pointer, stack, queue, table, pipeline) | Anywhere |
|
|
190
190
|
| `@algorisys/tinyfly/react`, `@algorisys/tinyfly/vue`, `@algorisys/tinyfly/svelte`, `@algorisys/tinyfly/solid` | `useTinyfly` hooks, a Svelte action and a Solid primitive: `live` animations scoped to a component and reverted on unmount | Browser (frameworks are optional peer dependencies) |
|
|
191
191
|
| `@algorisys/tinyfly/maps` | Animated maps: OpenStreetMap tiles or an offline world outline, places, routes that draw on, a camera that flies (`mapTarget`, `mapFlyTracks`, `fitView`, `WORLD_CITIES`) | Anywhere with a Canvas 2D context (tiles need a network) |
|
|
192
|
-
| `@algorisys/tinyfly/characters` | Poseable stick figure: `stickFigureTarget`, `poseTracks`, `POSES`, `blendPose`, `walkPose`, `drawStickFigure`; `stickFigureJoints` and `layers` for costumes, hair and props; `turn`, `sit` and ground contact; an organic look by default (`classic` keeps the old one); **characters v2**: `character()` / `characterTarget()`, turnarounds front to back, contact, reaching, clean / pencil / silhouette looks | Anywhere with a Canvas 2D context |
|
|
192
|
+
| `@algorisys/tinyfly/characters` | Poseable stick figure: `stickFigureTarget`, `poseTracks`, `POSES`, `blendPose`, `walkPose`, `drawStickFigure`; `stickFigureJoints` and `layers` for costumes, hair and props; `turn`, `sit` and ground contact; an organic look by default (`classic` keeps the old one); **characters v2**: `character()` / `characterTarget()`, turnarounds front to back, contact, reaching, clean / pencil / silhouette looks; `hair`, `facialHair`, `glasses`, `hat`, `ears`, `build`, `outfit` as data, `castMember()`, `HUMAN_EXPRESSIONS` with face marks | Anywhere with a Canvas 2D context |
|
|
193
193
|
| `@algorisys/tinyfly/headless` | `renderVideo`, `renderStills`, `FrameRenderer`: render a scene to MP4 or PNGs (see [Rendering Video from Code](docs/video-rendering.md)) | Node (`@napi-rs/canvas` optional peer, ffmpeg) |
|
|
194
194
|
| `@algorisys/tinyfly/browser` | One script-tag bundle (`tinyfly.iife.js`): the engine, player, drivers, interaction, the GSAP-style `live` / `tf` facades, teaching-embed controls and mounting, and the `characters` stick figure. Not included: `export`, `adapters`, `teach`, the framework hooks, `headless` | Browser |
|
|
195
195
|
|
|
@@ -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.
|
|
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.
|
|
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.
|
|
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.
|
|
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
|
|
541
|
-
values are declared as data
|
|
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)
|
|
563
|
-
`label:ID`, `value:ID` and `box`, and they
|
|
564
|
-
`sales.anchor('bar:q4', time)` is the bar as it stands
|
|
565
|
-
`set` (a new `value`; the value label counts along
|
|
566
|
-
`hidden` bar in from the axis,
|
|
567
|
-
|
|
568
|
-
|
|
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
|
|
699
|
-
|
|
761
|
+
- Beat scripts' hands reaching in the v2 character's own proportions (a `grab`
|
|
762
|
+
lands near its target, not on it)
|
|
@@ -0,0 +1,329 @@
|
|
|
1
|
+
# Character Appearance
|
|
2
|
+
|
|
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
|
+
is plain data, so a character can be saved, synced, generated by a language
|
|
6
|
+
model and changed one field at a time.
|
|
7
|
+
|
|
8
|
+

|
|
9
|
+
|
|
10
|
+
The sheet is drawn by `examples/headless-video/appearance-sheet.mjs`
|
|
11
|
+
(`npx tinyfly video examples/headless-video/appearance-sheet.mjs --stills stills/`).
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
import { character, characterTarget, drawCharacter, humanPose, castMember, HUMAN_EXPRESSIONS } from '@algorisys/tinyfly/characters'
|
|
17
|
+
|
|
18
|
+
// Pick everything by name…
|
|
19
|
+
const maya = character({
|
|
20
|
+
height: 300,
|
|
21
|
+
build: 'slim',
|
|
22
|
+
hair: { style: 'highPonytail', color: '#9a4426' },
|
|
23
|
+
glasses: 'round',
|
|
24
|
+
ears: true,
|
|
25
|
+
outfit: { shirt: '#f0b43c', trousers: '#36507a' },
|
|
26
|
+
})
|
|
27
|
+
|
|
28
|
+
// …or start from the cast and change what you like.
|
|
29
|
+
const grandpa = character(castMember('grandpa', 300, { look: 'pencil' }))
|
|
30
|
+
|
|
31
|
+
// Faces are pose fields, so any expression goes with any action and view.
|
|
32
|
+
drawCharacter(ctx, maya, humanPose({ ...HUMAN_EXPRESSIONS.embarrassed, turn: 0.5 }))
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
A plain figure (no `hair`, `facialHair`, `glasses`, `hat` or `ears`) draws
|
|
36
|
+
exactly as it did before these options existed.
|
|
37
|
+
|
|
38
|
+
## How it turns
|
|
39
|
+
|
|
40
|
+
Hair, beards and hats are not flat drawings pasted on the face. Each is a
|
|
41
|
+
region on the head's surface (where the hairline runs, how far the hair stands
|
|
42
|
+
off the head, how far it hangs), drawn wherever the head's `turn`, `head.turn`,
|
|
43
|
+
`head.nod` and `head.tilt` put it:
|
|
44
|
+
|
|
45
|
+
- the part facing away is drawn before the body, so long hair hangs behind the
|
|
46
|
+
shoulders seen from the front, and a bob shows beside the face;
|
|
47
|
+
- the part facing the viewer is drawn over the head, so a fringe crosses the
|
|
48
|
+
forehead and, from behind, the hair covers the whole head;
|
|
49
|
+
- turned away (past about `turn` 1.2), the hair is drawn after the whole body,
|
|
50
|
+
over an arm at the side;
|
|
51
|
+
- a parting, a side ponytail or a braid stays on the character's own side
|
|
52
|
+
through a turn: left and right are the character's, never mirrored.
|
|
53
|
+
|
|
54
|
+
Glasses, moustaches and the face marks sit on the face itself, placed like the
|
|
55
|
+
eyes and mouth, so they slide round with the face and hide with it.
|
|
56
|
+
|
|
57
|
+
**Which part wins where two overlap** is fixed: eyes and brows draw over a
|
|
58
|
+
fringe; the mouth draws over a beard, which leaves an opening for it (so every
|
|
59
|
+
lip-sync shape stays readable); a moustache draws over the top of the mouth;
|
|
60
|
+
glasses over the eyes; a hat over the hair. Ears are hidden by hair that
|
|
61
|
+
`coversEars`.
|
|
62
|
+
|
|
63
|
+
## Views
|
|
64
|
+
|
|
65
|
+
`turn` runs 0 → 4. The eight reference views:
|
|
66
|
+
|
|
67
|
+
| View | `turn` |
|
|
68
|
+
|---|---|
|
|
69
|
+
| Front | 0 |
|
|
70
|
+
| Front 3/4 right (nose toward screen right) | 0.5 |
|
|
71
|
+
| Right profile | 1 |
|
|
72
|
+
| Back 3/4 right | 1.5 |
|
|
73
|
+
| Back | 2 |
|
|
74
|
+
| Back 3/4 left | 2.5 |
|
|
75
|
+
| Left profile | 3 |
|
|
76
|
+
| Front 3/4 left | 3.5 |
|
|
77
|
+
|
|
78
|
+
The view names describe the screen; limb and side names (`arm.left`,
|
|
79
|
+
`at: 'left'`) are always the character's own.
|
|
80
|
+
|
|
81
|
+
## Hair
|
|
82
|
+
|
|
83
|
+
`hair` takes a style name, a style with changes, or `null`:
|
|
84
|
+
|
|
85
|
+
```js
|
|
86
|
+
character({ hair: 'bob' })
|
|
87
|
+
character({ hair: { style: 'bob', color: HAIR_COLORS.auburn, length: 1.4 } })
|
|
88
|
+
character({ hair: { volume: 0.2, hairline: { front: 0.3 }, ties: [{ kind: 'bun', at: 'top' }] } })
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Short cuts and hairlines: `bald`, `buzzCut`, `crewCut`, `short`, `sidePart`,
|
|
92
|
+
`sideSwept`, `slickBack`, `quiff`, `spiky`, `undercut`, `curlyCrop`, `afro`,
|
|
93
|
+
`wavyCrop`, `shortLocs`, `flatTop`, `receding`, `thinning`.
|
|
94
|
+
|
|
95
|
+
Medium and long hair: `pixie`, `bob`, `longBob`, `wavyBob`, `shoulderStraight`,
|
|
96
|
+
`shoulderWaves`, `longStraight`, `longWaves`, `longCurls`, `longLocs`,
|
|
97
|
+
`lowPonytail`, `highPonytail`, `ponytail`, `sidePonytail`, `topBun`, `lowBun`,
|
|
98
|
+
`singleBraid`, `twinBraids`, `braids`.
|
|
99
|
+
|
|
100
|
+
Every style is the same few fields (`resolveHair(spec)` fills them all in):
|
|
101
|
+
|
|
102
|
+
| Field | Meaning |
|
|
103
|
+
|---|---|
|
|
104
|
+
| `color` | Fill colour. `HAIR_COLORS` has `black`, `brown`, `chestnut`, `auburn`, `blond`, `ginger`, `gray`, `white` |
|
|
105
|
+
| `volume` | How far the hair stands off the head (head radii) |
|
|
106
|
+
| `hairline` | `{ front, side, back }`: its height at the forehead, temples and nape (head radii, +up from the head's centre) |
|
|
107
|
+
| `sweep` | A side fringe: the hairline drops toward the character's left (+) or right (−) |
|
|
108
|
+
| `recede` | Temples pushed back |
|
|
109
|
+
| `length` | Long hair: where it ends, head radii below the head's centre (`0` short; about 1.75 is the shoulders) |
|
|
110
|
+
| `opening` | Long hair: half the opening left for the face, degrees |
|
|
111
|
+
| `texture`, `textureAmount` | `smooth`, `spiky`, `curly`, `wavy` or `locs`, and how strong |
|
|
112
|
+
| `quiff`, `flat` | Volume swept up over the forehead; a flat top's height |
|
|
113
|
+
| `part`, `strands` | A parting (degrees round from the middle of the face) and the detail lines: `none`, `part`, `sweep`, `combed`, `hanging`, `thin` |
|
|
114
|
+
| `fill` | `solid`, or `stipple` (close-cropped: dots on the scalp) |
|
|
115
|
+
| `ties` | Ponytails, buns and braids: `{ kind: 'ponytail' \| 'bun' \| 'braid', at: 'top' \| 'high' \| 'low' \| 'left' \| 'right', length?, size? }` |
|
|
116
|
+
| `coversEars` | The hair hides the ears |
|
|
117
|
+
|
|
118
|
+
A style stays a starting point: any style suits anyone.
|
|
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
|
+
|
|
166
|
+
## Facial hair
|
|
167
|
+
|
|
168
|
+
`facialHair` takes a style name or `{ moustache, beard, color }` (the colour
|
|
169
|
+
defaults to the hair's):
|
|
170
|
+
|
|
171
|
+
`cleanShaven`, `stubble`, `pencilMoustache`, `shortMoustache`, `chevron`,
|
|
172
|
+
`handlebar`, `walrus`, `goatee`, `vanDyke`, `circleBeard`, `shortBoxed`,
|
|
173
|
+
`fullBeard`, `longBeard`, `roundedBeard`, `pointedBeard`, `chinStrap`,
|
|
174
|
+
`soulPatch`, `sideburns`, `muttonChops`, `moustacheStubble`.
|
|
175
|
+
|
|
176
|
+
Moustaches: `none`, `pencil`, `short`, `chevron`, `handlebar`, `walrus`.
|
|
177
|
+
Beards: `none`, `stubble`, `goatee`, `soulPatch`, `chinStrap`, `circle`,
|
|
178
|
+
`boxed`, `full`, `rounded`, `pointed`, `long`, `sideburns`, `muttonChops`.
|
|
179
|
+
|
|
180
|
+
## Glasses, hats and ears
|
|
181
|
+
|
|
182
|
+
- `glasses`: `round`, `square`, `sunglasses` (drawn in the ink; the near arm
|
|
183
|
+
runs back to the ear in profile).
|
|
184
|
+
- `hat`: `cap`, `beanie`, `hardHat`, `sunHat`, `bowler`, or `{ style, color }`.
|
|
185
|
+
The crown sits over the hair; hair below the brim still shows.
|
|
186
|
+
- `ears: true` adds ears: they stick out past the head from the front and
|
|
187
|
+
behind, and sit on the head with a curl when turned toward the viewer.
|
|
188
|
+
|
|
189
|
+
## Builds
|
|
190
|
+
|
|
191
|
+
`build` sets proportions; `height` sets how tall the character stands. Any
|
|
192
|
+
field can still be set on its own (`headSize`, `shoulderWidth`, `hipWidth`,
|
|
193
|
+
`legLength`, `armLength`).
|
|
194
|
+
|
|
195
|
+
| Build | What changes |
|
|
196
|
+
|---|---|
|
|
197
|
+
| `standard` | Nothing |
|
|
198
|
+
| `slim` | Smaller head, narrower |
|
|
199
|
+
| `tall` | Smaller head, longer legs and arms |
|
|
200
|
+
| `short` | Larger head, shorter legs, a little wider |
|
|
201
|
+
| `broad`, `curvy`, `stocky` | Shoulder and hip widths (stocky: a larger head) |
|
|
202
|
+
| `kid`, `child`, `toddler` | Larger head, shorter limbs |
|
|
203
|
+
|
|
204
|
+
Age, posture and accessories are separate choices: a child build is only
|
|
205
|
+
proportions, and an older character is shown by hair and glasses, never by a
|
|
206
|
+
stoop unless one is posed. The same poses, gaits and actions work on every
|
|
207
|
+
build; `humanGaitStrideLength(gait, height, stride, legLength)` gives a build's
|
|
208
|
+
stride so its feet stay planted.
|
|
209
|
+
|
|
210
|
+
## Clothes
|
|
211
|
+
|
|
212
|
+
`outfit` dresses the character as data (any `layers` are drawn over it):
|
|
213
|
+
|
|
214
|
+
```js
|
|
215
|
+
character({ outfit: { shirt: '#7a8fa6', trousers: '#3b3f46', sleeves: 'long', collar: true, tie: '#2b4f8c' } })
|
|
216
|
+
character({ outfit: { bottom: 'skirt' } })
|
|
217
|
+
character({ outfit: { over: 'labCoat' } })
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
| Field | Choices |
|
|
221
|
+
|---|---|
|
|
222
|
+
| `shirt`, `trousers` | Colours (the trousers' colour also colours shorts and a skirt) |
|
|
223
|
+
| `sleeves` | `short` (default), `long`, `none` |
|
|
224
|
+
| `bottom` | `trousers` (default), `shorts`, `skirt` |
|
|
225
|
+
| `collar` | `true` for a shirt collar |
|
|
226
|
+
| `tie` | A colour, for a tie down the front |
|
|
227
|
+
| `over`, `overColor` | `apron` or `labCoat`, and its colour |
|
|
228
|
+
|
|
229
|
+
The front details (collar, tie, apron, the coat's opening) show from the
|
|
230
|
+
front and turn away with the body; from behind an apron shows its ties.
|
|
231
|
+
`basicOutfit(options)` gives the same clothes as layers.
|
|
232
|
+
|
|
233
|
+
## The cast
|
|
234
|
+
|
|
235
|
+
`castMember(name, height, changes?)` returns character options for a recurring
|
|
236
|
+
cast member at an adult `height` (each stands at their own scale of it). The
|
|
237
|
+
family: `boy`, `girl`, `youngMan`, `youngWoman`, `man`, `woman`, `grandpa`,
|
|
238
|
+
`grandma`; at work (from the occupations sheet): `doctor`, `cook`, `builder`,
|
|
239
|
+
`courier`, `teacher`, `farmer`. `CHARACTER_CAST` has each one's `label`,
|
|
240
|
+
`group` (`family` or `work`), `scale` and `options`.
|
|
241
|
+
|
|
242
|
+
```js
|
|
243
|
+
const family = ['man', 'woman', 'girl', 'grandma'].map((name) => character(castMember(name, 280)))
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## Expressions and face marks
|
|
247
|
+
|
|
248
|
+
`HUMAN_EXPRESSIONS` sets every face field, so applying one replaces the whole
|
|
249
|
+
face, and any two blend. Besides the stick figure's faces (`neutral`, `happy`,
|
|
250
|
+
`joyful`, `sad`, `crying`, `surprised`, `shocked`, `angry`, `furious`,
|
|
251
|
+
`worried`, `scared`, `confused`, `skeptical`, `thinking`, `sleepy`,
|
|
252
|
+
`disgusted`, `smug`, `wink`) there are `laughing`, `afraid`, `bored`, `tired`,
|
|
253
|
+
`embarrassed`, `proud`, `determined`, `affectionate`, `hurt`, `suspicious`,
|
|
254
|
+
`relieved` and `excited`.
|
|
255
|
+
|
|
256
|
+
Three face marks fade in from 0 to 1 and are pose fields like any other (so
|
|
257
|
+
tracks animate them): `blush` (rosy cheeks, with hatch lines past 0.5),
|
|
258
|
+
`tears` (a drop under each eye, running down past 0.6) and `sweat` (a bead at
|
|
259
|
+
the temple).
|
|
260
|
+
|
|
261
|
+
## Everyday actions, held items and meeting hands
|
|
262
|
+
|
|
263
|
+
The motion and everyday-life sheets add poses to `HUMAN_POSES`: `sleep`,
|
|
264
|
+
`stretch`, `sitFloor` (cross-legged), `carry`, `lift`, `push`, `pull`,
|
|
265
|
+
`drink`, `phone`, `read` and `type` (seated, for a desk). Like every pose they
|
|
266
|
+
blend, turn and take any face.
|
|
267
|
+
|
|
268
|
+
**Holding things.** `holding` puts an item in a hand, as data:
|
|
269
|
+
|
|
270
|
+
```js
|
|
271
|
+
character({ holding: { right: 'mug' } }) // drink
|
|
272
|
+
character({ holding: { left: 'bag', right: 'bag' } }) // carry
|
|
273
|
+
character({ holding: { both: { item: 'parcel', color: '#c9a06a' } } })
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
Items: `mug`, `phone`, `briefcase`, `bag`, `umbrella` and `broom` (one hand,
|
|
277
|
+
`left` or `right`), `book` (one hand or `both`) and `parcel` (`both`). Each is
|
|
278
|
+
drawn at the hand's grip, so it follows the hand through any pose, gait or
|
|
279
|
+
turn, and sorts with that arm (a mug goes behind the body with the far arm).
|
|
280
|
+
An umbrella's canopy sits just over the head. `handGrip(joints, side)` gives
|
|
281
|
+
the grip point and the forearm's direction for drawing anything else in a
|
|
282
|
+
hand.
|
|
283
|
+
|
|
284
|
+
Whether an item shows is a pose field, `held.left`, `held.right` or
|
|
285
|
+
`held.both` (1 by default; below 0.5 it has been let go), so a track lets go
|
|
286
|
+
of it at a moment: a parcel handed over is the giver's `held.both` going to 0
|
|
287
|
+
as the taker's goes to 1.
|
|
288
|
+
|
|
289
|
+
**Meeting hands.** `meetHands(kind, a, b, options?)` poses two characters so
|
|
290
|
+
their hands meet at one point, rather than playing two clips and hoping they
|
|
291
|
+
line up: `handshake`, `highFive`, `fistBump` and `handOver` (four hands round
|
|
292
|
+
one parcel). Each partner is `{ character, x, pose? }` on the same ground
|
|
293
|
+
line; the one on the left turns to face right and the other left,
|
|
294
|
+
three-quarters on (`view: 'side'` for profiles). Stand them
|
|
295
|
+
`meetingSpacing(kind, a, b)` apart; the result's `reached` says whether both
|
|
296
|
+
got there.
|
|
297
|
+
|
|
298
|
+
```js
|
|
299
|
+
const gap = meetingSpacing('handOver', courier, neighbour)
|
|
300
|
+
const give = meetHands('handOver', { character: courier, x: 300 }, { character: neighbour, x: 300 + gap })
|
|
301
|
+
// give.a and give.b are poses to key; give.point is where the parcel is.
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
## In the editor
|
|
305
|
+
|
|
306
|
+
Select a 🧍 Character and open **Head** in the properties: **Cast** dresses it
|
|
307
|
+
as a cast member (build, hair, facial hair, glasses and clothes in one step),
|
|
308
|
+
then **Hair**, **Hair colour**, **Facial hair**, **Glasses**, **Hat** and
|
|
309
|
+
**Ears** change one thing at a time; **Right hand**, **Left hand** and **Both
|
|
310
|
+
hands** put an item in them. **Build** lists the builds, with **Legs** and
|
|
311
|
+
**Arms** sliders. The new expressions and everyday poses are in the **Face**
|
|
312
|
+
and **Body** lists. All of it is saved as plain fields on the element and
|
|
313
|
+
exported to video and GIF.
|
|
314
|
+
|
|
315
|
+
## In the gallery
|
|
316
|
+
|
|
317
|
+
- **Cast Turnaround**: the whole cast turning through all eight views together.
|
|
318
|
+
- **Hair, Beards & Hats**: pick a style, colour, facial hair, glasses, hat and
|
|
319
|
+
face, and see the character turning and in all eight views at once.
|
|
320
|
+
- **Hand Over**: a courier walks up and hands a parcel over (`meetHands`,
|
|
321
|
+
`holding`, `held.both`).
|
|
322
|
+
|
|
323
|
+
## Determinism
|
|
324
|
+
|
|
325
|
+
Outlines are traced from the same numbers every time (no randomness, no state
|
|
326
|
+
between frames), so a frame at a given time always draws the same, and the
|
|
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.
|