Home

UPGRADE NOTICE

Some important terminology has changed in recent updates to Entitas. The most significant change is that Pool has been renamed to Context. This means all references to the Pool/Pools in older documentation or tutorials is now referring to the Context/Contexts in Entitas v0.36.0 and newer. Please read the Upgrade Guide for more information on how to upgrade older projects.

Installation (Quick-start)

1. Download Entitas

• 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

2. Setup

Setup for Unity3D

1. Copy the contents of the Entitas-Unity.zip into the Assets folder of your Unity project. * It's best to place this in a sub-folder like Assets/Libraries/Entitas for organization, but you can place it anywhere in the project.
2. Open the Entitas Preferences from the Menu Bar -> Entitas -> Preferences
3. Specify all the paths and set everything up to your liking
4. Use the generate button or the menu item

Setup for a C# project

• Option A: Use the EntitasPure sample project
• Option B:
  1. Add the contents of Entitas-CSharp.zip to your project
     • If you want to use the code generator you can create yourself a simple helper console application which you can run as a post compile command.
     • See EntitasPure Program.cs
  2. The project file must be updated in order to recognize the generated files
  3. Add this to your .csproj
     • See EntitasPure.csproj

Example:

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

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!

https://github.com/sschmid/Entitas-CSharp/wiki/Example-projects