Duxlot is a new IRC bot created by Sean B. Palmer, the maker of the popular Phenny. Features include a fast multiprocess architecture, modularity, and ease of use. Duxlot has no dependencies except Python 3, and will even work without having to be installed as as package.

WARNING: This is an pre-release alpha version of Duxlot. The API and features may change, and the bot may not be stable.

Get Python 3.2 or later.

You may use either of these methods:

• Download the latest source:

  duxlot-0.9.21-1653.tar.bz2

  Unpack it and enter duxlot-0.9.21-1653/

  Optionally install using:

  python3 setup.py install

• OR: Install from pypi using pip:

  pip install duxlot

Optionally use virtualenv for either of these methods.

You can now use the duxlot script—either the one in the package that you downloaded, or the one that should be on your $PATH from installation.

WARNING: The entire Duxlot API is not yet stable, including the configuration file. Early adopters will find themselves having to change the configuration files often, with undocumented changes occurring.

Duxlot works by loading a JSON configuration file specified by the user. To create a default configuration file with some options filled in to work from, do:

duxlot create

This will create a file at ~/.duxlot/duxlot.json, which is the default configuration file. You can also create this file manually, if you prefer. You can then edit the file with various options recognised by Duxlot. Here's an example:

{
    "address": "barjavel.freenode.net:6667",
    "nick": "duxlot001",
    "prefix": "^",
    "admin-owner": "you",
    "start-channels": ["#duxlot-test"]
}

A summary of all allowed options is given in the section below.

You can then run the bot either as a daemon:

duxlot start

Or in the foreground:

duxlot --foreground start

If you run the bot as a daemon, you will be told the PID of the daemon. You can stop the bot using the stop action:

duxlot stop

Or by sending a SIGTERM signal to the PID manually.

To find out what else the duxlot script can do, try these commands:

duxlot --help
duxlot --usage

These are the allowed option fields for the configuration file:

address

Server to connect to, as "[ssl ]<hostname>[:<port>]"

nick

Nick for the bot to use for itself

prefix

Default prefix used across all channels for commands

admin-channels

Channels in which some admin commands can be used

admin-owner

Owner of the bot, allowed to use owner commands

admin-users

Users who are allowed to use admin commands

core-private

Private channels where seen data should not be recorded

start-channels

List of channels to join on connecting to the server

start-nickserv

Password to send to the NickServ services bot

start-password

Password to send to the server

People love Phenny, the predecessor of Duxlot. Some of them have wondered how Duxlot relates to Phenny. Stay tuned for information!

Duxlot is pronounced djuːksləʊ, or dʌksləʊ, in IPA.

• David P. Kendal (@dpkendal), who helped me to debug
• Smedley Butler (@epivalent), who helped me to maintain bug isostasy
• Björn Höhrmann (@hoehrmann), who confused me into adding bugs