px

p5.xr

a library that enables users to turn their p5.js sketches into immersive experiences using WebXR

Showing:

Popularity

Downloads/wk

62

GitHub Stars

64

Maintenance

Last Commit

1mo ago

Contributors

5

Package

Dependencies

2

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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. 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

💡

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100