Template:Locationbox/doc

Displays a location box, which contains a world's details.

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
(Header color)	headercolor	The color of the header of the location box. Default #3366cc	String	suggested
(Header font color)	headerfontcolor	The color of the text for the header of the location box. Default #ffffff	String	suggested
Original Name(s)	Name	The area's original Japanese (or generally, native, assuming a fangame's language is not English) names, along with any translations thereof, separated by commas. Example 扉部屋, ''Tobirabeya'', Door Room	String	suggested
(Location image)	image	The file name for the image to be displayed by the location box. Example Azure_garden.png	File	required
(Location image caption)	caption	The corresponding caption for the image, visible if a value is provided.	String	optional
Japanese Name	JapaneseName	The area's original name in Japanese, if applicable. Example 扉部屋	String	optional
Version Added	VersionAdded	The version in which the area was first added. Default x.x Example 0.114	String	suggested
Version Removed	VersionRemoved	The version in which the area was removed, if applicable. Example 0.115a	String	optional
Versions Updated	VersionsUpdated	The version(s) in which the area has been updated. This should not include VersionAdded, VersionRemoved, or any removed versions in VersionGaps. Use commas to separate multiple instances. Versions may also be followed by a dash and a 1 or 2 character code; this is an update type identifier used by Yume 2kki Explorer, and these are automatically handled by the version manager in the app. Example 0.112,0.112 patch 1,0.112d	String	optional
Version Gaps	VersionGaps	Any gaps where the area was removed only to later be re-added, starting with the version it was removed, followed by a dash, followed by the version it was re-added in. Use commas to separate multiple instances. Example 0.110b-0.110b patch 1,0.111-0.113a	String	optional
Effects	Effects	Effects (or the game's equivalent) obtainable in this location. Example Chainsaw	String	required
Wallpapers	Wallpapers Menu	Collectibles that you can find in this location. Example WP #87, Kura Puzzle #45	String	suggested
Events	Events	Events that you can encounter in this location.	String	required
Map Type	Map Type	Descriptors for a given location, such as the overall map size and whether it loops or otherwise. Example Small, Non-looping	String	optional
Notable NPCs	NPCS	Noteworthy NPCs that show up in this location.	String	suggested
Connecting Areas	Connections	List of areas connected to this location (using the Connection template) as of the game's current version. Example {{Connection|Dream Pool|one_way_type=NoEntry}}	String	required
Removed Connections	RemovedConnections	List of area connections (using the Connection template) to this location that have since been removed. Example {{Connection|Digital Forest}}	String	optional
BGM	BGM	List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it. Example {{BGM|title=soto_C5|filename=Soto-C5.ogg|label=Glasses Path}}	String	required
Map ID	Map ID	List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits. Annotations may be added to each map ID using parentheses. If you wish to include commas in these annotations, use , - it will break otherwise. Example 0002, 0003	String	required
Author	Primary	The location's main author.	String	suggested
Contributing	Contributing	Authors who have added to the location.	String	optional

Semantic properties

This template exposes the following semantic properties.

Property name	Description	Data type	Cardinality
Has location image filename	The location image's filename.	Page	Single
Header font color	The color of the locationbox's header text. Used for location-based styling.	String	Single
Header background color	The color of the locationbox's header background. Used for location-based styling.	String	Single
Has location image	The path pointing to the location image. Used for external applications to refer to the image.	String	Single
Japanese name	The area's Japanese (or generally, native-language) name. Used for localization purposes.	String	Single
Version added	The version where the location was added. Primarily used with the Yume 2kki Explorer.	String	Single
Versions updated	The version(s) where the location was updated. Primarily used with the Yume 2kki Explorer.	String	Multiple
Version removed	The version where the location was removed. Primarily used with the Yume 2kki Explorer.	String	Single
Version gaps	The versions where the location was absent prior to its return. Primarily used with the Yume 2kki Explorer.	String	Multiple
Has map type	The properties describing a map's nature.	String	Multiple
Has primary author	The person who has created the location; this is applicable to collaborative fangame projects.	String	Single
Has contributing author	The person(s) contributing to the the development of the location; this is applicable to collaborative fangame projects.	String	Multiple

General usage

 {{Locationbox
 |headercolor = #4a0400
 |headerfontcolor = #ffa500
 |image = volcanic_subterrain.png
 |Effects = None
 |Wallpapers = None
 |Events = None
 |NPCS = None
 |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}}
 |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}}
 |Map ID = 1023
 |Primary = Ruri
 |Contributing = qxy
 }}

will return:

Locationbox/doc
Basic Info
Effects	EffectNone
Events	None
Notable NPCs	None
Other
Connecting Areas	Chemical Research Facility NoEntry⛔
BGM	🔊 bgm-e – after lighting the foundry
Map ID	1023
Primary Author	Ruri
Contributing Author(s)	qxy