Skip to content

Ultrastar txt documentation

randompersona1 edited this page Aug 13, 2024 · 2 revisions

Ultrastar Format

For a better overview, see here: Official Ultrastar Format For the complete formal format, see here: Ultrastar Spec

As a brief overview:

Header

Contains tags like "#TITLE", "#ARTIST", or "#AUDIO". Some tags contain file paths, e.g to cover images or audio files; others just text. Example:

#VERSION:1.1.0
#TITLE:a_title
#ARTIST:some_artist
#LANGUAGE:English
#YEAR:1999
#CREATOR:me
#MP3:some_artist - a_title.mp3
#COVER:some_artist - a_title [CO].jpg
#VIDEO:some_artist - a_title.mp4
#BPM:288

Body

Contains the notes for the song. A note contains information about type, start beat, duration, pitch and text. Example note:

: 28 2 0 Have

Explanation: : Regular note. * would be golden note, R would be rap note. 28 Start beat. This note begins 28 beats from the start of the song. Refer to #BPM in the header 2 This note lasts for two beats. 0 Pitch. Measured in half-steps from C4. 2 would be D4, -2 would be A#3 Have This is the text that is shown for that note. If the text is not followed by a space, the next text will be directly attached

The body ends with a single "E"