Getting Started

Pre-Requisites

To use the Emergence Unity Engine plugin, you will need any LTS version of Unity, 2020.3 and 2021.3 at the time of writing. We are also currently supporting 2022.2. Newer versions should still work fine, but are not officially supported.

Installation

Emergence can be installed directly from the Unity asset store. If you're unfamiliar with using the Unity asset store check out these two links from Unity's own documentation:

• What is the Asset Store and how do I use it?

• How do I download an Asset from the Asset Store?

Integrating with your game

The Emergence prefab

Adding Emergence to your game is as simple as dropping the Emergence prefab into the first scene where you want it to appear.

The prefab can be seen here, the third item in the project view

Once it is loaded, the Emergence plugin will be accessible from the rest of your game. It will not unload with scene changes, so it will not lose the instance or any connections it may have.

The Emergence Prefab

The Emergence prefab has 3 main exposed functionalities to look into:

Prefab inspector view

• Configuration & Environment: The configuration is a topic in and of itself, for this Getting Started page we can leave the configuration on Default and Environment on Staging

  • Staging is identical to production with a separate database, it is a risk free environment to develop and test in.

  • See the configuration page for more details.

• Keyboard Shortcut: This will change what to press to open the overlay, the two modifiers when enabled determine what keys need to be pressed in addition to the key.

• Events: There are 2 events, and both are self explanatory, they are called when the user opens or closes the UI.