Multiplay using Messaging

What for?

マルチプレイ機能を実現する際には、プレイヤー状態（位置情報や動きなど）を同期させる必要があります。

NGOラッパーのベースとなるNetcode for GameObjectsは単一のサーバープロセス内でプレイヤー状態を集中管理しています。 このような設計は、スケールアウトを難しくしています。

そこで、このモジュールではMessagingを利用することで、単一サーバーで複数グループのマルチプレイを実現、または複数サーバーにスケールアウトしマルチプレイの人数を増やすことを実現します。 これにより、スケールアウトがより簡単に行えるようになり、結果として運用コストの削減が可能になります。

Specification

• グループでマルチプレイできます。
• グループ内でメッセージを送受信できます。
• 同期するオブジェクトの動きを追加できます。
• クライアントの状態をトリガーに処理を追加できます。

Architecture

classDiagram MultiplayClient ..> PlayerInput MultiplayClient ..> MultiplayJoiningConfig QueuingMessagingClient <-- MultiplayClient NetworkClient <-- MultiplayClient MessagingJoiningConfig <-- MultiplayJoiningConfig INetworkObjectsProvider <|.. MultiplayClient PlayerInput --> PlayerInputValues class MultiplayClient { +LocalClient NetworkClient +JoinedClients IReadOnlyDictionary +OnJoined IObservable +OnLeaving IObservable +OnUnexpectedLeft IObservable +OnJoiningApprovalRejected IObservable +OnClientJoined IObservable +OnClientLeaving IObservable +OnObjectSpawned IObservable +OnMessageReceived IObservable +MultiplayClient(messagingClient, networkObjectsProvider) +ListGroupsAsync() UniTask +JoinAsync(joiningConfig) void +LeaveAsync() void +SpawnObject(objectPrefab, position, rotation, parent, message) GameObject +SendMessage(message, to) void } class NetworkClient { +ClientId string +NetworkObjects IReadOnlyList +NetworkClient(clientId) } class INetworkObjectsProvider { <<interface>> } class QueuingMessagingClient { <<extreal>> } class PlayerInput { +Values PlayerInputValues +SetMove(newMoveDirection) void +ApplyValues(synchronizedValues) void } class PlayerInputValues { +Move Vector2 +SetMove(move) Vector2 +CheckWhetherToSendData() bool } class MultiplayJoiningConfig { +MessagingJoiningConfig MessagingJoiningConfig } class MessagingJoiningConfig { <<interface>> }

Installation

Package

Unity

https://github.com/extreal-dev/Extreal.Integration.Multiplay.Messaging.git

Dependencies

このモジュールは次のパッケージを使います。

Unity

• Extreal.Core.Logging
• Extreal.Core.Common
• Extreal.Integration.Messaging
• UniTask
• UniRx
• Newtonsoft Json

モジュールバージョンと各パッケージバージョンの対応はReleaseを参照ください。

Settings

このモジュールはMessagingを使ってマルチプレイを実現しています。 そのためMessagingのSettingsが必要になります。

public class ClientControlScope : LifetimeScope
{
    private MultiplayClient multiplayClient;

    protected override void Configure(IContainerBuilder builder)
    {
        // After initializing QueuingMessagingClient and NetworkObjectsProvider
        multiplayClient = new MultiplayClient(queuingMessagingClient, networkObjectsProvider)
    }
}

Usage

グループでマルチプレイを行う

グループでマルチプレイを行う機能はMultiplayClientが提供します。

グループへの参加/退室はMessagingと同じ使い方になります。 グループでメッセージをやりとりするを参照してください。

// Join a group
var messagingJoiningConfig = new MessagingJoiningConfig("groupName");
var multiplayJoiningConfig = new MultiplayJoiningConfig(messagingJoiningConfig);
await multiplayClient.JoinAsync(multiplayJoiningConfig);

// Leave the group
multiplayClient.LeaveAsync();

グループに参加したらプレイヤーをスポーンしてマルチプレイに参加します。

multiplayClient.SpawnObject(playerObjectToBeSpawned)

プレイヤー以外のオブジェクトのスポーンもできます。

multiplayClient.SpawnObject(objectToBeSpawned)

グループ内でメッセージを送受信する

リアクションの同期など、グループ内でメッセージを送受信したい場合があります。 メッセージの送受信はMessagingと同じ使い方になります。 グループでメッセージをやりとりするを参照してください。

// Send message to entire group
await messagingClient.SendMessageAsync("message");

同期するオブジェクトの動きを追加する

SpawnObjectメソッドでスポーンしたオブジェクトの位置と回転はデフォルト実装で同期します。

要件によっては、アニメーションなど、オブジェクトの位置と回転以外の動きも同期したい場合があります。 このモジュールでは実装を追加することで、要件に合わせて同期するオブジェクトの動きを追加できます。

このモジュールではプレイヤーの入力を他のプレイヤーに送信することで、オブジェクトの動きを同期しています。 どのプレイヤーの入力を同期に使うかはPlayerInputとPlayerInputValuesで示します。

位置と回転以外の動きを同期したい場合は、PlayerInputとPlayerInputValuesを継承したクラスを作成します。

例えばJumpという入力を同期する場合を示します。

public class HolidayPlayerInput : PlayerInput
{
    public override PlayerInputValues Values => HolidayValues;
    public HolidayPlayerInputValues HolidayValues { get; } = new HolidayPlayerInputValues();

    public void SetJump(bool newJump)
        => HolidayValues.SetJump(newJump);

    public override void ApplyValues(PlayerInputValues synchronizedValues)
    {
        var synchronizedHolidayValues = synchronizedValues as HolidayPlayerInputValues;

        base.ApplyValues(synchronizedHolidayValues);
        SetJump(synchronizedHolidayValues.Jump);
    }
}

public class HolidayPlayerInputValues : PlayerInputValues
{
    [SuppressMessage("Usage", "CC0047")] public bool Jump { get; set; }

    public void SetJump(bool jump)
        => Jump = jump;
}

プレイヤーの入力は一定時間ごとに同期されます。 入力が変わるごとに同期したい場合など、同期する条件を追加したい場合はCheckWhetherToSendDataメソッドを使用します。

MoveかJumpのいずれかが変化した場合に同期する例を示します。

[Serializable]
public class HolidayPlayerInputValues : PlayerInputValues
{
    private Vector2 preMove;
    private bool isMoveChanged;

    [SuppressMessage("Usage", "CC0047")] public bool Jump { get; set; }
    private bool preJump;
    private bool isJumpChanged;

    public override void SetMove(Vector2 move)
    {
        preMove = Move;
        base.SetMove(move);
        isMoveChanged = preMove != Move;
    }

    public void SetJump(bool jump)
    {
        preJump = Jump;
        Jump = jump;
        isJumpChanged = preJump != Jump;
    }

    public override bool CheckWhetherToSendData()
    {
        var ret = isMoveChanged || isJumpChanged;
        isMoveChanged = isJumpChanged = false;
        return ret;
    }
}

クライアントの状態をトリガーに処理を追加する

Messagingと同じイベント通知を使えます。詳細はMessagingのクライアントの状態をトリガーに処理を追加するを参照してください。

MultiplayClientは上記に加えて次のイベント通知を設けています。

• OnObjectSpawned
  • タイミング：同期するオブジェクトをスポーンした直後
  • タイプ：IObservable
  • パラメータ：参加したクライアントID、スポーンしたオブジェクト、送信されたメッセージ