v0.0.1

v0.0.1

Author: DavidPeicho

.travis.yml

@@ -1,4 +1,7 @@
 language: node_js
+branches:
+  only:
+    - develop
 node_js:
   - node
 script:

CONTRIBUTING.md

@@ -48,8 +48,8 @@ it out.
 
 ## Local Link
 
-In order to link this package to another one, you can either use `npm install`
-with a local path, or `npm link`.
+In order to link this package to another one, you can either use `yarn add file:[PATH_TO_FLECS]`
+with a local path, or `yarn link`.
 
 Just be careful: the package that is published (and so that you should link)
 is in the `dist` folder.

README.md

@@ -1,13 +1,16 @@
-# flecs
+# Flecs
+
+[![Build Status](https://travis-ci.com/DavidPeicho/flecs.svg?branch=main)](https://travis-ci.com/DavidPeicho/flecs)
+
 
 > 🚧 Flecs is a work-in-progress and might be unstable, use it at your
 > own risks 🚧
 
 Fast & Flexible EntityComponentSystem (ECS) for JavaScript and Typescript, available in browser and Node.js.
 
 Get started with:
-* The [Documentation](./doc.md)
-* The [Examples](./examples)
+* The [Documentation](./DOC.md)
+* The [Examples](./example)
 
 > 🔍 I am currently looking for people to help me to identify their needs in order to drive the development of this [library further](#stable-version).
 
@@ -35,14 +38,117 @@ The library will prioritize stability improvements over feature development.
 * System Grouping
 * System Topological Sorting
 * Automatic Component Registration
+* Component Properties Merging
+* System Queries Merging
 * TypeScript Decorators
   * For component properties
   * For system ordering and configuration
 
+## Install
+
+Using npm:
+
+```sh
+npm install flecs
+```
+
+Using yarn
+
+```sh
+yarn add flecs
+```
+
+The library is distributed as an ES6 module, but also comes with two UMD builds:
+* `fecs/umd/fecs.js` → Development build with debug assertions
+* `fecs/umd/fecs.min.js` → Minified production build, without  debug assertions
+
 ## Usage Example
 
 ```js
-class Component {}
+import {
+  ComponentData,
+  TagComponent,
+  NumberProp,
+  RefProp,
+  World
+} from 'flecs';
+
+/**
+ * Components definition.
+ */
+
+class Position2D extends ComponentData {}
+Position2D.Properties = {
+  x: NumberProp(),
+  y: NumberProp()
+};
+
+class FollowTarget extends ComponentData {}
+FollowTarget.Properties = {
+  target: RefProp(),
+  speed: NumberProp(1.0)
+};
+
+class PlayerTag extends TagComponent {}
+class ZombieTag extends TagComponent {}
+
+/**
+ * Systems definition.
+ */
+
+class ZombieFollowSystem extends System {
+
+  execute(delta) {
+    this.queries.zombies.execute((entity) => {
+      const { speed, target } = entity.read(FollowTarget);
+      const position = entity.write(Position2D);
+      const deltaX = target.x - position.x;
+      const deltaY = target.y - position.y;
+      const len = Math.sqrt(deltaX * deltaX + deltaY * deltaY);
+      if (len >= 0.00001) {
+        position.x += speed * delta * (deltaX / len);
+        position.y += speed * delta * (deltaY / len);
+      }
+    });
+  }
+
+}
+ZombieFollowSystem.Queries = {
+  // Select entities with all three components `ZombieTag`, `FollowTarget`, and
+  // `Position2D`.
+  zombies: [ZombieTag, FollowTarget, Position2D]
+}
+
+const world = new World();
+
+// Creates a player entity.
+const playerEntity = world.create().add(PlayerTag).add(Position2D);
+const playerPosition = playerEntity.read();
+
+// Creates 100 zombies at random positions with a `FollowTarget` component that
+// will make them follow our player.
+for (let i = 0; i < 100; ++i) {
+  world.create()
+    .add(ZombieTag)
+    .add(Position2D, {
+      x: Math.floor(Math.random() * 50.0) - 100.0,
+      y: Math.floor(Math.random() * 50.0) - 100.0
+    })
+    .add(FollowTarget, { target: playerPosition })
+}
+
+// Runs the animation loop and execute all systems every frame.
+
+let lastTime = 0.0;
+function loop() {
+  const currTime = performance.now();
+  const deltaTime = currTime - lastTime;
+  lastTime = currTime;
+  world.execute(deltaTime);
+  requestAnimationFrame(loop);
+}
+lastTime = performance.now();
+loop();
 ```
 
 ## Stable Version
@@ -61,7 +167,7 @@ Please feel free to reach out directly in the [Github Issues](https://github.com
 
 ## Benchmarks
 
-TODO
+Coming soon.
 
 ## Contributing
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "fecs",
+  "name": "flecs",
   "version": "0.0.1",
   "description": "Fast & Flexible EntityComponentSystem (ECS) for JavaScript & TypeScript",
   "repository": {
@@ -10,7 +10,8 @@
   "license": "MIT",
   "keywords": [
     "ecs",
-    "entity component system"
+    "entity component system",
+    "game"
   ],
   "type": "module",
   "main": "./umd/fecs.js",