EntityJS - 强大灵活的HTML5游戏引擎

EntityJS 是一个基于HTML5的JavaScript游戏引擎，采用了实体-组件设计模式。它使你在强大的JavaScript框架内编写高度可扩展的游戏代码变得轻而易举。

项目重构进行中

目前，EntityJS 正在从Ruby转向Node.js包，并向实体系统设计模式转变。请查看dev分支获取最新更新。

EntityJS 与其他JavaScript游戏引擎有何不同？

EntityJS旨在成为最灵活的游戏引擎。我们明白重复编写相同的函数和代码行是多么令人烦恼。因此，我们通过组件-实体设计解决了这个问题。传统的游戏引擎设计方法是创建类的层级结构，这实际上是最紧密耦合的设计。这种紧密耦合使得类的功能严格限制在一个类内，不易于移植到其他项目，复制某个必要的功能也很困难。随着游戏开发的推进，类会变得更加庞大和复杂，最终可能会产生控制大部分游戏逻辑的"上帝类"。

而在实体-组件的世界里，所有的逻辑都实现为组件，大小任你选择。你可以创建一个实体并添加/移除组件。实体是其所有组件的实时表现。这种低耦合的组件和实体使得你可以混合搭配组件来创造强大的功能，同时保持了代码的便携性和健壮性。

系统需求

至少需要Ruby 1.8.1+。

安装

EntityJS现在是一个易于安装的宝石。在终端输入：

gem install entityjs

这将安装最新的gem版本，现在你可以轻松地创建一些游戏！

使用

当你使用这些命令时，请确保总是在游戏的根目录下。

创建新游戏

在任意目录中运行：

entityjs new mygame

这将使用默认模板创建一个新的游戏。

使用平台模板创建游戏：

entityjs new mygame platform

查看所有可用模板：

entityjs templates

创建组件

entityjs comp rock

这将在scripts/rock.js创建名为“rock”的新组件，并创建测试文件。

entityjs comp display/hero

这将在scripts/display目录下创建一个名为“hero”的hero组件。

创建测试

entityjs test name test1 test1

在/tests/name_test.js创建有两个测试方法的测试。

构建游戏

entityjs build

这将把所有EntityJS源码和游戏源码压缩成一个文件放在/builds目录下。

运行游戏/测试

确保服务器正在运行：

entityjs server

访问以下地址以玩游戏：

localhost:2345

运行测试访问：

localhost:2345/test

资源位于：

localhost:2345/assets/*name

查看所有命令。

目录结构

• Assets - 包含所有外部资产

  • Images - 在这里添加图片，然后通过re.assets.images检索
  • Sounds - 添加任何声音，通过re.assets.sounds检索

• Build - 包含构建后的游戏

• Scripts - 包含所有的js、coffee源码。xml、tmx和json文件会被转换为js。

  • Plugins - 包含minified脚本用于插件播放。

• Tests - 包含测试文件，以QUnit运行

• Styles - 包含要包含的所有CSS，未来还将支持Sass和其他样式。

• game.json - 可选，用于配置脚本顺序、忽略某些文件等

短路获取器和设置器

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

//设置器甚至可以用于`attr()`中
tile.attr('tileX', 2); //设置

//设置器接受多个参数
tile.tile(1, 2); //设置tilex和tiley
//或者
tile.attr('tile', [1,2]); //同上

工厂在0.4.2

所有组件现在都有工厂方法，可用于创建复杂的实体。

re.c("button")
.factory(function(label, click){
  this.label = label;

  if(click){
    this.on('click', click);
  }
});

re.button("Hello", function(){
  alert(this.label+" clicked!");
});

工厂方法

如果你需要多次访问特定类型的实体，可以使用工厂方法。

re.c("player")
.method(function(){
  if(!this.instance){
    this.instance = re.e('player');
  }
  return this.instance;
});

//获取玩家
re.player();

QUnit 测试

所有游戏都使用轻量级且易于使用的QUnit进行测试。查看平台模板了解一些示例测试。

工厂

可以在tests/factories.js中创建新的工厂，然后这样使用：

factory('enemy', function(){
  //制作一个自定义硬币
  this.health = 100;
  this.state = 'idle';

  //可以使用正常实体的方法
  this.on('update', function(){
    //某事
  });
});

//在测试中的任何地方创建敌人实体
var e = factory('enemy');
eq(e.state, 'idle') //真

//与下面相同
var e = re.e('enemy');
e.health = 100;
//等等...

如果需要多个敌人工厂怎么办？

//为了方便，使用f
f('enemy attacking', function(){
  this.state = 'attacking';
});

EntityJS 帮助器

添加了一些用于检查实体的断言，如expectTrigger，expectFlicker和expectListener。更多信息请参阅localhost:2345/qunit/qunit.entity.js。

输入助手

提供了特殊方法如keypress()和click()来模拟用户输入。查看localhost:2345/qunit/qunit.input.js了解更多信息。

Tiled地图编辑器

惊人的tiled地图编辑器现在兼容并可用于你的项目。

只需在/assets创建一个名为levels或你喜欢保存地图的新目录，就可以像这样在代码中访问它们：

re('level1.tmx')[0]; //假设文件名是level1.tmx
re('level'); //查找/assets/levels目录下的所有级别

如果你仍然困惑，创建一个新的平台游戏并查看如何使用水平。

快速入门指南

首先，你应该安装ruby和entityjs gem。

然后，你可以从平台模板创建新游戏：

entityjs new mygame platform

移动到mygame目录并运行游戏：

entityjs server

打开浏览器，导航到localhost:2345。

贡献

在发送Pull Request之前，最好运行rspec和rake jasmine以确保所有Ruby和JavaScript的测试都能通过。

运行rspec会产生一个/mygame/目录，其中包含测试文件。git会忽略这个文件夹，所以不用担心。