# Introduction ## About & Summary [Stream Avatars](https://www.streamavatars.com) is a content creation tool for live video broadcasting that adds flair to your video to promote viewer engagement and channel growth! Viewers can also spend their hard-earned stream currency on avatar customizations. It can only be downloaded from the [Steam Store](https://store.steampowered.com/app/665300/Stream_Avatars/) but you can buy a steam key from [humble bundle](https://www.streamavatars.com/) too.

## Which Streaming platforms are supported?

Platform	Read Chat	Write Chat	Follow	Paid Subscriber	Paid Currency	Currency Title	Extension
Twitch	true	true	true	true	true	bits	true
Youtube	true	true	false	true	false	~~super~~	true
Kick	true	true	false	false	false	~~Kicks~~	true
Facebook	true	true	false	false	false	~~stars~~	true
Trovo	true	true	true	true	true	elixir	true
Dlive	true	true	true	true	false	~~lino~~	true
Tiktok	true	false	false	false	false	???	false
Picarto	true	true	false	false	false		false
Chzzk	true	true	false	false	true	cheese	true

## What other integrations are supported?

Name	Currency	Notes for StreamAvatars
Trovo Mana	false	only with trovo: how-to
Twitch Points	false	only with twitch: how-to
Mixitup Chatbot	true	only twitch, trovo, glimesh
StreamElements	true	only twitch
Streamlabs Chatbot	true	only twitch
Streamlabs Extension	true	Requires Streamlabs extension on your channel. - only twitch
Streamlabs Cloudbot	false	Does not have an API to integrate with.

{% embed url="" %} Primary Webpage URL {% endembed %} {% embed url="" %} Steam Page URL {% endembed %} # Quick Setup When launching Stream Avatars for the first time, you will be presented with an install wizard to walk you through the steps of setting up.

If for some reason you did not get this prompt, you can revisit the install wizard by navigating to: 1. General 2. Data Settings 3. Setup install wizard

