VRChat

The VRChat Developer Hub

Welcome to the VRChat developer 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

Requirements

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.

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 where ever 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 #development channel in the VRChat discord

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?

Well now you have a project ready you can move onto World Creation or Avatar Creation

Updating the SDK

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 5.6.3p1. Download the latest version here: https://vrchat.com/download/sdk
  2. Close Unity.
  3. Find your Project folder with Windows Explorer, and find the Assets folder.
  4. Delete the VRCSDK folder, as well as the VRCSDK.meta file in the Assets folder.
  5. Go into Plugins, and delete the VRCSDK folder, as well as the VRCSDK.meta file in the Plugins folder.
  6. Relaunch Unity, and then re-import the freshly-downloaded SDK. Do so by going to Assets, then Import Package, then Custom Package.
  7. Select the new SDK (you probably saved it in Downloads)
  8. 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.
  9. Wait a minute as the SDK finishes importing.

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!




* You require a VRChat account to upload custom avatar's and world's

Setting up the SDK