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



YumeWiki
3,033Articles

Template:BGM/doc: Difference between revisions

m (update templatedata to include soundroom)
m (add soundroom to syntax)
Line 38: Line 38:
== Syntax ==
== Syntax ==
<pre>
<pre>
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = }}
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}
</pre>
</pre>



Revision as of 00:02, 28 July 2023

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
Stringoptional
Sound Room IDsoundroom

If the BGM is from Yume 2kki, provide the ID as seen in the Sound Room.

Example
307C
Stringoptional

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)