​

LocalMultiplayerAgent をコンテナー モードで使用してゲーム サーバーを実行する方法

• Wrapper サンプルを使用して [Linux/Windows] コンテナー ビルドを作成する
• MultiplayerSettings.json を構成する
• Docker のセットアップ
• LocalMultiplayerAgent を実行する
• ゲーム接続をテストする

​

[Linux/Windows] コンテナー ビルドを作成する

​

Linux コンテナー ビルド

​

Windows コンテナー ビルド

​

MultiplayerSettings.json を構成する

{
    "RunContainer": true, // Set RunContainer to true if you are running LMA in Container mode.
    "OutputFolder": "C:\\output\\LMAContainer", // Path where config files and logs will be generated from LMA at each run
    "NumHeartBeatsForActivateResponse": 10,
    "NumHeartBeatsForTerminateResponse": 60,
    "TitleId": "", // default value
    "BuildId": "00000000-0000-0000-0000-000000000000", // default value
    "Region": "59F84", // default value
    "AgentListeningPort": 56001, // default value
    "ContainerStartParameters": {
        /// replace ImageDetails fields to your own images saved on ACR.
        "ImageDetails": {
            "Registry": "mydockerregistry.io",
            "ImageName": "wrapper",
            "ImageTag": "0.1",
            "Username": "",
            "Password": ""
        }
    },
    "PortMappingsList": [
        [
            {
                "NodePort": 56100,
                "GamePort": {
                    "Name": "game_port", 
                    // The same value of GamePort Name should be also defined in the Wrapper so Wrapper can get a port information while it's running.
                    "Number": 80,
                    "Protocol": "TCP"
                }
            }
        ]
    ],
}

"AssetDetails": [
    {
      "MountPath": "C:\\Assets",  
      // Mount Path should be "C:\\Assets" for Windows Container. 
      "LocalFilePath": "D:\\gameassets.zip" 
      // where your game server is located as an archive format.
    }
  ]

 "ContainerStartParameters": {
    "StartGameCommand": "C:\\Assets\\wrapper.exe -g C:\\Assets\\fakegame.exe arg1 arg2", 
    // Your game assets will be extracted under C:\\Assets (default mount path for Windows Container) and LMA will run your game server with StartGameCommand argument. 
     // Make sure the StartGameCommand provided above is an example of the Wrapper sample. 
    "ImageDetails": {
      "Registry": "mcr.microsoft.com",
      "ImageName": "playfab/multiplayer",
      "ImageTag": "wsc-10.0.17763.973.1",
      "Username": "", 
      "Password": ""
      // username and password are not required to use MCR image.
    }
    // LMA will package an existing game sample (path defined in LocalFilePath) as a Windows container.
 }

• LocalFilePath - 事前に作成したゲーム サーバーのアセット zip ファイルへのローカル (ワークステーション上) のフル パスです (例: D:\gameassets.zip、JSON フォーマットのためバックスラッシュはエスケープが必要です)。このフィールドは Windows コンテナーで必須です。LMA がゲーム アセットを検索してコンテナーにパッケージ化するために必要となります。
• PortMappingsList - これらは実行中にゲームで利用可能なポートです。
  • NodePort はワークステーション上で開かれるポートで、GamePort にマッピングされます。
  • GamePort.Number はコンテナーで実行時にゲーム サーバーがバインドする必要のあるポートです。たとえば、ここでは fakegame.exe がリッスンするポート番号として 80 を設定しています。
  • GamePort.Name はゲーム サーバーで定義されている値と同じ値を設定してください。実行時に GSDK config を確認して GamePort.Name キーの値を確認できます。
  • GamePort.Protocol - プロトコル タイプを指定します: TCP または UDP。
  GamePort セクションを、ゲーム サーバーがクライアントに対してリッスンするプロトコルとポートに合わせて更新してください。複数のポートを追加することもできます。
