Updated CHANGES.md and added comments.

Author: DuFF14

OSVR-Unity/Assets/OSVRUnity/src/DisplayInterface.cs

@@ -36,15 +36,15 @@ namespace Unity
         /// </summary>
         public class DisplayInterface : MonoBehaviour
         {
-            const string HmdJsonFileName = "hmd.json";
+            const string HmdJsonFileName = "hmd.json"; //hardcoded filename of hmd config in Data folder
             private string _deviceDescriptorJson; //a string that is the JSON file to be parsed
             public TextAsset JsonDescriptorFile; //drop the json file into this slot in the Unity inspector
 
             public bool Initialized
             {
                 get { return _initialized; }
             }
-            private bool _initialized = false;
+            private bool _initialized = false; //flag set when _deviceDescriptorJson has data
 
             void Awake()
             {
@@ -67,11 +67,12 @@ void Awake()
                         _deviceDescriptorJson = ClientKit.instance.context.getStringParameter("/display"); //otherwise read from /display
                     }
                     _initialized = true;
-                }
-                    
-                
+                }                        
             }
 
+            //coroutine for loading an external json config file
+            //this could be more generic, but I'm not sure we will be loading external files
+            //this will eventually go away anyway when we get display config data from /display
             private IEnumerator LoadJsonFile(string filePath)
             {
                 WWW jsonFile = new WWW("file://"+filePath);
@@ -80,9 +81,6 @@ private IEnumerator LoadJsonFile(string filePath)
                 _deviceDescriptorJson = jsonFile.text;
             }
 
-
-            
-
             /// <summary>
             /// This function will parse the device parameters from a device descriptor json file.
             ///

OSVR-Unity/CHANGES.md

@@ -3,13 +3,16 @@
 This is an abbreviated changelog for the OSVR Unity Plugin.
 
 Use git for a full changelog.
-##Recent Changes (updated 18-March-2015)
-##Distortion (20-March-2015)
+##Recent Changes (updated 28-March-2015)
+##External Json File v0.1-56-gf2d8bab (20-March-2015)
+- The JSON file containing display configuration can now be read from a file at runtime. To do this, add a config file "hmd.json" to the _Data folder that is created in a build. The format of the JSON file has not changed at all. It is the same file you would drag-and-drop onto the DisplayInterface component on your VRDisplayTracked prefab. If "hmd.json" does not exist in the Data folder (and it won't by default unless you put it there), then the plugin will look for the JSON file assigned in the DisplayInterface component in your scene. If that also has not been assigned, it will fall back to reading OSVR's /display parameter (this will eventually be the default).
+
+##Distortion v0.1-55-g046c709(20-March-2015)
 - Unity 4 Free limitations. The new distortion shader will not work with Unity 4 Free version. It will work with Unity 4 Pro or Unity 5. If you are using Unity 4 Free, everything will still work but there won't be any distortion. This is due to the distortion shader using a render to texture pass.
 - Fixed Timestep was changed from 0.2 to 0.01667. This is how often FixedUpdate() gets called. The change should result in a more comfortable VR experience, but make sure it doesn't break any physics in your game.
 - Changed the default quality settings. Turned on 4x AA and disabled shadows.
 
-##Unity 5 Update (updated 18-March-2015)
+##Unity 5 Update v0.1-55-g046c709 (updated 18-March-2015)
 - Refactored VRHead.cs and VREye.cs to be Unity 5-friendly (mostly instances of "camera" that needed to become GetComponent<Camera>()). Upgrading from Unity 4 to Unity 5 should be seamless.
 - VRDisplayTracked.prefab has been updated to use the json descriptor file for the HDK by default. If you are using another HMD, be sure to set the corresponding json file on the VRDisplayTracked prefab's DisplayInterface script. 
 - Fixed issue with stereo overlap and roll for HMDs with multiple video inputs.