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    

Choosing your SDK

Choose wisely.

VRChat has two SDKs (Software Development Kits) available. These kits are packages that you import into the Unity Editor and assist with the creation of content for VRChat. They are required to upload content to VRChat.

Both of these SDKs are available on our website.

This page will help you choose the correct version for your use case.

Migration Between VRChat SDK2 and VRChat SDK3 is Unsupported

If you have VRCSDK2 content and want to move it to VRCSDK3 (or vice versa), it is best if you start from "scratch." You should import your assets into a new project and then re-add all of the VRChat functionality. SDK components will not migrate.

VRCSDK3 is not a direct upgrade-- VRChat SDK3 is a brand new SDK.

❗️

Don't Cross the Streams!

Do NOT import VRCSDK3 and VRCSDK2 into the same project! They are not compatible and your project will become broken or produce unexpected results.

VRChat SDK3 (VRCSDK3)

Our newest SDK is VRChat SDK3. It comes pre-packaged with VRChat Udon for programming advanced actions in worlds. To learn more about Udon, check out our Udon section in this documentation.

You should use VRCSDK3 if you are creating new worlds and would like to use Udon.

❗️

Avatars Are Not Yet Supported in VRCSDK3

VRCSDK3 does not support the creation of avatars at this time. Use VRCSDK2 for avatar creation.

If you're making avatars, you must use VRCSDK2. VRCSDK3 does not support the creation of avatars at this time.

VRChat SDK2 (VRCSDK2)

VRChat SDK2 (VRCSDK2) is our legacy SDK. SDK2 utilizes Actions and Triggers for programming behavior in worlds.

You should VRCSDK2 if:

  • You are creating avatars
  • You are maintaining a world that uses Triggers and Actions

🚧

Partially Deprecated

VRCSDK2 is considered deprecated for world creation. It will not receive most/any of the new features available in VRCSDK3. It will still receive important security and maintenance patches.

Note: You may see other content creators or documentation refer to the VRChat SDK used in VRChat 2019.3.2p3 and below as "VRCSDK2." This previous version was labeled "VRCSDK", but it was indeed VRCSDK2. Now it is labeled as such. This is why migrating old Unity 2017 projects to VRCSDK2 works. Migrating to VRCSDK3 is not supported. See above.

Updated 4 months ago


Choosing your SDK


Choose wisely.

Suggested Edits are limited on API Reference Pages

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