Cocos2d-x

Quick Start

下载最新版本

Release 1.3.7 · naver/navergame-sdk-cocos2dxGitHub

在原项目应用Navergame SDK

本指南以Cocos2d-x 3.17.2版本为标准编写而成。

1. 插件构成

• 示例项目内的Plugins文件夹含有SDK所需文件。

1. android：含有android build所需文件。

2. ios：含有ios build所需文件。

3. navergamesdk：含有cocos2d-x项目和android、ios等连接各平台所需文件。

2. 安装插件

• 为了关联贵公司的Cocos2d-x项目和SDK，需要按如下方法将Plugins内的navergamesdk文件夹复制到贵公司项目内的Classes文件夹内。

• 如果贵公司项目只计划推出Android或iOS其中一个平台，那么只需保留platform下方的Android或iOS文件夹中相关文件夹，删除其他文件夹即可。

2-1. NaverGameSDK.h

• 相应文件内编写有连接SDK所需代码。

3. 应用插件

在贵公司的项目内要使用SDK的位置include头文件。（在示例项目应用于HelloWorldScene.h）

#include "NaverGameSDK.h"

• 如果未找到NaverGameSDK.h，应如下图所示在rootProject/CmakeLists.txt添加头文件。

登记头文件和cpp文件。

登记navergamesdk文件夹。

3-1. SDK初始化

对SDK进行初始化时，如下所示设置初始化选项，调用init() method：

• ClientId:在NAVER账号登录开发者中心登记、获取应用程序的客户账号

• ClientSecret:在NAVER账号登录开发者中心登记、获取应用程序的客户密钥

• LoungeId:申请、获取官方大厅的LoungeId

nng::NaverGameSDK::init("UKvNABLDsyEJusJGsXL2", "rK4suc_Qd0", "naver_game_4developer");

3-2. SDK事件监听器登记

登记监听器后方可接收SDK发送的各种事件。

//리스너는 NaverGameSDK.h 에 선언되어있습니다.
nng::NaverGameSDK::setSdkListener(this);

3-3. 查看SDK支持的Funtion

1. 导入主页横幅

   nng::NaverGameSDK::startHomeBanner();

2. 导入维护横幅

   nng::NaverGameSDK::startSorryBanner();

3. 导入特定公告栏

   nng::NaverGameSDK::startBoard(boardId);

4. 导入特定留言

   通过登记留言的编号直接运行的方法。如果是通过预约显示登记的预约留言，应在FeedId输入预留言的编号，并将IsTempFeedId输入为True。

   nng::NaverGameSDK::startFeed(feedId, isTempFeedId);

5. 终止SDK

   nng::NaverGameSDK::stopSdk

6. 导入国家代码

   获取移动设备的countryCode。应在调用init() method后调用，方可获取正常值。

   nng::NaverGameSDK::getCountryCode();

   countryCode是由2个字母构成的国家代码（ISO 3166-1 alpha-2）。利用这一代码可在代码内按国家进行分支处理。主要国家代码如下所示，其他国家代码请参考链接。

   国家代码	国家
   CN	中国
   JP	日本
   KR	韩国
   TH	泰国
   US	美国

安卓项目应用Navergame SDK

下面是示例项目的安卓创建环境，敬请参考。

• Cocos2d-x 3.17.2

• Android Studio 4.2

• Gradle 4.9 (proj.android/gradle/wrapper/gradle-wrapper.properties)

• Ndk 16.1.4479499

• Cmake 3.10.2.4988404 (with Ninja 1.10.2)

1. 添加关联Cocos2d-x和Android的桥接文件（代码）

示例项目内的Plugins文件夹。

Plugins文件夹内的Android文件夹内容。

1. com...文件夹内最后含有在Android发挥桥接cocos项目作用的NNGSdk.java文件。

2. navergame-sdk-gradle-x.x.x.aar是Navergame sdk库。

示例项目目录结构。

1-1. navergame-sdk-gradle-x.x.x.aar

Naver游戏SDK库。

• 粘贴至rootProject/proj.android/app/libs文件夹。如果没有libs文件夹，请创建。

1-2. NNGSdk.java

在Android编写连接Cocos2d-x项目和SDK的桥接代码的文件。

• 粘贴至rootProject/proj.android/app/src文件夹。请粘贴以com..开始的所有文件夹。

1-3. NaverGameSDK.cpp

编写在Cocos2d-x连接Android项目的桥接代码的文件夹。

• 确认是否有rootProject/Classes/navergamesdk/platform/android/NaverGameSDK.cpp文件，如果没有，请在Plugins文件夹内找到后粘贴。

• cocos2d-x版本不同，JniHelper的名称可能有所不同，请根据版本进行确认。

#include "NaverGameSDK.h"
#include "platform/android/jni/JniHelper.h"

using namespace cocos2d;

namespace nng {
    static bool getStaticMethod(JniMethodInfo &methodinfo, const char *methodName, const char *paramCode) {
        static const char* kCafeSdkClass = "com/navercorp/nng/cocos2dx/sample/NNGSdk";
        return JniHelper::getStaticMethodInfo(methodinfo, kCafeSdkClass, methodName, paramCode);
    }

    static NaverGameSDKListener* sdkListener = nullptr;

    void NaverGameSDK::setSdkListener(NaverGameSDKListener* listener) {
        sdkListener = listener;
    }

