# teleportvr

> Teleport module for WebXR THREE.js projects

Latest version **3.0.7** (published 2024-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install teleportvr
pnpm add teleportvr
yarn add teleportvr
bun add teleportvr
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.7 |
| Published | 2024-03-28 |
| First published | 2018-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Sean Bradley |
| Maintainers | seanwasere |
| Keywords | teleportvr, threejs, webvr, webxr, seanwasere, statsvr |

## Links

- npm: https://www.npmjs.com/package/teleportvr
- Repository: https://github.com/Sean-Bradley/TeleportVR
- Homepage: https://github.com/Sean-Bradley/TeleportVR#readme
- Issues: https://github.com/Sean-Bradley/TeleportVR/issues
- npm.io page: https://npm.io/package/teleportvr

## Dependencies (1)

- [express](https://npm.io/package/express.md) ^4.19.2

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 3.0.7 (latest) — 2024-03-28
- 3.0.5 — 2024-03-23
- 3.0.4 — 2022-11-11
- 3.0.3 — 2022-07-09
- 3.0.2 — 2022-07-09
- 3.0.1 — 2022-01-28
- 3.0.0 — 2021-05-15
- 2.2.0 — 2021-02-01
- 2.1.1 — 2020-11-26
- 2.1.0 — 2020-11-23
- 2.0.1 — 2020-11-16
- 2.0.0 — 2020-11-16
- 1.1.1 — 2018-05-12
- 1.1.0 — 2018-04-13
- 1.0.6 — 2018-04-02
- … 6 more at https://npm.io/package/teleportvr/versions

## README

# TeleportVR

Teleport module for WebVR and THREE.js projects.

You can download the project and view the examples.

```bash
git clone https://github.com/Sean-Bradley/TeleportVR.git
cd TeleportVR
npm install
npm run dev
```

Visit https://127.0.0.1:3000/

## How to import TeleportVR

```bash
npm install teleportvr
```

Import it into your code

```javascript
import TeleportVR from "teleportvr";
```

## How to Instantiate And Use

After creating your `THREE.Scene` and `THREE.Camera`, create a new **TeleportVR** object.

```javascript
const teleportVR = new TeleportVR(scene, camera);
```

Create geometries for the hands and add controller grips, see example code for more info.

Update **TeleportVR** in your render loop

```javascript
teleportVR.update();
renderer.render(scene, camera);
```

## Example 1

Basic TeleportVR setup for WebVR and Threejs projects.

[![TeleportVR Example 1](./dist/client/img/teleportvr-1.gif)](https://sbcode.net/threejs/teleportvr-1/)

## Example 2

Shoot at objects in the scene.

[![TeleportVR Example 2](./dist/client/img/teleportvr-2.gif)](https://sbcode.net/threejs/teleportvr-2/)

## Example 3

Teleport on top of objects in the scene.

[![TeleportVR Example 3](./dist/client/img/teleportvr-3.gif)](https://sbcode.net/threejs/teleportvr-3/)

## Example 4

Customising the TeleportVR default meshes.

[![TeleportVR Example 4](./dist/client/img/teleportvr-4.gif)](https://sbcode.net/threejs/teleportvr-4/)

## TeleportVR Source Project

This is a typescript project consisting of two sub projects with there own _tsconfigs_.

To edit this example, then modify the files in `./src/client/` or `./src/server/`

The projects will auto recompile if you started it by using _npm run dev_

## Threejs TypeScript Course

Visit https://github.com/Sean-Bradley/Three.js-TypeScript-Boilerplate for a Threejs TypeScript boilerplate containing many extra branches that demonstrate many examples of Threejs.

> To help support this Threejs example, please take a moment to look at my official Threejs TypeScript course at

[![Threejs TypeScript Course](threejs-course-image.png)](https://www.udemy.com/course/threejs-tutorials/?referralCode=4C7E1DE91C3E42F69D0F)

[Three.js and TypeScript](https://www.udemy.com/course/threejs-tutorials/?referralCode=4C7E1DE91C3E42F69D0F)<br/>  
 Discount Coupons for all my courses can be found at [https://sbcode.net/coupons](https://sbcode.net/coupons)

---
_Source: https://npm.io/package/teleportvr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._