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.

Component

Description

VRC_SceneDescriptor

Required and used to describe a VRChat world, one per scene.

VRC_AvatarPedestal

Used to display and / or switch to an avatar.

VRC_MirrorCamera

Used render the mirror only layers on a camera.

VRC_MirrorReflection

Used to created a mirror in VRChat.

VRC_PortalMarker

Used to create permanent portals to other VRChat worlds.

VRC_CustomRendererBehaviour

Used to apply custom renderer behaviours to an object.

VRC_Station

Used to allow users to sit down, often used in combination with a VRC_Trigger.

VRC_StationApi

A reference script used for creating vehicles. Internal use only.

VRC_StationInput

Used for input to vehicles. Internal use only.

VRC_Trigger

Used to create interactions and events in VRChat.

VRC_EventHandler

Used to synchronize events. Automatically added by VRC_Trigger. Do not add directly.

VRC_PlayerAudioOverride

Used to create a region in a world where user voice volume and falloff can be adjusted.

VRC_SpatialAudioSource

This component supercedes ONSPAudioSource, which is being deprecated. Use VRC_SpatialAudioSource to add 3D spatialization to a Unity AudioSource.

Updated 7 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.