From 548219256451508acd673b7f0bf989b890f889c5 Mon Sep 17 00:00:00 2001 From: Twentysix Date: Wed, 17 Feb 2016 22:06:42 +0100 Subject: [PATCH] Created General tips (markdown) --- General-tips.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 General-tips.md diff --git a/General-tips.md b/General-tips.md new file mode 100644 index 0000000..db4856c --- /dev/null +++ b/General-tips.md @@ -0,0 +1,23 @@ +> In the examples I will use the ! prefix. Of course change it to whatever you choose during configuration. + +####Modules (cogs): +Red is modular. Every module can contain additional features and/or set of commands. The basic bot only has a few commands for joining/leaving servers, managing cogs and settings. This allows Red to be fully customizable. You will be asked what to do with new modules during the initial configuration and whenever Red detects a new module at start. +You (owner) can load, unload and restart modules on the fly. + +Examples: +`!load cogs.audio` +`!unload cogs.general` +`!restart cogs.streams` + +Cogs are contained in the cogs folder. + +####Permissions: +* Red will always respond to the owner, regardless of blacklists, whitelists, ignored channels/servers +* The owner is set during the initial configuration or with !setowner +* Compared to the first version Red, admin roles and mod roles are not *strictly* necessary. Most commands check for permissions too. For example, if a user with permissions to manage messages tries to use the cleanup command, it will still work. + +####Help function: +* Always refer to it when you don't know how to use a command, a subcommand or a category of commands. Examples: `!help Audio` `!help flip` `!help cleanup messages` +* The help function only shows the commands that you have permissions to use. For example, normal users will not see admin commands. +####Hosting on a server: +* You can use the `--no-prompt` parameter when starting Red to avoid being asked what to do with new modules.