summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100755
index 0000000..71dce8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+python-fischbot
+===============
+
+IRC bot for #casiocalc on Afternet
+
+Requires:
+---------
+socket, sys, re, random, time, urllib2, os, subprocess, hashlib, datetime, json
+
+Required files:
+---------------
+_Unless stated otherwise, newlines separate lists_
+* **hashes.txt:** sha1 hashes of passwords for use of the !op command.
+* **blacklist.txt:** names of users not to be autovoiced.
+
+Commands:
+---------
+* !intro <name>: Send a message telling <name> to introduce himself on UCF
+* !info: info about fischbot
+* !8ball <query>: Return a super 8 ball message
+* !coin: flip a coin
+* !say <message>: have fischbot say something in the chat
+* !ddg <query>: Search DuckDuckGo and return the instant answers, if available.
+* !flood: >:-D
+* !info-contrib: info about contributing
+* !info-bugs: info about reporting bugs
+* !op <pass> <user>: op user
+* !blame: self-explanatory
+* !authfischbot <pass>: auth fischbot on afternet
+* !tell <user> <message>: Tell <user> a <message> when he joins the room
+* !slap <user>: you know what this does.