mirror of
https://github.com/reality/dbot.git
synced 2024-12-24 11:42:36 +01:00
Update documentation for users [#351]
This commit is contained in:
parent
5bcd1d9c27
commit
e8c2db5488
@ -11,42 +11,31 @@ This is the original reason that DBot was created, stores and displays quotes.
|
||||
#### rmLimit: 10
|
||||
Amount of quotes which can be removed before admin approval is required.
|
||||
|
||||
### Commands
|
||||
#### quotesOnJoin: false
|
||||
Show quotes for users when they enter channels.
|
||||
|
||||
### Commands: Quote Addition
|
||||
|
||||
#### ~qadd [category] = [quote]
|
||||
Add a new quote to the database under the given category.
|
||||
|
||||
### Commands: Quote Retrieval
|
||||
|
||||
#### ~[category]
|
||||
Alias for ~q.
|
||||
|
||||
#### ~q [category]
|
||||
Display a random quote from a given category.
|
||||
|
||||
#### ~qadd [category] = [quote]
|
||||
Add a new quote to the database.
|
||||
#### ~rq
|
||||
Show a random quote from the database.
|
||||
|
||||
#### ~qstats
|
||||
Show a list of the biggest quote categories.
|
||||
|
||||
#### ~qsearch [category] = [needle]
|
||||
Search a category for quotes including the given text.
|
||||
|
||||
#### ~rmlast [category]
|
||||
Remove the last quote added to a given category.
|
||||
### Commands: Quote Removal
|
||||
|
||||
#### ~rmstatus
|
||||
Show how many quotes are currently in the removal cache, and whether they will
|
||||
be randomly removed.
|
||||
|
||||
#### ~rm [category] = [quote]
|
||||
Remove a given quote from the given category.
|
||||
|
||||
#### ~qcount [category]
|
||||
Show the number of quotes stored in the given category, or if called without a
|
||||
category it will show the total number of quotes in the database.
|
||||
|
||||
#### ~rq
|
||||
Show a random quote from the database.
|
||||
|
||||
#### ~link [category]
|
||||
Show a link to the page on the web interface which shows this category's quotes.
|
||||
|
||||
### Admin-only Commands
|
||||
|
||||
#### ~rmconfirm
|
||||
Confirm that the quotes currently in the removal cache are okay to be removed,
|
||||
and permanently delete them.
|
||||
@ -55,6 +44,37 @@ and permanently delete them.
|
||||
Re-instate the quotes that are currently in the removal cache back into the main
|
||||
quote database.
|
||||
|
||||
#### ~rmlast [category]
|
||||
Remove the last quote added to a given category.
|
||||
|
||||
#### ~rm [category] = [quote]
|
||||
Remove a given quote from the given category.
|
||||
|
||||
### Commands: Stats & Searching
|
||||
|
||||
#### ~qstats
|
||||
Show a list of the biggest quote categories.
|
||||
|
||||
#### ~qsearch [category] = [needle]
|
||||
Search a category for quotes including the given text. If category is given as
|
||||
_*_, then all categories will be searched for the given text.
|
||||
|
||||
#### ~qcount [category]
|
||||
Show the number of quotes stored in the given category, or if called without a
|
||||
category it will show the total number of quotes in the database.
|
||||
|
||||
#### ~qrename [oldName] [newName]
|
||||
Rename a quote category.
|
||||
|
||||
#### ~qmerge [primary] [secondary]
|
||||
Merge two quote categories into one.
|
||||
|
||||
#### ~link [category]
|
||||
Show a link to the page on the web interface which shows this category's quotes.
|
||||
|
||||
### Admin-only Commands
|
||||
|
||||
|
||||
### API
|
||||
|
||||
#### getQuote(event, category)
|
||||
|
Loading…
Reference in New Issue
Block a user