examples/README.md

# Examples

Drop two files here to try the pipeline end-to-end (with a real backend set up per
`../SETUP_BACKENDS.md`):

- `walk.mp4` — a short (~5–15 s) clip of **one** person, reasonably framed.
- `character.glb` — a **Mixamo-rigged** GLB (e.g. exported from the mule/gekko/papagaj pipeline in
  `../../chibi_starters/mule/`). Must contain `mixamorig*` bone nodes.

Then, from the repo root:

```python
from vid2rig.pipeline import run_pipeline
run_pipeline("vid2rig/examples/walk.mp4", "vid2rig/examples/character.glb",
             "vid2rig/examples/out.glb", backend_name="gvhmr", target_fps=30.0)
```

`out.glb` is the rig animated with the video's motion. Feed it to the GLB→USDZ pipeline
(`../../chibi_starters/mule/CLAUDE.md`) for iOS Quick Look if desired.

Sample assets are not committed (size + licensing); add your own.