Willow: the mass documenting

2026-06-20T11:55:15Z

the mass documenting

New page

'''<code>Sound</code> places a small clickable volume icon that plays an uploaded audio file when clicked — used for boss voice lines and other in-game sounds.'''
__TOC__

== Overview ==
This template (powered by [[Module:Sound]]) outputs a little speaker icon (<code>Icon-Volume.png</code>) that, when clicked, plays the audio file you name. It is used inline on dungeon/boss pages such as [[Anubis Lair]], [[Celestial's Province: Part 1]], [[Freddy's Pizzeria]] and [[Omnipotent's Citadel]], typically right after a quoted voice line.

== Parameters ==
{| class="wikitable"
! Parameter !! Required? !! What it does !! Example
|-
| <code>1</code> (first unnamed) || Required || The audio file name '''with''' extension to play (e.g. an uploaded <code>.ogg</code>). If empty, the template shows a red "Error: No file specified". || <code>VA-AnubisLair1.ogg</code>
|-
| <code>2</code> (second unnamed) || Optional || Display size of the volume icon. Defaults to <code>20px</code>. || <code>30px</code>
|}

== How to use ==
1. Upload the audio file to the wiki first (commonly <code>.ogg</code>).
2. Put its full file name (with extension) as the first value: <code>{{Sound|VA-AnubisLair1.ogg}}</code>.
3. The icon is inline, so place it right after the text it relates to — e.g. a quoted line. A <code>&nbsp;</code> before it keeps it from wrapping onto its own.
4. Optionally pass a size as the second value to make the icon bigger or smaller: <code>{{Sound|VA-AnubisLair1.ogg|30px}}</code>.

== Copy this ==
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Sound|filename.ogg}}
</syntaxhighlight>

== Example ==
[D...] "Kurvaros. You may now rest." {{Sound|VA-AnubisLair1.ogg}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
[D...] "Kurvaros. You may now rest." {{Sound|VA-AnubisLair1.ogg}}
</syntaxhighlight>

== Tips & notes ==
* Include the extension — the module looks up the file path of exactly the name you give it. <code>{{Sound|VA-AnubisLair1}}</code> (no extension) will not find the file.
* The icon's own link is disabled; clicking it triggers playback via the <code>sound-button</code> script, not a navigation.
* The voice-line file naming convention seen on the wiki is <code>VA-<Area><n>.ogg</code> (e.g. <code>VA-AnubisLair2.ogg</code>).
* Leaving the first parameter empty renders a visible red error message, which is a quick way to spot a missing file name.
* Related: {{tl|DLog}} (lore log lines these icons usually sit beside) and [[Module:Sound]] (the engine behind this template).

Template:Sound/doc - Revision history

Willow: the mass documenting