[Home] [Downloads] [Search] [Help/forum]

Gammon Forum

See www.mushclient.com/spam for dealing with forum spam. Please read the MUSHclient FAQ!

[Folder]  Entire forum
-> [Folder]  MUSHclient
. -> [Folder]  Tips and tricks
. . -> [Subject]  Aardwolf Mapper Tutorial (by Lunk) 1/2
Home  |  Users  |  Search  |  FAQ
Register forum user name
Forgotten password?

Aardwolf Mapper Tutorial (by Lunk) 1/2

It is now over 60 days since the last post. This thread is closed.     [Refresh] Refresh page

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Wed 08 Jul 2015 04:06 AM (UTC)

Amended on Thu 09 Jul 2015 07:31 PM (UTC) by Lua_Newbie

Lunk's Aardwolf Mapper Tutorial

important note - for me I need to use a double semi-colon to separate my mapper entry's, not sure why but it may be the case that you only need one semi colon.

The Mapper in Aardwolf's MUSH client package is a very powerful and helpful resource for finding quest mobs, campaign mobs and even gq mobs.
If you don't already have the latest aardwolf version of MUSH client you can get it here : http://github.com/fiendish/aardwolfclientpackage click the "Download ZIP"
button in the bottom right corner of the web page.

Once you have MUSH client running and connected to aardwolf it's time to take a look at the mapper.
The first thing you want to type just to get an idea of what the mapper is capable of is to enter "mapper help".
You will notice several categories.

In this tutorial I am going to cover the basic functionality of the mapper as well as :

-mapper exits
-removing mapper exits
-the wait command
-mapper moving
-mapper searching
-mapper portals

basic functionality :

the mapper is essentially a database of areas, room titles, and cexits along with lots of helpful commands that can be found reasonably quickly using the mapper help command.
the mapper can move you around the mud very quickly, especially with aliases set up for the various mapper commands.
clickable rooms (listed alphabetically) for a customised runto (with cexits/portals)


1. mapper exits

Firstly what is a mapper exit? it is a "custom exit" or "cexit" that is programmable into MUSHclient that will aid with auto movement.
How do I make a mapper exit? like this - "mapper cexit open e;;e;;close w" this will open a door to the east, move east then close the door again (which is to the west after moving)
You may be thinking what use is this? It will become clear as you read on through this tutorial.

2. removing mapper exits

To remove a custom exit (mapper exit) from the mapper database. For example if I wanted to clear the custom exit I just made because it didn't quite work how I wanted it to I would
use this - "mapper delete cexits" - this would clear all cexits for the room I am in when I type it.

To remove an entire area's custom exits (which can be useful for some areas with big mazes that rotate) I would use this - "mapper purgezone *" swapping the asterisk (*) for the area
for example : "mapper purgezone nenukon" would clear the mapper exits in the area Nenukon.

3. the wait command

The wait command can be very handy for rooms that require some waiting before moving again, a good example of this is in the sandcastle area getting to the lamp section.

we use "wait(*)" as the wait command e.g in kobaloi you may want the cexit to wait before moving up (once you have purchased the pass) into the main section so we would use this: mapper cexit u;;wait(2)

It's worth noting that the minimum wait is 2 seconds. If you want a longer wait you can swap out the 2 for however long you need.

4. mapper moving

It's now time to put a cexit to the test using the mapper goto command. First I will assume you have a cexit in an area with no aggro mobs, a good place to try this out is beer goblins.

first find a closed door and make the cexit as described in part 1. of this tutorial. Make a note of the room you end up in after you have made the cexit.
next test it - make sure the door for the custom exit is closed and you are at the start of the area, next use the mapper area command to find the room you want to move to like this -
"mapper area *" again, replacing the asterisk for a word in the room title, for example - "mapper area home" or whichever room you made a note of and finally click on the blue writing of the room...

And like magic - you move to the room using the cexit you programmed into the mapper :)

