three-mediapipe-rig 0.0.2 → 0.0.3

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
@@ -11,6 +11,28 @@ This will run 3 models: face, body, hands. So expect a FPS drop.
11
11
 
12
12
  LIVE EXAMPLE: https://bandinopla.github.io/three-mediapipe-rig/
13
13
 
14
+ ---
15
+
16
+ ## Table of Contents
17
+
18
+ - [Features](#features)
19
+ - [Installation](#installation)
20
+ - [Quick Start](#quick-start)
21
+ - [Skeleton](#skeleton)
22
+ - [Facial Animation](#facial-animation)
23
+ - [API](#api)
24
+ - [`setupTracker(config?)`](#setuptrackerconfig)
25
+ - [Tracker API](#tracker-api-return-value-of-setuptracker)
26
+ - [Bone Naming](#bone-naming)
27
+ - [Default bone names](#default-bone-names)
28
+ - [Custom bone map example](#custom-bone-map-example)
29
+ - [Multiple Characters](#multiple-characters)
30
+ - [Debugging with Video](#debugging-with-video)
31
+ - [Recording](#recording)
32
+ - [License](#license)
33
+
34
+ ---
35
+
14
36
  ## Features
15
37
 
16
38
  - **Full-body pose tracking** — shoulders, arms, hips, legs, and head
@@ -19,6 +41,7 @@ LIVE EXAMPLE: https://bandinopla.github.io/three-mediapipe-rig/
19
41
  - **Automatic bone binding** — maps MediaPipe landmarks to your rig's skeleton using a configurable bone-name map
20
42
  - **Webcam & video input** — use a live webcam feed or a pre-recorded video for motion capture
21
43
  - **Debug tools** — preview the video/image feed overlaid with landmark visualizations
44
+ - **Recording** — record the motion capture to a file ( .glb )
22
45
 
23
46
  ## Installation
24
47
  ```
@@ -251,6 +274,24 @@ const tracker = await setupTracker({
251
274
  });
252
275
  ```
253
276
 
277
+ ## Recording
278
+ You can record the motion of a rig by doing this. Notice the track names of the clip will use the names of the bones from the currently recorded rig.
279
+
280
+ ```ts
281
+ // Start recording
282
+ yourRigBindHandler.startRecording()
283
+
284
+ // after a while...
285
+ const result = yourRigBindHandler.stopRecording();
286
+
287
+ // to save the recording to a file....
288
+ result.saveToFile();
289
+
290
+ // or if you just want the AnimationClip...
291
+ result.clip
292
+ ```
293
+ But this will save a .glb containing the rig (mesh, textures, etc...) You would have to strip the mesh data after export or just accept the full GLB and strip it with a post-process tool like [gltf-transform](https://gltf-transform.dev/). The saved .glb will contain the animation clip, the rig and the textures. Still havent figured out a way to export a minimal file like just the animation...
294
+
254
295
  ---
255
296
 
256
297
  ## License