This page explains how to install the Corgi Engine and its dependencies in a new project.

Introduction

Whatever version of Unity you’re using, remember to always import the asset in an empty project, so that the engine’s project settings get properly imported. If you decide not to import in a blank project, at least make sure to remove the old Corgi Engine folder first to avoid conflicts.

How to import the Corgi Engine in your project?

  1. Create a new empty project in Unity 6000.5.0f1 or higher using Universal 2D or 3D as the Template
  2. Go to Window > Package Manager, then from the top left dropdown pick “My Assets”, find Corgi Engine in the list and download then import it into the project, press “Import” on the first popup, “Install/Upgrade” on the second one, on the next one (“import unity package”), press Next, then Import
  3. This will take a bit of time, once import is complete, close the Package Manager window, restart Unity. you may be prompted to “enable the backends”, press No
  4. Open the FeaturesPlatforms demo scene, press play in the editor, then space to jump

Tilemaps and 2D Extras

The engine uses tilemaps in some of its demos (the Retro ones, mostly). If you wish to use or edit these tilemaps, you will need to add Unity’s 2D extras to your project, as most of the tiles in these demos’ tile palettes rely on them. To add the 2D extras to your project, simply download the latest release’s source as a zip, and extract its contents into your project in the folder of your choice. These used to be included in the asset, but Unity now has separate versions for different editor versions, and it’s still not available via the package manager, so this manual installation is unavoidable.

Unity versions not yet supported by the engine

Updates for the Corgi Engine usually support the latest stable version of Unity, but sometimes they lag behind a bit. If you’re importing the asset in a freshly released Unity version, chances are some packages won’t be compatible and you’ll have to manually sort dependencies using the method described above.