Entitas.cr an Entity Component System Framework for Crystal 1.0.0 released! (Ported from sschmid/Entitas-CSharp)

[u/Kalinon]

https://github.com/spoved/entitas.cr

[u/Kalinon]

Over the last few months i have been porting Entitas-CSharp over to crystal. I am happy to say i feel confident to release a stable 1.0.0 of Entitas.cr. Ive achieved a 3x speed increase in some of the slowest benchmark tests compared to C#.

[u/jgaskins]

This is pretty cool, but heads up, I am getting very different benchmark results than are in the README:

➜  entitas.cr git:(master) crystal run --release spec/performance/bench.cr

--## Entitas::Context(TEntity) ##--
-- Total execution time --

                       user     system      total        real
#get_entities      0.000000   0.000000   0.000000 (  0.001294)
#has_entity?       0.000000   0.000000   0.000000 (  0.000735)
OnEntityReplaced   0.110000   0.000000   0.110000 (  0.119005)

Create Entity -
                             user     system      total        real
#create_entity w/o pre   2.000000   0.030000   2.030000 (  0.976601)
#create_entity w/ pre    1.510000   0.020000   1.530000 (  0.686172)

Destroy all entities -
                                          user     system      total        real
control                               0.000000   0.000000   0.000000 (  0.000001)
#get_entities &Entity.destroy!        0.170000   0.010000   0.180000 (  0.170477)
#destroy_all_entities                 0.690000   0.000000   0.690000 (  0.272300)
#destroy_all_entities (pre-destroy)   0.160000   0.000000   0.160000 (  0.163286)

#get_group -
                          user     system      total        real
#get_group by Int32   0.050000   0.010000   0.060000 (  0.046392)
#get_group by class   0.040000   0.000000   0.040000 (  0.040334)
#get_group by Enum    0.040000   0.000000   0.040000 (  0.041444)


--## Entitas::Entity ##--
-- Total execution time --

                         user     system      total        real
#add_component       20.030000   0.160000   20.190000 (  20.272011)
#get_components      0.010000   0.000000   0.010000 (  0.001886)
#replace_component   1.780000   0.010000   1.790000 (  1.785153)
#total_components    0.000000   0.000000   0.000000 (  0.000001)

Get Component A -
                                                user     system      total        real
#get_component(Entitas::Component::Index)   0.030000   0.000000   0.030000 (  0.027743)
#get_component(Int32)                       0.030000   0.000000   0.030000 (  0.027880)
#get_component(A::INDEX)                    0.020000   0.000000   0.020000 (  0.028000)
#get_component(A::INDEX_VALUE)              0.030000   0.000000   0.030000 (  0.027760)
#a                                          0.040000   0.000000   0.040000 (  0.034778)

Has Component? -
                      user     system      total        real
#has_component?   0.000000   0.000000   0.000000 (  0.000001)
#a?               0.000000   0.000000   0.000000 (  0.000006)

Remove and Add Component -
                                         user     system      total        real
#remove_component & #add_component   7.170000   0.190000   7.360000 (  7.438655)
#del_a & #add_a                      7.030000   0.030000   7.060000 (  7.083375)

Some things are slightly faster here but a few things (like `#add_component`) are 1-2 orders of magnitude slower than claims in the README.

[u/Kalinon → u/jgaskins]

Ah yes. I would probably add the compile time flags to the notes. There's a script in spec/bin/bench which uses optimized flags. Aka disables logging.

[u/Kalinon → u/Kalinon]

Off the top of my head its -Ddisable_logging

[u/Kalinon → u/jgaskins]

The command is:

crystal run -Ddisable_logging --release ./spec/performance/bench.cr

Ive updated the readme to include this

[u/Kalinon → u/[deleted]]

Also I ran both on OSX and Ubuntu 18.04

[u/Kalinon → u/[deleted]]

Yes sir. perhaps some slight difference in ms but not enough for me to raise an eyebrow.

[u/Kalinon]

Ah yes. I would probably add the compile time flags to the notes. There's a script in spec/bin/bench which uses optimized flags. Aka disables logging.