Integrieren Sie Amazon GameLift in ein Unreal Engine-Projekt

Klonen Sie die Unreal Engine-Quelle in Ihre Entwicklungsumgebung in einem Zweig Ihrer Wahl.

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

Sieh dir das Tag der Version an, die du zur Entwicklung deines Spiels verwendest. Im folgenden Beispiel wird beispielsweise die Unreal Engine-Version 5.1.1 ausgecheckt:

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

Navigieren Sie zum Stammordner des lokalen Repositorys. Wenn Sie sich im Stammordner befinden, führen Sie die folgende Datei aus:Setup.bat.

Führen Sie im Stammordner auch die Datei aus:GenerateProjectFiles.bat.

Nachdem Sie die Dateien aus den vorherigen Schritten ausgeführt haben, wird eine Unreal Engine-Lösungsdatei,UE5.sln, erstellt. Öffnen Sie Visual Studio und öffnen Sie die UE5.sln Datei im Visual Studio-Editor.

Öffnen Sie in Visual Studio das Menü Ansicht und wählen Sie die Option Solution Explorer. Dadurch wird das Kontextmenü des Unreal-Projektknotens geöffnet. Klicken Sie im Solution Explorer-Fenster mit der rechten Maustaste auf die UE5.sln Datei (sie kann auch als „Nur“ aufgeführt werdenUE5) und wählen Sie dann Build, um das Unreal-Projekt mit dem Win64-Ziel des Development Editors zu erstellen.

Navigieren Sie bei geöffnetem Visual Studio zum Solution Explorer-Bereich und wählen Sie die UE5 Datei aus, um das Kontextmenü für das Unreal-Projekt zu öffnen. Wählen Sie im Kontextmenü die Option Als Startprojekt festlegen.

Wählen Sie oben in Ihrem Visual Studio-Fenster die Option Debugging starten (grüner Pfeil).

Diese Aktion startet Ihre neue, im Quellcode erstellte Instanz von Unreal Editor. Weitere Informationen zur Verwendung des Unreal Editors finden Sie unter Unreal Editor Interface auf der Unreal Engine-Dokumentationswebsite.

Schließen Sie das Visual Studio-Fenster, das Sie geöffnet haben, da der Unreal Editor ein weiteres Visual Studio-Fenster öffnet, das das Unreal-Projekt und Ihr Spielprojekt enthält.

Führen Sie im Unreal-Editor einen der folgenden Schritte aus:

• Wählen Sie ein vorhandenes Unreal-Projekt aus, das Sie in Amazon GameLift integrieren möchten.

• Erstellt ein neues Projekt. Um mit dem GameLift Amazon-Plugin für Unreal zu experimentieren, versuchen Sie es mit der Third-Person-Vorlage der Unreal Engine. Weitere Informationen zu dieser Vorlage finden Sie unter Vorlage für Dritte auf der Unreal Engine-Dokumentationswebsite.

  Alternativ können Sie ein neues Projekt mit den folgenden Einstellungen konfigurieren:

  • C++

  • Mit Starter-Inhalten

  • Desktop

  • Ein Projektname. In den Beispielen zu diesem Thema haben wir unserem Projekt einen Namen gegebenGameLiftUnrealApp.

Navigieren Sie im Solution Explorer von Visual Studio zum Speicherort Ihres Unreal-Projekts. Suchen Sie im Source Ordner Unreal nach einer Datei mit dem Namen. Your-application-name.Target.cs

Zum Beispiel: GameLiftUnrealApp.Target.cs.

Erstellen Sie eine Kopie dieser Datei und geben Sie der Kopie einen Namen:Your-application-nameServer.Target.cs.

Öffnen Sie die neue Datei und nehmen Sie die folgenden Änderungen vor:

Laden Sie das Amazon GameLift C++-Server-SDK-Plugin für Unreal herunter.

Laden Sie OpenSSL herunter und installieren Sie es. Weitere Informationen zum Herunterladen von OpenSSL finden Sie in der Github OpenSSL-Build- und Installationsdokumentation.

Weitere Informationen finden Sie in der Dokumentation zu OpenSSL Notes für Windows-Plattformen.

Erstellen Sie mit den heruntergeladenen Bibliotheken die C++-Server-SDK-Bibliotheken für Unreal Engine.

Kompilieren Sie im GameLift-Cpp-ServerSDK-<version> Verzeichnis im heruntergeladenen SDK mit dem -DBUILD_FOR_UNREAL=1 Parameter und erstellen Sie das Server-SDK. Die folgenden Beispiele zeigen, wie Sie mit kompilierencmake.

Führen Sie die folgenden Befehle in Ihrem Terminal aus:

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

Der Windows-Build erstellt die folgenden Binärdateien in dem out\gamelift-server-sdk\Release Ordner:

Kopieren Sie die beiden Bibliotheksdateien in den ThirdParty\GameLiftServerSDK\Win64 Ordner im Amazon GameLift Unreal Engine-Plugin-Paket.

Suchen Sie den GameLiftServerSDK Ordner, den Sie im vorherigen Verfahren aus dem Plugin extrahiert haben.

Suchen Sie den Stammordner Plugins in Ihrem Spielprojekt. (Falls der Ordner nicht existiert, erstelle ihn dort.)

