# Unity

The Kaedim Unity plugin can be found on [Github](https://github.com/Kaedim/unity-plugin)

## Installation Guide:

1. Download the `Scripts/KaedimPlugin.cs` file from the Github link above

<figure><img src="/files/35QW5GbRyXRZNW5MR4id" alt=""><figcaption></figcaption></figure>

2. In your Unity Project, create a folder named `Plugins` under `Assets` if it does not already exist
3. Under your `Plugins` folder, place the `KaedimPlugin.cs` file you just downloaded. Now, when you run your Project, the KaedimPlugin will automatically be built

## Usage Guide:

1. You can find the Plugin under Window → Kaedim Plugin

<figure><img src="/files/9g1wXC446LUGNtPSo8o8" alt="" width="375"><figcaption></figcaption></figure>

2. Once you open the panel, you’ll see a page to enter your credentials. You will want to enter your Dev ID and API Key found on your Kaedim profile at <https://www.app.kaedim3d.com/settings?tab=security>

<figure><img src="/files/Go6YjHR97kkSVfzMK2Dj" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/DQPW8Q7HG4S6HDNRw8YX" alt=""><figcaption></figcaption></figure>

3. You will now be able to view your available assets, or upload a new picture to generate new assets
4. Within the "Load Assets" panel, you can click individual asset names to download their corresponding 3D models

<figure><img src="/files/FpkYzWmgyKHEqrJlBaik" alt="" width="346"><figcaption></figcaption></figure>

5. The downloaded models can be found under your Assets folder. They can be imported into your Unity Scene from there

<figure><img src="/files/vyITY7oPOQGCmFFmnr2x" alt=""><figcaption></figcaption></figure>

6. You can upload new pictures to generate assets from the "Upload Asset" page. Make sure the image you choose follows our [Input Guidelines](/creating-assets/input-guidelines.md). You can view the progress of your new asset on the [web portal](https://www.app.kaedim3d.com/dashboard)

<figure><img src="/files/iCC9yWGlClKuUnGBdmmm" alt=""><figcaption></figcaption></figure>

7. You can view further details about how the plugin is running in the Console Panel

<figure><img src="/files/KX8ndTPbgBcqpPJ51wtu" alt=""><figcaption></figcaption></figure>


---

# 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://docs.kaedim3d.com/enterprise-features/custom-integrations/plugins/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.