SC2Mapster

Config File Overview

SC2 Map Analyzer uses .txt config files to control a wide range of parameters for analysis. Config files are organized into local and global copies to allow you more control over the analysis.

Global Config Files

Global config files are placed in the same directory as the analyzer executable. These files configure the analysis of each analyzed map unless a local version overrides the parameters.

• to-analyze.txt (global-only, will be ignored at the local level)
• output.txt
• constants.txt
• footprint.txt
• colors.txt
• locales.txt

Local Config Files

Local config files look just like global config files, but you put them in the same directory as a map to customize some settings for that map. For instance, you might use output.txt to only generate a specific output image for one map, while a local output.txt in another directory turns on all output for the maps there.

• output.txt
• constants.txt
• footprint.txt
• colors.txt
• locales.txt

Comments

All config files use the # character as a comment, anything else after it on a line is ignored.

"constants.txt:"

# here's a comment
xyz = 1.4 # this is a comment
# abc = 2    <-- this whole line is commented out

Config File Descriptions

to-analyze.txt

This file is only recognized globally (must be in same directory as the analyzer executable). It lists all the directories and/or specific map files the analyzer should analyze. Using "r" you tell the analyzer to recursively check a directory, going into all subdirectories.

"to-analyze.txt:"

C:/mydir/maps  # a directory of maps that will be analyzed
C:/anotherdir/someting/yo.SC2Map  # a particular map to analyze
r C:/somedir/another  # a directory that will be recursively explored for maps

output.txt

This config file selects which output files to generate. Here is an example that enables all possible outputs, and uses the output path feature: if the output path is set, all output files are sent to the output directory.

"output.txt:"

renderTerrain
renderPathing   
renderBases     
renderOpenness  
renderShortest  
renderInfluence 
renderSummary   
writeCSVpermap
writeCSVaggr    

# Set this path to have ALL OUTPUT of the analyzer be thrown
# into a common directory.
path=C:\A-PATH\sc2mapanalyzer-output

To disable outputs, simply comment them out with a '#' at the beginning of the line, rather than deleting the line, for easy toggling.

Note: the "writeCSVaggr" option to write a CSV to aggregate stats for all maps analyzed only has meaning at the global level. It will simply be ignored in a local output.txt.

constants.txt

Use this file to alter analysis constants. Each line should declare one constant value,

dodad=123

footprints.txt

Footprints are the shape of objects and doodads that block unit pathing. This information is not embedded in every map file, so the analyzer needs this config file to know how the placed objects affect the map's pathing. There is page explaining the footprint.txt config file in detail.

locales.txt

Specifies the preferred order of localizations when there are more than one present in the map. All locales should already be in locales.txt so all you need to do is reorder them to your preferences.

colors.txt

This config file is not yet supported.