Difference between revisions of "BanManager.php"

From Bebot Wiki 2
Jump to navigationJump to search
(Created page with '====== BanManager.php ====== ==== Description ==== Module to manage banning and unbanning of characters in the bot. ==== Features ==== * allows adding and removing of bans…')
 
 
(6 intermediate revisions by 2 users not shown)
Line 12: Line 12:
 
   * optional reason for a ban is saved
 
   * optional reason for a ban is saved
 
   * shows all information about banned users
 
   * shows all information about banned users
 +
  * can add peripheral bot(s) where bans are cloned
  
  
 
===== Commands provided =====
 
===== Commands provided =====
 +
<pre>
 +
^Command  ^ Keyword ^Argument(s)        ^Description                                ^Tell      ^Guild    ^Priv
 +
|!banlist |        |                  |Shows a listing of all banned characters  |Guest    |Guest    |Guest
 +
|!ban    |add      |<name> [<why>]    |Permanently bans <name>, optional <why>    |Admin    |Admin    |Admin
 +
|!ban    |add      |<name> <t*> [<why>]|Temporarly bans <name>, optional <why>.    |Admin    |Admin    |Admin
 +
|!ban    |del      |<name>            |Unbans <name>                              |Admin    |Admin    |Admin
 +
|!ban    |history  |                  |Shows previously banned last issue details |Admin    |Admin    |Admin
 +
|!ban    |search  |<word>            |Searches ban datas for <word>              |Admin    |Admin    |Admin
 +
</pre>
  
^Command  ^ Keyword  ^Argument(s)  ^Description                                ^Tell      ^Guild    ^Priv      ^
+
* : default unit is minutes, but an optional suffix may define the wanted unit of time. Add 'h' for hours, 'd' for days, 'w' for weeks, 'm' for monthes, 'y' for years. E.g. '6h' means 6 hours ban. The bot checks every 5 minutes for bans that timed out.
|!banlist| | |Shows a listing of all currently banned characters|Guest|Guest|Guest|
 
|!ban|[list]| |Shows a listing of all currently banned characters|Admin |Admin |Admin |
 
|!ban|add      |<name> [<reason>]      |Permanently bans <name>, with optional <reason> |Admin |Admin |Admin |
 
|!ban|add      |<name> <time> [<reason>]      |Temporarily bans <name>, with optional <reason>. Time is in the format #[mhd], where the optional suffix defines the unit of time. m means time is in minutes, h for hours, d for days. The bot checks once every minute for bans that timed out. |Admin |Admin |Admin |
 
|!ban|del      |<name>        |Unbans <name>|Admin|Admin|Admin|
 

Latest revision as of 16:43, 28 February 2023

BanManager.php[edit]

Description[edit]

Module to manage banning and unbanning of characters in the bot.


Features[edit]

 * allows adding and removing of bans
 * temporary bans that run out automatically
 * optional reason for a ban is saved
 * shows all information about banned users
 * can add peripheral bot(s) where bans are cloned


Commands provided[edit]
^Command  ^ Keyword ^Argument(s)        ^Description                                ^Tell      ^Guild     ^Priv
|!banlist |         |                   |Shows a listing of all banned characters   |Guest     |Guest     |Guest
|!ban     |add      |<name> [<why>]     |Permanently bans <name>, optional <why>    |Admin     |Admin     |Admin
|!ban     |add      |<name> <t*> [<why>]|Temporarly bans <name>, optional <why>.    |Admin     |Admin     |Admin
|!ban     |del      |<name>             |Unbans <name>                              |Admin     |Admin     |Admin
|!ban     |history  |                   |Shows previously banned last issue details |Admin     |Admin     |Admin
|!ban     |search   |<word>             |Searches ban datas for <word>              |Admin     |Admin     |Admin
  • : default unit is minutes, but an optional suffix may define the wanted unit of time. Add 'h' for hours, 'd' for days, 'w' for weeks, 'm' for monthes, 'y' for years. E.g. '6h' means 6 hours ban. The bot checks every 5 minutes for bans that timed out.