You can browse the various categories on the left bar. In this example you can manage your Login Details and also install different avatar packages from the Steam Workshop. (Note: Often times there will be a "Relevant Tutorials" tab at the top of each category to aid in learning about the category. 1. Login Details - (This will already be set up through the install wizard) 2. Steam Workshop - (Where you can download community made content)

browsing categories and installing workshop content

# How to Overlay # Windows - Spout2 (Recommended) ## Using Spout2 is for WINDOWS only. Spout2 plugin for OBS is the fastest and most efficient way to capture Stream Avatars.

1. Navigate to general 2. Window Settings 3. Enable the Spout2 Plugin 4. Download the Spout2 OBS Plugin ()

After you click on the Spout2 OBS Download link: 1. Find the latest version of spout 2. install the .exe file and run it.

1. Add the spout2 capture 2. Set it to Stream Avatars 3. Resize your stream avatars window to adjust the bounds on OBS. 4. Reset the transform on OBS if needed. # MacOS - Syphon (Recommended) ## Using Syphon is for MacOS only. Syphon plugin for OBS is the fastest and most efficient way to capture Stream Avatars on Mac/Apple

1. Navigate to general 2. Window Settings 3. Enable the Syphon Plugin 4. Download the Syphon OBS Plugin ()

After you click on the Syphon OBS Download: 1. Download Syphon and run it.

1. Add the Syphon capture 2. Set it to Stream Avatars 3. Resize your stream avatars window to adjust the bounds on OBS. 4. Reset the transform on OBS if needed. # OBS ## Recommended: The following options are far more efficient and fast for your computer! They take an extra minute to set up but it's worth it! ### Spout2 (Windows) If you are on windows I recommend using:\ [Windows - Spout2 (Recommended)](/stream-avatars/how-to-overlay/windows-spout2-recommended) ### Syphon (MacOS) If you are on macOS I recommend using:\ [MacOS - Syphon (Recommended)](/stream-avatars/how-to-overlay/macos-syphon-recommended) If these options do not work for you, please continue reading. ## OBS Default Options: ## Add A Game-Capture The recommended way to use Stream Avatars with OBS is with a Game-Capture. In rare cases you might run into situations forcing you to use a Window-Capture which is not ideal. For users on Mac Operating systems, you will need to use a "[Window-Capture](#window-capture)". Add a new "Game Capture" source, set it to "Specific Window", and then select "StreamingAvatars.exe". Also check the "Allow Transparency" box.

specific window, streaming avatars, allow transparency

## Choosing the Layer To ensure stream avatars is displaying on top of stream sources, you can adjust the order of the sources. The closer a source is to the top of the list, the higher it's layer value is. Higher layers values appear on top of content below it. Like your primary stream content (Video Games, Work, Art, Webcam).

click and drag from the bottom to the top

## Window Capture {% hint style="danger" %} Stop! Only use window capture if you are on Mac/OSX or your game-capture is not working!\ Also be sure to try Syphon or Spout2 first depending on your Operating System.\ \ Windows:\ [Windows - Spout2 (Recommended)](/stream-avatars/how-to-overlay/windows-spout2-recommended)\ \ MacOS:\ [MacOS - Syphon (Recommended)](/stream-avatars/how-to-overlay/macos-syphon-recommended) {% endhint %} Window capture is not ideal because it does not have an "Allow Transparency" option. The transparency this provides is perfect and requires zero tuning, but if you are unable to use a Game-Capture, this is how it works: Add a Window Capture source, set the window to Stream Avatars. Right click the source, Click "Filters", and add a "Color Key" filter. You can set the custom color to be anything you want, but Stream Avatar's background must match the color you select. After that you need to tune the "Similarity" and "Smoothness" until it looks good.

How to match the Stream Avatars background to the Color Key's color:\ Navigate to General > Window Settings, and click on the "Background Color" box.

After you're done make sure to adjust the [layer of the window capture](#obs-layer)! ## Trouble Shooting Sometimes OBS has problems displaying the content. There are a lot of systems at play where problems can occur. Here's a checklist to go through if you are having issues. * Make sure Stream Avatars is connected and your Avatar is walking around. The UI is designed to be transparent with game-capture's so it can be confusing that it doesn't show up. * You might need to make OBS run as administrator. (Or make it not run as administrator) * If the capture is not displaying anything, it could be other software interfering with OBS's ability to capture Stream Avatars correctly. Some examples of problematic software are: MSI-Afterburner, Rivatuner, Any software that has an overlay on top of full-screen programs\ \ I think the only way to work around this is to close those programs, and make sure your computer doesn't launch these programs on startup. After you do this, restart your Computer and try using OBS again. * In some cases you can try to set Stream Avatars, Steam, and OBS to run as ADMIN mode, however there are also cases where this can cause the capture to not work as well. * If you are using TWO graphics cards, you may need to use SLI-Crossfire. \ (This is the case for most laptops because they have a dedicated graphics card and an integrated one too) * If none of this seems to work check out this post by OBS:\ * Last resort is to use a "[Window Capture](#window-capture)" # Streamlabs Desktop ## Recommended: The following options are far more efficient and fast for your computer! They take an extra minute to set up but it's worth it! ### Spout2 (Windows) If you are on windows I recommend using:\ [Windows - Spout2 (Recommended)](/stream-avatars/how-to-overlay/windows-spout2-recommended) ### Syphon (MacOS) If you are on macOS I recommend using:\ [MacOS - Syphon (Recommended)](/stream-avatars/how-to-overlay/macos-syphon-recommended) If these options do not work for you, please continue reading. ## SLOBS Default Options: ## Add A Game-Capture The recommended way to use Stream Avatars with Streamlabs Desktop is with a Game-Capture. In rare cases you might run into situations forcing you to use a Window-Capture which is not ideal. For users on Mac Operating systems, you will need to use a "[Window-Capture](#window-capture)". Add a new "Game Capture" source, click "Add a new source", continue, and then set it to "Specific Window", and then select "StreamingAvatars.exe" as the window. Lastly, check the "Allow Transparency" box.

After you're done make sure to adjust the [layer of the window capture](#obs-layer)! ## Trouble Shooting Sometimes Streamlabs Desktop has problems displaying the content. There are a lot of systems at play where problems can occur. Here's a checklist to go through if you are having issues. * Make sure Stream Avatars is connected and your Avatar is walking around. The UI is designed to be transparent with game-capture's so it can be confusing that it doesn't show up. * You might need to make StreamLabs run as administrator. (Or make it not run as administrator) * If the capture is not displaying anything, it could be other software interfering with Streamlabs Desktop's ability to capture Stream Avatars correctly. Some examples of problematic software are: MSI-Afterburner, Rivatuner, Any software that has an overlay on top of full-screen programs\ \ I think the only way to work around this is to close those programs, and make sure your computer doesn't launch these programs on startup. After you do this, restart your Computer and try using Streamlabs Desktop again. * In some cases you can try to set Stream Avatars, Steam, and Streamlabs Desktop to run as ADMIN mode, however there are also cases where this can cause the capture to not work as well. * If you are using TWO graphics cards, you may need to use SLI-Crossfire. * If none of this seems to work check out this post by OBS:\ * Last resort is to use a "[Window Capture](#window-capture)". If none of the above works your problem might be specific to your computer. This may be a graphics card driver issue and if on windows directX driver. # XSplit {% hint style="info" %} Navigate to Tools > Settings and enable "game source" and "DX12" {% endhint %}

{% hint style="info" %} Restart XSplit. {% endhint %}

{% hint style="info" %} Add a Game capture source and select "Streaming Avatars". {% endhint %}

{% hint style="info" %} Stretch it to be full screen (ideally that is the same size as the stream avatars window for pixel perfect graphics) {% endhint %}

{% hint style="info" %} Set the background color of stream avatars to match the background removal Color Key of XSplit. {% endhint %}

# Twitch Studio ## Adding the Layer To add Stream Avatars as an overlay for Twitch Studio, first edit a scene. Next Add a new layer, and select "Screen Share" and then "Add".

Now you need to set the Application window to be Stream Avatars. To do this, locate the "Screen Share Source" on the right side. Then click "Change". From here you need to find "Streaming Avatars" from the list of open programs.

## Setting background transparency To make the new Screen Share have a transparent background you will need to navigate to the "Border" property on the right side. Click "Edit" and then set the "Opacity" to be 0.

## Adjusting the layer order Next you need to make sure your new "Screen Share" is on the correct layer to be an "Overlay" on your streaming content. To do this you need to click and drag the "Screen Share" to be the top element.

## Trouble shooting The transparency is lost if you ever open any of the properties on the left. Make sure they are collapsed while streaming.

{% hint style="danger" %} Stop! Only use the "Green Screen Effect" if the border transparency is not working for you! {% endhint %} As a last resort, you might have to use the "Green Screen Effect" property to remove the background of Stream Avatars to make it an overlay. Make sure to set it's color to the same color of the background in Stream Avatars.

# Unlisted / Other ## If your software is not listed here... We will use OBS as an example where we can. To broadcast Stream Avatars as an overlay on your livestream, you need to add it as a visual source. The visual source that you need depends on your broadcasting software of choice. If your broadcaster software is not shown here it will probably still work, however, some broadcasting software lack features so there may be some compromises with the type of visual source you add. Stream Avatars acts as a Game, so if you can, capture it as you would if you were streaming a Game. Feature rich broadcasters have options such as "Game Capture" and "Allow Transparency". Otherwise you might need to use a "[Window Capture](#window-capture)".

## Choosing the Layer To ensure stream avatars is displaying on top of stream sources, you can adjust the order of the sources. The closer a source is to the top, the higher it's layer is. That will allow Stream Avatars to be on top of other sources, like your primary stream content (Video Games, Work, Art, Webcam).

## No Game-Capture feature? If you don't have a game-capture or similar feature, you can use a regular window capture and add filter effects to take out the background color of Stream Avatars (effectively making it an overlay).

How to match the Stream Avatars background to the Color Key's color:\ Navigate to General > Window Settings, and click on the "Background Color" box.

After you're done make sure to adjust the [layer of the window capture](#obs-layer)! # 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. 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 %}

Twitch Extension install page. Creator Dashboard > Extensions > My Extensions

## 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 %}

#3 is how you would disable the extension communications.

## Announce Extension Link How to periodically paste the extension link into your chat for your viewers to use:

## 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. If you have too many avatars, gear, palettes, or nametags, you may need to [disable some](#disable-avatars-many-avatars-quickly), [delete some](/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](/stream-avatars/commands/selection-commands) and [doing actions](/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. *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.*

Found under: General > Viewer Extension Panel

## 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.

## 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.

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)

