Unity SDK

Classic/VPC 환경에서 이용 가능합니다.

Unity에서 게임을 개발하기 위한 GAMEPOT Unity SDK 사용법에 대해 설명합니다.
SDK를 설치하고 환경을 구성함으로써 게임과 대시보드를 연동할 수 있습니다.

요구 사양

Unity용 GAMEPOT SDK를 사용하기 위한 요구 사양은 다음과 같습니다.

• 최소 사양: 2020.3.0 이상
• 하위 버전의 Unity 지원이 필요하면 문의채널로 문의해 주시기 바랍니다.

SDK 설치 및 환경 구성

GAMEPOT Unity SDK를 설치한 후 환경을 구성하여 GAMEPOT 대시보드와 게임을 연동하고 게임 개발에 필요한 기능을 사용할 수 있습니다.

GAMEPOT SDK에서 지원하는 언어는 아래와 같습니다.

• 한국어, 영어, 이탈리아어, 태국어, 베트남어, 일본어, 중국어(간체/번체), 인도네시아어, 독일어, 스페인어, 프랑스어

앱 실행 시 디바이스 언어에 따라 SDK 내 지원 언어로 표기되며 미지원 언어는 영어로 표기됩니다.

SDK 설치

GAMEPOT Unity SDK를 설치하고 Unity에서 프로젝트를 구성하는 방법은 다음과 같습니다.

1. 유니티 공식 배포 깃헙 에서 최신 버전을 다운로드해 주십시오.
2. Unity에서 Assets > Import Package > Custom Package... 메뉴를 차례대로 클릭한 후 nbase-unity-plugin-[version].unitypackage 파일을 불러와 주십시오.
   • 게임팟 3.0 부터는 maven 배포와 cocoapods 을 통해 배포되며 기기별로 간단한 설정으로 수십 가지의 외부 라이브러리와 통합이 가능합니다.

External Dependency Manager for Unity를 포함하여 설치되며, 편리하게 Android, iOS 패키지를 설치할 수 있습니다.

Android Gradle 설정

1. Player Settings에서 Publishing Settings에 Custom Main Gradle Template, Custom Gradle Properties Template에 체크해 주십시오.
   
2. Minimum API Level 24 으로 상향해 주십시오.
   
3. Assets > External Dependency Manager > Android Resolver > Settings 메뉴를 차례대로 클릭한 후 Enable Auto-Resolution, Explode AARs 항목에 체크를 해제해 주십시오.
   
4. 이미지와 같이 해당 파일을 에디터를 통해 열어 주십시오. 아래와 같은 파일을 확인할 수 있습니다.
   

다음은 NBase SDK 사용에 기본으로 필요한 Dependency package 를 정의해 둔 파일입니다. 추가적인 기능을 사용할 경우, 아래 파일에 추가하면 Android, iOS 에서 모듈을 사용할 수 있습니다.

Dependency modules 란?
외부 SDK를 사용하기 위한 모듈로 구글 로그인의 경우 com.google.android.gms:play-services-auth 와 같이 구글에서 제공하는 모듈을 함께 설치해야 합니다.
만약 업데이트된 경우 마이너 버전의 업데이트는 상시로 가능하지만 메이저 업데이트의 경우 문의 후에 사용해 주시기 바랍니다.

 <?xml version="1.0" encoding="UTF-8"?>
<dependencies>
	<androidPackages>
        <androidPackage spec="io.nbase:nbasesdk:3.0.84"/>
	</androidPackages>
	<iosPods>		
		<iosPod name="NBase" version="3.0.56" minTargetSdk="15.0" />
	</iosPods>
</dependencies>

• 구글 로그인과 구글 스토어 결제를 사용하는 경우

 <dependencies>
	<androidPackages>
        <androidPackage spec="io.nbase:nbasesdk:3.0.84"/>
        <androidPackage spec="io.nbase:nbase-adapter-provider-google:3.0.8"/>
        <androidPackage spec="io.nbase:nbase-adapter-billing-googleplay:3.0.5" />
	</androidPackages>
	<iosPods>
		<iosPod name="NBase" version="3.0.56" minTargetSdk="15.0" />
		<iosPod name="NBaseAdapterProviderGoogle" version="3.0.56" minTargetSdk="15.0" />
	</iosPods>
</dependencies>

이메일, 게스트 로그인의 경우 기본 모듈에 적용되어 있습니다.

Assets > External Dependency Manager > Android Resolver > Force Resolve를 클릭해 주십시오.
Dependencies.xml에 정의를 한 뒤 Force Resolve를 하면 mainTemplate.gradle 파일에 정의한 내용이 implementation 으로 자동 정의가 되며, 해당 내용이 되어야 빌드 시에 관련 라이브러리들을 가져올 수 있습니다.

