Skip to content

快速接入

SDK通过插件的方式提供所需能力,如果是原生平台,运营将额外提供必须得资源文件

插件使用

目前插件支持UnityCocosCreator3.xCocosCreator2.x

安装插件

下载插件

  • Unity: 使用Git安装,国内镜像: https://gitee.com/csseeg/seeg-sdk-unity.git
  • CocosCreator3.x: 使用Git安装,国内镜像: https://gitee.com/csseeg/seeg-sdk-cc3.git
  • CocosCreator2.x: 使用Git安装,国内镜像: https://gitee.com/csseeg/seeg-sdk-cc2.git
Markdown
打开游戏工程 -> Unity/团结引擎 Editor 菜单栏 -> Package Manager -> 右上方 "+" -> Add package from git URL
后续可从Package Manager检查更新
sh
# 进入工程的extensions目录(没有则创建)
cd ${YOUR_PROJECT_PATH}/extensions
git clone https://gitee.com/csseeg/seeg-sdk-cc3.git
# 如果需要指定版本,可以切换分支 git checkout ${VERSION}
# 执行一次npm
cd seeg-sdk-cc3
npm install
# 后续更新
git pull
npm install
# 第一次导入,请从插件管理器启用该插件
# 后续更新,请在插件管理器中刷新插件
sh
# 进入工程的packages目录(没有则创建)
cd ${YOUR_PROJECT_PATH}/packages
git clone https://gitee.com/csseeg/seeg-sdk-cc2.git
# 如果需要指定版本,可以切换分支 git checkout ${VERSION}
# 执行一次npm
cd seeg-sdk-cc2
npm install
# 后续更新
git pull
npm install
# 第一次导入,请重启编辑器
# 后续更新,请在Package Manager中刷新插件

构建相关平台

  1. 从菜单栏,打开SeegSDK面板

图片加载中

  1. 第一次使用请先新增gid,后续请切换到对应的GID,并保存

  2. 配置对应参数

  1. 原生平台资源

名词解释

  1. 原生和小游戏
  • 原生是指通过发布(上架)apk(/aab)或iap等方式提供给用户,小游戏是指借助平台能力提供给用户,因此文档中提到的android或ios没有特殊语境,一般都指原生应用。
  1. API的tab页
  • Unity 对应 unity插件 的api,适配了小游戏原生
  • CocosCreator 对应 CocosCreator插件 的api, 适配了小游戏原生
  • Android 对应 Andorid原生 的api,仅供Android原生环境使用
  • iOS 对应 iOS原生 的api,仅供iOS原生环境使用
    因此,我们建议直接使用插件的api调用,可以一套代码多端通用
  1. API注释里的不支持java/oc直接调用
  • 这里并不是指不支持原生,而是不支持原生方法直接调用,可以通过插件提供的api调用。

FAQ

常见问题

插件版本介绍

版本规范

本SDK遵循语义化版本(SemVer)原则,版本格式为:主版本号.次版本号.修订号,版本号递增规则如何

  1. 主版本号:当API有不兼容的情况时;
  2. 次版本号:当功能有修改时;
  3. 修订号:仅做功能优化、修复时。

版本建议

  1. 如要始终保持最新的版本,可以将git切换到main分支
  2. 如需要保持最大的稳定性,可以直接切换对应的版本分支
    • 如没有对应版本的分支,可以选择次版本号相同的分支,此时意味着你所在的版本有重大bug或下一个版本完全兼容
    • 同时,我们依然建议尽量同步修订号版本,以获得最佳的体验