Template:Sound: Difference between revisions
Created page with "<includeonly> {{#invoke:Sound|main}} </includeonly>" |
the mass documenting |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly> | <includeonly>{{#invoke:Sound|main}}</includeonly><noinclude> | ||
{{#invoke:Sound|main}} | {{Documentation}} | ||
</ | </noinclude> | ||
Latest revision as of 11:55, 20 June 2026
Sound places a small clickable volume icon that plays an uploaded audio file when clicked — used for boss voice lines and other in-game sounds.
Overview
This template (powered by Module:Sound) outputs a little speaker icon (Icon-Volume.png) 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
| Parameter | Required? | What it does | Example |
|---|---|---|---|
1 (first unnamed) |
Required | The audio file name with extension to play (e.g. an uploaded .ogg). If empty, the template shows a red "Error: No file specified". |
VA-AnubisLair1.ogg
|
2 (second unnamed) |
Optional | Display size of the volume icon. Defaults to 20px. |
30px
|
How to use
1. Upload the audio file to the wiki first (commonly .ogg).
2. Put its full file name (with extension) as the first value: .
3. The icon is inline, so place it right after the text it relates to — e.g. a quoted line. A 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: .
Copy this
{{Sound|filename.ogg}}Example
[D...] "Kurvaros. You may now rest."
[D...] "Kurvaros. You may now rest." {{Sound|VA-AnubisLair1.ogg}}Tips & notes
- Include the extension — the module looks up the file path of exactly the name you give it.
(no extension) will not find the file. - The icon's own link is disabled; clicking it triggers playback via the
sound-buttonscript, not a navigation. - The voice-line file naming convention seen on the wiki is
VA-<Area><n>.ogg(e.g.VA-AnubisLair2.ogg). - Leaving the first parameter empty renders a visible red error message, which is a quick way to spot a missing file name.
- Related:
{{DLog}}(lore log lines these icons usually sit beside) and Module:Sound (the engine behind this template).