Difference between revisions of "PrivGroup.php"
From Bebot Wiki 2
Jump to navigationJump to search (Created page with '====== 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…') |
|||
| Line 15: | Line 15: | ||
===== Commands provided ===== | ===== Commands provided ===== | ||
| − | + | <pre> | |
^Command ^ Keyword ^Argument(s) ^Description ^Tell ^Guild ^Priv ^ | ^Command ^ Keyword ^Argument(s) ^Description ^Tell ^Guild ^Priv ^ | ||
|!join| | |Invites caller to the private group| Guest | Guest |N/A| | |!join| | |Invites caller to the private group| Guest | Guest |N/A| | ||
| Line 26: | Line 26: | ||
|!kickuser| | <//character name//> |Kicks //character// from the private group| N/A | 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 | | |!kickall| | |Kicks all characters from the private group by disbanding it| N/A | Admin | Admin | | ||
| − | + | </pre> | |
===== Module settings ===== | ===== Module settings ===== | ||
| − | + | <pre> | |
^Setting ^Default ^Description ^ | ^Setting ^Default ^Description ^ | ||
|EchoJoin | gc if guildbot, pgmsg if raidbot |Where should the info about new joins to the private group be spammed?| | |EchoJoin | gc if guildbot, pgmsg if raidbot |Where should the info about new joins to the private group be spammed?| | ||
| Line 37: | Line 37: | ||
|Deactivated | False |Deactivates the private group if wanted| | |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| | |DeactivatedText | Private chatgroup is disabled! |Informational text replied on locked private group if someone tries to join| | ||
| − | + | </pre> | |
===== Notes ===== | ===== 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//!#. | //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//!#. | ||
Latest revision as of 09:07, 30 July 2021
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//!#.
