GSDK-Hub V2.9使用手册
功能说明
登录
GSDK-Hub登录和开发者平台是共享同一套账号系统,都是使用飞书/Lark登录。如果没有对应账号,请联系开发者平台。
绑定CPID
CPID有两种,一种朝夕光年的工作室,一种是接入朝夕光年服务的应用ID。每个Hub的使用者,都必须绑定一种,这样让朝夕光年数据同学能够准确的获取Hub的使用方,以便做到精准的推送和升级沟通。
目前已经支持选择的工作室ID包括:绿洲、有爱、沐瞳、101、江南、游戏中台(给中台内部同学使用)。如您所在的工作室不在此列表,请联系朝夕光年的同学。
功能列表
介绍
GSDK在经过组件化改造后,变成了一个个功能的集合。功能列表展示的信息就是GSDK内部支持的核心功能列表。该信息是后面版本管理,出包管理的基础功能。功能列表中,每个功能包含以下信息。
列名 | 描述 | 额外信息 |
---|---|---|
组件名称 | 组件的名称 | |
组件标识 | 组件的Key,全局唯一 | |
平台 | 双端 / Android / iOS / Windows | 存在部分组件,只有单端才有。比如Thanos |
区域 | 通用 / 国内 / 海外 | |
起始版本 | 组件从哪个GSDK版本开始有的 | |
废弃版本 | 组件从哪个GSDK版本废弃的 | |
描述 | 组件的简单描述 |
版本列表
示例界面
SDK出包
从版本列表选择需要的版本,进入SDK配置生成页。
示例界面
可以自行选择需要的组件/模块,或者点击“导入历史配置”,从历史配置选择需要的组件/模块组合。
历史版本与目标版本的SDK在组成上可能存在差异,可以对比版本间的差异,对勾选的组件/模块自行更改。
组件/模块选择之后,点击“生成出包配置”,则会将选择的结构保存到用户记录中,在后续流程中可用于获取SDK的内容。
配置列表
介绍
配置列表记录使用方的所有配置出包记录。每个出包记录包括:包体的GSDK版本、区域信息、平台信息、组件集合、出包时间、出包相关操作。
对于每一份配置记录,GSDK-Hub提供了一些管理操作。如下
- 删除:删除个人的出包记录
- 备注:给该条出包记录增加备注信息,方便记录回忆
- 出包:对于iOS/Unity,需要实时根据信息得到需要的动态库。
- 下载:对于iOS/Unity,出的包是在CDN上,可以下载到本地
- 导出:对于iOS/Unity,将下载包导出到指定位置
- 详细:查看该条记录的标准DSL展示
- 查看Gradle配置:对于Android,根据所选的配置,实际上会得到一份Gradle配置建议文件
示例界面
补充说明
Android的出包就是出一份对应组件的配置,所以出包延迟为0。
iOS的出包是实时出一份对应组件的动态库,一般需要等待2-10分钟
Unity出包是实时出一份对应组件的UnityPackage,一般需要等待5-20分钟
如果相同的出包配置,之前已经有记录,会复用缓存,出包延迟为0
为什么是动态库?
- 动态库做到真正意义上按需加载,做到包体最小化。
- 彻底的解决符号冲突问题。
- 技术:不影响游戏app的text段。
- GSDK的符号表托管在G中台
出包完成后下载
在iOS/unity的导出环节和安卓查看gradle环节,可以选择目标工程的appID,用来查询所需的动态化预制包。如果不需要预制包可选择跳过。预制包内容可联系gsdk动态化同学了解。
查看android gradle
可以选择安卓的AGP版本,默认是4.0.2,如果需要使用其他版本请先咨询@高超 (该功能最低支持版本:2.8.2)
可以将gradle复制下来拷贝到游戏工程中
工程记录
介绍
该功能主要是记录本地的工程,用于SDK的自动化集成。每条记录包括:工程的基本信息(工程名、路径)、类型(Xcode工程/Unity工程)、目标(SDK需要集成到Xcode工程的target)等。
对于工程记录,GSDK-Hub提供了一些管理操作。如下
- 删除:删除工程记录(仅删除记录,不会对本地工程造成影响)
- 修改:修改工程基本信息、备注等
- 集成:对于iOS/Unity工程,选定自助出包的SDK进行自动化集成
示例界面
工程列表:
选择SDK:
开始集成:
设置
账号设置
展示账号信息,可以退出登录
缓存管理
SDK下载/集成将会在本地进行缓存,为了节省空间,可在此清理缓存,不会对已经集成的工程产生影响。
更新管理
可以查看最新GSDK-Hub版本
意见反馈
如果有遇到问题或者对GSDK-Hub有什么建议的话,欢迎反馈
命令行模式
GSDK-Hub支持命令行模式,可用于自动化集成。
windows版安装后即可直接在命令行下运行; mac版在使用前,需要先进行安装:
同时需要确保GSDK-Hub已成功登录,然后可以在终端执行gsdkhub命令:
目前版本支持五个子命令:
- pack: 根据DSL文件进行打包,保存到指定目录
- gradle: 根据DSL文件生成gradle代码片段,保存到指定文件
- config-list: 获取当前用户的配置列表
- packWithDSL: 使用云端的配置进行打包,保存到指定目录
- gradleWithDSL: 使用云端的配置生成gradle代码片段,保存到指定文件
其中的DSL文件,可以从GSDK-Hub GUI模式导出:
导出的DSL文件,可以分发给项目组其他人,在CLI模式下使用。如:
出包:
gsdkhub pack --dsl ~/Desktop/dsl.json --output .
生成gradle配置:
gsdkhub gradle --dsl ~/Desktop/dsl.json --output ./gradle.snippet
使用云端配置出包流程:
查询云端配置列表:
gsdkhub config-list
根据配置的ID获取云端配置并出包:
gsdkhub packWithDSL --dslId 4835 --output './'
根据配置的ID获取云端配置并生成gradle配置:
gsdkhub gradleWithDSL --dslId 4835 --output './gradle.txt'
GSDK-PC出包
GSDK Hub 2.6.0版本开始支持PC端出包
Unity出包:
- 以海外3.18.0.0出包为例,点击生成出包配置(暂不支持通用)
- 勾选支持windows,选择PCSDK版本号(具体接入版本号可咨询TPM同学)
- 海外官包选择正常版本;海外steam渠道包,则选择带-steam后缀版本
- 组件勾选根据项目实际需求选择
- 出包类型根据实际项目需要选择
- 配置列表中,根据生成的配置出包即可(出包 ->下载 -> 导出SDK)
Native出包:
- 选择好基线版本号:(具体版本号可咨询TPM同学)
- bytedance默认为官方渠道包
- steam渠道包选择steam选项
- 配置列表中导出SDK即可