User:Sting the Cat/Sound Test Tutorial

From SRB2 Wiki
Jump to navigation Jump to search
To do
  • Make this a little more tutorial-like?
  • Add links to other relevant tutorials

First off, the default Sound Test is located within music.dta, in the lump MUSICDEF. In this lump, each entry in the Sound Test, which will appear in the order they are listed, is defined as such

Lump _NTIME
Title = Dream_over...
Alttitle = Time_Up_(JINGLE)
Authors = Naofumi_Hataya_(NiGHTS_into_dreams...)
Soundtestpage = 1
Soundtestcond = -11
Stoppingtime = 11.709
BPM = 90
  • Lump: the name of the lump, minus the O_ prefix. For the example, O__NTIME (two underscores there, by the way) is the lump name in music.dta of the time up jingle for NiGHTS
  • Title: This is the name that will appear in the list for the Sound Test and in the scrolling title by default. Be careful not to make this too long, or it will go outside the box
  • Alttitle: Use this to add alternative names to the scrolling text while playing the song. This is useful if a track is used in multiple places or if you wish to refer to it by both title and use (such as the above, where "Dream_over..." is the name of the song, but "Time_Up_(JINGLE)" is used as well to clarify its use
  • Authors: this text appears underneath the scrolling text while a song is playing, and is typically used to credit those who worked on it.
  • Soundtestpage: The Sound Test entry this song is found in. All the entries in the default Sound Test have a 1 here, but you could have multiple Sound Tests with different songs.
  • Soundtestcond: This denotes the condition that must be filled to unlock this entry within the Sound Test. If you wish to have it appear only after beating a certain map, use the map number. If you instead desire for the entry to unlock upon fulfilling a condition, use the number of the conditionset and make it negative. For our example, in vanilla, conditionset 11 is fulfilled by completing Special Stage 1 at least once. If you wish to make the entry unlocked by default, simply use 0. Please consult the Unlockables Tutorial for information on how to set up conditions. NOTE:No matter what the condition is, you must still unlock Sound Test in order to view it.
  • Stoppingtime: This denotes the time before the song automatically stops playing and deselects. Use this for jingles. If you omit this, the song will continue looping indefinitely.
  • BPM: denotes the speed of the song so that the boombox in the Sound Test can move in the beat