Home

What is Entitas?

Entitas is a super fast and lightweight Entity-Component-System (ECS) framework specifically designed for C# and the Unity engine. Internal caching and blazing fast component access makes it second to none. Several design decisions have been made to work optimal in a garbage collected environment and to go easy on the garbage collector. Entitas also 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.

Installation

• Each release is published with zip files which contain all source files you need
  • For C# projects use Entitas-CSharp.zip
  • For Unity projects use Entitas-Unity.zip

C# Project Setup

The quickest and easiest way to get started is to download the EntitasPure sample project that is already setup for you. However, if you'd rather setup the project yourself or just want to update an existing project you can download the latest Entitas-CSharp.zip release and copy the files into your project manually.

If you want to use the code generator you can create a simple helper console application which you can run as a post compile command. The project file must also be updated in order to recognize the generated files. See EntitasPure.csproj file for more information.

Example:

<ItemGroup>
  <Compile Include="Generated\**\*.cs" />
</ItemGroup>

Unity Project Setup

Simply download the latest Entitas-Unity.zip release and copy the contents into the Assets folder of an existing or new Unity project. If everything has been done correctly you will now be able to setup all Entitas options by going to Menu Bar -> Tools -> Entitas -> Preferences.

Done. You're awesome! 🎉

Add contexts, write some components and systems and make an awesome game. Feel free to share what you've created with Entitas in the Community Section in the Wiki and use #madeWithEntitas in your Tweets so we can all enjoy playing your game or learn from it!