Introduction to the Corgi Engine

Welcome to the Corgi Engine Documentation. Here you'll find everything you need to know to create your own platformer game!

What’s the Corgi Engine?

The Corgi Engine is a Unity 2D + 2.5D Platformer Kit, available on the Unity Asset Store. It’s a very fast, non-physics based controller for your player, plus many other features, described below. It’s mobile friendly, works well with other assets, and is basically everything you need to start creating your own 2D game right now.

The Corgi Engine's start screen

I get errors after installing the engine!

Are your errors related to a Unity package? Have you tried updating it to the latest version? Packages get updated by Unity independently from the editor core, and that sometimes leads to conflicts. It’s not the engine’s fault, and thankfully can easily be fixed. Just select the package mentioned in the error and update it via the Package Manager. You can also check the dedicated part of the documentation.

Remove the old CorgiEngine folder, and import the new one. If you don’t, due to the way the Asset Store importer works, some scripts may be duplicated, not removed, etc. Depending on what version you’re updating from, and what version you’re updating to, you may have some light refactoring to do. Make sure you check the release notes to see what changed and what may have an impact on your own code.

Where do I start ?

First of all, you don’t have to read all that documentation. The engine is built with Unity good practices in mind, and is packed with help boxes. So if this is not your first Unity project, you’ll probably be ok on your own. And you can always go back here if something’s not clear.

That said, you can use the menu on the left to get to specific places. This documentation is functional. If you have questions about the code itself, you’ll rather want to have a look at the API documentation. It’s also recommended to look at the code’s comments directly, usually they cover pretty much any question you might have.

If you want a list of features, or are wondering if this or that is included in the engine, you can have a look at this page. It also includes a changelog, and other useful stuff.

There are also video tutorials on Youtube.

And if all that doesn’t help, you can always use the support email link on the Asset’s page.