GS2 이용 시작

Game Server Services의 이용을 시작하는 방법에 대해

모험 게임 만들기

모험 게임을 만들며 배우는 GS2에서 Studio 또는 Unity SDK로 로그인, 보상, 스태미나, 상점을 순서대로 만들어 봅니다.

SDK

Game Engine

Game Server Services는 주요 게임 엔진에서 이용할 수 있는 SDK를 제공합니다.
게임 엔진용 SDK는 게임 내에서 이용하는 것에 초점을 맞춰, 일반 SDK보다 고수준의 API 형태로 제공됩니다.

GS2 SDK for Unity

본 SDK는 Apache License 2.0으로 제공됩니다.
프로그램 어딘가에 Apache License 2.0으로 제공되는 라이브러리를 사용하고 있음을 명시해야 합니다.

본 SDK에는 퍼블릭 도메인인 LitJson(Gs2/Plugin/LitJSON.dll)이 포함되어 있습니다.
이 dll은 GS2 SDK 동작의 근간에 관여하는 기능에 사용되고 있어 삭제할 수 없습니다.

본 SDK에는 MIT License인 websocket-sharp(Gs2/Plugin/websocket-sharp.dll)가 포함되어 있습니다.
표시·표기가 필요한 라이선스 조문은 다음과 같습니다.
https://raw.githubusercontent.com/sta/websocket-sharp/master/LICENSE.txt
이 dll은 GS2 SDK 동작의 근간에 관여하는 기능에 사용되고 있어 삭제할 수 없습니다.

본 SDK에는 BSD License인 protobuf(Gs2/Plugin/Google.Protobuf.dll)가 포함되어 있습니다.
표시·표기가 필요한 라이선스 조문은 다음과 같습니다.
https://github.com/protocolbuffers/protobuf/blob/master/LICENSE
이 dll은 GS2-Realtime을 사용하지 않는다면 삭제할 수 있습니다.

GS2 SDK for Unity 도입 절차

GS2 SDK for Unity Installer Version 2024.4.1

위 링크에서 UnityPackage 형식의 인스톨러를 다운로드합니다.

Unity Editor를 실행하고, 메뉴의 Import Package에서 gs2-unity-installer_2024.4.1.unitypackage 파일을 임포트합니다.

그 후 Unity Editor 메뉴에서 『Window > Game Server Services > SDK Installer』를 선택하고, 마법사의 안내에 따라 진행하세요.

설치 완료 후 정상적으로 동작하지 않는 경우, Unity Editor를 한번 재시작해 보세요.

SDK 설정 절차 상세

GS2 UIKit for Unity

GS2 UIKit for Unity는 코드 작성 없이 Unity Editor의 UI를 사용하여 GS2 기능을 구현할 수 있도록 하는 것을 목적으로 합니다.

SDK 인스톨러를 도입한 후, Unity Editor 메뉴에서 『Window > Game Server Services > UIKit for Unity Installer』를 선택하고, 마법사의 안내에 따라 진행하세요.
설치 완료 후 정상적으로 동작하지 않는 경우, Unity Editor를 한번 재시작해 보세요.

UIKit 튜토리얼은 여기를 확인해 주세요.

SDK 설정 절차 상세

GS2 SDK for Unreal Engine 5

본 SDK는 Apache License 2.0으로 제공됩니다.
프로그램 어딘가에 Apache License 2.0으로 제공되는 라이브러리를 사용하고 있음을 명시해야 합니다.

GS2 SDK for Unreal Engine 5 도입 절차

최신 SDK는 GitHub에서 받으실 수 있습니다.

https://github.com/gs2io/gs2-sdk-for-ue5/

프로젝트 플러그인으로 설치

GitHub에서 소스 코드를 다운로드하여 Unreal Engine 프로젝트 내의 다음 폴더에 배치해 주세요.

(Unreal Engine 프로젝트)/Plugins/Gs2Plugin

Plugins 폴더가 존재하지 않는 경우 새로 만들어 주세요.

UnrealEditor에서 uproject를 실행하고 GS2 플러그인을 활성화한 후, UnrealEditor를 재시작해 주세요.

SDK 설정 절차 상세

엔진 플러그인으로 설치

Unreal Engine 소스 코드를 GitHub 또는 Perforce에서 받아 Engine을 빌드하고 있는 환경에 엔진 플러그인으로 설치할 수 있습니다.

다운로드한 GS2 플러그인 소스 코드 일체를 Unreal Engine 소스 코드 내의 다음 폴더에 배치해 주세요.

(Unreal Engine 소스 코드)/Engine/Plugins/Gs2Plugin

UnrealEditor에서 uproject를 실행하고 GS2 플러그인을 활성화한 후, UnrealEditor를 재시작해 주세요.

SDK 설정 절차 상세

GS2 SDK for Godot

본 SDK는 Godot 4(GDScript)를 위해 제공되며, Apache License 2.0으로 공개되어 있습니다.
프로그램 어딘가에 Apache License 2.0으로 제공되는 라이브러리를 사용하고 있음을 명시해야 합니다.

GS2 SDK for Godot 도입 절차

