Svelto.ECS/README.md

Svelto Entity Component System 2.0

=====================================

Real Entity-Component-System for c#. Enables to write encapsulated, decoupled, highly efficient, data oriented, cache friendly, multi-threaded, code without pain. Although the framework is platform agnostic, it comes with several unity extensions. you can find a working example to learn how to use the framework here:

Examples

• Survival Example (Unity): https://github.com/sebas77/Svelto-ECS-Example (including article)
• Vanilla Example (.Net Standard/.Net Core): https://github.com/sebas77/Svelto.ECS.Examples.Vanilla (including article)
• Entities as struct, cache friendly data oriented code: https://github.com/sebas77/Svelto.ECS.Examples.CacheFriendlyECSWithEntityStructs (including article)

Articles

Dario Oliveri's Svelto.ECS articles:

• https://eagergames.wordpress.com/category/ecs/

Framework Articles:

• http://www.sebaslab.com/ecs-1-0/
• http://www.sebaslab.com/svelto-ecs-2-0-almost-production-ready/ (shows what's changed compared to 1.0)

Theory related articles:

• http://www.sebaslab.com/ioc-container-for-unity3d-part-1/
• http://www.sebaslab.com/ioc-container-for-unity3d-part-2/
• http://www.sebaslab.com/the-truth-behind-inversion-of-control-part-i-dependency-injection/
• http://www.sebaslab.com/the-truth-behind-inversion-of-control-part-ii-inversion-of-control/
• http://www.sebaslab.com/the-truth-behind-inversion-of-control-part-iii-entity-component-systems/
• http://www.sebaslab.com/the-truth-behind-inversion-of-control-part-iv-dependency-inversion-principle/
• http://www.sebaslab.com/the-truth-behind-inversion-of-control-part-v-drifting-away-from-ioc-containers/

The perfect companion for Svelto.ECS is Svelto.Tasks to run the logic of the Systems even on other threads!

• https://github.com/sebas77/Svelto.Tasks

Unity official forum thread:

• https://forum.unity.com/threads/open-source-svelto-ecs-lightweight-entity-component-system-for-c-and-unity.502163/

How to clone

The folders Svelto.ECS, Svelto.Tasks and Svelto.Common, where present, are submodules pointing to the relavite repositories. If you find them empty, you need to update them through the submodule command. Check some instructions here: https://github.com/sebas77/Svelto.ECS.Vanilla.Example/wiki**

Note: don't beat yourself up if you find Svelto.ECS hard to use at first. The framework is very light in features, but it forces the use of a new coding paradigm and shifting code paradigm is hard! I will try to clarify all the concepts writing more and more articles

In case of bugs

just open an issue here, I come here pretty often :). Also feel free to contact me on twitter or leave comments on the blog!

The Github wiki page

It needs love and as far as I understood, anyone can edit it. Feel free to do so if you have a good understanding of Svelto!

Svelto Framework is used to develop the following products(*):

!

*if you want your products made with Svelto here, just send me an email or whatever, I'll be super happy to add them.

Note: Dear Svelto Users : Although I am committed to help you and write articles as much as I can, I will never be able to keep all the documentation up to date. If you are a happy svelto user and you want to contribute, please feel free to update the github wiki! 🙏👊