Skip to content
OpenTS Manual

RequiredAddon

Changed in 0.2.0

The expansion a campaign belongs to, or the expansion a music track needs.

Case-sensitive spelling

INI keys distinguish uppercase and lowercase letters. RequiredAddOn is a different setting.

Campaign expansion

Specification — Campaign expansion
Applies to
Campaign
File
BATTLE*.INI
Section
[<Campaign ID>]
Value
integer
When omitted
0

0 marks a base-game campaign and 1 a Firestorm campaign. The mission list shows base-game campaigns only while no expansion is running, and Firestorm campaigns only while Firestorm is running, so the two sets never appear together.

-1 shows the campaign whenever any expansion is running. Any other number matches no expansion, so the campaign never appears in the list.

Track expansion

Specification — Track expansion
Applies to
Themes
File
THEME.INI + THEME01.INI
Section
[<Theme ID>]
Value
integer
When omitted
0No expansion is needed, so the track can play in the base game and in every expansion.

RequiredAddon=1 makes the music track a Firestorm track: the game chooses it for the playlist, and lists it on the sound options screen, only while Firestorm is running. -1 allows the track while any expansion is running. 0 places no restriction.

theme01.ini
[MYTHEME]
Name=Example theme
RequiredAddon=1

Any other number names no expansion, so the track is never chosen. The restriction applies to the playlist, the sound options list, and the next track and previous track commands. A track that the game or a map starts by name, such as a scenario’s Theme= track or a Play music theme trigger action, plays whatever expansion is running.

See also — Description, Scenario, Normal, Side

History

  1. Changed0.2.0In development

    Hide campaigns whose expansion number matches no expansion — campaign

  2. Added0.2.0In development

    Limit a music track to several sides or to an expansion — themes