EntityJS

EntityJS 简介

EntityJS 是一个基于 实体-组件（Entity-Component） 设计模式的 HTML5 JavaScript 游戏引擎。它的核心理念是：把游戏逻辑拆分成一个个可大可小的 组件（Component），再通过 实体（Entity） 把组件组合起来，从而获得极高的灵活性与可复用性。

为什么选择实体-组件设计

传统游戏引擎常用类继承来组织代码，这会导致类之间高度耦合：功能被绑定在某个具体类上，难以移植，随着开发推进类会不断膨胀，最终演变成难以维护的“上帝类”。

EntityJS 的做法是：

• 所有逻辑写在组件里，组件可大可小；
• 实体本身只是其组件的实时组合；
• 通过增删组件来改变实体行为，组件之间低耦合、可跨项目复用。

主要特性

• 实体-组件架构：灵活组合，避免继承层级带来的耦合问题。
• 命令行工具：可创建游戏、组件与测试，并支持构建与本地服务器。
• 模板系统：内置默认模板与平台游戏模板，可快速起步。
• QUnit 测试：内置测试框架，并提供实体与输入相关的辅助断言。
• Tiled 地图支持：可直接加载 .tmx 地图文件用于关卡。
• 工厂方法：组件可定义工厂，用于批量创建结构复杂的实体。

目录结构概览

• Assets：图片、音效等外部资源
• Build：构建产物
• Scripts：JS/Coffee 源码，XML、TMX、JSON 会被转换为 JS
• Tests：QUnit 测试文件
• Styles：CSS 样式
• game.json：可选配置，用于指定脚本顺序、忽略文件等

使用方式示意

项目通过命令行工具管理游戏生命周期，例如创建游戏、创建组件、运行服务器与构建：

entityjs new mygame platform
entityjs comp rock
entityjs server
entityjs build

在代码中，实体通过短 getter/setter 访问属性：

var tile = re.e('tile');
tile.tileX(1); // 设置
tile.tileX();  // 读取

注意事项

EntityJS 目前处于重写阶段，正从 Ruby 迁移到 Node.js 包，并进一步向实体-系统（Entity-System）设计演进。仓库中的安装说明仍基于 Ruby 1.8.1+ 与 gem，与现代前端工具链差异较大。如果你打算在新项目中使用，建议先查看 dev 分支了解最新进展，或将其作为学习 ECS 架构的参考实现。