Skip to content
Snippets Groups Projects
Commit 93a78a08 authored by Samuel Truman's avatar Samuel Truman
Browse files

Updated package readme

parent 1d3bf63c
No related branches found
No related tags found
No related merge requests found
# VIA-VR Unity Bridge
Provides API used by VIA-VR Editor to talk to all VIA-VR packages.
\ No newline at end of file
This package provides a coherent interface for all VIA-VR Unity packages to use. You can create your package as you normally would without worrying about VIA-VR compatibility. You package may provide runtime and/or editor functionality. Normally, you would ask the user to add prefabs or components to the scene hierarchy and use the inspector to configure the objects. In the VIA-VR project, the user will not interact with the Unity editor. Therefore, you must provide an additional scripting interface. You can do so by creating a class that inherits from `PackageConfigurator`. You can then override the methods you need to configure the package. These event methods work similar to the MonoBehaviour event methods like `Start`, `Update`, `OnTriggerEnter`, etc.
## Execution Order
```mermaid
graph TD;
Init-->OnConfigureScene;
OnConfigureScene-->OnPostConfiguration;
```
See [PackageConfigurator.cs](https://gitlab2.informatik.uni-wuerzburg.de/GE/Dev/ViaVR/components/via-vr-unity-bridge/-/blob/main/Packages/de.jmu.ge.viavr.unitybridge/Editor/Core/PackageConfigurator.cs) to learn when these event methods are called.
## Examples
- You can install an example from the Unity Package Manager
- [Build Utils](https://gitlab2.informatik.uni-wuerzburg.de/GE/Dev/ViaVR/components/build-utils)
- [Spoke Scene Importer
](https://gitlab2.informatik.uni-wuerzburg.de/GE/Dev/ViaVR/components/spoke-scene-importer)
## FAQ
[FAQ](https://gitlab2.informatik.uni-wuerzburg.de/GE/Dev/ViaVR/components/via-vr-unity-bridge/-/wikis/FAQ)
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment