# Installing Zoe for Unity

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

{% embed url="<https://youtu.be/0-cAePuYc74>" %}

### Installing Unity

{% hint style="info" %}
Instructions updated for Unity 6.
{% endhint %}

* Start by installing Unity Hub for your operating system [here](https://unity.com/download).&#x20;
* From the plugin's [download page](https://zoeimmersive.com/unity/download), install the recommended Unity compatible version listed in the "Core Plugin" section simply by clicking on it.

{% hint style="info" %}
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](https://zoeimmersive.com/pricing/).
{% endhint %}

{% hint style="warning" %}
Always download the recommended Unity version listed [here](https://zoeimmersive.com/unity/download).
{% endhint %}

* 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`.

<figure><img src="/files/68ZrGyHBZlBVbLk0V2dh" alt=""><figcaption><p>Create a new project with the "Universal 3D" core template.</p></figcaption></figure>

{% hint style="info" %}
Note: Prior to Unity 6, the "Universal 3D" core template was just named "3D".
{% endhint %}

* Wait until Unity opens up the project.

### Installing Zoe for Unity

* Download the Zoe for Unity **core plugin** [here](https://zoeimmersive.com/unity/download/) (you need to be logged in). If you don't have an account yet, you can purchase one [here](https://zoeimmersive.com/pricing/).
* If it's not already opened, open the **Unity project** you previously created.

{% hint style="info" %}
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.
{% endhint %}

* Once downloaded, double-click on the Zoe for Unity **.unitypackage** file.
* Unity should automatically prompt the following popup. Click on `Import`.

<figure><img src="/files/JaAuu1WJtY2NBGnfhBSm" alt="" width="300"><figcaption><p>Import Window</p></figcaption></figure>

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

<figure><img src="/files/Tuc9JOMVOzn8EwAiyjuP" alt="" width="525"><figcaption><p>Install Window</p></figcaption></figure>

{% hint style="info" %}
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.
  {% endhint %}

The installation process takes a few minutes.

{% hint style="warning" %}
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.
{% endhint %}

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

<div><figure><img src="/files/kjulWuqlmYmddMq1hIZT" alt="" width="259"><figcaption><p>'Scoped registries' popup</p></figcaption></figure> <figure><img src="/files/Hh3rp5iXRYRqqCz9nMGD" alt="" width="259"><figcaption><p>'New layers' popup</p></figcaption></figure> <figure><img src="/files/9MXCCBRLkl4zkB5gg1V1" alt="" width="259"><figcaption><p>'New tags' popup</p></figcaption></figure></div>

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

<figure><img src="/files/pGZPkVd8olMzWjoEKBFx" alt="" width="259"><figcaption><p>'Editor Restart' popup window</p></figcaption></figure>

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

<figure><img src="/files/7kXLyix2YkysbsCDfhqH" alt="" width="233"><figcaption><p>Folder structure after installation</p></figcaption></figure>

### Updating Zoe for Unity

Follow these steps to update the Zoe for Unity plugin:

* Delete the 'Zoe' folder in your project.&#x20;
* Import the most up-to-date version of the plugin [here](https://zoeimmersive.com/unity/download/).&#x20;
* From the Zoe top bar menu, click on 'Open Initialization Tool' (or 'Reset SDK Initialization' in older versions) then follow the usual install process.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://unity.zoeimmersive.com/installation/installing-zoe-for-unity.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.