Skip to content

Commit bd68753

Browse files
authored
Merge pull request #130 from zeng16107/main
add Chinese language version of README.zh.md file.
2 parents 3834cc8 + 32b4fd0 commit bd68753

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Agora Unity WebGL Plugin and Demo
22

3+
*[中文](README.zh.md) | English*
4+
35
This project is the open source WebGL SDK for Unity, a wrapper to the Agora Web SDK 4.x.
46

57
**Please be aware that this is still a beta release. Do not assume everything works correctly as an official product. Do not expect the same behaviors from the original Unity SDK. You should check the README files to understand this SDK some more before proceeding to download. Do press the Star to show respect to people who work hard on creation of this SDK on your demand.**

README.zh.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Agora Unity WebGL 插件和示例
2+
3+
*[English](README.md) | 中文*
4+
5+
此项目是Unity WebGL的开源项目,包装了Agora Web SDK4.x版本。
6+
7+
**请注意到此项目还处于Beta阶段,不能保证所有功能没有错误和非预期行为,可能存在跟Agora Unity SDK版本行为不一致的情况。在下载和正式使用之前,请仔细阅读README文件。如果您喜欢这个项目,请点击Star,谢谢!**
8+
9+
## 前置条件
10+
- Unity 2017 以上版本
11+
- Agora 开发者账号
12+
- 理解如何部署、调试Unity WebGL项目
13+
- Google Chrome 浏览器
14+
15+
## Unity WebGL Demo 截图
16+
17+
![webgldemo](https://user-images.githubusercontent.com/1261195/180123220-ca7e96e2-bff5-48d7-b5bd-30a37003bdc9.png)
18+
19+
20+
## 快速开始
21+
22+
这一部分介绍如何准备、编译和运行示例程序
23+
24+
25+
### 获取 App ID
26+
27+
在您编译和运行任何Agora项目时,必须获取App ID和做相关的配置。请移步至 [开发者账号的 项目管理](https://console.agora.io/projects), 创建新的App ID 或者拷贝一个已有的项目App ID。
28+
**注意** 对于生产环境项目,您必须使用开启了Token验证的项目App ID。当然,如果仅仅是测试,可以忽略使用Token,使用测试模式,可以在POC集成阶段节省大量时间.
29+
![enter image description here](https://user-images.githubusercontent.com/1261195/110023464-11eb0480-7ce2-11eb-99d6-031af60715ab.png)
30+
31+
32+
33+
### 运行Demo程序
34+
35+
1. 即可以克隆此仓库, 也可以直接下载发布的unity package文件, 移步至 [发布页面](https://github.com/AgoraIO-Community/Agora_Unity_WebGL/releases) ,下载最新版本.
36+
2. [可选] 下载并导入Agora Video SDK
37+
3. 导入WebGL SDK 包(Unity Editor-> Assets -> Import Package -> Custom Package). 如果第2步已经做了,这里会覆盖之前的所有文件。
38+
4. 在 Project 窗口, 打开 Asset/AgoraEngine/Demo/Main.scene
39+
5. 下一步, 找到 Hierarchy window 并选择 ****GameController****, 在Inspector 中添加 ****App ID********AppID**** 输入框.
40+
41+
### API-Examples
42+
这个仓库包括了API-Examples的的子集,其编译版本来自 [主板SDK版本](https://github.com/AgoraIO/Agora-Unity-Quickstart/tree/master/API-Example-Unity).
43+
请使用Canvas game object来填写App ID,而不是GameController.
44+
45+
### [可选] 使用Editor测试
46+
您必须在第2步下载Agora Video SDK
47+
48+
### 编译和运行
49+
50+
1. 打开 ****File**** > ****Builds**** > ****Platform**** ,然后 切换至 WebGL 平台
51+
2. 确保 "Resolution and Presentation"设置,选择了****AgoraTemplate**** 或者 ****AgoraTemplate2020****
52+
![webgl_template](https://user-images.githubusercontent.com/1261195/130500369-53dca294-2cf5-4a0d-a875-a8ab8fbabd70.png)
53+
54+
模板的差别: 如果是Unity Editor 2020以及以上版本,使用 AgoraTemplate2020模板.
55+
56+
3. 对于Unity Editor 2020以及以上版本,您可以直接编译和运行。对于Unity 2017,需要先编译,然后从本地Http服务器上运行。
57+
58+
59+
60+
61+
## 资源
62+
63+
请点击 [Wiki页面](https://github.com/AgoraIO-Community/Agora_Unity_WebGL/wiki) 查阅更多信息
64+
65+
## 许可
66+
The MIT License (MIT). [查阅文件内容](LICENSE)

0 commit comments

Comments
 (0)