{"id":13725359,"url":"https://github.com/pmndrs/xr","last_synced_at":"2025-05-13T00:34:44.459Z","repository":{"id":36958339,"uuid":"262879465","full_name":"pmndrs/xr","owner":"pmndrs","description":"🤳 VR/AR for react-three-fiber","archived":false,"fork":false,"pushed_at":"2025-04-29T18:32:29.000Z","size":166032,"stargazers_count":2404,"open_issues_count":34,"forks_count":171,"subscribers_count":39,"default_branch":"main","last_synced_at":"2025-05-09T07:22:20.656Z","etag":null,"topics":["ar","react","react-three-fiber","vr","webxr"],"latest_commit_sha":null,"homepage":"https://pmndrs.github.io/xr/docs/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pmndrs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"bbohlender","polar":"bbohlender"}},"created_at":"2020-05-10T21:34:01.000Z","updated_at":"2025-05-09T03:21:54.000Z","dependencies_parsed_at":"2024-01-23T22:09:13.932Z","dependency_job_id":"531b70d8-8af1-45f9-935b-5578942e58d2","html_url":"https://github.com/pmndrs/xr","commit_stats":{"total_commits":130,"total_committers":10,"mean_commits":13.0,"dds":"0.25384615384615383","last_synced_commit":"c49cf8809b0f274f9711102af7b862d822d0de13"},"previous_names":["pmndrs/xr"],"tags_count":118,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmndrs%2Fxr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmndrs%2Fxr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmndrs%2Fxr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmndrs%2Fxr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmndrs","download_url":"https://codeload.github.com/pmndrs/xr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253391393,"owners_count":21900948,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ar","react","react-three-fiber","vr","webxr"],"created_at":"2024-08-03T01:02:20.476Z","updated_at":"2025-05-13T00:34:39.445Z","avatar_url":"https://github.com/pmndrs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/bbohlender","https://polar.sh/bbohlender"],"categories":["TypeScript","JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/getting-started/logo.svg\" width=\"100\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003exr\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eTurn any R3F app into an interactive immersive experience.\u003c/h3\u003e\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://npmjs.com/package/@react-three/xr\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@react-three/xr?style=flat\u0026colorA=000000\u0026colorB=000000\" alt=\"NPM\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://npmjs.com/package/@react-three/xr\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dt/@react-three/xr.svg?style=flat\u0026colorA=000000\u0026colorB=000000\" alt=\"NPM\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/pmndrs\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/follow/pmndrs?label=%40pmndrs\u0026style=flat\u0026colorA=000000\u0026colorB=000000\u0026logo=twitter\u0026logoColor=000000\" alt=\"Twitter\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/ZZjjNvJ\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/740090768164651008?style=flat\u0026colorA=000000\u0026colorB=000000\u0026label=discord\u0026logo=discord\u0026logoColor=000000\" alt=\"Discord\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n```bash\nnpm install three @react-three/fiber @react-three/xr@latest\n```\n\n## What does it look like?\n\n| A simple scene with a mesh that toggles its material color between `\"red\"` and `\"blue\"` when clicked through touching or pointing. | ![recording of interacting with the code below](./docs/getting-started/basic-example.gif) |\n| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n\n```tsx\nimport { Canvas } from '@react-three/fiber'\nimport { XR, createXRStore } from '@react-three/xr'\nimport { useState } from 'react'\n\nconst store = createXRStore()\n\nexport function App() {\n  const [red, setRed] = useState(false)\n  return (\n    \u003c\u003e\n      \u003cbutton onClick={() =\u003e store.enterAR()}\u003eEnter AR\u003c/button\u003e\n      \u003cCanvas\u003e\n        \u003cXR store={store}\u003e\n          \u003cmesh pointerEventsType={{ deny: 'grab' }} onClick={() =\u003e setRed(!red)} position={[0, 1, -1]}\u003e\n            \u003cboxGeometry /\u003e\n            \u003cmeshBasicMaterial color={red ? 'red' : 'blue'} /\u003e\n          \u003c/mesh\u003e\n        \u003c/XR\u003e\n      \u003c/Canvas\u003e\n    \u003c/\u003e\n  )\n}\n```\n\n### How to enable XR for your @react-three/fiber app?\n\n1. `const store = createXRStore()` create a xr store\n2. `store.enterAR()` call enter AR when clicking on a button\n3. `\u003cXR\u003e...\u003c/XR\u003e` wrap your content with the XR component\n\n... or read this guide for [converting a react-three/fiber app to XR](https://docs.pmnd.rs/xr/getting-started/convert-to-xr).\n\n## Tutorials\n\n- 💾 [Store](https://docs.pmnd.rs/xr/tutorials/store)\n- 👌 [Interactions](https://docs.pmnd.rs/xr/tutorials/interactions)\n- 🔧 [Options](https://docs.pmnd.rs/xr/tutorials/options)\n- 🧊 [Object Detection](https://docs.pmnd.rs/xr/tutorials/object-detection)\n- ✴ [Origin](https://docs.pmnd.rs/xr/tutorials/origin)\n- 🪄 [Teleport](https://docs.pmnd.rs/xr/tutorials/teleport)\n- 🕹️ [Gamepad](https://docs.pmnd.rs/xr/tutorials/gamepad)\n- ➕ [Secondary Input Sources](https://docs.pmnd.rs/xr/tutorials/secondary-input-sources)\n- 📺 [Layers](https://docs.pmnd.rs/xr/tutorials/layers)\n- 🎮 [Custom Controller/Hands/...](https://docs.pmnd.rs/xr/tutorials/custom-inputs)\n- ⚓️ [Anchors](https://docs.pmnd.rs/xr/tutorials/anchors)\n- 📱 [Dom Overlays](https://docs.pmnd.rs/xr/tutorials/dom-overlay)\n- 🎯 [Hit Test](https://docs.pmnd.rs/xr/tutorials/hit-test)\n- ⛨ [Guards](https://docs.pmnd.rs/xr/tutorials/guards)\n\n## Roadmap\n\n- 🤳 XR Gestures\n- 🕺 Tracked Body\n- ↕ react-three/controls\n\n## Migration guides\n\n- from [@react-three/xr v5](https://docs.pmnd.rs/xr/migration/from-react-three-xr-5)\n- from [natuerlich](https://docs.pmnd.rs/xr/migration/from-natuerlich)\n\n## Sponsors\n\nThis project is supported by a few companies and individuals building cutting-edge 3D Web \u0026 XR experiences. Check them out!\n\n![Sponsors Overview](https://bbohlender.github.io/sponsors/screenshot.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmndrs%2Fxr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmndrs%2Fxr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmndrs%2Fxr/lists"}