Giới thiệu

Trước khi tích hợp JOGOS_SDK, vui lòng đảm bảo tuân thủ các yêu cầu của chúng tôi. Tài liệu này sẽ hướng dẫn bạn cách sử dụng JOGOS_SDK một cách tối ưu nhất, bao gồm các yêu cầu về kỹ thuật, nội dung trò chơi, quảng cáo và tích hợp tài khoản. Ngoài Unity và Cocos có thể sử dụng SDK chuyên biệt, các engine khác của bạn có thể tích hợp các tính năng thông qua phiên bản HTML5, vì hầu hết các engine trò chơi hỗ trợ WebGL đều có cách tương tác với JavaScript khi chạy trên trình duyệt.

JOGOS_SDK bao gồm các module sau:

Mô-đun	Mô tả	Hỗ trợ SDK	Đề xuất tích hợp
JOGOS_SDK.init	Khởi tạo SDK	🟩 Hỗ trợ đầy đủ	☑️ Cần thiết, xem mô tả cụ thể bên dưới
JOGOS_SDK.game	Hành vi trò chơi	🟩 Hỗ trợ đầy đủ	☑️ Cần thiết, thông báo cho chúng tôi khi trò chơi của bạn tải, bắt đầu hoặc tạm dừng
JOGOS_SDK.user	Tương tác với người dùng đã đăng nhập	🟩 Hỗ trợ đầy đủ	🔳 Không bắt buộc, nếu sử dụng hệ thống người dùng
JOGOS_SDK.banner	Quảng cáo banner trong trò chơi	🟩 Hỗ trợ đầy đủ	🔳 Không bắt buộc, nếu trò chơi của bạn có quảng cáo Banner
JOGOS_SDK.ad	Video khích lệ và quảng cáo xen kẽ	🟩 Hỗ trợ đầy đủ	🔳 Không bắt buộc, nếu trò chơi của bạn có quảng cáo video
JOGOS_SDK.data	Lưu trữ đám mây	🟦 Sắp ra mắt	🔳 Không bắt buộc, nếu bạn cần sử dụng lưu trữ đám mây Jogos
JOGOS_SDK.friend	Bạn bè và nhóm	🟨 Chưa hỗ trợ	🔳 Không bắt buộc, nếu trò chơi của bạn cần hệ thống tương tác người chơi
JOGOS_SDK.payment	Mua hàng trong ứng dụng và trả phí một lần	🟦 Sắp ra mắt	🔳 Không bắt buộc, nếu trò chơi của bạn có mua hàng trong ứng dụng hoặc là trả phí một lần
JOGOS_SDK.active	Thành tựu và bảng xếp hạng	🟩 Hỗ trợ đầy đủ	🔳 Không bắt buộc, nếu cần sử dụng hệ thống thành tựu và bảng xếp hạng của Jogos
JOGOS_SDK.cdkey	Tính năng mã đổi thưởng	🟦 Sắp ra mắt	🔳 Không bắt buộc, nếu cần Jogos quản lý CDkey cho bạn

Bắt đầu

Phần này mô tả cách khởi chạy và chạy JOGOS_SDK trong engine.

Vui lòng thêm tập lệnh sau vào trong body của tệp index.html trong trò chơi của bạn để nhập JOGOS_SDK:

<script src="https://www.jogos.com/sdk/jogos-sdk-v1.js"></script>

Khởi tạo thủ công

JOGOS_SDK cần được khởi tạo trước khi có thể sử dụng. Việc khởi tạo được hoàn thành bằng cách gọi phương thức JOGOS_SDK.init:

let systemInfo = await window.JOGOS_SDK.init();

Phương thức JOGOS_SDK.init là không đồng bộ (asynchronous) và bất kỳ phương thức nào khác không thể sử dụng được trước khi phương thức JOGOS_SDK.init được thực thi thành công. Chúng tôi khuyến nghị mạnh mẽ bạn thực hiện việc này trước khi trò chơi bắt đầu.

Nếu gọi bất kỳ phương thức nào khác mà chưa gọi thành công phương thức JOGOS_SDK.init, một ngoại lệ "460 Can only be called after the successful call of the JOGOS_SDK.init method" sẽ được ném ra.

Promise

Phần lớn các phương thức trong JOGOS_SDK đều là không đồng bộ, có thể được gọi bằng cách sử dụng await:

try {
  const user = await window.JOGOS_SDK.user.getUser();
  console.log(user);
} catch (err) {
  console.log('Lỗi lấy người dùng: ', err);
}

Cũng có thể được gọi theo cách Promise:

window.JOGOS_SDK.user
  .getUser()
  .then((user) => console.log(user))
  .catch((err) => console.log('Lỗi lấy người dùng: ', err));

Có thể tải xuống cảnh mẫu để tham khảo: HTML5_Demo.zip

Thông tin SysInfo

Khi callback khởi tạo thành công, bạn có thể lấy thông tin SysInfo. Vui lòng không bỏ lỡ phần này, vì nó chứa thông tin quan trọng về game engine bạn đang sử dụng; bạn có thể lấy được loại ngôn ngữ mà người dùng nền tảng hiện đang sử dụng; để người chơi tự động khớp với ngôn ngữ địa phương khi vào trò chơi của bạn. Cập nhật thời gian thực của máy chủ trong trò chơi, v.v.

SysInfo{
    "gameId": number; //ID trò chơi
    "hasGameGroup": bool; //Có bật trò chuyện nhóm hay không
    "deviceType": "desktop"; // các giá trị có thể: "desktop", "tablet", "mobile"
    "language": string; //Loại ngôn ngữ
    "os": "Windows 10"; //Hệ thống và phiên bản
    "browser": "Chrome 10.0"; //Trình duyệt và phiên bản
    "serverTime": number; //Mốc thời gian máy chủ hiện tại
}

Phát triển và Kiểm thử

Trong quá trình phát triển, bạn sẽ thực thi JOGOS_SDK trong các môi trường khác nhau:

• localhost Khi gỡ lỗi phát triển cục bộ, JOGOS_SDK sẽ cố gắng mô phỏng hành vi của quảng cáo video/banner và các hành vi khác, và sẽ không tương tác với dịch vụ hoặc tải quảng cáo thực.
• Công cụ xem trước (Preview tool) Môi trường QA của chúng tôi cung cấp chức năng xem trước và kiểm tra thực tế. Sau khi trò chơi tích hợp JOGOS_SDK, bạn có thể xem trước trò chơi của mình trên cổng thông tin nhà phát triển sau khi đã tạo trò chơi mới và tải lên các tệp tài nguyên trò chơi liên quan.