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                             you can install those requirement in debian like this:
  10                             sudo aptitude install libtokyocabinet9 libtokyocabinet-dev zlib1g-dev libbz2-dev
  11       sqlite3               for "sqlite" DB adaptor
  12                             install with gem install sqlite,
  13                             this also requires development libraries on the system to be present.
  14       mechanize             install it using gem install mechanize
  15
  16 Useful but fallback provided
  17       ruby-gettext 1.8.0+   http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext
  18                             optional; if installed rbot can use localized messages
  19       htmlentities          http://htmlentities.rubyforge.org/
  20                             optional; if installed rbot will use it to decode
  21                             HTML entities; if missing, an internal table with
  22                             the most common HTML entities will be used instead
  23       hpricot               http://code.whytheluckystiff.net/hpricot/
  24                             optional, if installed rbot will used it to find
  25                             the first paragraph in HTML files; if missing,
  26                             regular expressions will be used instead
  27
  28
  29 Plugin requirements
  30 (these are all optional, if you don't have them, the plugins just won't
  31 function)
  32
  33 twitter:
  34       oauth, oauth2
  35
  36 shortenurls:
  37       shorturl
  38
  39 time:
  40       tzinfo
  41
  42 External programs needed for rbot
  43 =================================
  44
  45 Plugin requirements
  46 (These are all optional)
  47
  48 cal plugin:
  49       cal(1)
  50
  51 figlet plugin:
  52       figlet(6)
  53
  54 fortune plugin:
  55       fortune(6)
  56
  57 host plugin:
  58       host(1)
  59
  60 spell plugin:
  61       ispell(1)
  62
  63
  64 Running rbot on win32
  65 =====================
  66
  67 OMYGOD no!
  68
  69     http://www.fefe.de/nowindows/
  70
  71
  72 Further instructions
  73 ====================
  74
  75 For further instructions, check https://github.com/4poc/rbot/wiki/Install-Guide
  76 For tips on handling the persistent plugin storage, backup, restore
  77 and migration, check: https://github.com/4poc/rbot/wiki/Registry-Migration-Notes
  78