Table of Contents

Add the VIROO Studio package

In this article you will learn how to install the VIROO Studio package in two steps:

  1. Add the necessary Scoped Registries to your Unity project.
  2. Install the Viroo Studio package and its dependencies.
Tip

If you want to get a Unity project with VIROO Studio already configured, you can download a project already configured and with the VIROO Studio package installed from here.

This page covers the steps to add the VIROO Studio package to an existing project. If you download the VIROO Studio project template you are ready to create content and would not need to follow these steps.

Add Scoped registries

You can add the scoped registries needed to use VIROO Studio from the Unity Editor or by editing the manifest.json.

Using the Unity Editor

Open Window -> Package Manager.

Add these scoped registries with the following details:

Note: the scopes must be on one line each, click on the + button to add each of the scopes.

Unity NuGet

Name: Unity NuGet
URL: https://unitynuget-registry.azurewebsites.net
Scope(s):

  • org.nuget

OpenUPM

Name: OpenUPM
URL: https://package.openupm.com
Scope(s):

  • com.cysharp.unitask
  • com.openupm

Viroo

Name: Viroo
URL: https://pkgs.dev.azure.com/virtualwaregroup/be03201a-56db-4141-a519-e8a5ad855787/_packaging/Viroo@Release/npm/registry
Scope(s):

  • com.virtualware
  • com.nmerso
  • com.viroo

Editing manifest.json file

You can find the project manifest file, called manifest.json, in the Packages folder under the root folder of your Unity project.

Below the dependencies section, the scopedRegistries block must be included:

{
  "dependencies": {
    /* ... your dependencies ... */
  },
  "scopedRegistries": [
    {
      "name": "Unity NuGet",
      "url": "https://unitynuget-registry.azurewebsites.net",
      "scopes": [
        "org.nuget"
      ]
    },
    {
      "name": "OpenUPM",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.cysharp.unitask",
        "com.openupm"
      ]
    },
    {
      "name": "Viroo",
      "url": "https://pkgs.dev.azure.com/virtualwaregroup/be03201a-56db-4141-a519-e8a5ad855787/_packaging/Viroo@Release/npm/registry/",
      "scopes": [
        "com.virtualware",
        "com.nmerso",
        "com.viroo"
      ]
    }
  ]
}

Install VIROO Studio and other required packages

There are 2 ways to add the necessary packages in Unity. Choose the one you prefer from the following.

Using the Unity Editor

Open Window -> Package Manager.

To install the VIROO Studio package:

  1. Click the add (+) button in the status bar.
  2. Select Add package by name from the add menu.
  3. Enter com.viroo.studio in the name field.
  4. Enter the exact version (e.g., 1.0.0) in the version field.

    The latest com.viroo.studio package version can be found here.

  5. Click Add.

To install the DOTween package:

  1. Download com.demigiant.dotween package to {PROJECT_DIRECTORY}/Packages directory.
  2. Click the add (+) button in the status bar.
  3. Select Add package from tarball from the add menu.
  4. Navigate to {PROJECT_DIRECTORY}/Packages folder.
  5. Select the com.demigiant.dotween.tgz file.

Editing manifest.json file

Follow the steps below:

  1. Download com.demigiant.dotween package to {PROJECT_DIRECTORY}/Packages directory.
  2. Open manifest.json file.
  3. Add the references to the Viroo Studio package and DOTween in the dependencies section.
{
  "dependencies": {
    /* ... your other dependencies ... */
    "com.demigiant.dotween": "file:com.demigiant.dotween.tgz",
    "com.viroo.studio": "1.0.0", /* Change 1.0.0 to the correct version */
  },
},
  1. Return to Unity Editor to download the packages.

Importing TextMesh Pro Essentials

In both cases, in order for TextMesh Pro to work properly, we need to add some necessary components, for this we will do the following:

  • Click on Window -> TextMeshPro -> Import TMP Essential Resources.