Install

1. Install Unity Hub

https://unity.com/unity-hub

2. Install Unity Editor

Install one of Unity Editor on Unity Hub.

Unity version	remarks
2019.4.0f1	(expired)
2020.3.0f1	(expired)
2021.3.0f1
2022.3.0f1	recommended
2023.1.0f1	recommended
2023.2.0f1	recommended

If you don't see the version you're looking for in Unity Hub, install it via the Unity Download Archive.

3-A. Installation procedure (case using the template project)

3-1. Download sample project

Download one of the UniVGO sample projects.

unity version	rendering pipeline	link
2019.4.40f1	BRP	Link
2020.3.39f1	BRP	Link
2021.3.0f1	BRP	Link
2021.3.0f1	URP	Link
2021.3.0f1	HDRP	Link
2022.3.0f1	BRP	Link

3-2. Load project

At the Unity Hub, add the sample project downloaded in step 1 to the list.
The specified folder is the project folder.

3-B. Installation procedure (case you create your own project)

3-1. Creating a new project

Create a new 3D project in Unity Editor or Unity Hub.

    <Project>
        Assets
        Packages
        ProjectSettings

3-2. Add Define symbol

This is only necessary when using UniVGO version 2.5.0 or lower.

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.117.0)

Add the Define symbol to match the version of lilToon (jp.lilxyzw.liltoon) you are using.

symbol value	min version	max version
LILTOON_1_2_12_OR_OLDER	(1.2.0)	1.2.12
LILTOON_1_3_0_OR_NEWER	1.3.0	1.3.7
LILTOON_1_4_0_OR_NEWER	1.4.0	1.4.1
LILTOON_1_5_0_OR_NEWER	1.5.0	1.5.2
LILTOON_1_6_0_OR_NEWER	1.6.0	1.6.0
LILTOON_1_7_0_OR_NEWER	1.7.0	(1.7.2)

Click Apply button.

3-3. Install Packages

Import UniVGO and dependent packages into your project.
Write the following in <Project>/Packages/package.json.
You need to be careful where you add them.

3-3-1. Basic Sytem Packages

If you are using Unity 2021.1.28f1 or lower, add the following settings. Otherwise, do nothing.

{
  "scopedRegistries": [
    {
      "name": "Unity NuGet",
      "url": "https://unitynuget-registry.azurewebsites.net",
      "scopes": ["org.nuget"]
    }
  ],
  "dependencies": {
    "org.nuget.system.buffers": "4.4.0",
    "org.nuget.system.memory": "4.5.0",
    "org.nuget.system.numerics.vectors": "4.4.0",
  }
}

3-3-2. Basic Packages

To use UniVGO, add the following settings.

{
  "dependencies": {
    "com.izayoi.liltoon.shader.utility": "https://github.com/izayoijiichan/lilToonShaderUtility.git#v1.7.0",
    "com.izayoi.unishaders": "https://github.com/izayoijiichan/UniShaders.git#v1.6.1",
    "com.izayoi.univgo": "https://github.com/izayoijiican/VGO.git#v2.5.20",
    "com.izayoi.vgospringbone": "https://github.com/izayoijiichan/VgoSpringBone.git#v1.1.2",
    "com.unity.nuget.newtonsoft-json": "3.2.1",
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.105.0",
  }
}

3-3-3. Addtional Packages

If you want to use lilToon shader, append the following line.

{
  "dependencies": {
    "jp.lilxyzw.liltoon": "https://github.com/lilxyzw/lilToon.git?path=Assets/lilToon#1.7.2",
  }
}

If you are using Unity 2021.2 or higher and you want to use WebP, append the line "org.nuget.sixlabors.imagesharp".

{
  "scopedRegistries": [
    {
      "name": "Unity NuGet",
      "url": "https://unitynuget-registry.azurewebsites.net",
      "scopes": ["org.nuget"]
    }
  ],
  "dependencies": {
    "org.nuget.sixlabors.imagesharp": "2.1.6",
  }
}

If you want to use URP, append the following line.

{
  "dependencies": {
    "com.unity.render-pipelines.universal": "14.0.0",
  }
}

• Universal RP 10.10 for Unity 2020.3
• Universal RP 12.1 for Unity 2021.3
• Universal RP 14.0 for Unity 2022.3
• Universal RP 15.0 for Unity 2023.1
• Universal RP 16.0 for Unity 2023.2

If you want to use HDRP, append the following line.

{
  "dependencies": {
    "com.unity.render-pipelines.high-definition": "14.0.0",
  }
}

• High Definition RP 10.10 for Unity 2020.3
• High Definition RP 12.1 for Unity 2021.3
• High Definition RP 14.0 for Unity 2022.3
• High Definition RP 15.0 for Unity 2023.1
• High Definition RP 16.0 for Unity 2023.2

4. Confirmation of installation completion

4-1. Confirm Console

Check that no errors are displayed in the Unity Editor console.

4-2. Confirm Menu

Check that the menu item Tools > UniVGO is displayed on the menu bar of Unity Editor.

4-3. Confirm Installed Packages

Menu Bar > Window > Package Manager

Package Manager (Popup Window)

Packages: in Project

package author	package name	version	remarks
Microsoft	System.Buffers (Nuget)	4.4.0	Unity 2021.1.28f1 or lower only
Microsoft	System.Memory (Nuget)	4.5.3	Unity 2021.1.28f1 or lower only
Microsoft	System.Numerics.Vectors (Nuget)	4.4.0	Unity 2021.1.28f1 or lower only
Unity	Newtonsoft Json	3.2.1
Unity	Universal RP	(14.0.0)	URP only
Unity	High Definition RP	(14.0.0)	HDRP only
lilxyzw	lilToon	(1.7.2)	if your project use lilToon shader
Izayoi Jiichan	lilToon Shader Utility	1.7.0
Izayoi Jiichan	UniShaders	1.6.1
Izayoi Jiichan	UniVGO	2.5.20
Izayoi Jiichan	VgoSpringBone	1.1.2
VRM Consortium	UniGLTF	(0.105.0)
VRM Consortium	VRM Shaders	(0.105.0)

5. Causes of installation errors

Possible causes of the error are as follows.

• Different Unity version.
• Different versions of the package or bad combination.
• Duplicate or missing file.
• asmdef settings have been changed.
• asmdef.meta settings have been changed.
• The .meta guid of the file has changed.
• System.Buffers.dll, System.Memory.dll, System.Numerics.Vectors.dll is duplicated.
• NewtonSoft.Json.dll is duplicated.
• LFS data not retrieved.