Beta版のUnity Gaming Servicesを導入して軽く触ってみる

本記事はCraft Egg Advent Calendar 2021の12/4の記事です。
12/3の記事は@Tomy_0331さんの「新卒2年目までに学んだ、コーディングで意識すること」でした。

はじめに

株式会社Craft EggでUnityクライアントエンジニアをしている山元です。
アドベントカレンダーを書くということで何かいいネタがないかと探していたところ、最近 Unity Gaming Services のBeta版がリリースされていたので触ってみた記事になっております。

Unity Gaming Services とは

「バックエンド、マネタイズ、ユーザー獲得、プレイヤーエンゲージメントなど、ゲームクリエイターが必要とするすべての機能を提供する新しいプラットフォーム」のようです。

11/22にBeta版がリリースされた新機能になっておりマルチプレイ機能、Vivoxよる音声通話など様々な機能が入っています。

#早速触って試してみる
今回はUnity Gaming Services を使用してプレイヤーが Lobby に参加するところまでを試してみようと思います。

検証環境

Mac Catalina
Unity 2021.1.0b12
Unity Authentication 1.0.0-pre.6
Unity Lobby 1.0.0-pre.6
UniTask 2.2.5

##Gaming Servicesの準備
PackageManager, Unity Editor, Unity DashBoard にてそれぞれ準備を行います。
###PackageManager
Unity Editor で Gaming Services の機能を利用するため manifest.json に以下のPackageを追加します。

"dependencies": {
    "com.unity.services.authentication": "1.0.0-pre.6",
    "com.unity.services.lobby": "1.0.0-pre.6",
 }

###Unity Editor

Gaming Services の Unity Project ID を作成します。
手順：
・ UnityEditor で Project Settings > Services を開く
・ Organizations から自分のアカウントを選択する
・ Create Project ID ボタンをクリック
・ 一番下の項目にある13歳以下の子供を対象にしているかの設定で Yes No どちらかを選ぶ
・ 右下にあるSaveボタンを押して完了

Gaming Services を利用するための Unity Editor 側の準備は以上になるので Unity DashBoard 側の準備に移ります。

###Unity DashBoard
ダッシュボードでは Lobby 内でプレイヤーがマッチングするために必要な機能を有効にする設定を行います。

手順：
・ Unity Dashboard 側で先ほど作成した Unity Project を選択する
・ 今回はプレイヤーのマッチング機能を試すので左タブ下の方にある Multiplayer を選択する
・「Lobby」「Relay」機能それぞれ Get Started から手順通りに進み機能を ON にする

これでダッシュボード側の準備も完了しました。
これから実際にコードを書いてロビーを作成、参加していこうと思います。

##実装

###サインイン
Unity Gaming Services は何をするにしても Unity Authentication を使用して認証を通す必要があります。
なのでまずはUnity Authentication で匿名サインイン処理を行っていきましょう。

private async void Start()
{
    // Unity Gaming Services の初期化処理
    await UnityServices.InitializeAsync();
    Debug.Log(UnityServices.State);
    
    await SignInAnonymouslyAsync();
}

/// <summary>匿名サインインする処理</summary>
private async UniTask SignInAnonymouslyAsync()
{
    try
    {
        await AuthenticationService.Instance.SignInAnonymouslyAsync();
        Debug.Log("匿名サインイン成功！");
    }
    catch (AuthenticationException ex)
    {
        // 認証エラー時の例外
        Debug.LogException(ex);
    }
    catch (RequestFailedException exception)
    {
        // リクエストエラー時の例外
        Debug.LogException(exception);
    }
}

サインイン成功，サインイン失敗，サインアウト時のコールバックをそれぞれ登録することもできます。
AuthenticationService.Instance.SignedIn
AuthenticationService.Instance.SignInFailed
AuthenticationService.Instance.SignedOut

###ロビーの作成

private async void Start()
{
    // Unity Gaming Services の初期化処理
    await UnityServices.InitializeAsync();
    Debug.Log(UnityServices.State);
    
    await SignInAnonymouslyAsync();

    var lobby = await CreateLobbyAsync("test lobby", 2);

    if (lobby == null) return;

    Debug.Log($"ロビー作成成功！ Id:{lobby.Id}, Name:{lobby.Name}");
}

/// <summary>ロビーを作成する処理</summary>
/// <param name="lobbyName">ロビー名</param>
/// <param name="maxPlayers">ロビーの最大プレイヤー数</param>
/// <returns>作成したロビー</returns>
private async UniTask<Lobby> CreateLobbyAsync(string lobbyName, int maxPlayers)
{
    try
    {
        return await Lobbies.Instance.CreateLobbyAsync(lobbyName, maxPlayers);
    }
    catch (LobbyServiceException ex)
    {
        Debug.LogException(ex);
    }

    return null;
}

今回はお試しなので指定していませんが Lobbies.Instance.CreateLobbyAsync の第三引数に CreateLobbyOptions という細かいオプションを渡すこともできます。

public class CreateLobbyOptions 
{
    // プライベート用のフラグ
    public bool? IsPrivate { get; set; }

    // ロビー製作者の情報
    public Player Player { get; set; }

    // ゲーム固有のプロパティも設定できる
    public Dictionary<string, DataObject> Data { get; set; }
}

###ロビーの入室

Unity Editorだけでは検証することができないのでアプリケーションをビルドしてロビーを作成した状態で検証します。

private async void Start()
{
    // Unity Gaming Services の初期化処理
    await UnityServices.InitializeAsync();
    Debug.Log(UnityServices.State);
    
    await SignInAnonymouslyAsync();

    var lobby = await QuickJoinLobbyAsync();
    if (lobby != null)
    {
        Debug.Log($"ロビー入室成功！ Id:{lobby.Id}, Name:{lobby.Name}");
        return;
    }
    
    // ロビーに参加できなかったので作成する
    lobby = await CreateLobbyAsync("test lobby", 2);

    if (lobby == null) return;

    Debug.Log($"ロビー作成成功！ Id:{lobby.Id}, Name:{lobby.Name}");
}

/// <summary>条件に応じた適当な部屋に素早く入室する処理</summary>
/// <returns>入室したロビー</returns>
private async UniTask<Lobby> QuickJoinLobbyAsync(QuickJoinLobbyOptions options = null)
{
    try
    {
        return await Lobbies.Instance.QuickJoinLobbyAsync(options);
    }
    catch (LobbyServiceException ex)
    {
        Debug.LogException(ex);
    }

    return null;
}

ロビーに入室できた時

ロビーに入室できなかった時

無事ロビーに入室するところまで実装することができました。

#まとめ

今回は Unity Gaming Services を使って、ロビー作成、参加というマルチプレイの基本的な部分の実装を行ってみました。
Unity Gaming Services はマネタイズ、プレイヤーエンゲージメントなど広い領域をサポートするようなので今後のアップデートに注目していこうと思います。

今回のLobby実装はUnity公式にサンプルプロジェクトがあるので気になった方は触ってみると良いかもしれません！
※サンプルプロジェクトでは Vivox が使用されているのでダッシュボードにて「Vivox」を ON にする必要があります

ここまで読んで頂きありがとうございました！

Craft Egg Advent Calendar 2021 明日は@ryousangataの記事になります！