Installation guide

Before you Start

  1. Unity Version:

    The latest stable release of MAGES SDK is designed for Unity 2022.3.

    Warning

    You can use any LTS version above 2022.3.12.

    The support for Unity 2023 is under construction.

    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 MAGES™ SDK

  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

  3. Click Save and close the Project Settings window.

  4. Navigate to Window > Package Manager. You should be able to locate MAGES™ 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 MAGES™ SDK package.

  1. Select the MAGES™ package and click the Install button.

    ../../_images/InstallPackage.png

  2. After installation, the window below will pop. This indicates that MAGES uses the new Unity input system package. Click on the Yes button to restart your Unity editor.

    ../../_images/InstallRestart.png

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

Initial Setup

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

  2. To use MAGES™ SDK, 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 MAGES Panel and resolve all issues listed on the 2. Configuration section.

    • Issues with the error icon are mandatory for correct SDK 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 MAGES panel.

Adding VR Support

  1. In the MAGES Panel, navigate to the Configuration Tab.

  2. Fix the issue related to VR Support and the installation of the XR Plugin Management (if not done during the initial setup).

    ../../_images/add_vr_support_button.png

  3. After fixing that, a window will pop up with the XR Plugin Management settings. Select the plugin of the VR provider you are using.

    ../../_images/vr_plugin_provider.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.