Skip to content

簡介

在集成JOGOS_SDK之前,請務必遵循我們的要求。它將幫助您以最佳方式使用JOGOS_SDK,並在技術、遊戲內容、廣告和帳戶集成要求方面為您提供指導。 除了 Unity 和 Cocos 可以使用專屬 SDK 外,您的其他引擎可以通過HTML5版本集成這些功能,因為大多數支持WebGL的遊戲引擎在瀏覽器中運行時都有與JavaScript交互的方式。

JOGOS_SDK包含以下模塊:

模塊說明SDK支持接入建議
JOGOS_SDK.init初始化SDK🟩 完全支持☑️必要接入,下文具體說明
JOGOS_SDK.game遊戲行為🟩 完全支持☑️ 必要,告訴我們你的遊戲加載、開始或暫停
JOGOS_SDK.user與登錄用戶進行交互🟩 完全支持🔳非必要,如果使用用戶系統則需要
JOGOS_SDK.banner遊戲內橫幅廣告🟩 完全支持🔳非必要,如果你的遊戲內有Banner廣告
JOGOS_SDK.ad激勵視頻與插屏🟩 完全支持🔳非必要,如果你遊戲內有視頻廣告
JOGOS_SDK.data雲存檔🟦 即將推出🔳非必要,如果你需要使用Jogos雲存檔
JOGOS_SDK.friend好友與群組🟨 暫不支持🔳非必要,如果你遊戲內需要使用玩家交互系統
JOGOS_SDK.payment內購與買斷制🟦 即將推出🔳非必要,如果你的遊戲有應用內內購或是買斷制
JOGOS_SDK.active成就與排行榜🟩 完全支持🔳非必要,如果需要使用Jogos的成就和排行榜系統
JOGOS_SDK.cdkey兌換碼功能🟦 即將推出🔳非必要,如果需要Jogos為您管理CDkey

開始

本節介紹如何在引擎中啟動並運行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
let systemInfo = 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信息

當初始化成功回調後,可獲取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後,在 開發者門戶 上創建新遊戲並上傳了相關的遊戲資源文件後,就可以預覽您的遊戲了。