For AI agents: visit https://vrtoolkit.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides

Overview

Welcome to VRTK
Getting Started
Examples
Frequently Asked Questions
Made With VRTK

Prefabs

Summary
SDK Setup Switcher
Console Viewer
Frames Per Second Viewer
Desktop Camera
Controller Rigidbody Activator
Object Tooltip
Controller Tooltips
Snap Drop Zone
Destination Point
Pointer Direction Indicator
Radial Menu
Independent Radial Menu Controller
Panel Menu Controller
Panel Menu Item Controller
Avatar Hand Controller

Pointers

Summary
VRTK_DestinationMarker
VRTK_Pointer
VRTK_PlayAreaCursor

Pointer Renderers

Summary
Pointer Origin Smoothing Settings
VRTK_StraightPointerRenderer
VRTK_BezierPointerRenderer

Locomotion

Summary
VRTK_BasicTeleport
VRTK_HeightAdjustTeleport
VRTK_DashTeleport
VRTK_TeleportDisableOnHeadsetCollision
VRTK_TeleportDisableOnControllerObscured
VRTK_ObjectControl
VRTK_TouchpadControl
VRTK_ButtonControl
VRTK_MoveInPlace
VRTK_PlayerClimb
VRTK_SlingshotJump
VRTK_StepMultiplier
VRTK_TunnelOverlay
VRTK_DragWorld

Object Control Actions

Summary
VRTK_BaseObjectControlAction
VRTK_SlideObjectControlAction
VRTK_RotateObjectControlAction
VRTK_SnapRotateObjectControlAction
VRTK_WarpObjectControlAction

Interactors

Summary
VRTK_ControllerEvents
VRTK_InteractTouch
VRTK_InteractNearTouch
VRTK_InteractGrab
VRTK_InteractUse
VRTK_ControllerTrackedCollider
VRTK_ControllerHighlighter
VRTK_ObjectAutoGrab

Interactables

Summary
VRTK_InteractableObject
VRTK_InteractableListener
VRTK_InteractHaptics
VRTK_ObjectAppearance
VRTK_InteractObjectHighlighter
VRTK_ObjectTouchAutoInteract
VRTK_IgnoreInteractTouchColliders

Highlighters

Summary
VRTK_BaseHighlighter
VRTK_MaterialColorSwapHighlighter
VRTK_MaterialPropertyBlockColorSwapHighlighter
VRTK_OutlineObjectCopyHighlighter

Grab Attach Mechanics

Summary
VRTK_BaseGrabAttach
VRTK_BaseJointGrabAttach
VRTK_FixedJointGrabAttach
VRTK_SpringJointGrabAttach
VRTK_CustomJointGrabAttach
VRTK_ChildOfControllerGrabAttach
VRTK_TrackObjectGrabAttach
VRTK_RotatorTrackGrabAttach
VRTK_ClimbableGrabAttach
VRTK_ControlAnimationGrabAttach
VRTK_MoveTransformGrabAttach
VRTK_RotateTransformGrabAttach

Secondary Controller Grab Actions

Summary
VRTK_BaseGrabAction
VRTK_SwapControllerGrabAction
VRTK_AxisScaleGrabAction
VRTK_ControlDirectionGrabAction

Presence

Summary
VRTK_HeadsetCollision
VRTK_HeadsetFade
VRTK_HeadsetCollisionFade
VRTK_HeadsetControllerAware
VRTK_HipTracking
VRTK_BodyPhysics
VRTK_PositionRewind

UI

Summary
VRTK_UICanvas
VRTK_UIPointer
VRTK_UIDraggableItem
VRTK_UIDropZone

Controllables

Summary
VRTK_BaseControllable
VRTK_BasePhysicsControllable
VRTK_PhysicsPusher
VRTK_PhysicsRotator
VRTK_PhysicsSlider
VRTK_ArtificialPusher
VRTK_ArtificialRotator
VRTK_ArtificialSlider

Utilities

Summary
ScriptingDefineSymbolPredicateInfo
VRTK_SDKManager
VRTK_SDKSetup
VRTK_SDKInfo
VRTK_DeviceFinder
VRTK_SharedMethods
VRTK_PolicyList
VRTK_CustomRaycast
VRTK_NavMeshData
VRTK_AdaptiveQuality
VRTK_ObjectFollow
VRTK_RigidbodyFollow
VRTK_TransformFollow
VRTK_SDKObjectAlias
VRTK_SDKTransformModify
VRTK_SDKObjectState
VRTK_SDKInputOverride
VRTK_VelocityEstimator

Base SDK

Summary
SDK_Base
SDK_DescriptionAttribute
SDK_ScriptingDefineSymbolPredicateAttribute
SDK_BaseSystem
SDK_BaseHeadset
SDK_BaseController
SDK_BaseBoundaries

Fallback SDK

Summary
SDK_FallbackSystem
SDK_FallbackHeadset
SDK_FallbackController
SDK_FallbackBoundaries

Simulator SDK

Summary
SDK_SimSystem
SDK_SimHeadset
SDK_SimController
SDK_SimBoundaries

SteamVR SDK

Summary
SDK_SteamVRDefines
SDK_SteamVRSystem
SDK_SteamVRHeadset
SDK_SteamVRController
SDK_SteamVRBoundaries

OculusVR SDK

Summary
SDK_OculusDefines
SDK_OculusVRSystem
SDK_OculusVRHeadset
SDK_OculusVRController
SDK_OculusVRBoundaries

Daydream SDK

Summary
SDK_DaydreamDefines
SDK_DaydreamSystem
SDK_DaydreamHeadset
SDK_DaydreamController
SDK_DaydreamBoundaries

Ximmerse SDK

Summary
SDK_XimmerseDefines
SDK_XimmerseSystem
SDK_XimmerseHeadset
SDK_XimmerseController
SDK_XimmerseBoundaries

HyperealVR SDK

Summary
SDK_HyperealVRDefines
SDK_HyperealVRSystem
SDK_HyperealVRHeadset
SDK_HyperealVRController
SDK_HyperealVRBoundaries

WindowsMR SDK

Summary
SDK_WindowsMRDefines
SDK_WindowsMRSystem
SDK_WindowsMRHeadset
SDK_WindowsMRController
SDK_WindowsMRBoundaries

Unity SDK

Summary
SDK_UnitySystem
SDK_UnityHeadset
SDK_UnityController
SDK_UnityBoundaries
SDK_UnityControllerTracker
SDK_UnityHeadsetTracker

Powered by

Summary

VRTK/SDK/Fallback

The scripts used to provide a default/null fallback for any implemented SDK.