Changeset 60 for trunk/Phergie/README
- Timestamp:
- 02/17/08 04:25:26 (5 years ago)
- Files:
-
- 1 modified
-
trunk/Phergie/README (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/Phergie/README
r57 r60 2 2 -- WHO IS PHERGIE? 3 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 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 6 stage name Fergie. 7 7 8 8 ----------------------------------------------------------------------------- 9 -- LICENSE 9 -- LICENSE 10 10 ----------------------------------------------------------------------------- 11 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 12 See the LICENSE file included in the source tarball or go to the URL below 13 13 to obtain a copy. 14 14 … … 16 16 17 17 ----------------------------------------------------------------------------- 18 -- RUNNING PHERGIE 18 -- RUNNING PHERGIE 19 19 ----------------------------------------------------------------------------- 20 20 Download and decompress the source tarball, available at the URL below. … … 22 22 http://bluelyte.sytes.net/phergie.tar.gz 23 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 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 29 at the URL below. 30 30 31 31 http://us.php.net/manual/en/features.commandline.php 32 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. Once finished, open up a 36 command prompt/terminal/shell. Execute the PHP interpreter in CLI mode and 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. Once finished, open up a 36 command prompt/terminal/shell. Execute the PHP interpreter in CLI mode and 37 37 pass it the filename Bot.php, as shown below. 38 38 … … 42 42 43 43 ----------------------------------------------------------------------------- 44 -- USING PLUGINS 44 -- USING PLUGINS 45 45 ----------------------------------------------------------------------------- 46 Obviously, I hope that usage of Phergie gets to be widespread enough that 47 people post their own plugins and you happen upon one that you find to be 48 useful. 46 Obviously, I hope that usage of Phergie gets to be widespread enough that 47 people post their own plugins and you happen upon one that you find to be 48 useful. 49 49 50 Plugins are stored in the Phergie/Event/Handler folder. Each plugin should 51 have its own file in that folder and, if needed, a directory by the same 52 name (minus the extension, obviously) to include any other files it 50 Plugins are stored in the Phergie/Event/Handler folder. Each plugin should 51 have its own file in that folder and, if needed, a directory by the same 52 name (minus the extension, obviously) to include any other files it 53 53 requires. 54 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 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 57 instructions to this effect. 58 58 59 59 ----------------------------------------------------------------------------- 60 -- EXTENDING PHERGIE60 -- HISTORY 61 61 ----------------------------------------------------------------------------- 62 For instructions on how to write plugins for Phergie, see the CONTRIBUTE 63 file included in the source tarball. 64 65 ----------------------------------------------------------------------------- 66 -- HISTORY 67 ----------------------------------------------------------------------------- 68 The maintainer of the Ai bot for the #phpc channel on the Freenode IRC 69 network could never find time to package its source code for release and 70 only had the odd moment to handle feature requests. Additionally, the bot was 71 written in PHP 4, for which support will end on 8/8/08. With other existing 72 libraries having odd APIs, missing features, or just overall not seeming cut 73 out for the job, it was decided that a new bot should be built from scratch. 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 will end 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. 74 68 Hence, we have Phergie.
