Installation guide

Before you Start

  1. Unity Version:

    The latest stable release of Creator is designed for 6000.3.10.

    Warning

    You can use any LTS version above 6000.3.10.

    Unity Hub simplifies version management. If you don’t have it yet, download it from Unity’s official page. After installation, navigate to Installs  > Install Editor.

    ../../_images/unity_hub.png

    Warning

    Install the specified Unity version to avoid incompatibility issues with internal and third-party packages.

  2. Create a New Unity Project:

    Initiate a new Unity project. Opt for the 3D preset when creating the project, as illustrated below:

    ../../_images/project_creation.png

Download Creator

  1. Navigate to Edit > Project Settings > Package Manager.

  2. In the Scoped Registry section, add a new scoped registry and fill in the details as illustrated below.

    ../../_images/ORamaVRRegistry.png

    For your convenience, you can find these links below:

    Name

    ORamaVR

    URL

    https://npm-registry.oramavr.com/

    Scope(s)

    com.oramavr.mages.core
    To enable the experimental package, click the plus icon and add the following scope:

    • com.oramavr.mages.experimental

  3. Click Save and close the Project Settings window.

  4. Navigate to Window > Package Manager. You should be able to locate Creator package under ORamaVR registry.

Note

Make sure to set Packages to My Registries from the dropdown menu on the top of the window, to be able to see the Creator package.

  1. Select the Creator package and click the Install button.

    ../../_images/InstallPackage.png

  2. That’s it, you are done with the installation. You can close the Package Manager window.

Initial Setup

  1. After installing the Creator package, open the Creator Panel by navigating to ORamaVR Creator > Panel at the top bar.

  2. To use Creator, you need an ORamaVR account. Go to the Sign in tab to log in or create an account.

    ../../_images/signin.png

  3. Click on the Getting Started tab inside the Creator Panel and resolve all issues listed on the 2. Configuration section.

    • Issues with the error icon are mandatory for correct Creator functionality.

    • Issues with the warning icon are recommended.

    • Issues with the info icon are needed for specific functionalities.

    ../../_images/panel_startup.png

Note

If you do not require multiplayer in your project, you can ignore the option to install Photon from the Creator Panel.

Adding VR Support

  1. Navigate to Edit > Project Settings > XR Plug-in Management.

  2. There you should see a list of XR settings per platform:

    ../../_images/add_vr_support_button.png

  3. Select the platform of your choice and choose the plugin provider. We recommend OpenXR for Desktop & Android platforms:

    ../../_images/vr_plugin_provider.png

  4. After OpenXR has been installed, you should be navigated to the “Project Validation” tab automatically. Clicking ‘Edit’ on any of the issues will take you to the OpenXR configuration tab:

    ../../_images/oxr_validation.png

  5. In this section, click the ‘+’ button under “Enabled Interaction Profiles”, and choose “Oculus Touch Controller Profile”;

    ../../_images/touch_controller_profile.png

  6. Additionally, check the following boxes:

    ../../_images/checkboxes.png

Warning

Be aware that even though desktop VR is not supported on macOS, standalone VR is and you can fully create a simulation and transfer it to a mobile HMD. Learn more here.