|
|
 |
|
|
Configuring the Mapper
Because every MUD is different, it is impossible to pre-configure CMUD to automatically start mapping the MUD you play. Before you can start using the mapper, CMUD must learn how your MUD displays rooms as you walk around the MUD. CMUD makes extensive use of the exit information displayed by a MUD. Because of this, make sure you have turned on any option or flag necessary on your MUD to see the exits from a room.
The automapper is intimately tied with the Directions settings used by the speedwalking module. If you are not using the standard DEFAULT.MUD default settings file that is supplied with CMUD, make sure you edit you have Directions defined (View/Directions menu) so that words and commands are tied to the proper map directions. If you don't know what this means, assume you are using the proper default file and continue reading.
You can configure the mapper two different ways: Auto Configure (recommended), Manual Configure (only for those who know what they are doing).
How the AutoMapper works
Before you can configure the mapper, you should understand how the mapper works. The mapper first groups text received from the MUD into paragraphs. Paragraphs are lines of text separated by a blank line or a line that looks like the MUD prompt. A MUD prompt is defined as a line with several punctuation characters, more numbers than letters, or a simple text string surrounded by brackets (configurable).
Once the mapper has grouped lines into paragraphs, each paragraph is searched for exit information. Exit information is defined as lines containing keywords from the Directions settings, and optionally an exit keyword (which defaults to the string "exit"). Once the paragraph and line(s) containing the exit information are found, the mapper uses its configuration information to flag the room name (if present) and room description (if present). Because the mapper starts its search based upon the exit information, getting the exits identified properly is the key to configuring the mapper.
Automatic Configuration
For approximately 95% of the muds out there automatic configuration will work. This includes all Simutronics muds, most ROM/Diku muds, and practically every MXP enabled mud. This is the first step when trying to configure the AutoMapper. For Simutronics muds and MXP enabled muds it is still required to run the Automatic Configuration so mapper knows to expect the MUD to supply tagged information. Even when the mapper successfully configures automatically, you may want to tweak the configuration. Reading the Manual Configuration page will give you an idea of how you can adjust the mappers parsing routines.
Offline Configuration
Instead of configuring the mapper using text captured from the MUD, you can provide your own text or log file by clicking the "Offline Setup" button in the upper-right corner of the mapper configuration wizard window. You can then control what text the wizard sees.
Manual Configuration
You should always try auto configuration first and only resort to manual configuration if absolutely necessary. There are many combinations of parameters for the mapper, and with manual configuration it is easy to set the mapper so that it doesn't work at all. Only advanced users should attempt to configure the mapper manually.
Overriding the Mapper
If part of a room is not distinctly findable by any of these methods you may have to use the techniques described in this page. |
|
Automatic Mapper Configuration