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 twitter:
  46       oauth, oauth2, json (<ruby1.9)
  47
  48 bash, digg, slashdot, freshmeat, forecast:
  49       REXML
  50 rss:
  51       rss
  52 shortenurls:
  53       shorturl
  54 time:
  55       tzinfo
  56 translator:
  57       mechanize
  58
  59 External programs needed for rbot
  60 =================================
  61
  62 Plugin requirements
  63 (These are all optional)
  64
  65 cal plugin:
  66       cal(1)
  67
  68 figlet plugin:
  69       figlet(6)
  70
  71 fortune plugin:
  72       fortune(6)
  73
  74 host plugin:
  75       host(1)
  76
  77 spell plugin:
  78       ispell(1)
  79
  80
  81 Running rbot on win32
  82 =====================
  83
  84 You can install Ruby using the One-Click Ruby installer, available from
  85 http://rubyinstaller.rubyforge.org/
  86
  87 You can find a precompiled version of the bdb package for ruby here
  88 http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz
  89
  90 When you unpack the archive (e.g. using WinZip or 7-Zip or any other tool
  91 of your choice) you'll notice that it contains the following directory structure:
  92   usr
  93    +---local
  94          +---doc
  95          +---lib
  96 and you have to move the doc and lib folders (and all their contents) in the folder
  97 where you installed Ruby (typically C:\Ruby\)
  98
  99
 100 Further instructions
 101 ====================
 102
 103 For further instructions, check http://ruby-rbot.org/rbot-trac/wiki/InstallGuide