]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - README.md
[gemfile] add (uncommented) deps for all dbtypes
[user/henk/code/ruby/rbot.git] / README.md
1 # RBot - The Ruby IRC Bot
2
3 rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly
4 modular design based around plugins.
5
6 ## Install Guide
7
8 Information about installing the bot can be found here: [Install-Guide](https://github.com/4poc/rbot/wiki/Install-Guide).
9
10 Notes on the registry and migrating from an old bot can be found here: [Registry-Migration-Notes](https://github.com/4poc/rbot/wiki/Registry-Migration-Notes).
11
12 ## Fork Changes
13
14 - Ruby 2.1.1 is fully supported.
15 - Drops ruby 1.8 support, ruby >= 1.9.3 is required.
16 - Removes a lot of broken/outdated plugins.
17 - Removes the DRb remote interface due to its abysmal security.
18 - Introduces a [web service](https://github.com/4poc/rbot/wiki/Web-Service).
19 - Registry is now supporting DBM (that requires no external dependencies).
20 - [New standalone Backup/Restore Script](https://raw.github.com/4poc/rbot/fork/bin/rbotdb) for registry databases.
21 - Registry folders have now different names based on the adapter used: `~/.rbot/registry_<FORMAT>`
22 - Added a bundler `Gemfile` to make installing the dependecies easier.
23
24 ## Known Problems
25
26 * Ruby 2.0.0 (at least <=p353) is causing a segmentation fault crash that
27 only occurs after a few hours. This is [fixed](https://bugs.ruby-lang.org/issues/9168) in newer versions of ruby.
28
29 * DBM (if using Barkeley DB, maybe other backends aswell) is requiring manual repairs to work after
30 a crash.