‹ AgeCheq Doc Home

AgeCheq 集成指南

For the Lua version of cocos2d-x v3.x - (all other versions)

集成

用如下命令来集成 SDKBOX AgeCheq 插件,请确保您可以正常执行的 SDKBOX 安装器.

sdkbox import agecheq

重点注意事项

如果您升级到了 Xcode7, 则需要以下额外步骤来确保插件工作正常:

禁用应用程序安全传输策略

添加以下项到 plist:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

添加后的文件内容看起来就像这样：

禁止 Bitcode 支持

您必须禁止 Bitcode 的支持，否则将会编译失败。

游戏全屏配置

如果您的游戏不同时支持横竖屏，则必须在 Xcode 中选中 Requires full screen，否则将不会通过 Apple 的审核。

canOpenURL 白名单

取决于您使用哪些插件。需要在 info.plist 的 LSApplicationQueriesSchemes 下添加名单。

关于 Creator 工程

Creator 导出工程会修改工程的配置, 这可能会影响 SDKBox 对工程的配置修改. 所以可以有以下做法(任选其一):

  1. 保存导出工程中的修改, 对于 SDKBox 来说可能有这些文件(mk, gradle, gradle.properties, AppDelegate.cpp, ...), 导出后再恢复对应该文件
  2. 在每一次 Creator 导出工程后, 重新 import 插件.

推荐第一种, 但是第一种的麻烦点在于, 对于第一次(或很久没接触的人)可能会有露掉某个文件 第二种, 很方便, 它的麻烦点在于, 如果你对工程有自己的修改, SDKBox 的重新 import 不能帮你恢复.

JSON 配置

SDKBOX 安装器会自动在您的工程中添加一个样例配置文件res/sdkbox_config.json.在您编译工程前,请修改里面的参数,用您自己的应用信息

下面给出一个 AgeCheq 的配置样例,您需要在AgeCheq ID注册帐号,然后用对应的信息替换 <AppID> 和 <DeveloperKey>.

"AgeCheq":{
            "AppID":"ca0e20a3-3bb8-42e1-a5ac-55af7f63dbfc",
            "DeveloperKey":"9102be76-232b-49b1-9c4f-1c6806d3a975"
}

使用

修改 Lua 代码

修改 ./frameworks/runtime-src/Classes/lua_module_register.h 包含下面这几个必要的头文件,并注册 AgeCheq 到lua中.注意他们的参数 lua_State*:

#include "PluginAgeCheqLua.hpp"
#include "PluginAgeCheqLuaHelper.h"

static int lua_module_register(lua_State* L)
{
  register_all_PluginAgeCheqLua(L);
  register_all_PluginAgeCheqLua_helper(L);
}

初始化 AgeCheq

修改您的lua代码来初始化这个插件. 这个初始化,可以在任意地方,但是必须在您调用插件的功能接口之前.

sdkbox.PluginAgeCheq:init()

使用 AgeCheq

初始化完成后,您可以在您的代码任意需要的地方调用 check 功能:

sdkbox.PluginAgeCheq:check("agecheqPin")

接收 AgeCheq 事件 (可选)

您可以接收 AgeCheq 事件,然后对不同的事件在程序中做出不同的响应.一个简单的例子可能会如下:

sdkbox.PluginAgeCheq:init()
sdkbox.PluginAgeCheq:setListener(function(data)
        if "checkResponse" == data.event then
            dump(data)
        elseif "associateDataResponse" == data.event then
            dump(data)
        end
    end)
sdkbox.PluginAgeCheq:check("agecheqPin")

API Reference

Methods

sdkbox.PluginAgeCheq:init()

initialize the plugin instance.

sdkbox.PluginAgeCheq:setListener(listener)

Set listener to listen for adcolony events

sdkbox.PluginAgeCheq:check(ACPin)

The AgeCheq check method is used to determine the status of a child’s relationship with a particular online service. It requires the developer’s unique identifier, the child’s AgeCheq PIN as set up by their parent, and the unique identifier of the game or application.

sdkbox.PluginAgeCheq:associateData(ACPin, Data)

The associateData method allows you to save a string of information linking it to a particular AgeCheqPIN for a specific game or app. You’ll want to use that data later if a parent should unauthorize your online service.

Listeners

