Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/extendrealityltd/vrtk.prefabs
*Deprecated* - A collection of productive prefabs for rapidly building spatial computing solutions in the Unity software.
https://github.com/extendrealityltd/vrtk.prefabs
archived deprecated obsolete
Last synced: 2 months ago
JSON representation
*Deprecated* - A collection of productive prefabs for rapidly building spatial computing solutions in the Unity software.
- Host: GitHub
- URL: https://github.com/extendrealityltd/vrtk.prefabs
- Owner: ExtendRealityLtd
- License: mit
- Created: 2019-10-15T07:52:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-15T10:21:57.000Z (almost 3 years ago)
- Last Synced: 2024-10-13T22:48:29.664Z (3 months ago)
- Topics: archived, deprecated, obsolete
- Language: C#
- Homepage:
- Size: 339 KB
- Stars: 60
- Watchers: 4
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Deprecated Repository
> The VRTK.Prefabs repo has been deprecated and will no longer receive any future updates. The Tilia repos are now recommended to be used in place of the VRTK.Prefabs repo. A complete list of the Tilia repos can be found at https://www.vrtk.io/tilia.html along with installation instructions. Some of the prefabs found in the VRTK.Prefabs repo may not exist at Tilia repos at this time, but they are being worked on in due course and will be supported moving forward.
[![VRTK logo][VRTK-Image]](#)
> ### VRTK Prefabs `deprecated`
> A collection of productive prefabs for rapidly building spatial computing solutions in the Unity software.
[![Release][Version-Release]][Releases]
[![License][License-Badge]][License]
[![Backlog][Backlog-Badge]][Backlog]
[![Documentation][Academy-Badge]][Academy]
[![Slack][Slack-Badge]][Slack]
[![Videos][Videos-Badge]][Videos]
[![Twitter][Twitter-Badge]][Twitter]
## Introduction
The VRTK Prefabs aim to make building spatial computing solutions in the [Unity] software fast and easy for beginners as well as experienced developers.
> **Requires** the Unity software version `2018.3.10f1` (or above).
## Getting Started
### Setting up the project
* Create a new project in the Unity software version `2018.3.10f1` (or above) using `3D Template` or open an existing project.
* Ensure `Virtual Reality Supported` is checked:
* In the Unity software select `Main Menu -> Edit -> Project Settings` to open the `Project Settings` window.
* Select `Player` from the left hand menu in the `Project Settings` window.
* In the `Player` settings panel expand `XR Settings`.
* In `XR Settings` ensure the `Virtual Reality Supported` option is checked.
* Ensure the project `Scripting Runtime Version` is set to `.NET 4.x Equivalent`:
* In the Unity software select `Main Menu -> Edit -> Project Settings` to open the `Project Settings` inspector.
* Select `Player` from the left hand menu in the `Project Settings` window.
* In the `Player` settings panel expand `Other Settings`.
* Ensure the `Scripting Runtime Version` is set to `.NET 4.x Equivalent`.
> Note: Unity `2019.1` (or above) requires additional project setup before importing the VRTK Prefabs.
* Download and install the `XR Legacy Input Helpers` from the Unity Package Manager.
* In the Unity software select `Main Menu -> Window -> Package Manager` to open the `Package Manager` window.
* Select `XR Legacy Input Helpers` from the `Packages` tab in the `Package Manager` window.
* Click the `Install` button located in the bottom right of the `Package Manager` window.
* The `XR Legacy Input Helpers` package will now download and install into the project.
### Adding the package to the Unity project manifest
* Navigate to the `Packages` directory of your project.
* Adjust the [project manifest file][Project-Manifest] `manifest.json` in a text editor.
* Ensure `https://registry.npmjs.org/` is part of `scopedRegistries`.
* Ensure `io.extendreality` is part of `scopes`.
* Add `io.extendreality.vrtk.prefabs` to `dependencies`, stating the latest version.
A minimal example ends up looking like this. Please note that the version `X.Y.Z` stated here is to be replaced with [the latest released version][Latest-Release] which is currently [![Release][Version-Release]][Releases].
```json
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"io.extendreality"
]
}
],
"dependencies": {
"io.extendreality.vrtk.prefabs": "X.Y.Z",
...
}
}
```
* Switch back to the Unity software and wait for it to finish importing the added package.
### Updating to the latest version
The package will show up in the Unity Package Manager UI once the above steps have been carried out. From then on the package can be updated by selecting the package in the Unity Package Manager and clicking on the `Update` button or using the version selection UI.
## Documentation
Visit the [Academy] for a collection of educational content to help you get the most out of building spatial computing solutions with the VRTK Prefabs.
## Contributing
Please refer to the Extend Reality [Contributing guidelines] and the [Unity project coding conventions].
## Code of Conduct
Please refer to the Extend Reality [Code of Conduct].
## License
Code released under the [MIT License][License].
## Disclaimer
These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.
[VRTK-Image]: https://user-images.githubusercontent.com/1029673/40060519-bb122e8c-584e-11e8-8402-ca168b327671.png
[Version-Release]: https://img.shields.io/github/release/ExtendRealityLtd/VRTK.Prefabs.svg
[Backlog-Badge]: https://img.shields.io/badge/project-backlog-78bdf2.svg
[License-Badge]: https://img.shields.io/github/license/ExtendRealityLtd/VRTK.Prefabs.svg
[Academy-Badge]: https://img.shields.io/badge/learn-academy-f3aeae.svg
[Slack-Badge]: https://img.shields.io/badge/slack--E24663.svg?style=social&logo=slack
[Videos-Badge]: https://img.shields.io/badge/youtube--e52d27.svg?style=social&logo=youtube
[Twitter-Badge]: https://img.shields.io/badge/twitter--219eeb.svg?style=social&logo=twitter
[Releases]: ../../releases
[License]: LICENSE.md
[Backlog]: http://tracker.vrtk.io
[Academy]: https://academy.vrtk.io
[Slack]: http://invite.vrtk.io
[Videos]: http://videos.vrtk.io
[Twitter]: https://twitter.com/VR_Toolkit
[Unity]: https://unity3d.com/
[Latest-Release]: ../../releases/latest
[Project-Manifest]: https://docs.unity3d.com/Manual/upm-manifestPrj.html
[Contributing guidelines]: https://github.com/ExtendRealityLtd/.github/blob/master/CONTRIBUTING.md
[Unity project coding conventions]: https://github.com/ExtendRealityLtd/.github/blob/master/CONVENTIONS/UNITY3D.md
[Code of Conduct]: https://github.com/ExtendRealityLtd/.github/blob/master/CODE_OF_CONDUCT.md