From 78c79eae617df21a6188c6b47cd9dcf56e54904e Mon Sep 17 00:00:00 2001 From: Matthias H Date: Mon, 24 Feb 2014 06:37:36 +0100 Subject: [PATCH] README update --- README.md | 22 ++++++++++++++++++++++ README.rdoc | 45 --------------------------------------------- 2 files changed, 22 insertions(+), 45 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 00000000..d4e1cacf --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ += RBot - The Ruby IRC Bot + +rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly +modular design based around plugins. + +== Fork Changelog + +- Drops ruby 1.8 support, ruby >= 1.9.3 is required. +- Ruby 2.1.0 is supported. +- Removes a lot of broken/outdated plugins. +- Removes the DRb remote interface due to its abysmal security. +- Introduces a web service. +- Registry is now supporting DBM (that requires no external dependencies). + +== Known Problems + +Ruby 2.0.0 (at least <=p353) is causing a segmentation fault crash that +only occurs after a few hours. https://bugs.ruby-lang.org/issues/9168 + +DBM (if using Barkeley DB) is requiring manual repairs to work after +a crash. + diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index cd9a982f..00000000 --- a/README.rdoc +++ /dev/null @@ -1,45 +0,0 @@ -= rbot - The Ruby IRC bot - -rbot is a ruby IRC bot. Think of him as a ruby bot framework with a highly -modular design based around plugins. - -== rbot features - -* Runtime configuration via irc chat -* User authentication and access levels for using different bot features -* Built in infobot-style keywords. -* Support for underlying fact database (infobot fact files), which can - be overridden or supplemented by runtime keyword controls -* Multi-language support - comes with english, dutch, german, french, italian - japanese, chinese, russian and finnish definitions so far - more translations welcome -* Powerful plugin architecture, comes with plugins for: - - RSS feed updates - - IMDb queries - - Translator with multitude of services, it's easy as !translate Ein Automobil - - Last.fm - - Google searching - - URL information - - Seen +nick+? - * rbot: seen tango? tango_ was last seen 20 minutes and 7 seconds ago, joining #rbot - - Reminders - * Example: remind me about pizza in the oven in 15 minutes - - Checking the weather - - Doing math - - GeoIP lookup - - Lots of games, including uno, hangman, azgame and roshambo - - Karma - - Per-channel quote storage, searching and retrieval - - Check the spelling of a word - - RPG dice rolling - - larting people - - Conversation stats — also, rbot log format is supported by {pisg}[http://pisg.sourceforge.net/] - - more... - -Thanks are owed to the infobot developers - several of rbot's features are -inspired by infobot and so are some of the default plugins. Thanks are also -owed to RADKade1, as rbot's quote plugin is a direct reimplementation of his -"quotesaq" - simply because it's a great quote interface. - -Mainly, rbot's fun to play with, although the plugin architecture can be used -to write very useful modules - -- 2.39.5