×
Create a new article
Write your page title here:
We currently have 2,844 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
2,844Articles

Template:Locationbox/doc: Difference between revisions

mNo edit summary
Line 3: Line 3:
"params": {
"params": {
"headercolor": {
"headercolor": {
"label": "headercolor",
"label": "(Header color)",
"description": "The color of the header of the location box.",
"description": "The color of the header of the location box.",
"type": "string",
"type": "string",
Line 10: Line 10:
},
},
"headerfontcolor": {
"headerfontcolor": {
"label": "headerfontcolor",
"label": "(Header font color)",
"description": "The color of the text for the header of the location box.",
"description": "The color of the text for the header of the location box.",
"type": "string",
"type": "string",
Line 16: Line 16:
},
},
"image": {
"image": {
"label": "image",
"label": "(Location image)",
"description": "The file name for the image to be displayed by the location box.",
"description": "The file name for the image to be displayed by the location box.",
"type": "wiki-file-name"
"type": "wiki-file-name",
"example": "Azure_garden.png"
},
},
"caption": {
"caption": {
"label": "caption",
"label": "(Location image caption)",
"description": "The corresponding caption for the image, visible if a value is provided.",
"description": "The corresponding caption for the image, visible if a value is provided.",
"type": "string"
"type": "string"
},
},
"JapaneseName": {
"JapaneseName": {
"label": "JapaneseName",
"label": "Japanese Name",
"description": "The area's Japanese name.",
"description": "The area's original name in Japanese, if applicable.",
"example": "扉部屋",
"example": "扉部屋",
"type": "string"
"type": "string"
},
},
"VersionAdded": {
"VersionAdded": {
"label": "VersionAdded",
"label": "Version Added",
"description": "The version where the area has been added.",
"description": "The version in which area was first added.",
"example": "0.114",
"example": "0.114",
"type": "string",
"type": "string",
Line 39: Line 40:
},
},
"VersionRemoved": {
"VersionRemoved": {
"label": "VersionRemoved",
"label": "Version Removed",
"description": "The version where the area has been removed.",
"description": "The version in which the area was removed, if applicable.",
"example": "0.115a",
"example": "0.115a",
"type": "string"
},
"VersionsUpdated": {
"label": "VersionsUpdated",
"description": "The version(s) where the area has been updated. This should not include version added, version removed, or version removed in any version gaps. 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",
"type": "string"
"type": "string"
},
},
"VersionGaps": {
"VersionGaps": {
"label": "VersionGaps",
"label": "Version Gaps",
"description": "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.",
"description": "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",
"example": "0.110b-0.110b patch 1,0.111-0.113a",
"type": "string"
},
"VersionsUpdated": {
"label": "Versions Updated",
"description": "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",
"type": "string"
"type": "string"
},
},
"Effects": {
"Effects": {
"label": "Effects",
"label": "Effects",
"description": "Effects obtainable in the current location.",
"description": "Effects (or the game's equivalent) obtainable in this location.",
"example": "Chainsaw",
"example": "Chainsaw",
"type": "string"
"type": "string"
Line 64: Line 65:
"Wallpapers": {
"Wallpapers": {
"label": "Wallpapers",
"label": "Wallpapers",
"description": "Collectibles that you can find in the current location.",
"description": "Collectibles that you can find in this location.",
"example": "WP #87, Kura Puzzle #45",
"example": "WP #87, Kura Puzzle #45",
"type": "string"
"type": "string",
"aliases": ["Menu"]
},
},
"Events": {
"Events": {
"label": "Events",
"label": "Events",
"description": "Events that you can encounter.",
"description": "Events that you can encounter in this location.",
"type": "string"
"type": "string"
},
},
"NPCS": {
"NPCS": {
"label": "NPCS",
"label": "Notable NPCs",
"description": "Notable NPCs that show up in the current location.",
"description": "Noteworthy NPCs that show up in this location.",
"type": "string"
"type": "string"
},
},
"Connections": {
"Connections": {
"label": "Connections",
"label": "Connecting Areas",
"description": "Locations accessible from the location at present.",
"description": "List of areas connected to this location (using the Connection template) as of the game's current version.",
"type": "string"
"type": "string",
"example": "{{Connection|Dream Pool|one_way_type=NoEntry}}"
},
},
"RemovedConnections": {
"RemovedConnections": {
"label": "RemovedConnections",
"label": "Removed Connections",
"description": "Locations that have been removed from recent versions, connected to the present area.",
"description": "List of area connections (using the Connection template) to this location that have since been removed.",
"type": "string"
"type": "string",
"example": "{{Connection|Digital Forest|is_removed=true}}"
},
},
"BGM": {
"BGM": {
"label": "BGM",
"label": "BGM",
"description": "Soundtrack that plays in the current location.",
"description": "List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.",
"type": "string"
"type": "string",
"example": "{{BGM|title=soto_C5|filename=Soto-C5.ogg|label=Glasses Path}}"
},
},
"Map ID": {
"Map ID": {
"label": "Map ID",
"label": "Map ID",
"description": "The IDs corresponding to the location's map, as well as any existing sub-areas. Zero-padded, with four digits.",
"description": "List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits.",
"example": "0002",
"example": "0002, 0003",
"type": "string"
},
"Primary": {
"label": "Author",
"description": "The location's main author.",
"type": "string"
"type": "string"
},
},
Line 102: Line 112:
"label": "Contributing",
"label": "Contributing",
"description": "Authors who have added to the location, visible if a value is provided.",
"description": "Authors who have added to the location, visible if a value is provided.",
"type": "string"
},
"Primary": {
"label": "Primary",
"description": "The location's main author.",
"type": "string"
"type": "string"
},
},
"Name": {
"Name": {
"label": "Name",
"label": "Original Name(s)",
"description": "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.",
"description": "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",
"example": "扉部屋, ''Tobirabeya'', Door Room",
Line 151: Line 156:


==General usage==
==General usage==
<poem><code><nowiki>
<pre style="line-height:1.6;">
  {{Locationbox
  {{Locationbox
  |headercolor = #4a0400
  |headercolor = #4a0400
Line 166: Line 171:
  |Contributing = qxy
  |Contributing = qxy
  }}
  }}
</nowiki></code></poem>
</pre>
will return
will return:
{{Locationbox
{{Locationbox
  |headercolor = #4a0400
  |headercolor = #4a0400

Revision as of 21:36, 12 December 2022

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

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
(Header color)headercolor

The color of the header of the location box.

Default
#3366cc
Stringsuggested
(Header font color)headerfontcolor

The color of the text for the header of the location box.

Default
#ffffff
Stringoptional
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
Stringoptional
(Location image)image

The file name for the image to be displayed by the location box.

Example
Azure_garden.png
Fileoptional
(Location image caption)caption

The corresponding caption for the image, visible if a value is provided.

Stringoptional
Japanese NameJapaneseName

The area's original name in Japanese, if applicable.

Example
扉部屋
Stringoptional
Version AddedVersionAdded

The version in which area was first added.

Default
x.x
Example
0.114
Stringoptional
Version RemovedVersionRemoved

The version in which the area was removed, if applicable.

Example
0.115a
Stringoptional
Versions UpdatedVersionsUpdated

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
Stringoptional
Version GapsVersionGaps

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
Stringoptional
EffectsEffects

Effects (or the game's equivalent) obtainable in this location.

Example
Chainsaw
Stringoptional
WallpapersWallpapers Menu

Collectibles that you can find in this location.

Example
WP #87, Kura Puzzle #45
Stringoptional
EventsEvents

Events that you can encounter in this location.

Stringoptional
Map TypeMap Type

Descriptors for a given location, such as the overall map size and whether it loops or otherwise.

Example
Small, Non-looping
Stringoptional
Notable NPCsNPCS

Noteworthy NPCs that show up in this location.

Stringoptional
Connecting AreasConnections

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}}
Stringoptional
Removed ConnectionsRemovedConnections

List of area connections (using the Connection template) to this location that have since been removed.

Example
{{Connection|Digital Forest|is_removed=true}}
Stringoptional
BGMBGM

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}}
Stringoptional
Map IDMap ID

List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits.

Example
0002, 0003
Stringoptional
AuthorPrimary

The location's main author.

Stringoptional
ContributingContributing

Authors who have added to the location, visible if a value is provided.

Stringoptional

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
Volcanic subterrain.png
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