Bladeren bron

上传文件至 ''

初始化仓库
mojunshou 8 maanden geleden
bovenliggende
commit
67ededa2cf
5 gewijzigde bestanden met toevoegingen van 142 en 4 verwijderingen
  1. 21 0
      LICENSE
  2. 92 4
      README.md
  3. 13 0
      package.json
  4. 8 0
      tsconfig.json
  5. 8 0
      yarn.lock

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 dgflash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 92 - 4
README.md

@@ -1,4 +1,92 @@
-# Eliminate_gold_nuggets
-
-消消方块CocosCreator客户端项目
-引擎版本:3.8.5
+# oops-game-kit
+
+### 介绍
+基于 Oops Framework 提供的游戏项目开发模板,项目中提供了最新版本 Cocos Creator 3.x 插件与游戏资源初始化通用逻辑。
+
+### 使用Oops Framework创建游戏模板项目
+1. 下载模板项目
+```
+git clone https://gitee.com/dgflash/oops-game-kit.git
+```
+
+2. 下载框架插件
+#### windows
+- 执行 update-oops-plugin-framework.bat 克隆与更新框架插件
+- 执行 update-oops-plugin-hot-update.bat 克隆与更新热更新插件
+- 执行 update-oops-plugin-excel-to-json.bat 克隆与更新Excel转Json格式插件
+
+#### mac
+- 执行 update-oops-plugin-framework.sh 克隆与更新框架插件
+- 执行 update-oops-plugin-hot-update.sh 克隆与更新热更新插件
+- 执行 update-oops-plugin-excel-to-json.sh 克隆与更新Excel转Json格式插件
+
+### 模板项目目录结构
+```
+res                         - 预制引用的静态资源
+resources                   - 动态加载引用的资源
+    audio                       - 音乐资源
+    common                      - 公共资源
+    config                      - 配置资源
+        game                        - 游戏自定义内容配置数据表
+        config.json                 - 框架默认配置资源(可扩展内容)
+    content                     - 自定义动态加载内容资源
+    game                        - 核心玩法内容资源
+    gui                         - 界面资源
+        loading                     - 游戏初次加载界面
+    language                    - 多语言资源
+script                      - 游戏脚本
+    game                        - 游戏业务模块
+        common                      - 游戏公共模块
+            config                      - 游戏配置
+                GameEvent.ts                - 全局事件配置
+                GameUIConfig.ts             - 界面窗口配置(提供oops.gui模块使用的配置数据)
+            table                       - 游戏配置表对象(可通过oops-plugin-excel-to-json自动生成)
+        initialize                  - 游戏初始化模块
+        SingletonModuleComp.ts      - 游戏单例业务模块
+    Main.ts                     - 游戏入口脚本
+```
+
+根据上面的目录结构,在开发游戏时,可将资源存放到对应的文件夹中管理。这套模板项目自带以下游戏必备功能。
+- 屏幕自适应
+- 游戏本地配置数据获取
+- 游戏地址查询参数获取
+- 游戏初始化业务流程
+    - 初始可自定义资源加载提示界面
+- 加载与现实第一个游戏自定义界面
+
+### 屏幕自适应
+Cocos Creator 菜单->项目->项目设置
+#### 横屏自适应
+![](https://oops-1255342636.cos.ap-shanghai.myqcloud.com/img/kit/1.jpg)
+
+#### 竖屏自适应
+![](https://oops-1255342636.cos.ap-shanghai.myqcloud.com/img/kit/2.jpg)
+
+设置好后,其它的交给框架自动处理即可。
+
+### 游戏初始化模块
+#### 游戏启动时加载的必备资源
+initialize/bll/InitRes.ts
+
+这个脚本管理游戏启动时加载的必备资源,此处要注意的是,这里配置的资源尽量小一些,避免无提示加载阶段黑屏时间过长,导致游戏体验下降。
+- 加载公共资源
+- 加载多语言包(可选)
+- 加载自定义资源(可选)
+
+initialize/view/LoadingViewComp.ts
+
+这个脚本是游戏内容资源加载界面的控制脚本,游戏内容资源一般较大,会有加载进度条提示来提高游戏体验。所有资源加载完后,会通过执行以下脚本来显示游戏第一个自定义界面。
+```
+oops.gui.open(UIID.Demo);
+```
+
+### QQ群
+- 798575969(1群 - 满)
+- 621415300(2群 - 满)
+- 628575875(3群 - 满)
+- 226524184(4群-推荐)
+- 741197640(5群-推荐)
+
+### QQ频道:q366856bf5
+
+### [点击了解作者其它产品](https://store.cocos.com/app/search?name=oops)

+ 13 - 0
package.json

@@ -0,0 +1,13 @@
+{
+  "_sourceId": "c30b28da-749e-479b-bcb6-cecd8d7be9e3",
+  "creator": {
+    "version": "3.8.5"
+  },
+  "dependencies": {
+    "crypto-es": "^1.2.7"
+  },
+  "description": "消消金块游戏项目",
+  "name": "oops-game-kit",
+  "uuid": "00d7d957-a3e8-4ad6-80f4-2fcfb235bca4",
+  "version": "3.6.3"
+}

+ 8 - 0
tsconfig.json

@@ -0,0 +1,8 @@
+{
+  /* Base configuration. Do not edit this field. */
+  "extends": "./temp/tsconfig.cocos.json",
+  /* Add your custom configuration here. */
+  "compilerOptions": {
+    "strict": true
+  }
+}

+ 8 - 0
yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+crypto-es@^1.2.7:
+  version "1.2.7"
+  resolved "https://registry.yarnpkg.com/crypto-es/-/crypto-es-1.2.7.tgz#754a6d52319a94fb4eb1f119297f17196b360f88"
+  integrity sha512-UUqiVJ2gUuZFmbFsKmud3uuLcNP2+Opt+5ysmljycFCyhA0+T16XJmo1ev/t5kMChMqWh7IEvURNCqsg+SjZGQ==