Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 4.41 KB

README.md

File metadata and controls

76 lines (45 loc) · 4.41 KB
Raw

Agora Unity WebGL Plugin and Demo

中文 | English

This project is the open source WebGL SDK for Unity, a wrapper to the Agora Web SDK 4.x.

Important Notice

  1. This is a community supported SDK in open beta. Do not assume everything works correctly as an official product. Do not expect the same behaviors from the original Unity SDK. The Agora Support team does not assume responsibility in solving your issues.
  2. This project is NOT compatible with the current official Agora Unity SDK ver. 4.x
  3. If your just want to get the SDK, do not clone this project unless you plan to contribute code. Instead, go to the Release section download the package.
  4. Check the Wiki page to understand this SDK some more before proceeding to download or asking questions.
  5. Spatial Audio may not work.
  6. If it is not a bug or improvement request, your question probably should be asked in the Discussions page instead.
  7. Do press the Star to show respect to people who work hard on creation of this SDK on your demand.**

Prerequisites

  • Unity 2019 and up
  • Agora Developer Account
  • Knowledge of how to deploy and debug WebGL Application from Unity
  • Google Chrome

Updated main Demo

webgldemo

Quick Start

This section shows you how to prepare, build, and run the sample application.

Obtain an App ID

Before you can build and run any Agora project, you will need to add your AppID to the configuration. Go to your developer account’s project console, create a new AppId or copy the AppId from an existing project.

Note it is important that for a production ready project, you should always use an AppId with token enabled. However, in testing a demo, you will skip this part. Using a testing mode AppId can save time for POC integration. enter image description here

Run the Demo Application

  1. It is optional to clone this repository, to obtain the unity package file, go to the release section and download the latest version.
  2. Import the WebGL SDK package (Unity Editor-> Assets -> Import Package -> Custom Package).
  3. From Project window, open Asset/AgoraEngine/Demo/Main.scene
  4. Next, go into your Hierarchy window and select GameController, in the Inspector add your App ID to to the AppID Input field.

API-Examples

This repository includes a set of API-Examples that shows how to use a particular feature. Starting from Refactor 8 release, these demo scene are grouped into the Home Scene for build. Use the AppIDInfo asset to input the AppID (and token if using certificate enabled AppIDs) WebGL_-WebGL-appID Screenshot 2023-04-17 at 10 25 10 AM

Testing in Editor

You must download the "Complete" package from the Release. The package includes native plugins (Windows/MacOS) that support the Editor environment. Some may confuse on why certain functionalities work differently on Web verses "Editor". That is because the platform differences between the WebGL and the native.

Build and Run

  1. Go to File > Builds > Platform and switch to platform WebGL
  2. Make sure AgoraTemplate or AgoraTemplate2020 is chosen under "Resolution and Presentation": webgl_template The difference of the templates: use AgoraTemplate2020 for Unity Editor 2020 and up.
  3. You may do Build And Run for Unity version 2020 and up. For other versions, you need to build first, then run it from your local http server.

Resources

Please see the Wiki page for more information.

License

The MIT License (MIT). See doc.