diff --git a/README.md b/README.md index eb26ad9..6b977f1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,45 @@ + #### 介绍 -oops-plugin-framework 是基于 Cocos Creator 3.x 以插件形式使用的游戏框架，此版本框架代码与游戏具体业务逻辑代码分离，方便在项目开发过程随时更新框架最新版本代码。 +Oops Framework 基于 Cocos Creato 3.x 开发的一款游戏框架。 +1. 提供游戏常用功能库，提高开发效率 +2. 提供业务模块代码模板，降低程序设计难度 +3. 框架内置模块低耦合，可自行删减不需要的模块，适应不同类型的游 +4. 框架提供游戏常用插件工具 + - 热更新配置生成插件 + - 策划Excel配置表生成Json格式与配套ts代码插件 #### 技术文档 -- [oops-framework update](https://gitee.com/dgflash/oops-framework/tree/master/doc/using.md) -- [oops-framework](https://gitee.com/dgflash/oops-framework/tree/master/doc/core) +- [oops-framework](https://dgflash.gitee.io/oops-plugin-framework/) - [ecs](https://gitee.com/dgflash/oops-framework/tree/master/doc/ecs/ecs.md) - [mvvm](https://gitee.com/dgflash/oops-framework/tree/master/doc/mvvm) +#### 使用说明 +1. 下载教程项目 +``` +git clone https://gitee.com/dgflash/oops-framework.git +``` + +2. 下载框架插件 + ##### windows + 执行根目录下的 update-oops-plugin-framework.bat 下载最新版本框架插件 + + ##### mac + 项目下载后执行 update-oops-plugin-framework.sh 下载最新版本框架插件 + +#### 在线演示 +- [框架部分功能演示](https://oops-1255342636.cos-website.ap-shanghai.myqcloud.com/oops-framework/) +- [全栈解决方案 oops-moba](https://store.cocos.com/app/detail/3814) +- [游戏地图模块 oops-rpg-2d](https://store.cocos.com/app/detail/3675) +- [游戏地图模块 oops-rpg-3d](https://oops-1255342636.cos-website.ap-shanghai.myqcloud.com/oops-solution/?type=2) +- [新手引导模块 oops-guide](https://store.cocos.com/app/detail/3653) +- [开源框架 oops-framework gitee](https://gitee.com/dgflash/oops-framework) +- [开源框架 oops-framework github](https://github.com/dgflash/oops-framework) + ### 框架目录结构 ``` core - 框加核心技术库 @@ -46,5 +79,6 @@ module - 游戏通用模块 config - 配置模块 ``` -#### 学习交流 QQ 群：798575969 -![](http://dgflash.gitee.io/oops-full-stack-web/doc/img/qq.png) +1. 学习交流 QQ 群：798575969 + + ![](http://dgflash.gitee.io/oops-full-stack-web/doc/img/qq.png) \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 6460384..55285e5 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -3,24 +3,24 @@ --dark-hl-0: #9CDCFE; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; - --light-hl-2: #267F99; - --dark-hl-2: #4EC9B0; - --light-hl-3: #AF00DB; - --dark-hl-3: #C586C0; - --light-hl-4: #A31515; - --dark-hl-4: #CE9178; - --light-hl-5: #795E26; - --dark-hl-5: #DCDCAA; - --light-hl-6: #0000FF; - --dark-hl-6: #569CD6; - --light-hl-7: #098658; - --dark-hl-7: #B5CEA8; - --light-hl-8: #0070C1; - --dark-hl-8: #4FC1FF; - --light-hl-9: #008000; - --dark-hl-9: #6A9955; - --light-hl-10: #000000; - --dark-hl-10: #C8C8C8; + --light-hl-2: #000000; + --dark-hl-2: #C8C8C8; + --light-hl-3: #008000; + --dark-hl-3: #6A9955; + --light-hl-4: #267F99; + --dark-hl-4: #4EC9B0; + --light-hl-5: #AF00DB; + --dark-hl-5: #C586C0; + --light-hl-6: #A31515; + --dark-hl-6: #CE9178; + --light-hl-7: #795E26; + --dark-hl-7: #DCDCAA; + --light-hl-8: #0000FF; + --dark-hl-8: #569CD6; + --light-hl-9: #098658; + --dark-hl-9: #B5CEA8; + --light-hl-10: #0070C1; + --dark-hl-10: #4FC1FF; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } diff --git a/docs/classes/AudioEffect.html b/docs/classes/AudioEffect.html index 880fae6..2abd890 100644 --- a/docs/classes/AudioEffect.html +++ b/docs/classes/AudioEffect.html @@ -228,7 +228,7 @@

Zh

该组件被附加到的节点。组件总会附加到一个节点。

-

Example

import { log } from 'cc';
log(comp.node);
+
Example
import { log } from 'cc';
log(comp.node);