mikiya / xchatruby-plugins Goto Github PK

Trivial XChat-Ruby plugin set

------------
Installation
------------

* Install XChat version 2.6 or later
* Install XChat-Ruby Plugins.
* Setup rubyenv (ruby -e 'puts $:' > ~/.xchat2/rubyenv)
* Copy all .rb files under ~/.xchat2.

-------
License
-------
GPLv2. See COPYING for more details.

--------------
auto_greets.rb
--------------
Say greetings automatically when a user joined a channel, or a user changed
his/her nickname from what indicates the user is away to what indicates the
user is not away.

  Configuration
  -------------

  1. Ensure the plugin is loaded.

    /rb list

  2. Create a file named ~/.xchat2/greet.conf and edit like below.

    greet_word            "hi"            # Greetings word.
    wb_word               "welcome back"  # Greetings word when a user comes
                                          # back within short time.
    delay                 5               # Seconds to wait after a user joined
                                          # a channel before say greetings.
    wb_period             60 * 60         # A period to assumed as wb.
    cooling_off_period    60 * 60 * 8     # A period to assumed as offline.

  3. List all nicknames to say hello to in ~/.xchat2/known_nicks.

    e.g.)
    tom
    john
    taro

  4. Then the plugin starts saying hello to listed nicknames automatically.

  Usage
  -----
  
  1. You can see some information using /greet command at any time.

      /greet
          help           ... Show this help.
          all            ... Say greetings to all known nicks.
          status         ... Show status per nick.
          list           ... List all nicks to say greetings.
          config         ... Display current config.

  2. If you wish to say hello to all people you know, submit "/greet all".

---------------
chat_indexer.rb
---------------
Organize fulltext indexes upon Groonga and enable fulltext searches via command.

  Configuration
  -------------

  1. Install Groonga

    http://groonga.org/

  2. Install rroonga

    shell> gem install groonga

  3. Ensure the plugin is loaded.

    /rb list

  4. The plugin automatically organize indexes.

  Usage
  -----

  /indexer
         help           ... Show this help.
         find {word}    ... Do fulltext search.
         show {msg_id}  ... Display individual lines around a certain msg_id.
         last           ... Display the last search result.
         lines [#]      ... Show/set lines to display results. Default is 20.