## 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)

# Quick Guide ## Brief Feature Overview Stream Avatars is a complex program with a lot of options. Below you can find a video to summarize some important features. {% embed url="" %} # Commands How to use Stream Avatars commands # !commands posts a link to your chat room with a list of commands that are available and also altered command names and localized versions of the commands. *example: !commands* # Selection Commands A group of commands related to changing your avatar selections. Includes: Avatars, Gear, Color Palettes, Nametag, Actions / Custom Animations. # !random equips a random avatar, gear items, and color palettes to your character *Example: !avatar random* *Example: !gear random* *Example: !hats random* *Example: !color random* *Example: !nametag random* *Example: !attack random* *Example: !hug random* *Example: !bomb random* *Example: !currency add random 500* {% hint style="warning" %} Only moderators can add currency (with default settings) {% endhint %} # !mass random runs a command on every active avatar {% hint style="warning" %} Only moderators can use this command (with default settings) {% endhint %} *Example: !mass random* *Example: !mass avatar random* *Example: !mass gear random* *Example: !mass hats random* *Example: !mass color random* *Example: !mass attack random* *Example: !mass hug random* # !change {user} {command} random runs the command as if the target user was running it *Example: !change clonzeh !random* *Example: !change clonzeh !avatar random* *Example: !change clonzeh !gear random* *Example: !change clonzeh !color random* *Example: !change clonzeh !hats random* *Example: !change clonzeh !nametag random* # !avatars posts a list of available avatars to your chatroom (this is disabled if you have too many avatars) {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *Example: !avatars* # !avatar {avatar} Command - Changes your avatar to the one selected by name {% hint style="info" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *Example: !avatar block\_man* # !change {user} !avatar {avatar} Command - Changes the target user's avatar to the one selected by name {% hint style="warning" %} Only moderators can run these command(s). (with default settings applied) {% endhint %} *Example: !change clonzeh block\_man* {% hint style="info" %} to select your own avatar selection please visit: [Avatar Selection Commands](/stream-avatars/commands/selection-commands) {% endhint %} # !change {user} !avatar {avatar} {timer} Temporarily changes the target user's avatar to the one selected by name for a period of time {% hint style="warning" %} Only moderators can run these command(s). (with default settings applied) {% endhint %} *Example: !change clonzeh block\_man 30* {% hint style="info" %} to select your own avatar selection please visit: [Avatar Selection Commands](/stream-avatars/commands/selection-commands) {% endhint %} # !mass avatar {avatar} Command - Changes all active user's avatars to the one selected by name {% hint style="warning" %} Only moderators can run these command(s). (with default settings applied) {% endhint %} *Example: !mass avatar random* # !mass avatar {avatar} {timer} Command - Temporarily changes all active user's avatars to the one selected by name for a period of time {% hint style="warning" %} Only moderators can run these command(s). (with default settings applied) {% endhint %} *Example: !mass avatar random 120* # !color posts a list of available colors to your chatroom (this is disabled if you have too many colors) {% hint style="info" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} !color {color\_name} equip a color palette to your character. *Example: !color blue* # !gear posts a list of available gear sets to your chatroom (this is disabled if you have too many gear sets) {% hint style="info" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} !gear {gear\_set} posts a list of available gear sets to your chatroom (this is disabled if you have too many gear sets) !{gear\_set} posts a list of available gear pieces to your chatroom (this is disabled if you have too many gear pieces) !{gear*set} {gear\_piece}* equip a gear piece item to your character. *Example: !b\_hats tophat* # !nametags posts a list of available nametags to your chatroom. (this is disabled if you have too many nametags) {% hint style="info" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} !nametag {nametag\_name} equip a nametag to your character. *Example: !nametag subscriberTag* # !actions posts a list of available actions on your avatar to your chatroom. (this is disabled if you have too many actions) {% hint style="info" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} !{action\_name} uses the action on your character. {% hint style="info" %} The available actions depend on custom animations set to an avatar and shop prices applied to actions which you may not own. {% endhint %} *Example: !dance* *Example: !attack {target\_user}* *Example: !hug {target\_user}* *Example: !bomb {target\_user}* *Example: !{custom\_animation}* # !show posts a list of equipped items on your character. *Example: !show* *Example: !show {target\_user}* # Minigames and Fun Commands A group of commands that are fun to try! # !basketball Starts a global minigame between two basketball teams. {% hint style="warning" %} Only moderators can start this minigame (with default settings) {% endhint %} *example: !basketball 100 20 30* {% hint style="info" %} 100 loyalty reward points, 20 scored points to win, and a game length of 30 minutes. {% endhint %} *example: !basketball ffa 200 5 15* {% hint style="info" %} FFA mode (no teams and unlimited players can join) 200 loyalty reward points, 5 scored points to win, and a game length of 15 minutes. {% endhint %} *example: !basketball cancel* # !battleroyale Starts a global minigame between two basketball teams. {% hint style="warning" %} Only moderators can start this minigame (with default settings) {% endhint %} *example: !battleroyale* {% hint style="info" %} Starts a battleroyale with all active avatars, with a default loyalty point reward of 500. {% endhint %} *example: !battleroyale 200* {% hint style="info" %} Starts a battleroyale with all active avatars, with a 200 loyalty point reward. {% endhint %} {% hint style="info" %} You can permanently exclude players with the [!game exclude {user} command](/stream-avatars/commands/game-exclude-user). {% endhint %} *example: !battleroyale cancel* # !boss Starts a global minigame with several players fighting a boss {% hint style="warning" %} Only moderators can start this minigame (with default settings) {% endhint %} *example: !boss* {% hint style="info" %} Starts a boss battle, the default loyalty point reward of 200. {% endhint %} *example: !boss pumpkin\_king hard* {% hint style="info" %} Starts a boss battle against pumpkin\_king on hard difficulty. {% endhint %} {% hint style="info" %} Custom loot rewards can be created by [editing the details of the boss](/stream-avatars/content-creating/creating-bosses). {% endhint %} ## Joining a boss fight as a viewer Once a boss fight is started, you will be presented with options to join. *example: !join mage* *example: !join priest* *example: !join warrior* ## Fighting a boss as a viewer to cast abilities you can type !ability\_name or the number that the ability is listed as: *example: 1*\ *example: 2*\ *example: 3* # !duel {user} {amount} Starts a minigame between you and a target user, wagering an amount of loyalty points *example: !duel clonzeh 0* {% hint style="info" %} Starts a duel between you and clonzeh for 0 currency, the target user must type !accept for the duel to begin. {% endhint %} *example: !duel clonzeh 100* {% hint style="info" %} Starts a duel between you and clonzeh for 100 currency, the target user must type !accept for the duel to begin. {% endhint %} {% hint style="info" %} Custom loot rewards can be created by [editing the minigame](/stream-avatars/application-settings/minigames). {% endhint %} # !slots {amount} start a slot machine with a wager of an amount of loyalty points. *example: !slots 50* {% hint style="info" %} Starts a slot machine for 50 loyalty points. {% endhint %} # !bomb {user} spawns a bomb on your avatar {% hint style="warning" %} This command will cost 10 currency with the default settings in SA. {% endhint %} {% hint style="info" %} This command can target yourself or a target user. {% endhint %} *example: !bomb clonzeh* *example: !bomb* *example: !mass bomb* {% hint style="info" %} Only moderators can use mass commands. {% endhint %} {% hint style="info" %} !mass bomb will shower the screen with bombs in spectacular fashion! {% endhint %} # !sling {power} {angle} Slings your avatar with a power and direction. *example: !sling 100 90* {% hint style="info" %} Full power at an angle straight above your avatar. {% endhint %} *example: !sling 50 45* {% hint style="info" %} *Half power at 45 degrees towards the left of your avatar.* {% endhint %} *example: !mass sling random random* {% hint style="info" %} Only moderators can use mass commands. {% endhint %} {% hint style="info" %} !mass sling random random will shoot avatars with random powers at random angles. {% endhint %} # !fart Spawns a fart cloud on your avatar and plays an animation (if one is added) *example: !fart* *example: !mass fart* {% hint style="info" %} Only moderators can use !mass commands. {% endhint %} {% hint style="info" %} !mass fart will make all avatars fart. {% endhint %} # !quote {#} A quote system for storing and printing quotes from the streamer *example: !quote add This is the text of your New Quote.* *example: !quote #1* {% hint style="info" %} !quote #1 will display the quote stored in #1 position if it exists. {% endhint %} *example: !quote remove #1* # !roll {#d#} Rolls a number of dice with a number of sides and prints the outcome. *example: !roll* *example: !roll 1d6* *example: !roll 1d20* # !8ball {question} Ask the 8ball a question and receive an answer. *example: !8ball Do you like Stream Avatars?* *example: !8ball Will you give Stream Avatars a review on* [*STEAM*](https://store.steampowered.com/app/665300/Stream_Avatars/#app_reviews_hash)*?* :smile: # !freeze {user} {seconds} freezes the target user for an amount of seconds. {% hint style="warning" %} Only moderators can use this command (with default settings) {% endhint %} *example: !freeze clonzeh 30* # !pin {user} {x%} {y%} {seconds} pins a target avatar to a position {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} example: !pin clonzeh 0.5 0.5 {% hint style="info" %} Pins the target to center of the screen. {% endhint %} example: !pin remove clonzeh {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} example: !mass pin random random {% hint style="info" %} Pins everyone to random positions all over the screen. {% endhint %} example: !mass pin remove {% hint style="info" %} Removes the pin from all avatars. {% endhint %} example: !pin clonzeh random 30 {% hint style="info" %} Pins target to random position for 30 seconds. {% endhint %} # !attack {user} attacks a target user example: !attack clonzeh {% hint style="info" %} Tells your avatar to attack clonzeh's avatar {% endhint %} !mass attack random {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !climb {user} climbs a target user example: !climb clonzeh {% hint style="info" %} Tells your avatar to climb clonzeh's avatar {% endhint %} Note: avatars can climb the same avatar multiple times and chain together to make a tall tower. !mass climb random {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} !mass climb clonzeh {% hint style="info" %} Only moderators can run this command with default settings. (makes everyone stack on top of clonzeh) {% endhint %} # !dance tells your avatar to do a dance! example: !dance {% hint style="info" %} Tells your avatar to dance. {% endhint %} !mass dance {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !hug {user} tells your avatar to hug another user's avatar example: !hug clonzeh {% hint style="info" %} Tells your avatar to hugclonzeh's avatar {% endhint %} !mass hug random !mass huge clonzeh {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !throw throws an avatar at a specific location {% hint style="warning" %} Only moderators can use this command (with default settings) {% endhint %} {% hint style="info" %} throws your avatar at clonzeh {% endhint %} *example: !throw @clonzeh* {% hint style="info" %} throws clonzeh at nightbot {% endhint %} *example: !throw @clonzeh @nightbot* {% hint style="info" %} *throws your avatar at the center of the screen* {% endhint %} *example: !throw 0.5 0.5* {% hint style="info" %} *throws everyone at a target* {% endhint %} *example: !mass throw clonzeh* # !explode {target} makes a target avatar explode {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} example: !explode clonzeh {% hint style="info" %} Makes clonzeh's avatar explode into a bunch of pieces. It will respawn shortly after. {% endhint %} example: !mass explode {% hint style="info" %} Make's everyone's avatar explode. {% endhint %} # !bet {amount} {calltype} start a roulette game with a wager of loyalty points. *example: !bet 50 red* *example: !bet 50 32* *example: !bet 50 green* {% hint style="info" %} available call types are, red, black, odd, even, 1st12, 2nd12, 3rd12, green, and any number between 0-36 {% endhint %} # !scale {target} {size} changes the scale of someone's avatar {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} example: !scale clonzeh 2 {% hint style="info" %} Makes clonzeh's avatar twice as big. {% endhint %} example: !mass scale random {% hint style="info" %} Make's everyone's avatar a random size. {% endhint %} # !spawn game spawns a moving star. users can type !jump to try to catch if for a loyalty point bounty. {% hint style="warning" %} Only moderators can start this minigame (with default settings) {% endhint %} *example: !spawn game 50* {% hint style="info" %} Spawns a star with a bounty of 50 loyalty points. {% endhint %} *example: !spawn game 10 13* {% hint style="info" %} Spawns 13 stars with a bounty of *10* loyalty points. {% endhint %} # !screensaver {seconds} runs the global screensaver state on all active avatars. viewers fly across the screen like an old school DVD screensaver. {% hint style="warning" %} Only moderators can start this minigame (with default settings) {% endhint %} *example: !screensaver 30* *example: !screensaver cancel* # !mass {command} Runs a command for every active user. Some commands behave different when 'massed'. {% hint style="warning" %} Only moderators can run these command(s). (with default settings applied) {% endhint %} *example: !mass pin 25* *example: !mass fart* *example: !mass explode* *example: !mass attack random* *example: !mass hug @target* *example: !mass dance* *example: !mass jump* *example: !mass bomb* *example: !mass avatar random 15* *example: !mass gear random 15* *example: !mass color random 15* *example: !mass freeze* *example: !mass scale 2* *example: !mass throw @target* *example: !mass throw 0.5 0.5* # Shop Commands A group of commands related purchasing avatars and items from the SA shop. # !shop posts a list of shop options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !shop* # !buy avatars posts a list of avatar options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !buy avatars* *example: !buy avatar block\_man* # !buy colors posts a list of avatar color options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !buy colors* *example: !buy color blue* # !buy gear posts a list of gear set options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !buy gear* *example: !buy hats* {% hint style="info" %} !buy hats will post a list of gear pieces options to your live-stream's chat-room {% endhint %} *example: !buy hats tophat* # !buy nametags posts a list of nametag options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !buy nametags* *example: !buy nametag bold\_blue\_tag* # !buy actions posts a list of actions on your avatar options to your live-stream's chat-room {% hint style="warning" %} It's highly recommended to use the [extension command](/stream-avatars/commands/extension) or [extension panel](/stream-avatars/extension#about) instead of this command. {% endhint %} *example: !buy actions* *example: !buy action hover* # Currency Commands A group of commands related to currency (loyalty points). # !currency posts how much currency you have into the chat room *example: !currency* *example: !change clonzeh !currency* # !currency add {user} {amount} adds currency to the target user {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !currency add clonzeh 500* *example: !currency add all 500* {% hint style="info" %} using "all" as the target will give currency to all users that actively have an avatar spawned. {% endhint %} # !currency remove {user} {amount} removes currency from the target user {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !currency remove clonzeh 5* *example: !currency remove all 5* # !currency give {user} {amount} transfers currency from you to the target user {% hint style="info" %} This does not create new currency, it just transfers currency from one user to another. {% endhint %} *example: !currency give clonzeh 5* # Gifting Commands A group of commands related to giving viewers commodities. (items, currency, special, rare) # !gift {user} lootbox {name} Gives a target user a lootbox! {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh lootbox normalLoot* {% hint style="success" %} To find out how to create loot boxes visit this page: [Lootbox Editing](/stream-avatars/application-settings/edit-lootboxes) {% endhint %} # !gift {user} avatar {avatar} grants ownership of an avatar to a target user. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh avatar block\_man* {% hint style="warning" %} If the shop cost of this avatar has the "AND" condition with any of the status requirements checked ("Followers", "Subscribers", "Moderators"), then the user must also satisfy that before using the avatar. {% endhint %}

