Cocos2d-X LUA 配置

下载SDK

iOS 平台配置

一、添加文件

在下载的SDK中的iOS目录下，找到XinstallCocos2dx_Lua文件夹拷贝到项目的 proj.ios 真实文件目录下，然后在Xcode工程左侧目录里找到 proj.ios目录，右键 Add File to xxx 添加 XinstallCocos2dx_Lua 文件夹，add的时候注意勾选 Copy items if needed 和Create folder reference的选择。

【注】如果我们显示Library not found for -|XinstallSDK 可以在咱们Targets->Build Settings->Library Search Paths 加入我们Xinstall的.a 文件的地址

二、相关配置

1. 初始化配置

在Xinstall官网注册好账号后，创建好App后，在项目中的Info.plist文件配置appKey键值对，具体如下

<key>com.xinstall.APP_KEY</key>
<string>Xinstall创建的项目的AppKey,由Xinstall官网你的控制后台获得</string>

2. 接入SDK

在项目的 AppController.mm 文件夹中加入头文件
```
#import "XinstallLuaSDK.h"
```

在方法 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 中加入方法

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // cocos2dx 的方法-----
    .....
    // Xinstall Lua SDK 接入
    [XinstallLuaSDK init];
    return YES;
}

Universal Links 配置

首先，我们需要到苹果开发者网站，为当前的App ID开启关联域名(Associated Domains)服务：

为刚才开发关联域名功能的AppID创建新的（或更新现有的）描述文件，下载并导入到XCode中(通过xcode自动生成的描述文件，可跳过这一步)：

在XCode中配置Xinstall为当前应用生成的关联域名(Associated Domains)---具体可以在Xinstall的控制台中找到，类似applinks:xxxxxxx.xinstall.top

而后我们在AppDelegate中添加Univeral Link 调起App的回调方法
```
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler{
  //判断是否通过Xinstall Universal Link 唤起App
  if ([XinstallLuaSDK  continueUserActivity:userActivity]){
    //如果使用了Universal link ，此方法必写
    return YES;
  }
  //其他第三方回调；
  return YES;
}
```

Scheme 配置

此方法为XinstallSDK 1.2.2最新添加的方法，如果使用报错，请先更新SDK 更多问题见iOS常见问题

在Xcode选中Target -> Info -> URL Types,配置Xinstall 为当前应用生成的 Scheme,如图所示：

图中4中的值为实例值，具体为xi+appkey格式，如xi4z9yxu8，您也可以在iOS集成-功能集成-一键拉起的文档中找到您对应的Scheme值

在 AppController.mm 中添加 Scheme 回调的方法

// iOS9以上会优先走这个方法
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    // 处理通过Xinstall URL SchemeURL 唤起App的数据
    [XinstallLuaSDK handleSchemeURL:url];
    return YES;
}

// iOS9一下调用这个方法
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(id)annotation {
    // 处理通过Xinstall URL SchemeURL 唤起App的数据
    [XinstallLuaSDK handleSchemeURL:url];
    return YES;
}

Android平台配置

一、拷贝文件

将Android目录下的两个java文件拷贝到app/src目录下
将Android目录下的aar的包拷贝到项目的app/libs目录下

二、添加权限

在 AndroidManifest.xml 中添加 Xinstall 需要的网络权限

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

三、配置AppKey

同样在 AndroidManifest.xml 中添加标签

<meta-data android:name="com.xinstall.APP_KEY" android:value="Xinstall_APPKEY"/>

四、拉起配置

将Cocos2dx项目中AppActivity继承 Xinstall 提供的 XInstallActivity（就是前面拷贝的两个文件）

在AndroidManfest.xml中给 AppActivity 添加

android:launchMode="singleTask"

以及配置scheme

<data android:scheme="xixxxxx"/>
// 从Xinstall控制台获得scheme

最后配置大致未

<activity
            android:name="org.cocos2dx.lua.AppActivity"
            android:screenOrientation="landscape"
            android:configChanges="orientation|keyboardHidden|screenSize"
            android:label="@string/app_name"
            android:theme="@android:style/Theme.NoTitleBar.Fullscreen"
            android:launchMode="singleTask"
            android:taskAffinity=""  >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            <intent-filter>
                <action android:name="android.intent.action.VIEW"/>
                <category android:name="android.intent.category.DEFAULT"/>
                <category android:name="android.intent.category.BROWSABLE"/>

                <data android:scheme="XINSTALL_SCHEME"/>
            </intent-filter>

</activity>

注：如果不想继承Xinstall的Activity类，可以将Activity中的方法加到AppActivity里

Lua 使用指南

一、配置

导入 xinstall.lua 到文件工程中，并在调用的时候使用一下代码引用：

local xinstall = require("src/ActionManagerTest/xinstall")
--- require 内为文件地址

如果只是使用基础班功能（无需携带参数安装、渠道统计、调起传参），直接以前的配置就行了。

二、使用

1. 拉起传参

完成相关iOS 和 Android的一键拉起的配置

然后在app启动后的第一个scence 中获取参数

local function wakeUpCallBack(result)
    print("拉起参数回调："..result)
end

xinstall:registerWakeUpHandler(wakeUpCallBack)

2. 携带参数安装

local function getInstallCallBack(result)
    print("安装参数回调："..result)
end
// 此处第一个参数为网络请求过期时间，只有android 有效，iOS 未提供。
xinstall:getInstance(10,getInstallCallBack)

3. 渠道统计相关

3.1 注册上报

xinstall:reportRegister()

3.2 事件点上报

注：需要在官网控制台内注册效果点进行统计，只为某些特殊业务的效果点进行统计

xinstall:reportEventPoint("123",25)

导出apk/ipa包并上传

参考官网文档

iOS集成-导出ipa包并上传

Android-集成

如何测试功能

参考官方文档测试集成效果

Lua