Issue1: Added RealmId to the config file format. Added a Version code as well that is now 1 for the current version. Older versions will start at 0, which is the default if the Version element is not present in the file. I also added a small flow that will update the existing config file to the new version and use default values for the new RealmId field (1). The readme has been updated to reflect the new version.

Author: kirby561

Config.json.example

@@ -1,8 +1,10 @@
 {
+	"Version": 1,
 	"MsPerRead": 5000,
 	"DataDirectory": "",
 	"MmrFilePath": "mmr.txt",
 	"RegionId": "US",
+	"RealmId": 1,
 	"ProfileId": 1986271,
 	"LadderId": 274006,
 	"ClientId": "GetThisFromTheBlizzardDeveloperApiSite",

README.md

@@ -8,14 +8,26 @@ It requires a Blizzard API key which you can get for free but will need to creat
 To get started, create a file called "Config.json" (or whatever you want) and copy the contents of "Config.json.example" into it.  
 Then change the settings to your preferences and put in your own ClientId and ClientSecret.  
 This is what the different settings are and how to set them:  
-* "MsPerRead": This is how often to ask for MMR updates in milliseconds.  I found that MMR typically takes 10 seconds or so anyway to be updated on Blizzard's server so this doesn't have to be too quick.
-* "DataDirectory": This is a directory to store temp files that the application needs.  It can be a path relative to the executable or an absolute path.  "" just means put the files in the same directory as the executable.
-* "MmrFilePath": This is a file path to put the MMR in.  If the file doesn't exist it is created.  If they file exists it is overwritten.  The path can be relative to the executable or an absolute path.
-* "RegionId": This is the region to use.  It can be "US", "EU", "KO" or "CN".
-* "ProfileId": This is the ID of the profile you want to get the MMR for.  You can find this by navigating to Starcraft2.com, log into your Blizzard account and click View Profile. The ProfileId will be the last number in the URL at the top.  For example: in "https://starcraft2.com/en-us/profile/1/1/1986271", the ProfileId is 1986271.
-* "LadderId": This is the ID of the particular Ladder you want the MMR for (since you have separate MMR for each race and for team games).  To find this, go to Ladders on the Blizzard account profile site mentioned above and click the ladder you would like to get the MMR for.  The LadderId will be the last number in the URL at the top.  For example: in "https://starcraft2.com/en-us/profile/1/1/1986271/ladders?ladderId=274006", the LadderId is 274006.
-* "ClientId": You will need to sign up for a Blizzard API key to get a ClientId and ClientSecret.  This will give you access to Blizzard's API for access to ladder information.  To do this, go to https://develop.battle.net/access and log in with your Blizzard account.  If you don't have an Authenticator set up, it will make you do this first.  Once you're logged in, create a new Client.  Click on the Client and it will tell you the ClientId and ClientSecret.  Just copy/paste them in.
-* "ClientSecret": See instructions for ClientId above.
+* **Version**  
+This identifies the version of the config file.  If any parameters are added, removed or changed this will be incremented.  Users don't have to change this unless they are manually upgrading to the next version.
+* **MsPerRead**  
+This is how often to ask for MMR updates in milliseconds.  I found that MMR typically takes 10 seconds or so anyway to be updated on Blizzard's server so this doesn't have to be too quick.
+* **DataDirectory**  
+This is a directory to store temp files that the application needs.  It can be a path relative to the executable or an absolute path.  "" just means put the files in the same directory as the executable.
+* **MmrFilePath**  
+This is a file path to put the MMR in.  If the file doesn't exist it is created.  If they file exists it is overwritten.  The path can be relative to the executable or an absolute path.
+* **RegionId**  
+This is the region to use.  It can be "US", "EU", "KO" or "CN".
+* **RealmId**  
+This is the realm ID of the profile and can be 1 or 2.  You can see what it is for your account by logging into your Blizzard account on Startcraft2.com, clicking View Profile and taking the number in the [RealmId] position in the URL: "ht<span>tps://starcraft2.com/en-us/profile/</span>[RegionId]/**[RealmId]**/...".  For example, the realm ID is "1" in the following URL: "ht<span>tps://starcraft2.com/en-us/profile/2/</span>**1**/1986271"
+* **ProfileId**  
+This is the ID of the profile you want to get the MMR for.  You can find this by navigating to Starcraft2.com, log into your Blizzard account and click View Profile. The ProfileId will be the last number in the URL at the top.  For example: in "https://starcraft2.com/en-us/profile/1/1/1986271", the ProfileId is 1986271.
+* **LadderId**  
+This is the ID of the particular Ladder you want the MMR for (since you have separate MMR for each race and for team games).  To find this, go to Ladders on the Blizzard account profile site mentioned above and click the ladder you would like to get the MMR for.  The LadderId will be the last number in the URL at the top.  For example: in "https://starcraft2.com/en-us/profile/1/1/1986271/ladders?ladderId=274006", the LadderId is 274006.
+* **ClientId**  
+You will need to sign up for a Blizzard API key to get a ClientId and ClientSecret.  This will give you access to Blizzard's API for access to ladder information.  To do this, go to https://develop.battle.net/access and log in with your Blizzard account.  If you don't have an Authenticator set up, it will make you do this first.  Once you're logged in, create a new Client.  Click on the Client and it will tell you the ClientId and ClientSecret.  Just copy/paste them in.
+* **ClientSecret**  
+See instructions for ClientId above.
 
 # Running
 To run the program, either double click on the exe or run this from command line:  

Sc2MmrReader/MmrReader.cs

@@ -8,7 +8,7 @@
 
 namespace Sc2MmrReader {
     /// <summary>
-    /// Reads the MMR of kirby every "msPerRead" milliseconds into the file at the given path.
+    /// Reads the MMR of the given profile every "MsPerRead" milliseconds into the file at the given path.
     /// </summary>
     public class MmrReader {
         /// <summary>
@@ -89,7 +89,7 @@ private void RefreshMmr() {
             // Build the URL
             String url = "https://us.api.blizzard.com/sc2/profile/";
             url += _regionIdMap[_configuration.RegionId] + "/";
-            url += "1/"; // Realm ID - not sure what this is in SC2
+            url += _configuration.RealmId + "/";
             url += _configuration.ProfileId + "/";
             url += "ladder/";
             url += _configuration.LadderId;
@@ -107,6 +107,13 @@ private void RefreshMmr() {
                 if (ex.InnerException != null) {
                     Console.WriteLine("\tInnerException: " + ex.InnerException.Message);
                 }
+
+                // Since we had an exception, try refreshing the Auth token as well.
+                try {
+                    File.Delete(_accessCacheFile);
+                } catch (Exception deleteEx) {
+                    Console.WriteLine("After a response error, could not delete the access cache file: " + deleteEx.Message);
+                }
             }
 
             if (succeeded) {

Sc2MmrReader/Program.cs

@@ -36,6 +36,48 @@ private static ReaderConfig ReadConfigFile(String path) {
             return configFile;
         }
 
+        /// <summary>
+        /// Saves the given config file to the given path.
+        /// </summary>
+        /// <param name="config">The config to write.</param>
+        /// <param name="path">The path to save the config file to</param>
+        /// <returns>Returns true if it succeeded, false if there was an error.</returns>
+        private static bool SaveConfigFile(ReaderConfig config, String path) {
+            JavaScriptSerializer serializer = new JavaScriptSerializer();
+            String configString = null;
+            try {
+                configString = serializer.Serialize(config);
+            } catch (Exception ex) {
+                Console.WriteLine("Could not serialize the given config.");
+                Console.WriteLine("Exception: " + ex.Message);
+                if (ex.InnerException != null) {
+                    Console.WriteLine("Inner Exception: " + ex.InnerException.Message);
+                }
+
+                return false;
+            }
+
+            // Do a poor mans prettify since JavaScriptSerializer doesn't support
+            //    formatting the output.  This could be improved by using an actual library like JSON.net
+            configString = configString.Insert(configString.IndexOf("{") + 1, Environment.NewLine + "\t");
+            configString = configString.Insert(configString.LastIndexOf("}"), Environment.NewLine);
+            configString = configString.Replace("\":", "\": ");
+            configString = configString.Replace(",\"", "," + Environment.NewLine + "\t\"");
+
+            // Write it to a file
+            try {
+                File.WriteAllText(path, configString);
+            } catch (Exception ex) {
+                Console.WriteLine("Could not write the config file to " + path);
+                Console.WriteLine("Exception: " + ex.Message);
+                if (ex.InnerException != null) {
+                    Console.WriteLine("Inner Exception: " + ex.InnerException.Message);
+                }
+            }   
+
+            return true;
+        }
+
         /// <summary>
         /// Application entry point.  Reads the config file and starts the MmrReader.
         /// </summary>
@@ -54,6 +96,47 @@ public static void Main(string[] args) {
             ReaderConfig config = ReadConfigFile(configFilePath);
             if (config == null) {
                 Console.WriteLine("There was a problem reading the config file.");
+                Console.WriteLine("Press any key to exit.");
+                Console.ReadKey();
+                return;
+            }
+
+            // Check the version of the config file
+            if (config.Version < ReaderConfig.ReaderConfigVersion) {
+                Console.WriteLine("The specified config file is an older version.  See Config.json.example for the current format.");
+                Console.WriteLine("Would you like Sc2MmrReader to attempt to upgrade to the new format?  New parameters will get default values.");
+
+                String response = "";
+                while (response != "yes" && response != "no") {
+                    Console.WriteLine("Enter yes or no:");
+                    response = Console.ReadLine();
+                }
+                
+                // Just quit if they said no.  They can set the config settings themselves.
+                if (response == "no") {
+                    return;
+                }
+
+                // Otherwise update the config file
+                config.Version = ReaderConfig.ReaderConfigVersion;
+                if (SaveConfigFile(config, configFilePath)) {
+                    Console.WriteLine("The config file has been updated.  Please check that the settings are correct and then restart Sc2MmrReader.  The path is:");
+                    Console.WriteLine("\t" + configFilePath);
+                    Console.WriteLine("Press any key to exit.");
+                    Console.ReadKey();
+                    return;
+                } else {
+                    Console.WriteLine("There was a problem saving the config file.  Please update it manually.");
+                    Console.WriteLine("Press any key to exit.");
+                    Console.ReadKey();
+                    return;
+                }
+                
+            } else if (config.Version > ReaderConfig.ReaderConfigVersion) {
+                // If it's too new, tell them to update
+                Console.WriteLine("The specified config file version is for a new version of Sc2MmrReader.  Please update to the latest version or downgrade your config file to version " + ReaderConfig.ReaderConfigVersion);
+                Console.WriteLine("Press any key to exit.");
+                Console.ReadKey();
                 return;
             }
 

Sc2MmrReader/ReaderConfig.cs

@@ -6,6 +6,32 @@ namespace Sc2MmrReader {
     /// deserialized into it.  So if you rename or change parameters here, you must upgrade the config file format as well.
     /// </summary>
     public class ReaderConfig {
+        // This is the current version and should always be incremented when changing the config file format.
+        public static int ReaderConfigVersion = 1;  
+
+        // Version
+        public int Version { get; set; } = 0;          // This identifies the version of the config file.  If it's not set it will be at 0.
+
+        // Config settings:
+        public long MsPerRead { get; set; }            // How many milliseconds inbetween reads
+        public String DataDirectory { get; set; }      // Where to store cached files
+        public String MmrFilePath { get; set; }        // Where to output the MMR to
+
+        // Information about the account to get the MMR for:
+        public String RegionId { get; set; }       // Can be "US", "EU", "KO" or "CN"
+        public int RealmId { get; set; } = 1;      // Can be 1 or 2.  You get this from the link below ".../profile/<regionId>/<realmId>/...". This defaults to 1 for backwards compatibility.
+        public long ProfileId { get; set; }        // Example: https://starcraft2.com/en-us/profile/1/1/1986271/ladders?ladderId=274006, profile ID is 1986271
+        public long LadderId { get; set; }         // In the above link, the LadderId is 274006
+
+        // Information about who is connecting:
+        public String ClientId { get; set; }       // Get this by making a developer account for the Blizzard API.
+        public String ClientSecret { get; set; }   // Same as above.
+    }
+
+    // Keep track of old config versions in case we want to be
+    //    able to update old versions in a smarter way.
+    #region OldConfigVersions
+    public class ReaderConfigV0 {
         // Config settings:
         public long MsPerRead { get; set; }            // How many milliseconds inbetween reads
         public String DataDirectory { get; set; }      // Where to store cached files
@@ -20,4 +46,5 @@ public class ReaderConfig {
         public String ClientId { get; set; }       // Get this by making a developer account for the Blizzard API.
         public String ClientSecret { get; set; }   // Same as above.
     }
+    #endregion
 }

Sc2MmrReader/Sc2MmrReader.csproj

@@ -50,5 +50,16 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="ReaderConfig.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="Config.json.example">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="LICENSE">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="README.md">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>