Skip to main content

song.ini Guide

This is an abbreviated version of grishhung's Comprehensive song.ini Guide. 
A blank song.ini template can be downloaded here. Alternatively, you can copy one from any working song and change its info.

What is the song.ini file?

The song.ini file stores all of a chart’s metadata (things like the song name, charter name, release year, instrument difficulties, loading phrases, and more). A song.ini must be included in the chart folder in order for a chart’s information to be properly displayed in game.

Mandatory Tags

These tags are required for a song to appear in-game.

  • [Song]
    The first tag that must be at the top of the song.ini, do not edit it.

  • name
    The name of the song. 

Optional Tags

The game will be able to scan the song without these tags, but they can be displayed at the song list and be used for sorting purposes.

  • artist
    The song's artist.
  • album
    The song's album.

  • genre
    The song's genre.

  • year
    The song's release year.

  • album_track
    The song's position on an album. The position will be used when sorting the in-game song list by Album.

  • playlist_track
    The song's position in a playlist (folder). The position will be used when sorting the in-game song list by Playlist.

  • charter
    Author of the chart. An older frets tag can also be used instead of this one.

  • icon
    The icon that will be shown in the bottom corner of the album art at the song list. See the Custom Content guide if you want to set up a custom one.

  • diff_guitar
    An intensity number for the Lead Guitar track that will be displayed at the song list.

  • diff_rhythm
    An intensity number for the Rhythm Guitar track that will be displayed at the song list.

  • diff_bass
    An intensity number for the Bass Guitar track that will be displayed at the song list.

  • diff_guitar_coop
    An intensity number for the Co-op Guitar track that will be displayed at the song list.

  • diff_drums
    An intensity number for the Drums track that will be displayed at the song list.

  • diff_drums_real
    An intensity number for the Pro Drums track that will be displayed at the song list.

  • diff_guitarghl
    An intensity number for the 6-Fret Guitar track that will be displayed at the song list.

  • diff_bassghl
    An intensity number for the 6-Fret Bass Guitar track that will be displayed at the song list.

  • diff_rhythm_ghl 
    An intensity number for the 6-Fret Rhythm Guitar track that will be displayed at the song list.

  • diff_guitar_coop_ghl
    An intensity number for the 6-Fret Co-op Guitar track that will be displayed at the song list.

  • diff_keys
    An intensity number for the Keys track that will be displayed at the song list.

  • song_length
    The length of the song in milliseconds. If the tag isn't present or is empty, it will be automatically generated by the game based on the audio file. Entering the value manually is not recommended.

  • preview_start_time
    The point at which the audio will start playing while the song is highlighted in the song list. The value is in milliseconds, and the preview lasts a total of 30 seconds. You can also include a preview audio file in the folder which doesn't have this limit and will overwrite the value.

  • video_start_time
    The point at which the song's video background will begin, if it has one. See the Custom Content guide for more info.

  • modchart
    Indicates whether the song is a modchart. Used when sorting the song list.

  • loading_phrase
    A piece of text that will appear at the top of the instrument selection screen when you pick the song. It supports rich text formatting such as <br>.

  • delay
    An old tag that could be used to realign the audio and the note track. Positive numbers will make the chart start later, while negative numbers will make it start sooner. Nowadays, it exists for legacy purposes. Using it is not recommended and might break the audio alignment.
Back to top