Aardwolf MUD - GMCP Mapper

Clients.GMCPMapper History

Show minor edits - Show changes to markup

December 19, 2010, at 01:40 AM EST by admin
Changed lines 103-132 from:
If you are upgrading a version of Mushclient prior to release 4.57, you will need to remove the Lua Sandbox. 
To do this, select the 'file' menu, then 'global preferences', then 'lua'. Click edit and modify the sandbox 
to just read:

-- empty sandbox.

From Mushclient 4.57 onwards this is the default setting for the Lua sandbox. Although this is the
new default, you should fully understand the possible risks involved before making this change. See 
the Mushclient Security page at http://www.gammon.com.au/forum/?id=10503 for more information.

  1. If you don't already have the Mushclient GMCP handler installed, download and install that first. Note that Mushclient version 4.59 is the lowest level supported.
  2. Download the GMCP Mapper Plugin GMCP mapper package.
  3. Unzip the package using the following layout. Note: Most unzip utilities have the ability to browse to a directory and unzip the file in that directory. Use the main mushclient directory and the files will be in the correct place. If you are prompted to 'merge' directories, accept this for each directory:
    • The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
    • The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
    • The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

  4. Using the 'file menu' then 'plugins', add the 'GMCP_mapper.xml' plugin to your mushclient install. It will appear as "Aardwolf_GMCP_Mapper". Note you have to have the Aardwolf world file open at this point.
  5. Optionally, install the 'helper_aliases.xml' plugin - this is a set of aliases that allow you to reload the plugins after any errors. It is not essential, but strongly recommended as it makes life a lot easier, particularly if you are testing a pre-release version of the plugin. With this plugin enabled, you can 'reload gmcp' to reload the GMCP handler and 'reload mapper' to reload the mapper after any Lua level errors.

  6. The GMCP mapper comes pre-loaded with several of the starting areas plus most of the continents. You need to build the mapper database before this feature is activated. With Mushclient connected to the MUD, enter 'create GMCP database'.
  7. Browse to the 'aardmap.xml' file which is in the 'data' directory, select this file.
  8. The bottom right of the status bar will update as rooms are processed. Once the build is done, type 'reload mapper' to reload the plugin.
  9. Drag the window (click and hold the top of the window) and resize (using the bottom-right corner) as necessary to suit your preferences. You can change the size of each room on the map using 'mapper zoom in' and 'mapper zoom out'.

Note: You should only ever need to do the build database step 1 time. The database filename is the name of the World file (ALT+1 -> World Name), so if you change the world filename your mapper database will be reset.

to:

The GMCP Mapper is now part of the Aardwolf Mushclient download package which can be found at Aardwolf MUD Client Download

The mapper can also be found at the GoogleCode repository for the Aardwolf version of Mushclient which is maintained by Fiendish.

October 05, 2010, at 01:57 AM EST by admin
Changed line 15 from:

to:

Changed line 106 from:

To do this, select the 'file' menu, then 'global preferences', the 'lua'. Click edit and modify the sandbox

to:

To do this, select the 'file' menu, then 'global preferences', then 'lua'. Click edit and modify the sandbox

Changed lines 111-113 from:

Although this is now the default setting for Mushclient, you should fully understand the possible risks involved before making this change. See the Mushclient Security page at http://www.gammon.com.au/forum/?id=10503 for more information.

to:

From Mushclient 4.57 onwards this is the default setting for the Lua sandbox. Although this is the new default, you should fully understand the possible risks involved before making this change. See the Mushclient Security page at http://www.gammon.com.au/forum/?id=10503 for more information.

October 05, 2010, at 01:55 AM EST by admin
Changed line 15 from:

to:

Changed lines 112-113 from:

before making this change. See the Mushclient Security page for more details.

to:

before making this change. See the Mushclient Security page at http://www.gammon.com.au/forum/?id=10503 for more information.

October 05, 2010, at 01:54 AM EST by admin
Changed lines 105-108 from:

