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

These docs are for v3.2.0. Click to read the latest docs for v3.3.0.

Overview

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

Prefabs

Summary
VR Simulator
Frames Per Second Viewer
Object Tooltip
Controller Tooltips
Controller Rigidbody Activator
Snap Drop Zone
Radial Menu
Radial Menu Controller
Independent Radial Menu Controller
Destination Point
Pointer Direction Indicator
Console Viewer
Panel Menu Controller
Panel Menu Item 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_RoomExtender

Object Control Actions

Summary
VRTK_BaseObjectControlAction
VRTK_SlideObjectControlAction
VRTK_RotateObjectControlAction
VRTK_SnapRotateObjectControlAction
VRTK_WarpObjectControlAction

Interactions

Summary
VRTK_ControllerEvents
VRTK_ControllerHighlighter
VRTK_ControllerHaptics
VRTK_InteractControllerAppearance
VRTK_InteractTouch
VRTK_InteractGrab
VRTK_InteractUse
VRTK_InteractableObject
VRTK_ObjectAppearance
VRTK_InteractHaptics
VRTK_ObjectAutoGrab
VRTK_ObjectTouchAutoInteract

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

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

3D Controls

Summary
VRTK_Control
VRTK_Button
VRTK_Chest
VRTK_Door
VRTK_Drawer
VRTK_Knob
VRTK_Wheel
VRTK_Lever
VRTK_SpringLever
VRTK_Slider
VRTK_ContentHandler

Utilities

Summary
VRTK_SDKManager
VRTK_SDKSetupSwitcher
VRTK_SDKSetup
VRTK_SDKInfo
VRTK_DeviceFinder
VRTK_SharedMethods
VRTK_PolicyList
VRTK_CustomRaycast
VRTK_AdaptiveQuality
VRTK_ObjectFollow
VRTK_RigidbodyFollow
VRTK_TransformFollow
VRTK_SDKObjectAlias
VRTK_SDKTransformModify
VRTK_Simulator

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

Powered by

Summary

VRTK/Scripts/Utilities

A collection of scripts that provide useful functionality to aid the creation process.