Skip to main content

Installation

When you finish this page, you have a Unity project with MingToon installed and no errors. It takes about 15 minutes.

Before you start​

  • Unity Hub, a Unity version from the table below, and a backup of the project you will work on
  • VRChat SDK3 (Avatars) if you target VRChat

1. Match the Unity version​

TargetUnity
VRChat PC2022.3.22f1
Warudo2021.3.45f2
General Unity2021.3 LTS

Use 2022.3.22f1 if you target VRChat. The MingToon VRChat build hook only compiles on 2022.3 or later. A 2021.3 project has no upload optimization at all. One project cannot cover both VRChat and Warudo, so split them.

Unity Hub project list showing editor version 2022.3.22f1

2. Install the package​

Choose VCC or BOOTH on the official download page.

To install with VCC:

  1. Press Add to VCC on the download page.
  2. Confirm the repository in VCC.
  3. Open Manage Project for the target project.
  4. Add MingToon and open Unity.

To install with the BOOTH installer:

  1. Download the installer .unitypackage from the BOOTH product.
  2. Import it in Unity with Assets > Import Package > Custom Package.
  3. Stay connected to the internet and wait. The installer downloads the core automatically.

The Project window after Unity imported the MingToon package and finished compiling

If you installed with VCC, update in VCC as well. The BOOTH installer tells you about new versions when you open Unity.

The BOOTH installer's update window has an Include preview versions checkbox. It is off by default; only projects that opt in check for test builds that ship before the next stable release. After installing a preview, clearing the checkbox offers the latest stable release even when its number is lower than the installed prerelease. If an update is interrupted and the receipt still names the previous release, the installed package rebuilds it from the verified inventory. The bootstrap DLL is not changed for this repair.

3. Check that the shader arrived​

Select one material and open the shader list at the top of the Inspector. You are fine if StudioRaming/MingToon/MingToon BRP is there. The URP shader is not included in this BRP open beta.

The Inspector shader dropdown showing the MingToon BRP entry

4. Check the VRChat integration​

This applies only to VRChat targets. After the reload finishes, the Console must contain the line below.

[MingToon] VRChat build hook compiled and registered.

The Console window showing one MingToon build hook registration log line

If this line is missing

The VRChat build hook is not present. Uploading will not run the automatic optimization.

5. Validate the project​

Run StudioRaming > MingToon > Validate Project from the menu. If the build target cannot meet shader model 4.5, you get a MING-ENV-BUILD-TARGET error. Continuing in that state makes materials render magenta (pink). If the editor is 2021.3 and the VRC SDK is present, you get a MING-VRC-UNITY-VERSION warning.

The result window after running Validate Project

Check that it worked​

  • The Console has no red errors.
  • The shader list contains StudioRaming/MingToon/MingToon BRP.
  • The build hook log is present if you target VRChat.
  • Validate Project reports no errors.

If any of the four does not match, go to Troubleshooting.

If you upgraded from an earlier version​

The bake cache is rebuilt once. There is nothing to delete by hand, but the next build or upload takes that much longer. A VRChat avatar must be uploaded again for this version to apply. The shader ships with the avatar. The conditions are in VRChat.

Optional: Post Processing Stack v2​

MingToon works fully without PPv2. This is for scene checks and capture.

  1. Install PPv2 3.4.0.
  2. Add UNITY_POST_PROCESSING_STACK_V2 manually to Player Settings > Scripting Define Symbols.
  3. Wait until Unity finishes recompiling.
  4. Run StudioRaming > MingToon > Create or Repair BRP PPv2 Global Volume.

If you skip step 2, the menu in step 4 does nothing.

Getting Started with Manager · Supported Environments · Troubleshooting