Stream Avatars Docs

Initial Setup

Click Login Details inside the Stream Avatars application.
Click Get Channel Token.
Create a new twitch account for a custom bot. (optional)
- Sign in with your bot account.
Click Get Bot Token.
Add a Game Capture to your streaming software and capture the window for Stream Avatars.exe.
- Crop the Game Capture to fit your stream.
- Set the Window Size of Stream Avatars to fit your stream.
Click Connect.

XSplit users may have to use color-key or chroma-key on the background color of Stream Avatars.
When connected, you can select a better suited background color by changing the setting found in the Quick Access bar.

Twitch Extension

Enable the extension in the General section of the Stream Avatars application.
Install the Twitch Extension.
Activate the Twitch Extension as a panel on your stream.

Importing Content

Download a content zip pack from the Stream Avatars' Discord Server.
Move the .zip file into the "import" folder.
Click Save and Reload.
Select the file name in the dropdown and then click Import Selected

Commands

— RED commands require bot moderator status —

!help — Displays a list of basic commands.

!random — Forces your avatar to equip a randomize layout. (avatar, color, gear items)

!avatars — Displays a list of available avatars.
!avatars <choice> — Forces your avatar to change to the chosen avatar.

!gear — Displays a list of available gear items that are inside the chosen gear set.
!gear <choice> — Displays a list of available gear sets.
!<choice> <choice> — Forces current avatar to equip the chosen gear item.

!colors — Displays a list of available colors for the current avatar.
!colors <choice> — Forces current avatar to equip the chosen color.

!nametags — Displays a list of available nametags.
!nametags <choice> — Equips the chosen nametag.

!actions — Displays a list of available actions for the current avatar.
!<choice> — Forces avatar to do the chosen action.
!<choice> <target> — Forces avatar to do the chosen action on chosen target user.

!show — Displays a list containing avatar, color, gear, and nametag this is currently equipped.
(also brings the avatar to the highest avatar layer)

!shop — Displays a list to navigate the shop options.
!buy avatar — Displays a list of avatars that can be purchased.
!buy colors — Displays a list of colors that can be purchased for the current avatar.
!buy actions — Displays a list of actions that can be purchased for the current avatar.
!buy gear — Displays a list of actions that can be purchased for the current avatar.
!buy nametags — Displays a list of actions that can be purchased for the current avatar.

!bet — Displays instructions for using the roulette game.
!bet <amount> <bet-type> — Places a bet on the bet-type for the roulette game.
(bet types: red/black, odd/even, 0-36, 1st12, 2nd12, or 3rd12.

!duel <target> <amount> — Challenge the target user to a duel for an amount of currency, winner takes all.
(bet types: red/black, odd/even, 0-36, 1st12, 2nd12, or 3rd12.

!slots <amount> — Bet an amount on the slot machine.
(bet amounts are limited between 5 and 500 by default).

!currency — Displays how much currency you have.
!<currency name> give <target> <amount> — Give target user an amount of your currency.
!<currency name> add <target> <amount> — Give target user an amount of currency without subtracting from your own.
!<currency name> remove <target> <amount> — Removes an amount of currency from the target user.

!gift <target> avatar <choice> — Allows target user to use the chosen avatar.
!gift <target> color <avatar> <choice> — Allows target user to use the chosen color.
!gift <target> action <avatar> <choice> — Allows target user to use the chosen action.
!gift <target> gear <gearSet> <choice> — Allows target user to use the chosen gear item.
!gift <target> nametag <choice> — Allows target user to use the chosen nametag.

!remove <target> avatar <choice> — Removes ownership from target user to use the chosen avatar.
!remove <target> color <avatar> <choice> — Removes ownership from target user to use the chosen color.
!remove <target> action <avatar> <choice> — Removes ownership from target user to use the chosen action.
!remove <target> gear <gearSet> <choice> — Removes ownership from target user to use the chosen gear item.
!remove <target> nametag <choice> — Removes ownership from target user to use the chosen nametag.

!mass — Issues multiple commands from all active users.
(examples: !mass jump, !mass avatar littlewalker, !mass attack random)

!change <target> <commands> — Issues a command as if the target had issued it.
(examples: !change clonzeh !jump, !change clonzeh !avatar littlewalker, !change clonzeh !random)

!spawn game — Creates a mini-game star that users can attempt to collect by issuing the jump action.
!spawn <target> — Creates an avatar. (if the target does not exist, it will be created as a new viewer)

!whitelist add <target> — Add target user to the whitelist. (allows user to spawn regardless of spawn settings)
!whitelist remove <target> — Remove target user from the whitelist.

!blacklist add <target> — Add target user to the blacklist. (prevents user from spawning)
!blacklist remove <target> — Remove target user from the blacklist.

!mod add <target> — Add target user as a bot moderator.
!mod remove <target> — Remove target user as a bot moderator.

— RED commands require bot moderator status —

Creating Avatars

Rules and Guidelines:

The image file type must be png.
Each frame should fit into an imaginary grid.
It's recommended to keep the frame size under 300x300 pixels.
It's recommended to keep the total image size under 2000x2000 pixels.
Sprites must be facing the right.
The character's feet should touch the bottom of the frame.
The character should be centered on the horizontal axis.
The first 5 rows are preset animations: idle, run, sit, stand, jump
After the 5 preset animations, you can create custom animations on the following rows.
You can override certain animations by setting the custom name appropriately. (hug, dance, attack, fart)

This sprite is 8x9 (grid lines are not saved in the final image)

This sprite is 24x24 and has a custom animation "sleep" (grid lines are not saved in the final image)

Navigate to your data folder by clicking the "Open Folder" button inside Stream Avatars.

Drop your avatar .png spritesheet into the avatars folder.

Click the "Save and Reload" button.

Change the width and height to be the correct frame sizes, in this case 24x24, and then click "Apply". Now you can scroll down the animation list to edit the custom animation for custom1.

Change the custom animation name to be "sleep", this will allow users to type !sleep to play it.

I also enabled the Animation Loops toggle in "Advanced", and set the number of loops to be over 60 so that the animation loops until another command is issued.

Creating Color Palettes

Select your avatar and then click the Palette editor button.

Create the "Main Palette". You do this by adding the color boxes and selecting the primary colors of your avatar. There is an eyedropper tool to assist in acquiring these colors.

Create a new Palette by entering a name and clicking "Create".
You can now adjust the colors to swap correctly.
Optionally, you can have gears use the same palette swap.