Quow's Minimap Plugin, for Mushclient
=====================================
You must extract the entire zip somewhere for Mushclient to open it.  This could be a Discworld folder on your computer, or the Mushclient folder itself.

The entire "maps" folder must be in the same location as the main plugin .xml file.  The plugin will look for the /maps/ folder wherever it is running from.  This does NOT mean that you should move the plugin INTO the maps folder, leave the file and folder structure as it is found when extracting!  The .xml file should be sat next to the /maps/ folder, for example the directory structure after extracting might look something like this:

C:\Discworld\QuowsMinimap.xml
C:\Discworld\maps\_quowmap_database.db
C:\Discworld\maps\*.png  [60 files]
C:\Discworld\maps\*.wav  [5 files]

NOTE:  If you are installing over an old version of the plugin, be sure to choose "Yes" if asked if you wish to replace files - there may be updated map graphics or database files.


Add Plugin to Mushclient:
=========================
Now in Mushclient, with the Discworld world/connection loaded in Mushclient, go to the File->Plugins menu, click "Add", locate the QuowMinimap.xml plugin file, and Open it.

Optionally repeat this again for "QuowMDT.xml", if you have downloaded the MDT plugin and wish to use my parser plugin for the live written-map window of the Cow bar.

You should see lots of new miniwindows appear - you can drag these window around by left-click-dragging the titlebars/windows, and access many layout and configuration options and features by right clicking on these windows and going through the options carefully.

IMPORTANT NOTE:  The minimap MUST be installed upon initial connection to the MUD - this is because it tells Discworld to send map data in the background.
If you are already connected to the MUD, you must disconnect, and reconnect (you do not need to "quit" or log out first, just disconnect, reconnect, and log back in).

Now go to any room recognised by the minimap (for example outside the Drum in Ankh-Morpork!), and the map should snap to your location and start following you around.

Note that it will not recognise your location in the terrains, or inside of player houses, or any secret/far away locations not found on any of the graphical maps - these have not been mapped!


Disconnect and Reconnect:
=========================
After installing or updating the plugin, you should always disconnect and reconnect to the Discworld MUD.  This will let the plugin ask the Discworld MUD to send it the information it needs to keep everything running smoothly!


Usage:
======
Type "help minimap" into the mushclient window once the plugin is installed, for some essential usage instructions.  Be sure to read these commands and features out, and experiment!

Left click on a room on the minimap to select it, and then you can right click on the minimap to Bookmark, Show Information on, or Speedwalk to the room you have selected.

Right click on any of the miniwindows for a large amount of options, usually specifically relevant to that window.

You can "Lock" any miniwindow into place (so you cannot accidentally move or resize it), however any window that is NOT locked can be moved and resizes.  To move, simply left click and drag the window around.  To resize, move your mouse to any edge (EXCEPT the top edge) of a miniwindow, so the mouse cursor changes, and then drag it out to size.  You can grab the two bottom corners, or the left, right, and bottom sides, individually.

You can configure "Margins" that Discworld MUD output will not be sent to, to position your windows on out of the way, in any of the right click menus.  You can have any or all of Left, Right, Top, and Bottom margins.  These margin zones can be resized by unticking "Lock Screen Margins" in the Screen Margins submenus, and then dragging the white lines representing the margins to any size you wish.  Be sure to re-lock the margins when done!


Problems:
=========
If you get fatal errors on trying to install the plugin, then firstly ensure you are NOT using Mushclient 4.99 (anything from 4.84 to 5.03 and above, anything EXCEPT 4.99 which has fatal bugs within it).  Secondly, ensure your /maps/ folder is located in the same place as the main plugin file, and make sure the folder contains the _quowmap_database.db file, and the 53 .PNG graphics.

If the plugin runs without errors, but no map is visible, even if you right-click on the minimap window and select a map in the "Switch to map" options, then the plugin may be unable to find the map graphics, or you may have forgotten to disconnect and reconnect to the MUD after installing the plugin.  Go back and check your /maps/ folder location, and ensure it contains all 53+ of the map images, and try to disconnect and reconnect with the plugin installed.

If maps do display, but the plugin does not track your position as you move and you are definitely in a supported area (almost anywhere EXCEPT inside player houses or within terrains), then Discworld is not sending the GMCP data to Mushclient - simply Disconnect, and Reconnect, to the mud while the plugin is installed.


Enjoy!
======
I hope you enjoy, and I would welcome any feedback on the Discworld boards, or if you feel too shy to post publicly, you can MUD-Mail me!

- Quow.