README

   1
   2 ======
   3  Vomak
   4 ======
   5
   6 ----------------------
   7  A very simple IRC bot
   8 ----------------------
   9
  10 :Author: Enrico Tröger
  11 :Date: 2008-03-24
  12 :Version: 0.1
  13
  14 Copyright © 2008
  15
  16 Vomak is distributed under the terms of the GNU General Public
  17 License as published by the Free Software Foundation; version 2
  18 of the License. A copy of this license can be found in the file
  19 COPYING included with the source code of this program.
  20
  21
  22 BIG FAT WARNING
  23 ===============
  24 This code is not well tested and probably runs only on GNU/Linux systems.
  25 There has no work been made in being compatible with other systems nor
  26 being very secure.
  27 This whole code was just written to get an IRC bot working and only was
  28 published in case anyone might find it useful. The code quality is also
  29 not very good, comments are missing.
  30 It does not very much error checking, consider it running unstable.
  31 This document is the only documentation available besides the source code.
  32
  33 You have been warned.
  34
  35
  36 About
  37 =====
  38 Vomak is a very simple IRC bot with a few basic features.
  39 It connects to an IRC server and joins a channel. Then it waits for
  40 commands like ``?? keyword``. This is the built-in help system, see
  41 `Help System`_.
  42 Additionally, the bot creates a socket (Unix Domain Socket) where it
  43 accepts directly IRC messages and a few special commands, see
  44 `Socket Communication`_.
  45
  46
  47 Configuration
  48 =============
  49 Vomak expects two configuration files in the ~/.vomak.
  50 The first is ``config`` and defines basic settings for operation.
  51 The settings should be self-explanatory.
  52 The second file is `database` which contains all definitions for the
  53 built-in help system. The format is pretty simple, each line contains
  54 a key-value pair. The key should not contain whitespaces, quotes or any
  55 special characters. The values can contain any characters except line
  56 breaks. To add a line break, escape it with ``\n``.
  57 Each defined key-value pair can later be queried with the command
  58 ``?? key``.
  59 Examples of both files are included in the source code.
  60
  61
  62 Help System
  63 ===========
  64 The built-in help system is a handy way to access often used information and
  65 print them in the current channel for all users. It is triggered by two question
  66 marks followed by a space and the keyword to search.
  67 If the keyword is not known, nothing happens.
  68 If it is known, Vomak will print the corresponding help text found in its database.
  69 The database is a simple text file with some pre-defined help texts, see
  70 `Configuration`_ above.
  71 There is a special keyword named ``keywords`` which lists all known keywords.
  72
  73
  74 Socket Communication
  75 ====================
  76 A Unix Domain Socket is created once Vomak has start up and it is meant for
  77 inter-process communication with other applications running on this host.
  78 Please be careful with connecting clients: the opened socket connection should
  79 be closed as soon as all commands are sent and possible answers have been read.
  80 The socket is non-blocking, i.e. while a client connects to the socket, Vomaks
  81 main operation(reading and processing IRC messages) is blocked.
  82 All commands are line-based, i.e. answers are terminated with ``\r\n`` and you
  83 should your commands terminate with a ``\r\n``.
  84 Vomak accepts direct IRC messages (e.g. ``PRIVMSG #channel :text to send``) or
  85 the following special commands:
  86
  87 * userlist
  88 * reload
  89 * quit
  90
  91 userlist
  92 --------
  93 After sending this command to the socket, it will answer with a space separated
  94 list of currently connected users to current channel.
  95 Vomak caches this list for performance reasons and updates it every three minutes.
  96
  97 reload
  98 ------
  99 This command performs a reload of the database with the help texts. This is useful
 100 when you want to add, edit or remove some help texts and don't want to quit and start
 101 Vomak again.
 102
 103 quit
 104 ----
 105 Does a graceful shutdown of the program. This can also achieved by the SIGTERM or SIGINT
 106 signals.
 107
 108