liyasthomas / lvr

👓 Augmented Reality for everyone - Out of the world experiences

Lvr

👓 Virtual reality for everyone by Liyas Thomas

Features ✨

👓 Virtual Reality made simple: Lvr contains the 3D and WebVR boilerplates required to get running across platforms including mobile, desktop, Vive, and Rift. It works on any phone with WebGL and WebRTC.

❤️ Declarative HTML: HTML is easy to read and copy-and-paste. Since Lvr can be used from HTML, Lvr is accessible to everyone: web developers, VR enthusiasts, educators, artists, makers, kids. It is completely open source and free of charge!

🔌 Entity-Component Architecture: Lvr is a powerful framework on top of three.js, providing a declarative, composable, reusable entity-component structure. While Lvr can be used from HTML, developers have unlimited access to JavaScript, DOM APIs, three.js, WebVR, and WebGL.

⚡ Performance: Lvr is a thin framework on top of AR.js and A-Frame. Although A-Frame uses the DOM, A-Frame does not touch the browser layout engine. Performance is a top priority, being battle-tested on highly interactive WebVR experiences. It runs efficiently even on mobile phones!

🌐 Cross-Platform: Build VR applications for Vive, Rift, Daydream, GearVR, and Cardboard. Don't have a headset or controllers? No problem! Lvr still works on standard desktop and smartphones. It is a pure web solution, so no installation required. Full JavaScript based on three.js + jsartoolkit5.

---

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

• A device which supports WebGL and WebRTC with a working camera input
• Internet connection
• A web browser that supports WebVR. Works best with Chrome on Android devices. You can still experience WebVR content in other browsers on Android and iOS, but it might not be as smooth since those browsers don’t fully support WebVR
• Wonder! ❤️

Demo: Try it on mobile 📱

It works on all platforms. Android, iOS and Windows phone. It runs on any browser with WebGL and WebRTC (for iOS, you need to update to iOS 11).

Try on your phone in only two easy steps, check it out!

1. Open marker image from here in your browser.
2. Open my augmented reality web app in your phone browser. Give permissions to access camera. Scan marker image with your camera.

You're done! It will open a web page which read the phone's webcam, localize a marker and add 3D on top of it.

Installing

A step by step series of examples that tell you've to get a development environment running.

1. Download the whole zip/clone the repository.
2. Unzip and make changes.
3. Save and deploy to any hosting platforms like Firebase, GitHub pages etc.

---

Built with

• AR.js - For efficient augmented reality for the web
  • 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
• A-Frame - Web framework for building virtual reality experiences
• Chromium - Thanks for being so fast!
• HTML - For the web framework
• CSS - For styling components

---

Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

---

Continuous Integration

We use Travis CI for continuous integration. Check out our Travis CI Status.

---

Versioning

This project is developed by Liyas Thomas using the Semantic Versioning specification. For the versions available, see the releases on this repository.

---

Authors

Lead Developers

• Liyas Thomas - Author

Thanks

• Jerome Etienne - For AR.js

See also the list of contributors who participated in this project.

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Change log

See the CHANGELOG file for details.

---

Acknowledgments

• Hat tip to anyone who's code was used
• Inspirations:
  • Google VR
  • Google ARCore
  • Google WebVR Experiments
  • Google AR Experiments
  • Apple ARKit
  • Microsoft HoloLens
  • YouTube
  • A-Frame
  • three.js
  • CodePen
  • GitHub

lvr's Issues

Take a screenshot

Take a simple screenshot.

Switch between front and rear camera

Enable switching from primary camera to secondary camera and vice versa.

Audio not working

Audio auto-play is not working.

Markers are not being detected

Camera is not detecting markers.

Always black objects

Objects always appear in black texture.

Toggle flash light on and off

Is your feature request related to a problem? Please describe.
It would've been nice if we could toggle flash light on & off.

Describe the solution you'd like
Add a toggle button to turn flash light on and off.

Describe alternatives you've considered
(no alternatives)

Additional context
This turns on the flash light but can't turn them back off https://stackoverflow.com/a/47153547

Custom markers are not working

Custom markers are not being detected.