Commands

Overview

Commands are a special type of trigger that responds to specific chat patterns. While you could create chat triggers manually, the Commands system provides a streamlined interface for common use cases.

Creating Commands

1

Define Trigger Words

Enter one or more trigger words/phrases. Users can type any of these to activate the command. Don't include the ! prefix here - that's handled by the match mode.

Example: Multiple aliases

help
h
commands
cmds

2

Choose Match Mode

Select how the command should match chat messages. See Match Modes below.

3

Link an Action

Select or create an action that runs when the command is triggered. The action receives command context including arguments.

4

Configure Options

Set permissions, cooldowns, and platform restrictions.

Match Modes

Match modes determine how FaustBot identifies when a command is used.

Command Arguments

When users include text after the command, it's parsed into arguments you can use in your action.

!give @viewer 100 points

%rawInput%      → "@viewer 100 points"
%input0%        → "@viewer"
%input1%        → "100"
%input2%        → "points"
%inputCount%    → 3

// In scripts
args["rawInput"]
args["input0"]
args["inputCount"]

Using Arguments in Actions

Giving %input1% points to %input0%!

Permissions

Control who can use each command with role-based permissions.

Cooldowns

Prevent command spam with global and user-specific cooldowns.

Counter Tracking

Commands automatically track usage counts accessible in your actions:

%commandCount%       → Total times command was used
%userCommandCount%   → Times this user used the command

Action: Send Message
Message: "Death count: %commandCount%"

// Or increment via script
int count = CPH.GetCommandCounter("deaths");
CPH.SetCommandCounter("deaths", count + 1);

Common Examples

Simple Response

Follow me! Twitter: @streamer | Discord: discord.gg/xyz

User Lookup

%displayName%, you have %userPoints% points!

Moderation Command

string target = args["input0"].ToString();
int duration = int.Parse(args["input1"]?.ToString() ?? "60");
CPH.TwitchTimeoutUser(target, duration, "Mod command");
return true;

Random Response

// Set Variable effect
Variable: response
Value: $randomChoice("Yes!", "No.", "Maybe...", "Ask again later")$

// Send Message effect
Message: "🎱 %response%"