https://github.com/tattn/vtuberkit
Avatar support library like an AvatarKit (Animoji)
https://github.com/tattn/vtuberkit
animoji gltf ios vrm vtuber
Last synced: 18 days ago
JSON representation
Avatar support library like an AvatarKit (Animoji)
- Host: GitHub
- URL: https://github.com/tattn/vtuberkit
- Owner: tattn
- License: mit
- Created: 2019-02-11T11:19:24.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T06:33:28.000Z (over 1 year ago)
- Last Synced: 2025-03-19T19:02:41.721Z (about 1 month ago)
- Topics: animoji, gltf, ios, vrm, vtuber
- Language: Swift
- Homepage:
- Size: 20.6 MB
- Stars: 147
- Watchers: 3
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
VTuberKit
Avatar support library
## Features
- [x] Show VRM avatar
- [x] Facial morphing (blend shape)
- [x] Bone animation (skin / joint)
- [x] Face tracking
VTuber is a trending avatar style in Japan :wink:
For "VRM", please refer to [this page](https://dwango.github.io/en/vrm/).
# Requirements
- Swift 5.7+
- iOS 15.0+
# Installation
## Swift Package Manager
You can install this package with Swift Package Manager.
## Carthage & CocoaPods (Deprecated)
If you want to use these package managers, please use https://github.com/tattn/VTuberKit/releases/tag/0.1.4
# Dependencies
VTuberKit is depended on [tattn/VRMKit](https://github.com/tattn/VRMKit). Please also see it.
# Usage
## Show avatar
```swift
import VTuberKit
@IBOutlet weak var avatarView: AvatarView!
try avatarView.loadModel(withName: "model.vrm")
```
## Face tracking
```swift
avatarView.startFaceTracking()
avatarView.stopFaceTracking()
```
### More details
- Facial morphing and bone animation
- [tattn/VRMKit](https://github.com/tattn/VRMKit)
- [Example](https://github.com/tattn/VTuberKit/blob/main/Example/ViewController.swift)
# ToDo
- [ ] Improve face tracking
- [ ] Face tracking for All iOS devices without TrueDepth API
- [ ] Add pose presets
- [ ] Add many utility functions
# Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Support this project
Donating to help me continue working on this project.
[](https://paypal.me/tattn/)
# License
VTuberKit is released under the MIT license. See LICENSE for details.
# Author
Tatsuya Tanaka
