Skip to content

Commit 38580a6

Browse files
ZKGameDevZKGameDev
committed
doc:update readme
1 parent b7d0601 commit 38580a6

2 files changed

Lines changed: 50 additions & 40 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -360,42 +360,47 @@ src/
360360
│ │ ├── ComponentFilter.java # Component filter
361361
│ │ ├── ComponentFilterMode.java # Filter mode
362362
│ │ ├── ComponentFilterParam.java # Filter parameter
363+
│ │ ├── EcsCleanable.java # Cleanable resource interface
363364
│ │ ├── EcsComponentManager.java # Component manager
364365
│ │ ├── EcsEntityManager.java # Entity manager
365366
│ │ ├── EcsSystemManager.java # System manager
366367
│ │ ├── EntityArchetype.java # Entity archetype
367368
│ │ ├── EntityFactory.java # Entity factory interface
368369
│ │ ├── EntityQuery.java # Entity query
370+
│ │ ├── ParallelUpdateExecutor.java # Per-entity parallel update executor
369371
│ │ └── SystemScheduler.java # System scheduler
370372
│ ├── exception/ # Exception definitions
371373
│ ├── extensions/ # Extension functionality
372-
│ │ ├── component/ # Extension components
373-
│ │ ├── entity/ # Extension entity factories
374-
│ │ └── system/ # Extension system base classes
375-
│ ├── tools/ # Utility classes
374+
│ │ ├── component/ # Extension components (Initialized / Destroying)
375+
│ │ ├── entity/ # Extension entity factories (BaseEntityFactory)
376+
│ │ └── system/ # Extension system base classes (N-Component / Init / Destroy, etc.)
377+
│ ├── tools/ # Utility classes (scanning, sorting, ClassUtils, etc.)
376378
│ ├── EcsComponent.java # Component interface
377379
│ ├── EcsEntity.java # Entity class
378380
│ ├── EcsSystem.java # System base class
379381
│ ├── EcsSystemGroup.java # System group base class
382+
│ ├── EcsEntityUpdateSystem.java # Logic system base (entity query & filter)
383+
│ ├── EcsStandaloneUpdateSystem.java # Singleton update system base
380384
│ └── EcsWorld.java # ECS world
381385
├── jmh/java/top/kgame/lib/ecsjmh/ # JMH core benchmarks (-Pjmh; not in default mvn test)
382386
└── test/java/top/kgame/lib/ecstest/
383-
├── component/ # Component tests
384-
│ ├── add/ # Component addition tests
385-
│ │ ├── immediately/ # Immediate addition
386-
│ │ └── delay/ # Deferred addition
387-
│ └── remove/ # Component removal tests
388-
│ ├── immediately/ # Immediate removal
389-
│ └── delay/ # Deferred removal
390-
├── entity/ # Entity tests
391-
│ ├── add/ # Entity addition tests
392-
│ └── remove/ # Entity removal tests
393-
├── schedule/ # System scheduling tests
394-
├── system/ # System tests
395-
├── core/ # Core functionality tests
396-
├── performance/ # JUnit perf suite (-Pperf; not in default mvn test)
397-
├── dispose/ # Resource cleanup tests
398-
└── util/ # Test utility classes
387+
├── logic/ # Functional / behavioral tests (default mvn test)
388+
│ ├── common/ # Shared utility tests
389+
│ ├── component/ # Component tests
390+
│ │ ├── add/ # Component add (immediately / delay)
391+
│ │ └── remove/ # Component remove (immediately / delay)
392+
│ ├── entity/ # Entity tests
393+
│ │ ├── add/ # Entity add (immediately / delay)
394+
│ │ └── remove/ # Entity remove (immediately / delay)
395+
│ ├── schedule/ # System scheduling & system-type tests
396+
│ ├── system/ # System order & interval tests
397+
│ ├── systemgroup/ # System group tests
398+
│ ├── core/ # Core functionality tests
399+
│ ├── dispose/ # Resource cleanup tests
400+
│ ├── isolated/ # Isolated scenarios (e.g. invalid ParallelUpdate)
401+
│ └── util/ # Test utilities
402+
└── performance/ # JUnit perf suite (-Pperf; not in default mvn test)
403+
└── isolated/ # Isolated perf scenarios (archetype / lifecycle / mutation / parallelupdate / tickrate)
399404
```
400405

401406
## ⏱ JMH Core Benchmarks

‎README_CN.md‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -364,42 +364,47 @@ src/
364364
│ │ ├── ComponentFilter.java # 组件过滤器
365365
│ │ ├── ComponentFilterMode.java # 过滤模式
366366
│ │ ├── ComponentFilterParam.java # 过滤参数
367+
│ │ ├── EcsCleanable.java # 可清理资源接口
367368
│ │ ├── EcsComponentManager.java # 组件管理器
368369
│ │ ├── EcsEntityManager.java # 实体管理器
369370
│ │ ├── EcsSystemManager.java # 系统管理器
370371
│ │ ├── EntityArchetype.java # 实体原型
371372
│ │ ├── EntityFactory.java # 实体工厂接口
372373
│ │ ├── EntityQuery.java # 实体查询
374+
│ │ ├── ParallelUpdateExecutor.java # 系统内实体并行更新执行器
373375
│ │ └── SystemScheduler.java # 系统调度器
374376
│ ├── exception/ # 异常定义
375377
│ ├── extensions/ # 扩展功能
376-
│ │ ├── component/ # 扩展组件
377-
│ │ ├── entity/ # 扩展实体工厂
378-
│ │ └── system/ # 扩展系统基类
379-
│ ├── tools/ # 工具类
378+
│ │ ├── component/ # 扩展组件（Initialized / Destroying）
379+
│ │ ├── entity/ # 扩展实体工厂（BaseEntityFactory）
380+
│ │ └── system/ # 扩展系统基类（N-Component / Init / Destroy 等）
381+
│ ├── tools/ # 工具类（扫描、排序、ClassUtils 等）
380382
│ ├── EcsComponent.java # 组件接口
381383
│ ├── EcsEntity.java # 实体类
382384
│ ├── EcsSystem.java # 系统基类
383385
│ ├── EcsSystemGroup.java # 系统组基类
386+
│ ├── EcsEntityUpdateSystem.java # 逻辑系统基类（实体查询与过滤）
387+
│ ├── EcsStandaloneUpdateSystem.java # 单例更新系统基类
384388
│ └── EcsWorld.java # ECS世界
385389
├── jmh/java/top/kgame/lib/ecsjmh/ # JMH 核心基准（-Pjmh，不进默认 mvn test）
386390
└── test/java/top/kgame/lib/ecstest/
387-
├── component/ # 组件测试
388-
│ ├── add/ # 组件添加测试
389-
│ │ ├── immediately/ # 立即添加
390-
│ │ └── delay/ # 延迟添加
391-
│ └── remove/ # 组件移除测试
392-
│ ├── immediately/ # 立即移除
393-
│ └── delay/ # 延迟移除
394-
├── entity/ # 实体测试
395-
│ ├── add/ # 实体添加测试
396-
│ └── remove/ # 实体移除测试
397-
├── schedule/ # 系统调度测试
398-
├── system/ # 系统测试
399-
├── core/ # 核心功能测试
400-
├── performance/ # JUnit 压测（-Pperf，不进默认 mvn test）
401-
├── dispose/ # 资源清理测试
402-
└── util/ # 测试工具类
391+
├── logic/ # 功能与行为测试（默认 mvn test）
392+
│ ├── common/ # 通用工具测试
393+
│ ├── component/ # 组件测试
394+
│ │ ├── add/ # 组件添加（immediately / delay）
395+
│ │ └── remove/ # 组件移除（immediately / delay）
396+
│ ├── entity/ # 实体测试
397+
│ │ ├── add/ # 实体添加（immediately / delay）
398+
│ │ └── remove/ # 实体移除（immediately / delay）
399+
│ ├── schedule/ # 系统调度与系统类型测试
400+
│ ├── system/ # 系统顺序与间隔测试
401+
│ ├── systemgroup/ # 系统组测试
402+
│ ├── core/ # 核心功能测试
403+
│ ├── dispose/ # 资源清理测试
404+
│ ├── isolated/ # 隔离场景（如非法 ParallelUpdate）
405+
│ └── util/ # 测试工具类
406+
└── performance/ # JUnit 压测（-Pperf，不进默认 mvn test）
407+
└── isolated/ # 隔离压测场景（archetype / lifecycle / mutation / parallelupdate / tickrate）
403408
```
404409

405410
## ⏱ JMH 核心性能基准

0 commit comments

Comments
 (0)