Add documentation

Author: dani0105

ModLoader/IO/Console.cs

@@ -6,17 +6,30 @@
 
 namespace ModLoader.IO
 {
-
+	/// <summary>
+	/// This is the mod loader console. It is used for debugging and displaying errors.
+	/// </summary>
 	public class Console : MonoBehaviour
 	{
+		/// <summary>
+		/// Store the main Console instance
+		/// </summary>
 		public static Console Main;
+		/// <summary>
+		/// Store the gameobject that implements the Console class
+		/// </summary>
 		public static GameObject root;
 
 		private ConsoleGUI _consoleGui;
+
+		/// <summary>
+		/// Store the ConsoleGui instance
+		/// </summary>
 		public ConsoleGUI ConsoleGui
 		{
 			get { return this._consoleGui; }
 		}
+
 		private const int _maxLines = 150;
 		private FilePath logFile;
 		private Queue<string> _queue;
@@ -47,7 +60,7 @@ private void OnDisable()
 		}
 
 		/// <summary>
-		/// process all game logs
+		/// Process all game logs
 		/// </summary>
 		/// <param name="message">log message </param>
 		/// <param name="stackTrace"> error stackTrace </param>

ModLoader/IO/ConsoleGUI.cs

@@ -2,21 +2,31 @@
 
 namespace ModLoader.IO
 {
-
+    /// <summary>
+    /// This class is used to display console GUI.
+    /// </summary>
     public class ConsoleGUI : MonoBehaviour
     {
         // show in what position is the scroll of console
         private Vector2 _scrollConsole = Vector2.zero;
 
         // show if the console is visible for user
         private bool _isVisible;
+
+        /// <summary>
+        /// Get if the console gui is visible or not
+        /// </summary>
         public bool IsVisible
         {
             get { return this._isVisible; }
         }
 
         // store all records in the game
         private GUIContent _logs;
+        
+        /// <summary>
+        /// Set console text
+        /// </summary>
         public string Logs
         {
             set

ModLoader/Loader.cs

@@ -14,29 +14,37 @@
 using SFS.Adapter;
 using SFS.Translations;
 using ModLoader.UI;
+using ModLoader.Helpers;
 
 namespace ModLoader
 {
     /// <summary>
-    /// This is the main class of ModLoader. this class is injected into the game with the Unity Doorstop injector.
+    ///     This is the main class of ModLoader. this class is injected into the game with the Unity Doorstop injector.
     /// </summary>
     public class Loader : MonoBehaviour
     {
-        // This save Loader instance
+
+        /// <summary>
+        ///     This save Loader instance
+        /// </summary>
         public static Loader main;
-        //private Console _console;
 
-        // This save the gameObject that implement Loader class
+        /// <summary>
+        ///     This save the gameObject that implement Loader class
+        /// </summary>
         public static GameObject root;
 
-        private static FolderPath _modsFolder;
-
-        // modlaoder version
-        private const string modLoderVersion = "v1.2.0";
+        /// <summary>
+        ///     Current Modlaoder version
+        /// </summary>
+        private const string modLoderVersion = "v1.3.0";
 
+        /// <summary>
+        ///     Get folder where mods are
+        /// </summary>
         public static FolderPath ModsFolder
         {
-            get { return _modsFolder; }
+            get { return FileLocations.BaseFolder.Extend("MODS"); }
         }
 
         private List<SFSMod> _modsLoaded = new List<SFSMod>();
@@ -45,12 +53,12 @@ public static FolderPath ModsFolder
         private Dictionary<string, SFSMod> _modList;
 
         /// <summary>
-        /// First executed method. Save the loader instance to static var, subscribe to the scene event and load mods for early patches.
+        ///     First executed method. Save the loader instance to static var, subscribe to the scene event and load mods for early patches.
         /// </summary>
         private void Awake()
         {
             Loader.main = this;
-            _modsFolder = FileLocations.BaseFolder.Extend("MODS").CreateFolder();
+            FolderPath modsFolder = ModsFolder.CreateFolder();
 
             Debug.Log($"--- ModLoader {modLoderVersion} ---");
 
@@ -75,26 +83,29 @@ private void Awake()
             }
 
             Debug.Log("Early load finished");
-            Helper.OnHomeSceneLoaded += this.OnGomeSceneLoaded;
+            SceneHelper.OnHomeSceneLoaded += this.OnHomeSceneLoaded;
         }
 
-        private void OnGomeSceneLoaded(object sender, EventArgs args)
+        /// <summary>
+        ///     Is called when Home scenes has been loaded
+        /// </summary>
+        /// <param name="sender">Who send this event</param>
+        /// <param name="scene">Scene information</param>
+        private void OnHomeSceneLoaded(object sender, Scene scene)
         {
             this.insertModsButton();
         }
 
         /// <summary>
-        /// This method starts reading mods and runs automatically when this class is created after the Awake method.
+        ///     This method starts reading mods and runs automatically when this class is created after the Awake method.
         /// </summary>
         private void Start()
         {
-            Debug.Log("Loading mods");
+            Debug.Log("Starting mods");
             foreach (SFSMod mod in _modsLoaded)
             {
                 mod.load();
             }
-
-            Debug.Log("Loading finished");
             this.insertModsButton();
         }
 
@@ -120,7 +131,7 @@ private void insertModsButton()
         }
 
         /// <summary>
-        /// get mod instance.
+        ///     Get mod instance.
         /// </summary>
         /// <param name="modId">Mod ID you need</param>
         /// <returns>instance mod</returns>
@@ -137,7 +148,7 @@ public SFSMod getMod(string modId)
         }
 
         /// <summary>
-        /// Get a list of all loaded mods
+        ///     Get a list of all loaded mods
         /// </summary>
         /// <returns> Loaded mods </returns>
         public SFSMod[] getMods()
@@ -157,7 +168,7 @@ private Dictionary<string, SFSMod> getModList()
             this.detectIndividualDlls();
 
             // get a list of mod folders in the MODS folder
-            IEnumerable<FolderPath> modsFolders = _modsFolder.GetFoldersInFolder(false);
+            IEnumerable<FolderPath> modsFolders = ModsFolder.GetFoldersInFolder(false);
             string basePath = Path.Combine(FileLocations.BaseFolder, "MODS");
 
             foreach (FolderPath folder in modsFolders)
@@ -201,10 +212,14 @@ private Dictionary<string, SFSMod> getModList()
         }
 
         /// <summary>
-        /// Load the mod dependencies and check if it is already loaded and check its version.
+        ///     Load the mod dependencies and check if it is already loaded and check its version.
         /// </summary>
-        /// <param name="dependencies"> lista de dependencias que necesitas cargar primero</param>
-        /// <returns> verdadero si se han cargado todas las dependencias</returns>
+        /// <param name="dependencies"> 
+        ///     List of dependencies that need to be loaded first
+        /// </param>
+        /// <returns> 
+        ///     True if all dependencies have been loaded
+        /// </returns>
         private bool loadDependencies(Dictionary<string, string[]> dependencies)
         {
             // for each mod dependency
@@ -241,9 +256,11 @@ private bool loadDependencies(Dictionary<string, string[]> dependencies)
         }
 
         /// <summary>
-        /// Start checking mod version and run load method
+        ///     Start checking mod version and run load method
         /// </summary>
-        /// <param name="mod">Mod to start load</param>
+        /// <param name="mod">
+        ///     Mod to start load
+        /// </param>
         private void loadMod(SFSMod mod)
         {
             // has this mod been loaded?, if it does not start loading
@@ -275,11 +292,20 @@ private void loadMod(SFSMod mod)
         }
 
         /// <summary>
-        /// Check the string of two versions to identify if they are the same
+        ///     Check the string of two versions to identify if they are the same
         /// </summary>
-        /// <param name="version1"> version to check</param>
-        /// <param name="version2"> verison to check</param>
-        /// <returns>True if they are valid versions</returns>
+        /// <param name="version1"> 
+        ///     Version to check
+        /// </param>
+        /// <param name="version2"> 
+        ///     Verison to check
+        /// </param>
+        /// <param name="checkMinVersion">
+        ///     check if version 1 is is less than or equal to version 2
+        /// </param>
+        /// <returns>   
+        ///     True if they are valid versions
+        /// </returns>
         private bool verifyVersion(string version1, string version2, bool checkMinVersion = false)
         {
             Regex rx = new Regex(@"\bv([0-9]+)(\.([0-9]+|x)){2}\b", RegexOptions.Compiled | RegexOptions.IgnoreCase);
@@ -288,7 +314,7 @@ private bool verifyVersion(string version1, string version2, bool checkMinVersio
             {
                 string[] target1 = version1.Split('.');
                 string[] target2 = version2.Split('.');
-
+                int num1, num2;
                 if (target1.Length == target2.Length)
                 {
                     for (short index = 0; index < target2.Length; index++)
@@ -300,7 +326,7 @@ private bool verifyVersion(string version1, string version2, bool checkMinVersio
 
                         if (checkMinVersion)
                         {
-                            int num1, num2;
+                            
                             if (int.TryParse(target1[index], out num1))
                             {
                                 if(int.TryParse(target2[index], out num2))
@@ -326,32 +352,30 @@ private bool verifyVersion(string version1, string version2, bool checkMinVersio
         }
 
         /// <summary>
-        /// This function looks in the MODS folder for incorrectly installed mods and moves them to a new folder 
-        /// where they should be.
+        ///     This function looks in the MODS folder for incorrectly installed mods and moves them to a new folder 
+        ///     where they should be.
         /// </summary>
         private void detectIndividualDlls()
         {
             try
             {
                 Debug.Log("Searching mods improperly installed");
                 FolderPath newFolder;
-                foreach (FilePath file in _modsFolder.GetFilesInFolder(false))
+                foreach (FilePath file in ModsFolder.GetFilesInFolder(false))
                 {
 
                     if(file.Extension == "dll")
                     {
                         Debug.Log($"{file.FileName} incorrectly installed!");
-                        newFolder = _modsFolder.Extend(file.CleanFileName);
+                        newFolder = ModsFolder.Extend(file.CleanFileName);
                         if (!newFolder.FolderExists())
                         {
                             newFolder = newFolder.CreateFolder();
                         }
                         Debug.Log($"{file.FileName} moved!");
                         file.Move(newFolder.ExtendToFile(file.FileName));
-                        _modsFolder = FileLocations.BaseFolder.Extend("MODS");
                     }
                 }
-                Debug.Log("Everything moved!");
             }
             catch(Exception e)
             {
@@ -361,7 +385,7 @@ private void detectIndividualDlls()
         }
 
         /// <summary>
-        /// This is the mod loader entry point, this is the method that is executed after being injected into the game.
+        ///     This is the mod loader entry point, this is the method that is executed after being injected into the game.
         /// </summary>
         /// <param name="args"></param>
         public static void Main(string[] args)

ModLoader/ModLoader.csproj

@@ -31,6 +31,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\documentation.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="0Harmony, Version=2.2.0.0, Culture=neutral, processorArchitecture=MSIL">
@@ -41,9 +42,9 @@
       <HintPath>..\Dependencies\Assembly-CSharp.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
-      <HintPath>..\packages\Newtonsoft.Json.13.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
-      <Private>False</Private>
+    <Reference Include="Newtonsoft.Json, Version=6.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\Dependencies\Newtonsoft.Json.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
@@ -102,7 +103,9 @@
     <Compile Include="IO\Console.cs" />
     <Compile Include="IO\ConsoleGUI.cs" />
     <Compile Include="Helper.cs" />
+    <Compile Include="Helpers\KeybindingHelper.cs" />
     <Compile Include="Loader.cs" />
+    <Compile Include="Helpers\SceneHelper.cs" />
     <Compile Include="UI\ModsMenu.cs" />
     <Compile Include="Patcher.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />