README.zh.md

Agora Unity WebGL 插件和示例

English | 中文

此项目是Unity WebGL的开源项目，包装了Agora Web SDK4.x版本。

1. 这是一个社区支持的公开测试版 SDK。 可能存在跟Agora Unity SDK版本行为不一致的情况, 不要指望原始 Unity SDK 具有相同的行为。 请评估在生产环境中使用它的风险。
2. 这个项目不兼容当前最新的 Agora Unity SDK 官方版本。 4.x
3. 如果你只是想获得SDK，不要克隆这个项目，除非你打算贡献代码。 请到 Release 部分下载包。
4. 在继续下载或提问之前，查看Wiki 页面 以进一步了解此SDK。
5. 如果不是错误或改进请求，请把您的问题可能在讨论 页面中提出。
6. 如果您喜欢这个项目，请点击右上角的星星，谢谢

前置条件

• Unity 2019 以上版本
• Agora 开发者账号
• 理解如何部署、调试Unity WebGL项目
• Google Chrome 浏览器

Unity WebGL Demo 截图

快速开始

这一部分介绍如何准备、编译和运行示例程序

获取 App ID

在您编译和运行任何Agora项目时，必须获取App ID和做相关的配置。请移步至 开发者账号的 项目管理, 创建新的App ID 或者拷贝一个已有的项目App ID。 注意 对于生产环境项目，您必须使用开启了Token验证的项目App ID。当然，如果仅仅是测试，可以忽略使用Token，使用测试模式，可以在POC集成阶段节省大量时间.

运行Demo程序

1. 请移步至 发布页面 ，下载最新版本.
2. 导入WebGL SDK 包(Unity Editor-> Assets -> Import Package -> Custom Package).
3. 在 Project 窗口, 打开 Asset/AgoraEngine/Demo/Main.scene
4. 下一步, 找到 Hierarchy window 并选择 GameController, 在Inspector 中添加 App ID 到 AppID 输入框.

API-Examples

该存储库包含一组 API 示例，展示了如何使用特定功能。 对于大多数演示，请使用 Canvas 游戏对象来填充 AppID 而不是 GameController。

[可选] 使用Editor测试

您必须从发行版下载“完整”包(complete package)。 该软件包包括支持编辑器环境的本机插件。

编译和运行

1. 打开 File > Builds > Platform ，然后 切换至 WebGL 平台
2. 确保 "Resolution and Presentation"设置，选择了AgoraTemplate 或者 AgoraTemplate2020

模板的差别: 如果是Unity Editor 2020以及以上版本，使用 AgoraTemplate2020模板.

3. 对于Unity Editor 2020以及以上版本，您可以直接编译和运行。其它版本需要先编译，然后从本地Http服务器上运行。

资源

请点击 Wiki页面 查阅更多信息

许可

The MIT License (MIT). 查阅文件内容