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 three 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.

All of these SDKs are available on our website.

If you are participating in our Open Beta, the SDKs will be linked in the Open Beta Discord channels and announcements. There may be extra notes to go along with testing SDKs, so please review the latest info and announcements carefully.

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

Open Beta

Are you testing an Open Beta build? The SDKs for the Open Beta are only available on our Discord!

Check the last post in the #open-beta-info for the latest SDK download links.

VRChat SDK3 (VRCSDK3)

Our SDK called is VRChat SDK3. It comes in two "flavors"-- one for Avatars, and one for Worlds.

The VRCSDK3-Avatars package comes with Avatars 3.0, the latest avatar framework we offer for creation of both basic and advanced avatars with full customization. Check out Avatars 3.0 to learn more.

VRCSDK3-Worlds comes pre-packaged with VRChat Udon for programming advanced actions. To learn more about Udon, check out our Udon section in this documentation.

You may not import both into the same project - this will prevent you from publishing either Avatars or Worlds in that project.

You should use VRCSDK3 if you are creating avatar or world content for VRChat.

VRChat SDK2 (VRCSDK2) - Deprecated

🚧

Deprecated

VRCSDK2 is deprecated. It will not receive most/any of the new features available in VRCSDK3-Worlds or VRCSDK3-Avatars. It will still receive important security and maintenance patches, and we will continue to maintain it for the time being.

If you are creating new content, you need to use VRCSDK3 instead.

VRChat SDK2 (VRCSDK2) is our legacy SDK. SDK2 utilizes Actions and Triggers for programming behavior in worlds. It does not have access to Udon or Avatars 3.0.

You should VRCSDK2 if:

  • You are maintaining older "Avatars 2.0" avatars, or
  • You are maintaining a world that uses Triggers and Actions.

❗️

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.

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 an upgrade. VRChat SDK3 is a brand new SDK.

Updated 2 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.