/Entitas-Redux

An entity-component framework for Unity with code generation and visual debugging

Primary LanguageC#MIT LicenseMIT

GitHub issuesLicense: MIT Twitter Follow

Buy Me a Coffee at ko-fi.com

Entitas Redux

About

Entitas Redux is a reworked version of Entitas with a sole focus on Unity. For more background on this project, see here for more information.

Requirements

  • Min Unity Version: 2019.1
  • Scripting Runtime: .Net 4.X

Installing Entitas Redux

Using this library in your project can be done in three ways:

Install via OpenUPM

The package is available on the openupm registry. It's recommended to install it via openupm-cli.

openupm add com.jeffcampbellmakesgames.entitasredux

Install via GIT URL

Using the native Unity Package Manager introduced in 2017.2, you can add this library as a package by modifying your manifest.json file found at /ProjectName/Packages/manifest.json to include it as a dependency. See the example below on how to reference it.

{
	"dependencies": {
		...
		"com.jeffcampbellmakesgames.genesis" : "https://github.com/jeffcampbellmakesgames/genesis.git#release/stable",
		"com.jeffcampbellmakesgames.entitasredux" : "https://github.com/jeffcampbellmakesgames/entitasredux.git#release/stable",
		...
	}
}

You will need to have Git installed and available in your system's PATH.

Install via classic .UnityPackage

The latest release can be found here as a UnityPackage file that can be downloaded and imported directly into your project's Assets folder.

Note: If you install EntitasRedux using a .UnityPackage you must also grab the latest release of Genesis as well from here as it is not included. For better dependency handling, I would recommend using OpenUPM instead.

Usage

Entitas Redux at the moment is largely representative of the features present in v1.13.0 of Entitas. As a temporary solution for now, I would point you to the Entitas Wiki here for a breakdown on features and documentation on usage. In the future, EntitasRedux documentation and code examples will be hosted on this repository's wiki here.

Support

If this is useful to you and/or you’d like to see future development and more tools in the future, please consider supporting it either by contributing to the Github projects (submitting bug reports or features and/or creating pull requests) or by buying me coffee using any of the links below. Every little bit helps!

ko-fi

Contributing

For information on how to contribute and code style guidelines, please visit here.