If the project you are having issues with contains anything important before attempting any troubleshooting steps below, we highly recommend creating a backup of your project manually or by selecting your project in the Creator Companion and clicking the 'Make Backup' option.
Install the Creator Companion - This is highly recommended!
- Please note that the recommended way of installing the VRChat SDK is through the VCC ( VRChat Creator Companion ). The Creator Companion automatically handles creating and updating Unity projects for VRChat. If you have issues related to the Creator Companion, you can check out the Frequently Asked Questions section.
Issues with the VRChat SDK are most commonly caused by the following reasons:
- You've imported an editor asset that is outdated or is no longer supported, causing it to conflict with the current version of the VRChat SDK.
- You've imported an avatar from a Unity Package that was exported incorrectly or included conflicting scripts.
- If you've installed the VRChat SDK without using the Creator Companion, please ensure you are using the correct Unity version specified in Currently Supported Unity Version.
However, there can be several other reasons why you might be having an issue with your project.
If you are importing a third-party Unity Package into your project, it's recommended to ensure it does not include any parts of the VRChat SDK in it by scrolling through the import file list and unchecking any VRCSDK folders. This can most commonly happen if you are trying to import an older Unity Package created before VCC.
- Open the Unity Console with Ctrl + Shift + C and look for errors pointing toward an asset causing the issue. Yellow-colored Warnings can be ignored in most cases, and the issue you are looking for will appear under red-colored Errors.
- To narrow things down, you can disable everything but errors from the top-right corner of the console. It will also indicate how many errors you currently have in your console.
- If the errors indicate a specific asset you've imported into the project, you can try removing it first and checking to see if the creator has released a more recent version that might resolve known bugs with the asset itself.
- If you cannot determine the cause, you can also try creating a new project and seeing if the issue happens before importing additional assets. This can help you determine if a Unity Package you imported was exported incorrectly or could be conflicting with the current VRChat SDK version.
- If you need help solving the errors you've found or cannot find any, please submit a support request with as much information as possible, including an editor log where you've successfully reproduced the error.
Your Editor.log can be found in the following location: C:\Users\username\AppData\Local\Unity\Editor\Editor.log.
If you are having issues finding the correct location, you can follow the steps below:
- Open the Run dialog by pressing Windows + R
- Copy the following into the text box and press OK:
Please attach this file to your ticket. Please don't copy and paste it into the request!
Useful tips for troubleshooting your Avatar project
- If you have multiple avatars enabled in the scene you are trying to upload from, try disabling all other avatars except the one you are currently trying to upload.
- If you've imported an avatar you've bought online, please make sure you've checked if there are any instructions provided by the creator on how to import it correctly.
- You can also find a sample avatar provided with the SDK under Samples from the VRChat SDK menu.
- You can also reach out to other avatar creators in our Discord community on the #avatars-3-help channel in the Avatars category.
Useful tips for troubleshooting your World project
- To see if there is an issue with the scene you are trying to upload, you can open the UdonExampleScene provided with the SDK and try to upload it instead. If you are able to upload it successfully, the issue is in your scene instead of the project.
- The example scene can be found under the VRChat SDK menu under Samples.
- In case there is an issue with your scene, the following steps can help you find what is causing it:
- Start by duplicating your scene file by right-clicking it or by pressing Ctrl + D
- After this, you can open the newly created duplicate of your main scene and start removing GameObjects from the hierarchy.
- Pay attention to what you've removed, and try uploading the world again. If you are able to upload successfully, this means the cause for the issue was in one of the GameObjects you've removed.
- If you need to start over, you can duplicate the original scene you had again.
- You can also reach out to other world creators in our Discord community on the #udon-development or #world-development channels in the Worlds and Udon categories.