Companion Cube

Companion Cube - Documentation

Help and introduction

By default, the bot uses cc! or mention as command prefix. This means that commands are invoked by doing cc!command arguments... or @Companion Cube command arguments....

In below documentation, all commands will be listed with default command prefix. Arguments will be listed as <argument>, denoting required argument; <argument...> denoting required catch-all argument (i.e. one that can take more than one value). Optional arguments will be denoted using [argument] and [argument...] for single and catch-all optional arguments. When typing commands, you must omit the <> and [] parts, meaning that if a command is denoted as cc!command <argument 1> [argument 2], you use it as cc!command value1 value2 or cc!command value1. If you want to pass an argument that contains spaces, wrap it in "", for instance: cc!command "value for argument 1" will invoke cc!command with a single argument, value for argument 1. This is not required for catch-all arguments. For instance, if a command is declared as cc!echo <message...>, you can invoke it as cc!echo Hello, this is a message with spaces!.

cc!help [command] Displays help. Invoking this command without any arguments will list available top-level. Specifying a command will show information about that command, and its subcommands (if applicable).

Companion Cube features a blocking system. Blocking can happen on per-guild, per-channel, and per-user basis. Blocked users cannot use the bot's passive or active functionality. Messages from blocked guilds and channels are ignored (this excludes administrative commands).

Companion Cube's command prefix can be changed on per-guild or per-channel basis, where channel settings override guild settings. The mention prefix, however, cannot be changed or disabled.

 

Bot control

 

Tag management

At present, all tags are channel-specific tags. This means that when created in one channel, they cannot be called from any other one. Tags can be created by any user, however by default they are not shown in default listing. Moderators can approve or unapprove tags, which shows or hides them in default listing respectively. Moderators can also edit or delete any tag. The tag system features full tracking for all tags. This means that each tag has a use count, incremented when any user (excluding tag's owner) uses a tag, its use counter is incremented. Moreover, tags keep a full record of edits. Each edit to a tag records the timestamp, and the user who performed the action. Each tag's full history can be recalled at any time, including its previous versions. Deleting a tag, however, removes the tag along with its history.

 

Currency system

The currency system of Companion Cube features a currency called Comedy Chevrons. Currency issue rate is 5% (that is, each message has a 5% chance of generating a single Comedy Chevron). Currency is global, that is each user's balance is available in all guilds. Ignored guilds, channels, and users do not generate currency. Bots cannot receive or hold currency, nor do they generate any.

 

Miscellaneous commands