Configuring Mod Added Commands β
by CodeWithTD β
Version: 1.0.0DLL Streamer.bot Import
Give your moderation team the ability to add, edit, modify and delete commands directly from chat, without needing access to Streamer.bot.
π View on StreamUP Shopπ‘General Notice
This guide assumes you have the latest StreamUP DLL installed. All required plugins, including the StreamUP plugin, and Streamer.Bot should be up to date. It also assumes you have already imported any fonts, OBS scenes or Browser Sources and Streamer.Bot import files.
Please make sure you have followed the standard product installation steps for StreamUP products.
If you haven't and where appropriate please follow these specifically:
Some steps are accompanied by images, you can click on these images to make them bigger. Where appropriate they have been tagged with Numbers, you can find the corresponding number in brackets (X)
Settings β
To open the settings, right-click the Settings trigger and select Test Trigger.
This will open the Mod Added Commands settings window, where you can configure how commands created through the system will behave.
Command Table β
The Command Table contains all commands that have been created through Mod Added Commands, along with their individual settings.
| Setting | Description |
|---|---|
| Command | The command users will type in chat to trigger the response. |
| Command Text | The response that will be output when the command is used. This can be left empty if the command is only being used to play a sound. |
| Permission | Controls who can use the command. 1 = Everyone, 2 = VIP or Paid Member/Subscriber, 3 = Moderator, 4 = Broadcaster. |
| Global Cooldown | Controls how often the command can be used by anyone. |
| User Cooldown | Controls how often an individual user can use the command. |
| Sound Volume | Controls the volume of the sound associated with the command. This is useful for balancing sounds that are naturally louder or quieter than others. |
General Settings β
| Setting | Description |
|---|---|
| Allow Globals | Allows commands to access Streamer.bot Global Variables using global{} and temp{}. |
| Allow Sounds | Allows sounds to be added to commands using sound{url}. |
| Allow Fetching from URL | Allows commands to retrieve information from URLs and APIs using fetch{url}. |
| Banned Commands | Commands listed here cannot be created or modified through Mod Added Commands. The system's built-in protected commands will automatically be added when the settings are saved. |
Default Command Settings β
These settings are used whenever a new command is created without specifying its own values.
| Setting | Description |
|---|---|
| Default Global Cooldown | The default global cooldown applied to newly created commands. |
| Default User Cooldown | The default per-user cooldown applied to newly created commands. |
| Default Permission | The default permission level applied to newly created commands. |
| Default Sound Volume | The default volume used when a newly created command contains a sound. |
How to Use β
This guide explains how to add, edit, modify, and delete commands.
If you're going to allow your moderation team to manage commands, it's a good idea to share this page with them.
There is also a Command Helper at the bottom of this page to help you build commands and their settings.
Important: When referencing a command, do not include the
!.For example, if your command is
!hug, you would reference it ashug.
Adding and Editing Commands β
Commands can be added or edited using:
!addcom <command> <info>
!editcom <command> <info>
For example:
!addcom hug %user% gives %targetUser% a hug!
The <info> section contains the command's output and can also contain its settings.
If you don't provide settings:
- When adding a command, the default settings will be used.
- When editing a command, the command's current settings will remain unchanged.
Using Streamer.bot Arguments β
You still have access to Streamer.bot arguments inside your command output.
For example:
%user%
%targetUser%
%userId%
You can also use:
%input%
This can be used instead of %rawInput% to access everything entered after the command.
Sounds β
You can add a sound to a command using:
sound{url}
For example:
!addcom airhorn AIRHORN! sound{https://example.com/airhorn.mp3}
The sound will be downloaded and associated with the command.
Fetching API Data β
You can fetch information from an API or URL using:
fetch{url}
For example:
fetch{https://example.com/api}
Arguments can also be used inside the URL, allowing the request to change depending on who used the command or what they entered.
For example:
fetch{https://example.com/api/user/%user%}
Global Variables β
You can access Streamer.bot Global Variables from your command output.
For persisted Global Variables, use:
global{varName}
For non-persisted / temporary Global Variables, use:
temp{varName}
For example:
global{totalWins}
or:
temp{currentGame}
The value of the variable will be inserted into the command output.
Counters β
Commands also have access to a built-in counter system.
You can create as many named counters as you need.
| Action | Syntax |
|---|---|
| Get the current value | count{name} |
| Add 1 | count{name+} |
| Subtract 1 | count{name-} |
For example:
!addcom deaths The streamer has died count{deaths+} times!
Each time the command is used, the deaths counter will increase by 1.
You can then retrieve the current value elsewhere using:
count{deaths}
Command Settings β
Settings can be included when adding or editing a command, or changed separately using !modcom.
The available settings are:
| Purpose | Description | Syntax | Values |
|---|---|---|---|
| Global Cooldown | Controls how often the command can be used globally. | gc{XXX} | 1β7200 seconds |
| User Cooldown | Controls how often an individual user can use the command. | uc{XXX} | 1β7200 seconds |
| Volume | Controls the volume of the command's sound effect. | vol{XXX} | -100 to 100 |
| Permission | Controls who can use the command. | perm{XXX} | 1β4 |
Permission Levels β
| Level | Permission |
|---|---|
1 | Everyone |
2 | VIPs and Paid Members/Subscribers |
3 | Moderators |
4 | Broadcaster |
For example:
!addcom hug %user% gives %targetUser% a hug! gc{10} uc{30} perm{1}
This creates a command with:
- A 10-second global cooldown
- A 30-second user cooldown
- Permission level 1 β Everyone
Modifying Commands β
If you only want to change a command's settings, you can use:
!modcom <command> <settings>
For example:
!modcom hug gc{30} uc{60}
This changes the hug command to have a 30-second global cooldown and a 60-second user cooldown.
You only need to provide the settings you want to change.
For example:
!modcom hug perm{3}
will change the command's permission level without changing its cooldowns or other settings.
Important:
!modcomdoes not change the command's output. To change the output, use!editcom.
Modifying Sounds β
You can also change the sound associated with a command using !modcom.
If you want to completely remove a sound from a command, the recommended method is to use !editcom and remove sound{} from the command's output.
Alternatively, you can mute the sound by setting its volume to -100:
!modcom hug vol{-100}
Deleting Commands β
To delete a command, use:
!delcom <command>
For example:
!delcom hug
Remember that you don't include the ! when referencing the command itself.
Deleting a command will also delete its associated sound file, if one exists.
Quick Reference β
| Command | Purpose |
|---|---|
!addcom <command> <info> | Add a new command |
!editcom <command> <info> | Edit an existing command |
!modcom <command> <settings> | Change command settings |
!delcom <command> | Delete a command |
Output Features β
| Feature | Syntax |
|---|---|
| Command input | %input% |
| Sound | sound{url} |
| API/URL request | fetch{url} |
| Persisted Global Variable | global{varName} |
| Temporary Global Variable | temp{varName} |
| Counter value | count{name} |
| Increase counter | count{name+} |
| Decrease counter | count{name-} |
Settings β
| Setting | Syntax |
|---|---|
| Global Cooldown | gc{seconds} |
| User Cooldown | uc{seconds} |
| Volume | vol{-100 to 100} |
| Permission | perm{1-4} |
Command Helper β
This is based on that you have not changed any of the commands inside streamerbot, if you have you will need to adjust it.
Optional Settings
Generated Command
!addcomTriggers β
When you use Mod Added Commands you have several triggers at your disposal so you can, if you so wish, to have something pop up on screen when a command is in cooldown, or is added. You could also have a counter display. All this is up to you and your own creativity.
List of Triggers β
These are the triggers you have available, they are located in Custom >> StreamUP >> Mod Added Commands. If you don't see them make sure everything is correctly enabled and you have ran the settings.
- Command Triggered -
macCommandTriggered - Command Added -
macCommandAdded - Command Edited -
macCommandEdited - Command Deleted -
macCommandDeleted - Command On Cooldown -
macCommandOnCooldown - Command No Permission -
macPermissionDenied - Count Updated -
macCountUpdate - Count Check -
macCountCheck - Count Fail -
macCountFail - Command Fail -
macCommandFail
Arguments Available β
The following arguments are made available by the system when one of its triggers fires. The arguments available will depend on which trigger was executed.
| Argument | Description | Available On |
|---|---|---|
%command% | The command that was used or affected. | Add, Edit, Delete, Modify |
%output% | The output associated with the command. | Pull, Add, Edit |
%userCooldown% | The command's per-user cooldown, in seconds. | Pull |
%globalCooldown% | The command's global cooldown, in seconds. | Pull |
%permission% | The permission level required to use the command. | Add, Edit, Mod, Pull, Permission Denied |
%volume% | The volume configured for the command's sound effect. | Add, Edit, Mod, Pull |
%commandName% | The name of the command associated with the event. | Add, Edit, Mod, Delete, Pull |
%countValue% | The current value of the counter after it has been updated. | Counter Updated |
%cooldownType% | Identifies which type of cooldown was triggered, such as User or Global. | Pull, On Cooldown |
%cooldown% | The total duration of the cooldown, in seconds. | Pull, On Cooldown |
%cooldownLeft% | The amount of time remaining on the cooldown, in seconds. | Pull, On Cooldown |