Georg/dbot
1
0
Fork 0
forked from GitHub/dbot
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation for the Ignore module [#75]

Browse Source
This commit is contained in:
reality 2012-12-30 17:44:51 +00:00
parent 5e8495c3bb
commit 85fc4d6e6f
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
modules/ignore/README.md Normal file
View File

@ -0,0 +1,26 @@
## Ignore
Ignore modules.
### Description
Commands with which users can choose to ignore listeners and commands from
certain modules persistently, by storing their choices in the database. This is
an interface for the JSBot ignoreTag functionality which actually implements
the ignoration.
### Configuration
All modules may return with them an 'ignorable' property, which defines whether
or not their functionality may be ignored by users.
### Commands
#### ~ignore [module]
Ignore a given module. If the user does not specify a module, or provides an
invalid one a list of modules which are available to ignore will be given.
#### ~unignore [module]
Unignore a previously ignored module. If the user does not specify a module, or
provides an invalid choice a list of modules which are currently ignored will be
given.