* 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
79 lines
2.3 KiB
TypeScript
79 lines
2.3 KiB
TypeScript
/**
|
|
* @zh Script Runtime 模块服务令牌
|
|
* @en Script Runtime module service tokens
|
|
*
|
|
* @zh 遵循"谁定义接口,谁导出 Token"原则
|
|
* @en Following "who defines interface, who exports Token" principle
|
|
*/
|
|
|
|
import { createServiceToken } from '@esengine/ecs-framework';
|
|
|
|
import type { ServerBlueprintVM } from './vm/ServerBlueprintVM';
|
|
import type { IMemoryStore } from './persistence/IMemoryStore';
|
|
|
|
// =============================================================================
|
|
// 服务接口 | Service Interfaces
|
|
// =============================================================================
|
|
|
|
/**
|
|
* @zh 脚本运行时服务接口
|
|
* @en Script runtime service interface
|
|
*/
|
|
export interface IScriptRuntimeService {
|
|
/**
|
|
* @zh 为玩家创建 VM
|
|
* @en Create VM for player
|
|
*/
|
|
createPlayerVM(playerId: string, blueprintPath: string): Promise<ServerBlueprintVM>;
|
|
|
|
/**
|
|
* @zh 获取玩家的 VM
|
|
* @en Get player's VM
|
|
*/
|
|
getPlayerVM(playerId: string): ServerBlueprintVM | undefined;
|
|
|
|
/**
|
|
* @zh 移除玩家的 VM
|
|
* @en Remove player's VM
|
|
*/
|
|
removePlayerVM(playerId: string): void;
|
|
|
|
/**
|
|
* @zh 获取所有活跃玩家 ID
|
|
* @en Get all active player IDs
|
|
*/
|
|
getActivePlayerIds(): string[];
|
|
}
|
|
|
|
// =============================================================================
|
|
// 服务令牌 | Service Tokens
|
|
// =============================================================================
|
|
|
|
/**
|
|
* @zh 脚本运行时服务令牌
|
|
* @en Script runtime service token
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { ScriptRuntimeServiceToken } from '@esengine/script-runtime';
|
|
*
|
|
* const service = context.services.get(ScriptRuntimeServiceToken);
|
|
* const vm = await service.createPlayerVM('player1', 'blueprints/main.bp');
|
|
* ```
|
|
*/
|
|
export const ScriptRuntimeServiceToken = createServiceToken<IScriptRuntimeService>('scriptRuntimeService');
|
|
|
|
/**
|
|
* @zh Memory 存储服务令牌
|
|
* @en Memory store service token
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { MemoryStoreToken } from '@esengine/script-runtime';
|
|
*
|
|
* const store = context.services.get(MemoryStoreToken);
|
|
* const memory = await store.loadPlayerMemory('player1');
|
|
* ```
|
|
*/
|
|
export const MemoryStoreToken = createServiceToken<IMemoryStore>('memoryStore');
|