GS2-Realtime API リファレンス

リアルタイム通信機能

対戦・協力プレイ機能を実現します。

ルームを作成すると、IPアドレス ポート 暗号鍵 の3つの情報が発行されます。
ルームに参加するには、発行された IPアドレス ポート に WebSocket で接続します。
その通信には発行された 暗号鍵 を使用して通信します。

一般的な GS2 のサービスは API リクエスト回数に対して料金が発生しますが、
このサービスはゲームサーバーの起動時間と通信容量に対して費用が発生し、
通信回数に対しては費用が発生しません。

ルームのライフサイクル

作成

GS2-Realtime はルームの作成リクエストを受け付けてからサーバを起動します。
この時、割り当て可能な空きルームが一定数を下回っていた場合、
ホットスタンバイとなるルームをまとめて追加で起動します。

つまり、リクエストを受け付けてからサーバを起動する コールドスタート 時と ホットスタンバイされたルームを利用する ウォームスタート でルームの作成リクエストを受け付けてから実際に割り当てられるまでの時間に差が生じます。

コールドスタート時の待ち時間の目安は 40秒〜60秒
ウォームスタート時の待ち時間の目安は1秒〜3秒です。

終了

起動されたルームは作成後5分間誰も接続に来なかった場合終了されます。
この終了処理はホットスタンバイのルームにも適用されますが、ホットスタンバイの起動時間は利用料金に加算されません。

ルームに参加するすべてのプレイヤーから無通信状態が1分間続いても自動的に終了されます。

ルームの最大起動時間は3時間です。作成から3時間が経過すると自動的に終了されます。

コールドスタートの発生条件

  • ホットスタンバイを用意するより早くサーバーの起動リクエストを出した場合
  • ゲームサーバーのバージョンアップが行われた場合
  • 起動リクエストが頻繁に発生しない規模のため、ホットスタンバイが用意されていない場合

オブジェクト同期とサーバーサイドステートマシン

relay / sync / stateMachine の違いと選び方は、構成と選び方を参照してください。初めての場合は、チュートリアルで、サーバーで HP を管理する敵を作るところから始められます。


オブジェクト同期・ステートマシン

構成と選び方

relay・sync・stateMachine の違い、選び方、開発の流れ

チュートリアル: オブジェクト同期

ルールを書かずに、各プレイヤーのキャラクターの位置と RPC を Unity で同期するまでの手順

チュートリアル: サーバーサイドロジック

C# でルームのルールを書き、Unity で複数のプレイヤーが同じ敵を攻撃できるようにするまでの手順

チュートリアル: ロールバック式同期

キャラクターの位置をサーバーが入力から計算し、自分のキャラクターは予測して遅延なく動かすまでの手順

オブジェクト同期の仕組み

sync と stateMachine のルームで、オブジェクトがどう同期され、誰が何を書き換えられるか

Unity クライアント

共有オブジェクトを Unity で表示・操作するためのコンポーネントと設定

Godot クライアント

共有オブジェクトを Godot で表示・操作するためのノードと設定

ルーム定義リファレンス

stateMachine のルームで実行するルールの書き方、Room API、実行規則、上限値

GDScript でルールを書く

stateMachine のルームのルールを GDScript で書き、Godot から生成・登録する方法

ゲームから使う

Game Engine

ゲームエンジン向け GS2-Realtime SDK の モデルの仕様 と API のリファレンス

SDK

各種プログラミング言語向け GS2-Realtime SDK の モデルの仕様 と API のリファレンス

設定・連携

Deploy/CDK

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

関連ドキュメント

Photon からの移行

Photon(PUN2)で作ったマルチプレイを GS2-Realtime の sync / stateMachine へ移す手順と対応表