unity-xr
Set up XR Interaction Toolkit (XRI) for VR/AR
Install / Use
npx skills add Besty0728/Unity-Skills --skill xrInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
Development & EngineeringSupported Platforms
Tags
Our assessment of unity-xr
unity-xr scores 84/100 on our quality scale, 2894th of 4,700 Development & Engineering skills we index.
Its SKILL.md is 9.7 KB long, well organised into 19 sections with 2 code examples: a thorough specification that gives an agent plenty to work with.
With 1,781 GitHub stars, it is one of the more widely adopted skills in the catalogue.
Maintenance, license and trust
- The repository was last updated about 2 months ago, so unity-xr is actively maintained.
- Our last check on 2026-10-14 found the source still online.
- It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
- Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-10-01. Automated pattern scan on 2026-10-01. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
unity-xr compared with similar skills
All 4 of these similar skills score higher than unity-xr; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| unity-xr (this skill)by Besty0728 | 84 | 1.8k | 53d ago | SKILL.md |
| taste-skillby Leonxlnx | 100 | 116.8k | 8d ago | CLAUDE.md |
| ai-job-searchby ai-job-search-dev | 100 | 72.1k | today | CLAUDE.md |
| claude-howtoby luongnv89 | 100 | 47.3k | 2d ago | CLAUDE.md |
| lobehubby lobehub | 100 | 85.6k | today | MCP Server |
Frequently asked questions
- How do I install unity-xr?
- Run
npx skills add Besty0728/Unity-Skills --skill unity-xr. The install tabs above show the steps for each supported agent. - Which AI agents does unity-xr work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is unity-xr safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is unity-xr still maintained?
- The repository was last updated about 2 months ago, so unity-xr is actively maintained.
Skill content
View source on GitHubname: unity-xr description: Set up XR Interaction Toolkit (XRI) for VR/AR
Before calling any skill in this module: if you are about to call a skill with parameters guessed from its name or description, STOP — read this file (or fetch its schema via
GET /skills/recommend?includeSchema=true) first. If you already have the parameter definitions from recommend/schema, you may proceed straight to dryRun.
Triggers
- Building VR/AR interaction
- Setting up an XR rig
- Configuring grab/socket/ray interactors
- 构建 VR/AR 交互、搭建 XR rig、配置抓取/插槽/射线交互器
Unity XR Interaction Toolkit Skills
Use this module for XR Interaction Toolkit setup and configuration. All xr_* skills are reflection-based and support XRI 2.x on Unity 2022 and XRI 3.x on Unity 6+.
Requires:
com.unity.xr.interaction.toolkit. Hard rule: Read this file before the firstxr_*call in a session. Wrong property names can fail silently because the bridge is reflection-based.
Guardrails
Operating Mode (v1.9 three-tier):
- Approval (default): query/list/info skills (
xr_check_setup,xr_get_scene_report,xr_list_interactors,xr_list_interactables) run directly. Create/modify skills are FullAuto — onMODE_RESTRICTED, run the grant protocol; a successful/permission/grantexecutes the skill server-side and returns the result in the same response. - Auto / Bypass: SemiAuto and FullAuto run directly.
- This module contains no Delete / PlayMode / Reload /
RiskLevel="high"skills, so nothing is auto-classified as forbidden — every skill is reachable via grant. - When
com.unity.xr.interaction.toolkitis missing, everyxr_*skill returns theNoXRI()install instruction instead of executing. - Reflection-sensitive: property names on XRI components must match XRI 2.x/3.x exactly. A wrong field name on
xr_configure_interactable/xr_configure_haptics/xr_configure_interaction_layersis silently ignored. LoadAPI_REFERENCE.mdbefore issuing detailed property edits.
DO NOT (common hallucinations):
XRHand,XRPlayer,XRTeleporter,GrabInteractor,VRController,XRLocomotion, andXRManagerare not the runtime classes you want hereinteractable.OnGrab()/OnRelease()are not the XRI event model -> useselectEntered/selectExitedcontroller.vibrate()is not the documented route here -> configure haptics throughxr_configure_haptics- Do not assume physics Layer or Tag replaces
InteractionLayerMask - Do not guess component property names. Load
API_REFERENCE.mdbefore setting detailed XR component properties
Correct class names to anchor on:
XRInteractionManagerXROriginXRRayInteractorXRDirectInteractorXRSocketInteractorXRGrabInteractableXRSimpleInteractableTeleportationProviderTeleportationAreaTeleportationAnchorContinuousMoveProviderSnapTurnProviderContinuousTurnProviderTrackedDeviceGraphicRaycasterXRUIInputModuleTrackedPoseDriver
Routing:
- For non-XR Canvas UI creation -> use
ui - For architecture or lifecycle decisions in XR gameplay code -> load advisory modules such as
architecture,patterns,async, orscriptdesign - For exact component property names and full workflow examples -> load
API_REFERENCE.md
Skills
Setup and Diagnostics
| Skill | Use | Key parameters |
|-------|-----|----------------|
| xr_check_setup | Validate XR package, rig, managers, and scene prerequisites | verbose? |
| xr_setup_rig | Create XR Origin + camera + controllers | name, cameraYOffset? |
| xr_setup_interaction_manager | Add or find manager | none |
| xr_setup_event_system | Replace/add XR UI input stack | none |
| xr_get_scene_report | Report scene-side XR status | none |
Interactors and Interactables
| Skill | Use | Key parameters |
|-------|-----|----------------|
| xr_add_ray_interactor | Remote pointing / ray interaction | name, maxDistance?, lineType? |
| xr_add_direct_interactor | Close-range hand grab | name, radius? |
| xr_add_socket_interactor | Snap-to slot | name, showHoverMesh?, recycleDelay? |
| xr_add_grab_interactable | Rigidbody + collider + grab config | name, movementType?, throwOnDetach? |
| xr_add_simple_interactable | Hover/select without grab | name |
| xr_configure_interactable | Fine-tune interactable behavior | target + changed fields only |
| xr_list_interactors | List all scene interactors | none |
| xr_list_interactables | List all scene interactables | none |
Locomotion and XR UI
| Skill | Use | Key parameters |
|-------|-----|----------------|
| xr_setup_teleportation | Add teleport provider to XR Origin | none |
| xr_add_teleport_area | Mark a surface as teleportable | name, matchOrientation? |
| xr_add_teleport_anchor | Create fixed teleport destination | name, x/y/z, rotY?, matchOrientation? |
| xr_setup_continuous_move | Add stick locomotion | moveSpeed?, enableStrafe?, enableFly? |
| xr_setup_turn_provider | Add snap or smooth turn | turnType, turnAmount?, turnSpeed? |
| xr_setup_ui_canvas | Convert Canvas for XR interaction | name |
Feedback and Filtering
| Skill | Use | Key parameters |
|-------|-----|----------------|
| xr_configure_haptics | Set hover/select vibration | name, intensities, durations |
| xr_add_interaction_event | Wire interaction callback to target method | name, eventType, targetName, targetMethod |
| xr_configure_interaction_layers | Set InteractionLayerMask | name, layers, isInteractor |
Quick Start
import unity_skills as u
u.call_skill("xr_check_setup")
u.call_skill("xr_setup_rig", name="XR Origin")
u.call_skill("xr_add_ray_interactor", name="Right Controller")
u.call_skill("xr_add_direct_interactor", name="Left Controller")
u.call_skill("xr_setup_teleportation")
u.call_skill("xr_setup_turn_provider", turnType="Snap", turnAmount=45)
u.call_skill("xr_add_grab_interactable", name="MyCube", movementType="VelocityTracking")
Workflow Summary
Rig Setup
- Run
xr_check_setup. - Create the rig with
xr_setup_rig. - Ensure XR UI input exists with
xr_setup_event_system. - Add at least one interactor per controller.
Grab Setup
- Direct hand grab:
xr_add_direct_interactor+xr_add_grab_interactable - Distance grab:
xr_add_ray_interactor+xr_add_grab_interactable - Socket placement:
xr_add_socket_interactor+ grabbable object
movementType defaults matter:
VelocityTracking: best general-purpose physical grabKinematic: use for handles/tools that should not get stuckInstantaneous: best for precise remote grab
Locomotion Setup
- Teleport:
xr_setup_teleportation+xr_add_ray_interactor+xr_add_teleport_area/xr_add_teleport_anchor - Continuous locomotion:
xr_setup_continuous_move - Turn:
xr_setup_turn_provider
Comfort default: snap turn + moderate move speed (~2.0 m/s).
XR UI
- Convert Canvas with
xr_setup_ui_canvas - Ensure
xr_setup_event_system - Add a ray interactor on the controller that should click UI
Collider Configuration Matrix
This is the most important XR anti-hallucination table in the repo.
| Component | Collider required | isTrigger | Recommended collider | Reason |
|----------|-------------------|-------------|----------------------|--------|
| XRDirectInteractor | Yes | True | SphereCollider (0.1-0.25) | Overlap detection |
| XRRayInteractor | No | - | None | Uses raycasts |
| XRSocketInteractor | Yes | True | SphereCollider (0.1-0.3) | Snap zone |
| XRGrabInteractable | Yes | False | BoxCollider or convex MeshCollider | Physics + ray target |
| XRSimpleInteractable | Yes | False | BoxCollider | Selection detection |
| TeleportationArea | Yes | False | MeshCollider or BoxCollider | Surface raycast target |
| TeleportationAnchor | Yes | False | Thin BoxCollider | Point raycast target |
Critical rules:
XRGrabInteractableneeds aRigidbody.- A grabbable collider must not be trigger.
- A direct interactor collider must be trigger.
- Dynamic mesh colliders must be convex.
- Socket colliders should be trigger-only overlap zones.
Version Compatibility
| Topic | XRI 2.x | XRI 3.x |
|------|---------|---------|
| Main namespace style | root namespace | split sub-namespaces |
| Rig type | XROrigin | XROrigin |
| Locomotion core | LocomotionSystem | LocomotionMediator |
| Controller type | ActionBasedController | ActionBasedController |
| Bridge behavior | Reflection helper falls back automatically | Reflection helper prefers 3.x first |
Important Notes
- Scenes should normally have exactly one
XRInteractionManager. - Most locomotion skills assume an
XROriginalready exists. - Package installation or reconfiguration can trigger Domain Reload. Wait before retrying XR calls.
- Use
InteractionLayerMaskfor interactor/interactable filtering. - For custom XR scripts, prefer XRI lifecycle hooks and events over
Update()polling when possible.
Minimal Example
import unity_skills as u
u.call_skill("xr_setup_rig", name="XR Origin", cameraYOffset=1.36)
u.call_skill("xr_setup_event_system")
u.call_skill("xr_add_ray_interactor", name="Right Controller", maxDistance=30, lineType="StraightLine")
u.call_skill("xr_add_grab_interactable", name="Tool", movementType="VelocityTracking", throwOnDetach=True)
u.call_skill("xr_configure_haptics", name="Right Controller", selectIntensity=0.7, selectDuration=0.15)
Exact Signatures
Exact names, parameters, defaults, and returns are defined by GET /skills/schema or unity_skills.get_skill_schema(), not by this file.
Before configuring XR component properties in detail, load API_REFERENCE.md. XR property names are reflection-sensitive.
Related Skills
taste-skill
116.8kAgent skills that give coding agents taste: art direction, reference images and a browser check instead of generic AI pages
ai-job-search
72.1kThe job search that runs on your machine. AI job application framework built on Claude Code: evaluate postings, tailor CVs, write cover letters, prep interviews. Fork it and own it.
claude-howto
47.3kA visual, example-driven guide to Claude Code — from basic concepts to advanced agents, with copy-paste templates that bring immediate value.
lobehub
85.6k🤯 LobeHub - Super-Agents on Your Team. Add super-agents to the chats your team already uses.They take on work by themselves and get better every week.
Languages
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
