Setting up Agora World UnitySDK in an Existing Unity Project

Summary:

1. Install Unity and Download the correct Unity Engine version
2. Activate Your Unity License
3. Using an Existing Unity Project
4. Download and Import Agora World UnitySDK
5. Match Layers

1. Install Unity

The first thing you'll need to do is make sure you have Unity installed. You will need Unity Engine version 2021.3.0f1 to be able to successfully use the Agora World UnitySDK.

• Download and install Unity Hub
  • Copy and Paste the following link into your browser's address bar to open Unity Hub and begin the installation process: unityhub://2021.3.0f1/6eacc8284459.
    • Alternatively, you can also go to this webpage: https://unity.com/releases/editor/archive, click Unity 2021.X, and click the "Unity Hub" button next to Unity 2021.3.0 (April 11, 2022)
  • You will also have to install both "Mac Build Support (Mono)" and "Windows Build Support (Mono)". It automatically installs support for the device you are using so make sure to click the checkbox next to whichever is the opposite of the computer platform you are on.
    • 

 

2. Activate your Unity License

• Unity is free for companies/individuals with revenue/funding less than $100k/year. Check out their pricing page and purchase a plan if your company makes more than that. https://store.unity.com/compare-plans

• Unity Hub should prompt you to sign in and/or activate a license, the instructions for which can be found here: https://support.unity.com/hc/en-us/articles/211438683-How-do-I-activate-my-license-(if this link is outdated, Google "how to activate Unity license in Unity Hub").

3. Using an Existing Unity Project

• • Open Unity Hub (if not already open) and simply open your desired Unity Project.

4. Download and Import Agora World UnitySDK

• Click here to download the Agora World UnitySDK
• Importing the Agora World UnitySDK
  • Make sure your chosen Unity project for Agora World development is open.
  • Unzip the file and then double-click the AgoraWorldSDK package you downloaded
  • Click the "Import" button in bottom right of the "Import Unity Package" window that pops up.

5. Match Layers

To use Custom Art slot and Custom Booth slot functionality in WorldSDK, and to ensure consistent behavior for plugins, you'll need to match your Unity layers to our app's.

• To match layers, Select AgoraWorld->Match Layers from the top Unity Editor menu bar.
  • That's it! You can check that the layers were created by clicking the Layers button in the top right of the Unity editor. There should be an entry for "Avatar" at 11, plus many more layers.

Updated January 24, 2023 21:21