Unity용 Multiplay Hosting SDK

Unity.Services.Multiplay

요구 사항 및 제한 사항

SDK 초기화

IMultiplayService

async void Example_InitSDK(){	try	{		await UnityServices.InitializeAsync();	}	catch (Exception e)	{		Debug.Log(e);	}}

게임 서버 구성

ServerConfig

ServerConfig

ServerConfig

ServerConfig

ServerConfig

serverId

allocationId

queryPort

port

serverLogDirectory

ServerConfig

using System.Collections;using System.Collections.Generic;using Unity.Services.Multiplay;using UnityEngine;public class Example_ServerConfiguration{	/// <summary>	/// A simple example of accessing each of the server config's fields and printing them to the debug console.	/// </summary>	public static void LogServerConfig()	{		var serverConfig = MultiplayService.Instance.ServerConfig;		Debug.Log($"Server ID[{serverConfig.ServerId}]");		Debug.Log($"AllocationID[{serverConfig.AllocationId}]");		Debug.Log($"Port[{serverConfig.Port}]");		Debug.Log($"QueryPort[{serverConfig.QueryPort}");		Debug.Log($"LogDirectory[{serverConfig.ServerLogDirectory}]");	}}

게임 서버 준비

ReadyServerForPlayersAsync

using System.Threading.Tasks;using Unity.Services.Multiplay;/// <summary>/// Ready the server. This is to indicate that the server is ready to accept players./// Readiness is the server's way of saying it's ready for players to join the server./// You must wait until you have been Allocated before you can call ReadyServerForPlayersAsync./// </summary>private async void Example_ReadyingServer(){	// After the server is back to a blank slate and ready to accept new players	await MultiplayService.Instance.ReadyServerForPlayersAsync();}

게임 서버 준비 해제

UnreadyServerAsync

using System.Threading.Tasks;using Unity.Services.Multiplay;/// <summary>/// Unready the server. This is to indicate that the server is in some condition which means it can't accept players./// For example, after a game has ended and you need to reset the server to prepare for a new match./// </summary>private async void Example_UnreadyingServer(){	// The match has ended and players are disconnected from the server	await MultiplayService.Instance.UnreadyServerAsync();}

서버 쿼리 핸들러 시작

StartServerQueryHandlerAsync

maxPlayers

serverName

gameType

buildId

map

port

StartServerQueryHandlerAsyncparameters

IServerCheckManager

UpdateServerCheck()

UpdateServerCheck()

UpdateServerCheck()

Update

currentPlayers

using System.Collections;using System.Collections.Generic;using UnityEngine;using Unity.Services.Multiplay;/// <summary>/// An example of how to use SQP from the server using the Multiplay SDK./// The ServerQueryHandler reports the given information to the Multiplay Service./// </summary>public class Example_ServerQueryHandler : MonoBehaviour{	private const ushort k_DefaultMaxPlayers = 10;	private const string k_DefaultServerName = "MyServerExample";	private const string k_DefaultGameType = "MyGameType";	private const string k_DefaultBuildId = "MyBuildId";	private const string k_DefaultMap = "MyMap";	public ushort currentPlayers;	private IServerQueryHandler m_ServerQueryHandler;	private async void Start()	{		m_ServerQueryHandler = await MultiplayService.Instance.StartServerQueryHandlerAsync(k_DefaultMaxPlayers, k_DefaultServerName, k_DefaultGameType, k_DefaultBuildId, k_DefaultMap);	}	private void Update()	{		m_ServerQueryHandler.UpdateServerCheck();	}	public void ChangeQueryResponseValues(ushort maxPlayers, string serverName, string gameType, string buildId)	{		m_ServerQueryHandler.MaxPlayers = maxPlayers;		m_ServerQueryHandler.ServerName = serverName;		m_ServerQueryHandler.GameType = gameType;		m_ServerQueryHandler.BuildId = buildId;	}	public void PlayerCountChanged(ushort newPlayerCount)	{		m_ServerQueryHandler.CurrentPlayers = newPlayerCount;	}}

서버 이벤트 구독

SubscribeToServerEventsAsync

OnAllocate

OnDeallocate

OnError

using System;using System.Collections;using System.Collections.Generic;using Unity.Services.Multiplay;using UnityEngine;/// <summary>/// An example of how to access and react to multiplay server events./// </summary>public class Example_ServerEvents : MonoBehaviour{	private MultiplayEventCallbacks m_MultiplayEventCallbacks;	private IServerEvents m_ServerEvents;	/// <summary>	/// This should be done early in the server's lifecycle, as you'll want to receive events as soon as possible.	/// </summary>	private async void Start()	{		// We must first prepare our callbacks like so:		m_MultiplayEventCallbacks = new MultiplayEventCallbacks();		m_MultiplayEventCallbacks.Allocate += OnAllocate;		m_MultiplayEventCallbacks.Deallocate += OnDeallocate;		m_MultiplayEventCallbacks.Error += OnError;		m_MultiplayEventCallbacks.SubscriptionStateChanged += OnSubscriptionStateChanged;		// We must then subscribe.		m_ServerEvents = await MultiplayService.Instance.SubscribeToServerEventsAsync(m_MultiplayEventCallbacks);	}// Handle Multiplay events.}

Multiplay Hosting 이벤트 처리

MultiplayEventCallbacks

OnAllocate

OnDeallocate

OnError

using System;using System.Collections;using System.Collections.Generic;using Unity.Services.Multiplay;using UnityEngine;/// <summary>/// An example of how to access and react to multiplay server events./// </summary>public class Example_ServerEvents : MonoBehaviour{	private MultiplayEventCallbacks m_MultiplayEventCallbacks;	private IServerEvents m_ServerEvents;	/// <summary>	/// This should be done early in the server's lifecycle, as you'll want to receive events as soon as possible.	/// </summary>	private async void Start()	{		// We must first prepare our callbacks like so:		m_MultiplayEventCallbacks = new MultiplayEventCallbacks();		m_MultiplayEventCallbacks.Allocate += OnAllocate;		m_MultiplayEventCallbacks.Deallocate += OnDeallocate;		m_MultiplayEventCallbacks.Error += OnError;		m_MultiplayEventCallbacks.SubscriptionStateChanged += OnSubscriptionStateChanged;		// We must then subscribe.		m_ServerEvents = await MultiplayService.Instance.SubscribeToServerEventsAsync(m_MultiplayEventCallbacks);	}	/// <summary>	/// Handler for receiving the allocation multiplay server event.	/// </summary>	/// <param name="allocation">The allocation received from the event.</param>	private void OnAllocate(MultiplayAllocation allocation)	{		// Here is where you handle the allocation.		// This is highly dependent on your game, however this would typically be some sort of setup process.		// Whereby, you spawn NPCs, setup the map, log to a file, or otherwise prepare for players.		// After you the allocation has been handled, you can then call ReadyServerForPlayersAsync()!	}	/// <summary>	/// Handler for receiving the deallocation multiplay server event.	/// </summary>	/// <param name="deallocation">The deallocation received from the event.</param>	private void OnDeallocate(MultiplayDeallocation deallocation)	{		// Here is where you handle the deallocation.		// This is highly dependent on your game, however this would typically be some sort of teardown process.		// You might want to deactivate unnecessary NPCs, log to a file, or perform any other cleanup actions.	}	/// <summary>	/// Handler for receiving the error multiplay server event.	/// </summary>	/// <param name="error">The error received from the event.</param>	private void OnError(MultiplayError error)	{		// Here is where you handle the error.		// This is highly dependent on your game. You can inspect the error by accessing the error.Reason and error.Detail fields.		// You can change on the error.Reason field, log the error, or otherwise handle it as you need to.	}	/// <summary>	///	/// </summary>	/// <param name="state"></param>	private void OnSubscriptionStateChanged(MultiplayServerSubscriptionState state)	{		switch (state)		{			case MultiplayServerSubscriptionState.Unsubscribed: /* The Server Events subscription has been unsubscribed from. */ break;			case MultiplayServerSubscriptionState.Synced: /* The Server Events subscription is up to date and active. */ break;			case MultiplayServerSubscriptionState.Unsynced: /* The Server Events subscription has fallen out of sync, the subscription tries to automatically recover. */ break;			case MultiplayServerSubscriptionState.Error: /* The Server Events subscription has fallen into an errored state and won't recover automatically. */ break;			case MultiplayServerSubscriptionState.Subscribing: /* The Server Events subscription is trying to sync. */ break;		}	}}

Allocate

public event Action<MultiplayAllocation> Allocate;

Allocate

MultiplayAllocation

Deallocate

public event Action<MultiplayDeallocation> Deallocate;

Deallocate

MultiplayDeallocation

Error

public event Action<MultiplayError> Error;

Error

MultiplayError

SubscriptionStateChange

public event Action<MultiplayServerSubscriptionState> SubscriptionStateChanged;

SubscriptionStateChanged

MultiplayServerSubscriptionState

Unity 에디터로 리소스 배포

Multiplay 설정

1. SDK 설치
2. Unity 에디터에 프로젝트 연결

필수 패키지 설치

• Deployment
• Multiplay:
  • Unity 6 이상: Multiplayer
  • Unity 2022 LTS 이하: Multiplay

1. Unity 에디터에서 Window > Package Manager를 선택합니다.
2. + > Install package by name을 선택합니다.

3. com.unity.services.deployment

   를 입력합니다.
4. Install을 선택합니다.
5. Multiplay에도 같은 단계를 반복합니다.
   • Unity 6 이상:

     com.unity.services.multiplayer

   • Unity 2022 LTS 이하:

     com.unity.services.multiplay

프로젝트 연결

1. Unity 에디터에서 Edit > Project Settings > Services를 선택합니다.
2. 프로젝트를 연결합니다.

• 프로젝트에 Unity 프로젝트 ID가 없는 경우 다음 단계를 진행합니다.

1. Create a Unity Project ID > Organizations를 선택한 다음 드롭다운 메뉴에서 조직을 선택합니다.
2. Create project ID를 선택합니다.

• Unity 프로젝트 ID가 있는 경우 다음 단계를 진행합니다.

1. Use an existing Unity project ID를 선택합니다.
2. 드롭다운 메뉴에서 조직과 프로젝트를 선택합니다.
3. Link project ID를 선택합니다.

UnityEditor.CloudProjectSettings.projectId

Unity 에디터에서 저작

구성 생성

1. Unity 에디터에서 프로젝트(Project) 창을 오른쪽 클릭하고 Create > Services > Multiplay Config를 선택합니다.
2. 리소스 파일의 이름을 지정합니다.
3. Enter 키를 누릅니다.

구성 편집

• Project 탭에서 기존 리소스를 더블 클릭한 다음 텍스트 에디터를 선택하여 구성을 편집합니다.

리소스 파일 콘텐츠

yaml

.gsh

new_multiplay_config.gsh

version: 1.0builds:  my build: # replace with the name for your build    executableName: Build.x86_64 # the name of your build executable    buildPath: Builds/Multiplay # the location of the build filesbuildConfigurations:  my build configuration: # replace with the name for your build configuration    build: my build # replace with the name for your build    queryType: sqp # sqp or a2s, delete if you do not have logs to query    binaryPath: Build.x86_64 # the name of your build executable    commandLine: -port $$port$$ -queryport $$query_port$$ -log $$log_dir$$/Engine.log # launch parameters for your server    variables: {}    cores: 1 # number of cores per server    speedMhz: 750 # launch parameters for your server    memoryMiB: 800 # launch parameters for your serverfleets:  my fleet: # replace with the name for your fleet    buildConfigurations:      - my build configuration # replace with the names of your build configuration    regions:      North America: # North America, Europe, Asia, South America, Australia        minAvailable: 0 # minimum number of servers running in the region        maxServers: 1 # maximum number of servers running in the region

• 빌드
• 빌드 구성
• 플릿

리소스 배포

Deployment 창