Misc¶

This Cog contains miscellaneous commands.

Hint

To enable this cog, set the ENABLE_MISC variable.

Packages¶

No package is required!

env variables¶

Name	Description
`CROISSANT_PATH`	The path to `croissant.gif`
`KILL_PATH`	Where the kill messages are stored
`KILL_COUNT`	Where the kill count is stored

Use your own messages¶

KILL_PATH is a txt file which contains all the possible messages to send. There should be only one message per line. To insert the nickname of the user using the command, put <killer> in the message. Likewise, to insert the victim’s nickname, use <victim>. These tags are automatically replaced before sending the message. You can put as many of these per message as you want, or none at all. For example, if Alice calls the command on Bob, the phrase:

<killer> shot <victim>.

becomes:

Alice shot Bob.

How the count is stored¶

KILL_COUNT is a JSON file that keeps track of how many times a user used the command on someone on that server. When creating the bot it should at least contain an empty dictionary {}. It uses the following format:

{
   "guild_id": {
         "killer_id_1": {
            "victim_id_1": 3,
            "victim_id_2": 10
         },
         "killer_id_2": {
            "victim_id_3": 14,
            "victim_id_1": 2
         }
   }
}

Note

Since the KILL_COUNT file uses a server’s ID as the first key, the counts are not synchronized across servers.

Croissant?¶

CROISSANT_PATH points to croissant.gif, which is the gif sent when using the croissant command. See the README for more information on this command’s existence.