AR.js
Efficient Augmented Reality for the Web - 60fps on mobile!
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- aframe-ar.js
- aframe-ar.min.js
- basic.html
- README.md
- aframe.ply
- pikachu.ply
- seating.ply
- stadium.ply
- aframe-logo-model.html
- 360_topaz.png
- tree1.dae
- materials.mtl
- model.obj
- aframe-shadow-plane.js
- aframe-city-360.mp4
- cute-fox-model.html
- README.md
- two-ways-portal-door.html
- vr-camera-controls.html
- eyeM2.bmp
- miku_v2.pmd
- readme.txt
- readme_miku_v2.txt
- readme.txt
- readme_wavefile.txt
- readme_wavefile_camera.txt
- wavefile_camera.vmd
- wavefile_v2.vmd
- a-mmd.js
- full-hatsune-original.html
- index.html
- old-full-hatsune.html
- old-hatsune.html
- mapbox-terrain.js
- index.html
- README.md
- aframe-minecraft.js
- aframe-minecraft.min.js
- aframe-minecraft.html
- testbed.html
- aframe-minecraft.js
- Makefile
- README.md
- TODO.md
- require.js
- three.min.js
- animation.html
- basic.html
- controls.html
- loadskin.html
- player.html
- requirejs.html
- explosion.png
- items.png
- 3djesus.png
- agentsmith.png
- batman.png
- char.png
- god.png
- Iron-Man-Minecraft-Skin.png
- jetienne.png
- Joker.png
- Mario.png
- martialartist.png
- robocop.png
- Sonicthehedgehog.png
- Spiderman.png
- Superman.png
- theflash.png
- woody.png
- NOTES.md
- package.require.js
- README.md
- threex.animation.js
- threex.animations.js
- threex.minecraft.js
- threex.minecraftbubble.js
- threex.minecraftcharbodyanim.js
- threex.minecraftcharheadanim.js
- threex.minecraftcontrols.js
- threex.minecraftnickname.js
- minecraft-launch-demo-old.html
- minecraft-launch-demo.html
- minecraft.html
- 360_topaz.png
- aframe-portal-door.js
- threex-portal-door.js
- aframe-city-360.mp4
- pano.webm
- basic.html
- README.md
- index.html
- map-marker.png
- place_icon.png
- white_000.png
- index.html
- places.js
- index.html
- index.js
- index.html
- index.html
- places.js
- basic.html
- default-thinner-border.html
- dev.html
- marker-camera.html
- marker-events.html
- minimal.html
- mobile-performance.html
- multiple-independent-markers.html
- white-region-marker.html
- index.css
- gps-camera-debug.js
- gps-camera.js
- gps-entity-place.js
- component-anchor.js
- component-hit-testing.js
- system-arjs.js
- Makefile
- README.md
- camera_para.dat
- multi-marker-hirokanji.dat
- patt.hiro
- patt.kanji
- pinball.fset
- pinball.fset3
- pinball.iset
- 25P1geh.png
- armchair.jpg
- box.png
- chalk.jpg
- chalk_multi.jpg
- HIRO.jpg
- hiro.png
- img.jpg
- kuva.jpg
- marker_cube_hamming63.jpg
- multi-pattern-template-abcdgf.png
- multimarker.jpg
- pinball.jpg
- qrcode-in-marker.png
- logo-black-transparent-1280x512.png
- README.md
- .npmignore
- MGO2.swf
- README.md
- marker-small.dat
- marker.dat
- patt.a
- patt.b
- patt.c
- patt.d
- patt.f
- patt.g
- multi-barcode-4x3.dat
- multi-marker-hirokanji.dat
- chromedriver
- geckodriver
- selenium-server-standalone-3.0.1.jar
- marker-artoolkit-pattern-pattratio-09.png
- markers-page-ipad-640x480.jpg
- markers-page-ipad.jpg
- markers-page-ipad.mp4
- ERROR_chrome_2018-09-24T18-38-58.300Z.png
- ERROR_chrome_2018-09-24T18-38-58.352Z.png
- ERROR_chrome_2018-09-24T18-38-59.366Z.png
- ERROR_chrome_2018-09-24T18-39-00.802Z.png
- ERROR_chrome_2018-09-24T18-39-00.833Z.png
- ERROR_chrome_2018-09-24T18-39-01.807Z.png
- ERROR_chrome_2018-09-24T18-39-04.301Z.png
- learns an markers-area and play it-chrome.png
- rendering-three.js-artookit-640x480-chrome.png
- rendering-three.js-aruco-640x480-chrome.png
- resets the markers-area and enable marker-helpers-chrome.png
- test hit testing-chrome.png
- uses a markers-area and enabled markers-helpers-chrome.png
- learns an markers-area and play it-chrome.png
- learns an markers-area and play it-firefox.png
- rendering-three.js-artookit-640x480-chrome.png
- rendering-three.js-artookit-640x480-firefox.png
- rendering-three.js-aruco-640x480-chrome.png
- rendering-three.js-aruco-640x480-firefox.png
- resets the markers-area and enable marker-helpers-chrome.png
- resets the markers-area and enable marker-helpers-firefox.png
- test hit testing-chrome.png
- test hit testing-firefox.png
- uses a markers-area and enabled markers-helpers-chrome.png
- uses a markers-area and enabled markers-helpers-firefox.png
- learns an markers-area and play it-chrome.png
- learns an markers-area and play it-firefox.png
- rendering-three.js-artookit-640x480-chrome.png
- rendering-three.js-artookit-640x480-firefox.png
- rendering-three.js-aruco-640x480-chrome.png
- rendering-three.js-aruco-640x480-firefox.png
- resets the markers-area and enable marker-helpers-chrome.png
- resets the markers-area and enable marker-helpers-firefox.png
- test hit testing-chrome.png
- test hit testing-firefox.png
- uses a markers-area and enabled markers-helpers-chrome.png
- uses a markers-area and enabled markers-helpers-firefox.png
- .gitignore
- markers-area.js
- performance.js
- rendering.js
- .gitignore
- Makefile
- package-lock.json
- package.json
- README.md
- TODO.md
- wdio.conf.js
- ar.js
- ar.lean.js
- ar.lean.min.js
- ar.min.js
- 140867__juskiddink__boing.wav
- index.html
- threex-arliquiqmarker.js
- markercloak.html
- shadow.html
- vendor
- inner-arjs.png
- inner-hiro.png
- inner-kanji.png
- inner-letterA.png
- inner-letterB.png
- inner-letterC.png
- inner-letterD.png
- inner-letterF.png
- inner-letterG.png
- pattern-arjs.patt
- pattern-hiro.patt
- pattern-kanji.patt
- pattern-letterA.patt
- pattern-letterB.patt
- pattern-letterC.patt
- pattern-letterD.patt
- pattern-letterF.patt
- pattern-letterG.patt
- pattern-arjs.png
- pattern-hiro.png
- pattern-kanji.png
- pattern-letterA.png
- pattern-letterB.png
- pattern-letterC.png
- pattern-letterD.png
- pattern-letterF.png
- pattern-letterG.png
- generator.html
- patternmarker-from-image.html
- threex-arpatternfile.js
- TODO.md
- delete-scene.png
- record-start.png
- record-stop.png
- screenAsPortal-original.html
- screenAsPortal.html
- box.png
- target.png
- threex-screenasportal.js
- basic.html
- threex.tweencontrols.js
- default.html
- learner-old.html
- player-old.html
- learner-testrunner.html
- learner.html
- player.html
- index.html
- POST.md
- README.md
- threex-armultimarkercontrols.js
- threex-armultimarkerlearning.js
- threex-armultimarkerutils.js
- TODO.md
- pdfmake.min.js
- vfs_fonts.js
- three.js
- three.min.js
- OrbitControls.js
- VRControls.js
- VREffect.js
- dat.gui.min.js
- stats.min.js
- DDSLoader.js
- GLTF2Loader.js
- GLTFLoader.js
- MTLLoader.js
- OBJLoader.js
- WebVR.js
- dat.gui.min.js
- NoSleep.min.js
- webvr-polyfill.js
- arcode.html
- arjs-session.html
- basic.html
- boilerplate-threejs.html
- default-thinner-border.html
- default.html
- dev.html
- markerroot.html
- measure-it.html
- mobile-performance.html
- parameters-tunning.html
- profile.html
- test-runner.html
- trackingbackend-switch.html
- webvr-for-ar.html
- basic.html
- README.md
- threex-deadreckoningcontrols.js
- README.md
- franck.mp4
- franck.ogv
- main.css
- tracking-lbf-debug.js
- tracking-lbf-landmark-features.js
- tracking-lbf-landmarks-smoother.js
- eye-min.js
- eye.js
- face-min.js
- face.js
- mouth-min.js
- mouth.js
- tracking-min.js
- tracking.js
- Landmarks.js
- Regressor.js
- LBF.js
- Regressor.js
- eye.js
- face.js
- mouth.js
- ViolaJones.js
- Brief.js
- Fast.js
- Math.js
- Matrix.js
- EPnP.js
- ColorTracker.js
- LandmarksTracker.js
- ObjectTracker.js
- Tracker.js
- TrackerTask.js
- Canvas.js
- DisjointSet.js
- EventEmitter.js
- Image.js
- tracking.js
- ar-with-facetracking-experiment.html
- ar-with-facetracking-experiment0.html
- face_tracking_webcam.html
- TODO.md
- magic-book.jpg
- magic-book2.png
- pixel.png
- magic-book.mov
- magic-book.mp4
- logo.html
- magic-book.html
- basic.html
- gl-matrix.js
- arjs-camera.js
- arjs-math.js
- arjs-object3d.js
- README.md
- index.html
- viewer.html
- ar-code.png
- HTC_Vive_controller.obj
- README.md
- bookmarklet.js
- TODO.md
- show-gravity-raw.html
- show-gravity-webgl.html
- threex-armultimarkercontrols.js
- threex-armultimarkerlearning.js
- threex-armultimarkerutils.js
- arjs-anchor.js
- arjs-debugui.js
- arjs-hittesting.js
- arjs-session.js
- arjs-utils.js
- threex-arbasecontrols.js
- threex-arclickability.js
- threex-armarkercloak.js
- threex-armarkercontrols.js
- threex-armarkerhelper.js
- threex-arsmoothedcontrols.js
- threex-artoolkitcontext.js
- threex-artoolkitprofile.js
- threex-artoolkitsource.js
- threex-arvideoinwebgl.js
- threex-hittesting-plane.js
- artoolkit.debug.js
- artoolkit.min.js
- artoolkit.api.js
- artoolkit.three.js
- LICENSE.txt
- Makefile
- README.md
- .gitignore
- .travis.yml
- AR.js-1920-1080-HD.png
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- HOW_TO_RELEASE.md
- ISSUE_TEMPLATE.md
- LICENSE.txt
- Makefile
- package-lock.json
- package.json
- PULL_REQUEST_TEMPLATE.md
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/jeromeetienne/AR.js
Downloads the entire project code from GitHub to your computer.
cd AR.js
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)
