Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 5.31 KB

README.md

File metadata and controls

65 lines (48 loc) · 5.31 KB
Raw

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 VR ( mobile, desktop or standalone device )

  • Augmented Reality

    • Make sketches that use Augmented Reality with any device that supports immersive AR Session

Getting Started

  1. Use the the most recent version of p5.js
  2. Check out the Device and Browser Support Section or use the Immersive Web Emulator
  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.10.0/p5.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/p5.xr@latest/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!