Skip to content

Content:Music Definition File

dekarrin edited this page Feb 21, 2013 · 3 revisions

A music definition file is a DEF file that maps music indexes with music files. Once defined, the music indexes may be referred to from any field that requires an music definition.

Every content pack contains at most one music definition file. A content pack must include a music definition file if it contains music files that are to be referred to from other files in the content pack (that is to say, if it has music files that are to be used at all). If a content pack is to include a music definition file, it must list the path to it under the key MUSIC_DEFS_FILE in its Content:Manifest File. It must also list the directory that images are stored in under the MUSIC_DIR key in the manifest.

Each row maps one music index to one key.

Row Format

Column Name Value Description
1 Index The index to map the music file to.
2 File The music file to be mapped. This path is relative to the path MUSIC_DIR in the manifest.

Example File

"BGM_BATTLE",     "insidia.mp3"
"BGM_OVERWORLD",  "treacherousslopes.mp3"

Provided Music

There are several index-to-file mappings provided by the built-in content pack. Note that the listed files are relative to the path listed under MUSIC_DIR in the built-in manifest file.

All given music indexes are used by the engine internally. External content packs can re-define the indexes, but there is no point in adding new indexes.

Index File
BGM_MAIN_MENU worldmap.mp3
BGM_BATTLE insidia.mp3
BGM_OVERWORLD treacherousslopes.mp3