Skip to content
OpenTS Manual

THEME.INI

Formats

Changed in 0.2.0

Registers music track IDs and each track's playlist settings.

Format
Kind
Configuration file
Filename
THEME.INI, THEME01.INI

The game reads THEME.INI and THEME01.INI once at startup and builds the track list from them. Whether Firestorm is installed does not matter: each file that is present is read, and either one alone is enough. When neither can be read, the game shows an initialization error and closes. OPENTS.INI can change both file names.

[Themes] values register track IDs. Each ID names the track’s section and, unless the section sets Sound=, the base name of its music file. The text to the left of the = is only a label, and the list keeps the order the entries are read in. An ID listed twice appears once, at its first position. Music explains how that order and each track’s settings decide what plays.

The [General] section holds the settings that apply to every track: the fade and crossfade times, and the music level under an ion storm’s sound.

THEME.INI
[Themes]
0=MYTHEME


[MYTHEME]
Name=Example theme
Length=3.27
Normal=yes

The two files are combined as if they were one file, with THEME01.INI read second. A key that both files set, in the same section, takes the value from THEME01.INI. A track section present in both files takes each key from THEME01.INI when that file sets it, and from THEME.INI otherwise.

Give the [Themes] entries in THEME01.INI labels that THEME.INI does not use. A reused label replaces the THEME.INI entry with that label. The new ID is placed among the THEME01.INI entries in the order that file lists them, and the replaced ID is no longer a track unless another label lists it.

Accepted settings

12 of 12

KeyDescriptionValueWhen omitted
CrossFade[General]floating point0
FadeOut[General]floating point1.5
IonStormVolume[General]string0.33
Length[<Theme ID>]The playing time the sound options screen shows for a music track whose file does not state its own length.floating point0
Name[<Theme ID>]The display name of a type definition, a scenario, a multiplayer map, or a music track.string(empty)
Normal[<Theme ID>]Offers the music track to the playlist the game picks from automatically.booleanyes
Repeat[<Theme ID>]Makes the music track start again when it ends instead of handing over to the next one.booleanno
RequiredAddon[<Theme ID>]The expansion a campaign belongs to, or the expansion a music track needs.integer0
Scenario[<Theme ID>]The mission a campaign opens with, or the mission number from which a music track may be picked.integer0
Side[<Theme ID>]The side a country or a music track belongs to, or the country last chosen for multiplayer games.string<none>
Sound[<Theme ID>]stringComputed
Volume[<Theme ID>]The share of full loudness a sound effect or a music track is played at.string1.0

Source files

Linked at revision 51b52aa38392.

History

  1. Changed0.2.0In development

    Name the deployment's own files in OPENTS.INI

  2. Changed0.2.0In development

    Play music tracks from WAV, OGG, FLAC and MP3 files, and set each track's file and loudness

  3. Changed0.2.0In development

    Read the base and expansion sound and theme files together