root/trunk/Phergie/README @ 60

Revision 60, 3.2 KB (checked in by tobias382, 5 years ago)

Fixes #1, #8, #14, #10, #13
* Fixed some parameter parsing issues in the streams driver and Command plugin
* Fixed an issue in the streams driver where quitting would not cause the

connection to be terminated on the client side

* Added automated directory creation to the event handler class
* Added isInChannel() and TYPE_KICK to request event class
* Modified the bootstrap file to use a full path when referencing the Plugin

directory and to include plugin loading debugging messages

* Fixed a bug in the bootstrap file where it would not produce an error when

required configuration settings existed, but were empty

* Cleared default values and unused settings out of the config file
* Made modifications to the fromAdmin method in the AdminCommand? plugin to

optimize performance

* Fixed a bug in the parsing logic in the Acronym plugin and added a check for

instances where the per-IP bandwidth limit has been executed

* Added a check for cases where a server has no MOTD to the Autojoin plugin
* Modified the Drink plugin to filter coffee drinks when scraping data for the

coke table and to remove the profanity filter array from memory once the
init method is done using it

* Added an avogadro alias for the mole fixed karma and added support for

configurable fixed karma for the bot

* Modified the Logging plugin to extend the Command plugin and to use PDO in

place of the standalone SQLite driver

* Modified the Php plugin to use full URLs to function pages rather than the

shorthand version, which does not always resolve to the expected URL

* Renamed the Say plugin to Puppet and added support emulation of CTCP ACTION

commands

* Modified the Url plugin to use the MIME type of the resource in place of

the title in cases where it is not HTML-based

* Fixed an issue with the parsing logic in the onMode handler of the Users

plugin

* Uncommented the onPrivmsg handler and modified it to use the new debug

configuration setting

* Added alternate nick support to the Nickserv plugin
* Removed the CONTRIBUTE file, as its fairly out of date
Line 
1-----------------------------------------------------------------------------
2-- WHO IS PHERGIE?
3-----------------------------------------------------------------------------
4Phergie is an IRC bot written in pure PHP 5 with an OO API. She is named
5after the delicious and delectable Stacy Ann Ferguson, better known by her
6stage name Fergie.
7
8-----------------------------------------------------------------------------
9-- LICENSE
10-----------------------------------------------------------------------------
11Phergie is released under the GNU Lesser General Public License version 3.0.
12See the LICENSE file included in the source tarball or go to the URL below
13to obtain a copy.
14
15http://www.gnu.org/licenses/lgpl.html
16
17-----------------------------------------------------------------------------
18-- RUNNING PHERGIE
19-----------------------------------------------------------------------------
20Download and decompress the source tarball, available at the URL below.
21
22http://bluelyte.sytes.net/phergie.tar.gz
23
24Make sure that register_argc_argv is enabled if you want to use a
25configuration file that is not in the Phergie directory or is not named
26phergie.ini. register_argc_argv is often disabled in CGI environments since
27it's generally only needed for CLI purposes. If you have not run PHP from the
28command line before, it may be a good idea to read the related manual section
29at the URL below.
30
31http://us.php.net/manual/en/features.commandline.php
32
33Once you've made any necessary PHP configuration changes, navigate to the
34Phergie directory. From there, open your Phergie configuration file and
35update configuration settings there as needed. Once finished, open up a
36command prompt/terminal/shell. Execute the PHP interpreter in CLI mode and
37pass it the filename Bot.php, as shown below.
38
39% php Bot.php
40
41That's it. That's all there is to it. Simple, huh?
42
43-----------------------------------------------------------------------------
44-- USING PLUGINS
45-----------------------------------------------------------------------------
46Obviously, I hope that usage of Phergie gets to be widespread enough that
47people post their own plugins and you happen upon one that you find to be
48useful.
49
50Plugins are stored in the Phergie/Event/Handler folder. Each plugin should
51have its own file in that folder and, if needed, a directory by the same
52name (minus the extension, obviously) to include any other files it
53requires.
54
55Some plugins might also require certain configuration settings to be set up
56in the phergie.ini configuration file, so be sure to look for any
57instructions to this effect.
58
59-----------------------------------------------------------------------------
60-- HISTORY
61-----------------------------------------------------------------------------
62The maintainer of the Ai bot for the #phpc channel on the Freenode IRC
63network could never find time to package its source code for release and
64only had the odd moment to handle feature requests. Additionally, the bot was
65written in PHP 4, for which support will end on 8/8/08. With other existing
66libraries having odd APIs, missing features, or just overall not seeming cut
67out for the job, it was decided that a new bot should be built from scratch.
68Hence, we have Phergie.
Note: See TracBrowser for help on using the browser.