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    

Whitelisted World Components

The following is the complete list of scripts usable within worlds. Components that are not in this list will not work.

Unity Components

  • WindZone
  • VideoPlayer
  • Tilemap
  • TilemapRenderer
  • Terrain
  • Tree
  • SpriteMask
  • ParticleEmitter
  • EllipsoidParticleEmitter
  • MeshParticleEmitter
  • ParticleAnimator
  • ParticleRenderer
  • WorldParticleCollider
  • Grid
  • GridLayout
  • AudioSource
  • AudioReverbZone
  • AudioLowPassFilter
  • AudioHighPassFilter
  • AudioDistortionFilter
  • AudioEchoFilter
  • AudioChorusFilter
  • AudioReverbFilter
  • PlayableDirector
  • TerrainCollider
  • Canvas
  • CanvasGroup
  • CanvasRenderer
  • TextMesh
  • Animator
  • NavMeshAgent
  • NavMeshObstacle
  • OffMeshLink
  • Cloth
  • WheelCollider
  • Rigidbody
  • Joint
  • HingeJoint
  • SpringJoint
  • FixedJoint
  • CharacterJoint
  • ConfigurableJoint
  • ConstantForce
  • Collider
  • BoxCollider
  • SphereCollider
  • MeshCollider
  • CapsuleCollider
  • CharacterController
  • ParticleSystem
  • ParticleSystemRenderer
  • BillboardRenderer
  • Camera
  • FlareLayer
  • SkinnedMeshRenderer
  • TrailRenderer
  • LineRenderer
  • GUIElement
  • GUILayer
  • Light
  • LightProbeGroup
  • LightProbeProxyVolume
  • LODGroup
  • ReflectionProbe
  • SpriteRenderer
  • Transform
  • RectTransform
  • Rendering.SortingGroup
  • Projector
  • OcclusionPortal
  • OcclusionArea
  • LensFlare
  • Skybox
  • MeshFilter
  • Halo
  • MeshRenderer

VRCSDK2 Only

  • Legacy Animation
  • Legacy GUITexture
  • Legacy GUIText

VRCSDK3 Only

VRChat Components

VRCSDK2 and VRCSDK3

VRCSDK2 Only

Dynamic Bone

  • DynamicBone
  • DynamicBoneCollider

Text Mesh Pro

  • InlineGraphic
  • InlineGraphicManager
  • TMP_Dropdown
  • TMP_InputField
  • TMP_ScrollbarEventHandler
  • TMP_SelectionCaret
  • TMP_SpriteAnimator
  • TMP_SubMesh
  • TMP_SubMeshUI
  • TMP_Text
  • TextMeshPro
  • TextMeshProUGUI
  • TextContainer
  • TMP_Dropdown

Unity Event System

  • EventSystem
  • EventTrigger
  • UIBehaviour
  • BaseInput
  • BaseInputModule
  • PointerInputModule
  • StandaloneInputModule
  • TouchInputModule
  • BaseRaycaster
  • PhysicsRaycaster

Unity UI

  • Button
  • Dropdown
  • Dropdown
  • Graphic
  • GraphicRaycaster
  • Image
  • InputField
  • Mask
  • MaskableGraphic
  • RawImage
  • RectMask2D
  • Scrollbar
  • ScrollRect
  • Selectable
  • Slider
  • Text
  • Toggle
  • ToggleGroup
  • AspectRatioFitter
  • CanvasScaler
  • ContentSizeFitter
  • GridLayoutGroup
  • HorizontalLayoutGroup
  • HorizontalOrVerticalLayoutGroup
  • LayoutElement
  • LayoutGroup
  • VerticalLayoutGroup
  • BaseMeshEffect
  • Outline
  • PositionAsUV1
  • Shadow

Post Processing Stack V2

🚧

Post Processing Stack v1

PPSv1 is not supported in either VRCSDK2 or VRCSDK3. It has been deprecated by Unity.

  • PostProcessDebug
  • PostProcessLayer
  • PostProcessVolume

AVPro

  • ApplyToMaterial
  • ApplyToMesh
  • AudioOutput
  • CubemapCube
  • DebugOverlay
  • DisplayBackground
  • DisplayIMGUI
  • DisplayUGUI
  • MediaPlayer
  • StreamParser
  • SubtitlesUGUI
  • UpdateStereoMaterial

Oculus Lipsync

  • OVRLipSync
  • OVRLipSyncContext
  • OVRLipSyncContextBase
  • OVRLipSyncContextCanned
  • OVRLipSyncContextMorphTarget
  • OVRLipSyncContextTextureFlip

