{"id":20066038,"url":"https://github.com/sean-bradley/teleportvr","last_synced_at":"2025-05-05T18:32:12.242Z","repository":{"id":31467538,"uuid":"127619215","full_name":"Sean-Bradley/TeleportVR","owner":"Sean-Bradley","description":"Teleport module for WebVR, THREE.js and VRController.js projects","archived":false,"fork":false,"pushed_at":"2024-03-28T22:51:10.000Z","size":2168,"stargazers_count":33,"open_issues_count":1,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-13T12:08:52.025Z","etag":null,"topics":["rift","teleportvr","threejs","vive","vrcontroller","webvr"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sean-Bradley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":["Sean-Bradley"],"patreon":"seanwasere","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-04-01T10:29:24.000Z","updated_at":"2024-11-10T17:44:10.000Z","dependencies_parsed_at":"2024-01-10T09:41:08.238Z","dependency_job_id":"e4b0eeb5-919f-4fc8-b7d6-17201ffae43f","html_url":"https://github.com/Sean-Bradley/TeleportVR","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sean-Bradley%2FTeleportVR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sean-Bradley%2FTeleportVR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sean-Bradley%2FTeleportVR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sean-Bradley%2FTeleportVR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sean-Bradley","download_url":"https://codeload.github.com/Sean-Bradley/TeleportVR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224461707,"owners_count":17315116,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rift","teleportvr","threejs","vive","vrcontroller","webvr"],"created_at":"2024-11-13T13:54:18.484Z","updated_at":"2024-11-13T13:54:19.116Z","avatar_url":"https://github.com/Sean-Bradley.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Sean-Bradley","https://patreon.com/seanwasere"],"categories":[],"sub_categories":[],"readme":"# TeleportVR\n\nTeleport module for WebVR and THREE.js projects.\n\nYou can download the project and view the examples.\n\n```bash\ngit clone https://github.com/Sean-Bradley/TeleportVR.git\ncd TeleportVR\nnpm install\nnpm run dev\n```\n\nVisit https://127.0.0.1:3000/\n\n## How to import TeleportVR\n\n```bash\nnpm install teleportvr\n```\n\nImport it into your code\n\n```javascript\nimport TeleportVR from \"teleportvr\";\n```\n\n## How to Instantiate And Use\n\nAfter creating your `THREE.Scene` and `THREE.Camera`, create a new **TeleportVR** object.\n\n```javascript\nconst teleportVR = new TeleportVR(scene, camera);\n```\n\nCreate geometries for the hands and add controller grips, see example code for more info.\n\nUpdate **TeleportVR** in your render loop\n\n```javascript\nteleportVR.update();\nrenderer.render(scene, camera);\n```\n\n## Example 1\n\nBasic TeleportVR setup for WebVR and Threejs projects.\n\n[![TeleportVR Example 1](./dist/client/img/teleportvr-1.gif)](https://sbcode.net/threejs/teleportvr-1/)\n\n## Example 2\n\nShoot at objects in the scene.\n\n[![TeleportVR Example 2](./dist/client/img/teleportvr-2.gif)](https://sbcode.net/threejs/teleportvr-2/)\n\n## Example 3\n\nTeleport on top of objects in the scene.\n\n[![TeleportVR Example 3](./dist/client/img/teleportvr-3.gif)](https://sbcode.net/threejs/teleportvr-3/)\n\n## Example 4\n\nCustomising the TeleportVR default meshes.\n\n[![TeleportVR Example 4](./dist/client/img/teleportvr-4.gif)](https://sbcode.net/threejs/teleportvr-4/)\n\n## TeleportVR Source Project\n\nThis is a typescript project consisting of two sub projects with there own _tsconfigs_.\n\nTo edit this example, then modify the files in `./src/client/` or `./src/server/`\n\nThe projects will auto recompile if you started it by using _npm run dev_\n\n## Threejs TypeScript Course\n\nVisit https://github.com/Sean-Bradley/Three.js-TypeScript-Boilerplate for a Threejs TypeScript boilerplate containing many extra branches that demonstrate many examples of Threejs.\n\n\u003e To help support this Threejs example, please take a moment to look at my official Threejs TypeScript course at\n\n[![Threejs TypeScript Course](threejs-course-image.png)](https://www.udemy.com/course/threejs-tutorials/?referralCode=4C7E1DE91C3E42F69D0F)\n\n[Three.js and TypeScript](https://www.udemy.com/course/threejs-tutorials/?referralCode=4C7E1DE91C3E42F69D0F)\u003cbr/\u003e  \n Discount Coupons for all my courses can be found at [https://sbcode.net/coupons](https://sbcode.net/coupons)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsean-bradley%2Fteleportvr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsean-bradley%2Fteleportvr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsean-bradley%2Fteleportvr/lists"}