• ForcePullFromAcrOnLinuxContainersOnWindows - Docker レジストリから Linux コンテナー イメージをプルし、ローカル レジストリからのプルを回避したい場合は true に設定します。ほとんどの場合、これは false に設定します。
• ContainerStartParameters.ImageDetails - ゲーム サーバー イメージは、コンテナー レジストリで公開することも、ローカルでビルドすることもできます。Docker レジストリ (例: Azure レジストリ) から Linux コンテナー イメージをプルしたい場合は、ユーザー名とパスワードの値を設定し、ForcePullFromAcrOnLinuxContainersOnWindows を true に設定する必要があります。Windows コンテナーの場合、ユーザー名とパスワードは不要です。
• OutputFolder - 出力および構成ファイルが生成されるドライブまたはフォルダーへのパスです。ゲーム サーバーはこのパスの下に展開されるため、十分な空き容量があることを確認してください。指定しない場合、エージェント フォルダーが使用されます。
• AgentListeningPort - LMA がゲーム サーバーと通信するためのポートです。任意の空きポートで動作します。既定値は 56001 です。56001 にバインドされている別のプロセスがある場合は、この値を変更するか、ポート 56001 上の他のプロセスを終了する必要があります。
• ResourceLimits (省略可能) - 指定した場合、Docker が CPU/メモリ使用量を制限します。警告: サーバーが許可されたメモリを超えると、強制終了されます。ResourceLimits はコンテナー モードでのみ指定可能です。
• SessionCookie (省略可能) - RequestMultiplayerServer API 呼び出しの一部としてゲーム サーバーに渡される任意のセッション Cookie です。MPS 上の実際のシナリオでは、接続確立後、サーバーは SessionCookie から対応するリソースを読み込むようクライアントに通知します。

​

Docker のセットアップ

• Linux コンテナーの場合は SetupLinuxContainersOnWindows.ps1 を実行します。
  Windows コンテナーの場合は Setup.ps1 を実行します。これにより、Microsoft/PlayFab-Multiplayer から PlayFab Docker イメージがプルされます。
  スクリプトの初回実行時は、コンテナー イメージのダウンロードに数分かかる場合があります。

  このセットアップを正常に実行するには、インストールされているサードパーティ製アンチウイルス プログラムのファイアウォールを構成する必要がある場合があります。

​

LocalMultiplayerAgent を実行する

• PowerShell ウィンドウで:
  LocalMultiplayerAgent.exe が含まれる LMA のディレクトリに移動します。
• Windows コンテナーの場合は LocalMultiplayerAgent.exe を実行します。
  Linux コンテナーの場合は LocalMultiplayerAgent.exe -lcow を実行します。
  (lcow は Linux Containers On Windows の略です。) この時点で LMA は HTTP リスナーをセットアップし、コンテナーを実行します。
  docker ps コマンドを実行すると、マシン上で実行中のコンテナーを確認できます。

1. CurrentGameState - Initializing
   (ゲーム サーバーが直接 GSDK::ReadyForPlayers を呼び出し、GSDK::Start を呼び出さない場合、これは表示されない場合があります。)
2. CurrentGameState - StandingBy
3. CurrentGameState - Active
4. CurrentGameState - Terminating

​

ゲームへの接続をテストする

​

トラブルシューティング

• コンテナー モードでゲーム サーバーが「Container … exited with exit code 1」などのエラーで即座に終了するが、プロセス モードでは問題なく動作する場合は、必要なすべての システム DLL がアセット パッケージに含まれていることを確認してください。
• すべてのログは、MultiplayerSettings.json ファイルで指定された OutputFolder 下に配置されます。LocalMultiplayerAgent は起動のたびに、タイムスタンプをフォルダー名とする新しいフォルダーを作成します。GSDK を通じて出力されたすべてのゲーム サーバー ログは GameLogs フォルダー内に配置されます。
  ゲーム サーバーがコンテナー内で実行されている場合、追加のディレクトリ階層をたどる必要がある場合があります。
• GSDK はデバッグ ログを OutputFolder 下の GameLogs フォルダーに書き込みます。 これらのログは、ゲーム サーバーが出力するログと共に GameLogs フォルダー内に配置されます。
• ファイアウォール (Windows のものおよびその他のアンチウイルス) が、対象ポート上でのトラフィックを許可するように構成されていることを確認してください。
• 次のようなエラーが表示される場合: Docker API responded with status code=InternalServerError, response={"message":"failed to create endpoint <container_name> on network playfab: hnsCall failed in Win32: The specified port already exists". It is likely there is already a container running on the specified port. これは、LocalMultiplayerAgent が予期せず終了した場合に発生する可能性があります。docker ps コマンドで実行中のコンテナーを確認し、docker kill <container_name> で削除してください。
• Failed to find network 'playfab' を含むエラーが表示される場合は、Setup.ps1 を再実行してみてください。

​

既知の制限事項

1. デバッグ終了時にコンテナーが終了しない場合があります。この場合、管理者として次の PowerShell コマンドを実行してください。これらのコマンドは、LocalMultiplayerAgent によって起動されていないものを含め、すべてのコンテナーを停止して削除します。

docker stop $(docker ps -aq)
docker rm $(docker ps -aq)