privgroup.php

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

privgroup.php [2013/09/12 22:49]
privgroup.php [2020/09/12 01:30] (current)
Line 1: Line 1:
 +====== ModuleName ======
  
 +
 +==== Description ====
 +
 +This module handles requests for joins and leaves to the private chat group. In addition to this it offers notifies in chat with information about joins and leaves.
 +
 +
 +==== Features ====
 +
 +  * join and leaves for callers
 +  * invites and kicks by admins
 +  * customizable notifies on joins and leaves
 +  * optional disabling of the chatgroup
 +
 +===== Commands provided =====
 +
 +^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
 +|!join| | |Invites caller to the private group| Guest | Guest |N/A|
 +|!chat| | |Invites caller to the private group| Guest | Guest |N/A|
 +|!invite| | |Invites caller to the private group| Guest | Guest |N/A|
 +|!kick| | |Kicks caller from the private group| Anonymous | Anonymous |N/A|
 +|!leave| | |Kicks caller from the private group| Anonymous | Anonymous |N/A|
 +|!join| | |Invites caller to private group| Guest | Guest |N/A|
 +|!inviteuser| | <//character name//> |Invites //character// to the private group| Leader | Admin | Leader |
 +|!kickuser| | <//character name//> |Kicks //character// from the private group| N/A | Admin | Leader |
 +|!kickall| | |Kicks all characters from the private group by disbanding it| N/A | Admin | Admin |
 +
 +
 +===== Module settings =====
 +
 +^Setting       ^Default   ^Description                                              ^
 +|EchoJoin | gc if guildbot, pgmsg if raidbot |Where should the info about new joins to the private group be spammed?|
 +|EchoLeave | gc if guildbot, none if raidbot |Where should the info about leaves to the private group be spammed?|
 +|JoinString | #!NICKNAME!# (#!LEVEL!#/#!AT_ID!# #!FACTION!# #!PROFESSION!#, #!ORG!#) has joined #!BOTNAME!# |Formatting string for join notifies, see below for more infos|
 +|LeaveString | #!NICKNAME!# has left #!BOTNAME!#, #!ORG!#) has joined #!BOTNAME!# |Formatting string for leave notifies, see below for more infos|
 +|Deactivated | False |Deactivates the private group if wanted|
 +|DeactivatedText | Private chatgroup is disabled! |Informational text replied on locked private group if someone tries to join|
 +
 +
 +===== Notes =====
 +//JoinString// and //LeaveString// take all fields of the whois cache as variable names, extended by //botname// for the name of the bot. To signal that a part of the string is a variable and not just normal text it has to be encased in #!//variable//!#.