[UE5 - Multiplayer TPS] 언리얼 멀티 플레이어 플러그인 만들기(2) : Online Subsystem Steam을 사용하여 세션 생성하기

앞선 포스팅에서 LAN 연결을 구현할 때, 직접 IP주소를 입력하여 다른 PC의 게임에 접속했다.
하지만 실제 온라인 환경에서 게임에 접속할 때는 다른 유저의 IP주소를 모른 채로 게임에 접속한다. 
 
IP 주소를 모르는 채로 다른 컴퓨터와 네트워크 연결이 되려면 중간 단계가 필요하다.
우리가 게임 제작할 때 사용할 수 있는 중간 단계는 다음과 같이 2가지가 있다.

1. 유저들의 IP를 모아 관리하는 고유의 dedicate 서버로 연결
2. 스팀이나 xbox 라이브와 같은 온라인 플랫폼 서비스에서 제공하는 매치 메이킹 기능을 통해 연결
3. - 매치메이킹: 플레이어와 세션을 매치해 주는 프로세스 (세션 생성, 세션 검색, 세션 참여, 세션 소멸 등등)
4. - 세션 : 세션은 기본적으로 서버에서 실행중인 게임의 인스턴스

 우선, 1번은 고유의 dedicate 서버용 컴퓨터를 가지고 있어야 하기 때문에 유저가 늘어나면 늘어날수록 구축 비용이 비싸진다. 보통 유저가 많은 큰 회사에서 채택하는 서버 방식이다.
 
다음으로 2번은 스팀이나 xbox와 같은 게임 플랫폼에서 자신의 플랫폼의 게임에 제공하는 게임 서버이다.
개인 개발자나 작은 개발사는 2번을 선택할 수 밖에 없을 것이다.
 
그러나 2번의 방법에는 문제가 있다.
만약 게임을 스팀에도 올리고 xbox에도 올리고 싶다면, 같은 동작을 하는 코드를 각 플랫폼에 맞게 따로 작성해야 한다.
너무나 비효율적이고 피곤한 일이다.
 
언리얼 엔진은 이것을 해결하기 위해 플랫폼에 상관없이 매치 메이킹 API를 사용할 수 있는 Abstraction Layer를 제공한다.

{ Unreal Engine Subsystem }

Unreal Engine Subsystem : 온라인 플랫폼 서비스의 기능에 액세스하는 방법을 제공한다. 따라서 온라인 플랫폼마다 새로 코딩할 필요없이 각 플랫폼의 매치 메이킹 API 하나의 코드로 사용할 수 있게 도와준다.

1. 내 프로젝트에 Online Subsystem Steam 연결하기

1. Unreal 에서 “Online Subsystem Steam” 플러그 인을 추가한다.

2. 이 플러그인에 접근하기 위해 (projectName).Build.cs에서 PublicDependencyModuleNames.AddRange에 "OnlineSubsystemSteam", "OnlineSubsystem”를 추가한다.

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", ... , "OnlineSubsystemSteam", "OnlineSubsystem" });

3. 에디터와 vs를 종료하고 프로젝트 폴더 > Config > DefaultEngine.ini 에 다음 내용을 추가한다.

[/Script/Engine.GameEngine]
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemSteam.SteamNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

[OnlineSubsystem]
DefaultPlatformService=Steam

[OnlineSubsystemSteam]
bEnabled=true
SteamDevAppId=480
bInitServerOnClient=true

[/Script/OnlineSubsystemSteam.SteamNetDriver]
NetConnectionClassName="OnlineSubsystemSteam.SteamNetConnection"

4. 프로젝트 폴더에서 Binaries, Saved, Intermediate 폴더를 삭제한다. 그리고 (projectName).uproject 파일을 우클릭해서 Generate visual studio project files 옵션을 클릭한다.
5. 프로젝트가 정상적으로 실행되면 성공!

2.  Online Subsystem에 Access 하기

초기화 단계에서 OnlineSubsystem에 접근하여 OnlineSessionInterface을 받아온다.
OnlineSessionInterface는 매치 메이킹 수행은 물론 플레이어가 온라인 게임을 찾아 참가할 수 있도록 하기 위해 필요한 것들을 배후에 미리 구성하는 플랫폼 전용 함수성을 제공한다.
OnlineSubsystem을 사용하는데 필수적이다.

AMenuSystemCharacter::AMenuSystemCharacter()
{
	...
    
	// OnlineSubsystem에 Access
	IOnlineSubsystem* OnlineSubsystem = IOnlineSubsystem::Get();
	if (OnlineSubsystem)
	{
		// 온라인 세션 받아오기
		OnlineSessionInterface = OnlineSubsystem->GetSessionInterface();
		
		if (GEngine)
		{
			// OnlineSubsystem 이름 출력하기
			GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Blue, FString::Printf(TEXT("Found subsystem %s"), *OnlineSubsystem->GetSubsystemName().ToString()));
		}
	}
}

3.  Session이 생성되면 호출될 Delegate에 Callback함수를 바인딩하기.

(1) 생성자에서 Delegate 초기화 시에 Callback 함수 등록

