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