Add the VIROO Studio package
In this article you will learn how to install the VIROO Studio package in two steps:
- Add the necessary Scoped Registries to your Unity project.
- 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 it 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.viroo.cloud
Scopes:
- org.nuget
OpenUPM
Name: OpenUPM
Url: https://package.openupm.com
Scopes:
- com.annulusgames.lit-motion,
- 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
Scopes:
- 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.viroo.cloud/",
"scopes": [
"org.nuget"
]
},
{
"name": "OpenUPM",
"url": "https://package.openupm.com",
"scopes": [
"com.annulusgames.lit-motion",
"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
It's possible to add the necessary packages in Unity in two different ways. Choose the one you prefer from the following.
Using the Unity Editor
Open Window -> Package Manager.
To install the VIROO Studio package:
- Click the
add (+) buttonin the status bar. - Select
Add package by namefrom the add menu. - Enter
com.viroo.studioin thenamefield. - Enter the exact version (for example:
1.0.0) in theversionfield.The latest
com.viroo.studiopackage version can be found in the Viroo feed. - Click
Add.
Editing manifest.json file
Follow the steps below:
- Open
manifest.jsonfile. - Add the references to the Viroo Studio package in the
dependenciessection.
{
"dependencies": {
/* ... your other dependencies ... */
"com.viroo.studio": "1.0.0", /* Change 1.0.0 to the correct version */
},
},
- Return to Unity Editor to download the packages.
Importing TextMesh Pro Essentials
In both cases, in order for TextMesh Pro to work, you need to add some necessary components, for this, do the following:
- Click on
Window -> TextMeshPro -> Import TMP Essential Resources.