GNOME-Mud Plugin API

This manual describes version 0.9.1 of GNOME-Mud's Plugin API. It was last updated on 05/06/2002.

Table of Contents
1. Introduction
2. GNOME-Mud's Python plugin interface
2.1. Basic usage
2.2. GnomeMud module
2.2.1. Connection class
3. GNOME-Mud's C plugin interface
A. Python script example
B. C script example

1. Introduction

GNOME-Mud is an specialized telnet client to play Multi-User Dungeons, or MUDs.

GNOME-Mud provides the user with a series of functionality that makes mudding somewhat easier. Most notably, the ability to define `triggers', `aliases' and `character profiles', or the MUD lists support help making usual tasks like connecting to different MUDs and typing common names or commands more effective and fast.

GNOME-Mud has a plugin interface which allows users to extend the functionality of the client, and to perform more complex tasks. Currently, GNOME-Mud supports plugins written in C and Python. This manual only describes the Python interface and assumes the reader is familiar with basic Python programming. Tutorials and additional documentation are available on the Python Web page. The C interface will be described in later versions.