Skip to content

command-reference.md

Latest commit

 

History

History
191 lines (123 loc) · 5.23 KB

command-reference.md

File metadata and controls

191 lines (123 loc) · 5.23 KB
Raw

Command Reference Guide:

Table of Contents:

Syntax conventions:

When reading the commands some of the syntax might be a bit confusing. To help here is a short guide to the conventions that will be followed for all commands on this page.

Syntax Item Explanation
/command The name of a command, prefixed with a slash to indicate it is a slash command.
sub_command An argument used to alter the usage of the command.
[argument] Indicates a command that is optional and the user must own input.
{arg1 OR arg2} Indicates the user must provide some form of input.
italicized If an argument is italicized that means the user chooses the input.
bolded If an argument is bolded, that means that the user must choose a predefined input.

If you do not fully understand this right now, that is fine. You will learn to use the commands with time and get used to them.

Finally, each command is organized by extension.

Commands:

apod:

/daily_image

Posts the Astronomy picture of the day. Post in channel the command is used in.

Required Permissions: None

Built-In:

ℹ️ All the Built-In commands are core to the bot and can not be loaded/unloaded. They also are all hybrid commands (work with prefix and slash) to ensue that they always function. ℹ️

/core_reload

Fully restarts the discord bot.

Required Permissions: Administrator

/list_extensions

Lists all the extensions that are available to the bot.

Required Permissions: Administrator

/load_extension [extension]

Loads a specified extension. If no extension is specified then all available extensions are loaded.

Args:
  extension: The name of the extension to load.

Required Permissions: Administrator

/reload_extension [extension]

Unloads and then loads an extension. If no extension is specified then all extensions are reloaded.

Args:
  extension: The extension to reload.

Required Permissions: Administrator

/unload_extension [extension]

Unloads an extension. If no extension is specified all extensions are unloaded.

Args:
  extension: The extension to unload.

Required Permissions: Administrator

/sync

Syncs the slash commands from the bot to the server.

Required Permissions: Administrator

ping:

/ping {True OR False}

Checks the bot latency and test if it is up.

Args:
  True OR False: If the bot should respond with the ping value.

Required Permissions: None

settings:

/setting list_all

Lists all the settings that are currently configured for the bot.

Required Permissions: Administrator

/setting set {setting} {new_value}

Updates a value in the bot config.

Args:
  setting: The setting to make changes to.
  new_value: The new value that the setting should be set to.

Required Permissions: Administrator

/setting unset {setting}

Sets a setting to the value of "unset".

Args:
  setting: The setting that you want to set to a value of "unset".

Notes:
You will probably almost never need to use this. The value that it sets the specified setting to is a string value of unset. All this is useful for is if an extension wants to check if a value is unset.

Required Permissions: Administrator

/setting restore {change_number}

Undoes a specified change from the command setting history.

Args:
  change_number: The number of a change made. Found by using /setting view_history.

Required Permissions: Administrator

/setting view_history

Lists the past 5 changes made the bot's config file.

Required Permissions: Administrator