Skip to content

简介

在集成JOGOS_SDK之前,请务必遵循我们的要求。 它将帮助您以最佳方式使用JOGOS_SDK,并在技术、游戏内容、广告和帐户集成要求方面为您提供指导。 除了 Unity 和 Cocos 可以使用专属 SDK 外,您的其他引擎可以通过HTML5版本集成这些功能,因为大多数支持WebGL的游戏引擎在浏览器中运行时都有与JavaScript交互的方式。

JOGOS_SDK包含以下模块:

模块说明原生 HTML5CocosUnity
JOGOS_SDK.user与登录用户进行交互🟩 完全支持🟩 完全支持🟩 完全支持
JOGOS_SDK.game游戏行为🟩 完全支持🟩 完全支持🟩 完全支持
JOGOS_SDK.banner游戏内横幅广告🟩 完全支持🟩 完全支持🟩 完全支持
JOGOS_SDK.ad视频广告🟩 完全支持🟩 完全支持🟩 完全支持
JOGOS_SDK.data云存档🟦 即将推出🟦 即将推出🟦 即将推出
JOGOS_SDK.friend好友与群组🟨 暂不支持🟨 暂不支持🟨 暂不支持
JOGOS_SDK.purchase内购与买断制🟩 完全支持🟩 完全支持🟩 完全支持
JOGOS_SDK.Active成就与排行榜🟦 即将推出🟦 即将推出🟦 即将推出

开始

本节介绍如何在引擎中启动并运行JOGOS_SDK

请在游戏的index.html文件中的body内,添加以下脚本来引入JOGOS_SDK

html
<script src="https://www.jogos.com/sdk/jogos-sdk-v1.js"></script>
手动初始化

JOGOS_SDK需要初始化后才能使用。通过调用 JOGOS_SDK.init 方法来完成初始化:

javascript
await window.JOGOS_SDK.init();

JOGOS_SDK.init方法是异步的,并且其它任何方法在JOGOS_SDK.init方法成功执行之前不可用。我们强烈建议您在游戏开始前执行此操作。

如果调用其它方法之前未成功调用JOGOS_SDK.init方法,则会抛出异常"460 Can only be called after the successful call of the JOGOS_SDK.init method"

Pormise

JOGOS_SDK中的绝大多数方法都是异步的,可以使用await的方式调用:

javascript
try {
  const user = await window.JOGOS_SDK.user.getUser();
  console.log(user);
} catch (err) {
  console.log('Get user error: ', err);
}

也可以使用Pormise的方式调用:

javascript
window.JOGOS_SDK.user
  .getUser()
  .then((user) => console.log(user))
  .catch((err) => console.log('Get user error: ', err));

可下载示例场景参考 :HTML5_Demo.zip

重要信息

当初始化成功回调后,可获取SysInfo信息请不要错过此部分,其中包含有关您所使用的游戏引擎的重要信息;您可以获取到平台用户当前使用的语言类型;让玩家进入你的游戏时自动匹配本地化语言。更新你游戏内真实的服务器时间等。。

javascript
SysInfo{
    "gameId": number;//游戏 Id
    "hasGameGroup":bool;//是否开启群聊
    "deviceType": "desktop"// possible values: "desktop", "tablet", "mobile"
    "language": string;//语言类型
    "os":"Windows 10"//系统与版本
    "browser":"Chrome 10.0"//浏览器与版本
    "serverTime": number;//当前服务器时间
}

开发与测试

在开发过程中,您将在不同的环境中执行JOGOS_SDK

  • localhost 在本地调试开发时,JOGOS_SDK会尝试模拟视频广告/横幅及其它等行为,并不会与服务交互或加载真实的广告。
  • Preview tool 在我们的QA环境中提供了真实的预览及检测功能。游戏集成完JOGOS_SDK后,在 开发者门户 上创建新游戏并上传了相关的游戏资源文件后,就可以预览您的游戏了。