@esengine/ecs-framework 2.0.3 → 2.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esengine/ecs-framework",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "用于Laya、Cocos等游戏引擎的高性能ECS框架",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/README.md

@@ -1,277 +0,0 @@
-# ECS Framework
-
-[![npm version](https://badge.fury.io/js/%40esengine%2Fecs-framework.svg)](https://badge.fury.io/js/%40esengine%2Fecs-framework)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-一个轻量级的 TypeScript ECS（Entity-Component-System）框架，专为小游戏开发设计，适用于 Laya、Cocos 等游戏引擎。
-
-## ✨ 特性
-
-- 🚀 **轻量级 ECS 架构** - 基于实体组件系统，提供清晰的代码结构
-- 📡 **事件系统** - 内置 Emitter 事件发射器，支持类型安全的事件管理
-- ⏰ **定时器系统** - 完整的定时器管理，支持延迟和重复任务
-- 🔍 **查询系统** - 基于位掩码的高性能实体查询
-- 🛠️ **性能监控** - 内置性能监控工具，帮助优化游戏性能
-- 🎯 **对象池** - 内存管理优化，减少垃圾回收压力
-- 📊 **数学库** - 完整的 2D 数学运算支持
-
-## 📦 安装
-
-```bash
-npm install @esengine/ecs-framework
-```
-
-## 🚀 快速开始
-
-### 1. 初始化框架
-
-```typescript
-import * as es from '@esengine/ecs-framework';
-
-// 创建 Core 实例
-const core = es.Core.create(true); // true 表示开启调试模式
-
-// 在游戏循环中更新框架
-function gameLoop() {
-    // 发送帧更新事件
-    es.Core.emitter.emit(es.CoreEvents.frameUpdated);
-}
-```
-
-### 2. 创建场景
-
-```typescript
-class GameScene extends es.Scene {
-    public initialize() {
-        // 创建玩家实体
-        const player = this.createEntity("Player");
-        
-        // 设置位置
-        player.position = new es.Vector2(100, 100);
-        
-        // 添加自定义组件
-        const movement = player.addComponent(new MovementComponent());
-        
-        // 添加系统
-        this.addEntityProcessor(new MovementSystem());
-    }
-    
-    public onStart() {
-        console.log("游戏场景已启动");
-    }
-}
-
-// 设置当前场景
-es.Core.scene = new GameScene();
-```
-
-### 3. 创建组件
-
-```typescript
-class MovementComponent extends es.Component {
-    public speed: number = 100;
-    public direction: es.Vector2 = es.Vector2.zero;
-    
-    public update() {
-        if (this.direction.length > 0) {
-            const movement = this.direction.multiply(this.speed * es.Time.deltaTime);
-            this.entity.position = this.entity.position.add(movement);
-        }
-    }
-}
-```
-
-### 4. 创建系统
-
-```typescript
-class MovementSystem extends es.EntitySystem {
-    protected process(entities: es.Entity[]) {
-        for (const entity of entities) {
-            const movement = entity.getComponent(MovementComponent);
-            if (movement) {
-                movement.update();
-            }
-        }
-    }
-}
-```
-
-## 📚 核心概念
-
-### Entity（实体）
-实体是游戏世界中的基本对象，包含位置、旋转、缩放等基本属性，可以添加组件来扩展功能。
-
-```typescript
-const entity = scene.createEntity("MyEntity");
-entity.position = new es.Vector2(100, 200);
-entity.rotation = Math.PI / 4;
-entity.scale = new es.Vector2(2, 2);
-```
-
-### Component（组件）
-组件包含数据和行为，定义了实体的特性。
-
-```typescript
-class HealthComponent extends es.Component {
-    public maxHealth: number = 100;
-    public currentHealth: number = 100;
-    
-    public takeDamage(damage: number) {
-        this.currentHealth = Math.max(0, this.currentHealth - damage);
-        if (this.currentHealth <= 0) {
-            this.entity.destroy();
-        }
-    }
-}
-```
-
-### System（系统）
-系统处理实体集合，实现游戏逻辑。
-
-```typescript
-class HealthSystem extends es.EntitySystem {
-    protected process(entities: es.Entity[]) {
-        for (const entity of entities) {
-            const health = entity.getComponent(HealthComponent);
-            if (health && health.currentHealth <= 0) {
-                entity.destroy();
-            }
-        }
-    }
-}
-```
-
-## 🎮 高级功能
-
-### 事件系统
-
-```typescript
-// 监听事件
-es.Core.emitter.addObserver(es.CoreEvents.frameUpdated, this.onFrameUpdate, this);
-
-// 发射自定义事件
-es.Core.emitter.emit("playerDied", { player: entity, score: 1000 });
-
-// 移除监听
-es.Core.emitter.removeObserver(es.CoreEvents.frameUpdated, this.onFrameUpdate);
-```
-
-### 定时器系统
-
-```typescript
-// 延迟执行
-es.Core.schedule(2.0, false, this, (timer) => {
-    console.log("2秒后执行");
-});
-
-// 重复执行
-es.Core.schedule(1.0, true, this, (timer) => {
-    console.log("每秒执行一次");
-});
-```
-
-### 实体查询
-
-```typescript
-// 按名称查找
-const player = scene.findEntity("Player");
-
-// 按标签查找
-const enemies = scene.findEntitiesByTag(1);
-
-// 按ID查找
-const entity = scene.findEntityById(123);
-```
-
-### 性能监控
-
-```typescript
-// 获取性能数据
-const monitor = es.PerformanceMonitor.instance;
-console.log("平均FPS:", monitor.averageFPS);
-console.log("内存使用:", monitor.memoryUsage);
-```
-
-## 🛠️ 开发工具
-
-### 对象池
-
-```typescript
-// 创建对象池
-class BulletPool extends es.Pool<Bullet> {
-    protected createObject(): Bullet {
-        return new Bullet();
-    }
-}
-
-const bulletPool = new BulletPool();
-
-// 获取对象
-const bullet = bulletPool.obtain();
-
-// 释放对象
-bulletPool.free(bullet);
-```
-
-### 实体调试
-
-```typescript
-// 获取实体调试信息
-const debugInfo = entity.getDebugInfo();
-console.log("实体信息:", debugInfo);
-
-// 获取场景统计
-const stats = scene.getStats();
-console.log("场景统计:", stats);
-```
-
-## 📖 文档
-
-- [快速入门](docs/getting-started.md) - 从零开始学习框架使用
-- [核心概念](docs/core-concepts.md) - 深入了解 ECS 架构和设计原理
-- [查询系统使用指南](docs/query-system-usage.md) - 学习高性能查询系统的详细用法
-
-## 🔗 扩展库
-
-- [路径寻找库](https://github.com/esengine/ecs-astar) - A*、广度优先、Dijkstra、GOAP 算法
-- [AI 系统](https://github.com/esengine/BehaviourTree-ai) - 行为树、效用 AI 系统
-
-## 🤝 贡献
-
-欢迎提交 Issue 和 Pull Request！
-
-### 开发环境设置
-
-```bash
-# 克隆项目
-git clone https://github.com/esengine/ecs-framework.git
-
-# 进入源码目录
-cd ecs-framework/source
-
-# 安装依赖
-npm install
-
-# 构建项目
-npm run build
-
-# 运行测试
-npm test
-```
-
-### 构建要求
-
-- Node.js >= 14.0.0
-- TypeScript >= 4.0.0
-
-## 📄 许可证
-
-本项目采用 [MIT](LICENSE) 许可证。
-
-## 💬 交流群
-
-加入 QQ 群讨论：[ecs游戏框架交流](https://jq.qq.com/?_wv=1027&k=29w1Nud6)
-
----
-
-**ECS Framework** - 让游戏开发更简单、更高效！