Skip to content

Avatar support library like an AvatarKit (Animoji)

License

Notifications You must be signed in to change notification settings

tattn/VTuberKit

Repository files navigation

VTuberKit

Avatar support library

demo

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

  • 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. 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

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.

Donate

License

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

Author

Tatsuya Tanaka

Twitter GitHub