BWCoach features : Training file format

Training files are simple text files organised in sections. A section starts with a section name in square brackets:

[section name]

Sections contain entries, on entry per line with following format:

entry name = entry value

MAIN Section

Every training file contains a [MAIN] section with general information :

[MAIN]
TITLE=Lost Temple
AUTHOR=Various
DESCRIPTION=Standard builds for Lost Temple
DATE=05/03/2004

Warning: All entries must be on one line only, that includes the DESCRIPTION.

Build Order Section

After the [MAIN] section are the build orders sections. The section name is the build order name. Each build order contains a matchup entry to specify for which matchup the build order is valid and then a list of actions ordered by time. For example:

[Metal]
MATCHUP=TvZ
AUTHOR=Hurtntime
DESCRIPTION=Metal build with fast wraith for overlord harassment
DATE=05/03/2004
AT=00:15,Good luck !, good_luck.wav
AT=00:59,Build Supply Depot[34]
AT=01:20,Scout now !
AT=01:35,Build Barracks[68]
AT=01:48,Build Refinery[34]
AT=02:21,Build Supply Depot[34]
AT=02:27,Train Marine[20]

The MATCHUP entry should always be something like XvX where X is T,Z,P or * (* if race doesnt matter).

AT entry

Actions are defined like this:

AT=time, message, sound file name

The time should always have one the following two formats:

MM:SS  where MM are minutes on 2 digits, SS are seconds on 2 digits

MM:SS+mm:ss  where mm are minutes on 2 digits, ss are seconds on 2 digits

The MM:SS+mm:ss format means: first action will occur at MM:SS and then repeat every mm:ss. Can be useful for recurring actions like "Make SCVs", "Scout map", etc.

The message can be a simple string (keep it short and dont use commas) for an action that doesnt need any feedback with F9. For example:

AT=00:15,Good Luck!

For actions that require the player to press F9 when he performs the action, the action duration (in seconds) should be added at the end of the message between square brackets. For example:

AT=00:59,Build Supply Depot[34]     means "Build a depot at 00:59 and press F9 when done. 
                                    The construction of a depot takes 34 seconds."

The last parameter is optionnal. It is the name of a sound file contained in the /sounds folder. If an extension is missing, the ".wav" extension is added automatically. That message will be played when the action is triggered.

COMMON section

The [COMMON] section is like a build order section but it contains actions that will be triggered whatever build order you select. There can be multiple [COMMON] sections for various matchups. For example:

[COMMON]
MATCHUP=*v*
AT=07:00, Time to expand?
AT=08:30+01:00, Scout...
AT=10:00+02:00, Make units...
AT=30:00,Hey, not dead yet?

[COMMON]
MATCHUP=Pv*
AT=15:00, Time for Carriers?

STRATEGY section

[STRATEGY]
<h1>Title</h1>
Here you can write some HTML code (or plain text) to fully describe the 
build orders you have in your training file.

Complete training file sample here.

Other topics : Introduction, Alerts, Coaching, In game, Exporting a replay, Training file format, Download