Note

Access to Xareus requires a licence and an account. Please contact-us before following the installation instructions below.

Configure Unity3D Package Manager

This first section consists in configuring the Package Manager in order to be able to download Xareus and other tools.

1. In Unity, open the Package Manager Settings Edit>Project Settings>Package Manager
2. Add a new Scoped Registry, name it whatever you want
3. Set the following URL : https://vrbooking [dot] irisa [dot] fr/npm
4. Set the following scopes : fr.insa.xareus, fr.inria.unity.tools, fr.inria.npm_authentication
   

Note

You might need to tick "Enable Pre-release Packages" if you wish to get access to the most up to date versions of the packages

5. In the Package Manager of your project, you should be able to see some packages : Window>Package Manager then select "Packages: My Registries". Xareus might not be visible yet if you have not performed the authentication step.

Authentication to the repository

These steps have to be done only once on your Windows account.

Create a token

First, log to your https://gitlab.inria.fr account that has access to the xareus_unity project and access https://gitlab.inria.fr/-/profile/personal_access_tokens. Create a new token with api_read access and copy the token value, it will be used in the next steps.

Authenticate

Note

You can then either install "Npm Authentication" and follow the steps in Edit>Preferences>Package Manager>Registry Authentication (see next steps below) - or - (less convenient) follow the instructions on this web page : https://docs.unity3d.com/Manual/upm-config-scoped.html

1. Go to Window>Package Manager then select "Packages: My Registries".
2. Install the Npm Authentication package
3. Go to Edit>Preferences>Package Manager>Registry Authentication, click Add New Registry Authentication if necessary and fill the following fields :
   1. Registry URL : https://vrbooking [dot] irisa [dot] fr/npm
   2. E-Mail : enter any e-mail
   3. Login : enter your gitlab.inria.fr account login
   4. Token, enter the token you previously created
4. Click Login and get Auth Token. The AuthToken should now be filled with a value
5. Click Save All Authentications

6. You should now be able to refresh the package list in the Package Manager tab in "My Registries" and see the Xareus package.

Download Xareus Package

1. Go to Window>Package Manager then select "Packages: My Registries".
2. Install the Xareus package. this will install dependency packages automatically

Note

If there is an error regarding log4net in the console, you might need to remove Unity's Version Control package from your project (switch to "Packages: In Project"), it might be installed by default.

3. If you later need to update Xareus, install samples, or other Xareus Packages, you can do so in this view of the Package Manager.