Skip to content

Commit c12c5fd

Browse files
psygamespsygames
committed
readme, version log
1 parent 343a19c commit c12c5fd

File tree

3 files changed

+109
-163
lines changed

3 files changed

+109
-163
lines changed

‎README.md‎

Lines changed: 26 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11

22
[(English)](README_EN.md)
33

4-
## Demo 线上测试地址
5-
- [http://39.105.150.229/UnityWebSocketDemo/](http://39.105.150.229/UnityWebSocketDemo/)
4+
### Demo 线上测试地址
65

7-
## UnityWebSocket 使用
6+
- [http://39.105.150.229/UnityWebSocketDemo/](http://39.105.150.229/UnityWebSocketDemo/)
87

9-
### 1. [最新版本下载](https://github.com/y85171642/UnityWebSocket/releases)
8+
### UnityWebSocket 使用
109

11-
### 2. 使用方法：
10+
#### 1. 下载最新版本
1211

12+
- [https://github.com/y85171642/UnityWebSocket/releases](https://github.com/y85171642/UnityWebSocket/releases)
1313

14-
- 在 Unity 中导入 UnityWebSocket.unitypackage
14+
#### 2. 使用方法：
1515

16-
需要 Scripting Runtime Version = .Net 4.x
16+
- 在 Unity 中导入 UnityWebSocket.unitypackage，需要：
1717

18-
需要 WebGL LinkerTarger = asm.js or Both
18+
* 需要 Scripting Runtime Version = .Net 4.x
19+
* 需要 WebGL LinkerTarger = asm.js or Both
1920

2021
- 使用 WebSocket
2122

@@ -47,83 +48,33 @@
4748

4849
- 详细使用方法可参考项目中的 [Example](UnityWebSocket/Assets/Scripts/Plugins/UnityWebSocket/Example/TestWebSocket.cs) 示例代码。
4950

50-
### 3. 模块说明
51-
- WebSocket.jslib
52-
语法格式需要遵循 [asm.js](http://www.ruanyifeng.com/blog/2017/09/asmjs_emscripten.html)。
51+
#### 3. 注意（Warning）
5352

54-
路径：Plugins/WebSocketJS/WebSocketJS.jslib
55-
作用：Unity发布WebGL版本会将其加入到js运行库中。
53+
- 插件中多个命名空间中存在 **WebSocket** 类，适用不同环境。
54+
55+
命名空间 | 平台 | 方式 | 说明
56+
-|-|-|-
57+
UnityWebSocket.Synchronized | 全平台 | 同步(无阻塞) | **[推荐]** 无需考虑异步回调使用 Unity 组件的问题。
58+
UnityWebSocket.Uniform | 全平台 | 异步 | 需要考虑异步回调使用 Unity 组件的问题。
59+
UnityWebSocket.WebGL | WebGL平台 | 异步 | 仅支持WebGL平台下的通信。
60+
UnityWebSocket.NoWebGL | 非WebGL平台 | 异步 | 仅支持非WebGL平台下的通信。
5661

57-
- WebSocket.cs
62+
#### 4. WebGL 模块说明
5863

59-
作用：WebSocket连接，可同时创建多个不同连接。
60-
已经支持全平台使用。
64+
- WebSocket.jslib 语法格式需要遵循 [asm.js](http://www.ruanyifeng.com/blog/2017/09/asmjs_emscripten.html)。
65+
66+
路径：Plugins/WebSocketJS/WebSocketJS.jslib
67+
作用：Unity发布WebGL版本会将其加入到js运行库中。
6168

6269
- WebSocketReceiver.cs
6370

64-
作用：与jslib交互，负责收发多个WebSocket消息。
71+
作用：与 jslib 交互，负责收发多个WebSocket消息。
6572
该脚本在使用WebSocket时会自动加载到场景中，并添加到DonDestroyOnLoad。
6673

67-
- Example场景
74+
- Example 场景
6875

6976
作用：WebSocket的使用方法示例。
7077

71-
### 4. 注意(Warning)
72-
- Unity2018 以上版本需要修改WebGL平台 Publishing Settings -> Linker Target 为 asm.js 或 Both。
73-
- 插件中多个命名空间中存在 **WebSocket** 类，适用不同环境。
74-
75-
命名空间 | 平台 | 方式 | 说明
76-
-|-|-|-
77-
UnityWebSocket.Synchronized | 全平台 | 同步(无阻塞) | **[推荐]** 无需考虑异步回调使用 Unity 组件的问题。
78-
UnityWebSocket.Uniform | 全平台 | 异步 | 需要考虑异步回调使用 Unity 组件的问题。
79-
UnityWebSocket.WebGL | WebGL平台 | 异步 | 仅支持WebGL平台下的通信。
80-
UnityWebSocket.NoWebGL | 非WebGL平台 | 异步 | 仅支持非WebGL平台下的通信。
78+
#### 5. WebSocket 服务器
8179

82-
### 5. WebSocket服务器
8380
- 使用官方提供的 Echo Test 服务器。参考 [Echo Test](http://www.websocket.org/echo.html)。
84-
85-
### 6. 版本记录
86-
87-
#### v2.0
88-
- 移除 websocket-sharp 插件，使用 .Net 4.x 内置的 ClientWebSocket 作为非 WebGL 平台下 WebSocket 插件。
89-
- 添加**同步方式**的WebSocket ，使用者不必再考虑**异步回调**中使用 Unity 组件的问题。
90-
91-
#### v1.3.2
92-
- 修复 非ssl连接，使用sslConfiguration bug。
93-
94-
#### v1.3.1
95-
- 修复 Tls error，添加默认协议 Tls，Tls11，Tls12。
96-
97-
#### v1.3
98-
- 移除服务器Demo，改用 [websocket-sharp](http://www.websocket.org/echo.html) 官方提供的测试服务器。
99-
- 添加 PlayerSetting -> Linker Target 属性检测。
100-
101-
#### v1.2.2 - pre
102-
- support for wss(ssl) 支持SSL协议格式（更新了websocket-sharp源码）。
103-
- 服务器Demo尚未支持 SSL。会在未来版本支持。
104-
105-
#### v1.2.1
106-
- fix 非WebGL平台打包兼容BUG（屏蔽websocket-jslib部分代码）。
107-
108-
#### v1.2
109-
- 重构代码，规范代码，模块整理。
110-
- 规范接口，参考websocket-sharp结构，使用EventHandler方式处理事件。
111-
- 添加了字符串数据收发的支持。
112-
- jslib中添加了获取socket.readyState的方法。
113-
- jslib中的SendMessage参数整理。
114-
- fix some Bugs.
115-
116-
#### v1.1
117-
- 多平台支持，使用websocket-sharp 开源插件。
118-
- 完善项目命名空间，目录结构。
119-
- WebSocket增加异步连接发送方法。（webgl平台下仍调用同步方式）
120-
- 添加开发分支，git管理方式调整。
121-
122-
#### v1.0
123-
- 支持单客户端同时创建多个不同WebSocket链接。
124-
- 添加OnError错误回调。错误码对应错误原因，参考jslib文件。
125-
- 删除Alert功能（与WebSocket无关，按需求自行添加即可）。
126-
- Close Event Code 作为链接断开错误信息处理。
127-
- jslib 内容完善，增加Map管理websocket实例。
128-
- 修改 State 枚举对应到WebSocket ReadyState。
129-
- 添加 Release Demo Build 文件。

‎README_EN.md‎

Lines changed: 38 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,129 +1,79 @@
11

22
[(中文版)](README.md)
33

4-
## Demo 线上测试地址
5-
- [http://39.105.150.229/UnityWebSocketDemo/](http://39.105.150.229/UnityWebSocketDemo/)
4+
### Demo Online Test
65

7-
## UnityWebSocket 使用
6+
- [http://39.105.150.229/UnityWebSocketDemo/](http://39.105.150.229/UnityWebSocketDemo/)
87

9-
### 1. [最新版本下载](https://github.com/y85171642/UnityWebSocket/releases)
8+
### UnityWebSocket Usage
109

11-
### 2. 使用方法：
10+
#### 1. Download the latest version
1211

12+
- [https://github.com/y85171642/UnityWebSocket/releases](https://github.com/y85171642/UnityWebSocket/releases)
1313

14-
- 在 Unity 中导入 UnityWebSocket.unitypackage
14+
#### 2. Usage:
1515

16-
需要 Scripting Runtime Version = .Net 4.x
16+
- Import UnityWebSocket.unitypackage in Unity, Require:
1717

18-
需要 WebGL LinkerTarger = asm.js or Both
18+
* Require Scripting Runtime Version = .Net 4.x
19+
* Require WebGL LinkerTarger = asm.js or Both
1920

20-
- 使用 WebSocket
21+
- Easy to use WebSocket
2122

2223
```csharp
23-
// 命名空间
24+
// the namespace
2425
using UnityWebSocket;
2526
using UnityWebSocket.Synchronized;
2627

27-
// 创建实例
28+
// create instance
2829
WebSocket scoket = new WebSocket();
2930

30-
// 注册回调
31+
// register callback
3132
scoket.OnOpen += OnOpen;
3233
scoket.OnClose += OnClose;
3334
scoket.OnMessage += OnMessage;
3435
socket.OnError += OnError;
3536

36-
// 连接
37+
// connect
3738
string address = "ws://echo.websocket.org";
3839
socket.ConnectAsync(address);
3940

40-
// 发送数据（两种发送方式）
41-
socket.SendAsync(str); // 发送类型 String 类型数据
42-
socket.SendAsync(bytes); // 发送 byte[] 类型数据
41+
// send data (tow ways)
42+
socket.SendAsync(str); // send String data
43+
socket.SendAsync(bytes); // send byte[] data
4344
44-
// 关闭连接
45+
// close connection
4546
socket.CloseAsync();
4647
```
4748

48-
- 详细使用方法可参考项目中的 [Example](UnityWebSocket/Assets/Scripts/Plugins/UnityWebSocket/Example/TestWebSocket.cs) 示例代码。
49+
- more detail usage, see the [Example](UnityWebSocket/Assets/Scripts/Plugins/UnityWebSocket/Example/TestWebSocket.cs) code in project。
50+
51+
#### 3. Attention(Warning)
4952

50-
### 3. 模块说明
51-
- WebSocket.jslib
52-
语法格式需要遵循 [asm.js](http://www.ruanyifeng.com/blog/2017/09/asmjs_emscripten.html)。
53+
- there are many **WebSocket** class in different namespace, use in different situations.
5354

54-
路径：Plugins/WebSocketJS/WebSocketJS.jslib
55-
作用：Unity发布WebGL版本会将其加入到js运行库中。
55+
namespace | platform | sync style | description
56+
-|-|-|-
57+
UnityWebSocket.Synchronized | all | synchronized(no block) | **[recommend]** no need consider the problem by using unity component in asynchronized callback.
58+
UnityWebSocket.Uniform | all | asynchronized | consider the problem by using unity component in asynchronized callback.
59+
UnityWebSocket.WebGL | WebGL only | asynchronized | only run in WebGL platform.
60+
UnityWebSocket.NoWebGL | WebGL except | asynchronized | only run in not WebGL platforms.
61+
62+
#### 4. WebGL Module Introduction
5663

57-
- WebSocket.cs
64+
- WebSocket.jslib, syntax follow to [asm.js](http://www.ruanyifeng.com/blog/2017/09/asmjs_emscripten.html)。
5865

59-
作用：WebSocket连接，可同时创建多个不同连接。
60-
已经支持全平台使用。
66+
Path: Plugins/WebSocketJS/WebSocketJS.jslib
67+
Fucntion：Unity will deploy it to web js runtime on WebGL platform.
6168

6269
- WebSocketReceiver.cs
6370

64-
作用：与jslib交互，负责收发多个WebSocket消息。
65-
该脚本在使用WebSocket时会自动加载到场景中，并添加到DonDestroyOnLoad。
71+
Function: interact with jslib. this script set as DonDestroyOnLoad.
6672

67-
- Example场景
73+
- Example Scene
6874

69-
作用：WebSocket的使用方法示例。
75+
Function: show how to use UnityWebSocket.
7076

71-
### 4. 注意(Warning)
72-
- Unity2018 以上版本需要修改WebGL平台 Publishing Settings -> Linker Target 为 asm.js 或 Both。
73-
- 插件中多个命名空间中存在 **WebSocket** 类，适用不同环境。
77+
#### 5. WebSocket Server
7478

75-
命名空间 | 平台 | 方式 | 说明
76-
-|-|-|-
77-
UnityWebSocket.Synchronized | 全平台 | 同步(无阻塞) | **[推荐]** 无需考虑异步回调使用 Unity 组件的问题。
78-
UnityWebSocket.Uniform | 全平台 | 异步 | 需要考虑异步回调使用 Unity 组件的问题。
79-
UnityWebSocket.WebGL | WebGL平台 | 异步 | 仅支持WebGL平台下的通信。
80-
UnityWebSocket.NoWebGL | 非WebGL平台 | 异步 | 仅支持非WebGL平台下的通信。
81-
82-
### 5. WebSocket服务器
83-
- 使用官方提供的 Echo Test 服务器。参考 [Echo Test](http://www.websocket.org/echo.html)。
84-
85-
### 6. 版本记录
86-
87-
#### v2.0
88-
- 移除 websocket-sharp 插件，使用 .Net 4.x 内置的 ClientWebSocket 作为非 WebGL 平台下 WebSocket 插件。
89-
- 添加**同步方式**的WebSocket ，使用者不必再考虑**异步回调**中使用 Unity 组件的问题。
90-
91-
#### v1.3.2
92-
- 修复 非ssl连接，使用sslConfiguration bug。
93-
94-
#### v1.3.1
95-
- 修复 Tls error，添加默认协议 Tls，Tls11，Tls12。
96-
97-
#### v1.3
98-
- 移除服务器Demo，改用 [websocket-sharp](http://www.websocket.org/echo.html) 官方提供的测试服务器。
99-
- 添加 PlayerSetting -> Linker Target 属性检测。
100-
101-
#### v1.2.2 - pre
102-
- support for wss(ssl) 支持SSL协议格式（更新了websocket-sharp源码）。
103-
- 服务器Demo尚未支持 SSL。会在未来版本支持。
104-
105-
#### v1.2.1
106-
- fix 非WebGL平台打包兼容BUG（屏蔽websocket-jslib部分代码）。
107-
108-
#### v1.2
109-
- 重构代码，规范代码，模块整理。
110-
- 规范接口，参考websocket-sharp结构，使用EventHandler方式处理事件。
111-
- 添加了字符串数据收发的支持。
112-
- jslib中添加了获取socket.readyState的方法。
113-
- jslib中的SendMessage参数整理。
114-
- fix some Bugs.
115-
116-
#### v1.1
117-
- 多平台支持，使用websocket-sharp 开源插件。
118-
- 完善项目命名空间，目录结构。
119-
- WebSocket增加异步连接发送方法。（webgl平台下仍调用同步方式）
120-
- 添加开发分支，git管理方式调整。
121-
122-
#### v1.0
123-
- 支持单客户端同时创建多个不同WebSocket链接。
124-
- 添加OnError错误回调。错误码对应错误原因，参考jslib文件。
125-
- 删除Alert功能（与WebSocket无关，按需求自行添加即可）。
126-
- Close Event Code 作为链接断开错误信息处理。
127-
- jslib 内容完善，增加Map管理websocket实例。
128-
- 修改 State 枚举对应到WebSocket ReadyState。
129-
- 添加 Release Demo Build 文件。
79+
- use Official Echo Test Server. refer to [Echo Test](http://www.websocket.org/echo.html).

‎VERSION_LOG.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## 版本记录
2+
3+
#### v2.0
4+
- 移除 websocket-sharp 插件，使用 .Net 4.x 内置的 ClientWebSocket 作为非 WebGL 平台下 WebSocket 插件。
5+
- 添加**同步方式**的WebSocket ，使用者不必再考虑**异步回调**中使用 Unity 组件的问题。
6+
7+
#### v1.3.2
8+
- 修复 非ssl连接，使用sslConfiguration bug。
9+
10+
#### v1.3.1
11+
- 修复 Tls error，添加默认协议 Tls，Tls11，Tls12。
12+
13+
#### v1.3
14+
- 移除服务器Demo，改用 [websocket-sharp](http://www.websocket.org/echo.html) 官方提供的测试服务器。
15+
- 添加 PlayerSetting -> Linker Target 属性检测。
16+
17+
#### v1.2.2 - pre
18+
- support for wss(ssl) 支持SSL协议格式（更新了websocket-sharp源码）。
19+
- 服务器Demo尚未支持 SSL。会在未来版本支持。
20+
21+
#### v1.2.1
22+
- fix 非WebGL平台打包兼容BUG（屏蔽websocket-jslib部分代码）。
23+
24+
#### v1.2
25+
- 重构代码，规范代码，模块整理。
26+
- 规范接口，参考websocket-sharp结构，使用EventHandler方式处理事件。
27+
- 添加了字符串数据收发的支持。
28+
- jslib中添加了获取socket.readyState的方法。
29+
- jslib中的SendMessage参数整理。
30+
- fix some Bugs.
31+
32+
#### v1.1
33+
- 多平台支持，使用websocket-sharp 开源插件。
34+
- 完善项目命名空间，目录结构。
35+
- WebSocket增加异步连接发送方法。（webgl平台下仍调用同步方式）
36+
- 添加开发分支，git管理方式调整。
37+
38+
#### v1.0
39+
- 支持单客户端同时创建多个不同WebSocket链接。
40+
- 添加OnError错误回调。错误码对应错误原因，参考jslib文件。
41+
- 删除Alert功能（与WebSocket无关，按需求自行添加即可）。
42+
- Close Event Code 作为链接断开错误信息处理。
43+
- jslib 内容完善，增加Map管理websocket实例。
44+
- 修改 State 枚举对应到WebSocket ReadyState。
45+
- 添加 Release Demo Build 文件。

0 commit comments

Comments
 (0)