/XR

Vue components and composable functions to build AR/VR experiences with TresJS

Primary LanguageVueMIT LicenseMIT

repository-banner.png

npm package

discord chat


XR

Vue components and composable functions to build AR/VR experiences with TresJS

  • ⚡️ Powered by Vite
  • 🦾 Fully Typed

Installation

pnpm i @tresjs/xr

Docs

Checkout the docs

Demos

Contributing

We are open to contributions, please read the contributing guide to get started.

Build

To build the package run:

pnpm run build

Playground

To run the playground run, its a great way to test the components and helpers locally:

First install dependencies

pnpm i

And then to run the development server on http://localhost:5173

pnpm run playground

Test

TODO...

Docs

To run de docs in dev mode

pnpm run docs:dev

To build them

pnpm run docs:build

License

MIT

Sponsors

Be the first to support this project here ☺️

Logic

  • Watch effects trigger for first time
  • VRButton is clicked
  • handleButtonClick method of XRButton is triggered
  • toggleSession is called
  • startSession is called
  • XR session is requested
  • XR session is saved to global session pinia store
  • Set status as entered
  • Save copy of global session XR session to provided state
  • Watch effects trigger for second time (after reactive depedencies update)