添加插件相关资源、文档菜单导航

2026-05-06 16:50:22 +08:00 · 2024-10-17 22:35:46 +08:00
parent 0d3da6e306
commit 1ed43d8b29
13 changed files with 248 additions and 85 deletions
--- a/README.md
+++ b/README.md
@@ -37,25 +37,11 @@ git clone https://gitee.com/dgflash/oops-game-kit.git
    项目下载后执行 update-oops-plugin-framework.sh 下载最新版本框架插件

 ### QQ群
- 798575969（1群 - 满） 
- 621415300（2群 - 满）
- 628575875（3群 - 满）
- 226524184（4群 - 推荐）
+- 798575969（1群）
+- 621415300（2群）
+- 628575875（3群）    
+- 226524184（4群）

-### QQ频道号：q366856bf5
+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)
+## [点击了解作者其它产品](https://store.cocos.com/app/search?name=oops)
--- a/assets/core/game/GameManager.ts
+++ b/assets/core/game/GameManager.ts
@@ -17,10 +17,12 @@ export class GameManager {

    /** 设置游戏动画速度 */
    setTimeScale(scale: number) {
+        //@ts-ignore
        director.globalGameTimeScale = scale;
    }
    /** 获取游戏动画速度 */
    getTimeScale() {
+        //@ts-ignore
        return director.globalGameTimeScale;
    }
 }
--- a/assets/module/common/GameComponent.ts
+++ b/assets/module/common/GameComponent.ts
@@ -167,7 +167,7 @@ export class GameComponent extends Component {
        }
    }

