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:
YHH
GitHub
43
packages/framework/network-protocols/package.json
Normal file
43
packages/framework/network-protocols/package.json
Normal file
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"name": "@esengine/network-protocols",
|
||||
"version": "1.0.0",
|
||||
"description": "Shared network protocols for client and server",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
"types": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"proto": "tsrpc proto --input src/shared/protocols --output src/shared/protocols/serviceProto.ts",
|
||||
"build": "tsup",
|
||||
"build:watch": "tsup --watch",
|
||||
"type-check": "tsc --noEmit",
|
||||
"clean": "rimraf dist"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@esengine/build-config": "workspace:*",
|
||||
"rimraf": "^5.0.5",
|
||||
"tsrpc-cli": "^2.4.5",
|
||||
"tsup": "^8.0.0",
|
||||
"typescript": "^5.3.3"
|
||||
},
|
||||
"keywords": [
|
||||
"ecs",
|
||||
"network",
|
||||
"protocols",
|
||||
"tsrpc"
|
||||
],
|
||||
"author": "yhh",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"tsrpc-proto": "^1.4.3"
|
||||
}
|
||||
}
|
||||
34
packages/framework/network-protocols/src/index.ts
Normal file
34
packages/framework/network-protocols/src/index.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
/**
|
||||
* @esengine/network-protocols
|
||||
*
|
||||
* 基于 TSRPC 的共享网络协议
|
||||
* TSRPC-based shared network protocols
|
||||
*/
|
||||
|
||||
// ============================================================================
|
||||
// Service Protocol | 服务协议
|
||||
// ============================================================================
|
||||
|
||||
export { serviceProto } from './shared/protocols/serviceProto';
|
||||
export type { ServiceType } from './shared/protocols/serviceProto';
|
||||
|
||||
// ============================================================================
|
||||
// Types | 类型定义
|
||||
// ============================================================================
|
||||
|
||||
export type { Vec2, IEntityState, IPlayerInput } from './shared/protocols/types';
|
||||
|
||||
// ============================================================================
|
||||
// API Protocols | API 协议
|
||||
// ============================================================================
|
||||
|
||||
export type { ReqJoin, ResJoin } from './shared/protocols/PtlJoin';
|
||||
|
||||
// ============================================================================
|
||||
// Message Protocols | 消息协议
|
||||
// ============================================================================
|
||||
|
||||
export type { MsgSync } from './shared/protocols/MsgSync';
|
||||
export type { MsgInput } from './shared/protocols/MsgInput';
|
||||
export type { MsgSpawn } from './shared/protocols/MsgSpawn';
|
||||
export type { MsgDespawn } from './shared/protocols/MsgDespawn';
|
||||
@@ -0,0 +1,9 @@
|
||||
/**
|
||||
* 销毁实体消息
|
||||
* Despawn entity message
|
||||
*/
|
||||
|
||||
export interface MsgDespawn {
|
||||
/** 网络 ID | Network ID */
|
||||
netId: number;
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
/**
|
||||
* 输入消息
|
||||
* Input message
|
||||
*/
|
||||
|
||||
import type { IPlayerInput } from './types';
|
||||
|
||||
export interface MsgInput {
|
||||
/** 玩家输入 | Player input */
|
||||
input: IPlayerInput;
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
/**
|
||||
* 生成实体消息
|
||||
* Spawn entity message
|
||||
*/
|
||||
|
||||
import type { Vec2 } from './types';
|
||||
|
||||
export interface MsgSpawn {
|
||||
/** 网络 ID | Network ID */
|
||||
netId: number;
|
||||
/** 所有者客户端 ID | Owner client ID */
|
||||
ownerId: number;
|
||||
/** 预制体类型 | Prefab type */
|
||||
prefab: string;
|
||||
/** 初始位置 | Initial position */
|
||||
pos: Vec2;
|
||||
/** 初始旋转 | Initial rotation */
|
||||
rot: number;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* 状态同步消息
|
||||
* State sync message
|
||||
*/
|
||||
|
||||
import type { IEntityState } from './types';
|
||||
|
||||
export interface MsgSync {
|
||||
/** 服务器时间戳 | Server timestamp */
|
||||
time: number;
|
||||
/** 实体状态列表 | Entity state list */
|
||||
entities: IEntityState[];
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* 加入房间 API
|
||||
* Join room API
|
||||
*/
|
||||
|
||||
/**
|
||||
* 加入请求
|
||||
* Join request
|
||||
*/
|
||||
export interface ReqJoin {
|
||||
/** 玩家名称 | Player name */
|
||||
playerName: string;
|
||||
/** 房间 ID（可选，不传则自动匹配）| Room ID (optional, auto-match if not provided) */
|
||||
roomId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 加入响应
|
||||
* Join response
|
||||
*/
|
||||
export interface ResJoin {
|
||||
/** 分配的客户端 ID | Assigned client ID */
|
||||
clientId: number;
|
||||
/** 房间 ID | Room ID */
|
||||
roomId: string;
|
||||
/** 房间当前玩家数 | Current player count in room */
|
||||
playerCount: number;
|
||||
}
|
||||
@@ -0,0 +1,268 @@
|
||||
import { ServiceProto } from 'tsrpc-proto';
|
||||
import { MsgDespawn } from './MsgDespawn';
|
||||
import { MsgInput } from './MsgInput';
|
||||
import { MsgSpawn } from './MsgSpawn';
|
||||
import { MsgSync } from './MsgSync';
|
||||
import { ReqJoin, ResJoin } from './PtlJoin';
|
||||
|
||||
export interface ServiceType {
|
||||
api: {
|
||||
"Join": {
|
||||
req: ReqJoin,
|
||||
res: ResJoin
|
||||
}
|
||||
},
|
||||
msg: {
|
||||
"Despawn": MsgDespawn,
|
||||
"Input": MsgInput,
|
||||
"Spawn": MsgSpawn,
|
||||
"Sync": MsgSync
|
||||
}
|
||||
}
|
||||
|
||||
export const serviceProto: ServiceProto<ServiceType> = {
|
||||
"services": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "Despawn",
|
||||
"type": "msg"
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Input",
|
||||
"type": "msg"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Spawn",
|
||||
"type": "msg"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "Sync",
|
||||
"type": "msg"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "Join",
|
||||
"type": "api"
|
||||
}
|
||||
],
|
||||
"types": {
|
||||
"MsgDespawn/MsgDespawn": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "netId",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"MsgInput/MsgInput": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "input",
|
||||
"type": {
|
||||
"type": "Reference",
|
||||
"target": "types/IPlayerInput"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"types/IPlayerInput": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "frame",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "moveDir",
|
||||
"type": {
|
||||
"type": "Reference",
|
||||
"target": "types/Vec2"
|
||||
},
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "actions",
|
||||
"type": {
|
||||
"type": "Array",
|
||||
"elementType": {
|
||||
"type": "String"
|
||||
}
|
||||
},
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"types/Vec2": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "x",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "y",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"MsgSpawn/MsgSpawn": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "netId",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "ownerId",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "prefab",
|
||||
"type": {
|
||||
"type": "String"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "pos",
|
||||
"type": {
|
||||
"type": "Reference",
|
||||
"target": "types/Vec2"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "rot",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"MsgSync/MsgSync": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "time",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "entities",
|
||||
"type": {
|
||||
"type": "Array",
|
||||
"elementType": {
|
||||
"type": "Reference",
|
||||
"target": "types/IEntityState"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"types/IEntityState": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "netId",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "pos",
|
||||
"type": {
|
||||
"type": "Reference",
|
||||
"target": "types/Vec2"
|
||||
},
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "rot",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
},
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"PtlJoin/ReqJoin": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "playerName",
|
||||
"type": {
|
||||
"type": "String"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "roomId",
|
||||
"type": {
|
||||
"type": "String"
|
||||
},
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"PtlJoin/ResJoin": {
|
||||
"type": "Interface",
|
||||
"properties": [
|
||||
{
|
||||
"id": 0,
|
||||
"name": "clientId",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"name": "roomId",
|
||||
"type": {
|
||||
"type": "String"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "playerCount",
|
||||
"type": {
|
||||
"type": "Number"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,39 @@
|
||||
/**
|
||||
* 共享类型定义
|
||||
* Shared type definitions
|
||||
*/
|
||||
|
||||
/**
|
||||
* 二维向量
|
||||
* 2D Vector
|
||||
*/
|
||||
export interface Vec2 {
|
||||
x: number;
|
||||
y: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 实体状态
|
||||
* Entity state
|
||||
*/
|
||||
export interface IEntityState {
|
||||
/** 网络 ID | Network ID */
|
||||
netId: number;
|
||||
/** 位置 | Position */
|
||||
pos?: Vec2;
|
||||
/** 旋转角度（弧度）| Rotation (radians) */
|
||||
rot?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* 玩家输入
|
||||
* Player input
|
||||
*/
|
||||
export interface IPlayerInput {
|
||||
/** 帧号 | Frame number */
|
||||
frame: number;
|
||||
/** 移动方向 | Move direction */
|
||||
moveDir?: Vec2;
|
||||
/** 动作列表 | Action list */
|
||||
actions?: string[];
|
||||
}
|
||||
13
packages/framework/network-protocols/tsconfig.build.json
Normal file
13
packages/framework/network-protocols/tsconfig.build.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"composite": false,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"moduleResolution": "node"
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
11
packages/framework/network-protocols/tsconfig.json
Normal file
11
packages/framework/network-protocols/tsconfig.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"composite": true,
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"moduleResolution": "node"
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
11
packages/framework/network-protocols/tsup.config.ts
Normal file
11
packages/framework/network-protocols/tsup.config.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/index.ts'],
|
||||
format: ['esm', 'cjs'],
|
||||
dts: true,
|
||||
splitting: false,
|
||||
sourcemap: true,
|
||||
clean: true,
|
||||
tsconfig: 'tsconfig.build.json'
|
||||
});
|
||||
Reference in New Issue
Block a user