The VRChat Documentation Hub

Welcome to the VRChat Documentation hub. You'll find comprehensive guides and documentation to help you start working with VRChat as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Updating the SDK

If you need to update your SDK, it is important that you follow these steps to ensure the update proceeds properly and you don't have any old/conflicting files.

Simple Update

Here's how you update your SDK. If you're just uploading avatars, you can use the following process:

  1. Please ensure you're using Unity 2017.4.28f1.
  2. Download the latest version of the SDK here.
  3. Close Unity.
  4. Find your Project folder with Windows Explorer, and find the Assets folder.
  5. Delete the VRCSDK folder, as well as the VRCSDK.meta file in the Assets folder.
  6. Go into Plugins, and delete the VRCSDK folder, as well as the VRCSDK.meta file in the Plugins folder.
  7. Relaunch Unity, and then re-import the freshly-downloaded SDK. Do so by going to Assets, then Import Package, then Custom Package.
  8. Select the new SDK (you probably saved it in Downloads)
  9. Wait a moment, and click "Import" in the bottom left. If any files in the list are greyed out/unchecked, and you can't check them, you didn't delete everything you should have! Start over.
  10. Wait a minute as the SDK finishes importing.

Advanced Update Process

If you're reinstalling the SDK in a project that contains a world using complex trigger setups, here's a safer way to update your SDK.

  1. Close Unity
  2. Back up project to another folder (do not back up the Library folder, these files are auto-generated by Unity)
  3. Delete SDK and Plugins folder, as well as the the associated .META files
  4. Create a new dummy Unity Project
  5. Install the latest SDK on the dummy project
  6. Copy the newly added SDK/Plugin and associated .META files from the dummy project into your original project
  7. Done. Now you can open your upgraded project, and there will be no crash no matter how complex your trigger work!

Updating Unity

If you are updating from a previous version of Unity to a new one that we're swapping to, use this process below.

  1. If you have Unity Hub installed, you can just click here to install the proper version. Do NOT install the 2017.4 version that's in the list in the Unity Hub. Use our link!
  2. If installing via the Unity Hub link doesn't work, go to this page, find Unity 2017.4.28, and click the "Unity Hub" button on the far left side.
  3. If you don't want to use Unity Hub, you can use this link. You only need to install the Editor. You should install the Android Built Support as well if you plan on building content for Oculus Quest.

Updated 3 months ago

Updating the SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.