SDK Bug & Feature Requests

Please check out the following rules and use the provided template when posting a bug report! Off-topic posts will be deleted.http://bit.ly/vrchat-bug-reports

Don't use LegacyBlendShapeNormals when AutoFixing with BlendShapeNormals warning

In VRCSDK3 Avatars, if BlendShapeNormals in FBX is Calculate, the validation is displayed. If I press AutoFix here, LegacyBlendShapeNormals will be enabled. But I think LegacyBlendShapeNormals is an old method as it is named Legacy. Since relying on AutoFix in VRCSDK is not a way to get out of the old method, we would like to change it to use the new method. Instead of enabling LegacyBlendShapeNormals, I would like to change BlendShapeNormals to None. Incidentally, depending on the new Blender FBX export settings, LegacyBlendShapeNormals may break mesh normals. So I am trying to find a way to avoid using LegacyBlendShapeNormals. I am using VRCSDK3Avatars 3.6.0. Thanks.

[BUG] The AutoFIX applying SuperSampledUI is not working correctly.

UnityEditor Version: 2022.3.22f1 VRChat Version: VRChat SDK - World 3.6.0 VRChat SDK - Base 3.6.0 Description of the bug: When placing UI elements (Image/Button...) in the scene, a notification appears in the VRCSDK Control Panel's Builder tab indicating that the SuperSampledUIShader needs to be applied. When pressing the Auto Fix button in this notification, it seems like the relevant material is set for the UI in the Hierarchy. However, after saving the scene and reopening it, the changes revert to their original state. Steps to reproduce (how did you encounter the bug?): Method: 1. Place UI elements (Image/Button...) in the scene. 2. Open the VRCSDK Control Panel and display the Builder tab. 3. Press the Auto Fix button in the notification to apply the SuperSampledUIShader. 4. Save the scene and reopen it to find that the material has not been set. Cause: The issue occurs because the SDK does not set the Dirty flag after changes are made, so the changes are not marked for saving.

tracked

VRCSDK 3.6.0 breaks GetComponent<MyType>()

[BUG] Error When Creating Prefabs with UdonSharp in VRChat SDK 3.5.0

VRChat Version: VRChat SDK - World 3.5.0 VRChat SDK - Base 3.5.0 Description of the bug: When adding components created with UdonSharp to a GameObject and then either creating a prefab from this GameObject or saving changes to an existing prefab, an error occurs. This happens in the mentioned versions of the VRChat SDK. Despite the error, the functionality appears to be unaffected. ErrorMessages: ArgumentNullException: Value cannot be null. Parameter name: unityObject All Error Message https://gist.github.com/nmxi/c9404d5094b9774656a5a6e2b219da16 Steps to reproduce (how did you encounter the bug?): Method 1: Create an empty UdonSharp script. Create an EmptyGameObject in the scene. Add the UdonSharp script from step 1 to the GameObject from step 2. Convert the GameObject into a prefab. Error occurs. Method 2: Open the prefab created in Method 1 using the Prefab Editor. Modify a value (example: changing SynchronizationMethod). Save the prefab. Error occurs.

tracked

[FEEDBACK] Remove Unity version warnings in Control Panel because we now have VCC

