v1.0.0

Author: r-lyeh

README.md

@@ -1,14 +1,14 @@
-kult :fire: <a href="https://travis-ci.org/r-lyeh/kult"><img src="https://api.travis-ci.org/r-lyeh/kult.svg?branch=master" align="right" /></a>
+kult :crystal_ball: <a href="https://travis-ci.org/r-lyeh/kult"><img src="https://api.travis-ci.org/r-lyeh/kult.svg?branch=master" align="right" /></a>
 ====
 
-- Kult is a lightweight entity/component/system library written in C++11.
-- Kult is tiny.
-- Kult is header-only.
-- Kult is expressive.
-- Kult has no dependencies.
-- Kult is zlib/libpng licensed.
+Kult is a lightweight entity/component/system library (C++11).
 
-### sample
+## Features 
+- [x] Expressive.
+- [x] Tiny, cross-platform, self-contained, header-only.
+- [x] ZLIB/libPNG licensed.
+
+### Showcase
 ```c++
 #include <iostream>
 #include "kult.hpp"
@@ -32,12 +32,11 @@ kult::component<'pos2', vec2> position;
 kult::component<'vel2', vec2> velocity;
 
 // systems
-kult::system movement = [&]( double t, float dt ) {
+kult::system<float> movement = [&]( float dt ) {
     for( auto &entity : kult::join( position, velocity ) ) {
         entity[ position ].x += entity[ velocity ].x * dt;
         entity[ position ].y += entity[ velocity ].y * dt;
     }
-    return true;
 };
 
 // app
@@ -54,13 +53,49 @@ int main(int argc, const char **argv) {
 
     // simulate 100 frames
     for( int i = 0; i < 100; ++i ) {
-        movement(0, 1/60.f);
+        movement( 1/60.f );
     }
 
     // print status
-    std::cout << player.str() << std::endl;
-    std::cout << enemy.str() << std::endl;
+    std::cout << player.dump() << std::endl;
+    std::cout << enemy.dump() << std::endl;
+
+    // purge entities
+    player.purge();
+    enemy.purge();
+
+    // print status
+    std::cout << player.dump() << std::endl;
+    std::cout << enemy.dump() << std::endl;
 
     return 0;
 }
 ```
+
+### Output
+```
+{       name: player #1,
+        desc: this is our warrior,
+        pos2: (x:3.33333,y:6.66666),
+        vel2: (x:2,y:4),
+}
+{       name: orc #1,
+        pos2: (x:0,y:0),
+}
+{}
+{}
+```
+
+### Reading
+- https://github.com/sosolimited/Entity-Component-Samples
+
+### Alternatives
+- https://github.com/alecthomas/entityx
+- https://github.com/dbralir/ginseng
+- https://github.com/miguelmartin75/anax
+- https://github.com/Nocte-/es
+- https://github.com/SuperV1234/SSVEntitySystem
+
+### Changelog
+- v1.0.0 (2015/11/24): Allow external serializer; new entity methods; extra join/exclude sugars; improve dump info
+- v0.0.0 (2014/05/04): Initial commit

sample2.cc bench.cxx

@@ -32,7 +32,7 @@ int main( int argc, char **argv )
         // benchmark its access time
 
         {
-            std::cout << "Benchmarking... ";
+            std::cout << "Benchmarking get<T>(id) syntax... ";
             std::chrono::microseconds seconds1, seconds2;
             {
                 auto t_start = std::chrono::high_resolution_clock::now();
@@ -55,5 +55,39 @@ int main( int argc, char **argv )
         std::cout << dump(obj1) << std::endl;
     }
 
+    {
+        // obj
+        kult::entity obj;
+        kult::component<'cter', size_t> counter;
+
+        {
+            std::cout << "Benchmarking T[id] syntax... ";
+            std::chrono::microseconds seconds1, seconds2;
+            {
+                auto t_start = std::chrono::high_resolution_clock::now();
+                for( size_t i = 0; i < 200000000; ++i )
+                    counter[ obj ]++;
+                seconds1 = std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - t_start);
+            }
+            size_t &ref = counter[ obj ];
+            {
+                auto t_start = std::chrono::high_resolution_clock::now();
+                for( size_t i = 0; i < 200000000; ++i )
+                    ref++;
+                seconds2 = std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - t_start);
+            }
+            double relative_speed = double( seconds1.count() ) / seconds2.count();
+            std::cout << "relative access is x" << std::fixed << std::setprecision(2) << relative_speed << " times " << ( seconds1 >= seconds2 ? "slower" : "faster" ) << " than direct access" << std::endl;
+        }
+
+        // debug obj
+        std::cout << dump(obj) << std::endl;
+
+        kult::purge(obj);
+
+    // debug obj
+        std::cout << dump(obj) << std::endl;
+    }
+
     return 0;
 }

sample1.cc demo1.cc

@@ -1,3 +1,5 @@
+// demo1: construct two objects dinamically using the add<component_t>(id) syntax
+
 #include <string>
 #include <sstream>
 #include <iostream>
@@ -40,6 +42,9 @@ int main( int argc, char **argv )
         // print objects
         std::cout << dump(obj1) << std::endl;
         std::cout << dump(obj2) << std::endl;
+
+        purge(obj2);
+        std::cout << dump(obj2) << std::endl;
     }
 
     return 0;

sample5.cc demo2.cc

@@ -27,7 +27,7 @@ int main(int argc, char **argv) {
 
     for( unsigned times = 0; times < 100; ++times ) {
         movementSystem(0.0016f);
-        std::cout << get<position>(player) << std::endl;
+        std::cout << dump(player) << std::endl;
     }
 
     return 0;

sample6.cc demo3.cc

@@ -20,12 +20,11 @@ kult::component<'pos2', vec2> position;
 kult::component<'vel2', vec2> velocity;
 
 // systems
-kult::system movement = [&]( double t, float dt ) {
+kult::system<float> movement = [&]( float dt ) {
     for( auto &entity : kult::join( position, velocity ) ) {
         entity[ position ].x += entity[ velocity ].x * dt;
         entity[ position ].y += entity[ velocity ].y * dt;
     }
-    return true;
 };
 
 // app
@@ -42,12 +41,20 @@ int main(int argc, const char **argv) {
 
     // simulate 100 frames
     for( int i = 0; i < 100; ++i ) {
-        movement(0, 1/60.f);
+        movement( 1/60.f );
     }
 
     // print status
-    std::cout << player.str() << std::endl;
-    std::cout << enemy.str() << std::endl;
+    std::cout << player.dump() << std::endl;
+    std::cout << enemy.dump() << std::endl;
+
+    // purge entities
+    player.purge();
+    enemy.purge();
+
+    // print status
+    std::cout << player.dump() << std::endl;
+    std::cout << enemy.dump() << std::endl;
 
     return 0;
 }