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



YumeWiki
2,806Articles

Template:BGM/doc: Difference between revisions

(Created page with " <templatedata> { "params": { "title": { "label": "Title", "description": "The BGM's title, to be displayed. This could either be an official title, or the original f...")
 
(add author param)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Description ==
<templatedata>
<templatedata>
{
{
Line 19: Line 19:
"label": {
"label": {
"label": "Label",
"label": "Label",
"description": "A label describing where or when the area would play.",
"description": "A label describing where or when the area would play. This could be a sub-area or an event, or the area under different conditions",
"example": "FC Overworld",
"example": "FC Overworld",
"type": "string",
"suggested": true
},
"soundroom": {
"label": "Sound Room ID",
"description": "If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID exactly as seen in the Sound Room.",
"example": "307C",
"type": "string"
"type": "string"
},
"author": {
"label": "Author",
"description": "Credit the track's composer/author.",
"example": "MadameMimic",
"type": "string",
"suggested": true
}
}
},
},
Line 28: Line 42:
}
}
</templatedata>
</templatedata>
== Syntax ==
<pre>
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}
</pre>
== Sample output ==
<pre>
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
</pre>
{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
<includeonly>__NOEDITSECTION__</includeonly>

Latest revision as of 06:45, 12 June 2024

Description

Renders a link (if provided) to an area's BGM, and sets a subobject that can be queried.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The BGM's title, to be displayed. This could either be an official title, or the original filename exclusive of extension.

Example
いかる ひのやま
Stringrequired
Filenamefilename

The audio's filename, pointing to the file as uploaded. If left blank, no link will be displayed.

Example
FC BGM 008.ogg
Stringsuggested
Labellabel

A label describing where or when the area would play. This could be a sub-area or an event, or the area under different conditions

Example
FC Overworld
Stringsuggested
Sound Room IDsoundroom

If the BGM is featured in a Sound Room like in Yume 2kki, provide the ID exactly as seen in the Sound Room.

Example
307C
Stringoptional
Authorauthor

Credit the track's composer/author.

Example
MadameMimic
Stringsuggested

Syntax

{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}

Sample output

{{BGM|title = tonny31.6|filename = Tonny31.6 (284D).ogg|label = Budding Life World|soundroom = 248D}}

tonny31.6 (Budding Life World) (No. 248D)