feat: 添加跨平台运行时、资产系统和UI适配功能 (#256)
* feat(platform-common): 添加WASM加载器和环境检测API * feat(rapier2d): 新增Rapier2D WASM绑定包 * feat(physics-rapier2d): 添加跨平台WASM加载器 * feat(asset-system): 添加运行时资产目录和bundle格式 * feat(asset-system-editor): 新增编辑器资产管理包 * feat(editor-core): 添加构建系统和模块管理 * feat(editor-app): 重构浏览器预览使用import maps * feat(platform-web): 添加BrowserRuntime和资产读取 * feat(engine): 添加材质系统和着色器管理 * feat(material): 新增材质系统和着色器编辑器 * feat(tilemap): 增强tilemap编辑器和动画系统 * feat(modules): 添加module.json配置 * feat(core): 添加module.json和类型定义更新 * chore: 更新依赖和构建配置 * refactor(plugins): 更新插件模板使用ModuleManifest * chore: 添加第三方依赖库 * chore: 移除BehaviourTree-ai和ecs-astar子模块 * docs: 更新README和文档主题样式 * fix: 修复Rust文档测试和添加rapier2d WASM绑定 * fix(tilemap-editor): 修复画布高DPI屏幕分辨率适配问题 * feat(ui): 添加UI屏幕适配系统(CanvasScaler/SafeArea) * fix(ecs-engine-bindgen): 添加缺失的ecs-framework-math依赖 * fix: 添加缺失的包依赖修复CI构建 * fix: 修复CodeQL检测到的代码问题 * fix: 修复构建错误和缺失依赖 * fix: 修复类型检查错误 * fix(material-system): 修复tsconfig配置支持TypeScript项目引用 * fix(editor-core): 修复Rollup构建配置添加tauri external * fix: 修复CodeQL检测到的代码问题 * fix: 修复CodeQL检测到的代码问题
This commit is contained in:
YHH
GitHub
38
packages/engine-core/module.json
Normal file
38
packages/engine-core/module.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"id": "engine-core",
|
||||
"name": "@esengine/engine-core",
|
||||
"displayName": "Engine Core",
|
||||
"description": "Engine lifecycle, scene management, game loop | 引擎生命周期、场景管理、游戏循环",
|
||||
"version": "1.0.0",
|
||||
"category": "Core",
|
||||
"icon": "Cpu",
|
||||
"tags": [
|
||||
"engine",
|
||||
"scene",
|
||||
"gameloop"
|
||||
],
|
||||
"isCore": true,
|
||||
"defaultEnabled": true,
|
||||
"isEngineModule": true,
|
||||
"canContainContent": false,
|
||||
"platforms": [
|
||||
"web",
|
||||
"desktop",
|
||||
"mobile"
|
||||
],
|
||||
"dependencies": [
|
||||
"core",
|
||||
"math"
|
||||
],
|
||||
"exports": {
|
||||
"other": [
|
||||
"Engine",
|
||||
"Scene",
|
||||
"SceneManager",
|
||||
"GameLoop",
|
||||
"Time"
|
||||
]
|
||||
},
|
||||
"requiresWasm": false,
|
||||
"outputPath": "dist/index.js"
|
||||
}
|
||||
@@ -8,27 +8,7 @@
|
||||
|
||||
import type { ComponentRegistry as ComponentRegistryType, IScene, ServiceContainer } from '@esengine/ecs-framework';
|
||||
import { TransformComponent } from './TransformComponent';
|
||||
|
||||
// ============================================================================
|
||||
// 基础类型 | Basic Types
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* 插件类别
|
||||
* Plugin category
|
||||
*/
|
||||
export type PluginCategory =
|
||||
| 'core' // 核心功能 | Core functionality
|
||||
| 'rendering' // 渲染相关 | Rendering
|
||||
| 'ui' // UI 系统 | UI System
|
||||
| 'ai' // AI/行为树 | AI/Behavior
|
||||
| 'physics' // 物理引擎 | Physics
|
||||
| 'audio' // 音频系统 | Audio
|
||||
| 'networking' // 网络功能 | Networking
|
||||
| 'tools' // 工具/编辑器扩展 | Tools/Editor extensions
|
||||
| 'scripting' // 脚本/蓝图 | Scripting/Blueprint
|
||||
| 'tilemap' // 瓦片地图 | Tilemap
|
||||
| 'content'; // 内容/资源 | Content/Assets
|
||||
import type { ModuleManifest } from './ModuleManifest';
|
||||
|
||||
/**
|
||||
* 加载阶段 - 控制插件模块的加载顺序
|
||||
@@ -41,80 +21,6 @@ export type LoadingPhase =
|
||||
| 'postDefault' // 默认之后 | After default
|
||||
| 'postEngine'; // 引擎初始化后 | After engine init
|
||||
|
||||
/**
|
||||
* 模块类型
|
||||
* Module type
|
||||
*/
|
||||
export type ModuleType = 'runtime' | 'editor';
|
||||
|
||||
/**
|
||||
* 模块描述符
|
||||
* Module descriptor
|
||||
*/
|
||||
export interface ModuleDescriptor {
|
||||
/** 模块名称 | Module name */
|
||||
name: string;
|
||||
/** 模块类型 | Module type */
|
||||
type: ModuleType;
|
||||
/** 加载阶段 | Loading phase */
|
||||
loadingPhase?: LoadingPhase;
|
||||
}
|
||||
|
||||
/**
|
||||
* 插件依赖
|
||||
* Plugin dependency
|
||||
*/
|
||||
export interface PluginDependency {
|
||||
/** 依赖的插件ID | Dependent plugin ID */
|
||||
id: string;
|
||||
/** 版本要求 | Version requirement */
|
||||
version?: string;
|
||||
/** 是否可选 | Optional */
|
||||
optional?: boolean;
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// 插件描述符 | Plugin Descriptor
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* 插件描述符
|
||||
* Plugin descriptor
|
||||
*
|
||||
* 所有字段都是可选的，PluginManager 会填充默认值。
|
||||
* All fields are optional, PluginManager will fill in defaults.
|
||||
*/
|
||||
export interface PluginDescriptor {
|
||||
/** 插件唯一标识符 | Unique plugin ID */
|
||||
id: string;
|
||||
/** 显示名称 | Display name */
|
||||
name: string;
|
||||
/** 版本号 | Version */
|
||||
version: string;
|
||||
/** 描述 | Description */
|
||||
description?: string;
|
||||
/** 插件类别 | Plugin category */
|
||||
category?: PluginCategory;
|
||||
/** 标签（用于搜索） | Tags (for search) */
|
||||
tags?: string[];
|
||||
/** 图标（Lucide 图标名） | Icon (Lucide icon name) */
|
||||
icon?: string;
|
||||
/** 是否默认启用 | Enabled by default */
|
||||
enabledByDefault?: boolean;
|
||||
/** 是否可以包含内容资产 | Can contain content assets */
|
||||
canContainContent?: boolean;
|
||||
/** 是否为引擎内置插件 | Is engine built-in plugin */
|
||||
isEnginePlugin?: boolean;
|
||||
/** 是否为核心插件（不可禁用） | Is core plugin (cannot be disabled) */
|
||||
isCore?: boolean;
|
||||
/** 模块列表 | Module list */
|
||||
modules?: ModuleDescriptor[];
|
||||
/** 依赖列表 | Dependency list */
|
||||
dependencies?: PluginDependency[];
|
||||
/** 平台要求 | Platform requirements */
|
||||
platforms?: ('web' | 'desktop' | 'mobile')[];
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// 系统上下文 | System Context
|
||||
// ============================================================================
|
||||
@@ -192,8 +98,8 @@ export interface IRuntimeModule {
|
||||
* This is the unified type that all plugin packages export.
|
||||
*/
|
||||
export interface IPlugin {
|
||||
/** 插件描述符 | Plugin descriptor */
|
||||
readonly descriptor: PluginDescriptor;
|
||||
/** 模块清单 | Module manifest */
|
||||
readonly manifest: ModuleManifest;
|
||||
/** 运行时模块（可选） | Runtime module (optional) */
|
||||
readonly runtimeModule?: IRuntimeModule;
|
||||
/** 编辑器模块（可选，类型为 any 以避免循环依赖） | Editor module (optional, typed as any to avoid circular deps) */
|
||||
@@ -210,18 +116,25 @@ class EngineRuntimeModule implements IRuntimeModule {
|
||||
}
|
||||
}
|
||||
|
||||
const descriptor: PluginDescriptor = {
|
||||
id: '@esengine/engine-core',
|
||||
name: 'Engine Core',
|
||||
version: '1.0.0',
|
||||
const manifest: ModuleManifest = {
|
||||
id: 'engine-core',
|
||||
name: '@esengine/engine-core',
|
||||
displayName: 'Engine Core',
|
||||
description: 'Transform 等核心组件',
|
||||
category: 'core',
|
||||
enabledByDefault: true,
|
||||
isEnginePlugin: true,
|
||||
isCore: true
|
||||
version: '1.0.0',
|
||||
category: 'Core',
|
||||
icon: 'Box',
|
||||
isCore: true,
|
||||
defaultEnabled: true,
|
||||
isEngineModule: true,
|
||||
dependencies: ['core', 'math'],
|
||||
exports: {
|
||||
components: ['TransformComponent', 'HierarchyComponent'],
|
||||
systems: ['TransformSystem', 'HierarchySystem']
|
||||
}
|
||||
};
|
||||
|
||||
export const EnginePlugin: IPlugin = {
|
||||
descriptor,
|
||||
manifest,
|
||||
runtimeModule: new EngineRuntimeModule()
|
||||
};
|
||||
|
||||
196
packages/engine-core/src/ModuleManifest.ts
Normal file
196
packages/engine-core/src/ModuleManifest.ts
Normal file
@@ -0,0 +1,196 @@
|
||||
/**
|
||||
* Module Manifest Types.
|
||||
* 模块清单类型定义。
|
||||
*
|
||||
* This is the single source of truth for module/plugin configuration.
|
||||
* Each engine module should have a module.json file containing this information.
|
||||
* 这是模块/插件配置的唯一数据源。
|
||||
* 每个引擎模块应该有一个包含此信息的 module.json 文件。
|
||||
*/
|
||||
|
||||
/**
|
||||
* Module category for organization in UI.
|
||||
* 用于 UI 组织的模块分类。
|
||||
*/
|
||||
export type ModuleCategory =
|
||||
| 'Core'
|
||||
| 'Rendering'
|
||||
| 'Physics'
|
||||
| 'AI'
|
||||
| 'Audio'
|
||||
| 'Networking'
|
||||
| 'Other';
|
||||
|
||||
/**
|
||||
* Platform requirements for the module.
|
||||
* 模块的平台要求。
|
||||
*/
|
||||
export type ModulePlatform = 'web' | 'desktop' | 'mobile';
|
||||
|
||||
/**
|
||||
* Module exports definition.
|
||||
* 模块导出定义。
|
||||
*/
|
||||
export interface ModuleExports {
|
||||
/** Exported component classes | 导出的组件类 */
|
||||
components?: string[];
|
||||
|
||||
/** Exported system classes | 导出的系统类 */
|
||||
systems?: string[];
|
||||
|
||||
/** Exported asset loaders | 导出的资源加载器 */
|
||||
loaders?: string[];
|
||||
|
||||
/** Other exported items | 其他导出项 */
|
||||
other?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Module manifest definition (Unified Plugin/Module config).
|
||||
* 模块清单定义（统一的插件/模块配置）。
|
||||
*
|
||||
* This interface matches the structure of module.json files.
|
||||
* 此接口匹配 module.json 文件的结构。
|
||||
*/
|
||||
export interface ModuleManifest {
|
||||
// ==================== Core Identifiers ====================
|
||||
|
||||
/** Unique module identifier | 唯一模块标识符 */
|
||||
id: string;
|
||||
|
||||
/** Package name (npm style) | 包名（npm 风格） */
|
||||
name: string;
|
||||
|
||||
/** Display name for UI | UI 显示名称 */
|
||||
displayName: string;
|
||||
|
||||
/** Module description | 模块描述 */
|
||||
description: string;
|
||||
|
||||
/** Module version | 模块版本 */
|
||||
version: string;
|
||||
|
||||
// ==================== Classification ====================
|
||||
|
||||
/** Category for grouping in UI | UI 分组分类 */
|
||||
category: ModuleCategory;
|
||||
|
||||
/** Tags for search and filtering | 用于搜索和过滤的标签 */
|
||||
tags?: string[];
|
||||
|
||||
/** Icon name (Lucide icon) | 图标名（Lucide 图标） */
|
||||
icon?: string;
|
||||
|
||||
// ==================== Lifecycle ====================
|
||||
|
||||
/** Whether this is a core module (cannot be disabled) | 是否为核心模块（不能禁用） */
|
||||
isCore: boolean;
|
||||
|
||||
/** Whether enabled by default in new projects | 新项目中是否默认启用 */
|
||||
defaultEnabled: boolean;
|
||||
|
||||
/** Whether this is an engine built-in module | 是否为引擎内置模块 */
|
||||
isEngineModule?: boolean;
|
||||
|
||||
// ==================== Content ====================
|
||||
|
||||
/** Whether this module can contain content/assets | 是否可以包含内容/资源 */
|
||||
canContainContent?: boolean;
|
||||
|
||||
/** Platform requirements | 平台要求 */
|
||||
platforms?: ModulePlatform[];
|
||||
|
||||
// ==================== Dependencies ====================
|
||||
|
||||
/** Module IDs this module depends on | 此模块依赖的模块 ID */
|
||||
dependencies: string[];
|
||||
|
||||
/**
|
||||
* External package dependencies that need to be included in import map.
|
||||
* 需要包含在 import map 中的外部包依赖。
|
||||
*
|
||||
* These are runtime dependencies that are dynamically imported by the module.
|
||||
* 这些是模块动态导入的运行时依赖。
|
||||
*
|
||||
* Example: ["@esengine/rapier2d"]
|
||||
*/
|
||||
externalDependencies?: string[];
|
||||
|
||||
// ==================== Exports ====================
|
||||
|
||||
/** Exported items for dependency checking | 导出项用于依赖检查 */
|
||||
exports: ModuleExports;
|
||||
|
||||
// ==================== Editor Integration ====================
|
||||
|
||||
/**
|
||||
* Associated editor package name.
|
||||
* 关联的编辑器包名。
|
||||
* e.g., "@esengine/tilemap-editor" for "@esengine/tilemap"
|
||||
*/
|
||||
editorPackage?: string;
|
||||
|
||||
// ==================== Performance (auto-calculated at build time) ====================
|
||||
// ==================== 性能（构建时自动计算） ====================
|
||||
|
||||
/** JS bundle size in bytes | JS 包大小（字节） */
|
||||
jsSize?: number;
|
||||
|
||||
/** Whether this module requires WASM | 是否需要 WASM */
|
||||
requiresWasm?: boolean;
|
||||
|
||||
/** WASM file size in bytes | WASM 文件大小（字节） */
|
||||
wasmSize?: number;
|
||||
|
||||
/**
|
||||
* WASM file paths relative to module's node_modules or package root.
|
||||
* WASM 文件路径，相对于模块的 node_modules 或包根目录。
|
||||
*
|
||||
* Can be glob patterns like "*.wasm" or specific paths.
|
||||
* 可以是 glob 模式如 "*.wasm" 或具体路径。
|
||||
*
|
||||
* Example: ["@dimforge/rapier2d-compat/*.wasm"]
|
||||
*/
|
||||
wasmPaths?: string[];
|
||||
|
||||
/**
|
||||
* Runtime WASM path relative to game output root.
|
||||
* 运行时 WASM 路径，相对于游戏输出根目录。
|
||||
*
|
||||
* Build pipeline copies WASM to this location.
|
||||
* 构建管线将 WASM 复制到此位置。
|
||||
*
|
||||
* Example: "wasm/rapier_wasm2d_bg.wasm"
|
||||
*/
|
||||
runtimeWasmPath?: string;
|
||||
|
||||
// ==================== Build Configuration ====================
|
||||
// ==================== 构建配置 ====================
|
||||
|
||||
/**
|
||||
* Output path for the built module file.
|
||||
* 构建后模块文件的输出路径。
|
||||
*
|
||||
* Example: "dist/index.mjs"
|
||||
*/
|
||||
outputPath?: string;
|
||||
|
||||
/**
|
||||
* Plugin export name for dynamic loading.
|
||||
* 用于动态加载的插件导出名。
|
||||
*
|
||||
* Example: "SpritePlugin"
|
||||
*/
|
||||
pluginExport?: string;
|
||||
|
||||
/**
|
||||
* Additional files to include when copying module.
|
||||
* 复制模块时需要包含的额外文件。
|
||||
*
|
||||
* Glob patterns relative to the module's dist directory.
|
||||
* 相对于模块 dist 目录的 glob 模式。
|
||||
*
|
||||
* Example: ["chunk-*.js", "worker.js"]
|
||||
*/
|
||||
includes?: string[];
|
||||
}
|
||||
@@ -5,13 +5,16 @@ export { HierarchySystem } from './HierarchySystem';
|
||||
export {
|
||||
EnginePlugin,
|
||||
// 类型导出
|
||||
type PluginCategory,
|
||||
type LoadingPhase,
|
||||
type ModuleType,
|
||||
type ModuleDescriptor,
|
||||
type PluginDependency,
|
||||
type PluginDescriptor,
|
||||
type SystemContext,
|
||||
type IRuntimeModule,
|
||||
type IPlugin
|
||||
} from './EnginePlugin';
|
||||
|
||||
// Module Manifest types (unified module/plugin configuration)
|
||||
export {
|
||||
type ModuleManifest,
|
||||
type ModuleCategory,
|
||||
type ModulePlatform,
|
||||
type ModuleExports
|
||||
} from './ModuleManifest';
|
||||
|
||||
Reference in New Issue
Block a user