Effect Types

There are many different kinds of button types available in Firebot. Here is a quick rundown.

API Buttons These buttons go to an API on the web, and then pull some information that will be posted into your chat. Most of these are pretty silly such as pulling a random pokemon from the pokemon database or posting cat facts.

Celebration This button type provides special effects for your stream. For example, you could have people click a button that shoots fireworks all over your screen as the national anthem plays. You will need to load up the overlay file located in the main Firebot folder for this to work. (/firebot/overlay/firebot.html)

Change Groups This button will move the person who clicked it into a different group. This is useful for showing a single person a different set of controls.

Change Scenes When this button is clicked a user will change the scene for all members of a specific group. Using the reset setting will change all groups back to their original scene.

Chat The chat effects allows you to send any text you want into chat. You can even whisper to people! A variable $(user) has been added so you can add the name of the user who pressed the button into your commands. Remember, you can whisper commands to your bot with this to control things like Scorpbot and Scottybot!

Cooldown This allows you to put any other button on cooldown when this button is clicked.

Custom Script The custom script button effect allows you to write your own javascript node module and run it through Firebot. Running a script from an unknown source could damage Firebot, your Mixer account, or worse. Because of this the option must be enabled in the settings tab of Firebot. To learn more visit the custom scripts wiki page for examples. Use at your own risk. The Firebot devs take no responsibility for anything that happens when using this option.

Dice This button will roll some dice and output results to chat. You can roll anything you want. For example "2d20+5" would roll two 20 sided dice and then add 5. "2d20+1d12" would roll a d20 and a d12.

Game Controls Game control buttons simulate mouse and keyboard movements on the machine that Firebot is running on. Joystick and Mouse movements are automatically covered in this if they are on the interactive board. Please note that different programs handle keypresses differently so this might not work for everything. Test before streaming, and also try the two emulators provided in the settings menu.

HTML This button will output some HTML to the overlay. Create a single div and put everything you want inside of that div. No need for doctypes or headers or any other structure. It's just a single div. Whatever goes in that div will be appended to the overlay with JS. Note that local filepaths should be like this: "file:///F:/Downloads/old/ROARRRRR.mp4"

Play Sound The play sound button allows you to trigger a sound effect when the button is pressed. This sound is played through the Firebot app itself and not the overlay file. You can also set the volume here so you don't need to do any sound editing.

Show Image The show image effect allows you to show images on your stream. You do this by loading up the overlay file located in the main Firebot folder (/firebot/overlay/firebot.html).

Show Video This will load up a video in the Firebot overlay. You can also choose to load a video directly from youtube. Remember that you'll need the firebot overlay loaded into your streaming software to see the effect. (/firebot/overlay/firebot.html)