Difference between revisions of "Modules"

From Bebot Wiki 2
Jump to navigationJump to search
(correct renames of modules)
Line 2: Line 2:
 
BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them.
 
BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them.
  
−
[[Template.php|[Template]] - This is not a module but a template used for these entries
+
[[Template.php|Template]] - This is not a module but a template used for these entries
  
 
===== Conventions =====
 
===== Conventions =====
Line 15: Line 15:
 
===== Common modules =====
 
===== Common modules =====
  
−
[[AFK.php|[AFK]] - Let people know you're away from keyboard
+
[[AFK.php|AFK]] - Let people know you're away from keyboard
  
−
[[About.php|[About]] - Information about BeBot
+
[[About.php|About]] - Information about BeBot
  
 
[[AccessControlGUI.php|AccessControlUi]] - Handle access to commands in different channels based on security groups
 
[[AccessControlGUI.php|AccessControlUi]] - Handle access to commands in different channels based on security groups
  
−
[[AdminsUI.php|[AdminsUI]] - To display the bot admins/leaders
+
[[AdminsUI.php|AdminsUI]] - To display the bot admins/leaders
  
 
[[Alts.php|AdminsUI]] - To display the bot admins/leaders
 
[[Alts.php|AdminsUI]] - To display the bot admins/leaders
Line 27: Line 27:
 
[[Alts]] - Shows information about alternative characters
 
[[Alts]] - Shows information about alternative characters
  
−
[[AutoUserAdd.php|[AutoUserAdd]] - Automatically add guild channel users to the bot
+
[[AutoUserAdd.php|AutoUserAdd]] - Automatically add guild channel users to the bot
  
−
[[BanManager.php|[BanManagerUi]] - Managing bans from the bot
+
[[BanManager.php|BanManagerUi]] - Managing bans from the bot
  
−
[[BotStatisticsUi.php|[BotStatisticsUi]] - Element about the bot
+
[[BotStatisticsUi.php|BotStatisticsUi]] - Element about the bot
  
−
[[Bid.php|[Bid]] - Handles auctions and bidding based on raid points
+
[[Bid.php|Bid]] - Handles auctions and bidding based on raid points
  
−
[[Calc.php|[Calc]] - In-game calculator
+
[[Calc.php|Calc]] - In-game calculator
  
−
[[ColorConfig.php|[ColorConfigUi]] - Configure the colors used by the various modules of the bot
+
[[ColorConfig.php|ColorConfigUi]] - Configure the colors used by the various modules of the bot
  
−
[[CommandAliasUi.php|[CommandAliasUi]] - Manages custom command aliases
+
[[CommandAliasUi.php|CommandAliasUi]] - Manages custom command aliases
  
−
[[Com.php|[Com]] - Turns current bot into a Com(munication) dedicated tool
+
[[Com.php|Com]] - Turns current bot into a Com(munication) dedicated tool
  
−
[[Countdown.php|[Countdown]] - Count down and then post a message
+
[[Countdown.php|Countdown]] - Count down and then post a message
  
−
[[DiscordRelay.php|[DiscordRelay]] - Allow to relay from/to Discord
+
[[DiscordRelay.php|DiscordRelay]] - Allow to relay from/to Discord
  
−
[[FlexibleSecurityGUI.php|[FlexibleSecurityUi]] - The GUI to control flexible security extensions
+
[[FlexibleSecurityGUI.php|FlexibleSecurityUi]] - The GUI to control flexible security extensions
  
−
[[IRC.php|[IRC]] - Handles connection between guild chat and an IRC/Twitch channel
+
[[IRC.php|IRC]] - Handles connection between guild chat and an IRC/Twitch channel
  
−
[[Is.php|[Is]] - Checks if a person is online
+
[[Is.php|Is]] - Checks if a person is online
  
−
[[Items.php|[Items]] - Show/search for information about items
+
[[Items.php|Items]] - Show/search for information about items
  
−
[[Loot.php|[Loot]] - To help managing looting
+
[[Loot.php|Loot]] - To help managing looting
  
−
[[Logon_GUILD.php|[Logon]] - Handles logon messages for guild members
+
[[Logon_GUILD.php|Logon]] - Handles logon messages for guild members
  
−
[[Mail.php|[Mail]] - Send private messages in a mail-like fashion
+
[[Mail.php|Mail]] - Send private messages in a mail-like fashion
  
−
[[MassMsg.php|[MassMsg]] - Sends out mass messages and invites
+
[[MassMsg.php|MassMsg]] - Sends out mass messages and invites
  
−
[[ModulesControlUi.php|[ModulesControlUi]] - To activate/disable modules
+
[[ModulesControlUi.php|ModulesControlUi]] - To activate/disable modules
  
−
[[News.php|[News]] - Show guild news, raid info and headlines
+
[[News.php|News]] - Show guild news, raid info and headlines
  
−
[[Online.php|[OnlineDisplay]] - Online(Display) shows infos about who is logged on to the bot
+
[[Online.php|OnlineDisplay]] - Online(Display) shows infos about who is logged on to the bot
  
−
[[OnlineCount.php|[OnlineCount]] - More details about who is logged on to the bot
+
[[OnlineCount.php|OnlineCount]] - More details about who is logged on to the bot
  
−
[[Notify.php|[Notify]] - Settings about notifications
+
[[Notify.php|Notify]] - Settings about notifications
  
−
[[Nroll.php|[Nroll]] - Roll among several options
+
[[Nroll.php|Nroll]] - Roll among several options
  
−
[[Ping.php|[Ping]] - To ping and trace
+
[[Ping.php|Ping]] - To ping and trace
  
−
[[PlayerNotesUi.php|[PlayerNotesUi]] - Manages the player notes
+
[[PlayerNotesUi.php|PlayerNotesUi]] - Manages the player notes
  
−
[[Points.php|[Points]] - Handles raidpoints
+
[[Points.php|Points]] - Handles raidpoints
  
−
[[Preferences.php|[PreferencesUi]] - Manages bot prefs
+
[[Preferences.php|PreferencesUi]] - Manages bot prefs
  
−
[[Quotes.php|[Quotes]] - To quote other players
+
[[Quotes.php|Quotes]] - To quote other players
  
−
[[Raffle.php|[Raffle]] - Handles item lotteries
+
[[Raffle.php|Raffle]] - Handles item lotteries
  
−
[[Raid.php|[Raid]] - Announces a raid
+
[[Raid.php|Raid]] - Announces a raid
  
−
[[Rally.php|[Rally]] - Handles rally points for raids
+
[[Rally.php|Rally]] - Handles rally points for raids
  
−
[[Recruit.php|[Recruit]] - To help recruiting
+
[[Recruit.php|Recruit]] - To help recruiting
  
−
[[Relay.php|[Relay]] - Simple org to org relay
+
[[Relay.php|Relay]] - Simple org to org relay
  
−
[[Roll.php|[Roll]] - Roll a dice and show the result
+
[[Roll.php|Roll]] - Roll a dice and show the result
  
−
[[Roster.php|[Roster]] - Handles member roster commands
+
[[Roster.php|Roster]] - Handles member roster commands
  
−
[[Rules.php|[Rules]] - To show bot rules to players
+
[[Rules.php|Rules]] - To show bot rules to players
  
−
[[Say.php|[Say]] - Makes bot able to speak
+
[[Say.php|Say]] - Makes bot able to speak
  
−
[[Scripts.php|[Scripts]] - Sharing useful Extras\Scripts
+
[[Scripts.php|Scripts]] - Sharing useful Extras\Scripts
  
−
[[SetDebug.php|[SetDebug]] - Switches overall debug mode on/off
+
[[SetDebug.php|SetDebug]] - Switches overall debug mode on/off
  
−
[[SettingsInterface.php|[SettingsUi]] - Interface to change bot settings
+
[[SettingsInterface.php|SettingsUi]] - Interface to change bot settings
  
−
[[ShortCutsGUI.php|[ShortCutsGUI]] - Interface to the shortcut database
+
[[ShortCutsGUI.php|ShortCutsGUI]] - Interface to the shortcut database
  
−
[[Shutdown.php|[Shutdown]] - When the bot needs to be shut down
+
[[Shutdown.php|Shutdown]] - When the bot needs to be shut down
  
−
[[StringFilterUi.php|[StringFilterUi]] - Interface to filter specific words
+
[[StringFilterUi.php|StringFilterUi]] - Interface to filter specific words
  
−
[[TimerRelay.php|[TimerRelay]] - Relays the timers across bots
+
[[TimerRelay.php|TimerRelay]] - Relays the timers across bots
  
−
[[TimerUi.php|[TimerUi]] - Manages all your game timers
+
[[TimerUi.php|TimerUi]] - Manages all your game timers
  
−
[[UserAdmin.php|[UserAdmin]] - Allows superadmin to manage users datas
+
[[UserAdmin.php|UserAdmin]] - Allows superadmin to manage users datas
  
−
[[TeamSpeak.php|[TeamSpeak]] - Displays infos about the TS server
+
[[TeamSpeak.php|TeamSpeak]] - Displays infos about the TS server
  
−
[[Whois.php|[Whois]] - Information about a player
+
[[Whois.php|Whois]] - Information about a player
  
−
[[WebSocketRelay.php|[WebSocketRelay]] - Advanced bot relay
+
[[WebSocketRelay.php|WebSocketRelay]] - Advanced bot relay
  
  
Line 131: Line 131:
 
===== AOC modules =====
 
===== AOC modules =====
  
−
[[Attribute.php|[Attribute]] - An attribute calculator Module
+
[[Attribute.php|Attribute]] - An attribute calculator Module
  
−
[[Blacklist.php|[Blacklist]] - Keeps a list of persons blacklisted by the guild and warns on whois
+
[[Blacklist.php|Blacklist]] - Keeps a list of persons blacklisted by the guild and warns on whois
  
−
[[Bound.php|[Bound]] - To memorize where your toons are bound to
+
[[Bound.php|Bound]] - To memorize where your toons are bound to
  
−
[[Chuck.php|[Chuck]] - For funny C. Norris quotes
+
[[Chuck.php|Chuck]] - For funny C. Norris quotes
  
−
[[City.php|[City]] - To help managing your guild city
+
[[City.php|City]] - To help managing your guild city
  
−
[[CraftClasses.php|[CraftClasses]] - A craft helper interface
+
[[CraftClasses.php|CraftClasses]] - A craft helper interface
  
−
[[Gemcutting.php|[Gemcutting]] - Details about cutting gems
+
[[Gemcutting.php|Gemcutting]] - Details about cutting gems
  
−
[[Rweapon.php|[Rweapon]] - Raid loot informations
+
[[Rweapon.php|Rweapon]] - Raid loot informations
  
−
[[TimerAA.php|[TimerAA]] - Manage your offline training timers
+
[[TimerAA.php|TimerAA]] - Manage your offline training timers
  
  

Revision as of 14:21, 4 October 2026

BeBot Official modules

BeBot comes with a selection of modules already installed. Here you will find comprehencive documentation for them.

Template - This is not a module but a template used for these entries

Conventions

This document uses special conventions for values that you need to substitute. These are

 * **!command //<value>//** - Values within brackets 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

AFK - Let people know you're away from keyboard

About - Information about BeBot

AccessControlUi - Handle access to commands in different channels based on security groups

AdminsUI - To display the bot admins/leaders

AdminsUI - To display the bot admins/leaders

Alts - Shows information about alternative characters

AutoUserAdd - Automatically add guild channel users to the bot

BanManagerUi - Managing bans from the bot

BotStatisticsUi - Element about the bot

Bid - Handles auctions and bidding based on raid points

Calc - In-game calculator

ColorConfigUi - Configure the colors used by the various modules of the bot

CommandAliasUi - Manages custom command aliases

Com - Turns current bot into a Com(munication) dedicated tool

Countdown - Count down and then post a message

DiscordRelay - Allow to relay from/to Discord

FlexibleSecurityUi - The GUI to control flexible security extensions

IRC - Handles connection between guild chat and an IRC/Twitch channel

Is - Checks if a person is online

Items - Show/search for information about items

Loot - To help managing looting

Logon - Handles logon messages for guild members

Mail - Send private messages in a mail-like fashion

MassMsg - Sends out mass messages and invites

ModulesControlUi - To activate/disable modules

News - Show guild news, raid info and headlines

OnlineDisplay - Online(Display) shows infos about who is logged on to the bot

OnlineCount - More details about who is logged on to the bot

Notify - Settings about notifications

Nroll - Roll among several options

Ping - To ping and trace

PlayerNotesUi - Manages the player notes

Points - Handles raidpoints

PreferencesUi - Manages bot prefs

Quotes - To quote other players

Raffle - Handles item lotteries

Raid - Announces a raid

Rally - Handles rally points for raids

Recruit - To help recruiting

Relay - Simple org to org relay

Roll - Roll a dice and show the result

Roster - Handles member roster commands

Rules - To show bot rules to players

Say - Makes bot able to speak

Scripts - Sharing useful Extras\Scripts

SetDebug - Switches overall debug mode on/off

SettingsUi - Interface to change bot settings

ShortCutsGUI - Interface to the shortcut database

Shutdown - When the bot needs to be shut down

StringFilterUi - Interface to filter specific words

TimerRelay - Relays the timers across bots

TimerUi - Manages all your game timers

UserAdmin - Allows superadmin to manage users datas

TeamSpeak - Displays infos about the TS server

Whois - Information about a player

WebSocketRelay - Advanced bot relay


AOC modules

Attribute - An attribute calculator Module

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

Bound - To memorize where your toons are bound to

Chuck - For funny C. Norris quotes

City - To help managing your guild city

CraftClasses - A craft helper interface

Gemcutting - Details about cutting gems

Rweapon - Raid loot informations

TimerAA - Manage your offline training timers


AO modules

Aggdef - To calculate best aggdef position

Aiarmor - Helps tradeskilling AI armors

Aigen - Infos on AI generals

AlienAttack - City cloak management/history

Announcer - Connect org/private to any Botnet

AutoInv - Autoinvite guests on logon

Bank - Setup workflow to share org's owned items

Boss - Loot information about many bosses

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

Cluster - Helps to design self-made implants

Ding - Turns bot into a levelling coach

Dyna - Infos about dyna camps

Guide - Many text and AO-Universe guides

GMI - Offers pure chat GMI search based on Nadyita's API

GSP - Infos about the Grid Stream Production shows/events

History.php - Shows the history for a player

Identify.php aka ex-Bio.php - Identifies bio material

Ladder - To help laddering high QL implants

LandControlZones - Infos about NW fields

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

Mobs - Updated states for various mobs (Priso, Hag, Dread, Hi, Jack, Reck, Uniques ...)

Nanoline - All your nanos per profession and lines

Oe.php - Information about over-equipping

Ofab - Details about LE Ofab Weapons/Armors

OnlineOrg - To verify who's online in a guild

Orbital - To master orbital strikes

OrgHistory - To see/search org events

Orgs - To search for an org by name

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

Perks - Display infos about SL perks

PrivGroup.php - Manages the private group

Procs - Display infos about LE procs

Raid_Loot - All loots from various raids

Rcalc - Helps to optimize research slider

Recipes - All tradeskill recipes

Ris - Helps to design several Raid Interfaces

Route - Show you quickest path from A to B

Skills - Stats about special attacks/skills

Spirits - All shade spirit searchable

Stats - Reveals hidden stats of AO

Symbiants - All symbiants searchable

Taraviza - Timers for 2 main bosses (+ event's world bosses)

Target - To make assist macro

Tokens - Helper for token and guns

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

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

Twink - To help your twink your character

Whatbuff - Searches for items per slot and skill

Whereis - To help you locate an item or boss

Xp - Infos about experience points