Music.ini (Config pack)

From PGE Wiki
Jump to: navigation, search


music.ini - Defining a list of available music

Config pack wide variant

The config pack wide global list of default musics.

[ music-main ]
Parameter Allowed values Example value Description
total-world >=1 total-world = 16 Total number of world map music
total-level >=1 total-level = 56 Total number of level music
total-special >=1 total-special = 3 Total of special musics which using for special events and is not available to playback by standard methods
level-custom-music-id >=0 level-custom-music-id = 24 ID which will used as "custom music".
world-custom-music-id >=0 world-custom-music-id = 17 ID which will used as "custom music" on the world map.

Settings of each World map music (Where '*' - should be a MUSIC-ID from 1 to total number of World map musics)
You should define settings for all allocated MUSIC-ID range!

[ world-music-* ]
Parameter Allowed values Example value Description
name string name = "Jazz for everything" Title of music
file string file = "jazz-for-everything.ogg" Music file which connected to this ID slot

Settings of each level music (Where '*' - should be a MUSIC-ID from 1 to total number of level musics)
You should define settings for all allocated MUSIC-ID range!

[ level-music-* ]
Parameter Allowed values Example value Description
name string name = "Rock'n'roll!" Title of music
file string file = "rock-n-roll.ogg" Music file which connected to this ID slot

Settings of each special music (Where '*' - should be a MUSIC-ID from 1 to total number of special musics)
You should define settings for all allocated MUSIC-ID range!

[ special-music-* ]
Parameter Allowed values Example value Description
name string name = "tick-tack, go-go!" Title of music
file string file = "tick-tack.ogg" Music file which connected to this ID slot

Episode / Level custom variant

Allows to override config pack wide settings with custom musics inside of episode (when music.ini was created in the episode root directory) or specific level (when music.ini was created in the level specific custom resources directory). Unlike config pack wide variant, custom music config doesn't needs the "music-main" section and even doesn't requires to specify full list of available music IDs. Instead, you can define a minor set of musics you want to override.