mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-24 12:33:30 +08:00
af76e0ab0b
- 删除Position组件结构体定义 - 删除Velocity组件结构体定义 - 删除MovementSystem移动系统实现 - 移除ArchEcsModule ECS模块管理器 - 删除ArchSystemAdapter适配器基类 - 从ServiceModuleManager中移除ECS模块注册逻辑 - 从ArchitectureProperties中移除EnableEcs配置选项 - 删除ECS相关的单元测试文件 - 从项目文件中移除Arch和Arch.System包引用 - 从解决方案文件中移除ECS相关项目引用 - 更新项目配置文件中的目标框架和测试项目属性
171 lines
3.2 KiB
Markdown
171 lines
3.2 KiB
Markdown
# GFramework.Ecs.Arch
|
||
|
||
GFramework 的 Arch ECS 集成包，提供开箱即用的 ECS（Entity Component System）支持。
|
||
|
||
## 特性
|
||
|
||
- 🚀 **自动集成** - 引入 NuGet 包即可自动启用，无需手动配置
|
||
- 🔌 **零依赖** - 不使用时，Core 包无 Arch 依赖
|
||
- 🎯 **类型安全** - 完整的类型系统和编译时检查
|
||
- ⚡ **高性能** - 基于 Arch ECS 的高性能实现
|
||
- 🔧 **易扩展** - 简单的系统适配器模式
|
||
|
||
## 快速开始
|
||
|
||
### 1. 安装包
|
||
|
||
```bash
|
||
dotnet add package GeWuYou.GFramework.Ecs.Arch
|
||
```
|
||
|
||
### 2. 创建组件
|
||
|
||
```csharp
|
||
using System.Runtime.InteropServices;
|
||
|
||
[StructLayout(LayoutKind.Sequential)]
|
||
public struct Position(float x, float y)
|
||
{
|
||
public float X { get; set; } = x;
|
||
public float Y { get; set; } = y;
|
||
}
|
||
|
||
[StructLayout(LayoutKind.Sequential)]
|
||
public struct Velocity(float x, float y)
|
||
{
|
||
public float X { get; set; } = x;
|
||
public float Y { get; set; } = y;
|
||
}
|
||
```
|
||
|
||
### 3. 创建系统
|
||
|
||
```csharp
|
||
using Arch.Core;
|
||
using GFramework.Ecs.Arch;
|
||
|
||
public sealed class MovementSystem : ArchSystemAdapter<float>
|
||
{
|
||
private QueryDescription _query;
|
||
|
||
protected override void OnArchInitialize()
|
||
{
|
||
_query = new QueryDescription()
|
||
.WithAll<Position, Velocity>();
|
||
}
|
||
|
||
protected override void OnUpdate(in float deltaTime)
|
||
{
|
||
World.Query(in _query, (ref Position pos, ref Velocity vel) =>
|
||
{
|
||
pos.X += vel.X * deltaTime;
|
||
pos.Y += vel.Y * deltaTime;
|
||
});
|
||
}
|
||
}
|
||
```
|
||
|
||
### 4. 注册系统
|
||
|
||
```csharp
|
||
public class MyArchitecture : Architecture
|
||
{
|
||
protected override void OnRegisterSystem(IIocContainer container)
|
||
{
|
||
container.Register<MovementSystem>();
|
||
}
|
||
}
|
||
```
|
||
|
||
### 5. 创建实体
|
||
|
||
```csharp
|
||
var world = this.GetService<World>();
|
||
var entity = world.Create(
|
||
new Position(0, 0),
|
||
new Velocity(1, 1)
|
||
);
|
||
```
|
||
|
||
### 6. 更新系统
|
||
|
||
```csharp
|
||
var ecsModule = this.GetService<IArchEcsModule>();
|
||
ecsModule.Update(deltaTime);
|
||
```
|
||
|
||
## 配置选项
|
||
|
||
可以通过配置文件或代码配置 Arch ECS：
|
||
|
||
### 代码配置
|
||
|
||
```csharp
|
||
services.ConfigureArch(options =>
|
||
{
|
||
options.WorldCapacity = 2000;
|
||
options.EnableStatistics = true;
|
||
options.Priority = 50;
|
||
});
|
||
```
|
||
|
||
### 配置文件
|
||
|
||
```json
|
||
{
|
||
"GFramework": {
|
||
"Modules": {
|
||
"Arch": {
|
||
"Enabled": true,
|
||
"Priority": 50,
|
||
"WorldCapacity": 1000,
|
||
"EnableStatistics": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
## 架构说明
|
||
|
||
### 模块自动注册
|
||
|
||
本包使用 `ModuleInitializer` 特性实现自动注册，无需手动配置：
|
||
|
||
```csharp
|
||
[ModuleInitializer]
|
||
public static void Initialize()
|
||
{
|
||
ArchitectureModuleRegistry.Register(() => new ArchEcsModule(enabled: true));
|
||
}
|
||
```
|
||
|
||
### 系统适配器
|
||
|
||
`ArchSystemAdapter<T>` 桥接 Arch.System.ISystem<T> 到 GFramework 架构：
|
||
|
||
- 自动获取 World 实例
|
||
- 集成到框架生命周期
|
||
- 支持上下文感知（Context-Aware）
|
||
|
||
### 生命周期
|
||
|
||
1. **注册阶段** - 模块自动注册到架构
|
||
2. **初始化阶段** - 创建 World，初始化系统
|
||
3. **运行阶段** - 每帧调用 Update
|
||
4. **销毁阶段** - 清理资源，销毁 World
|
||
|
||
## 示例
|
||
|
||
完整示例请参考 `GFramework.Ecs.Arch.Tests` 项目。
|
||
|
||
## 依赖
|
||
|
||
- GFramework.Core >= 1.0.0
|
||
- Arch >= 2.1.0
|
||
- Arch.System >= 1.1.0
|
||
|
||
## 许可证
|
||
|
||
MIT License
|