Difference between revisions of "Modules"
(Created page with 'BeBot Official modules BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them. Conventions This document uses specia…') |
|||
Line 1: | Line 1: | ||
− | BeBot Official modules | + | ====== BeBot Official modules ====== |
+ | BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them. | ||
+ | |||
+ | |||
+ | |||
− | |||
− | |||
+ | ===== Conventions ===== | ||
This document uses special conventions for values that you need to substitute. These are | This document uses special conventions for values that you need to substitute. These are | ||
− | + | * **!command //<value>//** - Values within brackeds are mandatory and have to be supplied | |
− | + | * **!command //[value]//** - Values within square brackets are optional and offer additional features | |
− | + | * **!command //<(value1/value2)>//** - Values separated by a vertical bar within paranthesis indicate that you may choose between the values. The type of brackets surrounding the parenthesis indicate mandatory or optional values. | |
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
− | |||
− | Template.php - This is not a module but a template used for these entries. | + | ===== The modules ===== |
+ | [[Template.php]] - This is not a module but a template used for these entries. | ||
− | AFK.php - Let people know you're away from keyboard | + | [[AFK.php]] - Let people know you're away from keyboard |
− | About.php - Information about BeBot | + | [[About.php]] - Information about BeBot |
− | AccessControlGUI.php - Handle access to commands in different channels based on security groups | + | [[AccessControlGUI.php]] - Handle access to commands in different channels based on security groups |
− | AlienAttack_GUILD.php - Notifies the guild when the city is under alien attack | + | [[AlienAttack_GUILD.php]] - Notifies the guild when the city is under alien attack |
− | Alts.php - Shows information about alternative characters. | + | [[Alts.php]] - Shows information about alternative characters. |
− | AutoInv.php - Automatically invite guests to the bot | + | [[AutoInv.php]] - Automatically invite guests to the bot |
− | BanManager.php - Managing bans from the bot. | + | [[BanManager.php]] - Managing bans from the bot. |
− | Bid.php - Handles auctions and bidding based on raid points | + | [[Bid.php]] - Handles auctions and bidding based on raid points |
− | Bio.php - Identifies bio material | + | [[Bio.php]] - Identifies bio material |
− | Blacklist.php - Keeps a list of persons blacklisted by the guild and warns on whois | + | [[Blacklist.php]] - Keeps a list of persons blacklisted by the guild and warns on whois |
− | Calc.php - In-game calculator | + | [[Calc.php]] - In-game calculator |
− | Callers.php - Designate and list | + | [[Callers.php]] - Designate and list "callers" for raids and events |
− | ColorConfig.php - Configure the colors used by the various modules of the bot | + | [[ColorConfig.php]] - Configure the colors used by the various modules of the bot |
− | Countdown.php - Count down and then post a message | + | [[Countdown.php]] - Count down and then post a message |
− | FlexibleSecurityGUI.php - The GUI to control flexible security extensions | + | [[FlexibleSecurityGUI.php]] - The GUI to control flexible security extensions |
− | Glyph_RAID.php - Raffles inferno glyphs | + | [[Glyph_RAID.php]] - Raffles inferno glyphs |
− | History.php - Shows the history for a player | + | [[History.php]] - Shows the history for a player |
− | IRC.php - Handles connection between guild chat and an IRC channel | + | [[IRC.php]] - Handles connection between guild chat and an IRC channel |
− | Is.php - Checks if a person is online | + | [[Is.php]] - Checks if a person is online |
− | Items.php - Show/search for information about items | + | [[Items.php]] - Show/search for information about items |
− | LeadEcho_RAID.php - Offering leader echo and nominating leader in raidbots | + | [[LeadEcho_RAID.php]] - Offering leader echo and nominating leader in raidbots |
− | Level.php - Show information about team/pvp ranges and mission QLs for a given level | + | [[Level.php]] - Show information about team/pvp ranges and mission QLs for a given level |
− | Logon_GUILD.php - Handles logon messages for guild members | + | [[Logon_GUILD.php]] - Handles logon messages for guild members |
− | Mail.php - Send private messages in a mail-like fashion | + | [[Mail.php]] - Send private messages in a mail-like fashion |
− | MassMsg.php - Sends out mass messages and invites | + | [[MassMsg.php]] - Sends out mass messages and invites |
− | News.php - Show guild news, raid info and headlines | + | [[News.php]] - Show guild news, raid info and headlines |
− | Oe.php - Information about over-equipping | + | [[Oe.php]] - Information about over-equipping |
− | Online.php - Information about who is logged on to the bot | + | [[Online.php]] - Information about who is logged on to the bot |
− | PB.php - Information about which symbiants a given pocketboss drops or which pocketboss drops a given symbiant. | + | [[PB.php]] - Information about which symbiants a given pocketboss drops or which pocketboss drops a given symbiant. |
− | Points.php - Handles raidpoints | + | [[Points.php]] - Handles raidpoints |
− | PrivGroup.php - Manages the private group | + | [[PrivGroup.php]] - Manages the private group |
− | Raffle.php - Handles item lotteries | + | [[Raffle.php]] - Handles item lotteries |
− | Raid.php - Announces a raid | + | [[Raid.php]] - Announces a raid |
− | Rally.php - Handles rally points for raids | + | [[Rally.php]] - Handles rally points for raids |
− | Relay_GUILD.php - Handles relaying of messages between private group, guild chat and possible relaying between orgs | + | [[Relay_GUILD.php]] - Handles relaying of messages between private group, guild chat and possible relaying between orgs |
− | Roll.php - Roll a dice and show the result | + | [[Roll.php]] - Roll a dice and show the result |
− | Roster.php - Handles member roster commands | + | [[Roster.php]] - Handles member roster commands |
− | Server.php - Shows the server load | + | [[Server.php]] - Shows the server load |
− | SettingsInterface.php - Interface to change bot settings | + | [[SettingsInterface.php]] - Interface to change bot settings |
− | ShortCutsGUI.php - Interface to the shortcut database | + | [[ShortCutsGUI.php]] - Interface to the shortcut database |
− | Shutdown.php - When the bot needs to be shut down | + | [[Shutdown.php]] - When the bot needs to be shut down |
− | Target.php - Calls a target | + | [[Target.php]] - Calls a target |
− | Teams.php - Allows comfortable setting up of teams in raidbots | + | [[Teams.php]] - Allows comfortable setting up of teams in raidbots |
− | Tier2.php - Tier2 raid management | + | [[Tier2.php]] - Tier2 raid management |
− | TowerAttack.php - Announces tower wars and gives history for tower wars | + | [[TowerAttack.php]] - Announces tower wars and gives history for tower wars |
− | Trickle.php - Calculates the trickle-down to skills from increasing base stats | + | [[Trickle.php]] - Calculates the trickle-down to skills from increasing base stats |
− | Whois.php - Information about a player | + | [[Whois.php]] - Information about a player |
Revision as of 22:16, 16 September 2020
BeBot Official modules
BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them.
Conventions
This document uses special conventions for values that you need to substitute. These are
* **!command //<value>//** - Values within brackeds are mandatory and have to be supplied * **!command //[value]//** - Values within square brackets are optional and offer additional features * **!command //<(value1/value2)>//** - Values separated by a vertical bar within paranthesis indicate that you may choose between the values. The type of brackets surrounding the parenthesis indicate mandatory or optional values.
The modules
Template.php - This is not a module but a template used for these entries.
AFK.php - Let people know you're away from keyboard
About.php - Information about BeBot
AccessControlGUI.php - Handle access to commands in different channels based on security groups
AlienAttack_GUILD.php - Notifies the guild when the city is under alien attack
Alts.php - Shows information about alternative characters.
AutoInv.php - Automatically invite guests to the bot
BanManager.php - Managing bans from the bot.
Bid.php - Handles auctions and bidding based on raid points
Bio.php - Identifies bio material
Blacklist.php - Keeps a list of persons blacklisted by the guild and warns on whois
Calc.php - In-game calculator
Callers.php - Designate and list "callers" for raids and events
ColorConfig.php - Configure the colors used by the various modules of the bot
Countdown.php - Count down and then post a message
FlexibleSecurityGUI.php - The GUI to control flexible security extensions
Glyph_RAID.php - Raffles inferno glyphs
History.php - Shows the history for a player
IRC.php - Handles connection between guild chat and an IRC channel
Is.php - Checks if a person is online
Items.php - Show/search for information about items
LeadEcho_RAID.php - Offering leader echo and nominating leader in raidbots
Level.php - Show information about team/pvp ranges and mission QLs for a given level
Logon_GUILD.php - Handles logon messages for guild members
Mail.php - Send private messages in a mail-like fashion
MassMsg.php - Sends out mass messages and invites
News.php - Show guild news, raid info and headlines
Oe.php - Information about over-equipping
Online.php - Information about who is logged on to the bot
PB.php - Information about which symbiants a given pocketboss drops or which pocketboss drops a given symbiant.
Points.php - Handles raidpoints
PrivGroup.php - Manages the private group
Raffle.php - Handles item lotteries
Raid.php - Announces a raid
Rally.php - Handles rally points for raids
Relay_GUILD.php - Handles relaying of messages between private group, guild chat and possible relaying between orgs
Roll.php - Roll a dice and show the result
Roster.php - Handles member roster commands
Server.php - Shows the server load
SettingsInterface.php - Interface to change bot settings
ShortCutsGUI.php - Interface to the shortcut database
Shutdown.php - When the bot needs to be shut down
Target.php - Calls a target
Teams.php - Allows comfortable setting up of teams in raidbots
Tier2.php - Tier2 raid management
TowerAttack.php - Announces tower wars and gives history for tower wars
Trickle.php - Calculates the trickle-down to skills from increasing base stats
Whois.php - Information about a player