{"id":15049765,"url":"https://github.com/mozilla/aframe-xr","last_synced_at":"2025-10-04T12:30:28.936Z","repository":{"id":57174332,"uuid":"109352213","full_name":"mozilla/aframe-xr","owner":"mozilla","description":"INACTIVE - http://mzl.la/ghe-archive - System / Components to build WebXR experiences with A-frame","archived":true,"fork":false,"pushed_at":"2019-03-30T14:30:19.000Z","size":1928,"stargazers_count":184,"open_issues_count":0,"forks_count":35,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-01-16T16:26:22.655Z","etag":null,"topics":["inactive","unmaintained"],"latest_commit_sha":null,"homepage":"https://mozilla.github.io/aframe-xr/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mozilla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-03T04:30:28.000Z","updated_at":"2024-10-18T07:55:31.000Z","dependencies_parsed_at":"2022-08-28T20:52:24.937Z","dependency_job_id":null,"html_url":"https://github.com/mozilla/aframe-xr","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Faframe-xr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Faframe-xr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Faframe-xr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozilla%2Faframe-xr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mozilla","download_url":"https://codeload.github.com/mozilla/aframe-xr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235252702,"owners_count":18960467,"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":["inactive","unmaintained"],"created_at":"2024-09-24T21:22:19.718Z","updated_at":"2025-10-04T12:30:28.152Z","avatar_url":"https://github.com/mozilla.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aframe-xr\n\n[![Version](http://img.shields.io/npm/v/aframe-xr.svg?style=flat-square)](https://npmjs.org/package/aframe-xr)\n[![License](http://img.shields.io/npm/l/aframe-xr.svg?style=flat-square)](https://npmjs.org/package/aframe-xr)\n\nSystem \u0026amp; components to build [WebXR](https://github.com/mozilla/webxr-api) experiences with [A-frame](https://github.com/aframevr/aframe)\n\n## Running the examples\n\nVisit [this URL with all the examples](https://mozilla.github.io/aframe-xr/) or:\n\n\u003ca href=\"https://docs.npmjs.com/getting-started/installing-node\"\u003eInstall npm\u003c/a\u003e and then run the following:\n\n```\n$ npm install\n$ npm start\n```\n\n## Supported browsers\n\n### AR\n\n  - ARKit: Mozilla's [ARKit based iOS app](https://github.com/mozilla/webxr-ios)\n  - ARCore: Google's [WebARonARCore Android app](https://github.com/google-ar/WebARonARCore)\n\n### VR\n\n  - Daydream: [Chrome for Android](https://webvr.rocks/chrome_for_android)\n  - Gear VR: [Oculus Browser](https://webvr.rocks/oculus_browser)\n  - HTC Vive / Oculus Rift: [Firefox](https://webvr.rocks/firefox)\n  - Windows Mixed Reality: [Microsoft Edge](https://webvr.rocks/microsoft_edge)\n\n## Configuration\n\n```html\n\u003ca-scene\u003e\n  \u003ca-entity xr=\"ar: true; vr: false; magicWindow: false\"\u003e\u003c/a-entity\u003e\n  \u003c!-- ... --\u003e\n\u003c/a-scene\u003e\n```\n\n## Documentation\n\n### xr System\n\n| Property                        | Default | Description                                          |\n|---------------------------------|---------|------------------------------------------------------|\n| arAutostart                     | true    | Start AR if is the unique display available          |\n| arLightEstimate                 | false   | Modify lights intensity with the light estimation    |\n\n### xr Component\n\n| Property                        | Default | Description                                          |\n|---------------------------------|---------|------------------------------------------------------|\n| ar                              | true    | If the entity is visible on AR mode                  |\n| magicWindow                     | true    | If the entity is visible on magic window mode        |\n| vr                              | true    | If the entity is visible on VR mode                  |\n\n### ar-mode-ui Component\n\nBased on the [vr-mode-ui](https://github.com/aframevr/aframe/blob/v0.7.0/src/components/scene/vr-mode-ui.js) component\n\n| Property                        | Default | Description                                          |\n|---------------------------------|---------|------------------------------------------------------|\n| enabled                         | true    | Whether or not to display UI related to entering AR. |\n\n## Usage\n\n### Browser\nInclude A-Frame (for now, we are using master version - soon an official published version), followed by `three.xr.js` \u0026amp; `aframe-xr`:\n```html\n\u003cscript src=\"aframe-master.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"three.xr.js\"\u003e\u003c/script\u003e\n\u003cscript src='aframe-xr.js'\u003e\u003c/script\u003e\n```\n\n#### npm\n\nInstall via npm:\n\n```bash\nnpm install aframe-xr\n```\n\nThen require and use.\n\n```js\nrequire('aframe');\nrequire('aframe-xr');\n```\n\nUntil A-Frame 0.8.0 is released, make sure to reference the master version of A-Frame in `package.json`:\n\n```json\n \"dependencies\": {\n    \"aframe\": \"github:aframevr/aframe#master\"\n  }\n ```\n \n Or reference the A-Frame included with `aframe-xr` directly:\n \n ```js\nrequire('aframe-xr/vendor/aframe-master.js');\nrequire('aframe-xr');\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla%2Faframe-xr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmozilla%2Faframe-xr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozilla%2Faframe-xr/lists"}