iOS 설정

Settings in Tools > GamePotSDK > Edit Settings을 클릭해 주십시오.

각 소셜 로그인 방식에 따라 푸시, 인앱결제 등 빌드에 필요한 Capability 설정도 자동으로 설정됩니다.
XML 파일은 Editor 디렉토리 아래에 있어야 하며 *Dependencies.xml 형식의 이름과 일치해야 합니다. /Assets/NBaseSDK/Editor/NBaseSDKDependencies.xml 파일을 오픈합니다.

"iosPods" 와 "/iosPods" 사이에 필요한 프레임워크를 추가해 주시면 됩니다. 기본적으로 필요한 프레임워크는 추가되어 있습니다.

<?xml version="1.0" encoding="UTF-8"?>
<dependencies>
	<androidPackages>
        ...
	</androidPackages>
    <iosPods>
		<iosPod name="NBase" version="3.0.56" minTargetSdk="15.0" />
    </iosPods>
</dependencies>

만약 Firebase 와 같이 필요한 프레임워크를 설치하고자 하는 경우에도 아래와 같이 별도로 추가하시면 됩니다.

<iosPods> 
       ...
        <iosPod name="FirebaseMessaging" version="10.20.0" minTargetSdk="9.0" />
        <iosPod name="Firebase/Analytics" version="10.15.0" minTargetSdk="9.0" />
        ...
</iosPods>

Assets > External Dependency Manager > iOS Resolver > Install Cocoapods를 클릭해 주십시오.

'+' 버튼 클릭 후에 Add Package Collection ' https://github.com/apollographql/apollo-ios.git ' 추가 후 apollo-ios 선택 후 Add Package 에서 Unity-iPhone 를 선택해 주세요.

사전 준비

1. 프로젝트ID 와 프로젝트 키는 대시보드 > 프로젝트 설정에서 복사해 주십시오.
2. 로그인, 스토어, 연동에 대한 환경설정은 대시보드 > 프로젝트 설정에서 추가/수정해 주십시오.
3. 로그인별로 로그인 수단별 환경 설정을 참조하여, 콘솔에 설정하고 대시보드에 추가해 주십시오.
4. 인앱 결제 시에 스토어별 환경 설정을 참조하여, 콘솔에 설정하고 대시보드에 추가해 주십시오.
5. 인앱 결제를 위한 스토어마다 아이템을 등록해 주십시오. 대시보드 > 결제 > 인앱에서 추가해 주십시오.

초기화

초기화를 수행하려면 게임을 시작할 때 로드되는 첫 장면에 사용되는 개체에 아래 코드를 추가해 주세요.

using UnityEngine;
using NBaseSDK;

 public class GamePotExample : MonoBehaviour
 {
     void Start()
     { 
       NBaseSDK.NBase.initialize(projectId, projectKey, [storeId], [language], [region], (init, error) => {
           if (error != null)
           {
               Debug.Log(error.Message);
               return;
           }
           Debug.Log(init.ToString());
       });
     }
 }

• Parameter

• Callback

초기화 (이벤트 수신)

먼저 NBase 이벤트를 수신하는 스크립트를 만들어야 합니다.
이 스크립트를 NBaseListener라고 하고 씬의 어떤 객체에도 배치할 수 있으며, 이 객체가 영구적으로 존재하도록 하기 위해 DontDestroyOnLoad 메소드를 호출하는 것이 좋습니다.

using UnityEngine;
using NBaseSDK;
public class NBaseListener: MonoBehaviour, NBaseEventListener
{
	void Start()
	{
        DontDestroyOnLoad(this.gameObject);
        NBaseSDK.NBase.SetEventListener(this);
    }	
}

로그인

개발사에서 구현한 로그인 UI에 따라 로그인 버튼을 클릭했을 때 동작하는 SDK 로그인 기능을 사용하려면 아래 코드를 사용해 주십시오. 그 이전에 로그인에 필요한 콘솔 및 대시보드 설정을 모두 완료해야만 정상적으로 작동됩니다.

NBaseSDK.NBase.signIn(Provider.google.ToString(), (user, error) => {
    if (error != null)
    {
        if (error.Code == NBaseSDK.NBase.ErrorCode.MEMBER_WITHDRAW) // 탈퇴 상태
        {
            // 탈퇴
            Debug.Log(error.Message.ToString());    // 탈퇴 메시지
        }
        else if (error.Code == NBaseSDK.NBase.ErrorCode.UPDATE_REQUIRED) // 강제 업데이트
        {
            // 강제 업데이트
            Debug.Log(error.Message.ToString());    // 업데이트 안내 메시지
        }
        else if (error.Code == NBaseSDK.NBase.ErrorCode.MEMBER_BANNED) // 접속 차단
        {
            // 접속 차단
            Debug.Log(error.Message.ToString());    // 차단 메시지
        }
        else
        {
            Debug.Log(error.Message.ToString());
        }
    }
    else
    {
        // 로그인 성공
        Debug.Log(user.ToString());
    }
    return;
});

