X-Git-Url: https://git.r.bdr.sh/rbdr/serpentity/blobdiff_plain/85861d6720c30adc4afd1e041fd7e27fb596dde7..81ed2430ba2c0f23acde2834ba679b2661c3e367:/README.md diff --git a/README.md b/README.md index 3878dd1..ef2214e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ +# Serpentity + Serpentity is a simple entity framework inspired by Ash. Usage: -require('serpentity'); + require('serpentity'); ## Instantiating an engine -var engine = Serpentity(); + var engine = Serpentity(); Add entities or systems: @@ -26,7 +28,7 @@ Remove entities or systems: Entities are the basic object of Serpentity, and they do nothing. - var entity = new Serpentity.entity(); + var entity = new Serpentity.Entity(); All the behavior is added through components @@ -70,21 +72,21 @@ that comply with that API 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); - }); + 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); + }); + } } - } -}); + }); ## That's it