Skip to content

How to use UniVRM and UniVGO together

IzayoiJiichan edited this page Nov 4, 2024 · 35 revisions

1. Combination list

The version combinations are as follows.

min Unity UniVRM min UniVGO recommended UniVGO Check
2019.4 0.66.0 2.4.4 2.5.1 OK
2019.4 0.68.2 2.4.4 2.5.1 OK
2019.4 0.70.0 2.4.4 2.5.1 OK
2019.4 0.71.0 2.4.4 2.5.1 OK
2019.4 0.72.0 2.4.5 2.5.1 OK
2019.4 0.73.0 2.4.5 2.5.1 OK
2019.4 0.74.0 2.4.5 2.5.1 OK
2019.4 0.75.0 2.4.5 2.5.1 OK
2019.4 0.76.0 2.4.5 2.5.1 (OK)
2019.4 0.77.0 2.4.5 2.5.1 (OK)
2019.4 0.78.0 2.4.5 2.5.1 (OK)
2019.4 0.79.0 2.4.5 2.5.1 (OK)
2019.4 0.80.0 2.4.5 2.5.1 (OK)
2019.4 0.81.0 2.4.5 2.5.1 OK
2019.4 0.82.0 2.4.5 2.5.1 OK
2019.4 0.83.0 2.4.5 2.5.1 OK
2019.4 0.84.0 2.4.5 2.5.1 OK
2019.4 0.85.0 2.4.5 2.5.1 OK
2019.4 0.86.0 2.4.5 2.5.1 OK
2019.4 0.87.0 2.4.5 2.5.1 OK
2019.4 0.88.0 2.4.5 2.5.1 OK
2019.4 0.89.0 2.4.5 2.5.1 OK
2019.4 0.90.0 2.4.5 2.5.1 OK
2019.4 0.91.0 2.4.5 2.5.1 OK
2019.4 0.92.0 2.4.5 2.5.1 OK
2019.4 0.93.0 2.4.5 2.5.1 OK
2019.4 0.94.0 2.4.5 2.5.1 OK
2019.4 0.95.1 2.4.5 2.5.1 OK
2019.4 0.96.2 2.4.5 2.5.1 OK
2019.4 0.97.0 2.4.5 2.5.1 OK
2019.4 0.98.0 2.4.5 2.5.1 OK
2019.4 0.99.4 2.4.5 2.5.1 OK
2020.3 0.100.0 2.5.1 2.5.20 OK
2020.3 0.101.0 2.5.1 2.5.20 OK
2020.3 0.102.0 2.5.1 2.5.20 OK
2020.3 0.103.2 2.5.1 2.5.20 OK
2020.3 0.104.2 2.5.1 2.5.20 OK
2020.3 0.105.0 2.5.1 2.5.20 OK
2020.3 0.106.0 2.5.1 2.5.20 OK
2020.3 0.107.2 2.5.1 2.5.20 OK
2020.3 0.108.0 2.5.1 2.5.20 OK
2020.3 0.109.0 2.5.1 2.5.20 OK
2020.3 0.110.0 2.5.1 2.5.20 OK
2020.3 0.111.0 2.5.1 2.5.20 OK
2021.3 0.112.0 2.5.1 2.5.22 OK
2021.3 0.113.0 2.5.1 2.5.22 OK
2021.3 0.114.0 2.5.1 2.5.22 OK
2021.3 0.115.0 2.5.1 2.5.22 OK
2021.3 0.116.0 2.5.1 2.5.22 OK
2021.3 0.117.0 2.5.1 2.5.22 OK
2021.3 0.118.0 2.5.1 2.5.22 OK
2021.3 0.119.0 2.5.1 2.5.22 OK
2021.3 0.120.0 2.5.1 2.5.22 OK
2021.3 0.121.0 2.5.1 2.5.22 OK
2021.3 0.122.0 2.5.1 2.5.22 OK
2021.3 0.123.0 2.5.1 2.5.22 OK
2021.3 0.124.0 2.5.1 2.5.22 OK
2021.3 0.124.2 2.5.1 2.5.22 OK

When using Unity 2020.2 or higher, 0.76.0 to 0.80.0 will cause compilation errors and is not recommended.

2. Install Packages

2-A. When using UniVRM 0.66.0 to 0.71.0

Please use UniVGO 2.4.4.

Write the following in <Project>/Packages/package.json.

{
  "dependencies": {
    ///
    "com.vrmc.unigltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.66.0",
    "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.66.0",
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.66.0",
    ///
  }
}

2-B. When using UniVRM 0.72.0 to 0.80.0

Write the following in <Project>/Packages/package.json.

{
  "dependencies": {
    ///
    "com.vrmc.unigltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.72.0",
    "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.72.0",
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.72.0",
    ///
  }
}

2-C. When using UniVRM 0.81.0 to 0.124.2

Write the following in <Project>/Packages/package.json.

{
  "dependencies": {
    ///
    "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.81.0",
    "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.81.0",
    "com.vrmc.vrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v0.81.0",
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.81.0",
    ///
  }
}

2-D. When using UniVRM 0.125.0 to 0.127.0

Write the following in <Project>/Packages/package.json.

{
  "dependencies": {
    ///
    "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.125.0",
    "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.125.0",
    "com.vrmc.vrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v0.125.0",
    ///
  }
}

3. Modify Define symbol

If you are using UniVGO 2.5.0 or lower, modify the define symbol to match the version of VRMShaders (com.vrmc.vrmshaders) you are using.

Unity Editor

Menu Bar > Edit > Projcet Settings

Projcet Settings Window

Player > Other Settings > Script Compilation > Scripting Define Symbols

Add the Define symbol to match the version of VRMShaders (com.vrmc.vrmshaders) you are using.

symbol value min version max version
VRMC_VRMSHADERS_0_72_OR_NEWER 0.72.0 0.78.0
VRMC_VRMSHADERS_0_79_OR_NEWER 0.79.0 0.84.0
VRMC_VRMSHADERS_0_85_OR_NEWER 0.85.0 0.103.0
VRMC_VRMSHADERS_0_104_OR_NEWER 0.104.0 0.124.2

4. Pre-set up sample project

unity version rendering pipeline package link
2019.4.40f1 BRP UniVGO + UniVRM Link
2020.3.39f1 BRP UniVGO + UniVRM Link
2021.3.0f1 BRP UniVGO + UniVRM Link
2022.3.0f1 BRP UniVGO + UniVRM Link
Clone this wiki locally