- Lunk (of Aardwolf)
[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #1 on Wed 08 Jul 2015 04:07 AM (UTC)

Amended on Fri 10 Jul 2015 09:15 PM (UTC) by Lua_Newbie

5. mapper searching

To search for a room whilst you are in the area of the room you want to search for you would use "mapper area *" again, where the asterisk (or *) is part of the room you want to search for.
This works for one word or multiple words with spaces in-between for example - "mapper area home" would list all rooms in the current area that contained "home" in the room title,
"mapper area a cozy home" would list any rooms that contained ALL the text "a cozy home"

To search the entire mapper database for a room we do not know the area of, we use mapper find like this "mapper find *" or e.g "mapper find home"
Again the rooms in the database that contain the word "home" will be displayed in blue writing in a organised alphabetical list along with the area that contains them. And yes, they are clickable
(with the mouse).

6. mapper portals

Last but by no means least, mapper portals, this is what will really shave seconds and even minutes from your cp/gq times (once you have a good set of portals)

The best way to program the mapper to use portals is to use MUSHclient alias' and a variable for held item/duel wielded weapon.

What is an alias?
An alias is a keyboard short-cut to perform a set of pre-programmed actions.
for example I could make an alias "mpo1 *" with the send set to this:

Send :

hold %1
hold @mportal_item
put %1 @portal_bag

What does this do? firstly the * in the actual alias (short-cut) itself is called a wild-card which means it can be anything
then we can use it in the send with %1 as it is the first and only wild-card in the alias (short-cut).

If you wanted to use more than one wild-card you would still use an asterisk * and use it in the set of instructions (send) as whichever
position it is in e.g for the 3rd wild-card we would use %3 in the send.

Secondly the @mportal_item and @portal_bag are both variables which we would need to set up in the variables table of
MUSHclient as explained below (How do I make a variable?)
So if we had this alias setup with variables below and then we enter this - "mpo1 honeycomb" - we should then see the set of instructions we made entered as if we just typed them
and hit enter:

hold honeycomb
hold tanelorn
put honeycomb luggage

What is a variable?

A variable is a container for a piece of information that varies with time. (eg - a different portal bag or a different dual wielded weapon or a different held item)

How do I make a variable?

To open the variables part of MUSH client we want to hold ALT and press Enter on the keyboard,
this should bring up the world configuration window.
On the left hand side at the bottom you should see "Variables"..
click on it and then click "add"
then in the name field you can call your variable whatever you like
I would advise something suitable like: mportal_item
once you have done that you need to give the variable a value which is the information that the variable will hold
which for me would be: tanelorn, but for you would be whatever you dual wield or hold in your off-hand.

The other variable we want to set up is: portal_bag.
So as we did with the portal item we go to the world config with ALT + Enter,
click Variables
on the left and at the bottom, click add and name it: portal_bag or whatever you want to call the variable
give it the value of whichever bag you want to use as your portal bag which for me would be: luggage

What good will the above do?

It will mean that if and when you decide you want an aardbag for all your portals you can just change the value of the portalbag variable in the variables table to your new
aard bag instead of re-programming every single mapper portal with a different bag.
And again after, if you decide to restring your bag to Portals with portals also as a item keyword actually stored on the aardwolf server as part of the item. (read help restring in aardwolf)
It's the same theory with held/dual wielded items and the mportal_item variable.

The other alias we want to setup to actually program the portal into the mapper databse is this :
Alias : mpo2 *
Send :
mapper portal hold %1;;enter;;hold @mportal_item;;put %1 @portal_bag
Now with the 2 aliases setup as explained above we could do something like :
mpo1 honeycomb - this will take us to the entrance of war of the wizards (through the honeycomb portal)
mpo2 honeycomb - enter the honeycomb portal into the mapper portals database for later use + fast transport
you will also need to enter the level of the portal after using the second alias.

Golden chaos portals can be used during campaigns and gquests
It's best to either restring those or copy and paste the item id number as you use the aliases you made as above, the same applies if you have 2 portals with similar names.

Enjoy !
And remember - if you get stuck there is always the tech channel, I will try my best to answer any questions if I am logged in.

Useful Mapper Commands :

cexit *;;*;;* - programs a cexit into the mapper
wait(*) - adds a wait command into the cexit
mapper thisroom - displays cexits in the current room
mapper area * - displays rooms in area that contain *
mapper find * - displays rooms in entire MUD that contain * as well as the area that contains them
mapper purgezone * - removes an entire area's cexits from the mapper database
mapper delete cexits - removes cexits from current room
mapper portal * - enters a portal into the database with the level of the portal *** NOTE : YOU DO NOT NEED TO RE-PROGRAM ALL YOUR PORTALS WHEN YOU TIER, THE MAPPER WILL HANDLE TIER ADJUSTMENT ***
mapper goto * - use the room ID for example 32418 for recall

- Lunk (of Aardwolf)
[Go to top] top

Posted by Nick Gammon   Australia  (21,609 posts)  [Biography] bio   Forum Administrator
Date Reply #2 on Wed 08 Jul 2015 05:36 AM (UTC)

important note - for me I need to use a double semi-colon to separate my mapper entry's, not sure why but it may be the case that you only need one semi colon.

You probably have ";" configured as your "command stacking character". Therefore to have the ";" make its way to the mapper you have to double it. This will not apply to people who have disabled command stacking, or use a different stack character.

- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #3 on Wed 08 Jul 2015 08:23 AM (UTC)

Amended on Wed 08 Jul 2015 08:29 AM (UTC) by Lua_Newbie

Ahh thanks for that Mr.Gammon :)

