Header
At the top of every UltraStar Deluxe Song text file there is the header. In the header there are the main information about the song. For example the song's title and artist name which are displayed in UltraStar Deluxe.
| Tag | Required | Description |
|---|---|---|
| #TITLE:<SONG TITLE> |  | After the colon you can add the song title of the song which will be shown in UltraStar Deluxe. |
| #ARTIST:<ARTIST NAME> | | UltraStar Deluxe will read in the Artist name that you can type after the colon sign. |
| #MP3:<ARTIST-TITLE.MP3> | | Here you must fill in the complete (with ending .mp3) and correct file name of the mp3 file. |
| #BPM:<BEATSPERMINUTE> | | These are the emphasized beats per minute. Changing this value will affect the speed of the song. The more beats the faster the song will go on. |
| #GAP:<MILLISECONDS> | | This is the pause in milliseconds from the start of the song to the first note of the lyrics. |
| #COVER:<COVER.JPG> |  | JPG or PNG file of the song's album or single cover that is displayed during song selection. |
| #BACKGROUND:<IMG.JPG> | | Image that is displayed in the background while you are singing the song. |
| #GENRE:<GENRE> | | Enter the genre of your song (e.g. Pop, Rock, etc.). (recommended for sorting) |
| #RELATIVE:<YES/NO> |  | This shows how the txt-file is written. If this tag is set to “yes”, the start of the notes is counted from zero in every line. If this tag is not available or set to “no”, the start of the notes is counted continuous from the beginning to the end of the txt-file. |
| #EDITION:<EDITION> | | Here you can enter the edition the song belongs to (e.g. Singstar Rocks!). You can use this tag to sort your songs. |
| #LANGUAGE:<LANGUAGE> | | Set the language of the song (e.g. German, English, etc.). |
| #VIDEO:<VIDEO.*> | | Adds a music video in the background while singing. Can be any format (.avi, .mpg, .flv, etc.). |
| #VIDEOGAP:<SECONDS> | | Skips seconds at the beginning of the music video. You can also use negative videogaps on condition that you set the #START tag. |
| #START:<SECONDS> | | The disadvantage is that the #START gap will skip the seconds (which are set) from the mp3 file. |
Body
Under the header there are the important information about the song and the notes.
Here is a part from a txt-file:
| Position | ||||
|---|---|---|---|---|
| 1 | 2 | 3 | 4 | 5 |
| : | 0 | 2 | 57 | This |
| : | 2 | 2 | 58 | is |
| F | 4 | 6 | 50 | an |
| * | 10 | 2 | 55 | exam |
| * | 12 | 4 | 57 | ple |
| - | 18 | 20 | ||
| E | ||||
Position 1: Type of Note
The colon, star or F in front of the other information shows which kind of note this is. Valid values are the colon sign, the *-sign and the letter “F”.
| Sign | Meaning |
|---|---|
| : | normal note |
| * | golden note |
| F | freestyle note |
| - | line break |
| E | end of file |
Position 2: Start of a Note
If star or colon sign is at Position 1: It means the start of a new note (0 is the first note directly at the gap). If minus sign at Position 1: It means the time where the line break occurs. The start depends on header RELATIVE set at the beginning of the txt-file.
Position 3: Tone Length
If star or colon sign is at Position 1: The number of beats a tone lasts (tone length). If minus sign at Position 1: It’s a special case of a line break. There will be two numbers, one at Position 2 and the other one at Position 3. The first number (Position 2) then means the time when the current song line disappears from the screen. The second number (Position 3) stands for the time when the next song line fades in.
Position 4: Tone Pitch
There can only be a star, a colon sign or the letter “F” at Position 1 because this is the tone pitch. “0” means C1.
Position 5: Lyrics
These are the syllables of the lyrics that will later be displayed in UltraStar Deluxe. If the syllables belong together, there must not be a space (e.g. above: example). If the syllables do not belong together, there must be a space in front of them (e.g. above: is, an).
