mesh-avatar 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +7 -0
  2. package/package.json +14 -3
package/README.md CHANGED
@@ -10,6 +10,13 @@ npm install mesh-avatar
10
10
 
11
11
  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.
12
12
 
13
+ ## Get a `.mavatar` file
14
+
15
+ Open your project in Mesh Avatar Studio and choose **Export .mavatar** in the editor header.
16
+ The file holds the rig, the built layers, any drawn eye and mouth variants and a manifest,
17
+ so it is all the runtime needs. You can also pack a project folder from the command line
18
+ with `npm run pack-avatar -- projects/<name>` in the Studio repository.
19
+
13
20
  ## Load an avatar
14
21
 
15
22
  Place an exported `.mavatar` file in your app's public assets and provide a canvas:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mesh-avatar",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "description": "A browser WebGL runtime for 2D mesh avatars, with .mavatar archive and folder loading.",
@@ -10,10 +10,21 @@
10
10
  "directory": "packages/runtime"
11
11
  },
12
12
  "homepage": "https://github.com/shinshin86/mesh-avatar-studio/tree/main/packages/runtime",
13
- "keywords": ["avatar", "2d", "webgl", "animation", "vtuber", "mesh-avatar"],
13
+ "keywords": [
14
+ "avatar",
15
+ "2d",
16
+ "webgl",
17
+ "animation",
18
+ "vtuber",
19
+ "mesh-avatar"
20
+ ],
14
21
  "sideEffects": false,
15
22
  "types": "./dist/index.d.ts",
16
- "files": ["dist", "README.md", "LICENSE"],
23
+ "files": [
24
+ "dist",
25
+ "README.md",
26
+ "LICENSE"
27
+ ],
17
28
  "publishConfig": {
18
29
  "access": "public",
19
30
  "provenance": true