New plugin: suggestions
[dcbot.git] / README
blobb7c5e057670eb8e112127728f4686abc689041d9
1 DCBot is a Direct Connect bot written in Ruby.
2 It has an extensible plugin architecture backed by a database
3 and comes with a plugin to manage requests.
5 Dependencies
6 ============
8 - RubyGems
9 - ActiveRecord
10 - EventMachine
12 Usage
13 =====
15 Edit dcbot_example.conf, rename it to dcbot.conf, and then run dcbot.rb.
16 Typing text into standard input will send it as messages to hub chat.
18 Notes
19 =====
21 At this time, only one hub connection is supported. It should be easy to add multiple hubs,
22 but I didn't need it and I wasn't sure how to handle keyboard input in that case.
24 Also, please note that this is a fairly quick and dirty bot, so don't be surprised if some
25 of the architecture is suboptimal.
27 Author
28 ======
30 Kevin Ballard <kevin@sb.org>