Skip to content

Welcome to the V-ROOM Documentations

Find how to setup various things needed to work with the V-ROOM Project Team.


Project prerequisites

Please download and install the following software to start developing.

Prerequisite Version Link(s)
Unity Hub Latest Download Download
Unity Editor 2020.3.41f1 Get on Unity Hub
Steam Latest Get Steam
SteamVR Latest Get on Steam View on Web

Important

You can't start working until you have all of these software!


Documentations

This section details various setting up guides especially useful for first-time users or when trying to do complex operations.

Software Setup

Unity Installation Guide

Development Guides

Virtual Reality
Augmented Reality
Mixed Reality

Virtual Reality (VR)

Augmented Reality (AR)

Mixed Reality (MR)

Unity Plug-in List

Plugin Name Quick Link
SteamVR Plugin Setup Guide | Local link
Embedded Browser Setup Guide
Mixed Reality Toolkit Setup Guide

Documentations layout

You don't need to worry about this section!

This is for the documentations maintainer to see the layout of this website.

mkdocs.yml              # The configuration file.
README.md               # The README shown on GitHub
docs/
    index.md            # The documentation homepage.
    about.md            # About us page.

    user-guide/
        unity-setup.md      # Unity installation & Unity License activation.
        project-setup.md    # Setting up a project in Unity.
        steamvr.md          # Setting up SteamVR in Unity.
        zfbrowser.md        # Setting up ZF Browser (including for SteamVR)

    img/                # Contains various images used in the site
        logo/           # Logo images