Upgrade Instructions

Overview

Upgrading from older v2 Entitas-Redux to newer v2

Whenever upgrading from one version of Entitas-Redux v2 to a newer version:

• Update the package reference for Entitas Redux to the desired version.
• You should receieve a prompt to update your Genesis CLI if one was previously installed.
• Open the Genesis project settings via the menu item at Edit -> Project Settings.
• If a new version of the Genesis CLI was required, you should have already received a prompt to update it. If you did not select OK to update it, you can select the Update Genesis CLI to update the executable contents.
• Select the Install or Update all Plugins to extract any updates to the Entitas-Redux plugins.

Upgrading from v1 Entitas-Redux to v2

When upgrading from v1 Entitas-Redux to v2, there are a couple of things you should consider, but otherwise is a very straightforward easy process.

Checklist

• Handle Genesis Updates
  • Follow the instructions here to configure Genesis v2. This will require reconfiguring any existing GenesisSettings assets in the Unity project.
  • Port any custom v1 Genesis Plugins to be compatible with v2 (if any).
• Handle Assembly Definition Changes
  • Remove any redundant Assembly Definition references (if any).
  • If any custom Assembly Definitions have an overridden reference to the EntitasRedux AssemblyDefinition, it may be necessary to add or replace this with EntitasRedux.Core.

Genesis v1 => v2 Update

There is additional setup for v2 Genesis than there was for v1. Instructions for that can be found here.

The GenesisSettings asset underwent a major revision in the update from v1 to v2. If you have an existing GenesisSettings asset, it will be reset and will need to be configured to it's previous settings.

Any custom code-generation plugins using v1 Genesis would need to be ported to use v2. You can find instructions on how to do that here.

Assembly Definition Changes

Entitas-Redux base functionality (base classes for Entity, Context, etc...) has been moved to an assembly EntitasRedux.Core where previously it was in the Entitas-Redux Assembly definition. This should not affect most projects as the default Assembly-CSharp project and AssemblyDefinitions will auto-reference this new assembly.

The only exception to this is if you had an Assembly Definition that was set to Override References* and explicitly referenced EntitasRedux. In this case you will need to explicitly update this assembly reference.

In general many Editor Assembly Definitions previously in v1 Entitas-Redux have been removed; this should not affect most projects as most of that functionality was to support custom code-generation.