🌀🌀 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
- Use the the most recent version of p5.js or at least version
1.7.0. - Check out the Device and Browser Support Section.
- 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.9.2/p5.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/p5.xr/dist/p5xr.min.js"></script> - Change the
createCanvas()call in your p5 WEBGL sketch tocreateVRCanvas()and put it inpreload()-or- - 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 🚇 ⚠️ 💻 |
 Stalgia Grigg ⚠️ 🚇 🚧 💻 |
 Daniel Adams 💻 💡 🎨 |
 anagondesign 💡 |
 Samir Ghosh 💻 🎨 📖 |
 Tibor Udvari 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!