In the VRCSDK control panel, there is a "Wrong Unity Version." warning and "You are not using the recommended Unity version for VRChat SDK. Content built with this version may not work correctly. Please use Unity xxxx.x.xxx " warning. The second one has a very confusing "Auto Fix" button. Well, we now have VCC, which we can use it to update the various packages and update the Unity version of our project. So, the warnings on the SDK side are only confusing and should be removed. This is because users may read the SDK warnings and try to upgrade directly using Unity Hub or others without VCC. This will destroy the project. There should be no official navigation from anything other than the documentation, VCC, and VPMCLI. (BTW, VPMCLI does not have any migration feature now. https://github.com/vrchat-community/creator-companion/issues/403 ) Even if you keep the indication, it would be best to direct them to the official migration instructions page with a message like "(Info Icon) You are not using the recommended Unity version for VRChat SDK. To upgrade this project, read the document. ("Docs" Button)".

[3.6.0] VRCSDK control panel keeps setting active SDK defines every IMGUI repaint

When you have VRCSDK control panel open on "Authentication", "Content Manager" or "Settings" tab, the IMGUIContainer's onGUIHandler Action will continuously invoke: VRC.SDKBase.Editor.EnvConfig:SetActiveSDKDefines() The onGUIHandler Action is constructed in a lambda expression in Packages\com.vrchat.base\Editor\VRCSDK\Dependencies\VRChat\ControlPanel\VRCSdkControlPanel.cs:292 and the EnvConfig.SetActiveSDKDefines(); has been set to invoke in this Action on line 318. After benchmarking the method, I've only observed half a millisecond overhead per every GUI repaint on average, but it still seems like bad practice.

tracked

VRCWorld loses network IDs as a prefab

The network IDs assigned on the VRCWorld component by the network ID tool are lost when reopening the project if that VRCWorld component is a prefab. The VRCWorld component is a prefab Running VRChats network ID tool assigns different IDs Saving the scene The new IDs can be observed on the VRCWorld component Close and open the project The network IDs on the VRCWorld component are now reverted to the state before running the network ID tool This issue only occurs if the VRCWorld is a prefab. Here is a video demonstrating this issue using the 3.4.0-creator-economy.5 SDK when building for Android with Unity 2019 https://drive.google.com/file/d/1UzULBLYrfEsJJV11sZdr-jd4RSV_nsir/view?usp=drive_link

in progress

Proposal for fixing Audio Filters (eg low-pass) support for AVPro

I believe it is time to get a solution to the most plaguing issue (in my opinion) of AVPro: Audio Filters I do not think this is a "can't fix" situation. In this proposal I will go over the problem, considerations that have been discussed historically, and the solution I believe is feasible to implement with working sample code. ### Previous Cannys 1) https://feedback.vrchat.com/open-beta/p/986-avpro-player-ignores-lowpass-reverb-and-other-filters 2) https://feedback.vrchat.com/sdk-bug-reports/p/avpro-video-player-audio-filter-issue 3) https://feedback.vrchat.com/sdk-bug-reports/p/sound-effects-are-not-applied-to-audiosource-using-avpro-that-comes-with-sdk3 4) https://feedback.vrchat.com/feature-requests/p/usharpvideo-stream-audio-does-not-support-filters ### Crux of the issue As previously discussed in above canny #1, the current way of handling the AVPro speaker component (type named AudioOutput ) is that the component is implicitly created via AddComponent on the same game object. This has the critical drawback of being unable to respect any audio filters due to the DSP filter chain being _component order dependent_. The second half of this issue is that Unity has no runtime native way to change the ordering of components without fully reconstructing the references. This causes very obvious issues in regards to dependent scene references. (TCL's comment in canny #1 clarifies this as well) ### What has been considered Detecting and destroying/rebuilding known filter components after the implicit component is added. This is bad because all scene references to those components would be lost (eg: UI Events or public Udon variables). To avoid the lost components issue, a full scene search would be required in order to update the references which is costly and fragile. Placeholder components (shims) for each filter type that gets implicitly created after the implicit AudioOutput This is bad because it does not allow users to reference the actual filter components in the inspector (namely an issue for UI Events) Allow adding the AudioOutput script manually in scene and have the speaker search for it before trying to implicitly add the component. This is bad because it requires that the user import the AVProTrial package to be able to use built-in unity audio filters. This needs to be compatible with situations where the user does not wish to import that package so the dependency is decoupled from the feature itself. ### Proposed Solution A shim script that inherits from the AudioOutput class combined with a compiler flag for detecting if AVPro is present, and if not, then have a stub type of the _same namespace and type name_ which is _ONLY_ present in the sdk. Then update the VRCAVProVideoSpeaker to check for the existence of the shim component before creating an implicit AudioOutput, using it instead if found on the game object. This ensures that when the main shim script is loaded in editor, it is already a valid AudioOutput component and the component order is correctly retained so the Audio Filters will work correctly. In the SDK, the script type will check for the existence of AVPro through a version define, and if NOT present, will enable the AudioOutput stub class of the same namespace. An example of what it might be like: https://gist.github.com/techanon/41efc336604e148dde55862bff1778d9 I've tested this specific example in editor and it works there. Can't test in-client obviously.

[Bug] Missing Reference in AnimatorPlayAudio locks up build panel

If a state with an AnimatorPlayAudio behaviour has a missing reference (i.e. the source audio file has been deleted from the disk) the build panel will show nothing under "Validations" and both build options will be greyed out. The only hint that something has gone wrong are checking errors in the console: MissingReferenceException: The object of type 'AudioClip' has been destroyed but you are still trying to access it. and MissingReferenceException: The variable Clips of VRCAnimatorPlayAudio doesn't exist anymore. You probably need to reassign the Clips variable of the 'VRCAnimatorPlayAudio' script in the inspector.

Prevent pipeline manager ID from exporting

Something that takes a lot of time when publishing avatar bases for my customers is going through every variant (pc, quest etc.) and ensuring that the pipeline manager is cleared before exporting the unitypackage. Is it possible somehow to restructure the pipeline manager so that the id is saved in the editor or something instead of in the scene/prefab. I feel like this could also greatly help with confusion around the pipeline ID since it really should be in the SDK UI instead of having to go back and forth between the SDK and the object to change an avatar ID.

→