Awesome
<p align="center"> <img src="images/Entitas-Header.png" alt="Entitas"> </p> <p align="center"> <a href="https://discord.gg/uHrVx5Z"><img src="https://img.shields.io/discord/599321316377624601.svg?logo=discord&logoColor=FFFFFF&label=Discord&labelColor=6A7EC2&color=7389D8" alt="Entitas on Discord"></a> <a href="https://github.com/sschmid/Entitas/releases"><img src="https://img.shields.io/github/release/sschmid/Entitas.svg" alt="Latest release"></a> <a href="https://twitter.com/intent/follow?original_referer=https%3A%2F%2Fgithub.com%2Fsschmid%2FEntitas&screen_name=entitas_csharp&tw_p=followbutton"><img src="https://img.shields.io/twitter/follow/entitas_csharp" alt="Twitter Follow Me"></a> <a href="https://twitter.com/intent/follow?original_referer=https%3A%2F%2Fgithub.com%2Fsschmid%2FEntitas&screen_name=s_schmid&tw_p=followbutton"><img src="https://img.shields.io/twitter/follow/s_schmid" alt="Twitter Follow Me"></a> </p> <p align="center"> <b>Entitas is free, but powered by</b> <a href="https://www.paypal.com/donate/?hosted_button_id=BTMLSDQULZ852"><b>your donations</b></a> </p> <p align="center"> <a href="https://www.paypal.com/donate/?hosted_button_id=BTMLSDQULZ852"><img src="https://img.shields.io/static/v1.svg?logo=paypal&label=PayPal&labelColor=3F70B6&&message=Donate&color=gray" alt="Donate"></a> </p>Entitas - The Entity Component System Framework for C# and Unity
Entitas is the most popular open-source Entity Component System Framework (ECS) and is specifically made for C# and Unity. Several design decisions have been made to work optimal in a garbage collected environment and to go easy on the garbage collector. Entitas comes with an optional code generator which radically reduces the amount of code you have to write and makes your code read like well written prose.
Why Entitas
- #1 open-source ECS on GitHub
- 100% open-source under the MIT License
- great and helpful community on Discord
- easy to learn and easy to use
- works great in pure C# standalone projects without Unity
- comes with great Unity integration called Visual Debugging
- battle-tested at companies like Popcore (Rollic / Zynga / Take Two), Gram Games, Wooga, Plarium, Storm Chaser and many more
Video Tutorials and Unity Unite Talks
Video | Title | Resources |
---|---|---|
<a href="https://www.youtube.com/watch?v=DZpvUnj2dGI"><img src="https://img.youtube.com/vi/DZpvUnj2dGI/0.jpg" width="200" alt="Video: Entitas - Shmup - Part 2"></a> | Entitas ECS Unity Tutorial - Git & Unit Tests | |
<a href="https://www.youtube.com/watch?v=L-18XRTarOM"><img src="https://img.youtube.com/vi/L-18XRTarOM/0.jpg" width="200" alt="Video: Entitas - Shmup - Part 1"></a> | Entitas ECS Unity Tutorial - Setup & Basics | |
<a href="https://www.youtube.com/watch?v=Phx7IJ3XUzg"><img src="https://img.youtube.com/vi/Phx7IJ3XUzg/0.jpg" width="200" alt="Video: Watch the Entitas Talk at Unite Europe 2016"></a> | Unite Europe 2016: ECS architecture with Unity by example | SlideShare: Unite Europe 2016 |
<a href="https://www.youtube.com/watch?v=Re5kGtxTW6E"><img src="https://img.youtube.com/vi/Re5kGtxTW6E/0.jpg" width="200" alt="Video: Watch the Entitas Talk at Unite Europe 2015"></a> | Unite Europe 2015: Entity system architecture with Unity | SlideShare: Unite Europe 2015 |
First glimpse
The optional code generator lets you write code that is super fast, safe and literally screams its intent.
var entity = context.CreateEntity();
entity.AddPosition(Vector3.zero);
entity.AddVelocity(Vector3.forward);
entity.AddAsset("Player");
using static GameMatcher;
public sealed class MoveSystem : IExecuteSystem
{
readonly IGroup<GameEntity> _group;
public MoveSystem(GameContext context)
{
_group = context.GetGroup(AllOf(Position, Velocity));
}
public void Execute()
{
foreach (var e in _group.GetEntities())
e.ReplacePosition(e.position.value + e.velocity.value);
}
}
Overview
Entitas is fast, light and gets rid of unnecessary complexity. There are less than a handful classes you have to know to rocket start your game or application:
- Context
- Entity
- Component
- Group
Entitas ECS
+-----------------+
| Context |
|-----------------|
| e e | +-----------+
| e e--|----> | Entity |
| e e | |-----------|
| e e e | | Component |
| e e | | | +-----------+
| e e | | Component-|----> | Component |
| e e e | | | |-----------|
| e e e | | Component | | Data |
+-----------------+ +-----------+ +-----------+
|
|
| +-------------+ Groups:
| | e | Subsets of entities in the context
| | e e | for blazing fast querying
+---> | +------------+
| e | | |
| e | e | e |
+--------|----+ e |
| e |
| e e |
+------------+
Code Generator
The Code Generator generates classes and methods for you, so you can focus on getting the job done. It radically reduces the amount of code you have to write and improves readability by a huge magnitude. It makes your code less error-prone while ensuring best performance.
Unity integration
The optional Unity module "Visual Debugging" integrates Entitas nicely into Unity and provides powerful editor extensions to inspect and debug contexts, groups, entities, components and systems.
<p align="center"> <img src="images/Entitas.Unity-MenuItems.png" alt="Entitas.Unity MenuItems" height="200"><br /> <img src="images/Entitas.Unity.VisualDebugging-Entity.png" alt="Entitas.Unity.VisualDebugging Entity" width="400"> <img src="images/Entitas.Unity.VisualDebugging-DebugSystems.png" alt="Entitas.Unity.VisualDebugging Systems" width="400"> </p>Entitas deep dive
Read the wiki or checkout the example projects to see Entitas in action. These example projects illustrate how systems, groups, collectors and entities all play together seamlessly.
» Download and setup
» Video Tutorials and Unity Unite Talks
» Wiki and example projects
» Ask a question
Download and setup Entitas
GitHub releases (recommended)
Unity package manager
Coming soon
NuGet
Entitas and all dependencies are available as NuGet packages. More detailed explanation coming soon.
Unity Asset Store (deprecated)
Entitas on the Unity Asset Store is deprecated and will not be updated anymore. The last version available on the Asset Store is 1.12.3 and is free to download. Please see discussion Entitas turns 7 - and is FREE now
Thanks to
Big shout out to @mzaks, @cloudjubei and @devboy for endless hours of discussion and helping making Entitas awesome!
Maintainers
Different language?
Entitas is available in