Manual:Mapper - Revision history

Dt192 at 08:45, 16 February 2026

2026-02-16T08:45:46Z

Zooka: /* Working with the mapper API */

2025-12-11T23:47:29Z

Working with the mapper API

Zooka: /* Map labels */

2025-07-18T05:19:27Z

Map labels

Pkcnj: /* Map formats */

2024-10-25T23:26:45Z

Map formats

Pkcnj: /* Mapper */

2024-10-25T22:42:19Z

Mapper

Zooka: /* Map Legend */

2024-07-17T05:56:14Z

Map Legend

Zooka: /* Map Legend */

2024-07-17T04:29:05Z

Map Legend

Slysven: /* Map Legend */ - revised to more closely match reality

2024-07-16T20:03:17Z

Map Legend: - revised to more closely match reality

Zooka: /* Map Legend */

2024-07-16T11:19:23Z

Map Legend

Zooka: /* Map Legend */

2024-07-16T10:59:19Z

Map Legend

@@ Line 336: / Line 336: @@
 <syntaxhighlight lang="lua">
-lua local stubs = getExitStubs(6)
+local stubs = getExitStubs(6)
 for i = 0, #stubs do print(exitmap[stubs[i]]) end
 </syntaxhighlight>

@@ Line 289: / Line 289: @@
 Whenever working with mapper API, keep in mind of the following things:
-* You'll want to call centerview after you do some modifications, to get to have the map render your new changes
+* You'll want to call <code>updateMap()</code> after you do some modifications, to get to have the map render your new changes
 === Translating directions ===

@@ Line 90: / Line 90: @@
 == Advanced map features ==
 === Map labels ===
-Maps can be embellished with images and text labels. Map labels can be either used as background (default) or as the top most foreground e. g. for player name location scripts. Labels are defined by position and size according to the map coordinate system and keep their position and size relative to the rest of the map when the map is zoomed or moved.
+Maps can be embellished with images and text labels. To create one within the mapper window, ensure you are in map editing mode and mouse right-click will have a 'Create label...' entry.  Map labels can be either used as background (default) or as the top most foreground e. g. for player name location scripts. Labels are defined by position and size according to the map coordinate system and keep their position and size relative to the rest of the map when the map is zoomed or moved.
 Contrary to rooms which work on the basis of integer (natural numbers) coordinates, labels are described (with respect to both position & size) by real numbers in order to allow for more advanced placement and label sizes within the map coordinate system. Map labels are stored in form of png images directly in the map file and are thus a direct part of the map. As these images are being scaled to fit the label creation size, the image quality will depend on the initial size of the label (the large the better the quality, but the more memory will be used).

@@ Line 111: / Line 111: @@
 Whenever a mapping feature is added to Mudlet that requires storing something in the map, the map format version needs to be increased - so older Mudlets can know that a map is too new and they can't load it. To this end, every map has a version number embedded inside it, which you can see by going to mapper settings:
-[[File:Map formats setting.png]]
+[[File:Mapper-format-settings2.png|alt=Mapper format settings]]
 You'll also notice that you have the ability to downgrade a map's version for compatibility with older Mudlets. Be careful when you do so though - features available in the new map won't be available in the older map when you downgrade.

@@ Line 52: / Line 52: @@
 Regular mode:
-[[File:Mapper-regular-mode.png|frameless|716x716px]]
+[[File:Mapper-regular-mode1.png|alt=Regular mode mapper|frameless|716x716px]]
 Grid mode:
-[[File:Mapper-grid-mode.png|frameless|713x713px]]
+[[File:Mapper-grid-mode1.PNG|alt=Grid mode version of Mapper|frameless|714x714px]]
 === Areas ===
 Areas are defined by a unique integer number ID and a unique area name. Mudlet builds an internal numerical area ID table on the basis of the rooms that belong to the respective areas. Mudlet keeps a seperate lookup table to retrieve the area name on the basis of the area IDs. This name lookup table is not guaranteed to be correct because it may be imported invalid information if the map has been downloaded by the game server as an xml map description file on the basis of the MMP protocol. <ref>MMP allows for an area ID/area names table to be defined, but Mudlet has no means to verify which definition is the correct one if 2 different area names relate to the same area ID.</ref> However, if the map has been created with Mudlet directly, there will be no such problems as the area name lookup table API is made to enforce uniqueness.
@@ Line 88: / Line 93: @@
 Contrary to rooms which work on the basis of integer (natural numbers) coordinates, labels are described (with respect to both position & size) by real numbers in order to allow for more advanced placement and label sizes within the map coordinate system. Map labels are stored in form of png images directly in the map file and are thus a direct part of the map. As these images are being scaled to fit the label creation size, the image quality will depend on the initial size of the label (the large the better the quality, but the more memory will be used).