# !gift {user} gear {gear\_set} {gear\_piece} grants ownership of a gear piece to a target user. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh gear hats tophat* {% hint style="warning" %} If the shop cost of this avatar has the "AND" condition with any of the status requirements checked ("Followers", "Subscribers", "Moderators"), then the user must also satisfy that before using the avatar. {% endhint %}

# !gift {user} color {avatar} {color} grants ownership of an avatar's color palette to a target user. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh color block\_man blue* {% hint style="warning" %} If the shop cost of this avatar has the "AND" condition with any of the status requirements checked ("Followers", "Subscribers", "Moderators"), then the user must also satisfy that before using the avatar. {% endhint %}

# !gift {user} nametag {nametag} grants ownership of a nametag to a target user. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh nametag green\_tag* {% hint style="warning" %} If the shop cost of this avatar has the "AND" condition with any of the status requirements checked ("Followers", "Subscribers", "Moderators"), then the user must also satisfy that before using the avatar. {% endhint %}

# !gift {user} all true grants ownership of everything in the shop. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} *example: !gift clonzeh all* {% hint style="warning" %} To revert this command you can change, "false" instead of "true" {% endhint %} # Remove Ownership Commands A group of commands related to removing viewers commodities. (items, currency, special, rare) # !remove {user} avatar {avatar} removes ownership of an avatar to a target user. *example: !remove clonzeh avatar block\_man* # !remove {user} gear {gear\_set} {gear\_piece} removes ownership of a gear piece from a target user. *example: !remove clonzeh gear hats tophat* # !remove {user} color {avatar} {color} removes ownership of an avatar's color palette from a target user. *example: !remove clonzeh color block\_man blue* # !remove {user} nametag {nametag} removes ownership of a nametag from a target user. *example: !remove clonzeh nametag green\_tag* # !extension posts an extension link to your live-stream's chat-room for accessing the extension panel. For more info in the extension panel, please the page below. {% hint style="warning" %} If you are using multi-platform streaming, your extension link will be different per streaming service. {% endhint %} {% content-ref url="/pages/Rvgn4LfFQidqJm9fwjxJ" %} [Extension](/stream-avatars/extension) {% endcontent-ref %} # !hideavatar toggles the user's avatar to hide (also known as lurk mode) example: !hideavatar {% hint style="success" %} To reverse the effect of !hideavatar command type it again. {% endhint %} {% hint style="info" %} To run this command without typing into chat, use the extension panel's action tab. {% endhint %} # !mass {command} runs a command for every active avatar spawned. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !change {user} {command} runs a command as if it was the target user running that command. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !spawn {title} creates an avatar with the respective title. If a user is found with the title, it will use that instead. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !spawn remove {title} deletes an avatar with the respective title. (typically used on fake avatars spawned using the spawn command) {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !whitelist add {user} allows the target user to spawn regardless of your spawn settings. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !blacklist add {user} adds the target user to the blacklist, which prevents them from having an avatar and running commands. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !mod add {user} adds the user as a mod so they can run moderator only commands. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !leaderboard top 10 currency # !leaderboard exclude {user} excludes the target user from leaderboard entries. {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !game exclude {user} excludes a target user from participating in global minigames that have no opt-in. example: !game exclude clonzeh {% hint style="info" %} currently only works with the [battleroyale command](/stream-avatars/commands/minigames-and-fun-commands/battleroyale). {% endhint %} {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # !sounds Lists the available sounds that can be triggered by a command. example: !sounds {% hint style="info" %} Prints a list into chat on available options. {% endhint %} {% hint style="success" %} Sounds can be added in the settings section: [Sound Editing](/stream-avatars/application-settings/sounds) {% endhint %} example: !play alarm {% hint style="info" %} Plays the sound by the name of "alarm" (it won't work if you don't have the alarm sound). {% endhint %} # !shoutout {user} Puts the user's avatar on display example: !shoutout clonzeh {% hint style="info" %} Only moderators can run this command with default settings. {% endhint %} # Application Settings Managing settings for different categories in SA menus # General ## Viewer Spawning Settings 1. Which type of viewer is allowed to have an avatar. 2. Does the viewer need to be actively chatting? 3. Limit viewers - How many viewers can have an avatar at a given time. (Reduce this number to help with lag) 4. Despawn timer - How long it takes for an avatar to despawn. 5. Avatar profile - control which avatars can be used during a session.

