mNo edit summary |
|||
Line 3: | Line 3: | ||
"params": { | "params": { | ||
"headercolor": { | "headercolor": { | ||
"label": " | "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": " | "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": " | "label": "Japanese Name", | ||
"description": "The area's Japanese | "description": "The area's original name in Japanese, if applicable.", | ||
"example": "扉部屋", | "example": "扉部屋", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"VersionAdded": { | "VersionAdded": { | ||
"label": " | "label": "Version Added", | ||
"description": "The version | "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": " | "label": "Version Removed", | ||
"description": "The version | "description": "The version in which the area was removed, if applicable.", | ||
"example": "0.115a", | "example": "0.115a", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"VersionGaps": { | "VersionGaps": { | ||
"label": " | "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 | "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 | "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": " | "label": "Notable NPCs", | ||
"description": " | "description": "Noteworthy NPCs that show up in this location.", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"Connections": { | "Connections": { | ||
"label": " | "label": "Connecting Areas", | ||
"description": " | "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": " | "label": "Removed Connections", | ||
"description": " | "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": " | "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": " | "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" | "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== | ||
< | <pre style="line-height:1.6;"> | ||
{{Locationbox | {{Locationbox | ||
|headercolor = #4a0400 | |headercolor = #4a0400 | ||
Line 166: | Line 171: | ||
|Contributing = qxy | |Contributing = qxy | ||
}} | }} | ||
</ | </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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
(Header color) | headercolor | The color of the header of the location box.
| String | suggested |
(Header font color) | headerfontcolor | The color of the text for the header of the location box.
| String | optional |
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.
| String | optional |
(Location image) | image | The file name for the image to be displayed by the location box.
| File | optional |
(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.
| String | optional |
Version Added | VersionAdded | The version in which area was first added.
| String | optional |
Version Removed | VersionRemoved | The version in which the area was removed, if applicable.
| 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.
| 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.
| String | optional |
Effects | Effects | Effects (or the game's equivalent) obtainable in this location.
| String | optional |
Wallpapers | Wallpapers Menu | Collectibles that you can find in this location.
| String | optional |
Events | Events | Events that you can encounter in this location. | String | optional |
Map Type | Map Type | Descriptors for a given location, such as the overall map size and whether it loops or otherwise.
| String | optional |
Notable NPCs | NPCS | Noteworthy NPCs that show up in this location. | String | optional |
Connecting Areas | Connections | List of areas connected to this location (using the Connection template) as of the game's current version.
| String | optional |
Removed Connections | RemovedConnections | List of area connections (using the Connection template) to this location that have since been removed.
| String | optional |
BGM | BGM | List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.
| String | optional |
Map ID | Map ID | List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits.
| String | optional |
Author | Primary | The location's main author. | String | optional |
Contributing | Contributing | Authors who have added to the location, visible if a value is provided. | String | optional |
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 | None |
Events | None |
Notable NPCs | None |
Other | |
Connecting Areas | Chemical Research Facility ⛔ |
BGM | 🔊 bgm-e – after lighting the foundry |
Map ID | 1023 |
Primary Author | Ruri |
Contributing Author(s) | qxy |