This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
help:bots:comicbot:home [2008/02/26 20:30] the_rebel |
help:bots:comicbot:home [2008/02/28 20:01] (current) the_rebel |
||
---|---|---|---|
Line 2: | Line 2: | ||
- | Introduction: | + | __**Introduction: |
+ | ---- | ||
- | For This guide we will be using PPF (Pirc Plugin Framework), which is essentially a more beefed up and nifty version of Pircbot. | ||
- | As for our OS will be using Windows XP to run PPF in a Java environment, PPF is cross-platform due to it being written entirely in Java. (which means the steps for installation and configuration are fundamentally the same for any other OS..) | + | For this guide we will be using PPF (Pirc Plugin Framework), which is essentially a more beefed up and nifty version of Pircbot. |
+ | |||
+ | |||
+ | As for our OS will be using Windows XP to run PPF in a Java environment. PPF is cross-platform due to it being written entirely in Java, which means the steps for installation and configuration are fundamentally the same for any other OS. | ||
PPF Homepage (hosted by sourceforge): | PPF Homepage (hosted by sourceforge): | ||
- | If for some odd reason | + | If for some odd reason |
"Comic Bot is an IRC bot based on the PircBot framework. It sits quietly in a channel, observing what people say. When it sees something that may have been amusing, it quickly generates a cartoon comic strip which can be viewed on the web. The frequency at which this page updates is obviously dependant on how busy (and how funny!) the channel is." ~ http:// | "Comic Bot is an IRC bot based on the PircBot framework. It sits quietly in a channel, observing what people say. When it sees something that may have been amusing, it quickly generates a cartoon comic strip which can be viewed on the web. The frequency at which this page updates is obviously dependant on how busy (and how funny!) the channel is." ~ http:// | ||
Line 17: | Line 20: | ||
With that out of the way we can now dive into the Installation process. | With that out of the way we can now dive into the Installation process. | ||
- | Installation: | + | __**Installation: |
+ | ---- | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | // | ||
+ | |||
+ | Download Link: http:// | ||
+ | |||
+ | |||
+ | Once you've got Java installed on your platform you may proceed to installing PPF, first head on over to: http:// | ||
+ | |||
+ | Download the latest build archive and extract it anywhere, it doesn' | ||
+ | |||
+ | You should then have the following files and directories: | ||
+ | |||
+ | |||
+ | * config.sh (Linux bash script for configuration) | ||
+ | |||
+ | * docs (html document ion) | ||
+ | |||
+ | * JavaService.license (GNU software license) | ||
+ | |||
+ | * Jaxen-License.txt (library license) | ||
+ | |||
+ | * JDOM-License.txt (yet another license) | ||
+ | |||
+ | * License.txt (main PPF license) | ||
+ | |||
+ | * PircBot-License.txt (pircbot license) | ||
+ | |||
+ | * PPF.bat (batch script for PPF execution under windows) | ||
+ | |||
+ | * PPF.sh (bash script for PPF execution under *nix) | ||
+ | |||
+ | * removeService.cmd (batch script for removal of the PPF windows service) | ||
+ | |||
+ | * runAsService.cmd (batch script for adding of the PPF windows service) | ||
+ | |||
+ | * src (directiory that contains all of the PPF source code in an archive format) | ||
+ | |||
+ | * system (system folder which contains various plugins and the " | ||
+ | |||
+ | * Xerces-License.txt (yet another " | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | // | ||
+ | |||
+ | For Windows just execute the " | ||
+ | |||
+ | This will make it so PPF starts up every time windows starts up and will allow you to add a layer of fault tolerance.. | ||
+ | |||
+ | |||
+ | Well that about wraps up the Installation side of things. | ||
+ | |||
+ | |||
+ | __**Configuration: | ||
+ | ---- | ||
+ | |||
+ | |||
+ | Let's start by executing the "PPF Config Editor" | ||
+ | |||
+ | Most of these options are probably already familiar to you (or should be if you've ever used a full featured IRC client), the only thing out of the ordinary would be the password authentication system PPF takes advantage of for remote/real time administration. | ||
+ | |||
+ | The authentication system is pretty straight forward, each level grants the user(s) certain permissions to plugins and administration features, trusted being the lowest level, admin being the highest and master somewhere in between. (of course this is all dependant on how PPF is configured) | ||
+ | |||
+ | A quick example of how a user would authenticate to PPF with his/or password is as follows: | ||
+ | |||
+ | < | ||
+ | /msg $botname $password | ||
+ | </ | ||
+ | |||
+ | This could then be added to your client' | ||
+ | |||
+ | After thats all over and done with, configure your " | ||
+ | |||
+ | Now head to the " | ||
+ | if you want a no frills "comic bot" nows the time to set that up by just enabling that one plugin (comicbot) to load at run time. | ||
+ | |||
+ | (see http:// | ||
+ | |||
+ | PPF also comes bundled with a nice light weight http server which will allow you to share your comics with the whole world (or at least to the parts that are connected..) go ahead and set that up in the "Web server" | ||
+ | |||
+ | |||
+ | The final piece of our configuration lies within (\Pircbot Plugin Framework\system\ComicBot), | ||
+ | |||
+ | Here's a sample of what my config looks like: | ||
+ | |||
+ | < | ||
+ | <?xml version=" | ||
+ | < | ||
+ | <!-- where to place the strips - a directory per channel name will be created under this dir --> | ||
+ | < | ||
+ | < | ||
+ | |||
+ | <!-- upload information and message --> | ||
+ | <upload enable=" | ||
+ | <!-- ftp details --> | ||
+ | <ftp ip=" | ||
+ | |||
+ | <!-- where the uploaded image will be visible (added to the end of < | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | <!-- the words that will trigger the creation of the comic strip --> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | </ | ||
+ | |||
+ | After you've customized the config to suit your needs you can go ahead and fire up your PPF bot and test things out. (repeating the trigger words is great for testing the comics) | ||
+ | |||
+ | Additionally you can configure the PPF service (if you installed it) via the services console: | ||
+ | |||
+ | Press the windows key + R on your keyboard to bring up the run dialog box then type: | ||
+ | < | ||
+ | services.msc | ||
+ | </ | ||
+ | |||
+ | Once that services console window appears proceed to the " | ||
+ | |||
+ | **Congratulations you now have yourself a comicbot! *yay*** | ||
+ | |||
+ | |||
+ | __**Final Notes: | ||
+ | ---- | ||
+ | |||
+ | |||
+ | " | ||
+ | |||
+ | "**net start ppf**" //starts the bot via the windows service.// (this option is to be used from a command line or run dialog box) | ||
+ | |||
+ | "**net stop ppf**" //kills the windows service. (and so too the bot)// (this option is to be used from a command line or run dialog box) | ||
+ | |||
+ | For further documentation on how to take full advantage of PPF's powerful features please take a look at the user guide: http:// | ||
+ | |||
+ | And for those of you who wish to be creative and create your own comics, i recommend you check out "Comic Life" from Plasq. ~ http:// | ||
- | Perquisite - Java Runtime Environment (aka JVM): | + | //Stay tuned for my guide on how to create your own comics..// |
+ | __**Contact: | ||
+ | ---- | ||
+ | You can reach me @ The_Rebel52@hotmail(dot)com | ||
- | Configuration: | + | Or via IRC at #xbox-sky (nick: The_Rebel) |
- | Final Notes: | + | P.S Thanks goes to nhinja for helping with the editing. |
+ | --- // |