git.oblomov.eu Git - rbot/blob - REQUIREMENTS

   1 Ruby modules needed for rbot
   2 ============================
   3
   4 Core requirements
   5       tokyocabinet          for "tc" DB adaptor
   6                             http://1978th.net/tokyocabinet/
   7                             you can install Ruby bindings via "gem install tokyocabinet",
   8                             but this still requires libtokyocabinet to be installed system-wide
   9       bdb (berkeley db)      for "bdb" DB adaptor or converting from it
  10                             http://raa.ruby-lang.org/project/bdb/
  11                             (which requires libdb4.x or better, formerly from
  12                             www.sleepycat.com, now at
  13                             http://www.oracle.com/technology/products/berkeley-db/index.html)
  14                             Most of the time you don't need to compile anything.
  15                             If you're running Linux, your distribution should
  16                             have a libdb-ruby packaged (or similar).
  17                             For Windows instructions, check at the bottom
  18                             of this file.
  19
  20       iconv                 this is needed by the httputil object and by the IRC engine
  21                             to ensure consistent encoding across the bot
  22
  23       net/http 1.2+
  24       net/https             (for debian, this will also need libopenssl-ruby)
  25       socket
  26       uri
  27
  28 Useful but fallback provided
  29       ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
  30                             optional; if installed rbot can use localized messages
  31       htmlentities          http://htmlentities.rubyforge.org/
  32                             optional; if installed rbot will use it to decode
  33                             HTML entities; if missing, an internal table with
  34                             the most common HTML entities will be used instead
  35       hpricot               http://code.whytheluckystiff.net/hpricot/
  36                             optional, if installed rbot will used it to find
  37                             the first paragraph in HTML files; if missing,
  38                             regular expressions will be used instead
  39
  40
  41 Plugin requirements
  42 (these are all optional, if you don't have them, the plugins just won't
  43 function)
  44
  45 bash, digg, slashdot, freshmeat, forecast:
  46       REXML
  47 rss:
  48       rss
  49 shortenurls:
  50       shorturl
  51 time:
  52       tzinfo
  53 translator:
  54       mechanize
  55
  56 External programs needed for rbot
  57 =================================
  58
  59 Plugin requirements
  60 (These are all optional)
  61
  62 cal plugin:
  63       cal(1)
  64
  65 figlet plugin:
  66       figlet(6)
  67
  68 fortune plugin:
  69       fortune(6)
  70
  71 host plugin:
  72       host(1)
  73
  74 spell plugin:
  75       ispell(1)
  76
  77
  78 Running rbot on win32
  79 =====================
  80
  81 You can install Ruby using the One-Click Ruby installer, available from
  82 http://rubyinstaller.rubyforge.org/
  83
  84 You can find a precompiled version of the bdb package for ruby here
  85 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
  86
  87 When you unpack the archive (e.g. using WinZip or 7-Zip or any other tool
  88 of your choice) you'll notice that it contains the following directory structure:
  89   usr
  90    +---local
  91          +---doc
  92          +---lib
  93 and you have to move the doc and lib folders (and all their contents) in the folder
  94 where you installed Ruby (typically C:\Ruby\)
  95
  96
  97 Further instructions
  98 ====================
  99
 100 For further instructions, check http://ruby-rbot.org/rbot-trac/wiki/InstallGuide