Note: If you are upgrading a version of Mushclient prior to release 4.57, you will need to remove the Lua Sandbox. To do this, select the 'file' menu, then 'global preferences', the 'lua'. Click edit and modify the sandbox to just read:

to:

If you are upgrading a version of Mushclient prior to release 4.57, you will need to remove the Lua Sandbox. To do this, select the 'file' menu, then 'global preferences', the 'lua'. Click edit and modify the sandbox to just read:

Changed lines 110-111 from:

Although this is now the default setting for Mushclient, you should fully understand the possible risks involved before making this change. See the [[ http://www.gammon.com.au/forum/?id=10503

 | Mushclient Security page]] for more details.
to:

Although this is now the default setting for Mushclient, you should fully understand the possible risks involved before making this change. See the Mushclient Security page for more details.

October 05, 2010, at 01:53 AM EST by admin
Added lines 104-110:
'''Note:''' If you are upgrading a version of Mushclient prior to release 4.57, you will need to remove the Lua Sandbox. To do this, select the 'file' menu, then 'global preferences', the 'lua'. Click edit and modify the sandbox to just read:
-- empty sandbox.
Although this is now the default setting for Mushclient, you should fully understand the possible risks involved before making this change. See the [[ http://www.gammon.com.au/forum/?id=10503
 | Mushclient Security page]] for more details.
Added line 132:
October 03, 2010, at 07:11 PM EST by admin
Changed line 117 from:
to:
  1. Drag the window (click and hold the top of the window) and resize (using the bottom-right corner) as necessary to suit your preferences. You can change the size of each room on the map using 'mapper zoom in' and 'mapper zoom out'.
October 03, 2010, at 06:42 PM EST by admin
Changed lines 107-110 from:
  1. The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
  2. The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
  3. The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.
to:
  • The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
  • The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
  • The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.
October 03, 2010, at 06:42 PM EST by admin
Changed lines 114-116 from:

The GMCP mapper comes pre-loaded with several of the starting areas plus most of the continents. You need to build the mapper database before this feature is activated:

  1. With Mushclient connected to the MUD, enter 'create GMCP database'.
to:
  1. The GMCP mapper comes pre-loaded with several of the starting areas plus most of the continents. You need to build the mapper database before this feature is activated. With Mushclient connected to the MUD, enter 'create GMCP database'.
October 03, 2010, at 06:40 PM EST by admin
Changed lines 104-114 from:
  • If you don't already have the Mushclient GMCP handler installed, download and install that first. Note that Mushclient version 4.59 is the lowest level supported.
  • Download the GMCP Mapper Plugin GMCP mapper package.
  • Unzip the package using the following layout:
    • The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
    • The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
    • The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

Note: Most unzip utilities have the ability to browse to a directory and unzip the file in that directory. Use the main mushclient directory and the files will be in the correct place. If you are prompted to 'merge' directories, accept this for each directory.

  • Using the 'file menu' then 'plugins', add the 'GMCP_mapper.xml' plugin to your mushclient install. It will appear as "Aardwolf_GMCP_Mapper".
to:
  1. If you don't already have the Mushclient GMCP handler installed, download and install that first. Note that Mushclient version 4.59 is the lowest level supported.
  2. Download the GMCP Mapper Plugin GMCP mapper package.
  3. Unzip the package using the following layout. Note: Most unzip utilities have the ability to browse to a directory and unzip the file in that directory. Use the main mushclient directory and the files will be in the correct place. If you are prompted to 'merge' directories, accept this for each directory:
    1. The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
    2. The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
    3. The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

  4. Using the 'file menu' then 'plugins', add the 'GMCP_mapper.xml' plugin to your mushclient install. It will appear as "Aardwolf_GMCP_Mapper". Note you have to have the Aardwolf world file open at this point.
  5. Optionally, install the 'helper_aliases.xml' plugin - this is a set of aliases that allow you to reload the plugins after any errors. It is not essential, but strongly recommended as it makes life a lot easier, particularly if you are testing a pre-release version of the plugin. With this plugin enabled, you can 'reload gmcp' to reload the GMCP handler and 'reload mapper' to reload the mapper after any Lua level errors.
