mesh-avatar 0.1.0 → 0.2.0

package/README.md

@@ -10,6 +10,13 @@ npm install mesh-avatar
 
 The package is ESM and includes TypeScript declarations. Rendering requires a browser with WebGL. It has no React dependency; the animation loop starts automatically after loading.
 
+## Get a `.mavatar` file
+
+Open your project in Mesh Avatar Studio and choose **Export .mavatar** in the editor header.
+The file holds the rig, the built layers, any drawn eye and mouth variants and a manifest,
+so it is all the runtime needs. You can also pack a project folder from the command line
+with `npm run pack-avatar -- projects/<name>` in the Studio repository.
+
 ## Load an avatar
 
 Place an exported `.mavatar` file in your app's public assets and provide a canvas:

package/dist/engine/sprites.d.ts

@@ -5,12 +5,16 @@ export function createSpriteModule(engine: ReturnType<typeof import("./rig.js").
         /**
          * Show / hide and deform the sprites for this frame.
          * Returns which eyes are covered by a sprite, so the layered eye parts can be hidden.
+         * `mood` (angry / sad / surprise) picks drawn expression eyes (sad, surprise) and closed
+         * mouths (angry, sad) when the avatar has them.
          */
-        update(P: any, phys: any, dt?: number): {
+        update(P: any, phys: any, dt?: number, mood?: null): {
             eyes: boolean[];
             mouth: any;
         };
     };
     mouthShape: (open: any, form: any, prev?: null) => any;
-    eyeSprite: (open: any, smile: any) => "eyes_smile" | "eyes_closed" | "eyes_half" | null;
+    eyeSprite: (open: any, smile: any, mood?: null) => "eyes_smile" | "eyes_closed" | "eyes_half" | null;
 };
+/** The drawn-eye / mouth mood for the live expression, else for the motion expression (if it is applied). */
+export function eyeMood(overlay: any, expression: any): any;