Help:Editing/Advanced maps

From the RuneScape Wiki, the wiki for all things RuneScape
Jump to: navigation, search

Advanced maps are the maps used to how all the features of a given map area, most commonly a dungeon. Previously these were images using predefined markers, with an image map (linking to various pages) layed overtop. These can now generally be handled using interactive maps and the {{Advanced map}} template has been created for this purpose, and this guide describes how to use this template to create these maps.

Advanced maps should generally be created in the Map: namespace and added to pages via transclusion: {{Map:Map page name}} (for a map on the page Map:Map page name). For more information on adding these maps to the relevant pages pleases see transcluding maps below.

Note that the old method guide is still available at Help:Editing/Advanced maps/historical.

Map selection (mapID)[edit source]

The first task is determining which map id to use when creating the map. Most multi-tiered dungeons have several possible mapIDs associated with them, in general the mapID which contains all levels of the map should be used. This makes it possible to add things such as connecting ladders, portals etc between levels. A complete list of current mapIDs (as well as links to the map on the dev site) are available at RuneScape:Map/mapIDs, and can easily be searched using Ctrl+F.

Basic parameters[edit source]

  • title - A title for the map (may be or contain a link), this should also match the map page and describe what the map is. This is most often the dungeon (or similar) name.
  • name - The page name for the map, assuming it is in the map namespace (without the Map: prefix).
  • mapID - The id of the map to display.
  • mapVersion - Use a different mapVersion from the current one, generally for historic maps or holiday/event maps.
  • showicons - Generate map tiles with background icons. Advanced maps default to tiles without icons.
  • plane - The plane (level) of the map to display, not required if the plane is 0 (ground floor).


The map center and the map size should be chosen so that the map displays the entire region the map describes

  • center - The center point of the map (coordinates): x,y eg 3000,4000
  • size - Size of the mapframe itself in px (the template will be longer and slightly wider than this): x,y eg 400,500


A group name should be applied to the map to ensure that only the relevant elements are displayed on the map (especially when transcluded on other pages). See transcluding maps for how to include these features on additional maps on the page.

  • group - The group to add the map features too, must be a simple string of letters and numbers


Depending on the colors of the map many icons may blend into the map, light or dark shadows can be added to icons and pins to help alleviate this.

  • shadows - Allowed values are light and dark for the respective shadow colors.

Generally these maps are transcluded onto mainspace (or other) pages, for this purpose an alignment other than center (default) can be specified. Note that within the Map namespace they will always be centered, regardless of this value.

  • align - Alignment of the map (on pages not in Map namespace), default is center. It is recommended to use |align = {{{align|center}}} as maps can then easily be aligned on other pages by transcluding them such as {{Map:Abyss|align=right}}.

Categorising maps[edit source]

It is possible to add additional categories to the maps and/or pages the map is used on to help with categorisation/organisation. In both cases the value is a comma separated list of just the category names, for example: Maps in other Realms,Location maps would add the Category:Maps in other Realms and Category:Location maps to the map or page.

  • mapcats - A comma separated list of categories to add to the map itself.
  • pgcats - A comma separated list of categories to add to pages using the map.


The following are lists of map related categories, generally a map should have at least a category by area and by subject.

Categories by area: Maps in Anachronia, Maps in Ape Atoll, Maps in Asgarnia, Maps in Ashdale, Maps in Crandor, Maps in Dorgesh-Kaan, Dungeon maps, Maps in the Eastern Sea, Maps in Entrana, Maps in Feldip Hills, Maps in Kandarin, Maps in Karamja, Maps in Keldagrim, Maps in the Kharidian Desert, Maps in the Lunar Sea, Maps in Misthalin, Maps in Morytania, Maps in other Realms, Maps in the Southern Sea, Maps in Tirannwn, Maps in Troll Country, Maps in the Wilderness, Maps in Zanaris

Categories by subject: Crystal tree maps, Distractions and Diversions maps, Excavation site maps, Fairy ring maps, Hunter area maps, Location maps, Lodestone maps, Mine maps, Minigame maps, Music track maps, NPC maps, Quest maps, Resource dungeon maps, River maps, Scan clue maps, Thieving maps

