||LizardBot is no longer in development and is no longer supported. No further updates will be released for this bot.
This page is only kept for historical reasons.Instead of LizardBot, consider switching to LizardIRC's newer IRC bot, Beancounter.
Note: Some experience in the PHP programming language - which this bot is written in - is recommended for using this bot. The documentation on this site assumes that you are familiar with at least the basics of PHP (such as declaring variables, how to quote strings, etc.). That said, this is only a recommendation - if you don't know PHP at all, you are welcome to try out LizardBot, and do ask for help on our IRC channel or elsewhere if you need it.
Starting the bot
To start the bot, enter the command line. You should then see a prompt like the one shown below.
Use cd to change to the directory that lizardbot.php is in, assuming it is not in ~ (or /home/username). For example,
username@host:~$ cd bots username@host:~/bots$
Now, start the bot. At the prompt, type the command below. You should see the same result as shown below.
username@host:~/bots$ php lizardbot.php ******************************************************************************* FastLizard4's IRC bot developed by FastLizard4 (who else?), with a little help from davenull. Version 184.108.40.206b (major.minor.build.revision) BETA Licensed under the Creative Commons GNU General Public License 2.0 (GPL) For licensing details, contact me or read this page: http://creativecommons.org/licenses/GPL/2.0/ REPORT BUGS AND SUGGESTIONS TO FastLizard4 I can be contacted on the Freenode IRC network as FastLizard4. PandoraBot extension courtesy of Ttech (PHP-5 OOP) ******************************************************************************* *KNOWN ISSUES WITH THE BOT: 1. Private messages may not work as expected. 2. No logging functions (may be implemented some time in the future) ******************************************************************************* Loading pandorabot extension... Pandorabot class loaded! Welcome to the interface for LizardBot-1! Loading essential config files... OK! Verifying required settings are present... OK! Please enter the FULL address of the network you wish to join (REQUIRED):
Note: If, instead of "OK!" you see an error message and you don't get the network address prompt, something went wrong in bot setup or you do not have PHP 5. Recheck that you have PHP version 5 and have correctly configured the bot.
Note: As of version 220.127.116.11b (r21), you can specify a configuration file to use at startup. For example, starting the bot with the command below would use the configuration file
myconfig.lizardbot.conf.php. If no configuration file is specified at startup, the default of
lizardbot.conf.php is used.
username@host:~/bots$ php lizardbot.php myconfig.lizardbot.conf.php
Enter the full address of the network, then strike enter. You should see something like this:
Please enter the FULL address of the network you wish to join (REQUIRED): irc.myircnetwork.com Input of "irc.myircnetwork.com" received! Please enter the desired nickname for your bot. If you enter "." and strike enter, the default (in brackets) will be used Nickname [mynick]:
The mynick value comes fromt the configuration file setting $nickname. Assuming that mynick is the nick you want to use, just enter a period and strike enter, as below.
Nickname [mynick]: . No nickname received, using default of mynick. Now checking validity of the nickname using standard regex tests... Should I send identification information to NickServ? (yes/no, default no):
The system uses a regex pattern to make sure the nickname doesn't contain illegal characters. If it does, the loader will alert you to this and exit. The bot now asks if you wish to identify to services. Entering "y" or "yes" will cause it to do so, anything else will stop it from identifying. If you don't identify, the bot immediately begins the connection process, covered below. Assuming that you want to identify, you would enter "yes" or "y" as below.
Should I send identification information to NickServ? (yes/no, default no): y OK, will send identification info to NickServ. You will shortly be requested to enter the primary nickname of your account. Note that this is only usable on Atheme, and cannot be used with other daemons, such as Anope to the point that identification will fail. It is recommended you use this function with Atheme to guarantee your bot correctly identifies. To send the default (if present), enter "." and strike enter. To send NO primary username, enter "#" and strike enter. Otherwise, enter the username you would like to use and strike enter. Please note that this is not the same as the bot nickname. OK, what is the primary username on the account? [mynick]:
The bot is asking for the primary username of the bot's NickServ account. Note that this is only applicable if your irc server uses Atheme (this includes Freenode), but will cause identification to fail on other daemons (such as Anope, used on ClueNet). If you don't wish to send a username (because your server's services don't support it), enter "#" and strike enter (without the quotes, obviously). To use the default (set by $setNSUsername in the configuration file), enter "." and strike enter (without the quotes). Otherwise, you may specify a new one to use. Enter it and strike enter. We'll assume that you aren't using Anope, and don't wish to send a username to NickServ. You would do the following:
OK, what is the primary username on the account? [mynick]: # "#" received, will not send a username to NickServ. You will now be prompted to enter the NickServ password. Please note that THE PASSWORD IS NOT SAVED and it will be VISIBLE IN THE CONSOLE IN CLEAR TEXT, but should disappear when it leaves the screen buffer. For this reason, you should make sure any files containg a shell log should only be readable by you and only priveleged others. IF YOU DO NOT WANT TO ENTER A PASSWORD AND ABORT IDENTIFICATION, ENTER "." AND STRIKE ENTER AT THIS PROMPT. OK, what is the password?
The bot now needs the password to identify. Note that the password will not be saved and will be displayed in clear text, so enter the password away from prying eyes. If you wish to not enter a password and abort the process of identification (but not connecting), enter a period and strike enter. After entering the password, the bot will proceed to connect. Note: If your password is ".", you really should change it. The connection process is shown below.
OK, what is the password? zomgmypass Input received, using that to identify. Attempting to connect to "irc.myircnetwork.com"... Now commencing connection process... Opening socket... Socket to irc.myircnetwork.com opened on port 6667... Socket ID is: 0 -!- CONNECTING TO irc.myircnetwork.com:6667 ... -!- USER bot bot bot :LizardBot v18.104.22.168 -!- NICK mynick *** ID INFO SENT Please enter a comma-delimited list of channels to join:
The bot now needs the channels it is going to join. If you want it to join multiple channels, seperate them with commas. You must include the leading # in the channel names. You should see something like below:
Please enter a comma-delimited list of channels to join: ##chan1,#chan2 Input of "##chan1,#chan2" received! Joining... -!- JOIN ##chan1 -!- JOIN #chan2 *** Sent join messages :irc.myircnetwork.com NOTICE AUTH :*** Looking up your hostname... :irc.myircnetwork.com NOTICE AUTH :*** Checking ident... :irc.myircnetwork.com NOTICE AUTH :*** No ident response; username prefixed with ~ :irc.myircnetwork.com NOTICE AUTH :*** Found your hostname PING :3EC7BD0A PONG 3EC7BD0A :IRC!IRC@irc.myircnetwork.com PRIVMSG mynick :VERSION -!- SENT CTCP VERSION REPLY TO IRC :irc.myircnetwork.com 001 mynick :Welcome IRC Network firstname.lastname@example.org :irc.myircnetwork.com 002 mynick :Your host is irc.myircnetwork.com, running version Unreal3.2.7 :irc.myircnetwork.com 003 mynick :This server was created Sun Nov 9 2008 at 08:31:57 EST :irc.myircnetwork.com 004 mynick irc.myircnetwork.com CR1.8.03-Unreal3.2.7 iowghraAsORTVSxNCWqBzvdHtGplvhopsmntikrRcaqOALQbSeIKVfMCuzNTGj :irc.myircnetwork.com 005 mynick CMDS=KNOCK,MAP,DCCALLOW,USERIP NAMESX SAFELIST HCN MAXCHANNELS=20 CHANLIMIT=#:20 MAXLIST=b:256,e:256,I:256 NICKLEN=30 CHANNELLEN=32 TOPICLEN=307 KICKLEN=307 AWAYLEN=307 MAXTARGETS=20 :are supported by this server :irc.myircnetwork.com 005 mynick WALLCHOPS WATCH=128 SILENCE=15 MODES=12 CHANTYPES=# PREFIX=(qaohv)~&@%+ CHANMODES=beI,kfL,lj,psmntirRcOAQKVCuzNSMTG NETWORK=myircnetwork CASEMAPPING=ascii EXTBAN=~,cqnr ELIST=MNUCT STATUSMSG=~&@%+ EXCEPTS :are supported by this server :irc.myircnetwork.com 005 mynick INVEX :are supported by this server :irc.myircnetwork.com 251 mynick :There are 21 users and 10 invisible on 5 servers :irc.myircnetwork.com 252 mynick 12 :operator(s) online :irc.myircnetwork.com 254 mynick 37 :channels formed :irc.myircnetwork.com 255 mynick :I have 12 clients and 0 servers :irc.myircnetwork.com 265 mynick :Current Local Users: 12 Max: 22 :irc.myircnetwork.com 266 mynick :Current Global Users: 31 Max: 138 :irc.myircnetwork.com 422 mynick :MOTD File is missing :mynick MODE mynick :+x :Globalemail@example.com NOTICE mynick :[Logon News - Oct 05 2008] Welcome to the myircnetwork IRC Network. If you would like a global vHost feel free to request it via HostServ. [ /msg HostServ REQUEST box.domain.tld ] :Globalfirstname.lastname@example.org NOTICE mynick :[Logon News - Oct 05 2008] If help is needed with the server and/or it's services, /join #Help or any supported helpchannel that is listed in the motd and ask your question. :StatServemail@example.com PRIVMSG mynick :VERSION -!- SENT CTCP VERSION REPLY TO StatServ
This is all connection info that you should ignore. The bot will now output everything it sees.
Congratulations! You now have a working copy of LizardBot! Now, look over the General Documentation for help on using the bot!