Name template engine

The replay auto-save feature and manual renaming can name replays based on a name template.

The name template is a string which may contain any texts and special symbols. Symbols will be substituted with dynamic texts and values taken from the replay. Some symbols have parameters. For example the player name symbol has a parameter: the player index whose name to be substituted.

The template editor component contains buttons for symbols to insert them into the name template (to the position of the cursor) and a short description of the symbol. Symbols are grouped into tabs.

Google Ads

Player info block

The Player info block is a special symbol: it has an opening and closing part (< and >) and some other symbols can be used inside of it without the player index parameter. When applying the name template on a replay, the template engine will iterate over all players of the replay and insert them to the position of the player info block, grouped by teams.

For example the template "</p (/r)>" may result in "Joe (T) vs Brad (Z)" in case of an 1v1 replay, and may result in "Joe (T), Brad (Z) vs Lisa (T), John (P)" in case of 2v2. An expected result in case of FFA (Free For All) game may be: "Joe (T) vs Brad (Z) vs Lisa (T) vs John (P)".

Sub-folders

The template engine supports sub-folders. This means that applying a name template on replays can categorize the replays into sub-folders. Sub-folders are separated with the backslash ("\") character symbol in the template.

The sub-folder support means the replay auto-save and manual renaming can group your files into different sub-folders, but you can still only define 1 name template.

So let's say you want your replays named like "{date+time} {match-up} - {player1 (race1), player2 (race2)... vs playerx (racex), playery (racey)...} on {map}.SC2Replay".

Example: 2010-11-09 08-30 TZvPP - Joe (T), Lisa (Z) vs John (P), Brad (P) on Lost Temple.SC2Replay

It can be achieved with a template of:

/D /T - </p (/r)> on /m./e

The player block <> will insert all players in the replay, so if it's a 1v1, 2 players will be inserted, if it's a 3v3 for example, 6 players will be inserted grouped by teams.

Now let's say you want your replays categorized as the game format: put 1v1 replays into a "1v1" folder, put 2v2 replays into a "2v2" folder, free for all replays into a "FFA" forder etc.

All you have to do is insert "/f\" into the beginning of the previous template:

/f\/D /T - </p (/r)> on /m./e

If you want your previous template to categorize replays into sub-folders based on the match-up: prepend the template with "/T\":

/T\/D /T - </p (/r)> on /m./e

If you want your replays categorized into sub-folders based on the map AND into sub-folders based on game type INSIDE the map folders, start with this: "/m\/f\"

/m\/f\/D /T - </p (/r)> on /m./e