Additional map categories: World maps, Historical maps

The following categories are added automatically and should not be added manually: Advanced maps, Pages using advanced maps, Pages with maps

Map features[edit source]

Getting coordinates[edit source]

For many of the features to add to a map, coordinates can already be found on wiki pages themselves. This is true of most scenery objects (assuming the page already exists), item spawns and monster spawns. Consider looking for the map templates on the pages for coordinates, these include: {{Monster map}}, {{NPC map}}, {{Object map}}, and {{Item spawns}}.

If the coordinates can not be found on a corresponding page they can be located using the dev map at mejrs.github.io, the individual maps by ID are also linked directly from RuneScape:Map/mapIDs. The current coordinates of the mouse cursor are displayed in the top left corner (the 0_2925_3350 is plane _ x _ y) and the current coordinates can also be copied using Ctrl+Double click.

Additionally maps displayed in the preview mode when editing a page display the coordinates for the cursor location when you Right click them. This can be very useful if you temporarily add |showicons = t to the advanced map (which renders the map icons on the map) for getting locations that are displayed on maps in game, such as banks and agility shortcuts.

Alternatively coordinates can be retrieved in game using the developer console getcamerapos command. These can then be converted using the Calculator:Coordinates.

Coordinates are then given in a list of semicolon (;) separated list of coordinates, where coordinate x and y are separated by comma (,). For example: 4076,6623;4069,6621;4149,6561;4137,6544. For the special types complex-polygon and lines groups of coordinates are separated by a double semicolon ;; (white-space, eg a line-break may be between the semicolons). For example:4070,6620;4070,6510;4150,6510;4150,6620;;4080,6600;4080,6550;4120,6550;4120,6600.

In cases where the are many coordinates it may be helpful to add line-breaks and comments (<!-- Comment here -->) to break up the code. See Map:The Hunt for Surok for an example (also uses lines type).

Feature types[edit source]

Map features are one of the following: polygon, complex-polygon, line, lines, circle, text, pin, icon, square or dot. Of these all but polygon, complex-polygon, line and lines are point type element, meaning that each set of coordinates places a feature at that point. For lines and polygons each set of coordinates is a start/end or corner. In complex-polygons the first group of coordinates is the outer corners while each subsequent group are holes in the polygon. For lines (note the s) each group of coordinates is its own line and must be at least 2 coordinates (start and end). Features are described as a series of numbered parameters (the same way versions function for infoboxes). For each feature set at the minimum a |coords#= parameter must be included with at least 1 point given. Generally the |type#= parameter should also be provided, if it is not provided the default feature type is dot.

For all feature types (with the exception of text) a |title#= should be provided, this is text and may be or contain a link. This title is used for the popup (opens when a map feature is clicked on) as well as for the map key. A |description#= can also be provided which is added to the popup, and can include text, links and images. For text the |label#= parameter is used for the text (and may be or contain links), note that if |title#= or |description#= are provided the text label will also generate a popup which may make it harder to click any links contained in the label.

Dot and square features are unique in that the background color of the markers, if not specified, is auto generated and will be unique to that feature number.

Appearance Feature Basics
dot Color is selected automatically, use |fill#= to override it
square Color is selected automatically, use |fill#= to override it
Text label
text Use |label#= to specify the text, which may contain basic wikitext (links, images, bold, italics etc). Optionally use class names with |class#= to change text styling.
Pin green.svg
pin Use |icon#= to choose pin (default is green). See table below for all pin types, and how to use a wiki image instead.
World Gate map icon.png
icon Select a predefined icon from this list using |icon#=
Iron ore.png
pin Use |iconWikiLink#= to choose a custom image (not a predefined icon), |iconSize#= to define it's size and |iconAnchor#= to specify the anchor point. See Feature properties and styling below for details.
line, lines See table below for possible styling (geometry:shape = LineString:Line).
polygon, complex-polygon See table below for possible styling (geometry:shape = Polygon).
circle See table below for possible styling (geometry:shape = Point:Circle).

Feature properties and styling[edit source]

Below is a list of all possible styling properties for each feature type:

