refactor: reorganize package structure and decouple framework packages (#338)
* refactor: reorganize package structure and decouple framework packages ## Package Structure Reorganization - Reorganized 55 packages into categorized subdirectories: - packages/framework/ - Generic framework (Laya/Cocos compatible) - packages/engine/ - ESEngine core modules - packages/rendering/ - Rendering modules (WASM dependent) - packages/physics/ - Physics modules - packages/streaming/ - World streaming - packages/network-ext/ - Network extensions - packages/editor/ - Editor framework and plugins - packages/rust/ - Rust WASM engine - packages/tools/ - Build tools and SDK ## Framework Package Decoupling - Decoupled behavior-tree and blueprint packages from ESEngine dependencies - Created abstracted interfaces (IBTAssetManager, IBehaviorTreeAssetContent) - ESEngine-specific code moved to esengine/ subpath exports - Framework packages now usable with Cocos/Laya without ESEngine ## CI Configuration - Updated CI to only type-check and lint framework packages - Added type-check:framework and lint:framework scripts ## Breaking Changes - Package import paths changed due to directory reorganization - ESEngine integrations now use subpath imports (e.g., '@esengine/behavior-tree/esengine') * fix: update es-engine file path after directory reorganization * docs: update README to focus on framework over engine * ci: only build framework packages, remove Rust/WASM dependencies * fix: remove esengine subpath from behavior-tree and blueprint builds ESEngine integration code will only be available in full engine builds. Framework packages are now purely engine-agnostic. * fix: move network-protocols to framework, build both in CI * fix: update workflow paths from packages/core to packages/framework/core * fix: exclude esengine folder from type-check in behavior-tree and blueprint * fix: update network tsconfig references to new paths * fix: add test:ci:framework to only test framework packages in CI * fix: only build core and math npm packages in CI * fix: exclude test files from CodeQL and fix string escaping security issue
This commit is contained in:
48
packages/engine/platform-common/README.md
Normal file
48
packages/engine/platform-common/README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# @esengine/platform-common
|
||||
|
||||
平台通用接口定义包,定义了所有平台子系统的接口规范。
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npm install @esengine/platform-common
|
||||
```
|
||||
|
||||
## 用途
|
||||
|
||||
此包仅包含 TypeScript 接口定义,供各平台适配器包实现:
|
||||
|
||||
- `@esengine/platform-wechat` - 微信小游戏
|
||||
- `@esengine/platform-web` - Web 浏览器
|
||||
- `@esengine/platform-bytedance` - 抖音小游戏
|
||||
|
||||
## 接口列表
|
||||
|
||||
### Canvas/渲染
|
||||
- `IPlatformCanvasSubsystem`
|
||||
- `IPlatformCanvas`
|
||||
- `IPlatformImage`
|
||||
|
||||
### 音频
|
||||
- `IPlatformAudioSubsystem`
|
||||
- `IPlatformAudioContext`
|
||||
|
||||
### 存储
|
||||
- `IPlatformStorageSubsystem`
|
||||
|
||||
### 网络
|
||||
- `IPlatformNetworkSubsystem`
|
||||
- `IPlatformWebSocket`
|
||||
|
||||
### 输入
|
||||
- `IPlatformInputSubsystem`
|
||||
|
||||
### 文件系统
|
||||
- `IPlatformFileSubsystem`
|
||||
|
||||
### WASM
|
||||
- `IPlatformWASMSubsystem`
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user