自助开发工具使用手册

来自AnySDK 文档
跳转至: 导航搜索

使用须知

1、已知Mac OSX版本为10.10.1或10.10.2,在应用中调用git指令时有bug,请该版本用户升级系统到最新版本。
2、主仓库中的代码与Coding的仓库都是用git,因此在主仓库中,开发者请慎重主动用git的操作,从而影响工具使用。(git版本要求不低于1.8.4)
3、AnySDK工具2.0.2版本,暂不支持对应AnySDK的插件工程进行提交;开发者可以下载AnySDK的插件工程后,自己修改,自己验证。

自助开发使用流程

Sh-flow.png

进入自助开发

点击主界面上如下图所示的位置进入自助开发。
Sh-enter.png

切换到自助开发模式

游戏的发布等工作都是在安全稳定的正式模式下进行的。自助开发的开发和测试等工作为了不影响正式模式上的游戏配置和运行等,需要切换到独立的自助开发模式。
在自助开发模式下:
  • 创建的游戏和游戏的配置数据等跟正式模式没有任何关系,不能用于游戏的正式发布,仅用于插件开发过程中的测试。
  • 为了方便新增插件的测试,在自助开发模式打包时能够使用已经申请通过的所有 SDK,插件开发完成后,导入即可打包测试。
进入自助开发时,工具会提示切换模式。切换模式后客户端会重启,如下图:
Sh-swich module.png

激活码

自助开发目前处于内测中,因此第一次进入时需要使用激活码。
获取激活码的途径有:
1、在自助开发QQ群(368777551)向技术支持人员申请激活码;
2、将自己AnySDK客户端的邮箱账号发送给support@anysdk.com邮箱,申请激活码。
输入获取到的32位的激活码进行验证,如下图:
Sh-jihuoma.png

Coding账号登录

