Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Latest commit

 

History

History
53 lines (41 loc) · 2.29 KB

README.md

File metadata and controls

53 lines (41 loc) · 2.29 KB

aframe-ar

Basic A-Frame support for browser-based augmented reality (AR), supporting the new three.ar.js library and WebARonARKit/Core browsers, as well as WebXR Viewer.

By simply adding the ar component to your A-Frame scene declaration:

<a-scene ar>
...
</a-scene>

aframe-ar will, when using a supported browser, take over the scene camera using information from ARKit / ARCore.

Basic usage:

<!-- First, include whichever version of A-Frame you like. -->
<script src="https://rawgit.com/aframevr/aframe/master/dist/aframe-master.min.js"></script>
<!-- Next, include three.ar.js; add the speech recognition polyfill if you want. -->
<script src="https://rawgit.com/google-ar/three.ar.js/master/dist/three.ar.js"></script>
<!-- Last, include aframe-ar. -->
<script src="https://rawgit.com/chenzlabs/aframe-ar/master/dist/aframe-ar.js"></script>

<!-- Place the ar component on your scene, and the camera will use AR by default. -->
<a-scene ar>
  <a-sphere radius="0.01" position="0 0.005 -0.5"></a-sphere>
<a-scene>  

Examples:

Basic AR camera: https://aframe-ar.glitch.me

ar-raycaster usage: https://aframe-ar-raycaster-logo-test.glitch.me/ar.html

Plane detection and visualization: https://aframe-ar-plane.glitch.me

https://aframe-ar-dragonites.glitch.me with many thanks to Twitter user @uveavanto et al.

Reference links: