Welcome to the official Vlly Unity SDK! The Vlly Unity SDK is an open-source project, and we'd love to see your contributions! This SDK works with Unity 2021.3.19 and higher. If you need another versions supported please open an issue on Github.

1. Installation

Option 1: Unity Package Manager

1. Make sure you have Git installed.
2. In Unity, click Window > Package Manager.
3. Click the plus + sign and select Add package from Git URL.
4. Enter https://github.com/tremayne-stewart/vlly-unity.git#main, and then click Add.
5. The Unity editor imports the package from Github.

Option 2: Manually Modify the Manifest

1. In your unity project root open ./Packages/manifest.json
2. Add the following line to the dependencies section "com.vlly.unity": "[<https://github.com/tremayne-stewart/vlly-unity.git#main>](<https://github.com/tremayne-stewart/vlly-unity.git#main>)"
3. Open Unity and the package should download automatically.

2. Initialize Vlly

To start capturing clips with the Vlly Unity Library, you must first initialize it with your API Key. You can find your API Key on the homepage of the dashboard.

To initialize the library, first open the unity project settings menu for Vlly; click Edit > Project Settings > Vlly. Then, enter your api key into the Api Key input field within the inspector. Please note if you prefer to initialize Vlly manually, you can select the Manual Initialization in the settings and call Vlly.Init() somewhere in a script to initialize.

3. Add a Camera

For Vlly to see what the users sees Vlly needs eyes in your scene.