Giter VIP home page Giter VIP logo

p5.xr's Introduction

All Contributors

🌀🌀 WEBSITE 🌀🌀

What is it?

p5.xr is an add-on for p5.js, a Javascript library that makes coding accessible for artists, designers, educators, and beginners. p5.xr adds the ability to run p5 sketches in Augmented Reality or Virtual Reality. It does this with the help of WebXR. This enables anyone familiar with p5 to start experimenting with these technologies with little setup.

Features

p5.xr sketches can be run with p5's online editor. All of the existing p5 functionality works, and in addition, p5.xr allows you to:

  • Virtual Reality

    • Run any 2D or 3D p5 sketch in mobile VR with Google Cardboard
    • Do the above but with Desktop VR (Vive and Oculus)

  • Augmented Reality

    • Make sketches that use Augmented Reality with any device that supports ARCore.
    • Use marker-based AR on any mobile device Coming Soon
    • Set anchors and detects planes in your environment --- Coming Soon

  • Raycasting

    • Do some simple raycasting for gaze-based interaction in both AR and VR

Getting Started

  1. Make sure that you have the most recent version of p5.js.
  2. Check out the Device and Browser Support Section.
  3. Add p5.xr to your project. This can be done most easily by adding the script link to a CDN in the <head> of your HTML file underneath the p5 link: 
    <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.5.0/p5.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/p5.xr/dist/p5xr.min.js"></script>
  4. Change the createCanvas() call in your p5 WEBGL sketch to createVRCanvas() and put it in preload() -or-
  5. Try out one of the Examples!

Contributors ✨

Interested in contributing to this project? Check out the contributor docs.

Thanks goes to these wonderful people (emoji key):

Vedhant Agarwal
Vedhant Agarwal
🚇 ⚠️ 💻		 Stalgia Grigg
Stalgia Grigg
⚠️ 🚇 🚧 💻		 Daniel Adams
Daniel Adams
💻 💡 🎨		 anagondesign
anagondesign
💡		 Samir Ghosh
Samir Ghosh
💻 🎨 📖		 Tibor Udvari
Tibor Udvari
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

p5.xr's People

Contributors

stalgiag avatar vedhant avatar smrghsh avatar dependabot[bot] avatar anagondesign avatar allcontributors[bot] avatar msub2 avatar tiborudvari avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.