Changed lines 116-119 from:
  • With Mushclient connected to the MUD, enter 'create GMCP database'.
  • Browse to the 'aardmap.xml' file which is in the 'data' directory, select this file.
  • The bottom right of the status bar will update as rooms are processed. Once the build is done, type 'reload mapper' to reload the plugin.
to:
  1. With Mushclient connected to the MUD, enter 'create GMCP database'.
  2. Browse to the 'aardmap.xml' file which is in the 'data' directory, select this file.
  3. The bottom right of the status bar will update as rooms are processed. Once the build is done, type 'reload mapper' to reload the plugin.
October 03, 2010, at 06:20 PM EST by admin
Added lines 110-112:

Note: Most unzip utilities have the ability to browse to a directory and unzip the file in that directory. Use the main mushclient directory and the files will be in the correct place. If you are prompted to 'merge' directories, accept this for each directory.

October 03, 2010, at 06:13 PM EST by admin
Changed line 105 from:
  • Download the http://www.aardwolf.com/linkhere.zip GMCP mapper package.
to:
  • Download the GMCP Mapper Plugin GMCP mapper package.
October 03, 2010, at 05:51 PM EST by admin
Deleted lines 103-104:

-- Not Publicly Available .. Yet --

Changed lines 110-112 from:

to:
  • Using the 'file menu' then 'plugins', add the 'GMCP_mapper.xml' plugin to your mushclient install. It will appear as "Aardwolf_GMCP_Mapper".

The GMCP mapper comes pre-loaded with several of the starting areas plus most of the continents. You need to build the mapper database before this feature is activated:

  • With Mushclient connected to the MUD, enter 'create GMCP database'.
  • Browse to the 'aardmap.xml' file which is in the 'data' directory, select this file.
  • The bottom right of the status bar will update as rooms are processed. Once the build is done, type 'reload mapper' to reload the plugin.

Note: You should only ever need to do the build database step 1 time. The database filename is the name of the World file (ALT+1 -> World Name), so if you change the world filename your mapper database will be reset.

October 03, 2010, at 05:21 PM EST by admin
Changed lines 109-115 from:
    * The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
    * The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file. 
    * The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

to:
  • The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
  • The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file.
  • The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

October 03, 2010, at 05:19 PM EST by admin
Added lines 106-115:
  • If you don't already have the Mushclient GMCP handler installed, download and install that first. Note that Mushclient version 4.59 is the lowest level supported.
  • Download the http://www.aardwolf.com/linkhere.zip GMCP mapper package.
  • Unzip the package using the following layout:

    * The 'aardmapper.lua' file should go into your lua library directory. This is the 'lua' directory in your main Mushclient directory. For example, if you have Mushclient installed in c:\program files\mushclient then the main lua directory will be c:\program files\mushclient\lua.
    * The 'GMCP_mapper.xml' should go into your main plugins directory, usually under 'worlds' in the main Mushclient directory. It then needs adding to your plugin list. Add the plugin by selecting the 'File' menu, then 'Plugins' then 'Add' and locate the GMCP_handler.xml file. 
    * The 'images' and 'data' directories in the package should go in the plugins directory too - they will be subdirectories of the plugins directory.

September 17, 2010, at 05:12 PM EST by admin
Changed lines 104-105 from:
to:

-- Not Publicly Available .. Yet --

September 17, 2010, at 05:11 PM EST by admin
Added lines 107-108:
  • To be populated as questions are asked and issues are found.
September 17, 2010, at 05:11 PM EST by admin
Changed line 7 from:
to:
September 17, 2010, at 05:10 PM EST by admin
Changed lines 6-7 from:
to:
September 17, 2010, at 05:06 PM EST by admin
Added lines 6-8:
Deleted line 9:
Changed lines 34-35 from:

