【UnityAsset】Easy WebSocket の使い方
2019-05-08 2019-05-22
OverView
UnityAsset “Easy WebSocket”の紹介と使い方です．このアセットを用いることによりUnity上でWebSokcetを用いた通信を簡単に行うことが可能になります．
アセット本体は以下のリンク先で公開しています．
Environment
- macOS Mojave 10.14.4
- Unity2018.2.14f1
- Easy WebSocket 1.0.0
Unity Easy WebSocketとは
Unity上でのWebSocket通信をコンポーネント1個追加するだけでサーバ，クライアントでの動作を可能にするアセットです．このアセットを利用することによりネットワーク同期に対応したアプリなどを
Unityで開発する場合の開発コストを抑えることができます．
EasyWSServerコンポーネントを利用することでWebSocketServerが立ち上がり，
EasyWSClientコンポーネントを利用することでWebSocketClientとして動作します．
また，WebSocketを用いているため，node.jsやRuby on Railsなどとも接続が可能です．
Method
以下導入方法と使用方法です．Unityにアセットをインポート
Unity Asset StoreよりEasy WebSocketをインポート
EasyWSServerコンポーネントを適当なGameObjectに追加
サーバ機能を持たせたいプロジェクトにはEasyWSServerコンポーネントを追加します．※クライアントとしてしか動作させない場合はこのコンポーネントは不要です．
EasyWSServerコンポーネントの設定
サーバ設定はこのコンポーネントのインスペクター上から行うことができます．- Use Port
サーバのリスナー・ポート番号 - Receive Call Back
サーバへデータが届いたときに実行したいメソッドを登録します．引数はByte[]型で受信したデータが入ります．
EasyWSClient コンポーネントを適当な GameObject に追加
クライアント機能を持たせたいプロジェクトにはEasyWSClientコンポーネントを追加します．※サーバとしてしか動作させない場合はこのコンポーネントは不要です．
EasyWSClientコンポーネントの設定
クライアント設定はこのコンポーネントのインスペクター上から行うことができます．
- Server Address
サーバのアドレス．入力例:192.168.100.1 - Server Port
サーバのリスナー・ポート番号 - Receive Call Back
クライアントへデータが届いたときに実行したいメソッドを登録します．引数はByte[]型で，受信データが入ります．
サーバとクライアントの起動（活性化），停止とメッセージの送信
nmxi EasyWebSocket/Scenes/Demo シーンにサーバとクライアントの起動 (活性化) の サンプルがあります.Demo シーン内の「Master」という名前の GameObject を見て頂く と分かりやすいかもしれません.
EasyWSServerコンポーネントの起動と停止
|
1 2 3 4 5 6 7 8 9 10 |
//ポート番号設定後，スクリプトなどから Public メソッド StartWebSocketServer(); //例 GetComponent<EasyWSServer>.StartWebSocketServer(); //を呼び出すことで WebSocket サーバが立ち上がります. //また，以下の Public メソッドを呼び出すことでサーバを止めることができます. StopWebSocketServer(); //例 GetComponent<EasyWSServer>.StopWebSocketServer(); |
EasyWSClientコンポーネントの起動と停止
|
1 2 3 4 5 6 7 8 9 10 |
//ポート番号とアドレスの設定後，スクリプトなどから Public メソッド StartWebSocketClient() //例 GetComponent<EasyWSClient>().StartWebSocketClient(); //を呼び出すことで WebSocket クライアントが立ち上がります. //また，以下の Public メソッドを呼び出すことでクライアントを止めることができます. StopWebSocketClient(); //例 GetComponent<EasyWSClient>.StopWebSocketClient(); |
サーバ → クライアントのデータ送信（1.0.0ではブロードキャストのみ可能）
|
1 2 3 |
BroadCastMessage(Byte[] variable); //例: GetComponent<EasyWSServer>().BroadCastMessage(System.Text.Encoding.GetEncoding(”Shift JIS”).GetBytes( sendText)); |
クライアント → サーバのデータ送信
|
1 2 3 |
SendMessage(Byte[] variable); //例: GetComponent<EasyWSClient>().SendMessage(System.Text.Encoding.GetEncoding(”Shift JIS”).GetBytes( sendText)); |
Lisence
このアセットのライセンス表記This asset is governed by the Asset Store EULA.
however, the following components are governed by the licenses indicated below.
——————–
UniRx , ”MIT” license
——————–
The MIT License (MIT)
Copyright (c) 2018 Yoshifumi Kawai
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ”Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ”AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONIN- FRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEAL- INGS IN THE SOFTWARE.
——————–
websocket-sharp , ”MIT” license
——————–
The MIT License (MIT)
Copyright (c) 2010-2018 sta.blockhead
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ”Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ”AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONIN- FRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEAL- INGS IN THE SOFTWARE.
Could you me know if this websocket server support WebGL or not? thanks!
Thanks comment. Not support WebGL on the current version. sorry ;(