🗒️TXT file format
How the song's data is stored in a file?
Overview
All information about the song - both the metadata (artist, title, bpm, gap etc.) and the actual transcription of the vocal line - are defined in one txt file.
The txt file consists of:
list of tags,
one or more encoded vocal tracks consisting of:
one or more encoded notes separated by line breaks,
end of song symbol.
Metadata
Metadata is written in the form of tags. Tags are written one per line in the following format:
e.g.
You can find the list of standard tags with their definitions here.
Vocal line transcription
Note format
Each note is written in a single line - as a list of its properties separated by spaces:
e.g.
Note types
| Note type | Symbol | Description |
|---|---|---|
Standard | : | Standard note, pitch is assessed while singing. |
Golden | * | Same as standard but worth more points. |
Freestyle | F | Neither timing nor pitches are assessed. Not singable, only lyrics are displayed. |
Rap | R | Only timing is assessed, every pitch is treated as valid. |
Golden rap | G | Same as rap but worth more points. |
Start beat
When the note should start defined in beats. Beat length in milliseconds is determined from BPM value.
Duration
Duration of the note defined in beats.
Pitch
Pitch is encoded as a number from -60 to 67 range where 0 represents middle C (C4). The numbers are assigned sequentially and increase together with the pitch height so:
Lyrics
Lyrics assigned to this note (usually single syllable). The spaces dividing the words can be either placed before the first syllable of the new word (as long as it is not the first word in the line) or after the last syllable of the previous word (apart from the final word in the line). Both approaches are equally OK, just do not mix both in one file.
Karedi uses spaces before words approach while saving. If you want to use spaces after words, it can be changed in the preferences.
Line breaks format
Line breaks separate groups of notes that should be displayed at the same time - as a single phrase for the player to sing. Each line break defines the moment (in beats) in which the following line of the song should be displayed.
Format:
e.g.
Track format
Each track consists of a chronological list of notes separated by line breaks. If the song has multiple tracks, the player number header should be used before each track.
If your song has a single track, skip the player header.
Header format:
e.g
Example
Single-player
Duet:
Last updated