-    private getResKey(realBundle: string, realPath: string, resId?: number) {
+    private getResKey(realBundle: string, realPath: string, resId?: number): string {
        let key = `${realBundle}:${realPath}`;
        if (resId != null) key += ":" + resId;
        return key;
--- a/dist/main.js
+++ b/dist/main.js
@@ -1,20 +1,50 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unload = exports.load = exports.methods = void 0;
-/**
- * @en Registration method for the main process of Extension
- * @zh 为扩展的主进程的注册方法
- */
-exports.methods = {};
-/**
- * @en Hooks triggered after extension loading is complete
- * @zh 扩展加载完成后触发的钩子
- */
-const load = function () { };
-exports.load = load;
-/**
- * @en Hooks triggered after extension uninstallation is complete
- * @zh 扩展卸载完成后触发的钩子
- */
-const unload = function () { };
-exports.unload = unload;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.methods = exports.config = exports.unload = exports.load = void 0;
+const electron_1 = require("electron");
+/**
+ * @en Hooks triggered after extension loading is complete
+ * @zh 扩展加载完成后触发的钩子
+ */
+function load() { }
+exports.load = load;
+/**
+ * @en Hooks triggered after extension uninstallation is complete
+ * @zh 扩展卸载完成后触发的钩子
+ */
+function unload() { }
+exports.unload = unload;
+/**
+ * @en
+ * @zh 为扩展的主进程的注册方法
+ */
+exports.methods = {
+    /** 打开框架文档 */
+    document() {
+        electron_1.shell.openExternal('https://gitee.com/dgflash/oops-framework/wikis/pages');
+    },
+    /** 打开框架API文档 */
+    documentApi() {
+        electron_1.shell.openExternal('https://oops-1255342636.cos.ap-shanghai.myqcloud.com/doc/oops-framework/index.html');
+    },
+    /** 打开框架更新日志 */
+    log() {
+        electron_1.shell.openExternal('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12101082&doc_id=2873565');
+    },
+    /** 打开解决方案列表 */
+    solution() {
+        electron_1.shell.openExternal('https://store.cocos.com/app/search?name=oops');
+    },
+    /** 打开教程项目 */
+    tutorial() {
+        electron_1.shell.openExternal('https://store.cocos.com/app/detail/6647');
+    },
+    /** 点亮 Gitee 星星 */
+    gitee() {
+        electron_1.shell.openExternal('https://gitee.com/dgflash/oops-framework');
+    },
+    /** 点亮 Github 星星 */
+    github() {
+        electron_1.shell.openExternal('https://github.com/dgflash/oops-framework');
+    },
+};
--- a/i18n/en.js
+++ b/i18n/en.js
@@ -1,4 +1,12 @@
 "use strict";
-module.exports = { 
-    description: "Oops framework is based on Cocos creator 3 X development of a game framework." 
+module.exports = {
+    description: "Oops framework is based on Cocos creator 3 X development of a game framework.",
+    name: "Oops Framework",
+    document: "Document",
+    document_api: "API Document",
+    document_oops: "Framework Document",
+    solution: "Solution",
+    gitee: "Light up gitee stars",
+    github: "Light up github stars",
+    log: "Update Log",
 };
--- a/i18n/zh.js
+++ b/i18n/zh.js
@@ -5,6 +5,14 @@
 * @LastEditTime: 2022-06-14 19:41:18
 */
 "use strict";
-module.exports = { 
-    description: "Oops Framework 基于 Cocos Creator 3.x 开发的一款游戏框架"
+module.exports = {
+    description: "Oops Framework 基于 Cocos Creator 3.x 开发的一款游戏框架",
+    name: "Oops Framework",
+    document: "文档",
+    document_api: "API 文档",
+    document_oops: "框架文档",
+    solution: "解决方案",
+    gitee: "点亮 Gitee 星星",
+    github: "点亮 Github 星星",
+    log: "更新日志",
 };
--- a/package-lock.json
+++ b/package-lock.json
@@ -8,18 +8,18 @@
            "name": "oops-framework",
            "version": "1.0.0",
            "devDependencies": {
-                "@types/node": "^20.14.0",
+                "@types/node": "^20.16.12",
                "typedoc": "^0.23.24",
                "typescript": "^4.8.2"
            }
        },
        "node_modules/@types/node": {
-            "version": "20.14.0",
-            "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.0.tgz",
-            "integrity": "sha512-5cHBxFGJx6L4s56Bubp4fglrEpmyJypsqI6RgzMfBHWUJQGWAAi8cWcgetEbZXHYXo9C2Fa4EEds/uSyS4cxmA==",
+            "version": "20.16.12",
+            "resolved": "https://mirrors.cloud.tencent.com/npm/@types/node/-/node-20.16.12.tgz",
+            "integrity": "sha512-LfPFB0zOeCeCNQV3i+67rcoVvoN5n0NVuR2vLG0O5ySQMgchuZlC4lgz546ZOJyDtj5KIgOxy+lacOimfqZAIA==",
            "dev": true,
            "dependencies": {
-                "undici-types": "~5.26.4"
+                "undici-types": "~6.19.2"
            }
        },
        "node_modules/balanced-match": {
@@ -119,9 +119,9 @@
            }
        },
        "node_modules/undici-types": {
-            "version": "5.26.5",
-            "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
-            "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+            "version": "6.19.8",
+            "resolved": "https://mirrors.cloud.tencent.com/npm/undici-types/-/undici-types-6.19.8.tgz",
+            "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==",
            "dev": true
        },
        "node_modules/vscode-oniguruma": {
@@ -139,12 +139,12 @@
    },
    "dependencies": {
        "@types/node": {
-            "version": "20.14.0",
-            "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.0.tgz",
-            "integrity": "sha512-5cHBxFGJx6L4s56Bubp4fglrEpmyJypsqI6RgzMfBHWUJQGWAAi8cWcgetEbZXHYXo9C2Fa4EEds/uSyS4cxmA==",
+            "version": "20.16.12",
+            "resolved": "https://mirrors.cloud.tencent.com/npm/@types/node/-/node-20.16.12.tgz",
+            "integrity": "sha512-LfPFB0zOeCeCNQV3i+67rcoVvoN5n0NVuR2vLG0O5ySQMgchuZlC4lgz546ZOJyDtj5KIgOxy+lacOimfqZAIA==",
            "dev": true,
            "requires": {
-                "undici-types": "~5.26.4"
+                "undici-types": "~6.19.2"
            }
        },
        "balanced-match": {
@@ -219,9 +219,9 @@
            "dev": true
        },
        "undici-types": {
-            "version": "5.26.5",
-            "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
-            "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+            "version": "6.19.8",
+            "resolved": "https://mirrors.cloud.tencent.com/npm/undici-types/-/undici-types-6.19.8.tgz",
+            "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==",
            "dev": true
        },
        "vscode-oniguruma": {
--- a/package.json
+++ b/package.json
@@ -17,11 +17,79 @@
                "path": "./assets",
                "readonly": false
            }
+        },
+        "menu": [
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.document_oops",
+                "message": "document"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.document_api",
+                "message": "documentApi"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.solution",
+                "message": "solution"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.gitee",
+                "message": "gitee"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.github",
+                "message": "github"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "type": "separator"
+            },
+            {
+                "path": "i18n:oops-framework.name",
+                "label": "i18n:oops-framework.log",
+                "message": "log"
+            }
+        ],
+        "messages": {
+            "document": {
+                "methods": [
+                    "document"
+                ]
+            },
+            "documentApi": {
+                "methods": [
+                    "documentApi"
+                ]
+            },
+            "log": {
+                "methods": [
+                    "log"
+                ]
+            },
+            "solution": {
+                "methods": [
+                    "solution"
+                ]
+            },
+            "gitee": {
+                "methods": [
+                    "gitee"
+                ]
+            },
+            "github": {
+                "methods": [
+                    "github"
+                ]
+            }
        }
    },
    "devDependencies": {
-        "@types/node": "^20.14.0",
+        "@types/node": "^20.16.12",
        "typedoc": "^0.23.24",
        "typescript": "^4.8.2"
    }