Property Applicable feature(s)
geometry(:shape)
Use / Function
title all A title for the map feature (appears in the onclick popup)
description all A description for the map feature (appears in the onclick popup)
label Point:Text The visible text to display (allows usage without title or description to prevent popup
class Point:Text Additional class(es) to add to the wrapper of the visible text label (in addition to leaflet-vis-tooltip). See RuneScape:Map/Text classes for a complete list of defined classes.
direction Point:Text The position of the visible label with respect to the coordinates given (default is auto). One of right, left, top, bottom, center, auto. auto positions the label to the left or right of the coordinates depending on the proximity to the edge of the map frame.
stroke Point:Circle
Point:CircleMarker
Polygon
LineString:Line
The color of the line or shape border
stroke-opacity Point:Circle
Point:CircleMarker
Polygon
LineString:Line
The opacity of the line or shape border
stroke-width Point:Circle
Point:CircleMarker
Polygon
LineString:Line
The width of the line or shape border
fill Point:Circle
Point:CircleMarker
Polygon
Point:Dot
Point:SquareDot
The color of the shape or dot background
fill-opacity Point:Circle
Point:CircleMarker
Polygon
The opactiy of the shape background
radius Point:Circle
Point:CircleMarker
The radius of the circle or marker
icon Point The pin icon to use, one of greyPin, redPin, greenPin, bluePin, cyanPin, magentaPin, yellowPin
iconWikiLink Point An image on the wiki to use instead of a pin icon
iconSize Point
Point:Dot
Point:SquareDot
Size of the icon (pin or image) in px (eg [10,10])
iconAnchor Point Anchor point to map (location of given coordinates on image/pin) in px from top left where positive is right and down (eg [5,10])
popupAnchor Point Anchor point of popup in px relative to iconAnchor where positive is right and down (eg [0,0])

Customising the key[edit source]

Any feature that has a |coords# = and is not a text type will get an entry on the key (below the map). This entry can be suppressed by passing any value to the |nokey# = t. For text type label they can be forced to appear in the key by adding |key# = t, the symbol will display the text XX (so the size matches other key symbols) and the title is the text displayed in the key. Note that as adding a title to map elements gives them a popup it is advisable to not add them to text type, and instead use the following trick to create a separate key entry.

Additionally you can create entries that appear only on the key, by excluding the |coords# = param and adding a |key# = t param. The types available are the same as for map features and will appear the same in the key. There is an extra type key which can be used to add an entry to the key without a corresponding symbol to its left. All style parameters are treated the same as on the map, note that when using |wikiImageLink# = (to use a wiki image) the |iconSize# = parameter is needed to size the symbol in the key correctly.

The |compass = t param (note that it isn't a # param) can be included to add a compass to the end of the key. The |nokey = t param (again note that it isn't a # param) can be used to completely suppress the map key.

For an example, assuming a map with some points and the additional features for the key:

|type44 = text
|key44 = t
|title44 = Dungeon or cave
|class44 = lbl-yellow
|type45 = icon
|icon45 = quest
|key45 = t
|title45 = Requires a quest
|type46 = key
|key46 = t
|title46 = A full width key entry without a symbol

The key might look something like:

A dot feature displayed on the map.
A square feature displayed on the map
XX
Dungeon or cave
Quest map icon.png
Requires a quest
A full width key entry without a symbol

Transcluding maps[edit source]

As previously stated these "advanced maps" should be created on their own page within the map namespace. To include them on relevant pages the map namespace page should be transcluded to the relevant pages: {{Map:Map page name}}, most often in their own section such as ==Map==.

As a general rule the advanced map should not be directly added to an infobox, instead the map should be added to its own section as normal, then a standard map can be used in the infobox which displays the same elements, using the |show = parameter where the value is the same one set for the |group = parameter on the {{Advanced map}} template. {{Map}} can be used to generate this map, and while the centre should generally match that of the advanced map it is mimicking the zoom will need to be adjusted to fit the desired area within the smaller frame size. The map in the infobox should be preceded with a link to the map section of the page eg: See [[#Map|map]] section below.

As an example using the Map:Tarddiad map and the Tarddiad page, the advanced map is found on the Map:Tarddiad page (and uses |group = amaptarddiad). The infobox would then include the following:

|intmap = See [[#Map|map]] section below
{{Map|mapID = 692|4096,6592|zoom = 1|show = amaptarddiad}}

The page would then also include a map section that transcludes the map itself:

== Map ==
{{Map:Tarddiad}}

Note that the |show = parameter can be used on any map template to display the features from another map.

If you wish to align the map on a page it is recommended to use the trick mentioned above in basic parameters above.

Example[edit source]

Below is an example (the Tarddiad map).

Code[edit source]

{{Advanced map
|title = [[Tarddiad]]
|mapID = 692
|center = 4096,6592
|size = 475,475
|group = amaptarddiad
|title1 = [[Crystal Shapeshifter]]s
|coords1 = 4076,6623;4069,6621;4149,6561;4137,6544
|title2 = [[Angof]]
|coords2 = 4115,6605
|title3 = [[Bran]]
|coords3 = 4118,6572
|title4 = [[Weathered Tarddian journal]]
|type4 = square
|coords4 = 4094,6638
|title5 = [[Ancient Tarddian journal]]
|type5 = square
|coords5 = 4064,6620
|title6 = [[Dusty Tarddian journal]]
|type6 = square
|coords6 = 4121,6551
|title7 = [[World Gate]]
|type7 = icon
|icon7 = world gate
|coords7 = 4078.5,6552.5
}}

Result[edit source]

Combination advanced maps[edit source]

The {{Advanced multimap}} template can be used to create advanced maps that are a combination of several different maps (such as several levels). See Map:Slug Citadel for an example usage. The maps used here can be regular maps, advanced maps (as described on this page) or combinations. It is highly advisable to use |nokey = t to suppress the keys on all the maps, and then use |keyonly = t to create a key for all the maps combined. Please note that while the maps can each have lines on them, there is no way to draw lines from one map to another! For ladders etc it is advisable to either label them using text (for example if their is only one between floors) or use colored dots with good titles and descriptions. Also note that when using dots or squares as each map auto increments the colors individually it is generally advisable to use fill# params to ensure that the colors match between maps (when using a common key). Generally the name parameter should be used only on the parent multimap and not the individual maps themselves (so that only 1 set of view, discuss, edit links appears).

Parameters[edit source]

Template:

  • title - A title for the composite map
  • name - The Map: namespace page name (used to generate the view/discuss/edit links), should be used instead here instead of on the individual maps.
  • width - An optional custom width for the whole composite in format #px (defaults to full page width). This is essentially a maximum width and decides the maximum number of maps that will be arranged horizontally next to each other. The map will shrink to fit on smaller screens.
  • align - Alignment of the map (on mainspace pages), default is center. Recommended usage: |align = {{{align|center}}}
  • mapwidth - A custom width for each map (in format #px), default is 300px, can also overridden per map so that they aren't all the same width.
  • alignitems - Change the item alignment (vertically). Defaults to flex-end (bottoms of items will align), other possible values are center (items centered vertically) and flex-start (tops of items will align). This is the equivalent of the CSS align-items flex property.

Per component map:

  • title# = The title of the individual map (should not be used if the component map already has a title).
  • map# = The template code for the component map (generally an {{Advanced map}} or another map template).
  • width# = Allows overriding the width of this specific component map

Usage[edit source]

For a full usage example pleases see Map:Slug Citadel

{{Advanced multimap
|title = [[Combination map title]]
|width = 700px
|mapwidth = 350px
|alignitems = center
|map1 = {{Advanced map|nokey=t|...}}
|width1 = 700px
|title2 = [[Component map]] 2
|map2 = {{Map|...}}
|map3 = {{Advanced map|keyonly=t|...}}
}}

See also[edit source]

  • Help:Editing/Interactive maps - Help creating and adding basic interactive maps
  • RuneScape:Map - Details and documentation on the Kartographer project and extension used to generate the maps
  • RuneScape:Create Map - Details on creating a map manually, and details on the GeoJSON format (the JSON object used to add features to the maps)
Want some more help?