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
Что это такое?AR.js — это лёгкая библиотека для дополненной реальности в вебе. С её помощью можно делать AR-приложения, которые работают прямо в браузере, с поддержкой AR по маркерам и по местоположению.
То есть это JavaScript-библиотека, с которой я пишу код, а не мобильное приложение?Именно так — вы подключаете её к веб-страницам, и дополненная реальность работает в браузере посетителя. Она построена на A-Frame и three.js, поэтому вы описываете 3D-сцены, а не пишете нативный код для мобильных.
Как подключить её к проекту?Добавьте скрипт AR.js на свою веб-страницу и откройте её в браузере — нативный SDK или сборка приложения не нужны. Ссылки на CDN из этого репозитория по-прежнему работают, а в поддерживаемом репозитории выходят свежие документация и примеры.
Этот репозиторий ещё актуален?Нет — AR.js переехал в организацию на GitHub, которую поддерживает сообщество. Старый репозиторий оставили только для того, чтобы существующие ссылки продолжали работать; за обновлениями, вопросами и пулл-реквестами идите в новый репозиторий.
Он будет нормально работать на телефоне?Это и есть главное заявление проекта: эффективный веб-AR на 60fps на мобильных устройствах. Поскольку всё работает в браузере, пользователю достаточно просто открыть вашу страницу — ничего не нужно устанавливать из магазина приложений.
Можно бесплатно использовать в своих проектах?Да — AR.js это бесплатный проект с открытым исходным кодом под лицензией MIT. Его создал Jerome Etienne, а поддерживает Nicolo Carpignoli.
Какие режимы AR он поддерживает?AR по маркерам, где камера отслеживает распечатанные маркеры, и AR по местоположению, где контент привязывается к реальным координатам. В поддерживаемой версии третьим режимом добавлено распознавание изображений (Image Tracking).
Почему проект переехал в организацию на GitHub?Чтобы проектом владело сообщество, а не отдельные люди: добавить в организацию может любой, релизами и вопросами занимается больше людей, и проект не зависит от одного человека.
Что поддерживаемая версия добавляет к этой?Всё то же самое плюс Image Tracking, больше примеров, на которых можно учиться на практике, новое место для желающих внести вклад и новый сайт с документацией.
Size
319.7 MB
Stars
15.8K
Updated
CommitMar 15
Age
9y
Commits · 90 Days