Skip to content

Commit 57c1261

Browse files
phroggsterphroggster
committed
Add a static V5 effects list
Ideally, this will *eventually* get replaced by an automated source code effects importer.
1 parent b88695a commit 57c1261

File tree

2 files changed

+89
-1
lines changed

2 files changed

+89
-1
lines changed

Diff for: ‎src/app/v5/core/effects/page.mdx

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Effects
2+
The effects available in Firebot represent the *cool* stuff that can happen in response to things like a command or an event. There are a lot of effects available, and even more ways to combine them in unique ways to create a memoriable experience for your viewers.
3+
4+
## Effects List
5+
Effects are contained within an effects list, and some effects can contain additional effect list(s). Each effects list has an unique ID, and can control features like which [Effect Queue](/effect-queues) to run the effects within. [Preset effect lists](/preset-effect-lists) are bespoke effect lists that can accept custom parameters. These can be very helpful for designing and testing larger collections of effects.
6+
7+
## List of Firebot Effects
8+
This list contains all of the effects available in Firebot. Note that custom third-party plugins can add additional effects that are not listed here:
9+
10+
| Name | Description | Categories |
11+
|---|---|---|
12+
| **Ad Break** | Trigger an ad break. | Common, Moderation, Twitch |
13+
| **Add Quote** | Adds a quote to the quote database. | Fun |
14+
| **Activity Feed Alert** | Display an alert in Firebot's activity feed. | Fun |
15+
| **Announce** | Send an announcement to your chat. | Common, Chat, Twitch |
16+
| **API Effect** | Pulls info from a pre-selected API. | Fun, Chat, Overlay |
17+
| **Approve/Reject Channel Reward Redemption** | Approves or rejects a pending Twitch channel reward redemption. | Common, Twitch |
18+
| **Ban** | Ban or unban a user. | Common, Moderation, Twitch |
19+
| **Block User** | Block or unblock a user on Twitch. | Common, Twitch |
20+
| **Cancel Twitch Prediction** | Cancels the currently-active Twitch prediction, and refunds all channel points wagered. | Common, Twitch |
21+
| **Celebration** | Celebrate with firework overlay effects. | Fun, Overlay |
22+
| **Chat** | Send a chat message. | Common, Chat, Twitch |
23+
| **Chat Feed Alert** | Display an alert in Firebot's chat feed. | Common, Chat |
24+
| **Clear Chat** | Clear all chat messages. | Common, Moderation, Twitch |
25+
| **Clear Effects** | Remove overlay effects, stop sounds, or clear effect queues. | Common, Overlay |
26+
| [**Conditional Effects**](/v5/guides/conditional-effects) | Conditionally run effects. | Advanced, Scripting |
27+
| **Cooldown Command** | Manually add or remove a cooldown for a command. | Common, Advanced, Scripting |
28+
| **Create Clip** | Creates a clip on Twitch. | Common, Fun, Twitch |
29+
| **Create Stream Marker** | Create a stream marker in your Twitch VOD. | Common, Twitch |
30+
| **Create Twitch Poll** | Create a Twitch poll. | Common, Twitch |
31+
| **Create Twitch Prediction** | Create a Twitch prediction. | Common, Twitch |
32+
| **Custom Script** | Run a custom JS script. | Advanced, Scripting |
33+
| **Custom Variable** | Save data to a custom variable that you can then use elsewhere. | Scripting |
34+
| **Delay** | Pause between effects. | Common, Advanced, Scripting |
35+
| **Delete Chat Message** | Delete the associated chat message. | Chat, Advanced, Twitch |
36+
| **Emulate Control** | Emulate keyboard keys or mouse clicks. | Advanced, Fun |
37+
| **End Twitch Poll** | Ends the currently-active Twitch poll. | Common, Twitch |
38+
| **Evaluate JavaScript** | Evaluate a JavaScript expression. | Advanced |
39+
| **Firebot Shoutout** | Display a shoutout graphic for a channel in the overlay. | Common, Fun, Overlay |
40+
| **HTTP Request** | Send an HTTP request to a given URL. | Advanced, Scripting |
41+
| **Lock Twitch Prediction** | Locks the currently-active Twitch prediction so that no more predictions can be made. | Common, Twitch |
42+
| **Log Message** | Adds an entry to the Firebot log. This is useful for debugging. | Advanced, Scripting |
43+
| **Loop Effects** | Loop an effect list. | Scripting |
44+
| **Manage Active Chat Users** | Add or remove users from the active chat user lists. | Common, Moderation |
45+
| **Mark All Activity As Acknowledged** | Marks all Activity as Acknowledged in the Chat page. | Common |
46+
| **Mod** | Mod or unmod a user. | Common, Moderation, Twitch |
47+
| **Pause/Resume Effect Queue** | Pauses or resumes an effect queue. Effects sent to a paused queue will run once the queue is resumed. | Scripting |
48+
| **Play Sound** | Plays a sound effect. | Common |
49+
| **Play Video** | Plays a local, YouTube, or Twitch video in the overlay. | Common, Overlay, Twitch |
50+
| **Purge** | Purge a user's chat messages from chat. | Common, Moderation, Twitch |
51+
| **Raid/Unraid Twitch Channel** | Start or cancel a raid to another Twitch channel. | Common, Twitch |
52+
| **Random Reddit Image** | Pull a random image from a selected subreddit. | Fun, Chat, Overlay |
53+
| **Remove User Metadata** | Remove a key from metadata associated to a given user. | Advanced, Scripting |
54+
| **Reset Timer** | Force a timer to restart its interval. | Common |
55+
| **Resolve Twitch Prediction** | Resolves the currently-active Twitch prediction by selecting an outcome, and pays out channel points to the prediction winners. | Common, Twitch |
56+
| **Roll Dice** | Specify an amount of dice to roll in chat. | Fun, Chat |
57+
| **Run Command** | Runs effects saved for the selected custom command. | Advanced |
58+
| **Run Effect List** | Run a preset or custom list of effects. | Advanced, Scripting |
59+
| **Run Program** | Run a program or executable. | Advanced, Scripting |
60+
| **Run Random Effect** | Run a random effect from a list of effects. | Advanced, Scripting |
61+
| **Run Sequential Effect** | Run a single effect sequentially from a list of effects. | Advanced, Scripting |
62+
| **Set Chat Mode** | Sets the chat mode(s) for your Twitch channel. | Common, Twitch |
63+
| **Set User Metadata** | Save metadata associated to a given user. | Advanced, Scripting |
64+
| **Show HTML** | Show an HTML snippet in the overlay. | Advanced, Overlay |
65+
| **Show Image/GIF** | Shows an image in the overlay. | Common, Fun, Overlay |
66+
| **Show Text** | Shows specified textin the overlay. | Common, Overlay |
67+
| **Snooze Next Ad Break** | Pushes back the next scheduled mid-roll ad break by 5 minutes. | Common, Moderation, Twitch |
68+
| **Set Stream Category** | Set the stream category/game. | Common, Moderation, Twitch |
69+
| **Set Stream Title** | Set the title of the stream. | Common, Moderation, Twitch |
70+
| **Stop Effect Execution** | Stop the execution of the current effect list. | Scripting |
71+
| **Switch Statement** | Conditionally run effects based on a value. | Advanced, Scripting |
72+
| **Take Screenshot** | Takes a screenshoit of the selected screen. | Fun |
73+
| **Text-To-Speech** | Have Firebot read out some text. | Fun |
74+
| **Timeout** | Timeout a user. | Common, Moderation, Twitch |
75+
| **Toggle Command** | Toggle a command's active status. | Common |
76+
| **Toggle Connection** | Toggle connection to Twitch and any linked integrations. | Advanced |
77+
| **Toggle Event** | Toggle an event's active status. | Common |
78+
| **Toggle Event Set** | Toggle an event sets active status. | Common |
79+
| **Toggle Scheduled Effect List** | Toggle a scheduled effect list's enabled status. | Common |
80+
| **Toggle Timer** | Toggle a timer's active status. | Common |
81+
| **Twitch Shoutout** | Send a Twitch shoutout to another channel. | Common, Twitch |
82+
| **Update Channel Reward** | Update settings for a channel reward. | Advanced, Twitch |
83+
| **Update Counter** | Update a counter's value. | Common, Advanced |
84+
| **Update Currency** | Update a viewer's currency. | Common, Fun |
85+
| **Update Viewer Rank** | Update a viewers rank within a given rank ladder. | Common |
86+
| **Update Viewer Roles** | Add, remove, or clear users from a custom role. | Advanced |
87+
| **VIP** | Add or remove the VIP role of a user. | Common, Moderation, Twitch |
88+
| **Write To File** | Write or delete some text in a file. | Advanced |

Diff for: ‎src/navigation.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const nav: Array<NavGroup> = [
1111
{
1212
title: 'Core concepts',
1313
links: [
14-
{ title: 'Effects', href: '/effects' },
14+
{ title: 'Effects', href: '/v5/core/effects' },
1515
{ title: 'Commands', href: '/commands' },
1616
{ title: 'Events', href: '/events' },
1717
{ title: 'Timers', href: '/timers' },

0 commit comments

Comments
 (0)