RPG游戏接入SDK示例

本文档是 iOS 平台上，用 RPGMaker 引擎制作的游戏，如何接入 iOS 原生 SDK 的框架与示例
阅读文档前，先下载配套的项目 rpgsample

关于示例项目

• 提供了一般 SDK 的接入机制
• 接入了 4399 MOSDK

使用本项目有一些前置条件，请事先确认：

• 游戏应是在线的或本地的网页游戏，若是本地游戏，如本项目www目录所示
• 游戏使用 Javascript或Typescript，示例中使用 Javascript 演示
• 示例其他部分使用 swift 语言，使用 SwiftUI 写成，但可以移植到 Object-C 上
• 示例在 ios 17.2，模拟起 iphone 15 上测试
• 部分 SDK 的限制，本项目应在真机上运行

项目结构

├── AbsSDKNativeApi.swift
├── ContentView.swift
├── Info.plist
├── MOSDKNativeApi.swift
├── MockSDKNativeApi.swift
├── RPGWebView.swift
├── rpgsampleApp.swift
└── www
    ├── index.html
    ├── moSDKJsApi.js
    └── mockSDKJsApi.js

简要说明：

• www：模拟测试游戏
• **NativeApi.swift：封装了 SDK 的方法，便于游戏调用和回调
• RPGWebView.swift：加载本地网页，并关联原生代码与 js 代码

除了 www 目录下的内容，都可以称为 “原生代码”

SDK 接入通用方式

本项目使用 WKScriptMessageHandler 和 WKWebView.evaluateJavaScript 提供的机制完成原生代码与游戏代码的通信：

• js 方法调用原生方法，传递参数，与回调方法名称
• 原生方法调用 js 方法，返回上一步的调用结果

以下以一个名为 mockSDK 的 SDK 来说明具体过程：

• （0）游戏代码已经拷贝到项目www目录下，并且完成加载实现，如RPGWebView.makeUIView方法所示
• （1）在www/index.html中增加功能入口，如methodString, methodArgv等标签所示
  • （a）控件，作为测试入口
  • （b）控件回调定义及绑定，但实现可待定
• （2）实现 mockSDKJsApi 类，此类封装了 js 调用原生接口的方式，注意
  • （a）postMessage实现
  • （b）writeMessage实现
  • （c）postMessage调用，其中的callback方法待实现
  • （d）实现callback，此方法应能通过 html 中顶层对象 window 找到，它可以是顶层方法，也可以是对象方法，示例中是对象方法
• （3）实现 MockSDKNativeApi ，此类封装了 mockSDK 提供的方法，是其方法的直接调用和回调之处，js 回调的实现与 SDK 回调的方式应互相匹配
• （4）将 MockSDKNativeApi 注入到 window 中
  • （a）实例化对象并添加 WKWebView.configuration.userContentController.add
  • （b）分发 js 消息，按消息调用MockSDKNativeApi类中的方法

MOSDK 接入简介

• 下载并引入 MOSDK（向运营或 SDK 开发者咨询）
• 实现
  • 测试入口，测试方法，见www/index.html
  • 封装 js 方法，js 回调，见 www/moSDKJsApi.js, www/index.html
  • 封装原生方法，见MOSDKNativeApi.swift
• 注入原生对象，分发 js 消息，见RPGWebView.swift
• 调用
  • js 中调用封装方法，经过分发，最终调用 MOSDK 中的方法
  • MOSDK 方法的回调内，调用原生封装方法，最终调用 js 方法，更新游戏页面