v50 Steam/Premium information for editors
  • 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.
This notice may be cached—the current version can be found here.

Editing Audio

Jump to navigation Jump to search

Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.

If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 14: Line 14:
 
==Identifiers==
 
==Identifiers==
  
−
To allow the game to read audio files consistently, they must be given an identifier. Identifiers can be any arbitrary string, just like any other raw object.
+
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.
−
 
 
−
Identifier files are stored in a mod's <code>sound/</code> directory (not the <code>objects/</code> directory, where the logic for playing them is stored), and their name must start with <code>sound_file_</code> or <code>music_file_</code>.
 
−
 
 
−
Their first line must be the filename, followed by <code> [OBJECT:SOUND_FILE]</code> or <code>[OBJECT:MUSIC_FILE]</code> respectively.
 
  
 
  sound_file_example
 
  sound_file_example
Line 42: Line 38:
 
|
 
|
 
* path to audio
 
* path to audio
−
| (Required) Usually stored as <code>sound/...ogg</code>.
+
| (Required) Usually stored as "sound/...ogg".
 
|-
 
|-
 
| {{text anchor|AUTHOR}}
 
| {{text anchor|AUTHOR}}
Line 51: Line 47:
 
| {{text anchor|LOOPS}}
 
| {{text anchor|LOOPS}}
 
|  
 
|  
−
| (Music only) If set, should play continuously until interrupted.{{verify}}
+
| (Music only) If set, should play continuously until interrupted. [verify]
 
|-
 
|-
 
| {{text anchor|TITLE}}
 
| {{text anchor|TITLE}}
Line 61: Line 57:
 
==Sound effects==
 
==Sound effects==
  
−
All vanilla sound tokens are found within <code>objects/sound_standard.txt</code>. All sound definition raws must begin with <code>sound_</code>, followed by the <code>[OBJECT:SOUND]</code> token that tells the game that the file contains sound definitions.
+
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>]
−
     [FILE:<[[Audio#Identifiers|file identifier]]>]
+
     [FILE:<file identifier>]
 
     [ANNOUNCEMENT:<announcement>]
 
     [ANNOUNCEMENT:<announcement>]
 
     ...
 
     ...
Line 77: Line 73:
 
| {{text anchor|FILE}}
 
| {{text anchor|FILE}}
 
|
 
|
−
* [[Audio#Identifiers|sound file]]
+
* sound file
−
| (Required) [[Audio#Identifiers|File identifiers]] can be any of various hardcoded sounds (all present in the vanilla raws) or custom [SOUND_FILE] objects.
+
| (Required) File identifiers can be any of various hardcoded sounds (all present in the vanilla raws) or custom [SOUND_FILE] objects.
 
|-
 
|-
 
| {{text anchor|ANNOUNCEMENT}}
 
| {{text anchor|ANNOUNCEMENT}}
Line 91: Line 87:
  
 
==Music tracks==
 
==Music tracks==
−
All vanilla music tokens are found within <code>objects/music_standard.txt</code>. All music logic raws must begin with <code>music_</code>, 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.
  
 
  [MUSIC:TRACK_02]
 
  [MUSIC:TRACK_02]
Line 111: Line 107:
 
| {{text anchor|FILE}}
 
| {{text anchor|FILE}}
 
|
 
|
−
* [[Audio#Identifiers|music file]]
+
* music file
−
| (Required) Can be any of the many hardcoded [[Audio#Identifiers|files]] for the [[soundtrack]], or it can be a custom [MUSIC_FILE] object.
+
| (Required) Can be any of the many hardcoded files for the [[soundtrack]], or it can be a custom [MUSIC_FILE] object.
 
|-
 
|-
 
| {{text anchor|CARD}}
 
| {{text anchor|CARD}}
 
|
 
|
−
* [[Audio#Identifiers|music file(s)]]
+
* 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.
 
| 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}}
 
| {{text anchor|CONTEXT}}
−
| [[Audio#Contexts|context(s)]]
+
| context(s)
 
| This song can randomly play if any of the contexts are met.
 
| This song can randomly play if any of the contexts are met.
 
|-
 
|-
 
| {{text anchor|EVENT}}
 
| {{text anchor|EVENT}}
−
| [[Audio#Events|event(s)]]
+
| 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.
 
| 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.
 
|-
 
|-
Line 143: Line 139:
 
|-
 
|-
 
| {{text anchor|MAIN}}
 
| {{text anchor|MAIN}}
−
| The gamemode is [[Fortress Mode]].
+
| The gamemode is Fortress Mode.
 
|-
 
|-
 
| {{text anchor|FIRST_YEAR}}
 
| {{text anchor|FIRST_YEAR}}
Line 152: Line 148:
 
|-
 
|-
 
| {{text anchor|CAVERNS_OPENED}}
 
| {{text anchor|CAVERNS_OPENED}}
−
| Your fortress has access to the [[cavern]]s.
+
| Your fortress has access to the caverns.
 
|-
 
|-
 
| {{text anchor|SPRING}}
 
| {{text anchor|SPRING}}
−
| The current season is [[spring]]. Appears to also be played in Legends mode and the main menu.
+
| The current season is spring. Appears to also be played in Legends mode and the main menu.
 
|-
 
|-
 
| {{text anchor|SUMMER}}
 
| {{text anchor|SUMMER}}
−
| The current season is [[summer]]. Appears to also be played in Legends mode and the main menu.
+
| The current season is summer. Appears to also be played in Legends mode and the main menu.
 
|-
 
|-
 
| {{text anchor|AUTUMN}}
 
| {{text anchor|AUTUMN}}
−
| The current season is [[autumn]]. Appears to also be played in Legends mode and the main menu.
+
| The current season is autumn. Appears to also be played in Legends mode and the main menu.
 
|-
 
|-
 
| {{text anchor|WINTER}}
 
| {{text anchor|WINTER}}
−
| The current season is [[winter]].
+
| The current season is winter.
 
|}
 
|}
  
Line 174: Line 170:
 
|-
 
|-
 
| {{text anchor|JUST_EMBARKED}}
 
| {{text anchor|JUST_EMBARKED}}
−
| Plays when [[embark|founding]] a new fortress.
+
| Plays when founding a new fortress.
 
|-
 
|-
 
| {{text anchor|SIEGE}}
 
| {{text anchor|SIEGE}}
Line 180: Line 176:
 
|-
 
|-
 
| {{text anchor|FIRST_CAVERN_OPENED}}
 
| {{text anchor|FIRST_CAVERN_OPENED}}
−
| A new cave layer is discovered {{verify}}
+
| A new cave layer is discovered [verify]
 
|-
 
|-
 
| {{text anchor|MEGABEAST_ATTACK}}
 
| {{text anchor|MEGABEAST_ATTACK}}
Line 198: Line 194:
 
|-
 
|-
 
| {{text anchor|LOST_FORT}}
 
| {{text anchor|LOST_FORT}}
−
| Ending a game: a fortress has just been [[Reclaim fortress mode|abandoned or retired]] or your [[adventurer]] has died.
+
| A fortress is abandoned or retired.
 
|}
 
|}
 +
  
 
== See Also==  
 
== See Also==  

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)

Templates used on this page:

This page is a member of 1 hidden category:

Retrieved from "https://dwarffortresswiki.org/index.php/Audio"