Super Simple Silly Bot for Jabber.

Matteo Cypriani f3f9b9baa8 Allow disabling welcome messages (--welcome) 1 year ago
COPYING 071158591d Improve license stuff 1 year ago
README.md f3f9b9baa8 Allow disabling welcome messages (--welcome) 1 year ago
kaabot.py f3f9b9baa8 Allow disabling welcome messages (--welcome) 1 year ago
requirements.txt 95d3b65ee7 Add requirements file 1 year ago
vocabulary.json f343a48f8b Tweak vocabulary file 1 year ago

README.md

KaaBot

Super Simple Silly Bot for Jabber.

Requirements

    pip install -r requirements

Installing

Copy the main script in a directory that's in your $PATH (e.g. $HOME/.local/bin or /usr/local/bin), copy the configuration files in a kaabot subdirectory of a XDG config path (e.g. $HOME/.config/kaabot or /etc/xdg/kaabot), and you'll be ready to make your MUC a happier place!

cp kaabot.py $HOME/.local/bin/kaabot
mkdir $HOME/.config/kaabot
cp vocabulary.json $HOME/.config/kaabot

If no configuration file exists, one will be created automatically (typically in $HOME/.config/kaabot/config) when KaaBot is launched for the first time.

Usage

usage: kaabot [-h] [-d] [-b DATABASE] [-j JID] [-p PASSWORD] [-m MUC]
              [-n NICK] [-V VOCABULARY_FILE] [--welcome WELCOME]

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           set logging to DEBUG
  -b DATABASE, --database DATABASE
                        path to an alternative database; the '{muc}' string in
                        the name will be substituted with the MUC's name as
                        provided by the --muc option
  -j JID, --jid JID     JID to use
  -p PASSWORD, --password PASSWORD
                        password to use
  -m MUC, --muc MUC     Multi User Chatroom to join
  -n NICK, --nick NICK  nickname to use in the chatroom (default: KaaBot)
  -V VOCABULARY_FILE, --vocabulary_file VOCABULARY_FILE
                        path to an alternative vocabulary file
  --welcome WELCOME     welcome users joining the MUC (on/off, default: on)

License

KaaBot is licensed under the terms of the Expat license (also known as the MIT License). See the COPYING file.