Merge branch 'release/1.0.0'

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 4d73f182208efc8b870f5cb21f366c535891cf72..96e3a05bc48d73769ec511138549acc321096791 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
 # Serpentity
 
 # Serpentity
 

-Serpentity is a simple entity framework inspired by [Ash][ash].
+Serpentity is a simple entity framework inspired by Ash.

 
 Usage:
 
 
 Usage:
 

-    require('serpentity');
+    let Serpentity = require('serpentity');
+
+or:
+
+    <script src="/node_modules/serpentity/dist/serpentity.js"></script>

 
 ## Instantiating an engine
 
 
 ## Instantiating an engine
 

-    var engine = Serpentity();
+    let engine = Serpentity();

 
 Add entities or systems, systems are added with a priority (the smaller
 the number, the earlier it will be called):
 
 Add entities or systems, systems are added with a priority (the smaller
 the number, the earlier it will be called):


@@ -29,7 +33,7 @@ Remove entities or systems:
 
 Entities are the basic object of Serpentity, and they do nothing.
 
 
 Entities are the basic object of Serpentity, and they do nothing.
 

-    var entity = new Serpentity.Entity();
+    let entity = new Serpentity.Entity();

 
 All the behavior is added through components
 
 
 All the behavior is added through components
 


@@ -38,16 +42,18 @@ All the behavior is added through components
 Components define data that we can add to an entity. This data will
 eventually be consumed by "Systems"
 
 Components define data that we can add to an entity. This data will
 eventually be consumed by "Systems"
 

-    Class("PositionComponent").inherits(Serpentity.Component)({
-        prototype : {
-            x : 0,
-            y : 0
-        }
-    });
+    let PositionComponent = class PositionComponent extends Serpentity.Component {
+      constructor (config) {
+        super(config);
+
+        this.x = this.x || 0;
+        this.y = this.y || 0;
+      }
+    };

 
 You can add components to entities by using the add method:
 
 
 You can add components to entities by using the add method:
 

-    entity.add(new PositionComponent());
+    entity.addComponent(new PositionComponent());

 
 
 Systems can refer to entities by requesting nodes.
 
 
 Systems can refer to entities by requesting nodes.


@@ -57,12 +63,9 @@ Systems can refer to entities by requesting nodes.
 Nodes are sets of components that you define, so your system can require
 entities that always follow the API defined in the node.
 
 Nodes are sets of components that you define, so your system can require
 entities that always follow the API defined in the node.
 

-    Class("MovementNode").inherits(Serpentity.Node)({
-        types : {
-            position : PositionComponent,
-            motion : MotionComponent
-        }
-    });
+    let MovementNode = class MovementNode extends Serpentity.Node;
+    MovementNode.position = PositionComponent;
+    MovementNode.motion = MotionComponent;

 
 You can then request an array of all the nodes representing entities
 that comply with that API
 
 You can then request an array of all the nodes representing entities
 that comply with that API


@@ -73,40 +76,28 @@ that comply with that API
 
 Systems are called on every update, and they use components through nodes.
 
 
 Systems are called on every update, and they use components through nodes.
 

-    Class("TestSystem").inherits(Serpentity.System)({
-        prototype : {
-            added : function added(engine){
-                this.nodeList = engine.getNodes(MovementNode);
-            },
-            removed : function removed(engine){
-                this.nodeList = undefined;
-            }
-            update : function update(dt){
-                this.nodeList.forEach(function (node) {
-                    console.log("Current position is: " + node.position.x + "," + node.position.y);
-                });
-            }
+    let TestSystem = class TestSystem extends Serpentity.System {
+      added (engine){
+        this.nodeList = engine.getNodes(MovementNode);
+      },
+      removed (engine){
+        this.nodeList = undefined;
+      }
+      update (dt){
+        let node;
+        for (node of this.nodeList) {
+          console.log(`Current position is: ${node.position.x},${node.position.y}`);

         }
         }

-    });
+      }
+    };

 
 ## That's it
 
 Just run `engine.update(dt)` in your game loop :D
 
 
 ## That's it
 
 Just run `engine.update(dt)` in your game loop :D
 

-## Checking it in the frontend (dev).
-
-You can link the bower package (bower.json is in `lib/serpentity/` to
-make paths cleaner), then link it again from the root directory and
-spawn a python server (`python -m SimpleHTTPServer`). The test page
-will be available in `http://localhost:8000/browser_test/`
-
-If you just want to use it, it's available as a bower package!
-
-

 ## TO-DO
 
 ## TO-DO
 

-* Removing components
-* Implement the ashteroids demo (Serpentoids)
-* Actually check performance
+* Minimize code (Uglify does not support ES6 yet)
+* Check Performance

 
 [ash]: http://www.ashframework.org/
 
 [ash]: http://www.ashframework.org/