Commands

Commands are a vital part of any chat bot. They're used for communicating with the bot on what you want it to do.

Unfortunately at this day in age, Artificial Intelligence is not advanced enough to recognize in plain text what you're trying to tell it, so you must do so using predefined message formats (commands).

Commands consist of a few very key components, and are really simple to use once you get the hang of it.

The use of these commands can be easily bypassed by the streamer and their editors by simply accessing the Desktop Application.

  • Command Structure

    1. The Invoker

    2. Secondary Data

    3. Flags

  • Command Scope

    A scope describes the range at which a command is accessible, in the same manner as if you were to look down the scope of a rifle and be restricted by how far it can see.

    1. Channel: contains only the specified channel itself.

    2. Account: contains any channel that bound to a single account.

    3. Community: contains any channel within a single community.

    4. Global: contains all channels.

Ranks

Rank Name

Canonical Name

Grantable

Permissions

9.

Administrator

admin

No

Provides all permissions for the channel.
May only be requested by Staff.

8.

Owner

owner

No

Provides all permissions for the channel. Permission is given to the owner of a channel.

7.

Editor

editor

Yes

The highest grantable rank. Provides all permissions for the channel, except the ability to grant or revoke Editor permissions.

6.

Super Moderator

supermod

Yes

Grants permission to operate stream minigames. Such as creating and ending auctions, bets, and raffles. Cannot create, edit, or modify commands, currently played game, or title.

5.

Moderator

mod

No

Does not grant access to any built-in commands, but can be used to grant access to custom commands.
Granted to moderators of a channel.

4.

Subscriber

sub

No

Does not grant access to any built-in commands, but can be used to grant access to custom commands.
Cannot be granted manually, must be a subscriber of the channel, or to a third-party application such as Patreon.

3.

Regular

regular

Yes

Does not grant access to any built-in commands, but can be used to grant access to custom commands.

2.

Staff

staff

No

Does not grant any permissions, but is the only rank that allows the user to request access to permissions. Users with this rank may request Owners for access to the Administrator rank.
Granted automatically only to Boss Nation staff.

1.

Viewer

public

No

Does not grant access to any built-in commands. The default rank for all chatters.

Variables

Variable Name

Simple Usage

Description

Argument

{#}

#th argument from the senders message

Bits *

{bits}

Amount of bits sent in Twitch chats

Bot

{bot}

Name of your bots chatter account (The account it responds from)

Channel id

{channelid}

ID of your channel

Channel name

{channelname}

Name of your channel

Community

{community}

Community of the channel

Donator *

{donator}

Username provided of the user donating
Please trust this variable with a grain of salt, it is defined by the user

Followers

{followers}

Channel follower count

Game

{game}

Current game being played

Integer

{int  }

Format an Integer by the thousandths to be more readable

Language

{language}

The full name of the channels language

List

{list  }

Format a List into a string separated by a value

Loaded

{loaded}

The currently loaded user

Point name

{pointname  }

The name of a loyalty point, by default the channels primary will be displayed

Points

{points}

Amount of loyalty points the {sender} has

Save state

{state  }

A custom saved variable that can be used to display temporary information, or information that changes frequently

Sender

{sender}

The user that sent a command to trigger the current response

Subscriber *

{subscriber}

Username of the subscribed user

Subscribers

{subscribers}

Channel subscriber count

Time

{time}

Format a UTC TimeStamp into a date

Title

{title}

Current title of the stream

Uptime

{uptime}

Stream uptime UTC timestamp

Version

{version}

Active version of NucleusBot

* Only usable in Events


© 2015 - 2018 Boss Nation, LLC. All rights reserved.