Unreal GameLift Server SDK 플러그인 추가하기

Intro

GameLift Server SDK를 활용하여 Unreal Dedicate Server를 테스트하기 위해

GameLift SDK를 Unreal 프로젝트에 추가해 보자!

 

이 글의 작업 환경은 Win64이며,

다음 페이지를 참고하여 진행했다.

https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-engines-setup-unreal.html

Integrate Amazon GameLift Servers into an Unreal Engine project - Amazon GameLift Servers

 

---

준비

✅Visual Studio 2019 이상

✅ CMake 3.1 이상

✅ Python 3.6 이상

✅ Git PATH설정 완료

✅ Unreal Engine Source Build

 

---

프로젝트에 Server Target 추가하기

1. {ProjectName}Server.Target.cs 파일 추가

 

2. 다른 Target.cs의 내용을 복사해 와 TargetType만 Server로 수정해 준다.

// Copyright Epic Games, Inc. All Rights Reserved.

using UnrealBuildTool;
using System.Collections.Generic;

public class FPSTemplateServerTarget : TargetRules
{
    public FPSTemplateServerTarget(TargetInfo Target) : base(Target)
    {
        Type = TargetType.Server;
        DefaultBuildSettings = BuildSettingsVersion.V5;
        IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_4;
        ExtraModuleNames.Add("FPSTemplate");
    }
}

 

---

 

Unreal을 위한 ServerSDK 라이브러리 빌드하기

이 과정에서 우리가 최종적으로 얻어야 하는 건 다음과 같다.

1. OpenSSL의 dll 파일!

2. aws-cpp-sdk-gamelift-server의 dll파일과 lib 파일이 담긴 GameLiftPlugin 폴더!

Open SSL 빌드하기

🤔OpenSSL이 필요한 이유

Open SSL은 오픈소스 암호화 (Cryptography) 라이브러리이다. 네트워크 상에서 컴퓨터 간 커뮤니케이션 보안에 사용된다. 데이터의 보안과 무결성(Integrity)을 보장하는데 도움을 주는 SSL(Secure Socket Layer)과 TLS(Transport Layer Security) 프로토콜을 사용한다.

GameLift를 사용하여 온라인 게임을 제작할 때 AWS의 클라우드 서비스에 데이터를 보내고 받게 되는데 이 AWS가 Open SSL을 사용한다. 그리고 Amazon Game Lift SDK를 사용하는 게임 프로젝트를 패키징 하기 위해 이 라이브러리가 필요하다.

1. OpenSSL 다운로드 및 설치

참고 문서 => https://github.com/openssl/openssl/blob/master/NOTES-WINDOWS.md

openssl/NOTES-WINDOWS.md at master · openssl/openssl

 

---

OpenSSL 빌드를 위해선 몇 가지 사전 작업이 필요하다.

 

사전 작업 1. Perl 설치 : https://strawberryperl.com/

Strawberry Perl for Windows

 

​👇설치 방법 (더 보기)

최신버전의 MSI 파일을 다운하여 설치한다.

 

CMD 창에서 " perl --version "을 입력했을 때, 다음과 같이 버전 정보가 뜬다면 성공적으로 설치가 완료된 것이다.

 

 

사전 작업 2. NASM 설치 : https://www.nasm.us/

NASM

NASM은 Netwide Assembler로 인텔 x86 아키텍처용 어셈블러이자 역어셈블러이다. 프로그램을 작성하는 데 사용되고 OpenSSL을 사용하기 위해 필요하다.

​👇설치 방법 (더 보기)

NASM 사이트로 들어가 최신버전의 installer를 다운받아 준다.

• 실행 파일을 관리자권한으로 실행 후, 설치를 진행한다.
• 설치 후, CMD 창을 켜서 nasm --version 을 입력하여 최신 버전으로 잘 설치가 되었는지 확인한다. 이때, where nasm 을 입력했을때, Strawberry 하위에 있는 nasm.exe 경로가 나온다면 환경 변수 설정을 해줘야한다.

• 환경변수 설정 창에서 시스템 편수 > Path를 편집하여, NASM의 경로가 Strawberry 경로보다 위에 올 수 있도록 한다.

• 그리고 다시 where nasm 을 입력했을때, 다음과 같이 나오면 성공적으로 설치가 된 것이다.

---

 

사전 작업이 끝났으면 이어서 아래 과정을 따라간다.

 

1. 기본 개발자 명령 프롬프트 명령 파일 VsDevCmd.bat 실행하기

이 과정은 nmake.exe와 cl.exe 환경 변수 설정을 위해 필요한 과정이다.

• 📂C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\Common7\\Tools 에서 VsDevCmd.bat을 찾는다.
• 찾았다면 cmd를 관리자 권한으로 실행한다.
• cmd 창에 다음과 같이 입력한다 (window 64bit의 경우)

