# oops-plugin-framework

**Repository Path**: zerozerg/oops-plugin-framework

## Basic Information

- **Project Name**: oops-plugin-framework
- **Description**: oops-framework-plugin 是基于 Cocos Creator 3.x 以插件形式使用的游戏框架，此版本框架代码与游戏具体业务逻辑代码分离，方便在项目开发过程随时更新框架最新版本代码。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 94
- **Created**: 2024-07-01
- **Last Updated**: 2024-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 介绍
Oops Framework 基于 Cocos Creator 3.x 开发的一款游戏框架。
1. 提供游戏常用功能库，提高开发效率
2. 提供业务模块代码模板，降低程序设计难度
3. 框架内置模块低耦合，可自行删减不需要的模块，以适应不同类型的游戏
4. 框架提供游戏常用插件工具
    - 热更新配置生成插件([传送门](https://gitee.com/dgflash/oops-plugin-hot-update))
    - 策划Excel配置表生成Json格式与配套ts代码插件([传送门](https://gitee.com/dgflash/oops-plugin-excel-to-json))

### [视频教程](https://www.bilibili.com/video/BV1WV4y1G7Gb/?spm_id_from=333.337.search-card.all.click&vd_source=2ecab277f9fb79c5e11c909bf0affd34)

#### 技术文档
- [oops-framework](https://oops-1255342636.cos.ap-shanghai.myqcloud.com/doc/oops-framework/index.html)
- [ecs](https://gitee.com/dgflash/oops-framework/tree/master/doc/ecs/ecs.md)
- [mvvm](https://gitee.com/dgflash/oops-framework/tree/master/doc/mvvm)
- [animator](https://github.com/LeeYip/cocos-animator/blob/master/README.md)

### 学习部署说明
1. 下载教程项目
```
git clone https://gitee.com/dgflash/oops-framework.git
```

2. 下载框架插件
    #### windows
    执行根目录下的 update-oops-plugin-framework.bat 下载最新版本框架插件
    
    #### mac
    项目下载后执行 update-oops-plugin-framework.sh 下载最新版本框架插件

### 开发部署说明
1. 下载游戏项目模板
```
git clone https://gitee.com/dgflash/oops-game-kit.git
```

2. 下载框架插件
    #### windows
    执行根目录下的 update-oops-plugin-framework.bat 下载最新版本框架插件
    
    #### mac
    项目下载后执行 update-oops-plugin-framework.sh 下载最新版本框架插件

### 框架目录结构
```
core               - 框加核心技术库
    common             - 游戏公共模块
        audio              - 音频模块
        event              - 全局事件
        loader             - 加载模块
        log                - 日志模块
        random             - 随机管理
        storage            - 本地存储
        timer              - 时间管理
    game               - 游戏世界类
    gui                - 游戏界面类
        layer              - 多层界面、窗口管理
        prompt             - 公共提示窗口
    utils              - 游戏各类工具库
    Oops.ts            - 框架功能访问接口
    Root.ts            - 框架视图层根节点管理组件
libs               - 框架中可选技术库
    animator           - 动画状态机
    animator-effect    - 动画特效组件
    animator-move      - 动画移动组件
    behavior-tree      - 行为树框架
    camera             - 三维摄像机控制组件
    collection         - 数据集合处理
    ecs                - ECS框架
    gui                - 界面组件
        badge              - 红点提示组件
        button             - 按钮组件
        label              - 标签组件
        language           - 多语言组件
    model-view         - MVVM框架
    network            - 网络模块
    render-texture     - 渲染纹理组件
module             - 游戏通用模块
    common             - 公共模块
    config             - 配置模块
```

### QQ群
- 798575969（1群） 
- 621415300（2群）
- 628575875（3群）
- 226524184（4群）

### QQ频道提供教程，持续更新（频道号：q366856bf5）


### 在线演示
[网络游戏全栈解决方案](https://store.cocos.com/app/detail/3814)

[角色扮演游戏解决方案 - 2D角色](https://store.cocos.com/app/detail/3675)

[角色扮演游戏解决方案 - 3D角色](https://store.cocos.com/app/detail/4139)

[新手引导解决方案](https://store.cocos.com/app/detail/3653)

[Tiledmap地图类游戏解决方案](https://store.cocos.com/app/detail/4428)

[开源框架 oops-framework gitee](https://gitee.com/dgflash/oops-framework)

[开源框架 oops-framework github](https://github.com/dgflash/oops-framework)