AR.js README

The project's README from github.com/jeromeetienne/AR.js. As one markdown file: README.md.

AR.js - Augmented Reality for the Web

Logo by Simon Poulter


npm npm Build Status
Gitter chat Patreon donate button Twitter Follow Twitter Follow

AR.js is a lightweight library for Augmented Reality on the Web, coming with features like Marker based and Location based AR.

⚠️ This project repository has been moved to a Github organization account ⚠️

The old repository (the one you are now) will be left up, so all links and CDNs will continue to be available, but this version will not be updated anymore.

⚠️ AR.js repository has been moved, please check it out at: https://github.com/AR-js-org/AR.js ⚠️

Please, open issues and Pull Requests on the new repository: https://github.com/AR-js-org/AR.js

Thank you.

Why move AR.js

AR.js was among those great projects, with great technologies, often disruptive ones, that eventually were lacking from documentation and support.

We tried to carry on the author's terrific work by maintaining this project, handling new versions, issues, pull requests, the community itself. We continued promoting this project through blogs, Medium articles, socials. And we released new features, like the Location Based AR that was not initially present on AR.js.

Now, that we are also ready to ship a new feature, Image Tracking, we feel ready to start a new path, and so we have created a new repository that is not owned by individuals, but by one organization.

Anyone can be added to it, and more people will manage it, in order to make the project more collaborative and avoid "bottlenecks".

We feel this is a new chapter for this project, to not let it die alone. We feel the current Web Augmented Reality market really needed something like AR.js, but only if owned by no-one apart from the community itself. A technology free and Open Source, created by users for the users.

We'd like to thank all contributors and passionate people who help us in this journey.

On the new repository, you will find all the feature you already had here, plus:

See you on new AR.js org.

Nicolò Carpignoli


AR.js is a free and Open Source software, created by @jeromeetienne and maintained by @nicolocarpignoli. Check the LICENSE.txt to learn more.

AR.js (jeromeetienne/AR.js)

Searching Database…

15.8K ·GitHub
What is this?AR.js is a lightweight library for augmented reality on the Web. It lets you build AR experiences that run right in the browser, with marker-based and location-based AR support.
So it's a JavaScript library I code with, not a mobile app?Exactly — you include it in web pages and the AR runs in the visitor's browser. It builds on A-Frame and three.js, so you describe 3D scenes instead of writing native mobile code.
How do I add it to a project?Include the AR.js script in your web page and open it in a browser — no native SDK or app build. The CDN links from this repository remain available, and the maintained repo ships fresh docs and examples.
Is this repository still the one to use?No — AR.js moved to a community-run GitHub organization. This old repo stays up only so existing links keep working; for updates, issues and pull requests, go to the new repository.
Will it run smoothly on a phone?That is the project's headline claim: efficient web AR at 60fps on mobile. Since everything runs in the browser, users just open your page — nothing to install from an app store.
Is it free to use in my own projects?Yes — AR.js is free, open-source software under the MIT license. It was created by Jerome Etienne and is maintained by Nicolo Carpignoli.
What AR modes does it support?Marker-based AR, where the camera tracks printed markers, and location-based AR, which anchors content to real-world coordinates. The maintained version adds image tracking as a third mode.
Why did the project move to a GitHub organization?So the community, not individuals, owns it: anyone can be added, more people manage releases and issues, and the project avoids the bottleneck of a single maintainer.
What does the maintained version add over this one?Everything already here plus Image Tracking, more examples to learn by doing, a new contributive place to get started, and a new documentation site.
Size
319.7 MB
Stars
15.8K
Updated
CommitMar 15
Age
9y
Commits · 90 Days