Core Utility Sub Bot

Utilities

This sub-bot adds some useful administrative utilities. To enable this suite, call EnableUtils on a CoreBot or pass EnableUtils to CoreBot.EnableAll

Channels

This suite reserves the dev channel reference

Commands

• !_task <task name> : Manually runs a task

  Manually triggers a task function to run. A task's name is the name of the function which handles the task

• !_nt : Displays the total number of events handled by the .dispatch() function since the bot was last started

• !output-dev : Sets all channel references to temporarily point to the dev channel

• !output-prod : Resets all channel references to their original values

• !_announce <Message ...> : Sends a message as the bot

  The bot will send the provided message (preserving whitespace) to the general channel

• !permissions : Gets the current user's permissions

  Checks the user's current commands and sends a DM with the list of commands they can use and what role they're inheriting the permissions through. If the command is sent through a DM and the bot does not have a primary server configured, this command cannot check the user's roles, and will only be able to view permissions that the user was granted directly and by default.

  NOTE: This is also how permissions are checked. Without a primary server, commands sent via DM cannot use commands which are granted via roles

• !ignore <User reference > : Adds the given user to the ignore list

  Ignored users are ignored until they are !pardoned. A message is sent to general and to the user directly to notify. If configured, the ignored user will also be granted a role reserved for ignored users (which can be used to take away discord permissions from the user. Ignored users cannot issue commands to the bot (their messages are immediately discarded without checking for any command words)

• !pardon <User reference> : Removes the given user from the ignore list

  The user is removed from the ignore list, allowing them to use commands again. Additionally, if an ignore role was configured, it is removed from the user. A notification is posted to general and DM'ed to the pardoned user

• !idof <reference> : Gets the id for the given reference

  The bot checks all available resources for matches to the given reference. It lists the name and id of all servers, channels, roles, and members whose names (and nicknames) contain the given reference

• !timer <minutes> : Sets a timer for the given amount of minutes

  After the time has expired, a mention will be posted to the same channel where the command was issued. This is stored in-memory, so if the bot is restarted, all running timers are lost