netcode.io browser
netcode.io helper
このリポジトリにより、ブラウザでの導入に先立って、ブラウザ拡張機能を介して netcode.io を使用できるようになります。 netcode.io は、マルチプレイヤー HTML5 ゲームをサポートする目的で、Web ブラウザーで UDP を安全に使用できるようにします。 netcode.io の詳細については、ここを参照してください。
netcode.io は、拡張機能を介して次のブラウザでサポートされています。
モバイル プラットフォームは拡張機能やネイティブ メッセージングをサポートしていないため、ブラウザーで netcode.io サポートがネイティブに表示されるまで、モバイル デバイスのサポートは基本的に不可能です。
これが機能するには、ブラウザ拡張機能と、実際の netcode.io 通信を実行するネイティブ アプリケーション ヘルパーの両方をインストールする必要があります。この拡張機能は、ヘルパー経由で netcode.io を利用できるようにするために、ブラウザーで提供されるネイティブ メッセージング API を使用します。
ブラウザでこれを試すには、まず netcode.io.host ヘルパーをビルドします。
go get github.com/wirepair/netcodego build - 現在の OS の場合env GOOS=windows GOARCH=amd64 go build - Windows 用にビルドします (Linux スタイルで環境変数を設定します)env GOOS=linux GOARCH=amd64 go build - Linux 用にビルドします (Linux スタイルで環境変数を設定します)env GOOS=darwin GOARCH=amd64 go build - Mac 用にビルドします (Linux スタイルで環境変数を設定します) ./netcode.io.host
これはエラーなしで実行され、ネイティブ メッセージング拡張機能としてインストールされます。
これが完了したら、 browserwebextディレクトリを解凍された拡張機能として追加します。
この API は、JavaScript クライアントがwindow.netcodeとして利用できるようになりました。従来のif (window.netcode) { ... }パターンを使用して netcode.io が利用可能かどうかを確認できます。
window.netcodeは、 createClient(callback)という 1 つの関数が用意されています。
netcode.io プロトコルを使用した安全な UDP 通信に使用できる新しい netcode.io クライアントを作成します。コールバックの形式はcallback(err, client)です。 errが設定されている場合、クライアントの作成中にエラーが発生しました ( client null になります)。それ以外の場合はclientが設定され、 err null になります。返されるクライアントはClientのインスタンスです。
protocol ipv4またはipv6いずれかである必要があり、接続できるサーバー アドレスの種類が決まります。
パラメータ:
protocol : ipv4またはipv6のいずれか。callback : callback(err, client)形式のコールバック。 ここで、 errはnullまたはErrorのインスタンス、 client nullまたはClientのインスタンスのいずれかです。 netcode.io ヘルパーがユーザーによってインストールされているかどうかを確認します。コールバックの形式はcallback(err, isPresent)で、 errはnullまたはErrorのインスタンスです。エラーがない場合、 isPresentネイティブ ヘルパーがインストールされているかどうかを示すブール値です。
netcode.io ヘルパーがインストールされていない場合は、netcode.io ヘルパーを簡単にインストールできる https://github.com/RedpointGames/netcode.io-browser/releases/tag/latest にユーザーを誘導する必要があります。数回クリックするだけ。
パラメータ:
callback : callback(err, isPresent)形式のコールバック。 errはnullまたはErrorのインスタンスで、 isPresent nullまたはブール値のいずれかです。 netcode.io クライアントのティック レートを設定します。パケットの送受信における 1 秒あたりのティック数として表されます。クライアントのティック レートのデフォルトは60です。つまり、1 秒間に 60 回です。
パラメータ:
tickRate : 1以上の整数。callback : callback(err)形式のコールバック。 err nullまたはErrorのインスタンスです。指定されたトークンを使用して netcode.io サーバーに接続します。 token Uint8Arrayのインスタンスであり、認証サーバーから受信した netcode.io トークンを表す必要があります。
netcode.io を使用して UDP パケットを任意の IP アドレスに送信することはできません。代わりに、netcode.io ライブラリ (または互換性のある実装) を使用する認証サーバーが必要です。このライブラリでは、ゲーム サーバーの IP アドレスのリストと、認証サーバーとゲーム サーバー間で共有される秘密キーを使用してトークンを生成および署名できます。
ほとんどの一般的なシナリオでは、認証サーバーは AJAX リクエストの一部としてトークンを提供します。ユーザー アカウント システムを使用している場合は、ユーザーがゲームにログインした後、クライアントがどのサーバーへの接続を許可されているかを示すトークンを提供します。
パラメータ:
token : トークン データを含むUint8Arrayインスタンス。callback : callback(err)形式のコールバック。 err nullまたはErrorのインスタンスです。 packetBufferをデータとして接続先のサーバーにパケットを送信します。 packetBuffer Uint8Arrayのインスタンスである必要があります。
パラメータ:
token : 送信するパケット データを含むUint8Arrayインスタンス。callback : callback(err)形式のコールバック。 err nullまたはErrorのインスタンスです。クライアントの現在の状態を文字列として返します。返される状態は、 connected 、 connectionDenied 、 connectionRequestTimeout 、 connectionResponseTimeout 、 connectionTimedOut 、 connectTokenExpired 、 disconnected 、 invalidConnectToken 、 sendingConnectionRequest 、 sendingConnectionResponse 、またはdestroyedのいずれかです。
パラメータ:
callback : callback(err, state)形式のコールバック。 err nullまたはErrorのインスタンスです。 state null (エラーの場合) または上記のいずれかの状態です。クライアントを破棄し、サーバーから切断し、関連するリソースをクリーンアップします。クライアントは一度破棄されると再利用できません。
パラメータ:
callback : callback(err)形式のコールバック。 err nullまたはErrorのインスタンスです。イベントリスナーをクライアントに追加します。現在サポートされているtypeはreceiveのみです。これは、クライアントがサーバーからパケットを受信したときに起動されます。
receiveの場合、コールバックはcallback(clientId, buffer)の形式になります。 clientIdは認証サーバーによって最初に発行されたクライアント識別子であり、 buffer Uint8Arrayのインスタンスとして受信されたパケットです。
パラメータ:
type : 上記のサポートされているタイプの 1 つ。callback : typeに基づいて形式が異なるコールバック。 このホスト拡張コードは、MIT ライセンスに基づいて提供されます。
このプロジェクトの現在の主な目標は次のとおりです。
すべてのプル リクエストは、MIT ライセンスに基づいて利用可能にする必要があります。
