1. はじめに
2. SDK導入
3. SDK初期化処理追加
4. サーバービルドしてアップロード
5. ビルド設定追加
6. フリートの作成
7. テストアロケーションの作成
8. クライアントからサーバーに接続
参考

1. はじめに

UE5とUnity Game Service (https://unity.com/ja/unreal-engine) でマルチプレイができそうだなと思って検証してみました。

ドキュメントはこちら

Game Server Hosting SDK for Unreal Engine

2. SDK導入

UE5のソースコードDL周りは割愛します。

Unity Gaming Services

↑のセットアップ手順を進めていきます。

手順通りSDKのDL画面までいきます。

integrate game server にUnrealを選択します。

↑のLinuxもしくはWindows版をDLしてください。（ビルドが現状Linuxしか対応してないようなので、Linux版をDLして進めていきます。）

DLできたら、プロジェクトのPluginsフォルダに配置してビルドしてください。（Pluginsがなければ作成する）

プロジェクトを開いて、プラグインの一覧に Multiplay Game Server SDK があり有効になっていればOKです。

3. SDK初期化処理追加

特にドキュメントには明記されていなかったのですが、どうも必要なようなので、サーバー側の処理に初期化処理を追加しておきます。

新しくAGameSession を継承したクラスを追加します。

AGameSessoinはこちらを参考に。

AGameSession | Unreal Engine Documentation

RegisterServer をoverrideして以下の処理を追加。

void ACPP_GameSession::RegisterServer()
{
    Super::RegisterServer();
    
    UE_LOG(LogTemp, Log, TEXT("ACPP_GameSession::RegisterServer"));

    // Setup Server
    InitMultiplayServerSystem();

    if (ServerQueryHandlerSubsystem)
    {
        if (bool bConnect = ServerQueryHandlerSubsystem->Connect())
        {
            UGameInstance* GameInstance = GetWorld()->GetGameInstance();
            UMultiplayServerConfigSubsystem * ServerConfigSubsystem = GameInstance->GetSubsystem();

            const FMultiplayServerConfig & ServerConfig = ServerConfigSubsystem->GetServerConfig();
            UE_LOG(LogTemp, Log, TEXT("Server ID: %lld Allocation ID: %s Server Query Port: %u Port: %u Server Log Directory: %s"),
                ServerConfig.ServerId,
                *ServerConfig.AllocationId,
                ServerConfig.QueryPort,
                ServerConfig.Port,
                *ServerConfig.ServerLogDirectory);
            
            ServerQueryHandlerSubsystem->SetServerName(TEXT("Multiplay Server"));
            ServerQueryHandlerSubsystem->SetGameType(TEXT("Multi"));
            ServerQueryHandlerSubsystem->SetMap(TEXT("ThirdPersonServerMap"));
            ServerQueryHandlerSubsystem->SetPort(ServerConfig.Port);
        }
        else
        {
            UE_LOG(LogTemp, Error, TEXT("ServerQueryHandlerSubsystem Connect is Failed"));
        }
    }
}

void ACPP_GameSession::InitMultiplayServerSystem()
{
    if (ServerQueryHandlerSubsystem)
    {
        return;
    }
    
    UGameInstance* GameInstance = GetWorld()->GetGameInstance();
    
    GameServerSubsystem = GameInstance->GetSubsystem();
    GameServerSubsystem->SubscribeToServerEvents();

    ServerQueryHandlerSubsystem = GameInstance->GetSubsystem();
}

上記で初期化はできているかと思いますが、プレイヤーが入ったり、出たりしたときにPlayerの人数を変更する処理を追加しておきます。


void ACPP_GameSession::PostLogin(APlayerController* NewPlayer)
{
    Super::PostLogin(NewPlayer);

    InitMultiplayServerSystem();

    if(ServerQueryHandlerSubsystem)
    {
        ServerQueryHandlerSubsystem->IncrementCurrentPlayers();
    }
}

void ACPP_GameSession::NotifyLogout(const APlayerController* PC)
{
    Super::NotifyLogout(PC);

    InitMultiplayServerSystem();

    if(ServerQueryHandlerSubsystem)
    {
        ServerQueryHandlerSubsystem->DecrementCurrentPlayers();
    }
}

上記マルチシステムのAPIはBPからも呼べるようなので、BPにしたい方はこちらから参考。

Game Server Hosting SDK for Unreal Engine

上記GameSessionを呼ぶように、AGameModeを継承したクラスを作成して、GetGameSessionClassの関数をオーバーライドする（ThirdPersonのサンプルプロジェクトであれば、すでに作成されているはずなので、そちらでオーバーライドすればよい）

TSubclassOf AMutiSampleUGSGameMode::GetGameSessionClass() const
{
    return ACPP_GameSession::StaticClass();
}

4. サーバービルドしてアップロード

次にビルドをアップロードします。

Builds

↑のページを参考に。

まず MultiplayGameServerSDK モジュールの依存関係として以下のようにUnreal プロジェクトの Build.cs ファイルに追加します。

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "HeadMountedDisplay", "EnhancedInput", "MultiplayGameServerSDK"});