-}
+}
--- a/src/main.ts
+++ b/src/main.ts
@@ -0,0 +1,50 @@
+import { shell } from "electron";
+
+/**
+ * @en Hooks triggered after extension loading is complete
+ * @zh 扩展加载完成后触发的钩子
+ */
+export function load() { }
+
+/**
+ * @en Hooks triggered after extension uninstallation is complete
+ * @zh 扩展卸载完成后触发的钩子
+ */
+export function unload() { }
+
+export var config: any;
+
+/**
+ * @en 
+ * @zh 为扩展的主进程的注册方法
+ */
+export const methods: { [key: string]: (...any: any) => any } = {
+    /** 打开框架文档 */
+    document() {
+        shell.openExternal('https://gitee.com/dgflash/oops-framework/wikis/pages');
+    },
+    /** 打开框架API文档 */
+    documentApi() {
+        shell.openExternal('https://oops-1255342636.cos.ap-shanghai.myqcloud.com/doc/oops-framework/index.html');
+    },
+    /** 打开框架更新日志 */
+    log() {
+        shell.openExternal('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12101082&doc_id=2873565');
+    },
+    /** 打开解决方案列表 */
+    solution() {
+        shell.openExternal('https://store.cocos.com/app/search?name=oops');
+    },
+    /** 打开教程项目 */
+    tutorial() {
+        shell.openExternal('https://store.cocos.com/app/detail/6647');
+    },
+    /** 点亮 Gitee 星星 */
+    gitee() {
+        shell.openExternal('https://gitee.com/dgflash/oops-framework');
+    },
+    /** 点亮 Github 星星 */
+    github() {
+        shell.openExternal('https://github.com/dgflash/oops-framework');
+    },
+};
--- a/temp/declarations/cc.d.ts
+++ b/temp/declarations/cc.d.ts
@@ -1,5 +1,5 @@

-    /// <reference path="D:\cocos_editor\Creator\3.8.3\resources\resources\3d\engine\bin\.declarations\cc.d.ts"/>
+    /// <reference path="D:\cocos-dashboard-editors\Creator\3.8.4\resources\resources\3d\engine\bin\.declarations\cc.d.ts"/>
    
    /**
     * @deprecated Global variable `cc` was dropped since 3.0. Use ES6 module syntax to import Cocos Creator APIs.
--- a/temp/declarations/jsb.d.ts
+++ b/temp/declarations/jsb.d.ts
@@ -1 +1 @@
-/// <reference path="D:\cocos_editor\Creator\3.8.3\resources\resources\3d\engine\@types\jsb.d.ts"/>
+/// <reference path="D:\cocos-dashboard-editors\Creator\3.8.4\resources\resources\3d\engine\@types\jsb.d.ts"/>
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -3,7 +3,7 @@
        "target": "ES2017",
        "module": "CommonJS",
        "outDir": "./dist",
-        "rootDir": "./",
+        "rootDir": "./src",
        "strict": true,
        "moduleResolution": "node",
        "esModuleInterop": true,
--- a/typedoc.ts.x
+++ b/typedoc.ts.x
@@ -1,15 +1,10 @@
-/*
- * @Author: dgflash
- * @Date: 2022-09-01 18:03:51
- * @LastEditors: dgflash
- * @LastEditTime: 2022-09-22 14:51:28
- */
-
 // 该文件用作typedoc的入口点模块——我们的API生成器
 // 注：为避免项目代码中引用到生成API文档的TS文件，所以后缀加了.x避免VsCode提示导入，生成文档时去掉.x即可
+// npx typedoc

 /** core/common */
 export * from './assets/core/common/audio/AudioEffect';
+export * from './assets/core/common/audio/AudioEffectPool';
 export * from './assets/core/common/audio/AudioManager';
 export * from './assets/core/common/audio/AudioMusic';
 export * from './assets/core/common/event/EventDispatcher';
