# How To Use

### Opening the Level Palette

To open the Level Palette, navigate to the SHADERSOURCE dropdown menu in the editor toolbar.

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

In this menu, click the **SHADERSOURCE: Level Palette** option.

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

This will open the Level Palette UI in a new window. The Level Palette tab can be docked anywhere within the Unreal interface that the Content Browser can be docked.

<figure><img src="/files/xwoNEejWDTXJnFCQkOiA" alt=""><figcaption><p>Default Level Palette UI</p></figcaption></figure>

{% hint style="info" %}
The Level Palette can also be opened via **Window** -> **SHADERSOURCE** -> **SHADERSOURCE: Level Palette**.
{% endhint %}

### Adding Categories

To add a new category to the Level Palette, simply press the **Add Category** button. This will insert a new empty category.

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

{% hint style="danger" %}
The Level Palette has no limit to the number of categories that can be added, however, increasing the number of categories beyond 6-8 might cause some performance issues, especially if there are a lot of assets in the project.
{% endhint %}

### Renaming Categories

Categories can be renamed by clicking their name.

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

### Category Toolbar

The toolbar below the category name can be used to hide, move, and delete the category.

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

### Resizing Categories

Categories can be resized in a similar way to how a Details Panel can be resized. Hover between the categories, click and drag, to resize.

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

### Adding Assets to a Category

To add an asset to the category simply drag and drop the asset from the Content Browser.

{% hint style="info" %}
You can also drag and drop multiple assets at once.
{% endhint %}

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

<figure><img src="/files/Jpetl7IKnLsvoA6EjInr" alt=""><figcaption><p>Example of a level palette for a scene</p></figcaption></figure>

{% hint style="info" %}
Each category functions similar to the default Content Browser. They contain a search bar and a settings option to change the layout of the category.
{% endhint %}

### Removing an Asset from a Category

To remove an asset from a category, simply right click the asset and select **Remove**.

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

Right clicking empty space in a category will also give you the option to **Clear All** assets for the whole category.

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

### Saving and Presets

By default, the Level Palette saves the assets added to the categories when closing the tool or the editor so that when the tool is opened next, anything added isn't lost.

**Presets** are a way to save a Level Palette collection for use later or for other people to also use.

To save a new preset, select **Save Preset As**.

To save the current preset, select **Save Preset**.

Enabling **Auto Save Changes** will make it so that the Level Palette automatically saves any changes to the assets and categories added and removed to the Level Palette, in the current saved preset.

### Additional Buttons

* **Clear Palette** clears the entire palette of all assets and clears the saved preset. Note: This does **NOT** affect any assets in the current saved preset, even if **Auto Save Changes** is ticked on.
* **Delete All Categories** removes ALL categories from the palette. Note: If **Auto Save Changes** is ticked on, it WILL remove all the assets in the current saved preset too.


---

# 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.shadersource.io/assets-and-plugins/level-palette/how-to-use.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.