최신 SDK는 GitHub의 릴리스에서 ZIP 형식으로 받으실 수 있습니다.

https://github.com/gs2io/gs2-sdk-for-godot/releases/latest

릴리스의 Assets에 있는 “Source code (zip)“을 다운로드해 압축을 풀고, 포함되어 있는 addons/gs2 폴더를 Godot 프로젝트의 addons 폴더에 복사해 주세요.

배치 후 경로가 res://addons/gs2/가 되면 도입이 완료된 것입니다.

SDK 설정 절차 상세

각종 프로그래밍 언어

Go, PHP, Java, C#, TypeScript, Python용 SDK를 사용하면 애플리케이션이나 자체 백엔드에서 GS2 API를 호출할 수 있습니다. Unity, Unreal Engine 5, Godot으로 게임을 개발하는 경우 위의 “Game Engine”에서 해당 엔진용 SDK를 설치해 주세요.

사용할 언어의 탭을 선택하고 프로젝트 폴더에서 설치 명령을 실행합니다.

Go Modules로 추가하기

Go를 설치하고 go.mod가 있는 폴더에서 실행합니다. 새 프로젝트라면 먼저 go mod init example.com/gs2-sample로 모듈을 생성해 주세요.

go get github.com/gs2io/gs2-golang-sdk@latest

SDK는 애플리케이션에서 사용하는 라이브러리이므로 go get으로 의존성에 추가합니다.

설치 확인: 다음 명령으로 모듈 이름과 버전이 표시되면 추가가 완료된 것입니다.

go list -m github.com/gs2io/gs2-golang-sdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (pkg.go.dev)

Composer로 추가하기

PHP와 Composer를 설치하고 프로젝트 폴더에서 실행합니다.

composer require gs2/gs2-php-sdk

PHP 코드에서는 Composer가 생성한 오토로더를 불러온 후 SDK를 사용합니다. 프로젝트 루트의 PHP 파일에는 다음과 같이 작성합니다.

require __DIR__ . '/vendor/autoload.php';

설치 확인: 다음 명령으로 패키지 정보와 버전이 표시되면 추가가 완료된 것입니다.

composer show gs2/gs2-php-sdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (Packagist)

Maven으로 추가하기

JDK와 Maven을 설치하고 프로젝트의 pom.xml에서 <dependencies> 안에 다음 의존성을 추가합니다. YOUR_SDK_VERSION을 Maven Central의 Versions에서 선택한 버전 번호로 바꿔 주세요.

<dependency>
    <groupId>io.gs2</groupId>
    <artifactId>gs2-java-sdk</artifactId>
    <version>YOUR_SDK_VERSION</version>
</dependency>

설치 확인: pom.xml이 있는 폴더에서 다음 명령을 실행하고 io.gs2:gs2-java-sdk와 지정한 버전이 표시되는지 확인합니다. IDE를 사용한다면 Maven 프로젝트를 새로고침해 주세요.

mvn dependency:tree -Dincludes=io.gs2:gs2-java-sdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (Maven Central)

NuGet으로 추가하기

.NET SDK를 설치하고 .csproj가 있는 폴더에서 실행합니다.

dotnet add package GS2.CSharp.Sdk

Visual Studio에서는 프로젝트의 “NuGet 패키지 관리”에서 GS2.CSharp.Sdk를 검색하여 설치할 수도 있습니다.

설치 확인: 다음 명령으로 GS2.CSharp.Sdk와 버전이 표시되면 추가가 완료된 것입니다.

dotnet list package

Unity용 설치 방법은 SDK 설치 레퍼런스를 참조해 주세요.

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (NuGet)

npm으로 추가하기

Node.js와 npm을 설치하고 package.json이 있는 폴더에서 실행합니다. 새 프로젝트라면 먼저 npm init -y로 package.json을 생성해 주세요.

npm install gs2

설치 확인: 다음 명령으로 gs2와 버전이 표시되면 추가가 완료된 것입니다.

npm list gs2

소스 코드 (GitHub) · 패키지 정보 및 실행 환경 (npm)

pip로 추가하기

Python을 설치하고 프로젝트에서 사용하는 Python 환경에서 실행합니다. 가상 환경을 사용한다면 먼저 해당 환경을 활성화해 주세요.

python -m pip install gs2

python -m pip를 사용하면 실행하는 Python과 같은 환경에 SDK를 설치할 수 있습니다. Python 실행 명령이 python3인 환경에서는 이 명령들의 python을 python3로 바꿔 주세요.

설치 확인: 다음 명령으로 패키지 정보와 버전이 표시되면 추가가 완료된 것입니다.

python -m pip show gs2

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (PyPI)

CDK

CDK란 Cloud Development Kit의 약자로, GS2의 오케스트레이션을 코드로 수행할 수 있게 해주는 개발 키트입니다.

