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    

Setting up the SDK


We're going to need a couple things before we can get started.

Step 0 - Installing Unity

This step is for anyone who hasn't installed Unity, if you already have it up and running you can skip to step 1.

Ensure you are installing VRChat's recommended version, other than that you can run through the setup without having to change any options.

Unity Hub is a great tool that allows you to seamlessly install and work with multiple Unity versions at one time. We strongly recommend using it!

You can find Unity Hub site by clicking here. Click on "Unity Hub", its the green button on the right.

Once Unity Hub is installed, click this link to install the correct version of Unity.
Alternately, go to this page, find Unity 2017.4.15, and click the "Unity Hub" button on the far left side.
You can also go to this page, scroll down, and find Unity 2017.4.15f1.
If you're having trouble finding the right version, use this link, but keep in mind you'll have to manually add the install to Unity Hub.

If you don't want to use Unity Hub, you can use this link. You only need to install the Editor, everything else is optional.

Very Important: After installing Unity 2017.4.15f1, you need to install this Security Mitigation.

Step 1 - Creating a project

Go ahead and create a new project, set to 3D, save it to where ever though I do recommend you have some sort of structure to store your projects.

After the project is open check the title bar to ensure it ends with PC, Mac & Linux Standalone <DX11>, if it does not then go to File > Build Settings... then select PC, Mac & Linux Standalone then click Switch Platform in the bottom left.

Step 2 - Importing the SDK

Now we need to import the SDK, find the SDK unity package wherever you downloaded it and open it. It should open an import dialog. Click Import.

After Unity finishes importing the SDK, check the Console window in unity to ensure there are no errors (click clear first), if there are any errors search the error in a search engine of your choice, or post a message in the #user-support channel in the VRChat Discord. Most issues on initial import are related to running the wrong version of Unity, or other scripts conflicting with the SDK.

Step 3 - Logging in

To use the SDK you will need to log in. To do so, navigate to VRChat SDK > Settings, there you can log in.

What's Next?

Now your project is ready! You can move on to World Creation or Avatar Creation.

Updating the SDK

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.15f1.
  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!

Setting up 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.