Kopieren Sie den GameLiftServerSDK Ordner in denPlugins.

Dadurch kann das Unreal-Projekt das Plugin sehen.

Füge das Amazon GameLift Server SDK Plugin zur .uproject Datei des Spiels hinzu.

Im Beispiel wird die App aufgerufenGameLiftUnrealApp, also die DateiGameLiftUnrealApp.uproject.

Bearbeiten Sie die .uproject Datei, um das Plugin zu Ihrem Spielprojekt hinzuzufügen.

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

Stellen Sie sicher, dass ModuleRules das Spiel vom Plugin abhängig ist. Öffnen Sie die .Build.cs Datei und fügen Sie die Amazon GameLiftServer SDK-Abhängigkeit hinzu. Diese Datei finden Sie unterYour-application-name/Source//Your-application-name/.

Der Dateipfad für das Tutorial lautet beispielsweise. ../GameLiftUnrealApp/Source/GameLiftUnrealApp/GameLiftUnrealApp.Build.cs

Am Ende der Liste von hinzufügen"GameLiftServerSDK". PublicDependencyModuleNames

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;
    }
  }

Öffnen Sie in Visual Studio die .sln Datei für Ihre Anwendung. In unserem Beispiel GameLiftUnrealApp.sln befindet sich die Datei im Stammordner.

Suchen Sie bei geöffneter Lösung die Your-application-nameGameMode.h Datei Ihrer Anwendung. Beispiel: GameLiftUnrealAppGameMode.h.

Ändern Sie die Header-Datei so, dass sie dem folgenden Beispielcode entspricht. Achten Sie darauf, "GameLiftUnrealApp" durch Ihren eigenen Anwendungsnamen zu ersetzen.

#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();
};

Öffnen Sie die zugehörige Your-application-nameGameMode.cpp Quelldatei. In unserem Beispiel:GameLiftUnrealAppGameMode.cpp. und ändern Sie den Code so, dass er dem folgenden Beispielcode entspricht. Achten Sie darauf, "GameLiftUnrealApp" durch Ihren eigenen Anwendungsnamen zu ersetzen.

Dieses Beispiel zeigt, wie Sie alle erforderlichen Elemente für die Integration mit Amazon hinzufügen GameLift, wie unter Amazon GameLift zu Ihrem Spieleserver hinzufügen beschrieben. Dies umfasst:

#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);
}

Erstellen Sie ein Spielprojekt für die beiden folgenden Zieltypen: Entwicklungseditor und Entwicklungsserver.

Sobald beide Builds abgeschlossen sind, schließen Sie Visual Studio und öffnen Sie die .uproject Datei Ihres Projekts, um sie im Unreal Editor zu öffnen.

Packen Sie im Unreal Editor den Server-Build Ihres Spiels. Um ein Ziel auszuwählen, gehe zu Plattformen, Windows und wähle our-application-nameY-Server aus.

Um mit der Erstellung der Serveranwendung zu beginnen, wechseln Sie zu Plattformen, Windows und wählen Sie Paketprojekt aus. Wenn der Build abgeschlossen ist, sollten Sie über eine ausführbare Datei verfügen. In unserem Beispiel lautet der DateinameGameLiftUnrealAppServer.exe.

Beim Erstellen einer Serveranwendung in Unreal Editor werden zwei ausführbare Dateien erzeugt. Eine befindet sich im Stammverzeichnis des Build-Ordners des Spiels und dient als Wrapper für die eigentliche ausführbare Serverdatei.

Wenn Sie eine GameLift Amazon-Flotte mit Ihrem Server-Build erstellen, empfehlen wir, dass Sie die eigentliche ausführbare Serverdatei als Startpfad für die Laufzeitkonfiguration angeben. Beispielsweise könnten Sie in Ihrem Spiele-Build-Ordner eine GameLiftFPS.exe Datei im Stammverzeichnis und eine weitere unter haben\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe. Wenn Sie eine Flotte erstellen, empfehlen wir, den Startpfad für die Laufzeitkonfiguration zu verwendenC:\GameLiftFPS\Binaries\Win64\GameLiftFPSServer.exe.

Stellen Sie sicher, dass Sie die erforderlichen UDP-Ports auf der GameLift Amazon-Flotte öffnen, damit der Spieleserver mit den Spieleclients kommunizieren kann. Standardmäßig verwendet Unreal Engine den Port7777. Weitere Informationen finden Sie UpdateFleetPortSettingsim Referenzhandbuch GameLift zur Amazon Service API.

Erstellen Sie eine install.bat Datei für Ihren Spiel-Build. Dieses Installationsskript wird immer dann ausgeführt, wenn der Spiel-Build auf einer GameLift Amazon-Flotte bereitgestellt wird. Hier ist eine install.bat Beispieldatei:

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

Für einige Versionen von Unreal Engine install.bat sollte das stattdessen

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

Jetzt können Sie Ihren Spiel-Build verpacken und auf Amazon hochladen GameLift.

Die Version von OpenSSL, die du mit deinem Spiel-Build packst, muss mit der Version übereinstimmen, die die Game-Engine beim Aufbau des Spielservers verwendet hat. Vergewissere dich, dass du die richtige OpenSSL-Version mit deinem Gameserver-Build packst. Für das Windows-Betriebssystem ist .dll das OpenSSL-Format.