Guides:Common SDK issues: Difference between revisions

From VRChat Wiki
(Started page)
 
(Edits major; proofreading, "Official resources" category; added interlinks, Category:Guides, Category:Needs images.)
Line 1: Line 1:
<!-- Everyone is encouraged to add onto this page!
<!-- Everyone is encouraged to add onto this page!
informal "you" is acceptable on guide pages -->{{Noticebox/Community}}{{Stub}}Some users may run into issues when using the VRChat SDK or the Unity Editor itself.
informal "you" is acceptable on guide pages -->{{Noticebox/Community}}{{Stub|Not much information here! You can contribute by expanding and proofreading this article, in accordance with the [[VRCWiki:Manual of Style|Manual of Style]].}}
Some users may run into issues when using the [[VRChat SDK]] or the Unity Editor itself.


== Common SDK errors ==
== Common SDK errors ==
There are errors that may occur within the VRChat SDK, and this section aims to identify and troubleshoot these issues.
=== Common troubleshooting solutions ===
=== Common troubleshooting solutions ===
==== Update SDK/tools ====
==== Update SDK/tools ====
In many instances, checking for updates for the SDK can help fix many issues. You should keep your SDK updated to the latest release version if you are experiencing any issues.
In many instances, checking for updates for the SDK can help fix many issues. You should keep your SDK updated to the [https://creators.vrchat.com/releases latest release version] if you are experiencing any issues. The same goes for any additional tools one may be using, outdated tools could cause unpredictable issues.


The same goes for any additional tools one may be using, outdated tools could cause unpredictable issues.
The [[VRChat Creator Companion]] (VCC) aims to streamline management of keeping Unity, the VRCSDK, and packages updated. Though, some external packages may require manually downloading updates, and re-importing them into VCC or your Unity projects.
==== Remove newly added assets/tools ====
==== Remove newly added assets/tools ====
If the issue begun occuring shortly after installing a certain tool, try removing that tool and restarting Unity to see if it fixes the issue.
If issues arise, shortly after installing a certain tool or package, try removing the file from the project, and restarting Unity to see if it fixes the issue. Some tools may be outdated, or may not support or be compatible with the current SDK or Unity version. In cases such as this, inform the creator of the tool, or find an alternative.


Some tools may be outdated and not support the current SDK version, in cases such as this, inform the creator of the tool or find an alternative.
=== "Missing Credentials" when uploading ===
''<small>For advanced options, see also [[Guides:Connection issues]].</small>''


=== "Missing Credentials" when uploading ===
If you're logged into the SDK, but receive an error for missing credentials when uploading, this could often due to using a VPN service. If you have a VPN service enabled, try turning off your VPN, and it should fix the issue. This can also occur while using software such as [[Wikipedia:1.1.1.1#WARP|Cloudflare's WARP]], which acts similarly to a VPN. In the case of WARP, disabling it, or switching to regular 1.1.1.1 without WARP will fix the issue.
If you're logged into the SDK but recieve this error when uploading, this is often due to using a VPN service, and turning off your VPN will fix the issue. This can also occur while using software such as [[Wikipedia:1.1.1.1#WARP|Cloudflare's WARP]] which acts similarly to a VPN. In the case of WARP, disabling it or switching to regular 1.1.1.1 without WARP will fix the issue.


== Common Unity Editor issues ==
== Common Unity Editor issues ==
There are errors that may occur within the Unity Editor, and this section aims to identify and troubleshoot these issues. Make sure you are using the [https://creators.vrchat.com/sdk/upgrade/current-unity-version/ current Unity version], that is compatible with VRChat.
=== Common troubleshooting solutions ===
=== Common troubleshooting solutions ===
On some occasions the Unity Editor will break for no discernable reason. There are numerous methods that can fix most issues.
On some occasions, the Unity Editor will break, for no discernable reason. There are numerous methods that can fix most issues.
==== Reset Layout ====
==== Reset Layout ====
Commonly if you are having UI related issues, such as the "configure" button in the avatar rig tab not working, or other oddities when selecting assets, such as the inspector turning blank. Resetting your layout in the top right dropdown can fix most issues.
If you are having issues, related to Unity's user interface, such as the "configure" button in the [[Avatars|avatar]] rig tab; or other oddities when selecting assets, such as the Inspector turning blank, '''resetting your layout''' in the top-right dropdown can fix most issues.
<!-- add screenshots-->
 
==Official resources==
* {{VRC link|https://creators.vrchat.com/sdk/sdk-troubleshooting|SDK Troubleshooting}} on ''creators.vrchat.com''
* {{VRC link|https://help.vrchat.com/hc/en-us/categories/10415888257555-Content-Creation-and-VRChat-SDK|Content Creation and VRChat SDK  Knowledgebase}} on ''help.vrchat.com''
 
[[Category:Guides]]
[[Category:Needs images]]

Revision as of 22:44, 11 December 2024

IconOnly CL Portal.png
V · ECommunity-written content
The following was created by the community. It may contain material not directly endorsed by the VRChat team. To learn more, consider reading Contributing to the VRChat Wiki.
Vrrat posed-right.png
V · EThis page is a stub.
You can help the VRChat Wiki by improving it.
[Reason: Not much information here! You can contribute by expanding and proofreading this article, in accordance with the Manual of Style.]

Some users may run into issues when using the VRChat SDK or the Unity Editor itself.

Common SDK errors

There are errors that may occur within the VRChat SDK, and this section aims to identify and troubleshoot these issues.

Common troubleshooting solutions

Update SDK/tools

In many instances, checking for updates for the SDK can help fix many issues. You should keep your SDK updated to the latest release version if you are experiencing any issues. The same goes for any additional tools one may be using, outdated tools could cause unpredictable issues.

The VRChat Creator Companion (VCC) aims to streamline management of keeping Unity, the VRCSDK, and packages updated. Though, some external packages may require manually downloading updates, and re-importing them into VCC or your Unity projects.

Remove newly added assets/tools

If issues arise, shortly after installing a certain tool or package, try removing the file from the project, and restarting Unity to see if it fixes the issue. Some tools may be outdated, or may not support or be compatible with the current SDK or Unity version. In cases such as this, inform the creator of the tool, or find an alternative.

"Missing Credentials" when uploading

For advanced options, see also Guides:Connection issues.

If you're logged into the SDK, but receive an error for missing credentials when uploading, this could often due to using a VPN service. If you have a VPN service enabled, try turning off your VPN, and it should fix the issue. This can also occur while using software such as Cloudflare's WARP, which acts similarly to a VPN. In the case of WARP, disabling it, or switching to regular 1.1.1.1 without WARP will fix the issue.

Common Unity Editor issues

There are errors that may occur within the Unity Editor, and this section aims to identify and troubleshoot these issues. Make sure you are using the current Unity version, that is compatible with VRChat.

Common troubleshooting solutions

On some occasions, the Unity Editor will break, for no discernable reason. There are numerous methods that can fix most issues.

Reset Layout

If you are having issues, related to Unity's user interface, such as the "configure" button in the avatar rig tab; or other oddities when selecting assets, such as the Inspector turning blank, resetting your layout in the top-right dropdown can fix most issues.

Official resources

Retrieved from "https://wiki.vrchat.com/index.php?title=Guides:Common_SDK_issues&oldid=19281"