What pymudclient is
===================

pymudclient is a pure Python implementation of a MUD client. The aim is to keep the
core concepts simple, and give the user the ability to fiddle around with it
to suit their needs. Therefore, the core of the client is fairly small and
modular, with simple interfaces between the parts.

pymudclient is a fork of mudpyl.  See details in "Author, copyright and license"


Features
========

    * Regular-expression based triggers and aliases
    * Trigger-based and fairly safe line rewriting
    * Macros for almost any keys on the keyboard (including with modifiers)
    * Execute Python in-client
    * Coloured HTML logs
    * Supports MCCP v2
    * Tab-completion based on words already seen
    * Keeps a history of previous commands sent

Installing pymudclient
=================

Decompress and untar the package file, and from the unpacked directory, run::

    python setup.py install

Dependencies
============

   * pygdk version 2.0
   * Twisted
   * ordereddict
   * argparse
   
**NOTE**: pymudclient requires python 2.7. 

Running pymudclient
===================

See the file QUICKSTART for a tutorial-style guide for connecting to a MUD.

Author, copyright and license
=============================
Copyright Dmitry Mogilevsky 2015.  
The author can be reached at dmitry.mogilevsky@gmail.com

This project is hosted at github: https://github.com/dmoggles/pymudclient

pymudclient is a fork of mudpyl.
mudpyl was written by Sam Pointon.  
Partial copyright Sam Pointon <sampointon@gmail.com> 2007, 2008, as stipulated by GPL


pymudclient is licensed under the GNU GPL v3 or later. See the LICENSE file for
the full terms and conditions.