VR CineRig Addon Documentation

Installation

Prerequisites:

Install the VR Scene Inspection Add-on (built into Blender):

Open Blender and navigate to Edit > Preferences > Add-ons.

Search for VR Scene Inspection and enable it by checking the box next to its name.

Install SteamVR:

Download and install SteamVR from the Steam Store if you haven’t already.

Ensure your VR headset and controllers are properly configured with SteamVR.

Install the VR CineRig Add-on:

1. Download the "VR CineRig" add-on file.
2. Open Blender and navigate to Edit > Preferences > Add-ons.
3. Click Install and select the downloaded file.
4. Enable the add-on by checking the box next to its name.

Usage

After installation, the "VR CineRig" add-on can be accessed in the 3D Viewport's UI panel, under the VR CineRig tab. 

To begin using VR CineRig, make sure SteamVR is running, then click the Start VRSession button in the VR Scene Inspection add-on. To visualize the headsetand controllers, enable their display under the Viewport Feedback tab inthe VR Scene Inspection add-on.

1. Enable VR Tracking

While this is checkbox enabled,keyframes are automatically recorded during your session. Remember to uncheckthe box after each take before navigating the timeline to prevent overwritingkeyframes from a successful recording.

2. Track VR Headset

Press this button to create an empty in the location of the VR Headset.

3. Set VR Origin

The Set VR Origin function creates a camera that serves as the parent for all VR components. This allows you to parent the VR origin to another moving object, such as a vehicle, enabling more dynamic scene movement than what is physically possible with your controllers. For example, by parenting the VR origin to a vehicle, you can focus on controlling the camera’s pan, tilt, and roll while the vehicle handles positional movement in the scene.

4. Connect Selected Camera

Connects the selected camera to the VR Headset.

5. Move VR Origin to the Selected Camera

This function positions the VR Origin at the location of the selected camera in your scene. It’s especially useful during initial setup when you already have a camera placed and want to seamlessly integrate it with the VR CineRig system.

6. Track LH Controller

Creates an Empty in the location of the Left Controller.

7. Connect Selected Camera to LH Controller

Connects the Selected camera to the Left Controller.

8. Track RH Controller

Creates an Empty in the location of the Right Controller.

9. Connect Selected Camera to RH Controller

Connects the Selected camera to the Right Controller.

Troubleshooting and Best Practices

While using the "VR CineRig" add-on, you may encounter some issues. Here are solutions and tips to help you resolve them:

Tracking Stops Working

• Delete all empties created by the add-on and start again.

Controller Movement Not Registering

• Put on the VR headset and look at the controller briefly to wake it up.

Moving VR Empties into New Collections Breaks Connections

• Ensure all animations are finalized before moving any VR empties to a new collection.

Overwritten Keyframes When Scrolling

• Always uncheck the Enable VR Tracking checkbox immediately after finishing an animation recording to prevent overwriting keyframes.

VR Drift

• If the headset or controllers drift when stationary, ensure that a VR Origin has been set.

Headset not visible

• Some Headsets like the HTC Vive and Meta Quest 3 have proximity sensors to tell whether the headset is being used. If you want to track the headset or controllers without wearing the headset, simply block the sensor with a small piece of tape or something similar.

Known Issues

Undo (CTRL + Z) Issue

Pressing CTRL+Z to undo an action breaks the connection between the VR controllers/headset and the created empties. To fix the connection simply click the Track Headset or Track Controller buttons and then re-connect the selected camera. If the problem still persists, delete all Empties created by VR CineRig and re-create them.

Uninstallation

To uninstall the add-on, navigate to Edit > Preferences > Add-ons in Blender, find the VR CineRig add-on, and click Remove.

Support

For any issues or inquiries about the "VR CineRig" add-on, please contact us via email at [email protected].