I.  Interface
	1. ANSI color
	2. Input
	   a. Multi-line input
	   b. string argument seperator
	   c. command history
	   d. auto completion
	   e. keep sent text
	3. Multi-Game Tabs
	   a. Tab moving
	   b. Tab detachment
	   c. Tab alert on change
	   d. Tab reconnection, disconnect, close
	4. Game Wizard List
	5. Logging
	6. Themes

II. Protocols
	1 MSP (sound protocol)
	2 MCCP v1/v2 (compression protocol)
	3 ZMP (Zenith Mud Protocol)
	4 MXP (Mud Xtension Protocol)

III. Alias, Triggers, Macros
	1. Alias
	2. Triggers
	3. Macros

IV. Modules
	1. Database Module
	2. Notes Module
	3. Recorder Module
	4. Automapper Module

V. Scripting
	1. MudMagic BASIC
	2. Python


I. Interface
---------------------------

	1. ANSI Color
	-------------
MudMagic client is designed to be fully compliant with standard ANSI. The client has also been adjusted to take 
into consideration non-standard ANSI for Muds which make use of customised color output that doesn't quite adhere to 
strict ANSI usage.

The MudMagic client is OpenSource and any adjustments to color can be made at user request. View the Developing help 
file for details on modifying the client to suit your requirements.


	2. Input
	-----------------------------
MudMagic client provides multiple input method and features to provide the most interaction with the client.

		a. Multi-line input
		-------------------
By clicking on the icon to the left of an entry field, you can input multiple lines at once. This is handy for Builders 
or users that wish to send multiple text lines at once. You can copy and paste values into this multi-line input field.

To send the multiple lines - click on the SEND icon to the right of the entry field after entering the desired text.

		b. string argument seperator
		----------------------------
By setting your string argument seperator located in: Settings -> Global Settings -> Strings
you can process multiple input commands with one entry. Instead of having to type in:

west
east
open north

You can set a 'String Argument Seperator' of ;  and then only input

west;east;open north

to have the same effect

		c. command history
		-------------------
The Command History feature allows you to backscroll through your past input commands. This feature is only valid for 
direct entry commands - not multi-line inputs.

You can adjust the amount of command history stored in the buffer by visiting:
Settings -> Global Settings -> Input
and adjusting the value of 'Save command history'. 

This flag is toggable and can be turned on and off with a checkbox.

		d. auto completion
		-------------------
Autocompletion allows your repeated input commands to be automatically filled out for you. This is not a good feature 
for world travelling; but comes in handy when doing Administrative tasks that require the same commands to be input. 
When combined with Command History toggle - a browseable selection list is available for clickable history commands.

		e. keep sent text
		-------------------
This will keep your sent text on the entry field. With this toggled, when you input a command, it is then highlighted 
and you can either hit ENTER to reenter the same command, or input the new command and the old highlighted one will 
automatically be over-written.

	3. Multi-Game Tabs
	---------------
When you select to run more than one login at once, tabs will appear at the top of your client. These tabs are movable 
and detachable.

  		a. Tab moving
  		-------------
To move tabs to the left or right of other tabs, click on the TABS at the top of the client and select the 
appropriate directo to move the tab. The movement is for the current tab in view.

  		b. Tab detachment
  		-----------------
A tab can be detached from the client to view in a seperate window. To detach a tab, click on TABS at the top of the 
client and select detach. This will affect the current tab in view.

   		c. Tab alert on change
   		----------------------
When focus is not on a current tab - a small red colored ball will appear on that tab to let you know that the content 
on that tab has changed.

		d. Tab reconnection, disconnect, close
   		--------------------------------------
You can reconnect or disconnect from the game on a current tab by right-clicking on that tab and selecting the 
appropriate entry. To close the tab - right-click on the tab and select close.


	4. Game Wizard List
	-------------------
The Game Wizard allows you to browse all games that are present in the MudMagic database. Multiple fields are viewable, 
to include the games theme, host, website address and more.

	5. Logging
	-------------------
