乐变sdkAS插件使用说明.docx
- 文档编号:27488528
- 上传时间:2023-07-02
- 格式:DOCX
- 页数:11
- 大小:484.64KB
乐变sdkAS插件使用说明.docx
《乐变sdkAS插件使用说明.docx》由会员分享,可在线阅读,更多相关《乐变sdkAS插件使用说明.docx(11页珍藏版)》请在冰豆网上搜索。
乐变sdkAS插件使用说明
一在AndroidStudio中应用乐变插件
点击Browerrepositories...找到乐变插件PluginforLBSDK进行install然后重启AS,应用生效
二使用插件集成乐变sdk
1.右键要集成的项目module,点击MergeLbsdk
首次使用会,弹出提示
3.点击ok,弹出提示,该提示一般在左上角,比较小,拉伸后如图
4.点击UpdateSdk更新sdk,等一会会提示更新完成(如果不是首次使用可以不用更新,当然更新的话会拉取我们最新的sdk)
5.重新右键module打开集成对话框,填写配置信息
如下图,其他默认的配置也要根据实际需要来改动,一定要确保module路径正确
配置信息:
MainChid:
通过乐变提供的后台账号登陆后在首页获取,没有账号请联系我们,大陆地区小于800000,其他地区大于800000,如果没有相应账号,请找我们开通
ClientChid:
用户自定义,用于区分不同渠道,如XX就写成:
baidu,支持英文和小于9位数字,不能写成中文
Area:
地区,用于区分国内,海外,台湾.
大陆请设置为CN
台湾请设置为TW
其他地区请设置为OVS
UseBwBx:
只用热更功能设置为false,有分包功能才设置为true;
ScreenOrientation:
用于控制乐变弹框的横竖屏,
如果应用本身为横屏设置为:
landscape
如果应用本身为竖屏设置为:
portrait
Crashlog:
设置为true可以在管理后台的闪退日志中查看闪退信息,如果你们已经用了友盟等log统计,可以设置为false禁用log上传功能
ModulePath:
你要集成的Module的路径
6.Restore可以恢复上次的配置
7.配置好后点击Start进行集成,集成好后会有集成成功的提示
8.menifest中这样的报错不用管
9.如果想取消集成,可以点击CancelLbsdk恢复到上次集成前的状态
三分包说明及其他开关设置(只使用热更功能的客户请跳过本节内容)
如需使用乐变游戏分包功能,完成上面的sdk接入后,没有特殊需求,保持默认设置即可,打包后将apk文件发给我们,我们安排测试人员模拟用户行为,完成后就可以上传我们的后台自动分包了;如果有特殊需求可以根据下面开关说明进行设置,位置在com.excelliance.open.GlobalSetting.java中
GlobalSettings.java中分包相关开关说明
开关
说明
SHOW_LOADING_PROGRESS_BWBX
碰到缺失资源即时下载资源会显示加载动画,当前是一个咖啡杯动画,true打开,false关闭
SHOW_FIRST_DIALOG_WITHOUT_WIFI_BWBX
非wifi网络下,玩家进入游戏会弹出下载提示框,true打开,false关闭
SHOW_FIRST_DIALOG_ALWAYS_BWBX
任何网络下,玩家进入游戏都会弹出下载提示框,true打开,false关闭
CHECK_OLD_USER_AUTO
自动检查老用户的开关,我们有提供下载完整分包资源的接口,具体查看3.接口说明中GameSdk.downloadFullRes。
true打开,false关闭
CHOOSE_BY_USER_BWBX
玩家进入游戏立即提示下载完整分包资源,true打开,false关闭
四接口说明
1)请求更新
类:
com.excelliance.lbsdk.LebianSdk、com.excelliance.lbsdk.IQueryUpdateCallback
方法
说明
LebianSdk:
publicstaticvoidqueryUpdate(
finalContextcontext,
finalIQueryUpdateCallbackcb,
Stringtag)
请求应用更新,如后台有新版本,根据后台配置决定是否弹出对话框提示用户,此接口可在入口处调用,如登陆界面。
参数说明:
context:
当前ApplicationContext;
cb:
IQueryUpdateCallback类实例,如果不需要请求结果,传入null即可.在该实例的onUpdateResult(intresult)获取请求的结果
请求更新结果result说明:
-2:
SDK未准备好
-1:
请求失败
1:
未知错误
2:
没有更新
3:
有非强更版本
4:
有强更版本
tag:
自定义标签,服务器可根据该标签自定义升级范围
示例代码:
finalIQueryUpdateCallbackcallBack=newIQueryUpdateCallback(){
publicvoidonUpdateResult(intresult){
Log.d(TAG,"result="+result);
}
};
LebianSdk.queryUpdate(this,callBack,null);
关于该接口的说明:
a.启动游戏的时候,即使不调用该接口,SDK也会发起更新检查的。
但是用户玩游戏后可能会按home键切到后台,假如这段时间内后台上传了一个必须强更的版本,当用户重新回到游戏后,一般你们服务器会把用户踢出游戏要求用户重新登录,这样你们调用这个接口我们就会发起版本检查了。
假如你们不调用,在这种情况下我们就无法提示用户需要更新版本了。
假如不存在此场景,可以不调用该接口。
b.无需等待callback被回调,调用queryUpdate直接启动当前版本即可。
假如有新版本,乐变SDK会弹出提示
c.特别注意:
如果用户正常退出时,没有调用exit或killProcess终止当前进程,则必须在合适的地方调用该接口(比如在登陆的地方,请参考说明a)
2)老玩家提示用户一次性下载完整资源(该接口只在分包功能可用,如果您只使用热更新可直接跳过)
类:
com.excelliance.lbsdk.LebianSdk
方法
说明
GameSdk:
publicstaticvoiddownloadFullRes(finalContextcontext)
参数说明:
1.context:
当前Context;
示例代码:
LebianSdk.downloadFullRes(this);
关于该接口的说明:
当老玩家安装小包进入游戏后,会提前加载高级玩家才会使用的资源,这时游戏会及时下载这些资源,导致游戏不流畅,您可以在玩家登陆成功后通过账号信息判断此玩家是否是老玩家,如果是老玩家就调用该接口,调用后会弹出对话框提示玩家一次性下载完整资源。
即使不调用该接口,sdk也有自动检测老玩家的机制,只是没有您通过账号判断精确。
LebianSdk注意:
默认在流量网络下,小包进入游戏会立刻提示用户是否下载资源,如果调用该接口,又会再次弹出对话框提示玩家下载,造成重复提示,为了更好的用户体验,如果您需要调用该接口,请将GlobalSettings.java中流量提示下载对话框开关关闭:
publicstaticbooleanSHOW_FIRST_DIALOG_WITHOUT_WIFI_BWBX=false;关闭后流量网络进游戏就不会提示玩家下载了。
五定制升级时的下载界面背景图、进度条、字体颜色
文字颜色设置请修改res/values/lebian_styles.xml
背景图设置请将res/drawable-nodpi/lebian_background.xml中android:
drawable的value修改为您指定的背景图,默认实现是使用res/drawable-nodpi目录下放一张名字为lebian_main_background_normal.jpg的图片,切记将这张图片换成你们自己的,详情请参考SDK压缩包中的“资源替换图示”。
该图片会自动全屏拉升。
六其他说明
1)关于V2签名
如果你们使用的gradlewassembleRelease打包,那么请在build.gralde签名配置部分加上v2SigningEnabledfalse,示例如下:
如果你们是通过AndroidStudio的Build/GenerateSignedApk生成apk,那么请只勾选V1,假如看不到此选项,请升级Studio及gradle到最新版本。
升级gradle可以修改gradle-wrapper.properties,比如升级到3.3可以这样改:
distributionUrl=https\:
//services.gradle.org/distributions/gradle-3.3-all.zip
2)如果您的主activity设置了android:
taskAffinity,则需要将NextChapter和PromptActivity加上同样的taskAffinity
3)如果您的APP使用了multidex,请参考《关于Multidex的配置》目录中的README
七FAQ
1)AndroidManifest.xml中的MainChId做什么用的?
一个管理后台账号对应一个MainChId,设置错了将无法上传至后台。
可在后台“系统管理/管理首页/产品信息”查询该账号对应的MainChId。
2)如果有对外提供startActivity接口,是否支持热更后调用该接口启动新版本的activity?
支持的,请在manifest对应的activity加上 name="lbvm_hu_entry"android: value="true"/>,可参考demo中Activity2的定义 3)哪些内容不能热更? a)系统看到的信息不能更新,比如设置中看到的版本号,icon,权限等静态的信息,即使热更到新版本,看到的也还是老的。 但APP实际运行时获取到的版本号等信息都还是新版本的信息,因此不会影响统计等功能。 b)供外部使用的接口不能更新。 比如版本1没有ActivityA,版本2有ActivityA,如果新版本暴露startActivity接口让别的APP调用A,那么从版本1热更到版本2后,别人还是无法调用A。 (自己内部可以新增任何组件) 4)能否指定某些文件不更新? 比如有很多渠道包只有一个渠道ID的差异,别的内容完全相同,如果这些渠道热更到同一个版本,那么渠道ID就丢失了;如果每个渠道都在热更后台建立一个对应的渠道,又太多了。 目前支持: a)指定assets目录下的一个或多个文件热更后继续使用老版本中的(默认使用新版本中的) b)Manifest中的所有meta-data使用老版本中的(默认使用新版本中的;暂不支持设置某个meta-data使用老版本,其余使用新版本) c)META-INF下除签名以外的文件使用老版本中的(默认会保留META-INF下除签名外的其余文件) d)APK的注释信息使用老版本中的(默认会保留老版本中的注释) 5)新版本的提示界面以及强制更新的下载界面是全屏的,能否改为非全屏? 可以,修改AndroidManifest.xml中PromptActivity和NextChapter的android: theme即可。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- sdkAS 插件 使用说明