> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-unity-package.md).

# Install via Unity Package

## Introduction

Unity Package installation is a good fallback for offline workflows, quick evaluation, or when you need a pinned version.

## Prerequisites

* A Unity project opened in the Unity Editor
* A downloaded Convai `.unitypackage` file from releases:
  * `<CONVAI_GITHUB_RELEASES_URL>`

## Step-by-step

{% stepper %}
{% step %}
**Download a release package**

From the Convai GitHub Releases page, download either:

* the latest version, or
* a specific version you want to pin.
  {% endstep %}

{% step %}
**Import into your Unity project**

* Double-click the downloaded `.unitypackage`, **or**
* Drag and drop it into your project’s **Assets** folder area.
  {% endstep %}

{% step %}
**Import everything**

* In the Unity import window, ensure **all items are selected**.
* Click **Import**.
  {% endstep %}

{% step %}
**Verify the installation**

* After import, check **Console** for errors.
* **Expected result:** No errors in Console, and a **Convai** menu appears in the top toolbar.
  {% endstep %}
  {% endstepper %}

## Troubleshooting

* **Missing scripts after import**
  * Re-import the package and confirm all items are selected.
* **Console errors after install**
  * Confirm you are using a supported Unity version and render pipeline setup.

## Conclusion

You’ve installed the SDK via UnityPackage and verified the editor compiled successfully. Next, go to **Setup → Configure API Key**.

{% hint style="info" %}
**Need help?** For questions, please visit the [**Convai Developer Forum**](https://forum.convai.com/).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-unity-package.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.