ecsfp

简体中文 | English

---

Python 实体-组件-系统框架，简单灵活

• 易于使用和与其他框架结合。
• 99% 类型注解，代码补全无处不在。

鉴于类型注解的使用，仅支持 Python 3.7+。

安装

无需任何依赖，直接把 ecsfp 文件夹放进项目里用就行了。

也可以以包的形式通过源码安装：

git clone https://github.com/DreamAlone666/ecsfp.git
pip install ecsfp

设计

• 场景

  Scene 是 ecsfp 的主要类对象，作为实体和组件的管理者。

  from ecsfp import Scene
  
  scene = Scene()

• 实体

  用来组织组件的唯一标识，在 ecsfp 中只是一个整数。

  entity = scene.add_entity()

  实体从 0 开始递增，同一实体只会出现一次。

• 组件

  实体持有的数据，ecsfp 支持任意类型的组件，每个实体仅能持有某个组件类型的一个实例。

  实体在内部被视为一个特殊的 int 类型组件，可以通过 int 类型像访问组件一样访问实体，但最好不要直接使用该类型的自定义组件。

  class Position:
      ...
  
  class Velocity:
      ...
  
  scene.add_component(entity, Position())
  scene.add_component(entity, Velocity())
  
  # 或在添加实体时：
  # entity = scene.add_entity(Position(), Velocity())

• 系统

  从场景中获取组件，执行逻辑。

  ecsfp 不是侵入式的框架，没有自己的系统管理。

  典型的系统是一个接受场景，利用组件的函数：

  def move(scene: Scene):
      for position, velocity in scene.match_components(Position, Velocity):
          ...
  
  def render(scene: Scene):
      for position in scene.get_components(Position):
          ...

示例

一些使用 ecsfp 的游戏示例：

• mine_sweeper --- 终端界面的扫雷

以下示例结合了 pyglet，请先安装: pip install pyglet

• snake --- 有动效的简易贪吃蛇

许可证

此项目使用 MIT license 进行授权。