And for anyone who is wondering the best use for the mapper - it's to combine it with the hunt trick (whilst in aardwolf try "help hunt trick") which can be made even faster with the fasthunt wish (yes it is expensive but worth it if you cp a lot), another thing that is definitely worth checking out is winkle winkle's search and destroy triple pack found here : https://code.google.com/p/aardwolf-scriptalicious
It uses the mapper to xrt (x runto) in the quickest path possible using portals and anything else in the mapper database that you have programmed as shown in the tutorial above. The updated Mapper_Extender plugin can be found here :) -


And remember - be sure you know what IS and what ISN'T allowed (maybe check "help botting" ?) I will NOT be held responsible for anyone caught botting due to further modification of the s&d triple pack/addition of triggers.

Happy qp'ing :)

- Lunk (of Aardwolf)
[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #4 on Thu 09 Jul 2015 07:42 PM (UTC)
I updated the mapper portals in part 2/2 of the tutorial with a couple of aliases and variables plus explanations as it was suggested to me by a few people in the MUD.

- Lunk (of Aardwolf)
[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #5 on Thu 09 Jul 2015 09:56 PM (UTC)

Amended on Thu 09 Jul 2015 10:51 PM (UTC) by Lua_Newbie

IMPORTANT NOTE : the second alias needs "send to :execute" in the drop down menu of the alias window in the world config. (ALT + ENTER) to create the mapper portal

IMPORTANT NOTE 2 : both of the aliases need to have expand variables ticked on the right (by clicking) otherwise the variables in the variables table will be ignored and the MUD will try to use "@portal_bag" instead of the contents of the portal_bag variable in the variables table.

sorry for the confusion.

- Lunk (of Aardwolf)
[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #6 on Fri 10 Jul 2015 09:18 PM (UTC)
All the information in this thread has been condensed and re-written in a new thread found here : http://www.gammon.com.au/forum/?id=12930
or just click the turorial thread 2/2

- Lunk (of Aardwolf)
[Go to top] top

Posted by Fiendish   USA  (1,747 posts)  [Biography] bio   Global Moderator
Date Reply #7 on Fri 16 Oct 2015 10:11 AM (UTC)
I've pointed out an error in the tutorial on the other thread.

[Go to top] top

Posted by Lua_Newbie   (25 posts)  [Biography] bio
Date Reply #8 on Sun 25 Oct 2015 05:12 AM (UTC)
Fixed the error (with your help.. Fiendish :-) )

- Lunk (of Aardwolf)
[Go to top] top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.


It is now over 60 days since the last post. This thread is closed.     [Refresh] Refresh page

Go to topic:           Search the forum

[Go to top] top

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]