From 4067368fba0f26f7fa8874948d9ab3a62c69f554 Mon Sep 17 00:00:00 2001 From: Luke Slater Date: Sat, 10 Mar 2012 19:58:13 +0000 Subject: [PATCH] command docs --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00c2a93..34163a4 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,22 @@ Requirements: ## Modules: +### Command + +This handles the command execution logic for DBot. + +1. Does the input match a command key in *dbot.commands* ? +2. Is there a quote category which matches the first part of the input + (*~category*)? +3. Is there a command name similar to to the first part of the input (*~name*) + in *dbot.commands*? + +This is the only module which is force loaded, even if it's not in the +configuration. + ### Quotes -This is the original reason that DBot was created. +This is the original reason that DBot was created, stores and displays quotes. Commands: @@ -34,6 +47,11 @@ Commands: given category's quotes. - _~qprune_ - Delete empty quote categories. +Unfortunately, this module is fairly highly coupled with certain other areas of +the program. I am working on this, but note, for example, that one can still +access quotes with the *~category* syntax even if the quotes module isn't +loaded. + ### Admin Various administration functionality such as banning users, hot-reloading the