DOCSEARCHbyAlgolia
Submit Docs

VR Builder

repository·develop·Indexed 41 days ago

https://github.com/mindport-gmbh/vr-builder

An open-source toolkit for creating interactive VR applications, such as training and simulations, using a graphical workflow editor. It allows users to define processes consisting of steps and transitions without prior VR development experience. Compatible with Unity 6 or later and headsets supported by the XR Interaction Toolkit.

Tokens
709
Snippets
1
Records
5
Agent score
2%

What's inside VR Builder

  1. How Process Scene Objects and Properties work

    develop

    Behaviors and conditions interact with process scene objects.

    • Process Scene Object: A Unity GameObject that has a Process Scene Object component attached.
    • Scene Object Properties: These define the capabilities of a scene object. For example, adding a Grabbable Property allows VR Builder to detect when an object is grabbed.

    Note: When you assign an object to a behavior or condition, VR Builder can automatically configure the required components and properties with a single click, provided the object has a collider and a mesh.

  2. How VR Builder processes work

    develop

    A VR Builder application is driven by a process. A process is a sequence of steps connected by transitions.

    • Steps: Execute behaviors, such as moving an object or playing audio.
    • Transitions: Wait for conditions, such as the user grabbing an object, before the process continues.

    Processes are authored and maintained in the Workflow Editor, a node-based editor designed for managing these flows.

  3. Install VR Builder from Git repositories

    develop

    If you are working directly from the Git repositories instead of using a packaged release, you must clone both the main repository and the core runtime repository to avoid compile errors.

    git clone https://github.com/MindPort-GmbH/VR-Builder.git
git clone https://github.com/MindPort-GmbH/VR-Builder-Core-Runtime.git

    Important: VR Builder depends on the Source/CoreRuntime repository. The VR Builder CoreRuntime package contains the runtime process architecture (processes, steps, transitions, behaviors, conditions, etc.). Using VR Builder without the core runtime package will lead to compile errors and Unity warnings.

  4. Install VR Builder

    develop

    You can install VR Builder via OpenUPM, the Unity Asset Store, or by downloading a .unitypackage from GitHub Releases.

    Quick Start

    1. Install VR Builder in a Unity project (requires Unity 6 or later).
    2. Follow the Project Setup Wizard to configure required project settings.
    3. (Optional) Import Demo - Scene from the Scene setup wizard.
    4. Click Finish. If Demo - Scene was selected, the scene will load and automatically open the Process Editor view.

    Requirements

    • Unity Version: Unity 6 or later.
    • Hardware/Platform: Any headset compatible with Unity's XR Interaction Toolkit, or desktop and web-based platforms.

  5. Available VR Builder Samples

    develop

    The following samples are included to help you get started:

    • Demo - Core Features: Demonstrates the main free behaviors and conditions within a working process using 3D assets.
    • Demo - Hands Interaction: Demonstrates hand tracking integration using VR Builder and the XR Interaction Toolkit. Importing this sample will also install the necessary Unity packages and XRI samples.