自助开发过程中涉及到的所有插件工程和脚本工具等,是通过Coding进行管理的,所以需要绑定您的 Coding 帐号。如果您还还没有 Coding 帐号,可以登录Coding官网(https://coding.net )进行注册。
登录、授权界面如下图所示:
Sh-CodingLogin.png

主库目录

自助开发过程中的插件工程和工具等,需要存放到本地路径,这个目录就是自助开发的工作目录,我们称之为主库目录。
在第一次进入时,需要指定主库目录。 Windows 用户还需要制定 git.exe和 ssh-keygen.exe 的路径。如果git.exe和ssh-keygen.exe在同一目录下,只需指定 git 路径即可;如果git.exe和ssh-keygen.exe不在同一目录下,则需要再指定ssh-keygen.exe的路径。
Mac 用户、Windows 用户(git.exe和ssh-keygen.exe在同一目录下)、Windows 用户(git.exe和ssh-keygen.exe不在同一目录下)的界面图分别如下所示:
Sh-path-Mac.png
Sh-main-windows1.png
Sh-main-windows2.png

添加SSH 公钥

每一个插件工程都是一个 git 库,通过 git 的以 SSH 的方式对用户本地库、用户在 Coding 上的远程库和 AnySDK在 Coding 上的远程库进行代码的管理的。所以用户需要将自助开发工具生成的 SSH 工具添加到您的 Coding 帐号里,以便工具下载和提交代码等。
添加 SSH 公钥的提示如下图所示:
Sh-addSSHKey.png
在 Coding 上添加的贴图如下:
Sh-CodingSSHkey.png
如果初始化时没有添加SSH 公钥,可能导致插件工程无法提交等问题,可以在【设置界面】再次显示添加 SSH 公钥的教程。
到这一步,我们所有的准备工作完成了,点击确定后,工具开始下载自助开发需要用到的库文件到主库目录中。
Sh-MainCloning.png

自助开发界面

获取完主仓库后,默认进入自助开发界面的“插件管理——我的远程插件”界面。新用户进入后,未下载或新建过任何项目,所以我的远程插件没有任何工程。
自助开发界面中,分成6个模块:
  • 插件管理:管理用户 Coding 库中的插件工程、从 AnySDK 开发插件库中下载插件工程。
  • 插件配置::创建新插件工程、查看和编辑本地插件工程中的基本信息、扩展函数、 SDK 参数等。
  • 插件开发:生成插件,展示自助开发文档。
  • 插件提交:提交本地插件工程修改到 Coding 库中、提交插件工程审核上线。
  • 插件跟踪:插件提交审核的插件工程的审核状态。
  • 插件设置:修改主库目录、设置 Android 开发环境、Windows 下设置 git.exe和 ssh-keygen.exe路径。
新用户接入后,显示如下图:
Sh-selfmain.png

插件管理

“我的远程插件”

  • 分平台显示用户 Coding 库中的插件工程。
  • 下载插件工程:用户本地主库目录中还没有该插件工程时,可点击下载。当用户的 Coding 上和 AnySDK 开发库都有该工程时,询问用户选择下载的位置。
  • 删除 Coding 库中的插件工程:点击右上角红色删除按钮删除用户 Coding 库中的插件工。如果用户本地也有该工程,询问用户是否也删除本地库中的改插件工程。
Sh-myproject.png

“AnySDK 开源插件”

  • 分平台、分类型显示 AnySDK 已经开源的所有插件工程。
  • 下载插件工程:用户本地主库目录中还没有该插件工程时,可点击下载。当用户自己的 Coding 上已经有该工程时,提示用户选择下载的位置。
  • 删除本地插件工程:对已经下载到本地的插件工程,可以点击右上角红色删除按钮进行删除。如果用户 Coding 库中也有该工程,询问用户是否也删除。
Sh-AnySDKproject.png

插件配置

创建新插件工程、查看和编辑本地插件工程中的基本信息、扩展函数、 SDK 参数等。
界面如下图所示:
Sh-devshowinfo.png

基本信息

  • 工程类型:SDK 所属平台,分 Android 和 iOS。在渠道大全申请创建SDK时确定,修改时也需要到渠道大全去修改。可参考【 申请创建新的渠道SDK】。
  • 所属 SDK:对应的SDK 名字,即打包时选择 SDK 时的显示名字。在渠道大全申请创建SDK时确定,修改时也需要到渠道大全去修改。
  • 工程名称:插件工程的目录名,与工程名、插件类名等有关。在渠道大全申请创建SDK时确定,修改时也需要到渠道大全去修改。
  • 插件 ID:插件与客户端和服务端交互时的标识值。在渠道大全申请创建SDK时确定,修改时也需要到渠道大全去修改。
  • 插件版本号:插件版本号,首次创建时为2.0.0,每次更新版本时加0.0.1(更新时不修改版本号,可能会导致无法提交审核)。
  • SDK 版本:插件中的 SDK 版本号。版本号显示位置可参考【 README.md】【 子节点version】 。
  • 插件类型:插件包含的系统类型,有用户、支付、统计、推送、广告、分享、录屏、崩溃分析、自定义等。
  • 扩展函数:显示通用扩展函数列表,和插件已支持的扩展函数。
  1. 只显示通用扩展函数(客户端接入中用户、统计系统中提到的扩展函数),而不是插件所有的扩展函数。
  2. 只能通过勾选添加扩展函数,不能删除插件中已经支持的扩展函数,删除时需要在代码文件中删除相应的函数。
  3. Android 插件只有在能正确编译时,才可能看到扩展函数,编译不成功时,无法显示扩展函数。
  • 插件工程路径:显示当前插件工程在本地的路径。主库目录确定,插件工程路径即确定,不可修改。
  • 客户端开发者:最新开发插件的客户端开发者,用户可以写邮箱、公司名等。本项及以下内容写入 README.md 文件中,可参考【 README.md】。
  • 服务端开发者:最新开发插件的服务端开发者,没有服务端或者服务端没有改动的,可以不写。
  • 插件更新内容:最新插件更新内容。
  • 插件注意事项:插件更新中的注意事项,方便后期维护。

SDK 参数

SDK参数指的是,用户使用该插件时,需要提供的渠道分配游戏数据和游戏的设置数据等。最终参数写入 Config.xml 文件,详细说明见【子节点paramLs】。
  • SDK参数列表:当前插件的所有参数列表。可以查看、添加、编辑、删除参数。
Sh-SDKparams.png
  • SDK 参数配置:对参数详细信息的编辑。每个参数对应Config.xml 文件的一个<param/>,详细说明见【子节点paramLs】。
参数名:属性名name,客户度、服务端插件获取该参数时的 key 值。
参数显示名:属性名showName,打包工具中 SDK 参数列表中的显示的名字。
描述:属性名desc,对参数的描述。
占位符:属性名placeholderText,当该参数没有值时显示内容。
配置选项:“必填项”:属性名required;“用户填写”:属性名bUserOffer;“写入 APP”:属性名bWriteIntoClient;“写入 AndroidManifest”:属性名bWriteIntoManifest;
参数类型:“文本”:用户填写内容的编辑库;“下拉选项”:用户从下拉列表中选择值,可选值写入下拉选项文本框中,每行一个值,对应一个<option/>;“上传文件”:用户根据要求传入文件,对应子节点<input>。
Sh-editParams.png

插件开发

编辑插件工程

Android:根据点击编辑后的教程,将插件工程导入到 Eclipse 中进行开发。
iOS: Mac 电脑下,点击编辑后,直接在 XCode 中打开插件工程,进行开发。

生成插件 zip

Android:点击后选择生成方式:
  • 本地编译:在本地编译插件工程生成插件的 zip 包。
  • 远程编译:在本地编译成功的前提下,把本地插件工程提交到 Coding 上,远程编译工具从 Coding 上下载代码、编译生成 zip,再下载到本地。远程编译可以解决要求编译时区分大小写的问题。
iOS: Mac 电脑下,本地编译插件工程生成插件的 zip 包。
Sh-develope.png

提交界面

点击左窗口的插件,右窗口显示对应的提交信息;自己创建的插件在提交前应先填写提交信息;点击提交按钮,把对应插件代码传送到coding仓库中;点击“提交审核”,提交插件信息给AnySDK进行审核。
Sh-submit.jpg

跟踪界面

点击左边窗口的插件,右窗口显示对应插件跟踪状态;点击对应的状态,显示该状态下的反馈信息;点击“撤销”按钮,取消提交给AnySDK进行上线流程,如下图所示:
Sh-trace.jpg

设置界面

  • 主库目录:主工作目录,初始化时设置的目录,可再此处修改。
  • git 路径:Window 系统下需要设置的git.exe 的路径。
  • SSH 路径:Window 系统下当git 路径路径下没有 ssh-keygen.exe时,需要设置的ssh-keygen.exe路径。
  • ant 路径:Window 系统下ant.bat所在路径,Mac 系统下ant所在路径。
  • java home 路径:jdk 安装目录。
  • Android SDK路径:build-tools文件夹所在路径。
  • 添加 SSH 公钥教程:将 SSH 公钥添加到 Coding 上的教程,详见【 添加SSH 公钥】.
Window界面如下图所示:
Sh-settings.png

申请创建新的渠道SDK

1、登陆服务大全网页

登陆地址为:http://dq.qudao.info ,如下图:
Sh-qudaoWeb.jpg

2、账号登陆服务大全

如下图:
Sh-qudaoLogin.jpg

3、创建服务

进入创建界面,如下图:
Sh-qudaoCreateWeb.jpg
完善创建信息并且点击提交,如下图:
Sh-qudaoCreateInfo.jpg

4、新增SDK

进入SDK管理界面,如下图:
Sh-qudaoSDKWeb.jpg
进入添加SDK界面,如下图:
Sh-qudaoSDKAddWEB.jpg
完善添加SDK的信息,如下图:
Sh-qudaoSDKInfo.jpg
完成添加,如下图:
Sh-qudaoSDKfinish.jpg