    void NaverGameSDK::init(std::string clientId, std::string clientSecret, std::string loungeId) {
        JniMethodInfo t;
        if (getStaticMethod(t, "init","(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V")) {
            jstring _clientId = t.env->NewStringUTF(clientId.c_str());
            jstring _clientSecret = t.env->NewStringUTF(clientSecret.c_str());
            jstring _loungeId = t.env->NewStringUTF(loungeId.c_str());

            t.env->CallStaticVoidMethod(t.classID, t.methodID, _clientId, _clientSecret, _loungeId);

            t.env->DeleteLocalRef(_clientId);
            t.env->DeleteLocalRef(_clientSecret);
            t.env->DeleteLocalRef(_loungeId);
            t.env->DeleteLocalRef(t.classID);
        }
    }

    .
    .
    .

    extern "C" {
        JNIEXPORT void JNICALL
        Java_com_navercorp_nng_cocos2dx_sample_NNGSdk_onSdkStarted(JNIEnv* env, jclass thiz) {
            if (sdkListener == nullptr) return;
            sdkListener->onSdkStarted();
        }

        .
        .
        .
    }
}   /* namespace nng */

• kCafeSdkClass = "com/navercorp/nng/cocos2dx/sample/NNGSdk";

  • NNGSdk.java文件的位置路径。如果更改NNGSdk.java的位置路径，请根据相应位置进行修改。

• Java_com_navercorp_nng_cocos2dx_sample_NNGSdk_Funtion네임

  • NNGSDK.java文件的位置路径。如果更改NNGSdk.java的位置路径，请根据相应位置进行修改。

2. 旨在用安卓创建的设置

1-1. AndroidManifest.xml

• 在rootProject/proj.android/app/AndroidManifest.xml文件内添加SDK所需权限。

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

1-2. build.gradle

• 在rootProject/proj.android/app/build.gradle文件内添加SDK和SDK所需库。

dependencies {
    implementation project(':libcocos2dx')
    /**
     * Navergame sdk와 필요한 libraries
     */
    implementation files('libs/navergame-sdk-gradle-1.1.0.aar')
    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.3.72"            // Kotlin
    implementation "androidx.viewpager2:viewpager2:1.0.0"
    implementation "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0"
    implementation "com.github.bumptech.glide:glide:3.7.0"                // Glide
    implementation "com.squareup.retrofit2:retrofit:2.6.4"                // Retrofit, Gson
    implementation "com.squareup.retrofit2:converter-gson:2.6.4"          // Retrofit, Gson
}

1-3. ndk及cmake设置

• Android Studio使用方法

  • 在Android Studio -> Preferences -> 搜索进行sdk搜索后，在sdk tools标签下载ndk和cmake。（请检查Show Package Details。）

以cocos-3.17.2版本为准，使用ndk-16.1.4479499、cmake-3.10.2.4988404版本。

1-4. 应用ndk、cmake

• 对rootProject/proj.android/local.properties文件输入ndk、cmake安装文件路径。

3. 用安卓创建

Cocos2d-x项目安卓创建方法共2种。

• cmake

• ndk

正确的命名根据cocos2d-x版本可能有所不同，请确认。以3.17.2版本为准，可在build.gradle文件内确认。

以3.17.2版本为准，是“ndk-build”和“cmake”。

3-0. 创建类型应用方法

可在rootProject/proj.android/gradle.properties文件内的PROP_BUILD_TYPEproperty确定。

• 如果要用cmake进行创建，可设置PROP_BUILD_TYPE=cmake。

3-1. 用CMAKE创建

• 在rootProject/proj.android/gradle.properties内确认PROP_BUILD_TYPE=cmake。

• 在rootProject/CmakeList.txt确认是否添加有SDK所需文件及文件夹路径。

• 确认在rootProject/proj.andorid/local.properties是否输入有cmake及ndk安装校验编号。

• 创建cmake需要Ninja。确认安装ninja。

• 点击创建按钮！

3-2. 用NDK创建

• 在rootProject/proj.android/gradle.properties内确认PROP_BUILD_TYPE=ndk-build。

• 在rootProject/proj.android/app/jni/Android.mk添加SDK所需文件及文件夹路径。

• 确认在rootProject/proj.andorid/local.properties是否输入有ndk安装校验编号。

• 点击创建按钮！

在iOS项目应用Navergame SDK

Naver游戏iOS SDK支持iOS 12.0及以上版本。

要使用Naver游戏SDK，可如下所示，在XCode设置开发环境。

• 选择TARGETS项目中要运行的应用程序。

• 选择Build Setting标签，在Linking项目找到Other Linker Flags。

  • Basic或Customized模式下可能不显示Other Linker Flag。这种情况请选择All模式。

  • 在位于右上方的搜索栏输入Other Linker Flag，可轻松找到。

• 在Other Linker Flags添加-ObjC选项和-lc++选项。

• 在Info.plist添加如下取得用户权限选项。

  • Privacy - Camera Usage Description

  • Privacy - Photo Library Usage Description

• 选择TARGETS项目中要运行的应用程序，在Info标签的URL Types项目输入Identifier值和URL Schemes值。

• Identifier值可在相应TARGET的General标签确认。

• 对于URL Schemes值，只需输入在NAVER账号登录开发者中心登记应用程序时输入的URL Scheme即可。