Documentation for the Fun plugin for Supybot

Provides a multitude of fun, useless commands.

Commands for Fun
Command	Args	Detailed Help
chr	<number>	Returns the character associated with the 8-bit value <number>
coin	takes no arguments	Flips a coin and returns the result.
decode	<encoding> <text>	Returns an un-encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://www.python.org/doc/lib/node127.html>.
dice	<dice>d<sides>	Rolls a die with <sides> number of sides <dice> times. For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 ten-sided dice.
eightball	[<question>]	Ask a question and the answer shall be provided.
encode	<encoding> <text>	Returns an encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://www.python.org/doc/lib/node127.html>.
fun	<command> [<args> ...]	Command dispatcher for the Fun plugin. Use 'list Fun' to see the commands provided by this plugin. Use 'config list plugins.Fun' to see the configuration values for this plugin. In most cases this dispatcher command is unnecessary; in cases where more than one plugin defines a given command, use this command to tell the bot which plugin's command to use.
hexip	<ip>	Returns the hexadecimal IP for that IP.
levenshtein	<string1> <string2>	Returns the levenshtein distance (also known as the "edit distance" between <string1> and <string2>)
md5	<text>	Returns the md5 hash of a given string. Read http://www.rsasecurity.com/rsalabs/faq/3-6-6.html for more information about md5.
mimetype	<filename>	Returns the mime type associated with <filename>
monologue	[<channel>]	Returns the number of consecutive lines you've sent in <channel> without being interrupted by someone else (i.e. how long your current 'monologue' is). <channel> is only necessary if the message isn't sent in the channel itself.
objects	takes no arguments	Returns the number and types of Python objects in memory.
ord	<letter>	Returns the 8-bit value of <letter>.
ping	takes no arguments	Checks to see if the bot is alive.
roulette	[spin]	Fires the revolver. If the bullet was in the chamber, you're dead. Tell me to spin the chambers and I will.
sha	<text>	Returns the SHA hash of a given string. Read http://www.secure-hash-algorithm-md5-sha-1.co.uk/ for more information about SHA.
soundex	<string> [<length>]	Returns the Soundex hash to a given length. The length defaults to 4, since that's the standard length for a soundex hash. For unlimited length, use 0.
urlquote	<text>	Returns the URL quoted form of the text.
urlunquote	<text>	Returns the text un-URL quoted.
xor	<password> <text>	Returns <text> XOR-encrypted with <password>. See http://www.yoe.org/developer/xor.html for information about XOR encryption.

Configuration Variables for the Fun plugin

supybot.plugins.Fun.public
- Default: True
- Channel Specific: False
- Help: Determines whether this plugin is publicly visible.
supybot.plugins.Fun.levenshtein
- .max
  - Default: 256
  - Channel Specific: False
  - Help: Determines the maximum size of a string given to the levenshtein command. The levenshtein command uses an O(n**3) algorithm, which means that with strings of length 256, it can take 1.5 seconds to finish; with strings of length 384, though, it can take 4 seconds to finish, and with strings of much larger lengths, it takes more and more time. Using nested commands, strings can get quite large, hence this variable, to limit the size of arguments passed to the levenshtein command.