Guide.gfx
Using GFX consist of 3 basic steps: [list=1] [*] you create an animation [*] add it in OBS(or whatever streaming software you use), and [*] either [list=a] [*] use it as an alert for events(eg. follow, host, donation) [*] use it as part of a command. [*]use it as an interactive button [*]use it to announce when a specific user joins your channel[/list][/list] [u][b]To create the animation:[/b][/u] [list=1] [*] make sure animation are enabled [*] click "open media folder" button and place the GIFs you wish to use in that folder. Click "Reload" button to refresh the list of images you can use. [*] give your animation a name and select your gif from the list of files [*] click "save" button to save your animation. You can tweak it later [*] click "Open Stream window" and a green(default) window will open up [*] click "Test" to preview your animation[/list]
[u][b]To add it to OBS:[/b][/u] 1) add a new source to whichever scene(s) you want it to appear in and choose "window capture" 2) select the window named "Scorpbot - Stream Window". do not select capture mouse cursor 3) create a color key to make the green background transparent [list=a] [*] in OBS classic check the "use color key" option and select the same green [*] in OBS studio click ok to close the window capture. right click the source you just created and choose "Filters". add a new "color key" filter and choose the same green[/list] 4) position/resize/crop/etc the window capture source you just created as you wish
[u][b]To use the animation..[/b][/u] [i][b]...for an alert:[/b][/i] [list=1] [*] open the settings tab in scorpbot [*] click the checkbox to enable the alert you want to use and select your animation for the GFX[/list] [i][b]...for a command:[/b][/i] [list=1] [*] open the commands tab in scorpbot [*] create a new command by giving it a name (eg !graphic) [*] from the variables drop-down select "gfx" and click the "add" button [*] in the command response area replace "animationname" with the name of your animation [*] click "save" button to save your new command. You probably want to specify permissions and cooldowns but you can do that later [*] in your chatroom type (as the streamer, not bot) the name of your command (eg. !graphic) to test it[/list] [i][b]...for an interactive button:[/b][/i] [list=1] [*] open the interactive tab in scorpbot [*] create a new button by entering the button text in the "text" field [*] in the "response" field type "$gfx(animationname)" (where "animationname" is the name of the animation you wish to use) [*] click the "create" button to create your new button [*] double-click your new button on the button layout panel to test it [*] make sure your new button is selected in the list, then resize and reposition your button as you wish [*] check the boxes "enabled" and "visible" (buttons must be invisible to make changes to them) [*] click "update" button to save the new settings to mixer [*] click "connect" to make your buttons appear on mixer[/list] [i][b]...for when a user joins:[/b][/i] [list=1] [*] open the viewers tab in scorpbot [*] right-click the username for the person you want to announce and select "edit viewer" [*] in the "entrance message" field type "$gfx(animationname)" (where "animationname" is the name of the animation you wish to use) [*] choose "On Enter" (plays as soon as they join the channel) or "On Speak" (plays the first time they speak after entering your channel [*] click "save"[/list]