A screenshot of the basic mapper view is shown to the right:

to:

A screen shot of the basic mapper view is shown to the right:

Changed lines 41-44 from:
to:
  • The diagonal line pointing Southeast in the room 3N of the center indicates a down exit. Up exits are shown as NW pointing lines.
  • One way exits and exits that do not link back to the same room are indicated as half a line. There are several on this map of Verume - they are to the East of the current location.
  • Paths that you have recently traveled are shown in bolder lines. In this example map you can see the rooms to the North have been recently visited because the lines connecting them are thicker.
Changed lines 80-81 from:
to:


Changed line 93 from:

How to download and install

to:

Future Enhancements

Changed lines 95-96 from:

Future Enhancements

to:

The following parts of the mapper are room for future improvement:

  • Dynamic information that is shown on the existing ASCII map such as mobs and other players nearby are not part of this map.
  • The map does not currently have any knowledge of door status (locked, closed, etc).
  • A mechanism is needed to add new areas after the original database has been populated.

How to download and install

Added line 104:
September 17, 2010, at 05:01 PM EST by admin
Added line 67:
Deleted lines 71-73:
Changed lines 73-75 from:
to:


September 17, 2010, at 05:00 PM EST by admin
Changed lines 47-50 from:
to:
Added lines 52-53:
Added line 63:

\\

September 17, 2010, at 05:00 PM EST by admin
Changed line 47 from:
to:
September 17, 2010, at 04:59 PM EST by admin
Added lines 55-56:


September 17, 2010, at 04:58 PM EST by admin
Changed lines 70-71 from:
to:
Changed lines 74-75 from:

Mapper Bookmarks

to:

Mapper Bookmarks

September 17, 2010, at 04:58 PM EST by admin
Added lines 59-60:


September 17, 2010, at 04:56 PM EST by admin
Changed lines 76-78 from:
to:
Changed lines 81-82 from:
to:
September 17, 2010, at 04:55 PM EST by admin
Changed lines 43-44 from:

Mapper Commands

to:

Mapper Commands

September 17, 2010, at 04:55 PM EST by admin
Added lines 40-42:


September 17, 2010, at 04:54 PM EST by admin
Changed lines 73-79 from:
to:

Once you have set a bookmark, you can find it and run back to it:

September 17, 2010, at 04:52 PM EST by admin
Changed lines 40-41 from:

Mapper Commands

to:

Mapper Commands

Added lines 69-73:

Mapper Bookmarks

You also have the ability to bookmark specific rooms and refer back to them later. To bookmark a room, right click over the room on the mapper then select 'Edit Bookmark':

September 17, 2010, at 03:08 PM EST by admin
Changed lines 59-60 from:

Mapper areas: Shows exits to other areas within your search depth.

to:

Mapper areas: Shows exits to other areas within your search depth. \\

Added line 62:

\\

September 17, 2010, at 03:07 PM EST by admin
Changed lines 57-64 from:
to:

Mapper Where <Room Number>: Like mapper goto, but shows directions rather than running there.

Mapper areas: Shows exits to other areas within your search depth. Mapper quest: Shows questors within your search depth area. Mapper shops: Shows shops within your search depth area.

September 17, 2010, at 02:49 PM EST by admin
Added line 44:
Changed lines 46-47 from:
to:
Added lines 56-57:

Mapper Goto <Room Number>: If you know the number of a room you want to go to, and it is within your search depth, you can just 'mapper goto <room>'

September 17, 2010, at 02:47 PM EST by admin
Changed lines 1-2 from:
to:
Changed line 26 from:
to:
\
Changed line 28 from:
\
to:
Deleted lines 43-45:

Changed lines 45-46 from:
to:
September 17, 2010, at 02:46 PM EST by admin
Added lines 27-28:
\
Changed lines 46-47 from:
\
to:
September 17, 2010, at 02:25 PM EST by admin
Added lines 52-56:

