MUSHClient Sample Configuration

## Installing MUSHClient

* Download and install MUSHClient: MUSHClient
	+ Here are instructions specific to installing MUSHClient on Windows 7: Windows 7 Instructions
	+ MUSHClient is typically Windows only. If you use Mac or Linux, it is possible to run MUSHClient using Wine, a piece of software that allows Windows applications to run on Unix-based platforms. See the MUSHClient WINE Forums for details.
* Remember the folder location in which you install MUSHClient. You will need to place the configuration files in this directory.

## Setting Up The Configuration

* Download the sample configuration here: File:MUSHClient.Cosrin.Config.1.0.zip
* Unzip the configuration into the **MUSHClient\worlds\** folder where you installed MUSHClient.

### Loading the World File

1. Start MUSHClient.
2. Go to **File > Open World...**
3. Find and open the file:
	1. **MUSHclient\worlds\Cosrin A New Dawn.MCL**

### Configuring MUSHClient

1. Go to **Game > Configuration > Scripting...**
	1. Click the "Browse..." button below "Script File:". Find and open the file:
		1. **MUSHclient\worlds\Cosrin\_A\_New\_Dawn\_Functions.lua**.
2. Click **OK**.
3. Go to **File > Plugins...**
	1. Click "Add..."
	2. Find and add/open these 3 files:
		1. **MUSHclient\worlds\Chat\_Capture\_Miniwindow.xml**
		2. **MUSHclient\worlds\Experience\_Bar.xml**
		3. **MUSHclient\worlds\Health\_Bar\_Miniwindow.xml**
	3. Click **Close**.
4. Go to **File > Global Preferences...**.
	1. Click the **General** tab.
	2. Check the box next to "F1, F6 are macros".

### Use ANSI Extended

1. Log in to the game. If you are not connected, go to **Connection > Connect**.
2. After login, a trigger should have enabled ANSI extended mode. If it did not do this, type **ANSI EXTENDED** in game.
3. Log out and close MUSHClient.
4. Restart MUSHClient and reconnect to Cosrin:
	1. Go to **File > Open World...**
	2. Find and open the file:
		1. **MUSHclient\worlds\Cosrin A New Dawn.MCL**
5. Log in to Cosrin again.

## Configuration Comments

### General Comments

* You need to re-login after enabling ANSI EXTENDED mode to grab new ansi-extended metadata that the game sends immediately after login.
* The bar along the bottom is your experience bar.
* Right click in the "COMMUNICATION" window for options. Chats, shouts, tells, guild shouts, and other communication messages go here.
* The HP/SP bar may not appear until you enter combat or gain/lose HP/SP.

### Configuration Features

* F2 is a sample self-coloring macro. (it uses the "cast\_colors" alias)
* F3 is a sample eat\_vitality\_paste macro. (it uses the "eat\_vitality\_paste" alias)
* F4 is a sample eat\_spirit\_paste macro. (it uses the "eat\_spirit\_paste" alias)
* F5 is a ring-out macro.
* F9 enables automated hunting. F10 disables automated hunting. No more holding down keys!
	+ Automated hunting sends the command defined in the "hunting\_macro" variable (see **Game -> Configuration -> Variables...**) at a rate of once per second.
	+ You should change the "hunting\_macro" variable to suit your hunting area and style.
	+ For more information, look at the "macro\_hunt" timer (see **Game -> Configuration -> Timers...**) -- **this is where you would do intelligent decision processing**.

### MUSHClient Features

* Most options you'll want to configure are under the **Game > Configuration** menu.
* Macros: Note that macros in MUSHClient can only send text to the mud. If you want intelligent macros (i.e.: with wait times, prompts, or other dynamic features), you should set up an alias first, and then have the macro execute that alias.
* Timers: Timers should be a new concept to the regular Cosrin player. Timers allow for things to be executed at periodic intervals. For example, you could send 'qwf' to the game every 30 minutes to periodically check who is online.

### MUSHClient Documentation

* To learn how to script, highly recommend you read this article about scripting in MUSHClient: MUSHClient Tips and Tricks Introduction to Scripting
* Here is a list of functions you can use in MUSHClient Scripts: MUSHClient Function List