AMenuSystemCharacter::AMenuSystemCharacter()
	: CreateSessionCompleteDelegate(FOnCreateSessionCompleteDelegate::CreateUObject(this, &ThisClass::OnCreateSessionComplete))
{
 	...
}

(2) Callback 함수 구현

void AMenuSystemCharacter::OnCreateSessionComplete(FName SessionName, bool bWasSuccssful)
{
	// 세션 생성 성공!
	if (bWasSuccssful)
	{
		if (GEngine)
		{
			GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Blue, FString::Printf(TEXT("Created session : %s"), *SessionName.ToString()));
		}
	} 

	// 세선 생성 실패
	else
	{
		if (GEngine)
		{
			GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Red, FString(TEXT("Failed to create session!")));
		}
	}
}

4.  Session 생성

(1) OnlineSessionInterface가 유효한지 체크한다.

if (!OnlineSessionInterface.IsValid())
{
	// log
	if (GEngine)
	{
		GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Red, FString(TEXT("Game Session is invailed")));
	}
	return;
}

(2) 이미 세션이 존재한다면 기존 세션을 삭제한다.

auto ExistingSession = OnlineSessionInterface->GetNamedSession(NAME_GameSession);
if (ExistingSession != nullptr)
{
	OnlineSessionInterface->DestroySession(NAME_GameSession);
	
	// Log
	if (GEngine)
	{
		GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Black, FString::Printf(TEXT("Destroy session : %s"), NAME_GameSession));
	}
}

(3) 세션 생성 완료 후 호출될 delegate 리스트에 CreateSessionCompleteDelegate 추가

OnlineSessionInterface->AddOnCreateSessionCompleteDelegate_Handle(CreateSessionCompleteDelegate);

(4) 세션 옵션 세팅하기

TSharedPtr<FOnlineSessionSettings> SessionSettings = MakeShareable(new FOnlineSessionSettings());

SessionSettings->bIsLANMatch = false;			// LAN 연결
SessionSettings->NumPublicConnections = 4;		// 최대 접속 가능 수
SessionSettings->bAllowJoinInProgress = true;	// Session 진행중에 접속 허용
SessionSettings->bAllowJoinViaPresence = true;  // 세션 참가 지역을 현재 지역으로 제한 (스팀의 presence 사용)
SessionSettings->bShouldAdvertise = true;		// 현재 세션을 광고할지 (스팀의 다른 플레이어에게 세션 홍보 여부)
SessionSettings->bUsesPresence = true;			// 현재 지역에 세션 표시
SessionSettings->bUseLobbiesIfAvailable = true; // 플랫폼이 지원하는 경우 로비 API 사용

(5) Local Player를 호스트로 설정하여 하여 세션 생성하기

const ULocalPlayer* LocalPlayer = GetWorld()->GetFirstLocalPlayerFromController();
OnlineSessionInterface->CreateSession(*LocalPlayer->GetPreferredUniqueNetId(), NAME_GameSession, *SessionSettings);

 
전체 코드

void AMenuSystemCharacter::CreateGameSession()
{
	// Called when pressing the 1key
	if (!OnlineSessionInterface.IsValid())
	{
		// log
		if (GEngine)
		{
			GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Red, FString(TEXT("Game Session is invailed")));
		}
		return;
	}

	// 이미 세션이 존재한다면 기존 세션을 삭제한다
	auto ExistingSession = OnlineSessionInterface->GetNamedSession(NAME_GameSession);
	if (ExistingSession != nullptr)
	{
		OnlineSessionInterface->DestroySession(NAME_GameSession);
		
		// Log
		if (GEngine)
		{
			GEngine->AddOnScreenDebugMessage(-1, 15.f, FColor::Black, FString::Printf(TEXT("Destroy session : %s"), NAME_GameSession));
		}
	}

	// 세션 생성 완료 후 호출될 delegate 리스트에 CreateSessionCompleteDelegate 추가
	OnlineSessionInterface->AddOnCreateSessionCompleteDelegate_Handle(CreateSessionCompleteDelegate);

	// 세션 세팅하기
	TSharedPtr<FOnlineSessionSettings> SessionSettings = MakeShareable(new FOnlineSessionSettings());

	SessionSettings->bIsLANMatch = false;			// LAN 연결
	SessionSettings->NumPublicConnections = 4;		// 최대 접속 가능 수
	SessionSettings->bAllowJoinInProgress = true;	// Session 진행중에 접속 허용
	SessionSettings->bAllowJoinViaPresence = true;  // 세션 참가 지역을 현재 지역으로 제한 (스팀의 presence 사용)
	SessionSettings->bShouldAdvertise = true;		// 현재 세션을 광고할지 (스팀의 다른 플레이어에게 세션 홍보 여부)
	SessionSettings->bUsesPresence = true;			// 현재 지역에 세션 표시
	SessionSettings->bUseLobbiesIfAvailable = true; // 플랫폼이 지원하는 경우 로비 API 사용
	
	const ULocalPlayer* LocalPlayer = GetWorld()->GetFirstLocalPlayerFromController();
	OnlineSessionInterface->CreateSession(*LocalPlayer->GetPreferredUniqueNetId(), NAME_GameSession, *SessionSettings);
}

결과!

좌상단의 Debug Message에서 세션이 생성되었음을 확인할 수 있다.