Troubleshooting issues with your project in the VRChat SDK / Creator Companion

One
One
  • Updated

VRChat Creator Companion

Our Creator Documentation has a Frequently Asked Questions section that answers many of the commonly faced issues with the Creator Companion. If you are having issues launching the Creator Companion, your settings file might be invalid or corrupted and needs to be reset. If you have an issue with the Creator Companion that is not listed in the Creator Documentation you can see the Contacting Support section below for what information to provide when submitting your support request.

Before attempting any of the troubleshooting steps below, we recommend backing up your project. You can create one manually or by selecting your project in the Creator Companion and selecting the 'Make Backup' option.

Unity & VRChat SDK

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.

  1. Ensure your VRChat Creator Companion and any packages added to the project you are having the issue with are up to date.
  2. For some common issues, you can also look at the SDK Troubleshooting article in our Creator documentation.
  3. 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.
  4. 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 is conflicting with the current VRChat SDK version.
  5. If you've found located the error and are not sure how to interpret it you can see the sections below for some additional tips and finally the Contacting Support section for how to submit a support ticket.

Caution

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 by scrolling through the import file list and unchecking any VRCSDK-related folders. This can most commonly happen if you are trying to import an older Unity Package created before VCC.

Tips for troubleshooting your Avatar project

  1. 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.
  2. 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.
  3. You can also find a sample avatar provided with the SDK under Samples from the VRChat SDK menu.
  4. You can also reach out to other avatar creators in our Discord community on the #avatars-3-help channel in the Avatars category.

 

Tips for troubleshooting your World project

  1. 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.
  2. In case there is an issue with your scene, the following steps can help you find what is causing it:
    1. Start by duplicating your scene file by right-clicking it or by pressing Ctrl + D
    2. After this, you can open the newly created duplicate of your main scene and start removing GameObjects from the hierarchy.
    3. 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.
  3. 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.

Submitting a Bug Report

If you think you've found a bug in the SDK, please submit a report on the feedback board! Our team actively monitors this site and uses it to help keep track of issues.

Contacting Support

If you're having trouble determining your issue, please send our Support team a ticket. You can do so by using this form. Please make sure to describe it, including as much information as possible including the log files specified below. It is very important that you be as detailed as possible. Our Support team may also ask you for more details.

For contacting about issues with Unity and the VRChat SDK

The relevant logs can be found in the following location: C:\Users\username\AppData\Local\Unity\Editor\Editor.log.

Please note that the log is only for the current Unity session if you have restarted since the issue happened the Editor.log will no longer be relevant.

If you are having issues finding the correct location, you can follow the steps below:

  1. Open the Run dialog by pressing Windows + R
  2. Copy the following into the text box and press OK: %UserProfile%\AppData\Local\Unity\Editor

For contacting about issues with VRChat Creator Companion

Relevant logs can be found in the following location: C:\Users\username\AppData\Local\VRChatCreatorCompanion\Logs

If you are having issues finding the correct location, you can follow the steps below:

  1. Open the Run dialog by pressing Windows + R
  2. Copy the following into the text box and press OK: %UserProfile%\AppData\Local\VRChatCreatorCompanion\Logs

Compress all files from this folder into a ZIP archive by selecting them and right-clicking, navigating to "Send To", and choosing "Compressed File".

Please attach the files you are sending to your ticket. Please don't copy and paste it into the request!