crimsonfubot setup
[wiki.git] / irc / bots / supybot.mdwn
1 * http://supybot.com
2 * http://supybot.git.sourceforge.net/git/gitweb.cgi?p=supybot/supybot;a=tree;f=doc (official docs, I think)
3 * http://sourceforge.net/apps/mediawiki/gribble/index.php?title=Supybot_Resources
4 * http://supybook.fealdia.org
5 * http://supybot.fr.cr/doc/
6 * http://supybot.fr.cr/doc/use/plugins/google.html#google-lucky-snippet-search
7 * http://github.com/code4lib/supybot-plugins
8 * http://github.com/ProgVal/Limnoria "A modified version of Supybot with internationalization, embedded web server, bug fixes, and several other enhancements"
9
10 ## crimsonfubot setup
11
12     [root@server1 ~]# cat /etc/centos-release 
13     CentOS release 6.2 (Final)
14     [root@server1 ~]# 
15     [root@server1 ~]# rpm -qi supybot
16     Name        : supybot                      Relocations: (not relocatable)
17     Version     : 0.83.4.1                          Vendor: Fedora Project
18     Release     : 3.el6                         Build Date: Mon 18 Apr 2011 04:12:52 PM EDT
19     Install Date: Fri 08 Jun 2012 09:54:53 PM EDT      Build Host: x86-17.phx2.fedoraproject.org
20     Group       : Applications/Internet         Source RPM: supybot-0.83.4.1-3.el6.src.rpm
21     Size        : 4081850                          License: BSD and GPLv2
22     Signature   : RSA/8, Tue 19 Apr 2011 04:55:08 AM EDT, Key ID 3b49df2a0608b895
23     Packager    : Fedora Project
24     URL         : http://supybot.com
25     Summary     : Cross-platform IRC bot written in Python
26     Description :
27     Supybot is a robust, user-friendly, and programmer-friendly Python IRC bot.
28     It aims to be an adequate replacement for most existing IRC bots.  It
29     includes a very flexible and powerful ACL system for controlling access
30     to commands, as well as more than 50 builtin plugins providing around
31     400 actual commands.
32     [root@server1 ~]# 
33     [root@server1 ~]# su - supybot
34     [supybot@server1 ~]$ supybot-wizard 
35     /usr/bin/supybot-wizard:48: DeprecationWarning: the sets module is deprecated
36       import sets
37     ERROR 2012-06-08T21:55:55 Invalid user dictionary file, resetting to empty.
38     ERROR 2012-06-08T21:55:55 Exact error: IOError: [Errno 2] No such file or directory: 'conf/users.conf'
39     ERROR 2012-06-08T21:55:55 Invalid channel database, resetting to empty.
40     ERROR 2012-06-08T21:55:55 Exact error: IOError: [Errno 2] No such file or directory: 'conf/channels.conf'
41     WARNING 2012-06-08T21:55:55 Couldn't open ignore database: [Errno 2] No such
42             file or directory: 'conf/ignores.conf'
43     This is a wizard to help you start running supybot. What it will
44     do is create the necessary config files based on the options you
45     select here. So hold on tight and be ready to be interrogated :)
46
47     First of all, we can bold the questions you're asked so you can
48     easily distinguish the mostly useless blather (like this) from
49     the questions that you actually have to answer.
50
51     Would you like to try this bolding? [y/n] (default: y) 
52
53      Do you see this in bold? [y/n] 
54
55     Sorry, that response was not an option.
56
57      Do you see this in bold? [y/n] y
58
59     Great!
60
61     We've got some preliminary things to get out of the way before we
62     can really start asking you questions that directly relate to
63     what your bot is going to be like.
64
65     We want to know if you consider yourself an advanced Supybot user
66     because some questions are just utterly boring and useless for
67     new users. Others might not make sense unless you've used Supybot
68     for some time.
69
70      Are you an advanced Supybot user? [y/n] (default: n) 
71
72     Your bot needs to create some directories in order to store the
73     various log, config, and data files.
74
75      Where would you like to create these directories? (default: .) 
76
77     Good! We're done with the directory stuff.
78
79     Now we're going to ask you things that actually relate to the bot
80     you'll be running.
81
82     First, we need to know the name of the network you'd like to
83     connect to. Not the server host, mind you, but the name of the
84     network. If you plan to connect to irc.freenode.net, for
85     instance, you should answer this question with 'freenode'
86     (without the quotes).
87
88      What IRC network will you be connecting to? freenode
89
90      What server would you like to connect to? irc.freenode.net
91
92     Found irc.freenode.net (no network available).
93
94     IRC Servers almost always accept connections on port 6667. They
95     can, however, accept connections anywhere their admin feels like
96     he wants to accept connections from.
97
98      Does this server require connection on a non-standard port? [y/
99     n] (default: n) 
100
101      What nick would you like your bot to use? crimsonfubot
102
103     Some servers require a password to connect to them. Most public
104     servers don't. If you try to connect to a server and for some
105     reason it just won't work, it might be that you need to set a
106     password.
107
108      Do you want to set such a password? [y/n] (default: n) 
109
110     Of course, having an IRC bot isn't the most useful thing in the
111     world unless you can make that bot join some channels.
112
113      Do you want your bot to join some channels when he connects? [y/
114     n] (default: y) 
115
116     Separate channels with spaces. If the channel is locked with a
117     key, follow the channel name with the key separated by a comma.
118     For example: #supybot-bots #mychannel,mykey #otherchannel
119
120      What channels? (default: ) #crimsonfu
121
122     Beginning configuration for Admin...
123
124
125     Done!
126
127     Beginning configuration for User...
128
129
130     Done!
131
132     Beginning configuration for Channel...
133
134
135     Done!
136
137     Beginning configuration for Misc...
138
139
140     Done!
141
142     Beginning configuration for Config...
143
144
145     Done!
146
147     Now we're going to run you through plugin configuration. There's
148     a variety of plugins in supybot by default, but you can create
149     and add your own, of course. We'll allow you to take a look at
150     the known plugins' descriptions and configure them if you like
151     what you see.
152
153      Would you like to look at plugins individually? [y/n] y
154
155     Next comes your opportunity to learn more about the plugins that
156     are available and select some (or all!) of them to run in your
157     bot. Before you have to make a decision, of course, you'll be
158     able to see a short description of the plugin and, if you choose,
159     an example session with the plugin. Let's begin.
160
161      What plugin would you like to look at? [Alias/Anonymous/
162     AutoMode/BadWords/ChannelLogger/ChannelStats/Ctcp/Dict/Dunno/
163     Factoids/Filter/Format/Games/Google/Herald/Internet/Karma/
164     Lart/Later/Limiter/Math/MoobotFactoids/Network/News/
165     NickCapture/Nickometer/Note/Plugin/Praise/Protector/Quote/
166     QuoteGrabs/RSS/Relay/Reply/Scheduler/Seen/Services/ShrinkUrl/
167     Status/String/Success/Time/Todo/Topic/URL/Unix/Utilities/
168     Web] Google
169
170
171     Accesses Google for various things.
172
173
174      Would you like to load this plugin? [y/n] (default: y) 
175
176     Beginning configuration for Google...
177
178     The Google plugin has the functionality to watch for URLs that
179     match a specific pattern. (We call this a snarfer) When supybot
180     sees such a URL, it will parse the web page for information and
181     reply with the results. Google has two available snarfers: Google
182     Groups link snarfing and a google search snarfer.
183
184      Do you want the Google Groups link snarfer enabled by default?
185     [y/n] n
186
187      Do you want the Google search snarfer enabled by default? [y/
188     n] y
189
190
191     Done!
192
193      Would you like add another plugin? [y/n] n
194
195     Although supybot offers a supybot-adduser script, with which you
196     can add users to your bot's user database, it's *very* important
197     that you have an owner user for you bot.
198
199      Would you like to add an owner user for your bot? [y/n]
200     (default: y) 
201
202      What should the owner's username be? pdurbin
203
204     What should the owner's password be? 
205     Re-enter password: 
206     Of course, when you're in an IRC channel you can address the bot
207     by its nick and it will respond, if you give it a valid command
208     (it may or may not respond, depending on what your config
209     variable replyWhenNotCommand is set to). But your bot can also
210     respond to a short "prefix character," so instead of saying "bot:
211     do this," you can say, "@do this" and achieve the same effect. Of
212     course, you don't *have* to have a prefix char, but if the bot
213     ends up participating significantly in your channel, it'll ease
214     things.
215
216      Would you like to set the prefix char(s) for your bot? [y/n]
217     (default: y) 
218
219     Enter any characters you want here, but be careful: they should
220     be rare enough that people don't accidentally address the bot
221     (simply because they'll probably be annoyed if they do address
222     the bot on accident). You can even have more than one. I
223     (jemfinch) am quite partial to @, but that's because I've been
224     using it since my ocamlbot days.
225
226      What would you like your bot's prefix character(s) to be? @
227
228     There are a lot of options we didn't ask you about simply because
229     we'd rather you get up and running and have time left to play
230     around with your bot. But come back and see us! When you've
231     played around with your bot enough to know what you like, what
232     you don't like, what you'd like to change, then take a look at
233     your configuration file when your bot isn't running and read the
234     comments, tweaking values to your heart's desire.
235
236     All done! Your new bot configuration is crimsonfubot.conf. If
237     you're running a *nix based OS, you can probably start your bot
238     with the command line "supybot crimsonfubot.conf". If you're not
239     running a *nix or similar machine, you'll just have to start it
240     like you start all your other Python scripts.
241
242     [supybot@server1 ~]$