# @chiyou/minigame-framework 中文文档

规范地址：https://npmcn.com/package/%40chiyou/minigame-framework/

版本：1\.6\.8
npm 元数据更新时间：2026-11-02T02:59:07.956Z
中文译文更新时间：2026-11-09T16:03:43.120Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chiyou/minigame-framework
原文对照：https://npmcn.com/package/%40chiyou/minigame-framework/?lang=original
项目主页：https://github.com/chiyou/minigame-framework#readme
源码仓库：https://github.com/chiyou/minigame-framework

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.2 MB，69 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：cc \*
- 首次发布：2026-03-28T12:55:14.389Z
- 最新版本发布：2026-11-02T02:59:07.798Z
- 近 30 天下载量：2274（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：197（近 12 个月 197 个）

## 中文简介

基于 Cocos Creator 3.x 的小游戏开发框架，支持多平台发布

## 安装

```sh
npm install @chiyou/minigame-framework
```

也可以使用：`pnpm add @chiyou/minigame-framework`、`yarn add @chiyou/minigame-framework`、`bun add @chiyou/minigame-framework`

## README

# MiniGameFramework

基于 Cocos Creator 3.x 的小游戏开发框架，支持多平台发布。

## 特性

-   🚀 **模块化架构** - 将游戏功能分解为独立的 Manager
-   🔌 **多平台支持** - 微信、抖音、快手、支付宝、B站、TapTap 等 12+ 平台
-   📦 **资源管理** - 按批次预加载资源，支持异步加载和缓存管理
-   🎯 **生命周期管理** - 统一管理游戏的冷启动、热启动、前台/后台切换
-   🔐 **隐私合规** - 内置隐私协议、用户登录、数据加密等合规功能
-   📢 **广告系统** - 支持插屏、激励视频、Banner、原生、Portal 等广告
-   💬 **事件系统** - 基于观察者模式的事件中心，实现模块间解耦通信

## 安装

```bash
npm install @chiyou/minigame-framework
```

## 使用

### 在 Cocos Creator 项目中使用

1.  在 Cocos Creator 的 `package.json` 中添加依赖：

```json
{
  "dependencies": {
    "@chiyou/minigame-framework": "^1.0.0"
  }
}
```

2.  构建项目时 Cocos Creator 会自动安装依赖
    
3.  在代码中导入需要使用的模块：
    

```typescript
import { ResMgr, UIMgr, EventMgr } from '@chiyou/minigame-framework';
```

### 预置的平台适配器

| 平台 | PlatformID |
| --- | --- |
| 微信小游戏 | `ID_MiniGame_WeiXin` |
| 抖音小游戏 | `ID_MiniGame_DouYin` |
| 快手小游戏 | `ID_MiniGame_KuaiShou` |
| 支付宝小游戏 | `ID_MiniGame_ZhiFuBao` |
| B站小游戏 | `ID_MiniGame_Bilibili` |
| TapTap | `ID_MiniGame_TapTap` |
| 小米快游戏 | `ID_QuickGame_XiaoMi` |
| OPPO 快游戏 | `ID_QuickGame_Oppo` |
| 荣耀快游戏 | `ID_QuickGame_Honor` |
| vivo 快游戏 | `ID_QuickGame_Vivo` |
| 华为快游戏 | `ID_QuickGame_HuaWei` |

## License

MIT

## 常见问题

### @chiyou/minigame-framework 是什么？

基于 Cocos Creator 3\.x 的小游戏开发框架，支持多平台发布

### 如何安装 @chiyou/minigame-framework？

在项目目录运行 npm install @chiyou/minigame-framework，或使用 pnpm add / yarn add / bun add。

### @chiyou/minigame-framework 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @chiyou/minigame-framework 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @chiyou/minigame-framework 可以商用吗？

@chiyou/minigame-framework 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chiyou/minigame-framework 的下载量有多少？

根据 npm 官方下载统计，@chiyou/minigame-framework 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,274 次，日均约 76 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chiyou/minigame-framework 还在维护吗？

最新版本 1\.6\.8 发布于 2026/11/02（7 天前）；至今共发布 197 个版本，其中过去 12 个月发布了 197 个；首次发布于 2026/03/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。