{"id":28579161,"url":"https://github.com/khaledalam/avatoon","last_synced_at":"2026-03-04T22:31:02.854Z","repository":{"id":292141399,"uuid":"979339593","full_name":"khaledalam/avatoon","owner":"khaledalam","description":"React Three Fiber component for animated avatars with lip-sync and head motion.","archived":false,"fork":false,"pushed_at":"2025-05-09T06:32:12.000Z","size":32328,"stargazers_count":4,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-16T00:03:34.329Z","etag":null,"topics":["3d","animation","avatar","avatars","glb","lip-sync","npm","npm-package","r3f","react","three","three-js","threejs","webgl"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/avatoon","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khaledalam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-07T11:11:59.000Z","updated_at":"2025-07-19T12:23:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"3b39a5b5-9a1b-4784-bf6f-9db5c125e482","html_url":"https://github.com/khaledalam/avatoon","commit_stats":null,"previous_names":["khaledalam/avatoon"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/khaledalam/avatoon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledalam%2Favatoon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledalam%2Favatoon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledalam%2Favatoon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledalam%2Favatoon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khaledalam","download_url":"https://codeload.github.com/khaledalam/avatoon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledalam%2Favatoon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30096724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T21:59:23.547Z","status":"ssl_error","status_checked_at":"2026-03-04T21:57:50.415Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","animation","avatar","avatars","glb","lip-sync","npm","npm-package","r3f","react","three","three-js","threejs","webgl"],"created_at":"2025-06-11T01:38:28.140Z","updated_at":"2026-03-04T22:31:02.840Z","avatar_url":"https://github.com/khaledalam.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🧠 Avatoon\n\n\n[![npm package][npm-img]][npm-url]\n[![Build Status][build-img]][build-url]\n[![Issues][issues-img]][issues-url]\n[![Code Coverage][codecov-img]][codecov-url]\n\n\n**Avatoon** is a lightweight React Three Fiber component for rendering animated 3D avatars with real-time viseme-driven lip-sync. It supports lifelike head movements, morph target control, and optional goal-based gestures (e.g., flexing, sleeping), making it ideal for voice assistants, interactive characters, or storytelling apps.\n\n\u003cimg src=\"https://raw.githubusercontent.com/khaledalam/avatoon/main/test/assets/avatoon.gif\" /\u003e\n\n[demo video](https://youtu.be/9ODqu2EZvtw)\n\n\n## ✨ Features\n- 🎤 Real-time lip-sync using phoneme-viseme mapping  \n- 🧍 Subtle head motion animation while talking  \n- 🌐 GLTF model support via `useGLTF`  \n- ⚛️ Plug-and-play with React Three Fiber + Drei  \n- 🎯 Goal-based gestures like \"Muscle\" or \"Sleep\"\n\n## 📦 Installation\n\n```bash\nnpm install avatoon\n```\n\n## 🚀 Usage\n\n```js\nimport { Avatoon } from \"avatoon\";\n\nexport default App = () =\u003e {\n    const visemeJson = {\n        visemes: [{ \n            { \"time\": 0, \"viseme\": \"X\" },\n            { \"time\": 1.3, \"viseme\": \"A\" },\n            { \"time\": 1.367, \"viseme\": \"C\" },\n         }],\n        audio_base64: '',\n    };\n\n    return (\n        \u003cAvatoon\n            glbUrl='https://raw.githubusercontent.com/khaledalam/avatoon/main/test/assets/placeholder-avatar.glb'\n            goal={\"Normal\"}\n            onRenderComplete={() =\u003e console.log(\"Render Completed!\")}\n            visemeJson={visemeJson}\n        /\u003e\n    );\n}\n\n```\n\n### To run example:\n```bash\nnpm run example\n```\n\n## 🧩 API\n\n### `Avatoon(props)`\n\n| Prop                  | Type         | Default      | Description                                            |\n| --------------------- | ------------ | ------------ | ------------------------------------------------------ |\n| `glbUrl`              | `string`     | *(required)* | URL to the `.glb` avatar file (T1 or T2)               |\n| `goal`                | `string`     | `\"Normal\"`   | Goal-based motion preset: `\"Muscle\"`, `\"Sleep\"`, etc.  |\n| `onRenderComplete`    | `() =\u003e void` | `undefined`  | Callback fired when avatar finishes rendering          |\n| `visemeJson`          | `VisemeData` | `undefined`  | JSON structure for syncing visemes with audio playback |\n| `showPlayVoiceButton` | `boolean`    | `false`      | If true, renders a play/stop voice button in the scene |\n\n## 👤 Avatar Types\n- T1 (Static Face - Realistic)\n    - Most photorealistic\n    - No facial morphing\n    - Lightweight\n    - \u003cimg src=\"https://raw.githubusercontent.com/khaledalam/avatoon/main//test/assets/V1_bg.jpg\" width=\"100\"/\u003e\n- T2 (Blendshape Face - Expressive)\n  - Separate eyeballs and mouth\n  - Supports morph targets / ARKit visemes\n  - Slightly less realistic but animatable\n  - \u003cimg src=\"https://raw.githubusercontent.com/khaledalam/avatoon/main//test/assets/V2_bg.jpg\" width=\"100\"/\u003e\n\n## 📘 Types\n\n```ts\ninterface VisemeData {\n  visemes: Array\u003c{ time: number; viseme: string | null }\u003e;\n  audio_base64?: string;\n}\n```\n\n\n## 🤝 Contribution\nPull requests are welcome! If you'd like to suggest improvements or fix issues, feel free to fork and submit.\n\n\n## 🛡️ Author\n\n**Khaled Alam**\n\n📧 [khaledalam.net@gmail.com](mailto:khaledalam.net@gmail.com)\u003cbr /\u003e\n🌍 [Website](https://khaledalam.net/) | [LinkedIn](https://www.linkedin.com/in/khaledalam/) | [X(Twitter)](https://x.com/khaledalamxyz)\n\n[build-img]:https://github.com/khaledalam/avatoon/actions/workflows/release.yml/badge.svg\n[build-url]:https://github.com/khaledalam/avatoon/actions/workflows/release.yml\n[npm-img]:https://img.shields.io/npm/v/avatoon\n[npm-url]:https://www.npmjs.com/package/avatoon\n[issues-img]:https://img.shields.io/github/issues/khaledalam/avatoon\n[issues-url]:https://github.com/khaledalam/avatoon/issues\n[codecov-img]:https://codecov.io/gh/khaledalam/avatoon/branch/main/graph/badge.svg\n[codecov-url]:https://codecov.io/gh/khaledalam/avatoon","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaledalam%2Favatoon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhaledalam%2Favatoon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaledalam%2Favatoon/lists"}