VR Tools Unity

VR Tools Unity

Table of Contents


VR Tools

VR Tools Installation

To have access to the VR Tools, you need to install the necessary packages SYNK VR Toolbelt, which can be done from the Package Manager window, under My Registries. See below.

Once you’ve found the package, click Install. This will automatically import the necessary dependencies and plugins.

image-20250414-153138.png

Afterwards, set up the XR plugin by going to :

  • Edit → Project Settings → XR Plug-in Management

And enable both the Initialize XR on Startup option, and the OpenXR Loader checkbox.

image-20240516-122548.png

Finally, in case it is already not set by default, it is also necessary to make sure the project’s Active Input Handling is set to Both :

  • Edit → Project Settings → Player → Other Settings → Configuration → Active Input Handling

image-20240516-122631.png

VR Tools for Layout

Once the package is installed, you can open the VR Tools via the Editor menu.

image-20250414-153622.png
image-20251110-140957.png

Enter VR Tools Session

  • starts the session, it replaces the traditional unity play button

Camer Settings

Recording countdown

  • The duration of the countdown when starting a recording.

Default FocalLength

  • Focal length of the camera when starting the VR session.

Default Camera Tilt Angle

  • Tilt angle of the camera when starting the VR session.

Default Storyboard Opacity

  • Storyboard opacity when starting the VR session.

Show Rule Of Third

  • Toggles the rule of third grid on the VR camera.

Block the Z rotation of the camera

  • Prevents the VR user from moving the camera on the Z axis.

Movement Settings

Default Movement Type

  • The active movement type when starting the VR session.

Default Movement Speed

  • The movement speed when starting the VR session.

Enable teleport movement

  • When enabled, add the teleport option to the movement type menu in VR.

Move with right joystick when recording

  • When enabled, when you start recording, you will only be able to move with the right joystick input → for users who prefer to record and move with one joystick.

Attach Automatically To Dolly

  • When enabled, when selecting a shot, the VR camera will automatically parent to a Dolly cart if one is active in the shot.

Advanced Movement Settings

Default Acceleration

  • Determines the time needed to accelerate towards the current speed: value between 0 & 1

    • 0: No acceleration

    • 1: Full acceleration (instantly move at max speed)

Default Deceleration

  • Determines how fast the user slows down when the joystick gets no input: value between 0 & 1

    • 0: No deceleration

    • 1: Instantly stop moving

Preview Shot Settings

Relative To Sequence

  • Show the time info relate to the sequence when enabled or show the time relative to the shot if disabled.

Playback Recorded Clips Settings

Playback Mode

  • Theater Room: playback the clips on a screen inside a theater room

  • Screen Only: playback the clips on a screen in a black void

Other Settings

Add a character controller

  • Makes it possible to move with a character in the environment using keyboard or controller

Requires you to drag a transform into the Character initial transform slotto determine where the character gets spawned.

Add a teleporting plane (obsolete, get’s performed automatically but can still be done if wanted)

  • Makes the character controler able to walk (on the plane)

  • Makes the VR person teleport on the plane

Requires you to drag a transform into the Teleporting plane parent slot to determine where the plane gets spawned.

Recorded clips

Shows the recorded clips you made during play mode, they are ordered by shot and are sorted by version.

Screenshot 2025-09-09 123935.jpg
  • One or multiple clip(s) can be selected to be:

    • Deleted via the Delete Selected Clips button

      • A confirm window will appear as a safety check

    • Integrated into a Timeline via the Integrate Selected Shots Into The Timeline button

      • Only one clip can be selected per shot

      • The checkbox Integrate interpolated clip keeps the first and last frame and interpolates between those

  • There is also a Delete All Clips button to delete all clips without having to select all of them.

  • You can select multiple clips for deletion or delete them one by one

  • You can select a series of clips (one per shot) and integrate them in the timeline

    • Enabling Integrate Interpolated Clip will interpolate the recorded frames to smoothen the recorded clip

    • Interpolation Sensitivity will determine how sensitive the interpolation will be, a lower value will return more keyframes, a higher value will smoothen the clip more and result in less keyframes