## Window Settings 1. Move the application to the monitor you want it to open on by default. 2. Sets the window resolution. 3. Sets the window background color (Useful for using Window Capture) 4. Lock Resolution (When you connect it will always default the window size back to (#2) so your OBS capture never gets altered) 5. Application Framerate - If you have performance issues, you can try lowering this value. 6. Scale UI with resolution (this is supposed to help users that have 4k monitors) 7. Hide mouse (this can help prevent double mouse from appearing on your stream if your stream avatars is on the same monitor as your content) 8. Connect on startup (as soon as stream avatars launched, it will automatically connect!)

## Avatar Settings This section is for miscellaneous settings for avatars, commands, and customizations.

1. Extension leaderboard effects - enables rewards for achieving top placement in specific leaderboards (the above image shows the star particles effect flying off the avatar) 2. Chat bubble settings (when a user types in chat their message is displayed above their avatar) (you can install fonts to make the chat bubble work with other languages too) 3. Chatting sound settings (when a user types in chat, a sound will play) 4. Maximum sling power for the command [!sling {power} {angle}](/stream-avatars/commands/minigames-and-fun-commands/sling-power-angle) 5. Pinned Avatar settings for the command [!pin {target} {x%} {y%}](/stream-avatars/commands/minigames-and-fun-commands/pin-user-x-y-seconds)