Mapper Find <Location>: Find a specific location. Returns a list of links that can be clicked to go directly to that room. The default depth that can be searched is up to 50 rooms away. You can change this by clicking the '*' in the bottom right of the window. Note that the more you increase the depth, the slower the performance will be. Using mapper find tabaxi from Aylor recall with depth set to 100 gives the output below. Each of those links can be clicked to run directly to that room:

September 17, 2010, at 02:18 PM EST by admin
Changed lines 38-39 from:

[[#commands] Mapper Commands

to:

Mapper Commands

Changed lines 45-46 from:
to:
September 17, 2010, at 02:13 PM EST by admin
Added line 49:

\\

September 17, 2010, at 02:12 PM EST by admin
Changed lines 43-44 from:
to:
\
September 17, 2010, at 01:44 PM EST by admin
Changed lines 40-48 from:
to:

The mapper plugin includes a number of commands to help you display the map differently and search for various rooms:

Mapper Zoom In: Zoom in the map Mapper Zoom Out: Zoom out on the map

September 17, 2010, at 01:17 PM EST by admin
Added lines 25-29:

Deleted lines 40-43:
September 17, 2010, at 01:16 PM EST by admin
Changed lines 21-22 from:

The GMCP mapper was written by Nick Gammon, the author of http://www.mushclient.com and modified to work with GMCP by Lasher.

to:

The GMCP mapper was written by Nick Gammon, the author of Mushclient and modified to work with GMCP by Lasher.

Added lines 25-35:

A screenshot of the basic mapper view is shown to the right:

  • Each square on the mapper is a single room within Aardwolf.
  • The room with the dotted line 3 rooms north of center has not yet been visited.
  • The pink square highlighted in the center is your current location.
  • You can hover over any room to get the room name and where it leads to.
  • You can click on any room to run to it.

[[#commands] Mapper Commands

September 17, 2010, at 01:13 PM EST by admin
Added line 25:
Added lines 27-28:
September 17, 2010, at 01:11 PM EST by admin
Changed lines 25-26 from:
to:
September 17, 2010, at 01:11 PM EST by admin
Changed lines 25-26 from:
to:
September 17, 2010, at 01:06 PM EST by admin
Added lines 21-22:

The GMCP mapper was written by Nick Gammon, the author of http://www.mushclient.com and modified to work with GMCP by Lasher.

Added lines 24-25:
September 17, 2010, at 11:44 AM EST by admin
September 17, 2010, at 11:43 AM EST by admin
Changed line 3 from:
to:
Added line 23:
Added line 26:
Added line 29:
Deleted lines 31-49:

GMCP in CMUD


Cmud support for GMCP is available in Cmud 3.22 beta and higher.

For full details on GMCP in Aardwolf using CMUD, see the CMUD GMCP page.

GMCP in Mudlet


At the time of writing GMCP in Mudlet is only supported via a source version of the client which users have to compile for themselves so is not covered. If this is no longer true, please contact us (or just update the page, it's a wiki after all :) )

While not specifically related to GMCP, anyone using Mudlet on Aardwolf should consider the excellent Mudlet Aardwolf GUI package put together by Zaxes.


GMCP is used to exchange data between the MUD client and Aardwolf server "out of band". Out of band means that the exchange of data takes place behind the scenes rather than via standard game output that is captured by triggers in the client. The benefits of this include a less cluttered screen, fewer triggers to handle and the ability for the MUD and client to exchange data regardless of your status in the game. For example, with regular triggers you may not receive MUD output while in note mode or inside the output pager. With GMCP the data will be received and parsed by the client as long as you are actively connected to the game.

Another advantage with GMCP is lower overhead and bandwidth usage. If you are using the Aardwolf {statmon} tags then all your stats are sent along with each prompt. With GMCP, data is only sent when a value in a module you are subscribed to actually changes.\\\

September 17, 2010, at 11:43 AM EST by admin
Added lines 1-47: