Amazon GameLift を Unreal Engine プロジェクトに統合する

Unreal Engine ソースをお好きなブランチの開発環境にクローンます。

git clone https://github.com/EpicGames/UnrealEngine.git

ゲームの開発に使用しているバージョンのタグを確認してください。例えば、次の例では Unreal Engine バージョン 5.1.1 をチェックします。

git checkout tags/5.1.1-release -b 5.1.1-release

ローカルリポジトリのルートフォルダに移動します。ルートフォルダに移動したら、Setup.bat ファイルを実行します。

ルートフォルダで、GenerateProjectFiles.bat ファイルも実行します。

前のステップのファイルを実行すると、Unreal Engine ソリューションファイル、UE5.sln が作成されます。Visual Studio を開き、Visual Studio エディタで UE5.sln ファイルを開きます。

Visual Studio で [表示] メニューを開き、[ソリューションエクスプローラー] オプションを選択します。Unreal プロジェクトノードのコンテキストメニューが開きます。[ソリューションエクスプローラー] ウィンドウで UE5.sln ファイル (単に UE5 としてリストされる場合があります) を右クリックし、[構築] を選択して Development Editor Win64 ターゲットで Unreal プロジェクトを構築します。

Visual Studio を開いた状態で、[ソリューションエクスプローラー] ペインに移動し、UE5 ファイルを選択して Unreal プロジェクトのコンテキストメニューを開きます。コンテキストメニューで、[スタートアッププロジェクトとして設定] オプションを選択します。

Visual Studio ウィンドウの上部にある [デバッグを開始] (緑色の矢印) を選択します。

このアクションは Unreal Editor の新しいソースビルドインスタンスを起動します。Unreal Editor の使用に関する詳細は、Unreal Engine ドキュメントのウェブサイトにある「Unreal Editor インターフェイス」を参照してください。

Unreal Editor は Unreal プロジェクトとゲームプロジェクトを含む別の Visual Studio ウィンドウを開くので、開いた Visual Studio ウィンドウを閉じます。

Unreal Editor で、以下のいずれかを実行します。

• Amazon と統合する既存の Unreal プロジェクトを選択します GameLift。

• 新しい プロジェクトを作成します。Amazon GameLift plugin for Unreal を試すには、Unreal エンジンの Third Person テンプレートを試してください。このテンプレートの詳細については、Unreal Engine ドキュメンとのウェブサイトにある「Third Person テンプレート」を参照してください。

  または、以下の設定で新しいプロジェクトを設定します。

  • C++

  • スターターコンテンツを使用

  • Desktop

  • プロジェクト名 このトピックの例では、プロジェクトに GameLiftUnrealApp という名前を付けました。

Visual Studio の [ソリューションエクスプローラー] で、Unreal プロジェクトの場所に移動します。Unreal Source フォルダーで、Your-application-name.Target.cs という名前のファイルを検索します。

例: GameLiftUnrealApp.Target.cs。

このファイルのコピーを作成し、Your-application-nameServer.Target.cs という名前を付けます。

新しいファイルを開き、以下の変更を加えます。

Unreal 用の Amazon GameLift C++ サーバーSDKプラグインをダウンロードします。

Open をダウンロードしてインストールしますSSL。Open のダウンロードの詳細についてはSSL、Github OpenSSL のビルドとインストールのドキュメントを参照してください。

詳細については、Windows プラットフォームの OpenSSL Notes ドキュメントを参照してください。 https://github.com/openssl/openssl/blob/master/NOTES-WINDOWS.md

ライブラリをダウンロードして、Unreal Engine の C++ サーバーSDKライブラリを構築します。

ダウンロードした のGameLift-Cpp-ServerSDK-<version>ディレクトリでSDK、 -DBUILD_FOR_UNREAL=1パラメータを使用してコンパイルし、サーバー を構築しますSDK。次の例は、cmake を使用してコンパイルする方法を示しています。

ターミナルで以下のコマンドを実行します。

mkdir cmake-build
cmake.exe -G "Visual Studio 17 2022" -DCMAKE_BUILD_TYPE=Release -S . -B ./cmake-build -DBUILD_FOR_UNREAL=1 -A x64
cmake.exe --build ./cmake-build --target ALL_BUILD --config Release

Windows ビルドでは、out\gamelift-server-sdk\Release フォルダに次のバイナリファイルが作成されます。

2 つのライブラリファイルを Amazon GameLift Unreal Engine プラグインパッケージのThirdParty\GameLiftServerSDK\Win64フォルダにコピーします。

前の手順でプラグインから抽出したGameLiftServerSDKフォルダを見つけます。

ゲームプロジェクトのルートフォルダPluginsで を見つけます。（フォルダが存在しない場合は、そこに作成します）。

GameLiftServerSDK フォルダを にコピーしますPlugins。

これにより、Unreal プロジェクトはプラグインを表示できます。

Amazon GameLift サーバーSDKプラグインをゲームの.uprojectファイルに追加します。

この例では、アプリは GameLiftUnrealApp と呼ばれるため、ファイルは GameLiftUnrealApp.uproject になります。

.uproject ファイルを編集してプラグインをゲームプロジェクトに追加します。

"Plugins": [
    {
        "Name": "GameLiftServerSDK",
        "Enabled": true
    }
]

ゲームがプラグイン ModuleRules に依存していることを確認します。.Build.cs ファイルを開き、Amazon GameLiftServerSDK 依存関係を追加します。このファイルは Your-application-name/Source//Your-application-name/ の下にあります。

例えば、チュートリアルのファイルパスは ../GameLiftUnrealApp/Source/GameLiftUnrealApp/GameLiftUnrealApp.Build.cs です。

PublicDependencyModuleNames のリストの最後に "GameLiftServerSDK" を追加します。

using UnrealBuildTool;
using System.Collections.Generic;
public class GameLiftUnrealApp : ModuleRules  
  {
    public GameLiftUnrealApp(TargetInfo Target)
    {
      PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "GameLiftServerSDK" });
      bEnableExceptions = true;
    }
  }

Visual Studio で、アプリケーションの .sln ファイルを開きます。この例では、GameLiftUnrealApp.sln ファイルはルートフォルダーにあります。

ソリューションを開いた状態で、アプリケーションの Your-application-nameGameMode.h ファイルを見つけます。例えば、GameLiftUnrealAppGameMode.h などです。

ヘッダーファイルを次のサンプルコードに合わせて変更します。GameLiftUnrealApp「」を独自のアプリケーション名に置き換えてください。

#pragma once

#include "CoreMinimal.h"
#include "GameFramework/GameModeBase.h"
#include "GameLiftServerSDK.h"
#include "GameLiftUnrealAppGameMode.generated.h"

DECLARE_LOG_CATEGORY_EXTERN(GameServerLog, Log, All);

UCLASS(minimalapi)
class AGameLiftUnrealAppGameMode : public AGameModeBase
{
    GENERATED_BODY()

public:
    AGameLiftUnrealAppGameMode();

protected:
    virtual void BeginPlay() override;

private:
    // Process Parameters needs to remain in scope for the lifetime of the app
    FProcessParameters m_params;

    void InitGameLift();
};

関連するソースファイルの Your-application-nameGameMode.cpp を開きます。この例では: GameLiftUnrealAppGameMode.cpp ですが、次のサンプルコードに合うようにコードを変更してください。GameLiftUnrealApp「」を独自のアプリケーション名に置き換えてください。

このサンプルは、「ゲームサーバー に Amazon を追加する」で説明されているように GameLift、Amazon との統合に必要なすべての要素を追加する方法を示しています。 GameLift これには、以下が含まれます。

#include "GameLiftUnrealAppGameMode.h"
#include "GameLiftUnrealAppCharacter.h"

#include "UObject/ConstructorHelpers.h"

DEFINE_LOG_CATEGORY(GameServerLog);

AGameLiftUnrealAppGameMode::AGameLiftUnrealAppGameMode()
{
    // set default pawn class to our Blueprinted character
    static ConstructorHelpers::FClassFinder<APawn> PlayerPawnBPClass(TEXT("/Game/ThirdPerson/Blueprints/BP_ThirdPersonCharacter"));
    if (PlayerPawnBPClass.Class != NULL)
    {
        DefaultPawnClass = PlayerPawnBPClass.Class;
    }
}

void AGameLiftUnrealAppGameMode::BeginPlay()
{
#if WITH_GAMELIFT
    InitGameLift();
#endif
}

void AGameLiftUnrealAppGameMode::InitGameLift()
{
    UE_LOG(GameServerLog, Log, TEXT("Initializing the GameLift Server"));

    //Getting the module first.
    FGameLiftServerSDKModule* gameLiftSdkModule = &FModuleManager::LoadModuleChecked<FGameLiftServerSDKModule>(FName("GameLiftServerSDK"));

    //Define the server parameters for a GameLift Anywhere fleet. These are not needed for a GameLift managed EC2 fleet.
    FServerParameters serverParameters;

    //AuthToken returned from the "aws gamelift get-compute-auth-token" API. Note this will expire and require a new call to the API after 15 minutes.
    if (FParse::Value(FCommandLine::Get(), TEXT("-authtoken="), serverParameters.m_authToken))
    {
        UE_LOG(GameServerLog, Log, TEXT("AUTH_TOKEN: %s"), *serverParameters.m_authToken)
    }

    //The Host/compute-name of the GameLift Anywhere instance.
    if (FParse::Value(FCommandLine::Get(), TEXT("-hostid="), serverParameters.m_hostId))
    {
        UE_LOG(GameServerLog, Log, TEXT("HOST_ID: %s"), *serverParameters.m_hostId)
    }

    //The Anywhere Fleet ID.
    if (FParse::Value(FCommandLine::Get(), TEXT("-fleetid="), serverParameters.m_fleetId))
    {
        UE_LOG(GameServerLog, Log, TEXT("FLEET_ID: %s"), *serverParameters.m_fleetId)
    }

    //The WebSocket URL (GameLiftServiceSdkEndpoint).
    if (FParse::Value(FCommandLine::Get(), TEXT("-websocketurl="), serverParameters.m_webSocketUrl))
    {
        UE_LOG(GameServerLog, Log, TEXT("WEBSOCKET_URL: %s"), *serverParameters.m_webSocketUrl)
    }

    //The PID of the running process
    serverParameters.m_processId = FString::Printf(TEXT("%d"), GetCurrentProcessId());
    UE_LOG(GameServerLog, Log, TEXT("PID: %s"), *serverParameters.m_processId);

    //InitSDK establishes a local connection with GameLift's agent to enable further communication.
    //Use InitSDK(serverParameters) for a GameLift Anywhere fleet. 
    //Use InitSDK() for a GameLift managed EC2 fleet.
    gameLiftSdkModule->InitSDK(serverParameters);

    //Implement callback function onStartGameSession
    //GameLift sends a game session activation request to the game server
    //and passes a game session object with game properties and other settings.
    //Here is where a game server takes action based on the game session object.
    //When the game server is ready to receive incoming player connections, 
    //it invokes the server SDK call ActivateGameSession().
    auto onGameSession = [=](Aws::GameLift::Server::Model::GameSession gameSession)
    {
        FString gameSessionId = FString(gameSession.GetGameSessionId());
        UE_LOG(GameServerLog, Log, TEXT("GameSession Initializing: %s"), *gameSessionId);
        gameLiftSdkModule->ActivateGameSession();
    };

    m_params.OnStartGameSession.BindLambda(onGameSession);

    //Implement callback function OnProcessTerminate
    //GameLift invokes this callback before shutting down the instance hosting this game server.
    //It gives the game server a chance to save its state, communicate with services, etc., 
    //and initiate shut down. When the game server is ready to shut down, it invokes the 
    //server SDK call ProcessEnding() to tell GameLift it is shutting down.
    auto onProcessTerminate = [=]() 
    {
        UE_LOG(GameServerLog, Log, TEXT("Game Server Process is terminating"));
        gameLiftSdkModule->ProcessEnding();
    };

    m_params.OnTerminate.BindLambda(onProcessTerminate);

    //Implement callback function OnHealthCheck
    //GameLift invokes this callback approximately every 60 seconds.
    //A game server might want to check the health of dependencies, etc.
    //Then it returns health status true if healthy, false otherwise.
    //The game server must respond within 60 seconds, or GameLift records 'false'.
    //In this example, the game server always reports healthy.
    auto onHealthCheck = []() 
    {
        UE_LOG(GameServerLog, Log, TEXT("Performing Health Check"));
        return true;
    };

    m_params.OnHealthCheck.BindLambda(onHealthCheck);

    //The game server gets ready to report that it is ready to host game sessions
    //and that it will listen on port 7777 for incoming player connections.
    m_params.port = 7777;

    //Here, the game server tells GameLift where to find game session log files.
    //At the end of a game session, GameLift uploads everything in the specified 
    //location and stores it in the cloud for access later.
    TArray<FString> logfiles;
    logfiles.Add(TEXT("GameLift426Test/Saved/Logs/GameLift426Test.log"));
    m_params.logParameters = logfiles;

    //The game server calls ProcessReady() to tell GameLift it's ready to host game sessions.
    UE_LOG(GameServerLog, Log, TEXT("Calling Process Ready"));
    gameLiftSdkModule->ProcessReady(m_params);
}