A basic logging feature is available per game by visiting PROFILE -> Logging to toggle on logging. Once toggled, you 
can view the log output on linux by visiting the appropriate slot entry in your ~/.mudmagic file, or on windows by 
visiting the appropriate slot entry at: c:\Program Files\MudMagic

	6. Themes
	-------------------
Theme support is available. For Linux users, the theme engine is default set to your current OS distro. For window 
users, MudMagic has bundled several themes to choose from with the MudMagic full distro version.


II PROTOCOLS
---------------------------------------------------

1. MSP (mud sound protocol)
---------------------------
This protocol allow different sounds effect or music to be played in certain situations. The protocol must be also 
supported by server. 

To activate MSP for a session enable:
Settings -> Global Settings -> Sounds

In case the file specified it's not available on local disk, and a URL is specified by mud server ( this is 
transparent for user ) the file may be downloaded. This can have a significant impact on MUD playing performance. To 
activate download enable: 
Settings-> Global Settings -> Sounds -> (click) Allow Download

The command should be in $PATH or a full filename must be specified.

Example:
.wav 
play %s -v %d
.mid
/usr/local/bin/playmidi -V %d %s

Notes:
	- %s will be replaced by mud client with filename
	- %d will be replaced by mud client with volume 


2. MCCP v1/v2 (compression protocol)
--------------------------------------
Allow to the server to send compressed data to reduce band use.  (It's transparent for user.)


3. ZMP (Zenith Mud Protocol)
----------------------------

The Zenith MUD Protocol is a telnet-based protocol for text-based MUD servers and clients.  The protocol is based on a 
form of RPC, or remote procedure call.  In other words, clients and servers call functions on the other end of a 
connection, giving parameters.

See more info at http://www.awemud.net/zmp/draft.shtml.


4. MXP (Mud Xtension Protocol)
------------------------------
For games which make use of MXP or Mud Xtension Protocol - MudMagic client currently supports basic MXP tags. Full MXP 
support is expected in version 1.9

III. Alias, Triggers, Macros
----------------------------
The Aliases and Triggers use PCRE (Perl Regular Expression) to activate. They support a Python script usage or the 
MudMagic BASIC command line usage. See respective helpfiles for more details.
More information about Perl Regular Expression
        - http://www.zvon.org/other/PerlTutorial/Output/
More information about Python :
        - http://www.python.org

1. Alias
---------
An alias allows you to replace one text for another. For example:

drink fountain
  can be replaced with:
df

See Help -> Aliases  for more information

2. Triggers
-----------
A Trigger allows your MudMagic client to perform a certain action when text on the screen occurs. Whenever the screen 
triggers your script, either a Python script is run or the MudMagic BASIC command input is executed.

See Help -> Triggers for more information

3. Macros
-----------
Macros are quick keys that replace Key input values with a MudMagic BASIC command input script or a Python Script. 
Macros also support clickable buttons that are created when you create a new Macro.

See Help -> Macros for more information

IV: Modules
-----------------
The client supports modules, which can be enabled at runtime, if necessary. These are statically compiled in.
Settings -> Modules Current modules include a database, notes, recorder and automapper.

1. Database Module
------------------
Basic database that will provide future functionality with your stored information on mudmagic.com website

2. Notes Module
------------------
Store notes on a per-game basis.

3. Recorder Modules
-------------------
A recorder module that allows you to 'START RECORDING' to record all input commands. When you stop recording, the 
commands you input can be saved as a: Trigger, Macro, or Alias

4. Automapper Module
--------------------
Basic automapper that will be improved upon with 1.9 MXP functionality and 2.0 full client review.



V. Scripting
----------------
        1. MudMagic BASIC
	-------------------
MudMagic command input script uses the BASIC routine. That is:
IF ... THEN
    .....
ELSE
    ....
END

Variables are available on demand and can take either a string or numerical value. Numerical variables can be used in 
basic mathematical computations. 

See Help -> Inline Scripting

        2. Python
	----------------------
MudMagic client connects you to full Python scripts. You're alias, trigger, or macro can pass information to and from a 
python script by selecting Python Script and then pointing to the appropriate file. 
	- send a string back to server 
		send("your string here")
	- display a message box.
		messagebox("your string here")
See Help -> Python Scripting