• Parameter

• Callback

자동 로그인 (옵션)

초기화한 후에 마지막으로 로그인한 인증 수단으로 자동 로그인을 시도합니다.

NBaseSDK.NBase.signInLastLoggedIn((user, error) => {
    if (error != null)
    {
        if (error.Code == NBaseSDK.NBase.ErrorCode.MEMBER_WITHDRAW) // 탈퇴 상태
        {
            // 탈퇴
            Debug.Log(error.Message.ToString());    // 탈퇴 메시지
        }
        else if (error.Code == NBaseSDK.NBase.ErrorCode.UPDATE_REQUIRED) // 강제 업데이트
        {
            // 강제 업데이트
            Debug.Log(error.Message.ToString());    // 업데이트 안내 메시지
        }
        else if (error.Code == NBaseSDK.NBase.ErrorCode.MEMBER_BANNED) // 접속 차단
        {
            // 접속 차단
            Debug.Log(error.Message.ToString());    // 차단 메시지
        }
        else
        {
            Debug.Log(error.Message.ToString());
        }
    }
    else
    {
        // 로그인 성공
        Debug.Log(user.ToString());
    }
});

자체 아이디 비밀번호 인증하기 (옵션)

사용자가 이메일 주소와 비밀번호를 사용하여 로그인할 수 있게 하는 인증 메서드입니다.
사용자의 이메일 주소와 비밀번호를 기반으로 사용자 인증을 수행하며, 이 기능은 전통적인 이메일/비밀번호 기반의 인증 시스템에서 중요한 역할을 합니다.

NBaseSDK.NBase.signInWithPassword(username, password, (user, error) => {
    if (error != null)
    {
        Debug.Log(error.Message.ToString());
        return;
    }
});

자격 증명으로 로그인하기 (옵션)

다양한 인증 방법(이메일 및 비밀번호, 소셜 미디어 계정, 전화번호 등)을 통해 얻은 인증 자격 증명(credentials)으로 사용자 로그인을 처리하는 데 사용됩니다.
다양한 인증 방식을 쉽게 구현할 수 있도록 도와주며 게임팟에 로그인할 수 있도록 합니다.

NBaseSDK.NBase.signInWithCredential(Provider.gamepot.ToString(), providerToken, (user, error) => {
    if (error != null)
    {
        Debug.Log(error.Message.ToString());
        return;
    }
});

결제

결제 전에 스토어별 환경 설정 에 해당 스토어에 맞도록 설정하셔야 합니다.
또한, 대시보드 > 결제 > 인앱에 아이템이 추가되어 있지 않을 경우 'ProductID not found' 라는 오류가 발생됩니다.

iOS StoreKit 설정

Xcode 에서 StoreKit 를 New File 로 생성해 주셔야 합니다.

Synced Today 앞 새로고침 버튼을 클릭하시면 그림과 같이 Apple 에 등록된 인앱 정보가 표시되어야 합니다.

인앱 정보 가져오기

결제하실 때에 화면에 결제 정보와 현지 통화 정보를 표시해야 합니다.
아래 함수를 통해서 현재 결제 통화나 이름 등을 가져올 수 있습니다. 만일 정상적으로 가져오지 못하는 경우 콘솔 세팅을 확인해 주시기 바랍니다.

NBaseSDK.NBase.getProductItems(Store.google.ToString(), (products, error) => 
{
    if (products != null && products.Count > 0)
    {
        // 제품 목록을 순회합니다.
        foreach (var product in products)
        {
            // 각 제품의 정보를 토스트 메시지로 보여줍니다.
            // 예시에서는 product.ToString()을 호출하고 있지만,
            // 실제로는 product의 구체적인 속성(예: 이름, 가격 등)을 표시할 수 있습니다.
            NBaseSDK.NBase.showToast(product.ToString());
        }
    }
    else
    {
        // 제품 목록이 비어있는 경우, 사용자에게 알립니다.
        NBaseSDK.NBase.showToast("제품 목록이 비어있습니다.");
    }
});

• Callback

결제 요청

가져온 인앱 정보에 productId 로 결제를 요청할 수 있습니다.

NBaseSDK.NBase.purchase(Store.google.ToString(), [productId], [metadata], [options], (purchase, error) => 
{
    if (error != null)
    {
        Debug.Log(error.Message.ToString());
        return;
    }
    // 결제 성공
});

• Parameter

• Callback

Unity Standalone 안내