開発エディターと開発サーバーの両方のターゲットタイプのゲームプロジェクトを構築します。

両方のビルドが完了したら、Visual Studio を閉じてプロジェクトの .uproject ファイル Unreal Editor で開きます。

Unreal Editor で、ゲームのサーバービルドをパッケージ化します。ターゲットを選択するには、プラットフォーム 、Windows に移動し、 を選択します。 Your-application-nameServer.

サーバーアプリケーションの構築プロセスを開始するには、[プラットフォーム]、[Windows] に移動し、[パッケージプロジェクト] を選択します。ビルドが完了すると、実行ファイルが作成される必要があります。この例の場合、ファイル名は GameLiftUnrealAppServer.exe です。

Unreal Editor でサーバーアプリケーションをビルドすると、2 つの実行ファイルが生成されます。1 つはゲームビルドフォルダのルートにあり、実際のサーバー実行ファイルのラッパーとして機能します。

サーバービルドで Amazon GameLift フリートを作成するときは、実際のサーバー実行可能ファイルをランタイム設定起動パスとして渡すことをお勧めします。例えば、ゲームビルドフォルダには、ルートに GameLiftFPS.exe ファイルがあり、別のファイルが \GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe にある場合があります。フリートを作成するときは、ランタイム設定の起動パスとして C:\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe を使用することをおすすめします。

ゲームサーバーがゲームクライアントと通信できるように、Amazon GameLift フリートで必要なUDPポートを必ず開いてください。デフォルトでは、Unreal Engine は 7777 ポートを使用します。詳細については、Amazon GameLift サービスAPIリファレンスガイドUpdateFleetPortSettingsの「」を参照してください。

ゲームビルド用の install.bat ファイルを作成します。このインストールスクリプトは、ゲームビルドが Amazon GameLift フリートにデプロイされるたびに実行されます。サンプル install.bat ファイルは次のとおりです。

VC_redist.x64.exe /q
UE5PrereqSetup_x64.exe /q

Unreal Engine の一部のバージョンでは、代わりに を にinstall.batする必要があります。

VC_redist.x64.exe /q
UEPrereqSetup_x64.exe /q

これで、ゲームビルドをパッケージ化して Amazon にアップロードできるようになりました GameLift。

ゲームビルドでパッケージ化する OpenSSL のバージョンは、ゲームエンジンがゲームサーバーの構築時に使用したバージョンと一致する必要があります。ゲームサーバービルドで正しい OpenSSL バージョンをパッケージ化してください。Windows OS の場合、OpenSSL 形式は です.dll。