# cococs-creator-frame-2D

**Repository Path**: cocos2d-zp/cococs-creator-frame-2d

## Basic Information

- **Project Name**: cococs-creator-frame-2D
- **Description**: CocosCreator2.4.x前端框架
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 2
- **Created**: 2021-07-17
- **Last Updated**: 2025-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 1、可定制的首屏加载、优秀的加载性能
## 2、一套强大的UI、音频、资源管理系统
## 3、将Mobx的API定制为CocosCreator可用的装饰器，实现MVVM
## 4、完整的文件存储结构定义及插件自动化
___

# 框架目录说明：
> ### app
- app目录下存放的代码基本都是脱离于业务的，是整个框架的核心区域
- 此目录下需要细心维护，避免遭到污染，非核心开发者避免修改此文件夹下
  - [base目录]      用来存放游戏主要框架用到的所有基类
  - [manager目录]   用来存放核心manager，可通过app.manager调用
  - [app]           负责导出executor、setting的内容，一般业务中只需要都是通过app来调用各模块的
  - [executor]      是让整个框架串联在一起的核心文件，它确保各模块可以被正确的调用
  - [decorator]     框架中用到的所有装饰器都存于此处
  - [lib目录]       用来存放核心库文件，可通过app.lib调用

> ### app-appinit
- 游戏初始化界面，负责初始化manager(必须加载完所有manager才能进入游戏)
> ### app-configure
- handle文件负责一些状态回调
- setting文件负责配置一些核心基础设置信息，可通过app.setting调用
> ### app-extend
- com 用来存放游戏内可能用到的通用组件
- control 用来存放游戏内可能用到的通用控件
- module 用来存放一些库，这些库可根据项目需要进行清理，这些库只能require或import
> ### app-manager
- 用户manager的存储位置，可通过app.manager调用
> ### app-model
- model目录下存放的是data和config，游戏需要用到的数据和配置都可以存在这里
> ### app-scene
- 场景
> ### app-sound
- 用来存放音乐音效文件，由app.manager.sound负责管理
> ### app-view
- 用来存放用户界面，由app.manager.ui负责管理
> ### res-bundle
- 用来存放自定义budle
> ### res-native
- 用来存放静态资源

# 框架自动化：
- 在菜单中找到```App```菜单，里面提供了创建和更新两个功能，其中:
  - 更新中提供了一键更新executor的功能，一般情况下不需要手动调用
  - 创建包含创建View、创建Manager、创建Model
---
# 开始使用：
- 1、```UI、Manager、Model、Control```通过菜单App负责创建.
- 2、UI脚本是完全隔离的, 在外部没法直接调用UI脚本, 可以通过创建```Control```来负责UI与外部的信息交互.
- 3、```setting.ts```中可以定义默认UI或默认音乐, 一般只设置默认UI即可(例如PageGame).
- 4、```Paper```是Page的扩展层, 用于辅助Page显示, 多利用Paper可有效解决冲突问题.
- 5、```AppInit```是入口程序, 通过它可以进行游戏开始前的自定义加载.
- 6、框架内的东西都可以通过```app.```的方式调用.