(info) Most of the information here is for Warzone 3.1 and above.

Defining a Campaign

Each campaign must have an associated .ini file...

 

File Format

The standard .ini file format is used.

The name of the file can be anything you want, so long as it's unique and ends in .ini. When the list of campaigns is displayed, Warzone searches the campaigns folder for .ini files, treating each .ini file as a separate campaign.

An example is shown below:

[campaign]
name = "Alpha Campaign"
level = "CAM_1A"

[intro]
video = "cam1/c001.ogg"
captions = "cam1/c001.txa"

There are two sections in the file...

[campaign] section

This section must always be included.

Property nameData typeRequiredDescriptionGame Version
nameString(tick)

The name of the campaign as a quoted string.

This will be displayed in the menu system when users choose which campaign to play.

3.2
levelString(tick)

The first level in the campaign as a quoted string.

When a player starts a new campaign, this is the first mission they will play.

(question) This links to a file defining the level, its format may change in future so I'm waiting to learn more before providing additional details.

3.2

[intro] section

This section is optional, and can be used to play an intro video when the player starts the campaign.

Property nameData typeRequiredDescriptionGame Version
videoString(tick)

The path and filename of the video to play.

The path is relative to the data/base/ folder.

You can find a list of existing videos in the Video Directory.

3.2
captionsString(tick)

The path and filename of the captions file associated with the video.

The path is relative to the data/base/ folder.

(warning) Note, there can be two captions files associated with a video so it's likely this property will change prior to release.

3.2
There is currently a limit of 6 campaigns being listed in the user interface. If more than 6 campaigns are present, only the first 6 will be listed.
Availability 3.2+

Requires:

  • Warzone 3.2+

File location

The campaigns that come with Warzone are located here:

base.wz or base

campaigns

<filename>.ini

If you want to define a custom campaign in your mod, it should be here:

<your mod>.wz or <your mod>

campaigns don't forget this!

  <filename>.ini