Template:MapList/doc

Usage

To organize the large variety of areas and their associated maps in a list format.

It may also aid in keeping the naming convention of Map and Area images consistent, even if said images are not in a list.

Code

{{MapList/Start}}

{{MapList
|location       = 
|type           = 
|#              = 
|variant        = 
|location notes = 
|description    = 
|notes          = 
}}

{{Table/End}}

Naming convention is thus:

File:Map-{{{location}}}-{{{type}}}-{{{#|1}}}{{{variant|A}}}.png

File:Area-{{{location}}}-{{{type}}}-{{{#|1}}}{{{variant|A}}}.png

Parameters

Required

• location

If not a mission: use the larger, most uniform area name (Clockwork Tunnels, Devilish Drudgery, Deconstruction Zone, Treasure Vault, Compound instead of "ruined compound," etc.). You can use the specific floor too ("ruined compound" etc.), that's fine - but most of these are representative images. Since the filename is mostly hidden to casual users, this doesn't truly matter. I suppose in the long long run it would be best to use the true name instead of the "most uniform name," in case the clockworks is ever filled with lots of weird exceptions, instead of only a few.

If a mission: enter the mission's name here.

• type

If not a mission, and not an entire area: pick one of the below. (Please add to this list as the game updates).

Larger areas:

Danger Room

Scenario Room

Mysterious Room (Event only: March of the Tortodrones)

Modules:

Start   (area where the level starts)

I   (a "straight" path - you still end up going Weast<>East, or North<>South, no matter how wavy it seems to be.)

L   (an elbow, a.k.a "turn")

T   (a "T" connector that joins three paths.)

+   (a cross connector that joins 4 paths. includes modules shaped like "x" of course)

D   (a "dead end" or "cul-de-sac." Usually has loot, minerals, but not always.)

End   (area where the level ends. Sometimes has loot.)

If not a mission, AND an entire area:

Use the area's sub name. Example: "Fortune Smiles on the Greedy" for Treasure Vaults.

If a mission: enter the floor's name here.

• notes

Summarize the area. Avoid opinionated strategizing. See examples below for details.

Optional

• #

If not a mission: Used if the "type" is the same name, but the levels have clearly different MAPS, as with "Fortune Smiles on the Greedy" or the special event-only Fiendish Fray.

If a mission: generally leave this alone. Defaults to 1A with # = 1 and variant = A.

- 1

- 2

- 3

- etc.

• variant

If not a mission: used to distinguish very different AREAS that have the same type name AND map visual, so features won't be very distinguishable using the minimap or minimap overlay.

If a mission: generally leave this alone, but there are many known uses of this. Defaults to 1A with # = 1 and variant = A.

- A

- B

- C

- etc.

Variants may or may not be similar to each other between numbers and different filenames, if they are, this is just coincidence.

• description

defaults to: "No official description for this area."

• location notes

It is best to include sub location and depth notes here. See examples below for details. Defaults to blank.

Examples

Example 1: Randomly Generated Modules

{{MapList/Start}}

{{MapList
|location       = Clockwork Tunnels
|type           = Mysterious Room 
|#              = 1
|variant        = A
|location notes = *[[Infernal Passage]] <br> (Any) <br> Depth(s): ?, 28
|description    = Warning! An unidentified place of interest lies beyond this gate. By entering you will not be able to turn back until you complete the challenges within. However, should you manage to come out victorious you will be rewarded for your bravery. Enter at your own risk! <br> ''If "Bonus Mysterious Room", add: ''This room offers a bonus chance at the treasures within.
|notes          = 

This area only appears during the [[March of the Tortodrones]] event. 

A party button awaits beyond the entrance. Be prepared for many fiends.
}}

{{MapList
|location       = Clockwork Tunnels
|type           = Mysterious Room 
|#              = 2
|variant        = A
|location notes = *[[Infernal Passage]] <br> (Any)  <br> Depth(s): 27, ?
|description    = Warning! An unidentified place of interest lies beyond this gate. By entering you will not be able to turn back until you complete the challenges within. However, should you manage to come out victorious you will be rewarded for your bravery. Enter at your own risk! <br> ''If "Bonus Mysterious Room", add: ''This room offers a bonus chance at the treasures within.
|notes          = 

This area only appears during the [[March of the Tortodrones]] event. 

A party button awaits beyond the entrance. Be prepared for many fiends.

It features a special [[valestone]]-encrusted tortodrone. This tortodrone is like other [[Scenario Room]] shells - it is only an aesthetic and is not fought.
}}

{{Table/End}}

Produces:

Map	Visual	Mission or Area	Level or Segment	Notes
		Clockwork Tunnels *Infernal Passage (Any) Depth(s): ?, 28	Mysterious Room	Notes: This area only appears during the March of the Tortodrones event. A party button awaits beyond the entrance. Be prepared for many fiends.
		Clockwork Tunnels *Infernal Passage (Any) Depth(s): 27, ?	Mysterious Room	Notes: This area only appears during the March of the Tortodrones event. A party button awaits beyond the entrance. Be prepared for many fiends. It features a special valestone-encrusted tortodrone. This tortodrone is like other Scenario Room shells - it is only an aesthetic and is not fought.

Notes

Question: Why not use numbers and more numbers, instead of "type" and "variant" and so on?

Answer: Because the template is designed to cater to clockwork modules, but can also be used for all areas. Since the vast majority of entries will be modules, it is best to keep the template as intuitive as possible regarding that statistic, because the numbers start to dance after a while and the mind gets muddled, and that increases the chances of making mistakes. I've already flipped just # and Variant in my head several times. --Novaster 03:56, 14 March 2015 (UTC)

Question: Why not have "map" and "area" at the end? These seem to be two representations of the same entity.

Answer: Part of the convention reason: it is much easier to navigate categories with the variable-yet-anchoring name at the front instead of the end. It also lets text-only file browsing become clear right away - this is a map. This is an area. etc.

Thanks to

• HexZyle for doing lots of research on map modules for this project.
• Older editors such as Mozai for taking on the task of mapping a world that changes. Inspirational!