@@ -18,13 +13,14 @@ export * from './assets/core/common/event/MessageManager';
 export * from './assets/core/common/loader/ResLoader';
 export * from './assets/core/common/log/Logger';
 export * from './assets/core/common/random/RandomManager';
-export * from './assets/core/common/timer/TimerManager';
-export * from './assets/core/common/timer/Timer';
+export * from './assets/core/common/random/SeedRandom';
 export * from './assets/core/common/storage/StorageManager';
+export * from './assets/core/common/storage/StorageSecuritySimple';
+export * from './assets/core/common/timer/Timer';
+export * from './assets/core/common/timer/TimerManager';
 /** core/game */
 export * from './assets/core/game/GameManager';
 /** core/gui */
-export * from './assets/core/gui/GUI';
 export * from './assets/core/gui/layer/Defines';
 export * from './assets/core/gui/layer/DelegateComponent';
 export * from './assets/core/gui/layer/LayerDialog';
@@ -32,16 +28,14 @@ export * from './assets/core/gui/layer/LayerManager';
 export * from './assets/core/gui/layer/LayerNotify';
 export * from './assets/core/gui/layer/LayerPopup';
 export * from './assets/core/gui/layer/LayerUI';
-export * from './assets/core/gui/layer/UIMap';
 export * from './assets/core/gui/prompt/CommonPrompt';
 export * from './assets/core/gui/prompt/LoadingIndicator';
 export * from './assets/core/gui/prompt/Notify';
-export * from './assets/core/Oops';
-export * from './assets/core/Root';
+// export * from './assets/core/Oops';
+// export * from './assets/core/Root';
 /** core/utils */
 export * from './assets/core/utils/ArrayUtil';
 export * from './assets/core/utils/CameraUtil';
-export * from './assets/core/utils/EncryptUtil';
 export * from './assets/core/utils/ImageUtil';
 export * from './assets/core/utils/JsonUtil';
 export * from './assets/core/utils/LayerUtil';
@@ -55,11 +49,10 @@ export * from './assets/core/utils/StringUtil';
 export * from './assets/core/utils/Vec3Util';
 export * from './assets/core/utils/ViewUtil';
 /** libs/animator-effect */
-export * from './assets/libs/animator-effect/Effect2DFollow3D';
-export * from './assets/libs/animator-effect/Effect2DFollow3D';
-export * from './assets/libs/animator-effect/EffectDelayRelease';
-export * from './assets/libs/animator-effect/EffectFinishedRelease';
-export * from './assets/libs/animator-effect/EffectSingleCase';
+// export * from './assets/libs/animator-effect/Effect2DFollow3D';
+// export * from './assets/libs/animator-effect/EffectDelayRelease';
+// export * from './assets/libs/animator-effect/EffectFinishedRelease';
+// export * from './assets/libs/animator-effect/EffectSingleCase';
 /** libs/collection */
 export * from './assets/libs/collection/AsyncQueue';
 export * from './assets/libs/collection/Collection';
@@ -68,6 +61,24 @@ export * from './assets/libs/ecs/ECS';
 export * from './assets/libs/ecs/ECSComp';
 export * from './assets/libs/ecs/ECSEntity';
 export * from './assets/libs/ecs/ECSSystem';
+/** libs/model-view */
+export * from './assets/libs/model-view/JsonOb';
+export * from './assets/libs/model-view/StringFormat';
+export * from './assets/libs/model-view/ui/BhvButtonGroup';
+export * from './assets/libs/model-view/ui/BhvFrameIndex';
+export * from './assets/libs/model-view/ui/BhvRollNumber';
+export * from './assets/libs/model-view/ui/BhvSwitchPage';
+export * from './assets/libs/model-view/ViewModel';
+export * from './assets/libs/model-view/VMBase';
+export * from './assets/libs/model-view/VMCompsEdit';
+export * from './assets/libs/model-view/VMCustom';
+export * from './assets/libs/model-view/VMEvent';
+export * from './assets/libs/model-view/VMLabel';
+export * from './assets/libs/model-view/VMModify';
+export * from './assets/libs/model-view/VMParent';
+export * from './assets/libs/model-view/VMProgress';
+export * from './assets/libs/model-view/VMState';
+
 /** module/network */
 export * from './assets/libs/network/HttpRequest';
 export * from './assets/libs/network/NetInterface';
@@ -84,4 +95,4 @@ export * from './assets/module/common/ModuleUtil';
 /** module/config */
 export * from './assets/module/config/Config';
 export * from './assets/module/config/GameConfig';
-export * from './assets/module/config/GameQueryConfig';
+export * from './assets/module/config/GameQueryConfig';