- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
Difference between revisions of "Audio"
Joostheger (talk | contribs) m |
(Formalized music tokens. Added to modding sidebar and category.) |
||
Line 1: | Line 1: | ||
− | {{ | + | {{Modding}} |
''Dwarf Fortress'' contains music tracks which play at various points in game, including the main menu theme. Some types of audio seem to be triggered by events, while others play randomly while certain criteria are met. These seem to include some [[weather]] sounds, wild ambience, building sounds, river etc. | ''Dwarf Fortress'' contains music tracks which play at various points in game, including the main menu theme. Some types of audio seem to be triggered by events, while others play randomly while certain criteria are met. These seem to include some [[weather]] sounds, wild ambience, building sounds, river etc. | ||
Line 11: | Line 11: | ||
All sound and [[Soundtrack|music]] files used by ''Dwarf Fortress'' are stored in the [https://en.wikipedia.org/wiki/Ogg .ogg] format within the <code>[[Game folder|<Dwarf Fortress>]]/data/sound/</code> subfolders. You can replace the existing ogg files with different ones. That has to be performed manually and isn't actually supported by the game. You can also change some of the definitions of when certain musical cues are played, using available music tokens and sound tokens in the [[raw file]]s found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_music\</code>. You can add new music and sounds with raws in the sound folder{{version|0.50.09}}, formatted like so: | All sound and [[Soundtrack|music]] files used by ''Dwarf Fortress'' are stored in the [https://en.wikipedia.org/wiki/Ogg .ogg] format within the <code>[[Game folder|<Dwarf Fortress>]]/data/sound/</code> subfolders. You can replace the existing ogg files with different ones. That has to be performed manually and isn't actually supported by the game. You can also change some of the definitions of when certain musical cues are played, using available music tokens and sound tokens in the [[raw file]]s found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_music\</code>. You can add new music and sounds with raws in the sound folder{{version|0.50.09}}, formatted like so: | ||
+ | |||
+ | ==Identifiers== | ||
+ | |||
+ | To allow the game to read sound files consistently, they must be given an identifier. Identifiers can be any arbitrary string, just like any other raw object. | ||
sound_file_example | sound_file_example | ||
Line 25: | Line 29: | ||
[TITLE:piece title] | [TITLE:piece title] | ||
− | + | {| {{prettytable}} | |
+ | |- bgcolor="#dddddd" | ||
+ | !Token | ||
+ | !Arguments | ||
+ | !Extra Information | ||
+ | |- | ||
+ | | {{text anchor|FILE}} | ||
+ | | | ||
+ | * path to audio | ||
+ | | (Required) Usually stored as "sound/...ogg". | ||
+ | |- | ||
+ | | {{text anchor|AUTHOR}} | ||
+ | | | ||
+ | * string | ||
+ | | (Music only) Displays as the song author on pause menu. | ||
+ | |- | ||
+ | | {{text anchor|LOOPS}} | ||
+ | | | ||
+ | | (Music only) If set, should play continuously until interrupted. [verify] | ||
+ | |- | ||
+ | | {{text anchor|TITLE}} | ||
+ | | | ||
+ | * string | ||
+ | | (Music only) Displays as track title on pause menu. | ||
+ | |} | ||
+ | |||
+ | ==Sound effects== | ||
− | All vanilla sound tokens are found within <code>sound_standard.txt</code>. All sound files must begin with | + | All vanilla sound tokens are found within <code>sound_standard.txt</code>. All sound definition files must begin with <code>sound_</code>, followed by the <code>[OBJECT:SOUND]</code> token that tells the game that the file contains sound definitions. |
[SOUND:<identifier>] | [SOUND:<identifier>] | ||
Line 35: | Line 65: | ||
[ANNOUNCEMENT:<announcement n>] | [ANNOUNCEMENT:<announcement n>] | ||
− | + | {| {{prettytable}} | |
− | * | + | |- bgcolor="#dddddd" |
− | + | !Token | |
− | * | + | !Arguments |
+ | !Extra Information | ||
+ | |- | ||
+ | | {{text anchor|FILE}} | ||
+ | | | ||
+ | * sound file | ||
+ | | (Required) File identifiers can be any of various hardcoded sounds (all present in the vanilla raws) or custom [SOUND_FILE] objects. | ||
+ | |- | ||
+ | | {{text anchor|ANNOUNCEMENT}} | ||
+ | | | ||
+ | * [[Announcements.txt|announcement(s)]] | ||
+ | | Trigger condition, can use more than one announcement in the list. | ||
+ | |- | ||
+ | | {{text anchor|SAVAGE_AREA}} | ||
+ | | | ||
+ | | Played randomly in a [[Surroundings#Savage|savage]] area. | ||
+ | |} | ||
− | + | ==Music tracks== | |
All vanilla music tokens are found within <code>music_standard.txt</code>. All music files must begin with the file name{{verify}}, followed by the <code>[OBJECT:MUSIC]</code> token that tells the game that the file contains music definitions. | All vanilla music tokens are found within <code>music_standard.txt</code>. All music files must begin with the file name{{verify}}, followed by the <code>[OBJECT:MUSIC]</code> token that tells the game that the file contains music definitions. | ||
Line 53: | Line 99: | ||
[FREQUENCY:UNCOMMON] | [FREQUENCY:UNCOMMON] | ||
− | * | + | {| {{prettytable}} |
− | * | + | |- bgcolor="#dddddd" |
− | + | !Token | |
− | * | + | !Arguments |
+ | !Extra Information | ||
+ | |- | ||
+ | | {{text anchor|FILE}} | ||
+ | | | ||
+ | * music file | ||
+ | | (Required) Can be any of the many hardcoded files for the [[soundtrack]], or it can be a custom [MUSIC_FILE] object. | ||
+ | |- | ||
+ | | {{text anchor|CARD}} | ||
+ | | | ||
+ | * music file(s) | ||
+ | | Mostly unexplored, listed as a "shuffled deck of short bits." Appears to be played only if no song is currently playing? Before the song proper starts, the game will play a few of these in random order. | ||
+ | |- | ||
+ | | {{text anchor|CONTEXT}} | ||
+ | | context(s) | ||
+ | | This song can randomly play if any of the contexts are met. | ||
+ | |- | ||
+ | | {{text anchor|EVENT}} | ||
+ | | event(s) | ||
+ | | When the chosen event occurs, this song automatically plays and overrides the current song. If multiple songs match the event, a random song will be played from among them. | ||
+ | |- | ||
+ | | {{text anchor|FREQUENCY}} | ||
+ | | | ||
+ | * UNCOMMON or RARE | ||
+ | | Can be set to 'UNCOMMON' to set the frequency half as often as the other candidates or 'RARE' to make it 1/5 as often as other candidates. | ||
+ | |} | ||
+ | |||
+ | ; Contexts | ||
+ | {| {{prettytable}} | ||
+ | |- bgcolor="#dddddd" | ||
+ | !Token | ||
+ | !Extra Information | ||
+ | |- | ||
+ | | {{text anchor|ANY}} | ||
+ | | Can play at any time, including in menus. | ||
+ | |- | ||
+ | | {{text anchor|MAIN}} | ||
+ | | The gamemode is Fortress Mode. | ||
+ | |- | ||
+ | | {{text anchor|FIRST_YEAR}} | ||
+ | | You are controlling a fortress that is less than one year old. | ||
+ | |- | ||
+ | | {{text anchor|SECOND_YEAR_PLUS}} | ||
+ | | Your fortress has been around for more than one year. | ||
+ | |- | ||
+ | | {{text anchor|CAVERNS_OPENED}} | ||
+ | | Your fortress has access to the caverns. | ||
+ | |- | ||
+ | | {{text anchor|SPRING}} | ||
+ | | The current season is spring. Appears to also be played in Legends mode and the main menu. | ||
+ | |- | ||
+ | | {{text anchor|SUMMER}} | ||
+ | | The current season is summer. Appears to also be played in Legends mode and the main menu. | ||
+ | |- | ||
+ | | {{text anchor|AUTUMN}} | ||
+ | | The current season is autumn. Appears to also be played in Legends mode and the main menu. | ||
+ | |- | ||
+ | | {{text anchor|WINTER}} | ||
+ | | The current season is winter. | ||
+ | |} | ||
− | + | ; Events | |
− | + | {| {{prettytable}} | |
− | + | |- bgcolor="#dddddd" | |
− | + | !Token | |
− | + | !Extra Information | |
− | + | |- | |
− | + | | {{text anchor|JUST_EMBARKED}} | |
− | + | | Plays when founding a new fortress. | |
− | + | |- | |
− | + | | {{text anchor|SIEGE}} | |
+ | | A [[siege]] is announced. | ||
+ | |- | ||
+ | | {{text anchor|FIRST_CAVERN_OPENED}} | ||
+ | | A new cave layer is discovered [verify] | ||
+ | |- | ||
+ | | {{text anchor|MEGABEAST_ATTACK}} | ||
+ | | Plays when a [[megabeast]]'s arrival is announced. It is unknown if it is also relevant for [[Semi-megabeast|semi-megabeasts]] or [[Titan|titans]]. | ||
+ | |- | ||
+ | | {{text anchor|FORGOTTEN_BEAST_ATTACK}} | ||
+ | | Plays when a [[forgotten beast]]'s arrival is announced. | ||
+ | |- | ||
+ | | {{text anchor|DEATH_SPIRAL}} | ||
+ | | Many citizen deaths have occurred in short succession. | ||
+ | |- | ||
+ | | {{text anchor|TAVERN_MUSIC_PRESENT}} | ||
+ | | Many units have gathered to perform or watch a [[Performer#Music|musical form]]. | ||
+ | |- | ||
+ | | {{text anchor|TAVERN_DANCE_PRESENT}} | ||
+ | | Many units have gathered to perform or watch a [[Performer#Dance|dance]]. | ||
+ | |- | ||
+ | | {{text anchor|LOST_FORT}} | ||
+ | | A fortress is abandoned or retired. | ||
+ | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== See Also== | == See Also== |
Revision as of 07:25, 27 October 2023
Modding |
---|
Tokens |
Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World |
Body tokens |
Body · Body detail plan · Bodygloss · Tissue |
Creature tokens |
Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer |
Descriptor tokens |
Descriptor color · Color · Descriptor pattern · Descriptor shape |
Entity tokens |
Entity · Ethic · Language · Value · Position |
Job tokens |
Building · Labor · Reaction · Skill · Unit type |
Item tokens |
Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon |
Material tokens |
Material type · Material definition · Inorganic material definition |
Dwarf Fortress contains music tracks which play at various points in game, including the main menu theme. Some types of audio seem to be triggered by events, while others play randomly while certain criteria are met. These seem to include some weather sounds, wild ambience, building sounds, river etc.
According to Tarn, there are different settings for every track. One depends on the caverns being opened, one plays only after the second year, one is a first year track. Strike the Earth plays when you first embark, and then gets mixed in with the others afterward. And so forth; there's a raw format for this so you can change it if you like.[1]
Game Audio settings can be adjusted in the settings menu.
Modding
All sound and music files used by Dwarf Fortress are stored in the .ogg format within the <Dwarf Fortress>/data/sound/
subfolders. You can replace the existing ogg files with different ones. That has to be performed manually and isn't actually supported by the game. You can also change some of the definitions of when certain musical cues are played, using available music tokens and sound tokens in the raw files found in <Dwarf Fortress>\data\vanilla\vanilla_music\
. You can add new music and sounds with raws in the sound folderv0.50.09, formatted like so:
Identifiers
To allow the game to read sound files consistently, they must be given an identifier. Identifiers can be any arbitrary string, just like any other raw object.
sound_file_example [OBJECT:SOUND_FILE] [SOUND_FILE:<identifier>] [FILE:file name]
music_file_example [OBJECT:MUSIC_FILE] [MUSIC_FILE:<identifier>] [FILE:file name] [AUTHOR:author name] [LOOPS] optional [TITLE:piece title]
Token | Arguments | Extra Information |
---|---|---|
FILE |
|
(Required) Usually stored as "sound/...ogg". |
AUTHOR |
|
(Music only) Displays as the song author on pause menu. |
LOOPS | (Music only) If set, should play continuously until interrupted. [verify] | |
TITLE |
|
(Music only) Displays as track title on pause menu. |
Sound effects
All vanilla sound tokens are found within sound_standard.txt
. All sound definition files must begin with sound_
, followed by the [OBJECT:SOUND]
token that tells the game that the file contains sound definitions.
[SOUND:<identifier>] [FILE:<file identifier>] [ANNOUNCEMENT:<announcement>] ... [ANNOUNCEMENT:<announcement n>]
Token | Arguments | Extra Information |
---|---|---|
FILE |
|
(Required) File identifiers can be any of various hardcoded sounds (all present in the vanilla raws) or custom [SOUND_FILE] objects. |
ANNOUNCEMENT | Trigger condition, can use more than one announcement in the list. | |
SAVAGE_AREA | Played randomly in a savage area. |
Music tracks
All vanilla music tokens are found within music_standard.txt
. All music files must begin with the file name[Verify], followed by the [OBJECT:MUSIC]
token that tells the game that the file contains music definitions.
[MUSIC:TRACK_02] [FILE:EXPANSIVE_CAVERN] [CARD:EXPANSIVE_CAVERN_CARD_1] for the shuffled deck of short bits [CARD:EXPANSIVE_CAVERN_CARD_2] [CARD:EXPANSIVE_CAVERN_CARD_3] [CARD:EXPANSIVE_CAVERN_CARD_4] [EVENT:FIRST_CAVERN_OPENED] [CONTEXT:CAVERNS_OPENED] [FREQUENCY:UNCOMMON]
Token | Arguments | Extra Information |
---|---|---|
FILE |
|
(Required) Can be any of the many hardcoded files for the soundtrack, or it can be a custom [MUSIC_FILE] object. |
CARD |
|
Mostly unexplored, listed as a "shuffled deck of short bits." Appears to be played only if no song is currently playing? Before the song proper starts, the game will play a few of these in random order. |
CONTEXT | context(s) | This song can randomly play if any of the contexts are met. |
EVENT | event(s) | When the chosen event occurs, this song automatically plays and overrides the current song. If multiple songs match the event, a random song will be played from among them. |
FREQUENCY |
|
Can be set to 'UNCOMMON' to set the frequency half as often as the other candidates or 'RARE' to make it 1/5 as often as other candidates. |
- Contexts
Token | Extra Information |
---|---|
ANY | Can play at any time, including in menus. |
MAIN | The gamemode is Fortress Mode. |
FIRST_YEAR | You are controlling a fortress that is less than one year old. |
SECOND_YEAR_PLUS | Your fortress has been around for more than one year. |
CAVERNS_OPENED | Your fortress has access to the caverns. |
SPRING | The current season is spring. Appears to also be played in Legends mode and the main menu. |
SUMMER | The current season is summer. Appears to also be played in Legends mode and the main menu. |
AUTUMN | The current season is autumn. Appears to also be played in Legends mode and the main menu. |
WINTER | The current season is winter. |
- Events
Token | Extra Information |
---|---|
JUST_EMBARKED | Plays when founding a new fortress. |
SIEGE | A siege is announced. |
FIRST_CAVERN_OPENED | A new cave layer is discovered [verify] |
MEGABEAST_ATTACK | Plays when a megabeast's arrival is announced. It is unknown if it is also relevant for semi-megabeasts or titans. |
FORGOTTEN_BEAST_ATTACK | Plays when a forgotten beast's arrival is announced. |
DEATH_SPIRAL | Many citizen deaths have occurred in short succession. |
TAVERN_MUSIC_PRESENT | Many units have gathered to perform or watch a musical form. |
TAVERN_DANCE_PRESENT | Many units have gathered to perform or watch a dance. |
LOST_FORT | A fortress is abandoned or retired. |