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    

Testing Content

Testing a Scene

To test a scene you've created in Unity in VRChat, you need to first log in with your VRChat account by going to the VRChat Menu and then selecting VRChat SDK > Settings. Once you're logged in, make sure your Installed Client Path is correct and pointing to VRChat.exe.

Now go to VRChat SDK > Show Build Control Panel. If it asks you to add a scene descriptor go to Assets > VRCSDK > Prefabs > World, drag VRCWorld into your scene, and place in the location where you want the player to spawn.

In the Build Control Panel there are 4 options. To test your world in VRChat locally without uploading what you want to select is New Build under the Test section. Once you click this button Unity will build a VRChat version of your scene and then launch VRChat and load your world.

Testing an Avatar

There is currently no way to test an Avatar locally. To test an Avatar, upload it to your account and select it as avatar in-app.

Testing Content

Suggested Edits are limited on API Reference Pages

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