We're going to need a couple things before we can get started.
- Unity 2017.4.28f1 - Scroll down to find LTS Release 2017.4.28f1
If you have Unity Hub installed, you can just click here to install the proper version. Do NOT install the 2017.4 version that's in the list in the Unity Hub.... use the link we've provided above!
- VRChat SDK
This step is for anyone who hasn't installed Unity. If you already have it up and running, you can skip to Step 1.
It is very important that you install the correct version of Unity. Ensure that you are installing and using Unity 2017.4.28f1, otherwise content that you upload will not be visible in the application.
Unity Hub is a great tool that allows you to seamlessly install and work with multiple Unity versions at one time. We strongly recommend using Unity Hub!
You can find Unity Hub site by clicking here. Click on "Unity Hub", its the green button on the right.
Once Unity Hub is installed, click this link to install the correct version of Unity.
Alternately, go to this page, find Unity 2017.4.28, and click the "Unity Hub" button on the far left side.
You can also go to this page, scroll down, and find Unity 2017.4.28f1.
If you're having trouble finding the right version, use this link, but keep in mind you'll have to manually add the install to Unity Hub.
If you don't want to use Unity Hub, you can use this link. You only need to install the Editor. You should install the Android Built Support as well if you plan on building content for Oculus Quest.
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. We strongly recommend saving your projects in a mass-storage drive with a lot of space-- Unity projects can get quite large.
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.
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.
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.
To use the SDK, you will need to log in. To do so, navigate to
VRChat SDK > Settings. 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.
Here's how you update your SDK. If you're just uploading avatars, you can use the following process:
- Please ensure you're using Unity 2017.4.28f1.
- Download the latest version of the SDK here.
- Close Unity.
- Find your Project folder with Windows Explorer, and find the Assets folder.
- Delete the VRCSDK folder, as well as the VRCSDK.meta file in the Assets folder.
- Go into Plugins, and delete the VRCSDK folder, as well as the VRCSDK.meta file in the Plugins folder.
- Relaunch Unity, and then re-import the freshly-downloaded SDK. Do so by going to Assets, then Import Package, then Custom Package.
- Select the new SDK (you probably saved it in Downloads)
- 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.
- 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.
- Close Unity
- Back up project to another folder (do not back up the Library folder, these files are auto-generated by Unity)
- Delete SDK and Plugins folder, as well as the the associated .META files
- Create a new dummy Unity Project
- Install the latest SDK on the dummy project
- Copy the newly added SDK/Plugin and associated .META files from the dummy project into your original project
- Done. Now you can open your upgraded project, and there will be no crash no matter how complex your trigger work!
If you are updating from a previous version of Unity to a new one that we're swapping to, use this process below.
- If you have Unity Hub installed, you can just click here to install the proper version. Do NOT install the 2017.4 version that's in the list in the Unity Hub. Use our link!
- If installing via the Unity Hub link doesn't work, go to this page, find Unity 2017.4.28, and click the "Unity Hub" button on the far left side.
- If you don't want to use Unity Hub, you can use this link. You only need to install the Editor. You should install the Android Built Support as well if you plan on building content for Oculus Quest.