X-Git-Url: https://git.r.bdr.sh/rbdr/serpentity/blobdiff_plain/971ff307c745e394ba3fd20e9dfbd1f302736c7c..77dc64fee29f530ecef0b09d2380729734cf62dd:/README.md?ds=inline diff --git a/README.md b/README.md index 434196a..6724652 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -Serpentity is a simple entity framework inspired by Ash. +# Serpentity + +Serpentity is a simple entity framework inspired by [Ash][ash]. Usage: @@ -8,10 +10,11 @@ Usage: var engine = Serpentity(); -Add entities or systems: +Add entities or systems, systems are added with a priority (the smaller +the number, the earlier it will be called): engine.addEntity(entityFactory()); - engine.addSystem(new GameSystem()); + engine.addSystem(new GameSystem(), priority); Update all systems: @@ -42,9 +45,9 @@ eventually be consumed by "Systems" } }); -You can add components to entities by using the add method: +You can add components to entities by using the addComponent method: - entity.add(new PositionComponent()); + entity.addComponent(new PositionComponent()); Systems can refer to entities by requesting nodes. @@ -90,8 +93,17 @@ Systems are called on every update, and they use components through nodes. Just run `engine.update(dt)` in your game loop :D +## Checking it in the frontend (dev). + +You can link the bower package to test it out locally. +Spawn a python server (`python -m SimpleHTTPServer`) to see +the test page in `http://localhost:8000/browser_test/` + + ## TO-DO * Removing components * Implement the ashteroids demo (Serpentoids) * Actually check performance + +[ash]: http://www.ashframework.org/