Corebot
From Botdom Wiki
| Developer(s): | Captainredmuff |
| Programming language: | PHP |
| Development state: | Beta |
| Source model: | Open source |
| Last stable release: | 1.0 |
| Last preview release: | None |
| License type: | Free software (GPL)
|
CoreBot is a logging bot foundation written in object oriented php by Captainredmuff. CoreBot is easily extended to allow modifications to be made to any user written bots which are based upon its core. CoreBot logs all channel activity within a MySQL database, thus database connectivity is required to allow CoreBot to operate as intended. Experience using object oriented programming (in php preferably) is recommended, as is familiarity with MySQL databases to proceed with installing and operating your own CoreBot extension.
Contents |
Download
Only one current mirror -> http://download.botdom.com/b927t/corebot.zip. Download, unzip, and enjoy!
Extended Versions
Botdom Summer Project -> http://download.botdom.com/nnlqh/bsp.zip. Zombie game made via CoreBot's extended AppBot Core. Enjoy!
General Notes
CoreBot was written in what little time Captainredmuff had to spare amongst other code oriented projects; a result of which has lead to some minor 'issues' brought about by ManjyomeThunder && Photofroggy. Some functions such as uptime may work incorrectly due to temporary 'fixes' implemented during the development phase. The console is fairly active, displaying the vast majority of CoreBot's inner workings which may look rather unpleasant to some users. Any fixes for known problems/issues are listed below.
You may notice an odd syntax with the naming conventions of functions within the core and app class declarations. The function naming conventions is as follows
- function($params){} - is a 'public' command/function
- _function($params){} - is a 'private' command/function
- __function(){} - is a protected function
The three main function types are public, private and protected. Protected functions are only available within the class files, not in dAmn channels, via the bots trigger, ie: __damnWrite($message, $channel); cannot be called directly from a channel. Private functions work as 'admin' only functions whereas, the 'administrators' of the bot are the only members allowed to invoke said functions. Finally, public functions are available to be called by any member of the channel in which the bot resides.
Setup
Simply change the appropriate values as documented in the file 'config.php' before running the bot via 'run.php'.
Statistics and Commands
Admin Functions:
- admin - add/remove bot admin
- autojoin - auto join room(s)
- callcount - display function call counts
- disconnect - disconnect from dAmn
- join - join a new room(s)
- part - part a room(s)
- restart - restart (does not reload files) - yes, its pointless.
- say - say a message/action
- settrigger - set bot trigger
- status - display bot status
- uptime - display bot uptime
Public Functions:
- about - display about message
- commands - display bot commands
Uses
- Channel Logging using a MySQL database.
- Bot core framework for extension.
- Stable interactions with dAmn and extended packet parsing.
CoreBot Extensions
None
Fixes/Issues
This section pertains to fixes for known 'issues', ie: these are not necessarily 'bugs', just unpleasant errors.
Too much console activity due to 'send/receive' messages
- Comment out line #1056 in 'core.php'
- Comment out line #1094 in 'core.php'
Remove MySQL Logging functions
- Comment out line #80 in 'core.php'
- Comment out line #897 in 'core.php'
Suggestions
- Optional MySQL channel login in place of flat files
- Multiple characters as bot trigger
- Streamline console message activity
