文档中心>游戏多媒体引擎

导入 SDK 到项目

最近更新时间:2026-06-09 11:46:11

我的收藏
本文介绍如何快速地将 GME SDK(Electron 版本)集成到您的 Electron 项目中。

支持的平台

Windows(PC)

安装 Node.js

1. 根据 Windows 操作系统选择下载最新版本的 Node.js 安装包 Windows Installer (.msi) 64-bit。
2. 打开应用程序列表中的 Node.js command prompt,启动命令行窗口,用于输入后续步骤中的各项命令。

通过 npm 集成 Electron SDK

步骤1:新建 Electron 工程

新建一个 Electron 项目,本文以项目名 GMEElectronApp 为例。若已有项目可跳过此步骤。
mkdir GMEElectronApp && cd GMEElectronApp
npm init -y
npm install electron@30 --save-dev
执行上述命令后,目录下会生成 node_modulespackage.jsonpackage-lock.json。接下来需要手动创建主进程入口文件: index.js 和渲染页面 index.html,完整项目结构如下:
GMEElectronApp/
├── node_modules/ # npm 依赖目录
├── package.json
├── package-lock.json
├── index.js # Electron 主进程入口(需手动创建)
└── src/
└── index.html # 渲染页面(需手动创建)


步骤2:安装 SDK

通过 npm 安装 GME Electron SDK v3。
npm install gme-electron-sdk-v3@latest --save
安装完成后,node_modules/gme-electron-sdk-v3/ 目录下包含以下结构。
gme-electron-sdk-v3/
├── doc/ # 接口文档
├── gmesdk/ # SDK 源码(TMGContext.js 为入口,含 TMGType / AVError 等模块)
├── scripts/ # postinstall 下载脚本
├── build/ # native 库解压目录(postinstall 下载得到,含 *.node)
├── package.json # main = "gmesdk/TMGContext.js"
├── README.md

步骤3:引入 SDK 模块验证 SDK 是否导入成功

在 Electron 主进程入口文件 index.js 里引入 SDK 并调用 GetSDKVersion()。

// index.js
const { app } = require('electron');
const { GetTMGInstance } = require('gme-electron-sdk-v3');

app.whenReady().then(() => {
const gmeContext = GetTMGInstance();
const sdkVersion = gmeContext.GetSDKVersion();
console.log(`[GME] SDK Version: ${sdkVersion}`);
});
然后在项目根目录执行:
npx electron .
如果终端可以正常打印版本号字符串(例如 [GME] SDK Version: 3.x.x),说明 SDK 已经成功导入。