Difference between revisions of "Modules"

From Bebot Wiki 2
Jump to navigationJump to search
Line 34: Line 34:
  
 
[[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
 
  
 
[[Calc.php]] - In-game calculator
 
[[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
 
[[ColorConfig.php]] - Configure the colors used by the various modules of the bot
Line 48: Line 44:
  
 
[[FlexibleSecurityGUI.php]] - The GUI to control flexible security extensions
 
[[FlexibleSecurityGUI.php]] - The GUI to control flexible security extensions
 
[[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
Line 56: Line 50:
  
 
[[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
 
 
[[Level.php]] - Show information about team/pvp ranges and mission QLs for a given level
 
  
 
[[Loot.php]] - To help managing looting
 
[[Loot.php]] - To help managing looting
Line 70: Line 60:
  
 
[[News.php]] - Show guild news, raid info and headlines
 
[[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
 
[[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
 
[[Points.php]] - Handles raidpoints
  
 
[[Quotes.php]] - To quote other players
 
[[Quotes.php]] - To quote other players
 
[[PrivGroup.php]] - Manages the private group
 
  
 
[[Raffle.php]] - Handles item lotteries
 
[[Raffle.php]] - Handles item lotteries
Line 104: Line 88:
  
 
[[Shutdown.php]] - When the bot needs to be shut down
 
[[Shutdown.php]] - When the bot needs to be shut down
 
[[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
 
[[Whois.php]] - Information about a player
Line 132: Line 112:
  
 
===== AO modules =====
 
===== AO modules =====
 +
 +
[[Bio.php]] - Identifies bio material
 +
 +
[[Callers.php]] - Designate and list "callers" for raids and events
 +
 +
[[History.php]] - Shows the history for a player
 +
 +
[[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
 +
 +
[[Oe.php]] - Information about over-equipping
 +
 +
[[PB.php]] - Information about which symbiants a given pocketboss drops or which pocketboss drops a given symbiant.
 +
 +
[[PrivGroup.php]] - Manages the private group
 +
 +
[[TowerAttack.php]] - Announces tower wars and gives history for tower wars
 +
 +
[[Trickle.php]] - Calculates the trickle-down to skills from increasing base stats

Revision as of 21:33, 22 March 2021

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.


Common 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

AutoUserAdd.php - Automatically add guild channel users to the bot

BanManager.php - Managing bans from the bot.

Bid.php - Handles auctions and bidding based on raid points

Calc.php - In-game calculator

ColorConfig.php - Configure the colors used by the various modules of the bot

Countdown.php - Count down and then post a message

DiscordRelay.php - Allow to relay from/to Discord

FlexibleSecurityGUI.php - The GUI to control flexible security extensions

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

Loot.php - To help managing looting

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

Online.php - Information about who is logged on to the bot

Points.php - Handles raidpoints

Quotes.php - To quote other players

Raffle.php - Handles item lotteries

Raid.php - Announces a raid

Rally.php - Handles rally points for raids

Recruit.php - To help recruiting

Roll.php - Roll a dice and show the result

Roster.php - Handles member roster commands

Rules.php - To show bot rules to players

Say.php - Makes bot able to speak

SettingsInterface.php - Interface to change bot settings

ShortCutsGUI.php - Interface to the shortcut database

Shutdown.php - When the bot needs to be shut down

Whois.php - Information about a player


AOC modules

Blacklist.php - Keeps a list of persons blacklisted by the guild and warns on whois

Bound.php - To memorize where your toons are bound to

Chuck.php - For funny C. Norris quotes

City.php - To help managing your guild city

CraftClasses.php - A craft helper interface

Gemcutting.php - Details about cutting gems

Rweapon.php - Raid loot informations

TimerAA.php - Manage your offline training timers


AO modules

Bio.php - Identifies bio material

Callers.php - Designate and list "callers" for raids and events

History.php - Shows the history for a player

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

Oe.php - Information about over-equipping

PB.php - Information about which symbiants a given pocketboss drops or which pocketboss drops a given symbiant.

PrivGroup.php - Manages the private group

TowerAttack.php - Announces tower wars and gives history for tower wars

Trickle.php - Calculates the trickle-down to skills from increasing base stats