-[[File:MapTextLabelDemo.PNG|250px|frameless|misc label types]]
+[[File:Mapper-label1.PNG|alt=Mapper labels example #1|frameless|440x440px|misc label types]]
-[[File:MalLabelsScaled.PNG|250px|frameless|zoomed]]
+[[File:Mapper-label2a.PNG|alt=Mapper labels example #2|frameless|447x447px|zoomed]]
-[[File:MapBackgroundImageLabel.PNG|250px|frameless|label as background image]]
+[[File:Mapper-label-background1.PNG|alt=Mapper labels example #3|frameless|393x393px|label as background image]]
 (The desert and dragon images used in this example are licensed under the Creative Commons Attribution 2.0 Generic license and can be found here: http://en.wikipedia.org/wiki/File:Ninedragonwallpic1.jpg and http://en.wikipedia.org/wiki/File:Siwa_sand_dunes2009a.jpg)
@@ Line 97: / Line 102: @@
 The mapper supports user defined visual exit lines on the basis of a sequence of line points in the map coordinate system. Custom lines as well as labels work on real numbers to allow for fine grained placement. User defined lines can be solid, dotted, dashed etc. line types with or without ending arrows. The line color can be freely selected. By default the regular exit color is being used.
-[[File:CustomExitSelection.PNG|400px|frameless|custom exit line demo]] [[File:DifficultGeography.PNG|500px|frameless|custom exit line demo]]
+[[File:Mapper-custom-exit1a.PNG|alt=Mapper custom exits example #1|frameless|400x400px|custom exit line demo]] [[File:Mapper-custom-exit2a.PNG|alt=Mapper custom exits example #2|frameless|464x464px|custom exit line demo]]
 The above example shows 3 different types of user defined exit lines, where the orange one on the left has been selected by the user in order to be edited.
@@ Line 447: / Line 452: @@
 Just a few example maps from different players and games:
 <gallery>
-File:Mapper 562.png
+File:Mapper-example1a.PNG|alt=Mapper example #1
-File:Mudlet 563.png
+File:Mapper-example2a.PNG|alt=Mapper example #2
 File:TK6fS.png
 File:Stary kontynent-min-scaled.png|Here is the [https://i.imgur.com/IaV6lDc.png full image] (17160 x 10120 pixel)

@@ Line 422: / Line 422: @@
 |-
 | [[File:Out exits.png|thumb]] || out stub exit: no door, door open, door closed, door locked
 |-
 | [[File:Room-id.png|thumb]] || room identifiers (built in numbering)

@@ Line 391: / Line 391: @@
 | [[File:1-single room square.png|thumb]] || a room, square mode
 |-
-| [[File:1-single room square-player-location.png|thumb]] || a room, square mode with player location (default marking)
+| [[File:Player-marker-original.png|thumb]] || a room, square mode with player location (default marker)
 |-
 | [[File:1-single room square-selected.png|thumb]] || a selected room
@@ Line 416: / Line 422: @@
 |-
 | [[File:Out exits.png|thumb]] || out stub exit: no door, door open, door closed, door locked
 |}

@@ Line 391: / Line 391: @@
 | [[File:1-single room square.png|thumb]] || a room, square mode
 |-
-| [[File:1-single room square-player-location.png|thumb]] || a room, square mode with player location
+| [[File:1-single room square-player-location.png|thumb]] || a room, square mode with player location (default marking)
 |-
 | [[File:1-single room square-selected.png|thumb]] || a selected room
@@ Line 403: / Line 403: @@
 | [[File:10-one-way link leading east.png|thumb]] || one way link
 |-
-| [[File:Single-door.png|thumb]] || single open door leading east
+| [[File:Single-door.png|thumb]] || single open door leading east, no door in other direction (unlikely in practice unless a one-way exit)
 |-
 | [[File:Single-door-two-way.png|thumb]] || two way open door
 |-
-| [[File:Two way door, east closed, west locked.png|thumb]] || two doors, orange is closed, red is locked
+| [[File:Two way door, east closed, west locked.png|thumb]] || two way door, closed in easterly direction and locked going west (orange is closed, red is locked)
 |-
-| [[File:Up exits.png|thumb]] || up exits; no door, door open, door closed, door locked
+| [[File:Up exits.png|thumb]] || up stub exit; no door, door open, door closed, door locked - in this, and the next three, actual exits have a finer mesh fill
 |-
-| [[File:Down exits.png|thumb]] || down exits: no door, door open, door closed, door locked
+| [[File:Down exits.png|thumb]] || down stub exit: no door, door open, door closed, door locked
 |-
-| [[File:In exits.png|thumb]] || in exits: no door, door open, door closed, door locked
+| [[File:In exits.png|thumb]] || in stub exit: no door, door open, door closed, door locked
 |-
-| [[File:Out exits.png|thumb]] || out exits: no door, door open, door closed, door locked
+| [[File:Out exits.png|thumb]] || out stub exit: no door, door open, door closed, door locked
 |}

@@ Line 389: / Line 389: @@
 ! Symbol !! Explanation
 |-
+| [[File:1-single room square.png|thumb]] || a room, square mode
 |-
-| Example || Example
+| [[File:1-single room square-player-location.png|thumb]] || a room, square mode with player location
 |-
-| Example || Example
+| [[File:1-single room square-selected.png|thumb]] || a selected room
 |-
-| Example || Example
+| [[File:2-single room round.png|thumb]] || a room, round mode
 |-
-| Example || Example
+| [[File:3-single room two exits.png|thumb]] || exits stubs, to lead south and east
 |-
-| Example || Example
+| [[File:5-two-way link between two rooms.png|thumb]] || two way link
 |-
-| Example || Example
+| [[File:10-one-way link leading east.png|thumb]] || one way link
 |-
-| Example || Example
+| [[File:Single-door.png|thumb]] || single open door leading east
 |-
-| Example || Example
+| [[File:Single-door-two-way.png|thumb]] || two way open door
 |-
-| Example || Example
+| [[File:Two way door, east closed, west locked.png|thumb]] || two doors, orange is closed, red is locked
 |-
-| Example || Example
+| [[File:Up exits.png|thumb]] || up exits; no door, door open, door closed, door locked
 |-
-| Example || Example
+| [[File:Down exits.png|thumb]] || down exits: no door, door open, door closed, door locked
 |}

@@ Line 384: / Line 384: @@
 == Map Legend ==
+{| class="wikitable"
+|+ Caption map symbols
 == Screenshots ==