The VRChat Documentation Hub

Welcome to the VRChat Documentation hub. You'll find comprehensive guides and documentation to help you start working with VRChat as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Scene Components

Some of these components may not be usable in a given SDK version. Please consult Whitelisted World Components for a full list.

VRC_SceneDescriptorRequired and used to describe a VRChat world, one per scene.
VRC_AvatarPedestalUsed to display and / or switch to an avatar.
VRC_MirrorCameraUsed render the mirror only layers on a camera.
VRC_MirrorReflectionUsed to created a mirror in VRChat.
VRC_PortalMarkerUsed to create permanent portals to other VRChat worlds.
VRC_CustomRendererBehaviourUsed to apply custom renderer behaviours to an object.
VRC_StationUsed to allow users to sit down, often used in combination with a VRC_Trigger.
VRC_StationApiA reference script used for creating vehicles. Internal use only.
VRC_StationInputUsed for input to vehicles. Internal use only.
VRC_TriggerUsed to create interactions and events in VRChat.
VRC_EventHandlerUsed to synchronize events. Automatically added by VRC_Trigger. Do not add directly.
VRC_PlayerAudioOverrideUsed to create a region in a world where user voice volume and falloff can be adjusted.
VRC_SpatialAudioSourceThis component supercedes ONSPAudioSource, which is being deprecated. Use VRC_SpatialAudioSource to add 3D spatialization to a Unity AudioSource.

Updated 6 months ago

Scene Components

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.