# Stream Avatars - [Introduction](https://docs.streamavatars.com/stream-avatars/introduction.md) - [Quick Setup](https://docs.streamavatars.com/stream-avatars/quick-setup.md) - [How to Overlay](https://docs.streamavatars.com/stream-avatars/how-to-overlay.md) - [Windows - Spout2 (Recommended)](https://docs.streamavatars.com/stream-avatars/how-to-overlay/windows-spout2-recommended.md) - [MacOS - Syphon (Recommended)](https://docs.streamavatars.com/stream-avatars/how-to-overlay/macos-syphon-recommended.md) - [OBS](https://docs.streamavatars.com/stream-avatars/how-to-overlay/obs.md) - [Streamlabs Desktop](https://docs.streamavatars.com/stream-avatars/how-to-overlay/streamlabs-desktop.md) - [XSplit](https://docs.streamavatars.com/stream-avatars/how-to-overlay/xsplit.md) - [Twitch Studio](https://docs.streamavatars.com/stream-avatars/how-to-overlay/twitch-studio.md) - [Unlisted / Other](https://docs.streamavatars.com/stream-avatars/how-to-overlay/unlisted-other.md) - [Extension](https://docs.streamavatars.com/stream-avatars/extension.md) - [Quick Guide](https://docs.streamavatars.com/stream-avatars/quick-guide.md) - [Commands](https://docs.streamavatars.com/stream-avatars/commands.md): How to use Stream Avatars commands - [!commands](https://docs.streamavatars.com/stream-avatars/commands/commands.md): 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. - [Selection Commands](https://docs.streamavatars.com/stream-avatars/commands/selection-commands.md): A group of commands related to changing your avatar selections. Includes: Avatars, Gear, Color Palettes, Nametag, Actions / Custom Animations. - [!random](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/random.md): equips a random avatar, gear items, and color palettes to your character - [!mass random](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/random/mass-random.md): runs a command on every active avatar - [!change {user} {command} random](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/random/change-user-command-random.md): runs the command as if the target user was running it - [!avatars](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars.md): posts a list of available avatars to your chatroom (this is disabled if you have too many avatars) - [!avatar {avatar}](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars/avatar-avatar.md): Command - Changes your avatar to the one selected by name - [!change {user} !avatar {avatar}](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars/change-user-avatar-avatar.md): Command - Changes the target user's avatar to the one selected by name - [!change {user} !avatar {avatar} {timer}](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars/change-user-avatar-avatar-timer.md): Temporarily changes the target user's avatar to the one selected by name for a period of time - [!mass avatar {avatar}](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars/mass-avatar-avatar.md): Command - Changes all active user's avatars to the one selected by name - [!mass avatar {avatar} {timer}](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/avatars/mass-avatar-avatar-timer.md): Command - Temporarily changes all active user's avatars to the one selected by name for a period of time - [!color](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/color.md): posts a list of available colors to your chatroom (this is disabled if you have too many colors) - [!gear](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/gear.md): posts a list of available gear sets to your chatroom (this is disabled if you have too many gear sets) - [!nametags](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/nametags.md): posts a list of available nametags to your chatroom. (this is disabled if you have too many nametags) - [!actions](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/actions.md): posts a list of available actions on your avatar to your chatroom. (this is disabled if you have too many actions) - [!show](https://docs.streamavatars.com/stream-avatars/commands/selection-commands/show.md): posts a list of equipped items on your character. - [Minigames and Fun Commands](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands.md): A group of commands that are fun to try! - [!basketball](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/basketball.md): Starts a global minigame between two basketball teams. - [!battleroyale](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/battleroyale.md): Starts a global minigame between two basketball teams. - [!boss](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/boss.md): Starts a global minigame with several players fighting a boss - [!duel {user} {amount}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/duel-user-amount.md): Starts a minigame between you and a target user, wagering an amount of loyalty points - [!slots {amount}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/slots-amount.md): start a slot machine with a wager of an amount of loyalty points. - [!bomb {user}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/bomb-user.md): spawns a bomb on your avatar - [!sling {power} {angle}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/sling-power-angle.md): Slings your avatar with a power and direction. - [!fart](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/fart.md): Spawns a fart cloud on your avatar and plays an animation (if one is added) - [!quote {#}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/quote.md): A quote system for storing and printing quotes from the streamer - [!roll {#d#}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/roll-d.md): Rolls a number of dice with a number of sides and prints the outcome. - [!8ball {question}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/8ball-question.md): Ask the 8ball a question and receive an answer. - [!freeze {user} {seconds}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/freeze-user-seconds.md): freezes the target user for an amount of seconds. - [!pin {user} {x%} {y%} {seconds}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/pin-user-x-y-seconds.md): pins a target avatar to a position - [!attack {user}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/attack-user.md): attacks a target user - [!dance](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/dance.md): tells your avatar to do a dance! - [!hug {user}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/hug-user.md): tells your avatar to hug another user's avatar - [!throw](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/throw.md): throws an avatar at a specific location - [!explode {target}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/explode-target.md): makes a target avatar explode - [!bet {amount} {calltype}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/bet-amount-calltype.md): start a roulette game with a wager of loyalty points. - [!scale {target} {size}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/scale-target-size.md): changes the scale of someone's avatar - [!spawn game](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/spawn-game.md): spawns a moving star. users can type !jump to try to catch if for a loyalty point bounty. - [!screensaver {seconds}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/screensaver-seconds.md): runs the global screensaver state on all active avatars. viewers fly across the screen like an old school DVD screensaver. - [!mass {command}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/mass-command.md): Runs a command for every active user. Some commands behave different when 'massed'. - [Shop Commands](https://docs.streamavatars.com/stream-avatars/commands/shop-commands.md): A group of commands related purchasing avatars and items from the SA shop. - [!shop](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/shop.md): posts a list of shop options to your live-stream's chat-room - [!buy avatars](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/buy-avatars.md): posts a list of avatar options to your live-stream's chat-room - [!buy colors](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/buy-colors.md): posts a list of avatar color options to your live-stream's chat-room - [!buy gear](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/buy-gear.md): posts a list of gear set options to your live-stream's chat-room - [!buy nametags](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/buy-nametags.md): posts a list of nametag options to your live-stream's chat-room - [!buy actions](https://docs.streamavatars.com/stream-avatars/commands/shop-commands/buy-actions.md): posts a list of actions on your avatar options to your live-stream's chat-room - [Currency Commands](https://docs.streamavatars.com/stream-avatars/commands/currency-commands.md): A group of commands related to currency (loyalty points). - [!currency](https://docs.streamavatars.com/stream-avatars/commands/currency-commands/currency.md): posts how much currency you have into the chat room - [!currency add {user} {amount}](https://docs.streamavatars.com/stream-avatars/commands/currency-commands/currency-add-user-amount.md): adds currency to the target user - [!currency remove {user} {amount}](https://docs.streamavatars.com/stream-avatars/commands/currency-commands/currency-remove-user-amount.md): removes currency from the target user - [!currency give {user} {amount}](https://docs.streamavatars.com/stream-avatars/commands/currency-commands/currency-give-user-amount.md): transfers currency from you to the target user - [Gifting Commands](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands.md): A group of commands related to giving viewers commodities. (items, currency, special, rare) - [!gift {user} lootbox {name}](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-lootbox-name.md): Gives a target user a lootbox! - [!gift {user} avatar {avatar}](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-avatar-avatar.md): grants ownership of an avatar to a target user. - [!gift {user} gear {gear\_set} {gear\_piece}](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-gear-gear_set-gear_piece.md): grants ownership of a gear piece to a target user. - [!gift {user} color {avatar} {color}](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-color-avatar-color.md): grants ownership of an avatar's color palette to a target user. - [!gift {user} nametag {nametag}](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-nametag-nametag.md): grants ownership of a nametag to a target user. - [!gift {user} all true](https://docs.streamavatars.com/stream-avatars/commands/gifting-commands/gift-user-all-true.md): grants ownership of everything in the shop. - [Remove Ownership Commands](https://docs.streamavatars.com/stream-avatars/commands/remove-ownership-commands.md): A group of commands related to removing viewers commodities. (items, currency, special, rare) - [!remove {user} avatar {avatar}](https://docs.streamavatars.com/stream-avatars/commands/remove-ownership-commands/remove-user-avatar-avatar.md): removes ownership of an avatar to a target user. - [!remove {user} gear {gear\_set} {gear\_piece}](https://docs.streamavatars.com/stream-avatars/commands/remove-ownership-commands/remove-user-gear-gear_set-gear_piece.md): removes ownership of a gear piece from a target user. - [!remove {user} color {avatar} {color}](https://docs.streamavatars.com/stream-avatars/commands/remove-ownership-commands/remove-user-color-avatar-color.md): removes ownership of an avatar's color palette from a target user. - [!remove {user} nametag {nametag}](https://docs.streamavatars.com/stream-avatars/commands/remove-ownership-commands/remove-user-nametag-nametag.md): removes ownership of a nametag from a target user. - [!extension](https://docs.streamavatars.com/stream-avatars/commands/extension.md): posts an extension link to your live-stream's chat-room for accessing the extension panel. - [!hideavatar](https://docs.streamavatars.com/stream-avatars/commands/hideavatar.md): toggles the user's avatar to hide (also known as lurk mode) - [!mass {command}](https://docs.streamavatars.com/stream-avatars/commands/mass-command.md): runs a command for every active avatar spawned. - [!change {user} {command}](https://docs.streamavatars.com/stream-avatars/commands/change-user-command.md): runs a command as if it was the target user running that command. - [!spawn {title}](https://docs.streamavatars.com/stream-avatars/commands/spawn-title.md): creates an avatar with the respective title. If a user is found with the title, it will use that instead. - [!whitelist add {user}](https://docs.streamavatars.com/stream-avatars/commands/whitelist-add-user.md): allows the target user to spawn regardless of your spawn settings. - [!blacklist add {user}](https://docs.streamavatars.com/stream-avatars/commands/blacklist-add-user.md): adds the target user to the blacklist, which prevents them from having an avatar and running commands. - [!mod add {user}](https://docs.streamavatars.com/stream-avatars/commands/mod-add-user.md): adds the user as a mod so they can run moderator only commands. - [!leaderboard](https://docs.streamavatars.com/stream-avatars/commands/leaderboard.md): top 10 currency - [!leaderboard exclude {user}](https://docs.streamavatars.com/stream-avatars/commands/leaderboard-exclude-user.md): excludes the target user from leaderboard entries. - [!game exclude {user}](https://docs.streamavatars.com/stream-avatars/commands/game-exclude-user.md): excludes a target user from participating in global minigames that have no opt-in. - [!sounds](https://docs.streamavatars.com/stream-avatars/commands/sounds.md): Lists the available sounds that can be triggered by a command. - [!shoutout {user}](https://docs.streamavatars.com/stream-avatars/commands/shoutout-user.md): Puts the user's avatar on display - [Application Settings](https://docs.streamavatars.com/stream-avatars/application-settings.md): Managing settings for different categories in SA menus - [General](https://docs.streamavatars.com/stream-avatars/application-settings/general.md) - [Login Details](https://docs.streamavatars.com/stream-avatars/application-settings/login-details.md) - [Minigames](https://docs.streamavatars.com/stream-avatars/application-settings/minigames.md) - [Avatars And Gear](https://docs.streamavatars.com/stream-avatars/application-settings/avatars-and-gear.md) - [Sounds](https://docs.streamavatars.com/stream-avatars/application-settings/sounds.md) - [Nametag Settings](https://docs.streamavatars.com/stream-avatars/application-settings/nametag-settings.md): Section - Nametags - explanation of various settings - [Import & Export](https://docs.streamavatars.com/stream-avatars/application-settings/import-and-export.md): This page is for privately sharing files created from SA. - [Shop Editing](https://docs.streamavatars.com/stream-avatars/application-settings/shop-editing.md) - [User Editing](https://docs.streamavatars.com/stream-avatars/application-settings/user-editing.md) - [Unfinished Docs!](https://docs.streamavatars.com/stream-avatars/application-settings/unfinished-docs.md) - [Bot Commands](https://docs.streamavatars.com/stream-avatars/application-settings/bot-commands.md) - [Custom Commands](https://docs.streamavatars.com/stream-avatars/application-settings/bot-commands/custom-commands.md) - [Edit Lootboxes](https://docs.streamavatars.com/stream-avatars/application-settings/edit-lootboxes.md) - [Backgrounds](https://docs.streamavatars.com/stream-avatars/application-settings/backgrounds.md) - [Bot Commands](https://docs.streamavatars.com/stream-avatars/application-settings/bot-commands-1.md) - [Content Creating](https://docs.streamavatars.com/stream-avatars/content-creating.md): Creating and editing your content for Stream Avatars. - [Creating Avatars](https://docs.streamavatars.com/stream-avatars/content-creating/creating-avatars.md): Adding your own content - How to create your own avatar sprite-sheet - [Deleting Avatars, Palettes/Colors, and Gear](https://docs.streamavatars.com/stream-avatars/content-creating/deleting-avatars-palettes-colors-and-gear.md): How to delete avatars, colors, and gear sets or gear piece items. - [Creating Gear](https://docs.streamavatars.com/stream-avatars/content-creating/creating-gear.md): Adding your own content - - [Creating Colors](https://docs.streamavatars.com/stream-avatars/content-creating/creating-colors.md): Adding your own content - - [Creating Backgrounds](https://docs.streamavatars.com/stream-avatars/content-creating/creating-backgrounds.md): Adding your own content - - [Creating Bosses](https://docs.streamavatars.com/stream-avatars/content-creating/creating-bosses.md): Adding your own content - - [Creating Player Classes (boss)](https://docs.streamavatars.com/stream-avatars/content-creating/creating-player-classes-boss.md): Adding your own content - - [Creating Nametags](https://docs.streamavatars.com/stream-avatars/content-creating/creating-nametags.md): Adding your own content - - [Creating Lootboxes](https://docs.streamavatars.com/stream-avatars/content-creating/creating-lootboxes.md): Adding your own content - - [Importing Scripts](https://docs.streamavatars.com/stream-avatars/content-creating/importing-scripts.md) - [Importing Private Content](https://docs.streamavatars.com/stream-avatars/content-creating/importing-private-content.md): This is usually used if you commission someone to make SA content and you want them to privately transfer the finished work to you. Ready to use in one click. - [Creating Custom Redemptions](https://docs.streamavatars.com/stream-avatars/content-creating/creating-custom-redemptions.md): Creating custom redemptions for twitch & other services that support this feature. - [Creating Extension Thumbnails](https://docs.streamavatars.com/stream-avatars/content-creating/creating-extension-thumbnails.md) - [Creating Custom Language Localization](https://docs.streamavatars.com/stream-avatars/content-creating/creating-custom-language-localization.md) - [Integrations](https://docs.streamavatars.com/stream-avatars/integrations.md) - [Stream Deck](https://docs.streamavatars.com/stream-avatars/integrations/stream-deck.md): Using SA with your Stream Deck - [Support](https://docs.streamavatars.com/stream-avatars/support.md) - [New Platform Additions](https://docs.streamavatars.com/stream-avatars/support/new-platform-additions.md): requirements for Stream Avatars to add a new platform - [Various Troubleshooting](https://docs.streamavatars.com/stream-avatars/support/various-troubleshooting.md) - [Data Folder](https://docs.streamavatars.com/stream-avatars/support/data-folder.md): Finding your data and how to back it up or transfer it manually. - [Beta Branch](https://docs.streamavatars.com/stream-avatars/support/beta-branch.md): how to use a beta version of SA on steam. - [F.A.Q](https://docs.streamavatars.com/stream-avatars/support/f.a.q.md): Frequently Asked Questions - [Crash Log - Event Viewer](https://docs.streamavatars.com/stream-avatars/support/crash-log-event-viewer.md): If the app crashes, the logs might not be able to record anything useful to find out what's wrong. Sometimes we can find good information using Windows Event Viewer. - [Stream Avatars Partner](https://docs.streamavatars.com/stream-avatars/stream-avatars-partner.md) --- # 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.md?ask= ``` 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.