"C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\Common7\\Tools\\VsDevCmd.bat" -arch=amd64

 

 

2. OpenSSL Configuration

• 적당한 위치에 OpenSSL repository 를 Clone한다.https://github.com/openssl/openssl.git

GitHub - openssl/openssl: TLS/SSL and crypto library

• 해당 위치에서 cmd를 실행 시킨 후 다음과 같이 입력한다.

perl Configure VC-WIN64A

 

• 아래와 같이 뜨면 OpenSSL Configuration에 성공한 것이다.

 

3. NMake 실행하기

• x64 Native Tools Command Prompt for VS2022를 관리자 권한으로 실행한다.

• OpenSSL 경로로 이동 후 nmake를 실행한다. 꽤 오랜 시간이 걸린다.

이 모든 과정이 끝났으면 openssl 경로에서 다음 두 파일을 복사해둔다.

📄 libcrypto-3-x64.dll

📄 libssl-3-x64.dll

Game Lift Server SDK 빌드하기

• 아래 페이지에서 최신 Release버전의 .zip파일을 다운 받는다.
  https://github.com/amazon-gamelift/amazon-gamelift-plugin-unreal/releases

Releases · amazon-gamelift/amazon-gamelift-plugin-unreal

 

 

• 압축을 푼다.
  다운받은 파일의 압축을 풀면, 두 압축파일 amazon-gamelift-plugin-unreal과 GameLift-Cpp-ServerSDK을 확인할 수 있는데, 이 두 압축 파일을 download가 아닌 C드라이브에 압축을 푼다.

• Server SDK 빌드를 위해 시스템 환경변수에 이전에 다운받았던 OPENSSL의 경로를 바탕으로 "OPENSSL_ROOT_DIR" 과 "OPENSSL_INCLUDE_DIR" 추가한다.

• Developer Command Prompt for VS 2022를 관리자 권한으로 실행한다.

 

• 다음 명령어를 순차적으로 입력하여 빌드를 진행한다.

cd C:\GameLift-Cpp-ServerSDK-5.2.0
mkdir out
cd out
cmake -G "Visual Studio 17 2022" -DBUILD_FOR_UNREAL=1 ..
msbuild ALL_BUILD.vcxproj /p:Configuration=Release

 

 

• 생성된 다음 두 파일을 복사한다.
  📄 \out\prefix\lib\aws-cpp-sdk-gamelift-server.lib
  📄 \out\prefix\bin\aws-cpp-sdk-gamelift-server.dll
  
  
• 복사한 파일을 아까 압축을 풀었던 amazon-gamelift-plugin-unreal의 다음 경로에 Unreal plugin 폴더에 붙여넣는다.
  📁 C:\amazon-gamelift-plugin-unreal\GameLiftPlugin\Source\GameLiftServer\ThirdParty\GameLiftServerSDK\Win64

 

Import the Game Lift Server SDK 

• amazon-gamelift-plugin-unreal의 📁 GameLiftPlugin 폴더를 복사한다.

• 언리얼 프로젝트 경로로 이동해서 📁Plugins 폴더를 새로 생성한다.

• 이 Plugin 폴더에 복사해둔 GameLiftPlugin를 붙여넣는다.

만약 git을 사용중이라면 프로젝트에서 사용되는 📄.gitignore 파일을 복사해 📁Plugins 폴더에도 추가해줘야한다.

• 프로젝트의 .uproject에 플러그 인을 추가한다.

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

 

• 프로젝트의 .Build.cs 파일의 PublicDependencyModuleNames 끝에 "GameLiftServerSDK”를 추가한다.

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

 

• 📁Binaries 와 📁Intermediate 폴더를 삭제하고 .uproject 우클릭 후 “Generate Visual Studio project file” 을 선택한다.
• 솔루션을 열고 플러그인이 성공적으로 추가되었는지 확인한다.

 

• 프로젝트를 빌드한다.
  • 만약 빌드에 실패했다면,
    • 프로젝트에서 사용되는 📄.gitignore 파일을 복사해 📁Plugins 폴더에도 추가가 되었는지 확인한다.
    • 프로젝트 .Target.cs 의 IncludeOrderVersion 을 다음과 같이 수정해보자.
      

      IncludeOrderVersion = EngineIncludeOrderVersion.Latest;
      ​

• Development Server 빌드를 진행한다.

---

마무리

 

빌드까지 마쳤다면 성공적으로 GameLift SDK 플러그인을 프로젝트에 추가 완료된 것이다!!

OPENSSL의 두 dll 은 Server 패키징 후에 필요하니 잘 보관해두자.

📄 libcrypto-3-x64.dll

📄 libssl-3-x64.dll