VRChat

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

Requirements

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

Step 0 - Installing Unity

Check the Current Unity Version page, and install the current version of Unity-- ideally using Unity Hub.

If you already have Unity up and running, you can skip to Step 1.

Step 1 - Creating a project

For our first project, we'll assume you're building content for Windows PC. If you're looking for the process to build content for VRChat on Quest, check out Setting up Unity for Creating Quest Content.

First, open Unity Hub (or just the editor if you chose to go that route). Create a new project, set it to 3D, and save it.

HDRP and LWRP/URP

VRChat does not use the HDRP or LWRP/URP rendering pipelines offered by Unity. We only support the "3D" renderer.

We strongly recommend saving your projects in a mass-storage drive with a lot of space-- Unity projects can get quite large.

We also STRONGLY recommend creating a new project for each separate world you create. For avatars, it is sufficient to keep your avatars in seperate scenes... but you may want to split your avatar project up if you have a ton of avatars.

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..., select PC, Mac & Linux Standalone, then click Switch Platform in the bottom left.

If you're building content for VRChat on the Oculus Quest, you should also be building for Android. Check out Creating Content for VRChat on Oculus Quest for more details.

Step 2 - Importing the SDK

Now we need to import the SDK! With Unity open to your project, find the SDK's Unity package and open it by double-clicking it in Explorer. You can also Import it via the Assets > Import Package > Custom Package option.

Ensure that you are importing the correct SDK. See the Choosing your SDK page to see how to choose the correct SDK for your use.

After Unity finishes importing the SDK, check the Console window in unity to ensure there are no errors (click clear first). Most errors on initial import are related to running the wrong version of Unity, or other scripts conflicting with the SDK.

If there are any errors even with a brand new empty project, please contact our Support team.

Step 3 - Logging in

To use the SDK, you will need to log in. To do so, navigate to VRChat SDK > Show Control Panel > Authentication. You can sign into your VRChat account there.

Keep in mind that you must have a VRChat account of at least "New User" Trust Rank to upload content. You cannot use a Steam, Oculus, or Viveport account to upload content.

What's Next?

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

Updated a day ago


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.