Difference between revisions of "LizardBot/Docs"
FastLizard4 (Talk | contribs) m (→Commands: fix) |
LizardBot 1 (Talk | contribs) (Adding Category:LizardBot using AutoWikiBrowser) |
||
| Line 53: | Line 53: | ||
'''Note: There is a known bug with the signals. It is being worked on. The bug can be found [[lizardbug:2|here]].''' | '''Note: There is a known bug with the signals. It is being worked on. The bug can be found [[lizardbug:2|here]].''' | ||
| + | [[Category:LizardBot]] | ||
Revision as of 05:53, 30 March 2009
 |
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. |
Contents
[hide]Commands
To run a command, simply say the command either in a channel the bot is in or as a PM to the bot. Commands are displayed in this format:
command [parameters] {optional parameters} (access level required by default to execute) description
NOTE: For the access level, s-trusted inherits *, trusted inherits s-trusted and *, v-trusted inherits trusted, s-trusted, and *, and root inherits v-trusted, trusted, s-trusted, and *. The special ignore group causes the bot to completely ignore messages from people in it.
NOTE: As of v5.3.2.0b, you may choose a custom command trigger. Being the default, @ is used below, but you may customize it for your bot. See Bot Setup for details on setting this.
NOTE: As of v5.4.0.2b, if you pass a : to the bot in a @eval or @exec command, you must replace it with $$ to avoid the bot from screwing up. For example, instead of @eval return self::$test, you should do @eval self$$$$$test.
- @test (*) Tests the bot to see if it is running
- @die (root) Orders the bot to disconnect from the current network
- @say {target} [text] (s-trusted) Says text in the channel. Target necessary when command sent in PM. If sent in channel, sends text to that channel.
- @do {target} [text] (s-trusted) Performs a /me with text in the channel. Target necessary when command sent in PM. If sent in channel, sends text to that channel.
- @join [channel] (trusted) Joins the specified channel.
- @part [channel] (trusted) Parts the specified channel.
- @notice {target} [text] (trusted) Sends a notice to the target. Target is necessary when command sent in PM, otherwise, target is the channel command sent in.
- @raw [data] (root) Dumps the raw data to the uplink stream as a raw IRC command. Do not use if you don't know what you're doing!
- @oper (DEFUNCT) Defunct command. Was useful to me, never bothered to remove it from the bot.
- @fap {nick} (s-trusted) Ceiling_cat is watching you! If no nick is specified, defaults to the person calling the command. Must be run in the target channel.
- @kick {channel} [target] [comment] (trusted) Kicks target from channel with comment comment. Channel only useful if command sent in PM, otherwise uses channel the command was called in.
- @op (trusted) Asks the bot to op itself in the channel it was called in. Bot must be on channel access list.
- @deop (trusted) Asks the bot to deop itself in the channel it was calld in.
- @deoper (DEFUNCT) Defunct command. Bot can't oper.
- @rehash (root) Causes the bot to reparse the configuration file. Use after editing the configuration file.
- @nick [nick] (root) Causes the bot to change its nick to nick.
- @info (*) Some help output
- @nyse [symbol] (*) Get the stock quote on the New York Stock Exchange for symbol.
- @fantasy (v-trusted) Shows whether the AI is enabled or not.
- @fantasy-on (v-trusted) Enables the AI
- @fantasy-off (v-trusted) Disables the AI
- @mute (v-trusted) Disables the bot entirely except for the @unmute command. WARNING: This will cause the bot to ping timeout, so only use in emergencies and disable when not needed!
- @unmute (v-trusted) Reenables the bot after use of @mute
- [bot nick]: [text] (*) Allows someone to invoke the AI, if enabled.
- @exec [command string] (root) DANGEROUS! Allows priveleged users to DIRECTLY EXECUTE commands on the server! If you really want it, remember to enable it ($setEnableExec in the config file)
- @eval [PHP] (root) DANGEROUS! Allows priveleged users to DIRECTLY EXECUTE PHP! If you really want it, remember to enable it ($setEnableEval in the config file)
- @update (*) Checks for updates
- @wot [site] (*) Checks the WoT reputation rating for site. site is without the protocol prefix (en.wikipedia.org instead of http://en.wikipedia.org). The reply is in this format:
- The WoT rating for [site] is: Trust: <[rating], [% users that agree] >; Reliability: < ... >; Privacy: < ... >; Child Safety: < ... >
- @gcalc [operation] (*) Asks google to perform the operation using Google Calculator. Can be a math function (2+2) or a currency conversion (150 USD in Yen)
- @editcount [username] {language} {wiki} (*) Asks SoxRed's editcount tool for the latest editcount for username on the language wiki. Only works for Wikimedia wikis. Some example usages of the command are:
@editcount loluseror@editcount loluser de wikinews. Note that you must replace spaces in the username with underscores. Language defaults to en, and wiki defaults to wikipedia. You cannot specify wiki without language.
Signals
- ^C: SIGINT: Ends the bot with a message indicating a SIGINT
- 1: SIGHUP: Causes the bot to rehash its config file
- 15: SIGTERM: Ends the bot with a message indicating a SIGTERM
Note: There is a known bug with the signals. It is being worked on. The bug can be found here.