checkResponse(rtn,
               rtnmsg,
               apiversion,
               checktype,
               appauthorized,
               appblocked,
               parentverified,
               under13,
               under18,
               underdevage,
               trials)

The delegate named checkResponse is triggered once the check command executes. It contains several status variables that you can check against.

associateDataResponse(rtn, rtnmsg)

The delegate named associateDataResponse is triggered once the associateData command executes.

手动集成

如果 SDKBOX 安装器 安装插件失败了，那么需要手动集成插件.如果安装器安装插件成功了,那么不需要，也没必要,按文档再手动集成一次.

下面列出的的步骤一般很少用到.如果你按下面的步骤完成了集成，请在完成集成后，再按步骤检查一次.

iOS 平台手动集成

拖拽下列 framework 从 AgeChecq 插件包的 plugins/ios 目录到您的 Xcode 工程中，在添加 frameworks 的时候，请勾选 Copy items if needed 。

sdkbox.framework

PluginAgeCheq.framework

把 plugin/luabindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把刚刚拷贝的文件拖动到 Xcode 中或使用 File -> Add files to... 来添加.

Android 平台手动集成

拷贝文件

从插件安装包中的 plugin/android/libs 目录拷贝下列 jar 文件到您的工程的 proj.android/libs 目录。

AgeCheqLib.jar

PluginAgeCheq.jar

sdkbox.jar

从 plugin/android/jni 目录拷贝 pluginagecheq 以及 sdkbox 目录到您的工程的 proj.android/jni 目录。如果 sdkbox 目录在工程中已经存在，请覆盖它。

编辑 AndroidManifest.xml

在标签 application tag 上添加下列权限：

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

编辑 Android.mk

编辑 proj.android/jni/Android.mk：

为 LOCAL_STATIC_LIBRARIES 添加额外的库：

LOCAL_STATIC_LIBRARIES += PluginAgeCheq
LOCAL_STATIC_LIBRARIES += sdkbox

在所有 import-module 语句之前添加一条 call 语句：

$(call import-add-path,$(LOCAL_PATH))

在最后添加额外的 import-module 语句：

$(call import-module, ./sdkbox)
$(call import-module, ./pluginagecheq)

这意味着您的语句顺序看起来像是这样：

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginagecheq)

Note: 如果您使用的是 cocos2d-x 预编译库，那么保证这些语句在已有的 $(call import-module,./prebuilt-mk) 语句之上非常重要。

编辑 Application.mk （只限 Cocos2d-x v3.0 到 v3.2 版本）

编辑 proj.android/jni/Application.mk 保证 APP_STL 的定义正确。如果 Application.mk 包含了 APP_STL := c++_static 语句，那么这条语句应该被改为：

APP_STL := gnustl_static

把 plugin/luabindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把你刚刚拷贝的 .cpp 文件添加到 Android.mk 文件的的 LOCAL_SRC_FILES 项.比如

LOCAL_SRC_FILES := hellocpp/main.cpp \
                ../../Classes/AppDelegate.cpp \
                ../../Classes/HelloWorldScene.cpp \
                                ../../Classes/NewSourceFile.cpp

修改 AppActivity.java

插件版本 >= 2.4.0.3

  1. 找到 AppActivity.java 文件
find . -name "AppActivity.java"
  1. 把 extends Cocos2dxActivity 替换为 extends com.sdkbox.plugin.SDKBoxActivity

以下是 AppActivity.java 不同版本的引擎所在的目录：

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

插件版本 < 2.4.0.3

Note: 当你使用 cocos2d-x 源代码时，不同的版本中 Cocos2dxActivity.java 文件的位置也不同。一个确定该文件位置的方法是查看 proj.android/project.properties 。比如：

android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

在这个例子中， Cocos2dxActivity.java 文件应该在如下位置：

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java

import android.content.Intent;
import com.sdkbox.plugin.SDKBox;

onLoadNativeLibraries();
SDKBox.init(this);

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }

混淆 (release, 可选)

proguard.config=proguard.cfg

# 如果您的JS工程用到了WebView,不要注释下面的代码,并输入完全合法的 JavasSript 接口类名
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
#   public *;
#}

注意: 混淆只在 Release 编译模式下有效 (i.e cocos run -m release) debug 编译下不会调用到混淆规则。