Setting up Agora World UnitySDK with a New Unity Project


  1. Install Unity and Download the correct Unity Engine version
  2. Activate Your Unity License
  3. Create a new 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.
    • 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.
      • Screen_Shot_2023-01-22_at_3.18.22_PM.png


2. Activate your Unity License

3. Create a new Unity project

  • Open Unity Hub (if not already open) and Click the "New" button (blue, top right).
  • Select "3D", give your project a name, choose where you want it stored, and click "Create Project".
    • Screen_Shot_2023-01-22_at_3.32.50_PM.png

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.






Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request



Please sign in to leave a comment.