README.md

    AR.js - Augmented Reality for the Web

    Augmented Website

    npm npm
    Gitter chat Patreon donate button Twitter Follow

    I am focusing hard on making AR for the web a reality. This repository is where I publish the code. Contact me anytime @jerome_etienne. Stuff are still moving fast, We reached a good status tho. An article has been published on uploadvr. So I wanted to publish thus people can try it and have fun with it :)

    • Very Fast : it runs efficiently even on phones. 60 fps on my 2 year-old phone!
    • Web-based : It is a pure web solution, so no installation required. Full javascript based on three.js + jsartoolkit5
    • Open Source : It is completely open source and free of charge!
    • Standards : It works on any phone with webgl and webrtc

    AR.js 1.0 Video

    Try it on Mobile

    It works on all platforms. Android, IOS and window phone. It run any browser with WebGL and WebRTC. (for IOS, you need to update to ios11)

    To try on your phone is only 2 easy steps, check it out!

    1. Open this hiro marker image in your desktop browser.
    2. Open this augmented reality webapps in your phone browser, and point it to your screen.

    You are done! It will open a webpage which read the phone webcam, localize a hiro marker and add 3d on top of it, as you can see below.

    screenshot

    Standing on the Shoulders of Giants

    So we shown it is now possible to do 60fps web-based augmented reality on a phone. This is great for sure but how did we get here ? By standing on the shoulders of giants! It is thanks to the hard work from others, that we can today reach this mythic 60fps AR. So i would like to thanks :

    • three.js for being a great library to do 3d on the web.
    • artoolkit! years of development and experiences on doing augmented reality
    • emscripten and asm.js! thus we could compile artoolkit c into javascript
    • chromium! thanks for being so fast!

    Only thanks to all of them, i could do my part : Optimizing performance from 5fps on high-end phone, to 60fps on 2years old phone.

    After all this work done by a lot of people, we have a web-based augmented reality solution fast enough for mobile!

    Now, many people got a phone powerful enough to do web AR in their pocket. I think this performance improvement makes web AR a reality. i am all exited by what people are gonna with it :)

    Performance

    We are still early in the project but here are some initial numbers to give you an idea.

    Obviously you mileage may vary. The performance you get will depend on 3 things: How heavy your 3D is, How you tune your parameters and the hardware that you are using.

    screenshot

    Full Featured Marker based

    With this project, we bring more performance to artoolkit. artoolkit is a software with years of experience doing augmented reality. It is able to do a lot!

    It is marker based. It supports a wide range of markers: multiple types of markers pattern/barcode multiple independent markers at the same time, or multiple markers acting as a single marker up to you to choose.

    What’s New?

    Recently, we’ve been getting creative and working on developing new things with AR.js. One of them is playing around with shadows, syncing the position of virtual lights with reality for a more life-like finish: screen shot 2017-03-16 at 21 06 24

    We’ve been collaborating very closely with Fredrick Blomqvist. His input has had a great impact on AR.js innovation and we want to thank him. Together, we’ve been implementing refraction, giving the 3d a transparent/glassy effect. It ended up having a nice polished look. What do you guys think? screen shot 2017-03-06 at 16 31 28

    Other crazy ideas we’ve been working on include a hole in the wall and a portal into another world. We want to take AR.js to new dimensions. screen shot 2017-03-12 at 15 19 51 screen shot 2017-03-07 at 10 08 39

    principles

    • "Shared #ar is a lot more real than solo #AR." - Augmented reality principle tweet
    • "The marker must be a portal from where the virtual emerges." by @AndraConnect - #AR principles at dinner 😏 tweet

    Status

    • At the three.js level is the main one. It is working well and efficiently
    • a-frame component - it export <a-marker> tag. It becomes real easy to use. It allows the things three.js extension does. Here are some slides aframe-artoolkit
    • webvr-polyfill: it is kind of working - still a work-in-progress

    Augmented reality for the web in less than 10 lines of html

    A-Frame magic :) All details are explained in this super post "Augmented Reality in 10 Lines of HTML - AR.js with a-frame magic" by @AndraConnect.

    <!doctype HTML>
    <html>
    <script src="https://aframe.io/releases/0.6.1/aframe.min.js"></script>
    <script src="https://cdn.rawgit.com/jeromeetienne/AR.js/1.5.0/aframe/build/aframe-ar.js"> </script>
      <body style='margin : 0px; overflow: hidden;'>
        <a-scene embedded arjs>
      	<a-marker preset="hiro">
                <a-box position='0 0.5 0' material='color: black;'></a-box>
      	</a-marker>
      	<a-entity camera></a-entity>
        </a-scene>
      </body>
    </html>

    See on codepen or bl.ocks.org

    Posts on medium

    We started a AR.js blog, thus we can write about all the crazy ideas related to AR.js.

    Great Posts by Users

    Augmented Website

    Seminal post explaining the concept. The service is available webxr.io/augmented-website

    Augmented Website

    Examples

    Some applications:

    ALL EXAMPLES

    Folders

    • /three.js is the extension to use it with pure three.js
    • /aframe is the extension to use it with a-frame
    • /webvr-polyfill is the WebVR polyfill so you can reuse your #AR / #VR content easily

    Licenses

    It is all open source ! jsartoolkit5 is under LGPLv3 license and additional permission. And All my code in AR.js repository is under MIT license. :)

    For legal details, be sure to check jsartoolkit5 license and AR.js license.

    Change Log

    CHANGELOG.md

    What's Next ?

    We did good on performance, but there are still a lot of room for optimisation. Using webworkers would increase cpu usage. Compiling in webassembly instead of asm.js should improve loading time and likely cpu performance. And obviously, we can still do more parameters tweaking :)

    I would like people start experience augmented reality and play with it. This is highly creative! Just look at this puzzle game in #AR playing with mirror and laser beam. You could do it with AR.js, so opensource and running on normal phones, no need to buy a new device. isn't that great!

    Augmented reality on phone have applications in many fields: history education , science or gaming. I exited to see what people will do with AR.js :)

    Browser Support

    Demo tested on the following browser setups:

    • Desktop Chrome with webcam and 2 tabs (one for Hero, one for result) (works!)
    • Android native 4.4.2 (doesn't work, doesn't ask for permission to use camera. I see white background and text)
    • Android native 5.0 (doesn't work, doesn't ask for permission, I see white background and text)
    • Chrome on Android 4.4.2 (works!)
    • Chrome on Android 5.0 (doesn't work, asks for permission, I see black background, text and a chart)
    • Safari and Chrome on iOS 8.2 (iPad) (doesn't work, doesn't ask for permission, I see white background and text)
    • Microsoft Edge on Windows 10 (Chrome on Google Pixel phone to view hologram)

    Credits: @HelloDeadline, @sorianog

    Future

    FUTURE.md

    FAQ

    FAQ.md

    How To Release ?

    This one is mainly for me to remember :)

    # Update CHANGELOG.md - remove the -dev into version
    atom CHANGELOG.md
    
    # replace REVISION to the proper version, search/replace on the version string should do it
    atom three.js/src/threex/threex-artoolkitcontext.js package.json README.md
    
    # Rebuild and minify everything - aka a-frame and three.js
    make minify
    
    # Commit everything
    git add . && git commit -a -m 'Last commit before release' && git push
    
    # Go to master branch
    git checkout master
    
    # Merge dev branch into master branch
    git merge dev
    
    # tag the release
    git tag 1.5.5
    
    # push the tag on github
    git push origin --tags
    
    # push commits tag on github
    git push
    
    # update npm package.json
    npm publish
    
    # Come back to dev branch
    git checkout dev
    
    # Update CHANGELOG.md - start new dev version
    atom CHANGELOG.md
    
    # update the a-frame codepen if needed
    open "https://codepen.io/jeromeetienne/pen/mRqqzb?editors=1000#0"

    项目简介

    Efficient Augmented Reality for the Web - 60fps on mobile!

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/jeromeetienne/AR.js

    发行版本

    当前项目没有发行版本

    贡献者 54

    全部贡献者

    开发语言

    • HTML 56.8 %
    • JavaScript 33.8 %
    • Makefile 2.1 %
    • C 1.8 %
    • Brainfuck 1.8 %