Installing Zoe for Unity

Zoe for Unity is a plugin that requires the Unity game engine. To install it, follow the instructions below.

Installing Unity

Instructions updated for Unity 6.

• Start by installing Unity Hub for your operating system here.

• From the plugin's download page, install the recommended Unity compatible version listed in the "Core Plugin" section simply by clicking on it.

Note: You need an account to access the Zoe for Unity download page. If you don't have one yet, you can purchase one here.

Always download the recommended Unity version listed here.

• Install the necessary packages depending on the platform you want to build for. Zoe for Unity is compatible with Web, Android (for VR headsets), macOS and Windows. If unsure, you can always add new packages later.

• When the Unity version has been installed, click on 'New Project'.

• Choose the Universal 3D core template (named "3D" in versions prior to Unity 6), name your project and choose a folder location, then click on Create project.

Create a new project with the "Universal 3D" core template.

Note: Prior to Unity 6, the "Universal 3D" core template was just named "3D".

• Wait until Unity opens up the project.

Installing Zoe for Unity

• Download the Zoe for Unity core plugin here (you need to be logged in). If you don't have an account yet, you can purchase one here.

• If it's not already opened, open the Unity project you previously created.

Make sure you are logged into your Unity account. For this, check the upper-left corner of the Editor (upper-right corner prior to Unity 6). Make sure you can see your username and that nothing is grayed out.

• Once downloaded, double-click on the Zoe for Unity .unitypackage file.

• Unity should automatically prompt the following popup. Click on Import.

Import Window

• An initialization process will start and you will get the following window. Press on Install Zoe:

Install Window

If for some reason you don't see this window pop, try one of the following:

• If you see a Zoe item in the top bar menu, click on it and select 'Open Initialization Tool' (or 'Reset SDK Initialization' in older versions).

• Or quit and re-open Unity, then try importing the plugin again.

The installation process takes a few minutes.

The installation process may pause if Unity in not kept as an active window on your computer. If it does, simply make the Unity window active again to resume installation.

During the installation you will get the following popup windows to acknowledge:

'Scoped registries' popup

'New layers' popup

'New tags' popup

When the process is finished, the following popup will ask to restart the Unity editor. Click OK.

'Editor Restart' popup window

When your project reopens, it will have the following folder structure. You'll also get a new Zoe section in the top bar menu.

Folder structure after installation

Updating Zoe for Unity

Follow these steps to update the Zoe for Unity plugin:

• Delete the 'Zoe' folder in your project.

• Import the most up-to-date version of the plugin here.

• From the Zoe top bar menu, click on 'Open Initialization Tool' (or 'Reset SDK Initialization' in older versions) then follow the usual install process.