# Extension

## About

The extension panel for SA is a graphics interface for viewers to customize their avatar and run commands or animations with their avatar silently by clicking buttons rather than typing in chat.&#x20;

This is an accessibility addon that is highly recommended but completely optional, it's good for exploring options related to avatars and keeping your chatroom quiet from command spam.

## How to Install

By default, SA will have your extension enabled.

Twitch has a [channel add-on](https://dashboard.twitch.tv/extensions/fe5a78xkj1lnk9wefpk295p6x3dsvl-0.1.982) which allows you to embed the extension directly onto the page.

For other platforms (Trovo, Facebook, Dlive, Youtube, Glimesh), you may need to use the [!extension command](https://app.gitbook.com/s/YvA0UlM6GCcOd8hKhafT/~/changes/RtKfghbiONOxgj6JMnX0/stream-avatars/commands/extension) in your chatroom (while the app is connected) to receive a link to your channels pop-out extension page. There's also settings below to periodically paste this link into your chat found further down on this page.

{% hint style="info" %}
If you are streaming to multiple platforms, your extension page will have a unique url per platform. To get the correct extension page for a specific platform, use the chatroom to run the [!extension command](https://app.gitbook.com/s/YvA0UlM6GCcOd8hKhafT/~/changes/RtKfghbiONOxgj6JMnX0/stream-avatars/commands/extension).
{% endhint %}

{% hint style="info" %}
You can also [periodically paste the extension link](#announce-extension-link) in your chat for your viewers.
{% endhint %}

<div><figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2FzNDENwIGQdPkDuUTL73T%2Fextension123.png?alt=media&#x26;token=4e49c1d6-9ff0-469c-a810-481afdb606a9" alt=""><figcaption><p><strong>extension example image</strong></p></figcaption></figure> <figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2FRw6731DFIg0t5MtTF9eY%2FimmmR2qPmo.png?alt=media&#x26;token=6d17a5e6-f8c6-4f17-9899-ec9fcb278312" alt=""><figcaption><p>Twitch <a href="https://dashboard.twitch.tv/extensions/fe5a78xkj1lnk9wefpk295p6x3dsvl-0.1.982">Extension</a> install page. Creator Dashboard > Extensions > My Extensions</p></figcaption></figure></div>

## How to manage extension settings

{% hint style="info" %}
Navigate to: General > Viewer Extension Panel
{% endhint %}

{% hint style="info" %}
To disable the extension, toggle the "Interactable viewer extension" off.
{% endhint %}

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2F7VA4lf3VFatisuWLKLDu%2Fextension.png?alt=media&#x26;token=2f97c2a6-7ed6-4230-8b5a-fcf949726254" alt=""><figcaption><p>#3 is how you would disable the extension communications.</p></figcaption></figure>

## Announce Extension Link

How to periodically paste the extension link into your chat for your viewers to use:

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2Fu2OVLuT7uBnpJhcJFALm%2FeMSHrPKUBY.png?alt=media&#x26;token=848564e9-e61b-4350-aff0-5ed8e2b0ae35" alt=""><figcaption><p>toggle the announce extension link on.</p></figcaption></figure>

## Extension upload limit

**Q: Why do I have a limited amount?**

A: The extension server costs money to maintain. To keep the cost minimal there is a maximum amount of upload space for each user.&#x20;

If you have too many avatars, gear, palettes, or nametags, you may need to [disable some](#disable-avatars-many-avatars-quickly), [delete some](https://docs.streamavatars.com/stream-avatars/content-creating/deleting-avatars-palettes-colors-and-gear), [buy more upload space](#how-to-buy-more-upload), or [disable the extension entirely](#how-to-manage-extension-settings) to have unlimited space.

{% hint style="warning" %}
Disabling the extension means your viewers will need to rely exclusively on commands for [selecting avatars](https://docs.streamavatars.com/stream-avatars/commands/selection-commands) and [doing actions](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/actions).
{% endhint %}

## How to buy more upload

There's a [patreon link](https://www.patreon.com/streamavatars/membership) in the application where you can pay a low amount for a massive increase of upload space. Make sure to link your account with Stream Avatars in the application to gain the benefits.&#x20;

*Alternatively, you can buy the* [*DLC for extra upload on steam*](https://store.steampowered.com/app/1346730/Stream_Avatars_Extra_Upload/) *for a permanent increase, however it is not as much upload space.*

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2FDmOfnM4OUvkfE6TqNfDw%2FZpa5pVrdjW.png?alt=media&#x26;token=6f994cfe-8a1d-4402-9e7e-68c586a489d5" alt=""><figcaption><p>Found under: General > Viewer Extension Panel</p></figcaption></figure>

## Disable Avatars Many Avatars Quickly

**Q: How to disable avatars between each stream:**

A: Create an avatar profile. This allows you to keep your avatars but temporarily disable them.

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2F59Z5nXyBmIgdRLOLgClW%2F5csvwQprzE.png?alt=media&#x26;token=e38e5e34-4d35-46f6-88cf-f7d4ebec4d59" alt=""><figcaption></figcaption></figure>

## Organizing Extension Selection Items

You can set the order that your avatars, gear, colors, and nametags appear in the extension by doing the following.

1. Visit the editing area for the item you wish to sort.
2. Example: to edit avatar order, visit Avatar and Gear > Click the option button beside the avatar selection > Click Sorting.

<div><figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2Fg29EpoyPVTfS1fEC2pVv%2F4Bw4wt28E1.png?alt=media&#x26;token=09d2d74e-ccd5-491d-8d1e-a08e7a2a813f" alt=""><figcaption></figcaption></figure> <figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2FPEAV7RcW8CSzuetsbNL5%2FVh3dZZyDrb.png?alt=media&#x26;token=b12e0802-a34d-4395-89ce-1e85ebba4ba8" alt=""><figcaption></figcaption></figure></div>

Re-order the avatars by entering a number on each one individually. (It will shift other avatars index-order to accommodate for the newly inserted avatar's index)

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2FFcUtfvdxCJ27idzByHJc%2FsAoppYr1FX.png?alt=media&#x26;token=646fc555-fbf4-4614-87c5-2eb9e2b1e611" alt=""><figcaption></figcaption></figure>

## Trouble-shooting problems

If a viewer is saying their extension page never loads, check the following:

* The extension server might be having problems and will be back online shortly.
* The Stream Avatars application must be open and connected on the streamer's computer!
* Is their avatar currently spawned in the application? It needs to be. Check your spawn settings in General > Viewer Spawning.
* Make sure the extension is enabled! You can find the setting for that here: [Extension Settings](#how-to-manage-extension-settings).
* If their Avatar is still not spawning, the viewer might have accidentally entered [lurk mode with a chat command](https://app.gitbook.com/s/YvA0UlM6GCcOd8hKhafT/~/changes/RtKfghbiONOxgj6JMnX0/stream-avatars/commands/hideavatar). Type it again to toggle lurk mode.
* Make sure the viewer's computer clock is automatically synced, sometimes the out of sync causes issues with the authorization process. (image below)

<figure><img src="https://2994430787-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYvA0UlM6GCcOd8hKhafT%2Fuploads%2F5DTVXuomFqsa8shB7jAu%2FUBMm2UqqjB.png?alt=media&#x26;token=60d6a8de-7faf-4cb3-9cc9-bc054de5152b" 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.streamavatars.com/stream-avatars/extension.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.