Standalone 은 Mac, Windows 및 Linux용 빌드를 나타냅니다.
게임팟 SDK 는 크로스 플랫폼을 지원하지만 모바일과 Standalone 에서 지원되는 기능이 다르기 때문에 아래 표를 참고하시어 개발 계획을 하시기 바랍니다.

Newtonsoft.Json 충돌

NBase Unity SDK는 API 요청 파싱을 위해 Unity의 Newtonsoft Json 패키지를 사용합니다. Json은 가장 일반적으로 사용되는 라이브러리 중 하나이므로 프로젝트에 이미 Json이 있고 다음과 같은 라이브러리 중복 오류가 발생할 가능성이 있습니다.

이 경우 Plugins/Standalone 경로에 있는 Newtonsoft.Json 파일을 삭제하거나 프로젝트에 이미 있는 Json 라이브러리를 삭제하고 Unity의 Json을 사용하면 됩니다. Unity의 Json 패키지는 Unity 엔진과 함께 작동하도록 수정되었으며, IL2CPP를 완벽하게 지원하는 버전입니다.

문제 해결

Q. UnityPlayerActivity.java uses or overrides a deprecated API.
A. Edit > Project Settings > Player > Publishing settings > Custom Properties Gradle Template 에 체크해 주십시오.

Q. error:1E08010C:DECODER routines::unsupported
A. 구글 Authentication Key 키 값이 일치하지 않을 경우 생기는 현상으로 구글 플레이 스토어 가이드를 참고하여 키를 정확하게 입력해 주세요.

Q. 원스토어나 게임팟 베타와 같은 공식 maven 주소이외에 maven, jitpack.io 에 다운로드가 되지 않습니다.
유니티에서 아래와 같은 오류가 발생됩니다.

Could not determine the dependencies of task ':unityLibrary:compileReleaseAidl'.
> Could not resolve all task dependencies for configuration ':unityLibrary:releaseCompileClasspath'.
   > Could not find io.nbase:nbasesdk:0.0.71-beta.
     Required by:
         project :unityLibrary

public maven 을 사용하지 않는 모듈의 경우 아래와 같이 maven 주소를 입력해야 합니다. NBaseSDKDependencies 파일 구성시에 maven 주소를 입력해 주십시오.

<!-- # 원스토어 -->
<androidPackage spec="com.onestorecorp.sdk:sdk-iap:21.01.00"/>
    <repositories>
        <repository>https://repo.onestore.co.kr/repository/onestore-sdk-public</repository>
    </repositories>
</androidPackage>

<!-- # NBase Beta maven 리포지토리 -->
<androidPackage spec="io.nbase:nbasesdk:3.0.82"/>
    <repositories>
        <repository>https://repo.nbase.io/repository/nbase-releases/</repository>
    </repositories>
</androidPackage>

jitpack.io 도 주소를 추가해 주시면 됩니다.

Q. minimum API Level 상향 안내
A. 기본 API Level 22 에서 24 로 샹향해 주십시오.

Q. Authorization failed: Error Domain=AKAuthenticationError Code=-7026
A. TARGETS > +Capability 를 클릭하여 Sign in with Apple 을 추가해 주십시오.

Q. Couldn't get credential from result.10: Developer console is not set up correctly
A. 이 오류는 Google Cloud Console > 사용자 인증 정보 > OAuth 2.0 클라이언트 ID에서 웹 애플리케이션 유형의 클라이언트 ID가 설정되어 있지 않아 발생할 수 있습니다.

Q. 16: Cannot find a matching credential.
A. 이 경우는 Google Cloud Console > 사용자 인증 정보 > OAuth 2.0 클라이언트 ID가 등록 되지 않은 경우에 발생할 수 있는 오류입니다.

Q. java.lang.NoClassDefFoundError: Failed resolution of: Lcom/android/billingclient/api/BillingClient;
A. 아래 코드를 추가해 주십시오.

<androidPackage spec="com.android.billingclient:billing:6.1.0" /> 

Q. (iOS) 앱 실행 시 크래시가 발생되며 "/AdapterProviderFacebook' (no such file)" 에러가 확인됨
A. Xcode TARGETS → General → Frameworks, Libraries, and Embedded Content → AdapterProviderFacebook.xcframework 추가해 주십시오.

Q. (iOS) 실행 후 "'/usr/lib/swift/NBase.framework/NBase' (no such file, not in dyld cache)" 에러 발생
A. 아래와 같이 NBase.xcframework 를 추가해 주십시오.

Q. (iOS) iOS 18 환경에서 "NSBundle file:///System/Library/Frameworks/Metal.framework/ principal class is nil because all fallbacks have failed" 에러 발생

A. Edit Scheme 윈도우를 열어 (단축키: CMD + SHIFT + , ) 아래와 같이 Metal 항목의 API Validation을 체크 해제해 주십시오.