VTuberKit

Avatar support library

Features

• Show VRM avatar
• Facial morphing (blend shape)
• Bone animation (skin / joint)
• Face tracking

VTuber is a trending avatar style in Japan 😉

For "VRM", please refer to this page.

Requirements

• Xcode 13+
• Swift 5.x
• iOS 12.0+

Installation

Swift Package Manager (Recommended)

You can install this package with Swift Package Manager.

Carthage

github "tattn/VTuberKit"

$ carthage update --platform ios --use-xcframeworks

Add VTuberKit.xcframework, VRMKit.xcframework and VRMSceneKit.xcframework into Linked frameworks and Libraries & Embed Frameworks.

CocoaPods

pod 'VTuberKit'

Dependencies

VTuberKit is depended on tattn/VRMKit. Please also see it.

Usage

Show avatar

import VTuberKit

@IBOutlet weak var avatarView: AvatarView!


try avatarView.loadModel(withName: "model.vrm")

Face tracking

avatarView.startFaceTracking()
avatarView.stopFaceTracking()

More details

• Facial morphing and bone animation
  • tattn/VRMKit
• Example

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.

License

VTuberKit is released under the MIT license. See LICENSE for details.

Author

Tatsuya Tanaka