Play Mode Windows

These windows can be accessed while you are in play mode.

image-20251013-093720.png

Settings Menu Canvas

A canvas next to the VR camera, displaying information.

  • Focal Length → select focal length, choose between predefined values

  • Shot → select shot, teleports the VR user to the start postion of the shot

  • Preview Shot → preview the current selected shot in 3D, you can move around, play and pause (Right joystick A button, fast forward and backward (Right joystick thumbstick left & right)

  • Playback Recorded Clips → Move to a cinema room where you can playback recorded clips on a big screen by selecting the clip with the right joystick. The clip loops, if you press the A button on the right joystick, the clip resets. Above the selected clip UI button there is a “back” button, this will bring you back to the set.

  • Storyboard Opacity: Configure the opacity of the storyboard

  • Movement Type → select movement type

    • World: Does not move on the Y axis, only if the left back trigger is held down.

    • Local: Moves relative to the look direction

    • Teleport: Hold down the left back trigger, aim at a point, rotate the left joystick to determine the look direction, release the left back trigger to teleport

  • Movement Speed: Select movement speed by moving a slider, the min and max value of the slider is determined in the VR Tools Window and can only be adjusted outside of playmode

  • Advanced Movement Settings:

    • Acceleration: Determines the time needed to accelerate towards the current speed. Set this to 0 if you do not want to move and 1 if you want to instantly move at the max speed

    • Deceleration: Determines how fast the user slows down when the joystick gets no input: Set this to 0 if you never want to stop moving and 1 if you want to instantly stop moving

  • Camera Tilt: Tilts the camera, choose between predefined values

  • Z Rotation: Toggle the Z rotation of the camera

  • Rule Of Third: Toggle the rule of third guidelines on the camera

  • Attach To Dolly: Toggle automatically attaching to a dolly if possible

Camera Canvas

A canvas overlay over the VR camera, displaying the VR camera view or story board with some small info elements.

  • Background

  • RawImage

  • Storyboard (toggle)

  • Rec (icon indicating camera is recording)

  • Message (name of recorded clip when recording has ended)

Controls

image-20250107-152720.png

Left Joystick

  • Previewing shot:

    • B button: Go to next shot if possible

    • A button: Go to previous shot if possible

  • Movement

    • Thumbstick: move around, see Movement Type for more info

    • Trigger

      • World & Local Movement:

        • (hold) trigger + Thumbstick (up/down) = Move up/down

      • Teleport Movement:

        • (hold) trigger + aim + left joystick to determine look direction (optional) + (release) trigger = teleport

Right Joystick

  • UI

    • Thumbstick (up/down): navigate

    • Thumbstick (left/right): decrease/increase a slider value

    • Primary/A button (press):

      • Select menu section

      • Select menu item

      • Toggle item (storyboard)

  • Movement

    • Thumbstick (When UseRightJoystickWhenRecording is enabled): move around when recording, see Movement Type for more info

    • Hold trigger (up/down) + Thumbstick: navigate vertically through menu

  • Recording

    • Trigger (press): start/stop recording

Wishlist of Future Improvements

  • Camera on dolly track

  • Camera on crane

  • Place characters/objects/props

  • See and playback recorded takes & storyboard

  • Fast forward and Fast backward controls + pause

  • While recording show duration of record session

  • Write down a note after recording a clip (optionaly) → visible in recorded clips unity editor view

  • Modify Focal Length based on virtual slider that user can adjust with left hand, slider appears near RawImage when left hand is close to it

  • Modify Camera Tilt with left hand, tilt icon appears near corner of RawImage when left hand is close, when holding trigger to grab + move left hand → tilts camera on predefined angles

  • Have the current UI fold in and out with B button on right joystick → fallback (is possible with the finger tracking grip force sensor but users did this accidentically so maybe change it to button press)

  • Add default settings the user can define in the unity editor when they want to record most of the shots with a certain focal distance or when they prefer a certain camera tilt to be applied directly when entering play mode