@fabi-play/engine 0.2.0 → 0.5.0

package/dist/index.d.ts

@@ -56,7 +56,9 @@ export type Backdrop = "video" | "none";
  * image is cropped to fill the screen), with any backdrop, so avatars and hands are where the children stand (a
  * "virtual mirror"). The screen decides it: with 'video', where the video is drawn (cover or contain); with 'none',
  * the whole image contained at 92% of the viewport's height, bottom-aligned. Games don't compute it: they just use
- * it. Body points are in player space (0–1 of the camera image, already mirrored like the video), so a point p is on
+ * it. It is not fixed: with automatic framing (the default, see GameManifest.framing) the screen zooms in on children
+ * standing far away, up to 1.8×, so the image may reach past every edge; it changes only at calibration and in breaks
+ * (pause, level, turn), never during play, and arrives in a backdrop message. Body points are in player space (0–1 of the camera image, already mirrored like the video), so a point p is on
  * screen at (x + p.x·w, y + p.y·h): see toScreen.
  */
 export interface BackdropView {
@@ -1874,21 +1876,21 @@ export interface Palette {
 	hair?: string;
 }
 /** The head's outline. */
-export type HeadShape = "round" | "wide" | "tall" | "square" | "bulb" | "bucket";
+export type HeadShape = "round" | "wide" | "tall" | "square" | "bulb" | "bucket" | "snout-long";
 /** The ears (or what is in their place: horns, antennae, a fin). */
-export type EarKind = "none" | "pointy" | "round" | "big-round" | "long" | "side" | "tufts" | "antenna" | "antennae" | "horns" | "unicorn" | "floppy" | "droopy" | "fin" | "human";
+export type EarKind = "none" | "pointy" | "round" | "big-round" | "long" | "side" | "tufts" | "antenna" | "antennae" | "horns" | "unicorn" | "floppy" | "droopy" | "fin" | "human" | "pixie";
 /** How the eyes are drawn. */
 export type EyeKind = "dot" | "big" | "mask" | "screen" | "almond" | "visor" | "calm" | "slit" | "goggle" | "bead";
 /** How the mouth (or beak) is drawn. */
-export type MouthKind = "none" | "smile" | "open" | "cat" | "beak" | "teeth" | "grill" | "tiny" | "smirk" | "bill" | "hook" | "jaws";
+export type MouthKind = "none" | "smile" | "open" | "cat" | "beak" | "teeth" | "grill" | "tiny" | "smirk" | "bill" | "hook" | "jaws" | "toothy";
 /** The patch around the nose and mouth. */
 export type MuzzleKind = "none" | "oval" | "heart" | "monkey" | "disc" | "cheeks" | "band";
 /** The tail, behind the body. */
-export type TailKind = "none" | "fluffy" | "brush" | "pom" | "long" | "curl" | "tuft" | "striped" | "spiky" | "arrow" | "fish" | "plume";
+export type TailKind = "none" | "fluffy" | "brush" | "pom" | "long" | "curl" | "tuft" | "striped" | "spiky" | "arrow" | "fish" | "plume" | "thick";
 /** Things on the head. */
-export type HeadExtra = "mane" | "rainbow-mane" | "stripes" | "spikes" | "spots" | "curl" | "helmet" | "bolts" | "whiskers" | "tuft" | "brows" | "eggshell" | "wool" | "eye-spot" | "crest" | "forehead" | "gills" | "ruff" | "hair" | "curls" | "locks" | "ninja-hood" | "cap" | "safari-hat" | "wizard-hat" | "plume" | "stripe" | "bandana" | "eye-patch" | "dive-mask" | "domino";
+export type HeadExtra = "mane" | "rainbow-mane" | "stripes" | "spikes" | "spots" | "curl" | "helmet" | "bolts" | "whiskers" | "tuft" | "brows" | "eggshell" | "wool" | "eye-spot" | "crest" | "forehead" | "gills" | "ruff" | "hair" | "curls" | "locks" | "ninja-hood" | "cap" | "safari-hat" | "wizard-hat" | "plume" | "stripe" | "bandana" | "eye-patch" | "dive-mask" | "domino" | "bun" | "flower-crown";
 /** Things on the body. */
-export type BodyExtra = "wings" | "backpack" | "sheet" | "tentacles" | "panel" | "badge" | "joints" | "feathers" | "flippers" | "boots" | "scarf" | "spots" | "wool" | "robe" | "cape" | "fins" | "tank" | "straps" | "belt" | "stripes" | "pauldrons" | "emblem" | "pocket" | "racing-stripe" | "star";
+export type BodyExtra = "wings" | "backpack" | "sheet" | "tentacles" | "panel" | "badge" | "joints" | "feathers" | "flippers" | "boots" | "scarf" | "spots" | "wool" | "robe" | "cape" | "fins" | "tank" | "straps" | "belt" | "stripes" | "pauldrons" | "emblem" | "pocket" | "racing-stripe" | "star" | "tiny-arms" | "strong-legs" | "wings-fairy" | "wand" | "petals";
 /** An avatar's face. */
 export interface FaceDef {
 	/** How the eyes are drawn. */
@@ -1910,7 +1912,7 @@ export interface FaceDef {
 	/** Eyebrows of this colour (people): a little attitude. */
 	brows?: string;
 }
-/** The age band an avatar is for, or 'all': offered in every band (Fabi the fox, the app's mascot). */
+/** The age band an avatar is for, or 'all': of no band (Fabi the fox, the app's mascot: the host, in no picker). */
 export type AvatarBand = AgeRange | "all";
 /** An avatar, as data: one renderer draws any definition. */
 export interface AvatarDef {
@@ -1922,11 +1924,17 @@ export interface AvatarDef {
 		it: string;
 	};
 	/**
-	 * The age band the avatar is for: its style and its body proportions (see BAND_BODY in rig.ts). 'all': in every
-	 * band's list, drawn with the 6–8 proportions.
+	 * The age band the avatar is for, its home: its style and its body proportions (see BAND_BODY in rig.ts). 'all': in
+	 * no band's list (the mascot), drawn with the 6–8 proportions. See alsoIn for an avatar offered in other bands too.
 	 */
 	band: AvatarBand;
-	/** A special avatar (the mascot): first in every band's list; pickers may mark it. */
+	/**
+	 * Other age bands the avatar is also offered in (listed in their AVATAR_BANDS too), besides its own band. Shown in
+	 * one of them, it is drawn with that band's proportions (bodyBand(def, band)); its band stays its home: its style
+	 * (outline), bandOf, and its proportions when the band shown is not known. Not for 'all' (the mascot).
+	 */
+	alsoIn?: readonly AgeRange[];
+	/** A special avatar (the mascot): the host, not a player; in no band's list (AVATAR_BANDS). */
 	special?: boolean;
 	/** Its colours. */
 	palette: Palette;

package/dist/index.development.js

@@ -28,6 +28,7 @@ var DEFAULT_AVATARS_BY_AGE = {
 };
 var DEFAULT_AVATARS = DEFAULT_AVATARS_BY_AGE["6-8"];
 var toScreen = (view, p) => view ? { x: view.x + p.x * view.w, y: view.y + p.y * view.h } : { x: p.x, y: p.y };
+var COVER_ASPECT = 16 / 9;
 var POSE_HEADER = 12;
 var POSE_BODY_BYTES = LANDMARKS * 4;
 var poseBytes = (bodies) => POSE_HEADER + bodies * POSE_BODY_BYTES;
@@ -5176,6 +5177,10 @@ async function createEngine(opts = {}) {
     };
     unlisten.push(
       play.on("start", (m) => lateHint(m?.device)),
+      // The simple API knows muted only from the start (its getter is false before): read it again then.
+      play.on("start", (m) => {
+        if (typeof m?.muted === "boolean") sound.muted = m.muted;
+      }),
       play.on("frame", (m) => setPlayers(m?.players)),
       play.on("players", (m) => setPlayers(m?.players)),
       play.on("backdrop", (m) => setBackdrop(m?.backdrop, m?.view)),