Install UniVRM with UPM

  • require Unity 2019.4 or later version

  • require Git client

Install git for Unity

Please refer to Git dependencies -> Requirements for more information.

To use Git dependencies in a project, make sure the Git client is installed on your machine and that you have added the Git executable path to the PATH system environment variable.

If git is not installed, the error messages like below will be shown:

An error occurred while resolving packages: Project has invalid dependencies: com.vrmc.vrmshaders: No ‘git’ executable was found. Please install Git on your system then restart Unity and Unity Hub

.

Check whether git.exe can be found on your machine

As mentioned above, install Git client and get the directory of git.exe (by default, git.exe is in C:\Program Files\Git\cmd). Then, add it to the PATH system environment variable.

  • To check the git version, for instance, open Windows PowerShell and type the command git --version:

> git --version
git version 2.29.2.windows.2

Install using UnityPackageManager window

../../_images/menu_packagemanager.jpg

To open UPM, go to Windows -> Package Manager:

../../_images/from_git.jpg

add package from git URL

Whenever a new UniVRM version comes out, we will post git urls associated with this release.

For example, the git urls of v0.66.0 are:

  • https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.66.0

  • depends on VRMShaders

  • depends on UniGLTF, VRMShaders

Since there is no function that can automatically download the dependencies between packages, please add above git urls in order.

Now check your project window. The packages above should be in the Packages folder:

../../_images/upm_package.jpg

By changing the version number, you can switch to different version based on your needs.

Add dependencies in Packages/manifest.json

An alternative way is to add necessary dependencies right in Packages/manifest.json

{
  "dependencies": {
    // ...
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.66.0",
    "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",
    // ...
}

Specify git commit

However, if you want to switch to the specific commit, you can manually change the hash value or append the specific commit in dependencies.

Example:

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