1. Bomb settings for the command [!bomb](/stream-avatars/commands/minigames-and-fun-commands/bomb-user) 2. Freeze settings for the command [!freeze {target} {seconds}](/stream-avatars/commands/minigames-and-fun-commands/freeze-user-seconds) 3. Avatar emote popups occur during minigames (example: boss fight avatars will emote based on what's happening. It looks similar to a chat bubble) 4. Avatar despawn explosion (when enabled, rather that fading out, avatars will explode when they are being removed from the scene) 5. Fart settings for the command [!fart](/stream-avatars/commands/minigames-and-fun-commands/fart) or [!mass fart](/stream-avatars/commands/minigames-and-fun-commands/fart)

1. Attack settings for the command [!attack {target}](/stream-avatars/commands/minigames-and-fun-commands/attack-user) 2. Hug settings for the command [!hug {target}](/stream-avatars/commands/minigames-and-fun-commands/hug-user) 3. Dance settings for the command [!dance](/stream-avatars/commands/minigames-and-fun-commands/dance)

## Events 1. Follow event (occurs when a viewer follows your channel) 2. Platform donation event (occurs when a viewer donates real virtual currency)

1. Subscribe event (this occurs when a viewer subscribes(paid)) (twitch has multiple subscription tiers (1x, 2x, 3x)

## Data Settings 1. Steam cloud save settings 2. First time install setup wizard 3. Default avatar - can also be found on the workshop: block man 4. Mute all chat outputs - prevents your bot from sending any messages into chat (recommended to have this disabled) 5. Platform mods are bot mods - allows your moderators to automatically have access to moderator commands in SA. 6. Cleaning up old user data (useful for keeping startup times short and saving becomes less expensive) 7. Import Data is a debugging tool for helping the developer quickly switch SA data with another user's when provided. 8. Deletes everything in your data folder and starts SA fresh out of the box.

## Viewer Extension Panel 1. Enables communication with the SA server and uploads your content when you connect. (this allows the extension to function - if you want unlimited avatar space you will need to disable this) 2. SA Patreon - Support the developer and also gain bonus upload space with the SA Extension Server. 3. A quick link to the twitch extension (panel/component) install page. 4. Extension Link Settings - [!extension](/stream-avatars/commands/extension) * Extension link - a popout link for your viewers. * Announce link - periodically pastes the link in your chatroom. * Announce timer - how frequently the link is pasted. 5. Extension text display settings.

# Login Details ## Connecting your channel Navigate to Login Details and then select the streaming platform you want to connect with. Click both of the platform login buttons (Note: (#3) is for your "Bot" account, which is the **account** that will be **typing responses into your chat room**) {% hint style="info" %} The bot account can also be the same as your primary channel login if you want. {% endhint %} After you connect the platforms you should be able to click the "Test" button (#4) to make sure the connections are working. A green checkmark will appear if the logins are connected properly.

## Allowing multiple platforms Click the box for "Allow multiple platforms" and then click "Add this platform". You can do this for multiple streaming platforms in the dropdown selector.

Each platform has it's own associated color when you add it to the list of streaming services you will connect with. You can see which ones are added by looking beside the connect button for multiple colored boxes.

purple = twitch, yellow = dlive, red = youtube, dark blue = facebook, light blue = glimesh ...

# Minigames ## Boss Battle Settings that are related to the [!boss command](/stream-avatars/commands/minigames-and-fun-commands/boss) 1. Custom Bosses - (where you can create and edit bosses) 2. Default currency reward for players defeating a boss. 3. Boss Timers * Join Timer - (how long players have to join the battle) * Turn Timer - (how long a player has to make a decision) 4. Turn chat message (displays a message in chat when the next player should take their turn) 5. Bots fill spots (if less than 7 players join, bots will fill the rest) 6. Various display colors for the boss.

1. Various sound settings for the boss battle. 2. Positioning of the boss battle and related UI elements.

## Basketball Settings that are related to the [!basketball command](/stream-avatars/commands/minigames-and-fun-commands/basketball) 1. Currency reward settings for winners. 2. Default points to win (the game will end after a player or team reaches the point count) \[seconds] 3. Join timer (how long players have to join the game. During FFA players can join at any point) 4. Default game length timer (how long the minigame will last) \[seconds] 5. Various team settings.

1. Various sound settings for the basketball game. 2. Loot reward for winners. 3. Positioning of the basketball minigame and related UI elements.

## Battle Royale Settings that are related to the [!battleroyale command](/stream-avatars/commands/minigames-and-fun-commands/battleroyale) 1. Default win reward (how much currency the winner will receive) 2. Plane height & plane image override. 3. Med-kit image override. 4. Various sounds for the battle royale. 5. Loot reward for the winning player. 6. Positioning of the battle royale game and related UI elements.

## Duel Settings that are related to the[ !duel command](/stream-avatars/commands/minigames-and-fun-commands/duel-user-amount) 1. Accept timer (how long the player has to accept the duel challenge) 2. Minimum & Maximum duel wager amounts. 3. Various sounds for the duel minigame. 4. Loot reward for the winning player. 5. Positioning of the duel and related UI elements.

## Jump Catch Star Settings that are related to the [!spawn game command](/stream-avatars/commands/minigames-and-fun-commands/spawn-game) 1. Periodic spawn settings. 2. Win response and rewards.

1. Star image override and various settings for the minigame. 2. Loot reward for the player that catches the star.

## Roulette Settings that are related to the[ !bet command](/stream-avatars/commands/minigames-and-fun-commands/bet-amount-calltype) 1. Roll timer (how long it takes for the ball to land and display results) 2. Cooldown timer (how long before the game can be played again) \[seconds] 3. Moderators must initiate (only moderators can initiate the game, afterwards players can join in) 4. Display the winnings and losing in chat. 5. Win multipliers (red/black/even/odd = 50/50, 1st12,2nd12,3rd12 = 33%, Single digit bets = 2.78%) 6. Maximum bet amount (the max amount a player can bet on a single roll) ## Slots Settings that are related to the [!slots command](/stream-avatars/commands/minigames-and-fun-commands/slots-amount) 1. Reset all slots settings to default values. 2. Minimum and maximum bet amounts.

1. Win chance (how frequently a "win" will occur. Note: a win just means a payout of getting 3 of the same type) 2. Adjust the frequencies of what the win type will be. 3. Adjust the payouts based on win type. Make all values add up to 100% (50 means you win half your bet) 4. Slots scale size (how large the slot machine is)

# Avatars And Gear ## Avatar Settings 1. Avatar selection dropdown (this also has a search bar for finding specific avatars quickly!) 2. Avatar extra options - which has the following options: * Rename (rename the current selected avatar) * Copy (copy the current avatar settings) * Paste (paste the last copied avatar settings onto the current selected avatar) * Delete (delete the selected avatar and it's image file in the folder) * Update Preview (rebuilds the avatar's extension image - can fix palette swap issues) * Create Thumbnail (add a 62x62 thumbnail for the extension) * Remove Thumbnail (removes the extension thumbnail image) * Sorting (decides the order of avatars in the extension) 3. Is enabled (makes the avatar available for users to equip) 4. Allowed Gear (determine which gear sets the avatar can equip.

1. Sprite-sheet dimensions for slicing the avatar into frames (this does not affect the size the avatar appears!) (See: Scale (#4)) 2. Acceleration (when the avatar starts and stops walking the speed is reduced or increased over time to reach the correct value) 3. Palette Editor (a new page for reskinning the selected avatar by changing out colors quickly) 4. Scale (how large an avatar will appear while connected scale:1 is the default value and works well for avatars sized 32x32 to 64x64) (it's highly recommended to keep the scale value as 0.5, 1, 2, or 3 5. Move speed (how quickly an avatar moves, 10 is the default speed) 6. Collision box (the hit box determines where avatar nametags are placed and when the avatar collides with other collisions, like walls or blocks...) See nametags: [here](/stream-avatars/application-settings/nametag-settings#adjusting-nametag-height-position-on-an-avatar)

## Gear settings 1. Gear set selection (this also has a search bar for finding specific gear sets quickly!) (to add more gear sets see the setting in avatar: "Allowed Gear") 2. Gear set extra options: * Rename (rename the gear set) * Delete (delete the gear set and every gear piece inside the folder as well) * Sorting (decides the order of the gear sets in the extension) 3. Advanced options * Item none=random (forces the gear set to always have an item equipped) * Item Flips (useful for keeping an item from flipping with the avatar when facing a different direction. An example use case would be: the item has text that reads left to right) 4. Uses palette swap (allows the gear item to use the same palette swap as the avatar)

1. Gear piece selection (this also has a search bar for finding specific items quickly!) 2. Gear piece extra options * Rename (rename the gear piece) * Delete (delete the gear piece) * Update Preview (rebuild the extension preview for the item (this can fix palette swapping issues)) * Create Thumbnail (add a 62x62 thumbnail for the extension for the selected item) * Remove Thumbnail (remove the thumbnail) * Sorting (decides the order that the gear items appear in the extension) * Copy positions (copy all frame positions from the selected gear item) * Paste Positions (paste all frame positions to the selected gear set) 3. Scale (how large the gear item appears (note: this should probably be the same size as the avatar's scale) 4. Unique Z-Index (converts the item to having it's own value for z-index rather than following the gear set's value) 5. Z-Index (z-index refers to which image appears in front. Higher value means it will display over top of other images)

1. Animated (allows a gear piece to be an animated horizontal strip with a frame width & FPS setting included) 2. Has Unique Position (converts the items position to having it's own value rather than following the gear set's value) 3. Frame Anim (Allows the gear item to match it's animation with the avatar's on a frame by frame basis. The use case for this example is: an avatar wearing pants, and the pants need to align to the avatar's legs for each frame) See Creating Avatars video [here](/stream-avatars/content-creating/creating-avatars#tutorial-video).

## Avatar Frame Editor This area for avatar & gear is to give a preview and allow for editing gear positions for each individual frame. 1. Preview zoom (how large the preview appears -- this does not actually affect the avatar's size when you connect) 2. Frame selection (when you select a gear item, you can select an avatar frame. After selecting you are able to move the item's position with arrow keys or by editing the X:Y values in the gear item area) {% hint style="info" %} If you hold ALT while adjusting an item's position on a frame, it will adjust the position for the entire animation. {% endhint %}

1. Custom animation name (default animations cannot be renamed) 2. FPS (frames per second -- how quickly an animation plays) 3. Preview the animation. 4. Delays (toggles visibility of individual frame delays -- this will override the FPS for individual frames) 5. Advanced animation settings * Returns to idle (when the animation is finished it will return to idle) * Hold last frame (a number of seconds the animation will hold the last frame before continuing) * Animation loops (enables animation looping) * Loop # (how many times the animation will loop before continuing) * Targets a user (if this animation is designed to be used on another avatar, it will force the avatar to walk towards the target before running the animation) * Target distance (how close the avatar needs to be before executing the animation)

## Palette Editor Rather than making multiple avatars and coloring them differently, the preferred way is to use the palette editor. This can save you upload space and system resources and is also way easier for creating new content! 1. Palette selection 2. Palette options * Copy All (copies all the palettes that the current avatar has) * Copy Selected (copies the current selected palette) * Paste Selected (pastes the palette onto your current selection) * Auto Add Colors (try to automatically find and add the base colors for your avatar) * Auto Fix Colors (if your colors are slightly off, this can help fix them. But it can be dangerous to use this because it can alter existing colors that you don't want changed) * Fix All Colors (applies the above command to all palettes on every avatar. But it can be dangerous) 3. Manually add a new base palette color.

1. After creating a color palette, you can select it. 2. The selected color palette will be shown below the "main palette" 3. You can alter individual colors by first selecting them and then editing the colors {% hint style="info" %} Make sure not to edit the top row of colors when you are editing a palette! the top row is for sampling the main image, the bottom row is for adjusting the specific color swaps. {% endhint %}

## Creating an avatar walk-through The page link below has avatar creating guidelines and a tutorial video for assisting you in creating your custom avatar. {% content-ref url="/pages/WZZiexiJI8KpKN0wWayS" %} [Creating Avatars](/stream-avatars/content-creating/creating-avatars) {% endcontent-ref %} # Sounds ## Importing Sound Files To import a sound file, first you need the file type to be ".ogg". If you want to use another file type like ".mp3" or ".wav" you will need to use an audio format converter. \ \ You can easily find browser based audio converters by googling for it, they're quick and easy to use!

After converting your file to the correct format, click the "Import Sound" button. It will ask you to name the sound file. {% hint style="info" %} The name might be important incase you want people in chat to have the ability to play the sound with the [!sound](/stream-avatars/commands/sounds) command. {% endhint %}

## Sound Settings

1. Remove or Edit the sound name. 2. Allows randomizing of the pitch and volume sliders. (the bottom slider will appear and be considered the "MAX" range, while the top slider will be the "MIN" range. Make sure the max range is larger than the min range. 3. Allows the sound to be played from a chat command. ie: !play test\_*sound\_*one 4. Pitch - A higher pitch plays faster and squeakier , A lower pitch players slower and with more bass. 5. The volume level the sound will play at. 6. Global cooldown only matters if being played from the !play command. It affects all users. 7. User cooldown only matters if being played from the !play command. It affects only command calling user. ## Overriding Default Sounds Throughout the application you can find sound overrides. In this example you can see different sound overrides for the Duel minigame. * "Challenge" is when the duel is first requested. * "Game loop" is looped the whole time the duel is happening. * "Victory Sound" happens when the duel is over.

Some overrides have a default sound that the application has internally. You can override this value by switching it from "default" to whichever sound you want.

# Nametag Settings Section - Nametags - explanation of various settings ## Settings found in the nametag section

1. Creating custom nametags. Visit the [Content Creation documentation for nametags](/stream-avatars/content-creating/creating-nametags). 2. The group of settings related to nametags. 3. Hide on stack height - if nametags collide with each other, one will be chosen to rise up. This setting determines how high the nametags can stack up before they go invisible / disappear. [Look at the image below for a visualize of this setting](#nametag-stack-height). 4. Set the percentage of the distance between each row. 0% makes all nametags overlap. 100% is the default spacing between nametag rows. 5. Fade out on hide - determines whether the nametag disappears over time or instantly turns invisible. 6. Hide on inactivity - if a user has not typed into chat for a while, their nametag will hide. 7. Inactivity timeout - how many seconds before a user's nametag becomes "inactive" and goes invisible. 8. Collides with avatars - nametags normally only collide with each other, but when this is enabled, nametags will also collide with the hitboxes of the avatars, causing them to stack higher. 9. Nametag Sorting - determines the graphical sorting order of nametags. Behind avatars, After avatars, or Foreground. 10. Maximum name length - determines the maximum length a user's name can display on a nametag. example: "clonzeh" is 7 characters long. If you are interested in customizing your own nametags, please visit [this article](/stream-avatars/content-creating/creating-nametags) instead. {% content-ref url="/pages/KaXlylIu0JpGKMGKsQhO" %} [Creating Nametags](/stream-avatars/content-creating/creating-nametags) {% endcontent-ref %} ## Nametag stack height In the image below, the nametag stack height is set to: 2. This means any nametags that rise to row #3 will become invisible / disappear until they move to a space where it can fall back to the stack height limit.

## Adjusting Nametag height position on an avatar If your avatar has a nametag in an undesirable position, you can adjust the avatar's collision box by doing the following: Navigate to Avatar and Gear > select your avatar > click "Collision Box"

Here you can adjust the horizontal and vertical position of the nametag by click-dragging the handles on the red box outline.

# Import & Export This page is for privately sharing files created from SA. ## Importing Content to SA If you are importing content that another SA user is providing, you can do this simply by clicking "Select Import", on the Import & Export page. This will open up a file browser which will allow you to select any zip file. {% hint style="danger" %} Only zip files that were EXPORTED via SA will be able to be used with the Select File Import option. If you are trying to create avatars with sprite-sheets please visit [here](/stream-avatars/content-creating/creating-avatars) instead. {% endhint %}

## Exporting Content from SA This content will be in a .zip format and can be shared to other users. The zip file will be specially formatted for SA so that it can be imported easily. Navigate to Import & Export and Under export options: 1. Select avatars (the number 0 is how many are currently selected) 2. Select backgrounds (the number 0 is how many are currently selected) 3. Select bosses (the number 0 is how many are currently selected) 4. Click export selected and provide a name for your file. 5. Open the folder to find where your file is located.

--- [Next Page](/llms-full.txt/1)