<h1 align="center">VRMKit</h1> <h5 align="center">VRM loader and VRM renderer</h5> <div align="center"> <a href="https://app.bitrise.io/app/efaa4b22f111455d"> <img src="https://github.com/tattn/VRMKit/actions/workflows/ci.yml/badge.svg" /> </a> <a href="./LICENSE"> <img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="license:MIT" /> </a> </div> <br /> <div> <img src="https://github.com/tattn/VRMKit/raw/main/.github/demo.jpg" width="300px" alt="demo" /> <img src="https://github.com/tattn/VRMKit/raw/main/.github/demo2.gif" width="300px" alt="demo" /> </div>

For "VRM", please refer to this page.

Features

[x] Load VRM file
[x] Render VRM models on RealityKit (experimental)
[x] Face morphing (blend shape)
[x] Bone animation (skin / joint)
[x] Physics (spring bone)

Requirements

Swift 6.0+
iOS 15.0+
macOS 12.0+
visionOS 2.0+
watchOS 8.0+ (Experimental)

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/VRMKit/releases/tag/0.4.2

Usage

Load VRM

import VRMKit

let vrm = try VRMLoader().load(named: "model.vrm")
// let vrm = try VRMLoader().load(withUrl: URL(string: "/path/to/model.vrm")!)
// let vrm = try VRMLoader().load(withData: data)

// VRM meta data
vrm.meta.title
vrm.meta.author

// model data
vrm.gltf.jsonData.nodes[0].name

Render VRM

import RealityKit
import VRMKit
import VRMRealityKit

let loader = try VRMEntityLoader(named: "model.vrm")
let vrmEntity = try loader.loadEntity()

let arView = ARView(frame: .zero, cameraMode: .nonAR, automaticallyConfigureSession: false)
let anchor = AnchorEntity(world: .zero)
anchor.addChild(vrmEntity.entity)
arView.scene.addAnchor(anchor)

Render VRM (SwiftUI)

import RealityKit
import RealityKitContent
import VRMKit
import VRMRealityKit

import SwiftUI

struct ContentView: View {
    var body: some View {
        RealityView { content in
            let loader = try VRMEntityLoader(named: "model.vrm")
            let vrmEntity = try loader.loadEntity()
            content.add(vrmEntity.entity)
        }
    }
}

<details> <summary>Render VRM (SceneKit) — Deprecated</summary>

Note: VRMSceneKit is deprecated. Use VRMRealityKit instead.

import VRMKit
import VRMSceneKit

@IBOutlet weak var sceneView: SCNView!

let loader = try VRMSceneLoader(named: "model.vrm")
let scene: VRMScene = try loader.loadScene()
let node: VRMNode = scene.vrmNode

sceneView.scene = scene

</details>

Blend shapes

vrmEntity.setBlendShape(value: 1.0, for: .preset(.joy))

vrmEntity.setBlendShape(value: 1.0, for: .preset(.angry))

vrmEntity.setBlendShape(value: 1.0, for: .custom("><"))

Bone animation

vrmEntity.setBlendShape(value: 1.0, for: .preset(.fun))
let neckRotation = simd_quatf(angle: 20 * .pi / 180, axis: SIMD3<Float>(0, 0, 1))
let armRotation = simd_quatf(angle: 40 * .pi / 180, axis: SIMD3<Float>(0, 0, 1))
let (leftArm, rightArm): (Entity?, Entity?)
switch vrmEntity.vrm {
case .v1:
    (leftArm, rightArm) = (vrmEntity.humanoid.node(for: .leftShoulder), vrmEntity.humanoid.node(for: .rightShoulder))
case .v0:
    (leftArm, rightArm) = (vrmEntity.humanoid.node(for: .leftUpperArm), vrmEntity.humanoid.node(for: .rightUpperArm))
}

vrmEntity.humanoid.node(for: .neck)?.transform.rotation *= neckRotation
leftArm?.transform.rotation *= armRotation
rightArm?.transform.rotation *= armRotation

Read the thumbnail image

let loader = VRMLoader()
let vrm = try loader.load(named: "model.vrm")
let image = try loader.loadThumbnail(from: vrm)

ToDo

[ ] VRM 1.0 support
- [x] Decoding VRM 1.0 file
- [x] Render an avatar by RealityKit (as VRM 0.x)
- [ ] Render an avatar by RealityKit (as VRM 1.x)
[ ] VRM shaders support (MToon)
[ ] Improve rendering quality
[ ] Animation support (vrma)
[ ] VRM editing function
[ ] GLTF renderer support

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Support this project

Donating to help me continue working on this project.

License

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

Author

Tatsuya Tanaka

VRMKit

Install / Use

README