https://github.com/mozilla/aframe-xr
INACTIVE - http://mzl.la/ghe-archive - System / Components to build WebXR experiences with A-frame
https://github.com/mozilla/aframe-xr
inactive unmaintained
Last synced: 3 months ago
JSON representation
INACTIVE - http://mzl.la/ghe-archive - System / Components to build WebXR experiences with A-frame
- Host: GitHub
- URL: https://github.com/mozilla/aframe-xr
- Owner: mozilla
- License: mit
- Archived: true
- Created: 2017-11-03T04:30:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-30T14:30:19.000Z (almost 7 years ago)
- Last Synced: 2025-01-16T16:26:22.655Z (12 months ago)
- Topics: inactive, unmaintained
- Language: JavaScript
- Homepage: https://mozilla.github.io/aframe-xr/
- Size: 1.84 MB
- Stars: 184
- Watchers: 33
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# aframe-xr
[](https://npmjs.org/package/aframe-xr)
[](https://npmjs.org/package/aframe-xr)
System & components to build [WebXR](https://github.com/mozilla/webxr-api) experiences with [A-frame](https://github.com/aframevr/aframe)
## Running the examples
Visit [this URL with all the examples](https://mozilla.github.io/aframe-xr/) or:
Install npm and then run the following:
```
$ npm install
$ npm start
```
## Supported browsers
### AR
- ARKit: Mozilla's [ARKit based iOS app](https://github.com/mozilla/webxr-ios)
- ARCore: Google's [WebARonARCore Android app](https://github.com/google-ar/WebARonARCore)
### VR
- Daydream: [Chrome for Android](https://webvr.rocks/chrome_for_android)
- Gear VR: [Oculus Browser](https://webvr.rocks/oculus_browser)
- HTC Vive / Oculus Rift: [Firefox](https://webvr.rocks/firefox)
- Windows Mixed Reality: [Microsoft Edge](https://webvr.rocks/microsoft_edge)
## Configuration
```html
```
## Documentation
### xr System
| Property | Default | Description |
|---------------------------------|---------|------------------------------------------------------|
| arAutostart | true | Start AR if is the unique display available |
| arLightEstimate | false | Modify lights intensity with the light estimation |
### xr Component
| Property | Default | Description |
|---------------------------------|---------|------------------------------------------------------|
| ar | true | If the entity is visible on AR mode |
| magicWindow | true | If the entity is visible on magic window mode |
| vr | true | If the entity is visible on VR mode |
### ar-mode-ui Component
Based on the [vr-mode-ui](https://github.com/aframevr/aframe/blob/v0.7.0/src/components/scene/vr-mode-ui.js) component
| Property | Default | Description |
|---------------------------------|---------|------------------------------------------------------|
| enabled | true | Whether or not to display UI related to entering AR. |
## Usage
### Browser
Include A-Frame (for now, we are using master version - soon an official published version), followed by `three.xr.js` & `aframe-xr`:
```html
```
#### npm
Install via npm:
```bash
npm install aframe-xr
```
Then require and use.
```js
require('aframe');
require('aframe-xr');
```
Until A-Frame 0.8.0 is released, make sure to reference the master version of A-Frame in `package.json`:
```json
"dependencies": {
"aframe": "github:aframevr/aframe#master"
}
```
Or reference the A-Frame included with `aframe-xr` directly:
```js
require('aframe-xr/vendor/aframe-master.js');
require('aframe-xr');
```