Oculus Spatializer Unity

  • ONSPReflectionZone
  • OculusSpatializerUnity
  • ONSPAmbisonicsNative
  • ONSPAudioSource

Final IK

  • BipedIK
  • FingerRig
  • Grounder
  • GrounderBipedIK
  • GrounderFBBIK
  • GrounderIK
  • GrounderQuadruped
  • GrounderVRIK
  • AimIK
  • CCDIK
  • FABRIK
  • FABRIKRoot
  • FullBodyBipedIK
  • IK
  • IKExecutionOrder
  • LegIK
  • LimbIK
  • LookAtIK
  • TrigonometricIK
  • VRIK
  • FBBIKArmBending
  • FBBIKHeadEffector
  • TwistRelaxer
  • InteractionObject
  • InteractionSystem
  • InteractionTarget
  • InteractionTrigger
  • GenericPoser
  • HandPoser
  • Poser
  • RagdollUtility
  • RotationLimit
  • RotationLimitAngle
  • RotationLimitHinge
  • RotationLimitPolygonal
  • RotationLimitSpline
  • AimPoser
  • Amplifier
  • BodyTilt
  • HitReaction
  • HitReactionVRIK
  • Inertia
  • OffsetModifier
  • OffsetModifierVRIK
  • OffsetPose
  • Recoil
  • ShoulderRotator
  • AnimationBlocker
  • BehaviourAnimatedStagger
  • BehaviourBase
  • BehaviourFall
  • BehaviourPuppet
  • JointBreakBroadcaster
  • MuscleCollisionBroadcaster
  • PressureSensor
  • Prop
  • PropRoot
  • PuppetMaster
  • PuppetMasterSettings
  • BipedRagdollCreator
  • RagdollCreator
  • RagdollEditor
  • SolverManager
  • TriggerEventBroadcaster

VRCSDK2 Only

These components are only available when using VRCSDK2, either due to them being deprecated or redundant with the features available in VRCSDK3/Udon.

PhysSound

  • PhysSoundBase
  • PhysSoundObject
  • PhysSoundTempAudio
  • PhysSoundTempAudioPool
  • PhysSoundTerrain

Realistic Eye Movements

  • EyeAndHeadAnimator
  • LookTargetController

Unity Standard Assets

  • AbstractTargetFollower
  • AutoCam
  • FreeLookCam
  • HandHeldCam
  • LookatTarget
  • PivotBasedCameraRig
  • ProtectCameraFromWallClip
  • TargetFieldOfView
  • FirstPersonController
  • HeadBob
  • RigidbodyFirstPersonController
  • Ball
  • BallUserControl
  • AICharacterControl
  • ThirdPersonCharacter
  • ThirdPersonUserControl
  • AxisTouchButton
  • ButtonHandler
  • InputAxisScrollbar
  • Joystick
  • MobileControlRig
  • TiltInput
  • TouchPad
  • WaterBasic
  • Displace
  • GerstnerDisplace
  • PlanarReflection
  • SpecularLighting
  • Water
  • WaterBase
  • WaterTile
  • AfterburnerPhysicsForce
  • ExplosionFireAndDebris
  • ExplosionPhysicsForce
  • Explosive
  • ExtinguishableParticleSystem
  • FireLight
  • Hose
  • ParticleSystemMultiplier
  • SmokeParticles
  • WaterHoseParticles
  • ActivateTrigger
  • AlphaButtonClickMask
  • AutoMoveAndRotate
  • DragRigidbody
  • DynamicShadowSettings
  • FollowTarget
  • FPSCounter
  • ObjectResetter
  • ParticleSystemDestroyer
  • SimpleActivatorMenu
  • SimpleMouseRotator
  • SmoothFollow
  • TimedObjectActivator
  • TimedObjectDestructor
  • WaypointCircuit
  • WaypointProgressTracker
  • AeroplaneAiControl
  • AeroplaneAudio
  • AeroplaneController
  • AeroplaneControlSurfaceAnimator
  • AeroplanePropellerAnimator
  • AeroplaneUserControl2Axis
  • AeroplaneUserControl4Axis
  • JetParticleEffect
  • LandingGear
  • BrakeLight
  • CarAIControl
  • CarAudio
  • CarController
  • CarSelfRighting
  • CarUserControl
  • Mudguard
  • SkidTrail
  • Suspension
  • WheelEffects

Updated 4 months ago


Whitelisted World Components


Suggested Edits are limited on API Reference Pages

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