좀 더 구체적으로 기능을 설명하면, CDK로 GS2 리소스에 해당하는 객체를 인스턴스화하는 코드를 작성하고 덤프 API를 호출함으로써 GS2-Deploy의 템플릿을 생성할 수 있습니다. GS2-Deploy의 템플릿은 YAML 형식으로 작성할 수 있지만, YAML 파일은 프로그램 코드가 아니기 때문에 외부 파일을 가져오거나 반복문을 실행할 수 없어, 워크플로우를 최적화하려면 템플릿을 생성하는 코드를 작성해야 했습니다. CDK는 이러한 워크플로우를 최적화하기 위한 솔루션으로, CDK를 사용한 도구 내에서 마스터 데이터의 엑셀 파일을 파싱하거나 이벤트 기간을 반복문으로 정의하면서 GS2-Deploy 템플릿을 생성할 수 있습니다.

사용할 언어의 탭을 선택하고 프로젝트 폴더에서 설치 명령을 실행합니다.

Go Modules로 추가하기

Go를 설치하고 go.mod가 있는 폴더에서 실행합니다. 새 프로젝트라면 먼저 go mod init example.com/gs2-cdk-sample로 모듈을 생성해 주세요.

go get github.com/gs2io/gs2-golang-cdk@latest

CDK는 애플리케이션에서 사용하는 라이브러리이므로 go get으로 의존성에 추가합니다.

설치 확인: 다음 명령으로 모듈 이름과 버전이 표시되면 추가가 완료된 것입니다.

go list -m github.com/gs2io/gs2-golang-cdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (pkg.go.dev)

Composer로 추가하기

PHP와 Composer를 설치하고 프로젝트 폴더에서 실행합니다.

composer require gs2/gs2-php-cdk

PHP 코드에서는 Composer가 생성한 오토로더를 불러온 후 CDK를 사용합니다. 프로젝트 루트의 PHP 파일에는 다음과 같이 작성합니다.

require __DIR__ . '/vendor/autoload.php';

설치 확인: 다음 명령으로 패키지 정보와 버전이 표시되면 추가가 완료된 것입니다.

composer show gs2/gs2-php-cdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (Packagist)

Maven으로 추가하기

JDK와 Maven을 설치하고 프로젝트의 pom.xml에서 <dependencies> 안에 다음 의존성을 추가합니다. YOUR_CDK_VERSION을 Maven Central의 Versions에서 선택한 버전 번호로 바꿔 주세요.

<dependency>
    <groupId>io.gs2</groupId>
    <artifactId>gs2-java-cdk</artifactId>
    <version>YOUR_CDK_VERSION</version>
</dependency>

설치 확인: pom.xml이 있는 폴더에서 다음 명령을 실행하고 io.gs2:gs2-java-cdk와 지정한 버전이 표시되는지 확인합니다. IDE를 사용한다면 Maven 프로젝트를 새로고침해 주세요.

mvn dependency:tree -Dincludes=io.gs2:gs2-java-cdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (Maven Central)

NuGet으로 추가하기

.NET SDK를 설치하고 .csproj가 있는 폴더에서 실행합니다.

dotnet add package GS2.CSharp.Cdk

Visual Studio에서는 프로젝트의 “NuGet 패키지 관리”에서 GS2.CSharp.Cdk를 검색하여 설치할 수도 있습니다.

설치 확인: 다음 명령으로 GS2.CSharp.Cdk와 버전이 표시되면 추가가 완료된 것입니다.

dotnet list package

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (NuGet)

npm으로 추가하기

Node.js와 npm을 설치하고 package.json이 있는 폴더에서 실행합니다. 새 프로젝트라면 먼저 npm init -y로 package.json을 생성해 주세요.

npm install gs2-cdk

설치 확인: 다음 명령으로 gs2-cdk와 버전이 표시되면 추가가 완료된 것입니다.

npm list gs2-cdk

소스 코드 (GitHub) · 패키지 정보 및 실행 환경 (npm)

pip로 추가하기

Python을 설치하고 프로젝트에서 사용하는 Python 환경에서 실행합니다. 가상 환경을 사용한다면 먼저 해당 환경을 활성화해 주세요.

python -m pip install gs2-cdk

python -m pip를 사용하면 실행하는 Python과 같은 환경에 CDK를 설치할 수 있습니다. Python 실행 명령이 python3인 환경에서는 이 명령들의 python을 python3로 바꿔 주세요.

설치 확인: 다음 명령으로 패키지 정보와 버전이 표시되면 추가가 완료된 것입니다.

python -m pip show gs2-cdk

소스 코드 및 실행 환경 (GitHub) · 패키지 정보 (PyPI)

SDK 설치는 끝나셨나요?

다음은 GS2를 실제로 이용해 보는 튜토리얼에 도전해 봅시다.


GS2 UIKit for Unity 튜토리얼

GS2 UIKit for Unity 사용 방법에 대하여

GS2-SDK for UE5 Blueprint 튜토리얼

GS2-SDK for UE5 Blueprint 로 계정을 생성하고 로그인하기까지를 구현해 봅시다

SDK 설치 참고 자료

Unity, Unreal Engine, Godot에 GS2 SDK 설치하기

모험 게임을 만들며 배우는 GS2

로그인부터 보상과 상점까지, 작은 모험 게임을 차근차근 만들어 봅니다.