유니티 게임 클라이언트 개발 프레임워크입니다. 다양한 기능을 적은 코딩으로 쉽게 구현할 수 있습니다. C# 서버와 통신 시 직렬화를 위해 MessagePack-CSharp을 사용하였으며 기타 유틸을 사용하기 위해 Nextwin C# Library를 참조합니다. 또한 C#의 Dictionary를 유니티 인스펙터창에서 수정할 수 있도록 Serializable Dictionary Asset을 포함합니다.
이 프레임워크를 사용하기 위해 상단의 download 버튼을 클릭하여 유니티 패키지를 다운받은 후, 유니티 프로젝트에 import 하세요.
서버와 통신할 때 데이터를 직렬화, 역직렬화 하기 위해 사용되는 라이브러리입니다.
우선 프레임워크에 종속적인 데이터 패킷 클래스(서버와 주고 받기 위해 직렬화할 클래스)를 만들기 위해 다음과 같이 Nextwin.Client.Protocol.SerailizableData를 상속받는 클래스를 생성합니다.
using MessagePack;
using Nextwin.Client.Protocol;
using System.Collections.Generic;
// 전송 데이터 패킷임을 표시하기 위해 [MessagePackObject]를 붙여줍니다.
[MessagePackObject]
public class PacketExample : SerializableData
{
// 직렬화할 필드 변수 위에 [Key(n)]을 작성합니다. Key는 1번부터 시작하세요.
[Key(1)]
public int IntData { get; set; }
[Key(2)]
public float FloatData { get; set; }
[Key(3)]
public List<int> IntList { get; set; }
[Key(4)]
public string StringData { get; set; }
// SerializableData를 상속받기 때문에 다음과 같은 형태의 생성자가 반드시 필요합니다.
public Packet(int msgType) : base(msgType)
{
}
}다음 작업은 데이터 패킷 클래스가 추가된 후 빌드나 유니티 에디터에서 실행시키기 전에 반드시 수행되어야 합니다. 우선 .NET Core 3.1버전을 설치하세요. cmd나 터미널에서 dotnet -v 명령어를 통해 설치된 .NET 버전을 확인할 수 있습니다. 버전이 .NET Core 3.1인지 꼭 확인하세요. 유니티 실행 시에는 동적으로 코드를 생성할 수 없기 때문에 데이터 패킷 클래스가 추가될때마다 다음 절차를 반드시 수행해주세요.
유니티 에디터 메뉴의 Window->MessagePack->CodeGenerator를 선택하여 MessagePackCodeGen창을 엽니다.
첫 입력 줄에는 프로젝트 어셈블리 파일을 입력합니다. 기본 경로는 ${유니티 프로젝트}/Assets 폴더입니다. 두번째 줄에는 생성된 코드가 위치할 경로를 입력합니다. 아래의 Generate 버튼을 클릭하면 다음과 같이 두번째 줄에 지정한 위치에 스크립트가 생성된 것을 확인할 수 있습니다.
기타 자세한 내용은 MessagePack-CSharp을 참고하세요.
캐릭터 객체에 PlayerController Component를 추가하여 캐릭터를 조작할 수 있습니다. 인스펙터창을 보면 다음과 같습니다.
On Control을 체크하면 사용자의 입력이 캐릭터의 움직임에 영향을 줍니다. 캐릭터를 조작하기 위해서는 On Control이 체크되어 있어야 합니다.
"Body"는 캐릭터의 머리, 팔, 다리, 몸통을 모두 포함한 객체입니다. 사용자의 입력을 받아 실제로 움직이는 오브젝트입니다. "Pivot"은 카메라 조작을 위해 사용됩니다. 빈 게임 오브젝트이고 캐릭터를 조작하는 방법(시점)에 따라 달라집니다. 아래에서 어떤 오브젝트가 "Pivot"에 할당되어야 하는지 설명합니다. "Camera"에 알맞은 카메라를 넣어줍니다. 게임을 실행하면 카메라에 CameraController 컴포넌트가 추가되고 카메라에 관한 설정은 이를 통해 할 수 있습니다. "Foot"은 캐릭터의 발입니다. 발이 땅에 닿아있는지, 즉 캐릭터가 공중에 떠있는지 땅 위에 있는지 확인하기 위해 사용됩니다. "Foot"에는 Rigidbody 컴포넌트가 붙어있어야 합니다.
"Use Mouse"는 캐릭터 조작에 마우스를 사용하는지 여부입니다. "Use Mouse" 상태에 따라 게임의 시점과 조작 방법, 그리고 캐릭터의 계층 구조가 달라집니다. "Mouse Sensitivity"는 "Use Mouse"를 체크한 상태일 때만 유효하며 마우스 민감도를 설정하는 항목입니다.
[Control Basic Key Setting] 에서는 기본 조작키를 설정할 수 있습니다.
"Walk Speed"와 "Run Speed"는 각각 기본 움직임 시 속도, "Run Key"를 이동키와 함께 눌렀을 때의 속도입니다. "Rotate Speed"는 "Use Mouse"가 체크되어있지 않을 때 유효하며 캐릭터가 이동하는 방향 전환 시 캐릭터가 회전하는 속도입니다. "Jump Power"를 통해 점프력을 설정할 수 있습니다.
"Check Ground By Tag Or Layer"은 땅 오브젝트를 판별할 때 Tag로 검사할 것인지, Layer로 검사할 것인지 여부입니다. "Ground Tag Or Layer"에는 땅 오브젝트의 Tag("Check Ground By Tag Or Layer"에서 Tag를 선택했을 때) 혹은 Layer("Check Ground By Tag Or Layer"에서 Layer를 선택했을 때)를 입력합니다.
PlayerController를 상속받아 몇몇 함수를 재정의하거나 다른 기능을 추가하여 필요에 맞게 튜닝해서 사용할 수 있습니다.
캐릭터는 2가지 방법으로 조작할 수 있습니다.
마우스를 사용할 때에는 다음과 같이 캐릭터를 구성해줍니다.
"Body"는 캐릭터의 머리, 팔, 다리, 몸통을 모두 포함한 객체입니다. "Pivot"은 빈 게임 오브젝트입니다.
마우스를 사용하지 않을 때에는 다음과 같이 캐릭터를 구성해줍니다.
플레이어와 카메라의 거리, 카메라의 높이 및 각도를 설정할 수 있습니다.
"Camera Distance"는 플레이어와 카메라 사이의 거리입니다. "Camera Height"는 카메라의 높이입니다. "Camera Angle"은 카메라의 각도입니다. "Camera Speed"는 PlayerController의 Walk Speed와 비슷하거나 약간 더 느리게 하는 것이 좋습니다.
서버와 통신이 필요한 경우 GameManager를 만들 때 Nextwin.Client.Game.GameManagerBase를 상속받으세요. 서버와 연결 및 서버로부터 데이터를 수신하는 등의 번거로운 작업을 코딩하지 않아도 됩니다. 다음은 서버로부터 받은 데이터를 처리하는 예시입니다.
using Nextwin.Client.Game;
using Nextwin.Client.Protocol;
public class GameManager : GameManagerBase<GameManager>
{
// Start is called before the first frame update
protected override void Start()
{
base.Start();
// 추가적인 Start 함수 구현
}
// Update is called once per frame
protected override void Update()
{
base.Update();
// 추가적인 Update 함수 구현
}
protected override void OnReceivedData(int msgType, byte[] receivedData)
{
switch(msgType)
{
case ExProtocol.ExMessage:
PacketExample packetExample = Serializer.Instance.Deserialize<PacketExample>(receivedData);
/*
* 적절한 작업을 수행합니다.
*/
break;
.....
}
}
}Start와 Update 함수의 접근자를 protected로 바꿔주고 override 키워드를 추가합니다. 각 함수의 첫 줄에는 base.Start()와 base.Update()함수를 추가하여 GameManagerBase의 Start, Update 함수가 수행되도록 합니다. OnReceivedData 함수를 반드시 구현해야 합니다. 서버로부터 데이터를 받았을 때 호출되며 위의 예시와 같이 msgType에 따라 적절한 작업이 수행되도록 합니다. receivedData를 Serializer.Instance.Deserilalize<특정 패킷 클래스>(receivedData)와 같이 역직렬화할 수 있습니다. 물론 이 작업을 위해서 해당 패킷 클래스를 작성한 후 동적 코드 생성 작업을 해주어야 합니다.
GameManagerBase를 상속받은 GameManager는 Singleton 객체입니다.
서버에 어떤 데이터를 주고받을 때에는 그 데이터를 직렬화, 역직렬화 해야합니다. 이때 직렬화, 역직렬화 되는 데이터 클래스의 최상위 클래스입니다. SerializableData를 상속받지 않고도 직렬화 가능한 클래스를 만들 수 있지만 해당 프레임워크에 맞추어 사용하기 위해 SerializableData를 상속받습니다. 직렬화 및 역직렬화 가능한 데이터 클래스를 만드는 방법은 MessagePack에서 확인하세요.
Singleton 객체로 Nextwin.Protocol.ISerializer 인터페이스를 구현합니다. 데이터를 직렬화하고 역직렬화 하는 방법은 다음과 같습니다.
// 직렬화
byte[] bytes = Serializer.Instance.Serialize(packetExample1);
// 역직렬화
PacketExample packetExample2 = Serializer.Instance.Deserialize<PacketExample>(bytes);UI를 관리합니다. 추상 클래스이기 때문에 UIManagerBase를 상속받은 UIManager 클래스를 정의해주어야 합니다. 마찬가지로 UIManagerBase도 Singleton 객체입니다. 다음은 UIManagerBase를 상속받은 UIManager 클래스 작성 예시입니다.
using Nextwin.Client.UI;
public enum EFrame
{
Frame1,
Frame2,
Frame3
}
public enum EDialog
{
Dialog1,
Dialog2,
Dialog3
}
public class UIManager : UIManagerBase<UIManager, EFrame, EDialog>
{
}UIManagerBase에 3가지 타입 파라미터를 전달해야합니다. 첫번째 인자는 UIManagerBase를 상속받는 클래스, 두번째 인자는 Frame에 대한 enum, 세번째 인자는 Dialog에 대한 enum입니다. 두번째와 세번째 타입 파라미터를 UIManager 클래스 위에 EFrame과 EDialog라고 정의하였으며 이 enum의 멤버들은 Frame이나 Dialog를 식별하는 키가 됩니다.
UIManagerBase를 상속받은 이 UIManager를 씬 내의 게임 오브젝트의 Component로 붙여 활성화하면 어플리케이션 실행 시 모든 UI를 즉, Frame과 Dialog를(모든 UI는 Frame이나 Dialog로 관리되어야 합니다.) 비활성화 상태로 만듭니다.
다양한 UI Component들로 구성된 하나의 전체 화면입니다. UIManager를 통해 관리됩니다. 화면 전환을 쉽게 구현할 수 있습니다. 먼저 UIFrame을 상속받은 클래스를 다음과 같이 정의합니다.
using Nextwin.Client.UI;
// UIManager에서 정의한 enum인 EFrame을 타입 파라미터로 전달하였습니다.
public class UIFrameExample : UIFrame<EFrame>
{
}타입 파라미터로 전달된 EFrame은 반드시 UIManagerBase에 타입 파라미터로 전달한 두번째 파라미터와 같아야 합니다.
Canvas 아래에 Image 혹은 Panel을 추가하고 화면에 꽉 차도록 만듭니다. 그리고 추가한 오브젝트에 위에서 새로 정의한 클래스인 UIFrameExample을 추가합니다.
"Id"와 "Show Speed Rate"를 조정할 수 있습니다. "Id"는 UIManager에서 UIFrame을 상속받은 다양한 클래스들을 식별하여 관리할 수 있도록 합니다. UIManagerBase에 전달한 두번째 타입 파라미터이자 UIFrame에 전달한 타입 파라미터, 위의 예제에서는 EFrame에 정의한 멤버 요소들이 표시됩니다. 위의 예제에서는 해당 Frame의 "Id"를 Frame1으로 설정하였습니다. "Show Speed Rate"의 값을 올리면 Frame이 나타나거나 사라질 때 더 빠른 속도로 전환됩니다. 이렇게 두가지 클래스를 정의하고 UI 오브젝트에 Component로 붙이게 되면 아래의 코드를 통해 다음 기능을 구현할 수 있습니다.
// Frame1이라는 Id를 가진 UIFrame을 활성화합니다.
UIManager.Instance.GetFrame(EFrame.Frame1).Show();
// Frame1이라는 Id를 가진 UIFrmae을 비활성화합니다.
UIManager.Instance.GetFrame(EFrame.Frame1).Show(false);
대회상자 UI입니다. UIFrame과 마찬가지로 UIManager를 통해 관리되며 대화상자를 열고 닫는 등의 효과를 쉽게 구현할 수 있습니다. 사용 방법은 UIFrame과 거의 동일합니다.
using Nextwin.Client.UI;
// UIManager에서 정의한 enum인 EFrame을 타입 파라미터로 전달하였습니다.
public class UIDialogExample : UIDialog<EDialog>
{
}마찬가지로 타입 파라미터로 전달된 EDialog는 반드시 UIManagerBase에 타입 파라미터로 전달한 세번째 파라미터와 같아야 합니다.
Canvas에 Dialog를 만들기 위한 Image를 추가하고 Component로 UIDialogExample을 추가합니다.
UIFrame과 사용방법이 같습니다. "Id"에는 UIManagerBase에 전달한 세번째 타입 파라미터이자 UIDialog에 전달한 타입 파라미터인 EDialog에 정의한 멤버 요소들이 표시됩니다. UIManager를 통해 UIDialog를 보이거나 사라지게 할 수 있습니다.
// Dialog1이라는 Id를 가진 UIDialog을 활성화합니다.
UIManager.Instance.GetDialog(EDialog.Dialog1).Show();
// Dialog1이라는 Id를 가진 UIFrmae을 비활성화합니다.
UIManager.Instance.GetDialog(EDialog.Dialog1).Show(false);