forked from GitHub/dbot
command docs
This commit is contained in:
parent
90b95fae43
commit
4067368fba
20
README.md
20
README.md
@ -14,9 +14,22 @@ Requirements:
|
|||||||
|
|
||||||
## Modules:
|
## 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
|
### Quotes
|
||||||
|
|
||||||
This is the original reason that DBot was created.
|
This is the original reason that DBot was created, stores and displays quotes.
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
|
|
||||||
@ -34,6 +47,11 @@ Commands:
|
|||||||
given category's quotes.
|
given category's quotes.
|
||||||
- _~qprune_ - Delete empty quote categories.
|
- _~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
|
### Admin
|
||||||
|
|
||||||
Various administration functionality such as banning users, hot-reloading the
|
Various administration functionality such as banning users, hot-reloading the
|
||||||
|
Loading…
Reference in New Issue
Block a user