# vuejs-vr
> A framework for building VR applications with Vue
Latest version **1.2.2** (published 2020-11-19) · MIT license · 0 weekly downloads
## Install
```sh
npm install vuejs-vr
pnpm add vuejs-vr
yarn add vuejs-vr
bun add vuejs-vr
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.2.2 |
| Published | 2020-11-19 |
| First published | 2018-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 2 |
| Unpacked size | 2.5 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 475 |
| Author | mudin |
| Maintainers | imudin07 |
| Keywords | vue, vue-vr, panolens.js, three.js, component, vr, vr tour |
## Links
- npm: https://www.npmjs.com/package/vuejs-vr
- Repository: https://github.com/mudin/vue-vr
- Homepage: https://github.com/mudin/vue-vr#readme
- Issues: https://github.com/mudin/vue-vr/issues
- npm.io page: https://npm.io/package/vuejs-vr
## Dependencies (2)
- [vue](https://npm.io/package/vue.md) ^2.2.6
- [three](https://npm.io/package/three.md) ^0.105.2
## Recent versions
- 1.2.2 (latest) — 2020-11-19
- 1.2.1 — 2020-11-19
- 1.1.0 — 2019-03-20
- 1.0.9 — 2019-02-25
- 1.0.8 — 2018-12-05
- 1.0.7 — 2018-03-28
- 1.0.6 — 2018-03-20
- 1.0.4 — 2018-03-19
- 1.0.3 — 2018-03-19
- 1.0.2 — 2018-03-19
- 1.0.1 — 2018-03-19
- 1.0.0 — 2018-03-19
## README
# Vue VR
A Wrapper of [Panolens](https://pchen66.github.io/Panolens/) for building VR applications with Vue
based on [threejs](https://threejs.org/)
## Demos
[Image Pano](https://mudin.github.io/vue-vr/#/demo-pano)
[Cube Pano](https://mudin.github.io/vue-vr/#/demo-cube-pano)
[Video Pano](https://mudin.github.io/vue-vr/#/demo-video-pano)
[VR Tour](https://mudin.github.io/vue-vr/#/demo-tour)
## Getting started
using npm
```
npm install vuejs-vr --save
```
Or using script tag for global use
```html
```
Or Download vue-vr.min.js and include it in your html
## Installing & Running Locally
Clone the repository using git:
```
git clone https://github.com/mudin/vue-vr.git
```
Installing all dependencies:
```
npm install
```
Build by webpack:
```
npm run-script build
```
Run locally:
```
npm start
```
This will start development server on localhost:8080
## Usage
####For simple panorama:
Panorama by equirectangular image
```vue
```
Or
```vue
```
####For cube faces:
Panorama with a six-face cubemap
```vue
```
Note: `%s` replaced by `'l'|'f'|'r'|'b'|'u'|'d'`
Or
```vue
```
####360 video:
Panorama with 360 video
```vue
```
Or
```vue
```
## TODO List
* Hotspots
* 3D objects
## Contributing
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
## LICENSE
MIT
---
_Source: https://npm.io/package/vuejs-vr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._