# Docs ## Docs - [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 - [!climb {user}](https://docs.streamavatars.com/stream-avatars/commands/minigames-and-fun-commands/climb-user.md): climbs 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. - [!spawn remove {title}](https://docs.streamavatars.com/stream-avatars/commands/spawn-remove-title.md): deletes an avatar with the respective title. (typically used on fake avatars spawned using the spawn command) - [!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) - [Introduction](https://docs.streamavatars.com/lua-scripting-api/introduction.md): API - - [Quick Start](https://docs.streamavatars.com/lua-scripting-api/quick-start.md): API - - [API Reference & Tips](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips.md): API - Reminders, Helpful tips, and things you should know before starting. - [Global Functions](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions.md): API - Various functions that let you interact with SA (API) - [log](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/log.md): API - prints a message to console log - [wait](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/wait.md): API - pauses the script for x amount of seconds. (essentially a timer) - [yield](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/yield.md): API - pauses the script for x amount of seconds. - [yieldBreak](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/yieldbreak.md): API - pauses the script for x amount of seconds. - [async functions](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/async-functions.md): API - pauses the script for x amount of seconds. - [waitForAsync function](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/waitforasync-function.md): API - pauses the script for x amount of seconds. - [stopAsync function](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/stopasync-function.md): API - pauses the script for x amount of seconds. - [get](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/get.md): API - gets global variables from the main coroutine. - [set](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/set.md): API - sets global variables to the main coroutine. - [applyImage](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/applyimage.md): API - applies an image or animation to a GameObject. - [waitForAnimation](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/waitforanimation.md): API - pauses script until an image is finished animating - [webrequest get/post](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/webrequest-get-post.md): API - - [getUser](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getuser.md): API - gets an active User by displayName or ID - [getUsers](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getusers.md): API - gets all active users in an array. - [getUserById](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getuserbyid.md): API - gets a User by id - [getCurrency](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getcurrency.md): API - gets the target User's currency value - [addCurrency](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/addcurrency.md): API - add currency to a target user - [removeCurrency](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/removecurrency.md): API - remove currency to a target user - [adjustCurrency](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/adjustcurrency.md): API - adjust currency of a target user (sets their currency to specified a amount) - [getBackground](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getbackground.md): API - gets the title of the current background level - [getScriptableBlocks](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getscriptableblocks.md): API - gets all of the scriptable blocks on the current background level - [getAvatar](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getavatar.md): API - gets a specific avatar - [getAllAvatars](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getallavatars.md): API - gets all available avatars - [runCommand](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/runcommand.md): API - sends a message to the application to run a specific command - [writeChat](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/writechat.md): API - sends a message to your live stream chatroom - [setProperty](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/setproperty.md): API - this is just a helper function to set a default value, but if a value already exists it will do nothing. - [getApp](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/getapp.md): API - returns the App class which gives access to a group of functions and properties related to SA application. - [save](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/save.md): API - saves the global variable: data on the main coroutine. This data can be found as a .JSON file in the script's folder. - [load](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/load.md): API - Loads the .JSON file from the script folder. This can be used to have data persist between streaming sessions, or to just store script settings in a single location. - [addEvent](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/addevent.md): API - subscribe to an event to receive data and a trigger of when certain situations occur - [removeEvent](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/removeevent.md): API - unsubscribe to an event that you previously subscribed to. - [keepAlive](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/global-functions/keepalive.md): API - Keep the script alive by pausing it. This allows for other coroutines to be processed while the main script doesn't really do much. - [Events](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events.md): API - Events are essentially triggers to run code. You can subscribe to every event once per script. - [BankController](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/bankcontroller.md): API - - [ServiceController](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/servicecontroller.md): API - - [Read Chat](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/read-chat.md): API - - [Websockets](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/websockets.md): API - - [Scriptable Block Trigger](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/scriptable-block-trigger.md): API - - [Platform Donation](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/platform-donation.md): API - - [App State Change](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/app-state-change.md): API - - [Custom Command](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/custom-command.md): API - - [Basketball Outcome](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/basketball-outcome.md): API - - [BattleRoyale Outcome](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/battleroyale-outcome.md): API - - [Boss Battle Outcome](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/boss-battle-outcome.md): API - - [Boss Battle Player Joined](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/boss-battle-player-joined.md): API - - [Duel Outcome](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/duel-outcome.md): API - - [On JumpCatch Star](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-jumpcatch-star.md): API - - [On Background Switch](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-background-switch.md): API - - [On Avatar Change](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-avatar-change.md): API - - [On Gear Change](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-gear-change.md): API - - [On New Viewer](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-new-viewer.md): API - - [On InitializeNewViewer](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-initializenewviewer.md): API - - [On Follower](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-follower.md): API - - [On Raid](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-raid.md): API - - [On Subscriber](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-subscriber.md): API - - [On Avatar Spawn](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-avatar-spawn.md): API - - [On Trigger Object](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-trigger-object.md): API - - [On Hotkey](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-hotkey.md): API - - [On Purchase](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/events/on-purchase.md): API - - [Classes](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes.md): API - Classes are objects that get returned by functions. This lists all properties and functions attached to those objects. - [App](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app.md): API - - [globalAvatarScale {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/globalavatarscale-get-set.md): API - - [globalNametagScale {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/globalnametagscale-get-set.md): API - - [globalChatBubbleScale {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/globalchatbubblescale-get-set.md): API - - [globalNametagStack {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/globalnametagstack-get-set.md): API - - [getResolution](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getresolution.md): API - - [platformServiceSettings](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/platformservicesettings.md): API - Allows controlling of the custom lua streaming platform - [setResolution](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/setresolution.md): API - - [setFullscreen](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/setfullscreen.md): API - - [getStreamer](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getstreamer.md): API - - [convertPositionToPercent](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/convertpositiontopercent.md): API - - [convertPercentToPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/convertpercenttoposition.md): API - - [playSound](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/playsound.md): API - - [createBomb](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/createbomb.md): API - - [pitchSound](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/pitchsound.md): API - - [stopSound](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/stopsound.md): API - - [soundIsPlaying](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/soundisplaying.md): API - - [createGameObject](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/creategameobject.md): API - - [getGameObject](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getgameobject.md): API - - [createChatBubble](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/createchatbubble.md): API - - [createWebsocket](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/createwebsocket.md): API - - [removeWebsocket](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/removewebsocket.md): API - - [sendWebsocketMessage](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/sendwebsocketmessage.md): API - - [getAppState](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getappstate.md): API - - [sha256\_base64](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/sha256_base64.md): API - - [getUserFromData](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getuserfromdata.md): API - - [getIdsFromData](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/getidsfromdata.md): API - - [deleteUser](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/deleteuser.md): API - - [exportAvatarImage](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/exportavatarimage.md): API - - [translateCommand](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/app/translatecommand.md): API - Used for getting the real translation settings of a command - [User](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user.md): API - - [id {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/id-get.md): API - - [isActive {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/isactive-get.md): API - - [isFake {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/isfake-get.md): API - "fake" is an avatar spawned from other places than via your chatroom. - [lastActiveDate {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/lastactivedate-get.md): API - - [secondsSinceLastActive {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/secondssincelastactive-get.md): API - - [displayName {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/displayname-get.md): API - - [channelName {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/channelname-get.md): API - - [follower {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/follower-get.md): API - - [vip {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/vip-get.md): API - - [subscriber {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/subscriber-get.md): API - - [subTier {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/subtier-get.md): API - - [moderator {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/moderator-get.md): API - - [platformModerator {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/platformmoderator-get.md): API - - [platform {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/platform-get.md): API - - [streamer {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/streamer-get.md): API - - [avatar {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/avatar-get-set.md): API - - [scale {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/scale-get-set.md): API - - [override\_scale {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/override_scale-get-set.md): API - - [color {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/color-get-set.md): API - - [nametag {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/nametag-get-set.md): API - - [getState](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getstate.md): API - - [getGear](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getgear.md): API - - [setGear](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/setgear.md): API - - [setPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/setposition.md): API - - [getPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getposition.md): API - - [getWearableAvatars](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getwearableavatars.md): API - - [getWearableAvatarColors](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getwearableavatarcolors.md): API - - [getWearableGearSetPieces](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getwearablegearsetpieces.md): API - - [getWearableNametags](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/getwearablenametags.md): API - - [setTemporaryAvatar](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/settemporaryavatar.md): API - - [setTemporaryColor](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/settemporarycolor.md): API - - [setTemporaryNametag](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/settemporarynametag.md): API - - [setTemporaryGear](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/settemporarygear.md): API - - [setTemporaryNone](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/settemporarynone.md): API - - [clearAllTemporarySelections](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/clearalltemporaryselections.md): API - - [chatBubble](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/chatbubble.md): API - - [look](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/look.md): API - - [runCommand](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/runcommand.md): API - - [physics](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/physics.md): API - - [saveUserData](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/saveuserdata.md): API - - [loadUserData](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/user/loaduserdata.md): API - - [Physics](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/physics.md): API - - [grounded {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/physics/grounded-get-set.md): API - - [setVelocity](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/physics/setvelocity.md): API - - [ObjectPhysics](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics.md): API - - [hasTrigger {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/hastrigger-get.md): API - - [hasRigidBody {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/hasrigidbody-get.md): API - - [layer {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/layer-get-set.md): API - - [kinemetic {get;set}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/kinemetic-get-set.md): API - - [setVelocity](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/setvelocity.md): API - - [addBoxCollider](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/addboxcollider.md): API - - [addCircleCollider](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/addcirclecollider.md): API - - [addBoxTrigger](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/addboxtrigger.md): API - - [addCircleTrigger](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/objectphysics/addcircletrigger.md): API - - [Avatar](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar.md): API - - [name {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar/name-get.md): API - - [getGear](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar/getgear.md): API - - [getGearPieces](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar/getgearpieces.md): API - - [getColors](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar/getcolors.md): API - - [getActions](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/avatar/getactions.md): API - - [GameObject](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject.md): API - - [image {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/image-get.md): API - - [destroy](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/destroy.md): API - - [setAngle](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/setangle.md): API - - [setPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/setposition.md): API - - [getPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/getposition.md): API - - [adjustPosition](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/adjustposition.md): API - - [getScale](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/getscale.md): API - - [setScale](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/setscale.md): API - - [adjustScale](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/adjustscale.md): API - - [physics](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/gameobject/physics.md): API - - [Image](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image.md): API - - [playAnimation](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/playanimation.md): API - - [stopAnimation](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/stopanimation.md): API - - [flipX](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/flipx.md): API - - [flipY](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/flipy.md): API - - [sorting](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/sorting.md): API - - [anchor](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/image/anchor.md): API - - [ScriptableBlock](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/scriptableblock.md): API - - [id {get}](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/scriptableblock/id-get.md): API - - [position](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/classes/scriptableblock/position.md): API - - [Helper Class](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class.md): API - Various functions I included to make programming easier. - [createCooldown](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/createcooldown.md): API - - [checkCooldown](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/checkcooldown.md): API - - [setCooldown](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/setcooldown.md) - [cooldownTimeLeft](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/cooldowntimeleft.md): API - - [startsWith](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/startswith.md): API - - [replace](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/replace.md): API - - [split](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/split.md): API - - [randomElement](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/randomelement.md): API - - [hasValue](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/hasvalue.md): API - useful for checking if an array contains a value - [matchRegex](https://docs.streamavatars.com/lua-scripting-api/api-reference-and-tips/helper-class/matchregex.md): API - useful for checking if an array contains a value