oops-framework 开源项目教程

1. 项目的目录结构及介绍

oops-framework 是一个基于 Cocos Creator 3.x 版本开发的游戏框架。项目的目录结构如下：

oops-framework/
├── assets/
│   ├── resources/
│   └── scenes/
├── library/
├── local/
├── packages/
├── settings/
├── temp/
├── build/
├── node_modules/
├── oops-game-kit/
├── oops-plugin-framework/
├── oops-plugin-excel-to-json/
├── oops-plugin-bundle/
├── README.md
├── project.json
└── tsconfig.json

目录介绍

• assets/: 存放游戏资源，包括场景文件、预制体、图片、音频等。
  • resources/: 存放动态加载的资源。
  • scenes/: 存放场景文件。
• library/: 存放 Cocos Creator 编译后的资源。
• local/: 存放本地配置文件。
• packages/: 存放扩展包。
• settings/: 存放项目设置文件。
• temp/: 存放临时文件。
• build/: 存放构建后的游戏包。
• node_modules/: 存放 Node.js 模块。
• oops-game-kit/: 游戏项目模板。
• oops-plugin-framework/: 基础框架插件。
• oops-plugin-excel-to-json/: Excel 转 Json 的框架插件。
• oops-plugin-bundle/: AB 包框架插件。
• README.md: 项目说明文档。
• project.json: 项目配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

oops-framework 的启动文件主要位于 assets/scripts/ 目录下。主要的启动文件包括：

• main.ts: 主入口文件，负责初始化游戏框架和加载第一个场景。
• config.ts: 配置文件，包含游戏的基本配置信息，如屏幕适配、资源路径等。
• bootstrap.ts: 引导文件，负责初始化各个模块，如资源管理、UI 管理、音频管理等。

启动流程

1. main.ts: 初始化游戏框架，加载配置文件和引导文件。
2. config.ts: 读取并应用游戏配置。
3. bootstrap.ts: 初始化各个模块，加载第一个场景。

3. 项目的配置文件介绍

oops-framework 的配置文件主要位于 assets/config/ 目录下。主要的配置文件包括：

• game.json: 游戏配置文件，包含游戏的基本设置，如屏幕适配、资源路径等。
• ui.json: UI 配置文件，包含 UI 界面的配置信息。
• audio.json: 音频配置文件，包含音频资源的配置信息。
• language.json: 多语言配置文件，包含多语言文本的配置信息。

配置文件示例

game.json

{
  "screen_adaptation": "fixed_width",
  "resource_path": "resources",
  "default_scene": "main"
}

ui.json

{
  "main_menu": {
    "prefab_path": "prefabs/main_menu",
    "scripts": ["MainMenuController"]
  }
}

audio.json

{
  "bgm": {
    "path": "audio/bgm",
    "loop": true
  },
  "sfx": {
    "path": "audio/sfx",
    "loop": false
  }
}

language.json

{
  "en": {
    "welcome": "Welcome to the game!"
  },
  "zh": {
    "welcome": "欢迎来到游戏！"
  }
}

以上是 oops-framework 开源项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该框架。