Update comments & add comments

Author: frxctura

MainForm.cs

@@ -63,7 +63,7 @@ public partial class MainForm : Form
         private bool manualIP;
         public MainForm()
         {
-            // check for offline mode
+            // Check for Offline Mode or No RCLONE Updating
             string[] args = Environment.GetCommandLineArgs();
             foreach (string arg in args)
             {
@@ -111,7 +111,7 @@ public MainForm()
                 Properties.Settings.Default.SubmittedUpdates = String.Empty;
                 Properties.Settings.Default.Save();
             }
-            //Time for debuglog
+            // Launch time used within debuglog.
             string launchtime = DateTime.Now.ToString("hh:mmtt(UTC)");
             _ = Logger.Log($"\n------\n------\nProgram Launched at: {launchtime}\n------\n------");
             if (string.IsNullOrEmpty(Properties.Settings.Default.CurrentLogPath))
@@ -1003,7 +1003,7 @@ private async void getApkButton_Click(object sender, EventArgs e)
                 string gameName = $"{GameName} v{VersionInt} {packageName} {HWID.Substring(0, 1)}";
                 string gameZipName = $"{gameName}.zip";
 
-                // delete the zip and txt if they exist from a previously failed upload
+                // Delete both zip & txt if the files exist, most likely due to a failed upload.
                 if (File.Exists($"{Properties.Settings.Default.MainDir}\\{gameZipName}"))
                 {
                     File.Delete($"{Properties.Settings.Default.MainDir}\\{gameZipName}");
@@ -1078,15 +1078,15 @@ private async void getApkButton_Click(object sender, EventArgs e)
                     string currentlyUploading = GameName;
                     changeTitle("Uploading to server, you can continue to use Rookie while it uploads in the background.");
 
-                    // get size of pending zip upload and write to text file
+                    // Get size of pending zip upload and write to text file
                     long zipSize = new FileInfo($"{Properties.Settings.Default.MainDir}\\{gameZipName}").Length;
                     File.WriteAllText($"{Properties.Settings.Default.MainDir}\\{gameName}.txt", zipSize.ToString());
-                    // upload size file
+                    // Upload size file.
                     _ = RCLONE.runRcloneCommand_UploadConfig($"copy \"{Properties.Settings.Default.MainDir}\\{gameName}.txt\" RSL-gameuploads:");
-                    // upload zip
+                    // Upload zip.
                     _ = RCLONE.runRcloneCommand_UploadConfig($"copy \"{Properties.Settings.Default.MainDir}\\{gameZipName}\" RSL-gameuploads:");
 
-                    // deleting uploaded files
+                    // Delete files once uploaded.
                     File.Delete($"{Properties.Settings.Default.MainDir}\\{gameName}.txt");
                     File.Delete($"{Properties.Settings.Default.MainDir}\\{gameZipName}");
 
@@ -1272,7 +1272,7 @@ private async void Form1_DragDrop(object sender, DragEventArgs e)
                                 CurrAPK = file2;
                                 System.Windows.Forms.Timer t3 = new System.Windows.Forms.Timer
                                 {
-                                    Interval = 150000 // 180 seconds to fail
+                                    Interval = 150000 // 150 seconds to fail
                                 };
                                 t3.Tick += timer_Tick4;
                                 t3.Start();
@@ -1621,8 +1621,8 @@ private async void initListView()
             List<string> blacklistItems = blacklist.ToList();
             List<string> whitelistItems = whitelist.ToList();
             errorOnList = false;
-            //This is for black list, but temporarly will be whitelist
-            //this list has games that we are actually going to upload
+            //This is for the black list, but temporarily will be the whitelist
+            //This list contains games that we are actually going to upload
             newGamesToUploadList = whitelistItems.Intersect(installedGames).ToList();
             progressBar.Style = ProgressBarStyle.Marquee;
             if (SideloaderRCLONE.games.Count > 5)
@@ -1915,7 +1915,7 @@ public static async void doUpload()
                     string gameName = $"{game.Uploadgamename} v{game.Uploadversion} {game.Pckgcommand} {SideloaderUtilities.UUID().Substring(0, 1)}";
                     string gameZipName = $"{gameName}.zip";
 
-                    // delete the zip and txt if they exist from a previously failed upload
+                    // Delete both zip & txt if the files exist, most likely due to a failed upload.
                     if (File.Exists($"{Properties.Settings.Default.MainDir}\\{gameZipName}"))
                     {
                         File.Delete($"{Properties.Settings.Default.MainDir}\\{gameZipName}");
@@ -1933,12 +1933,12 @@ public static async void doUpload()
                     Directory.Delete($"{Properties.Settings.Default.MainDir}\\{game.Pckgcommand}", true);
                     Program.form.changeTitle("Uploading to server, you may continue to use Rookie while it uploads.");
 
-                    // get size of pending zip upload and write to text file
+                    // Get size of pending zip upload and write to text file
                     long zipSize = new FileInfo($"{Properties.Settings.Default.MainDir}\\{gameZipName}").Length;
                     File.WriteAllText($"{Properties.Settings.Default.MainDir}\\{gameName}.txt", zipSize.ToString());
-                    // upload size file
+                    // Upload size file.
                     _ = RCLONE.runRcloneCommand_UploadConfig($"copy \"{Properties.Settings.Default.MainDir}\\{gameName}.txt\" RSL-gameuploads:");
-                    // upload zip
+                    // Upload zip.
                     _ = RCLONE.runRcloneCommand_UploadConfig($"copy \"{Properties.Settings.Default.MainDir}\\{gameZipName}\" RSL-gameuploads:");
 
                     if (game.isUpdate)
@@ -1947,7 +1947,7 @@ public static async void doUpload()
                         Properties.Settings.Default.Save();
                     }
 
-                    // deleting uploaded files
+                    // Delete files once uploaded.
                     File.Delete($"{Properties.Settings.Default.MainDir}\\{gameName}.txt");
                     File.Delete($"{Properties.Settings.Default.MainDir}\\{gameZipName}");
 
@@ -2085,7 +2085,7 @@ private void initMirrors(bool random)
 
                 remotesList.Invoke(() =>
             {
-                remotesList.SelectedIndex = 0; //set mirror to first
+                remotesList.SelectedIndex = 0; // Set mirror to first item in array.
                 currentRemote = "VRP-mirror" + remotesList.SelectedItem.ToString();
             });
 
@@ -2490,7 +2490,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                     changeTitle("Downloading game " + gameName, false);
 
                     int i = 0;
-                    //Download
+                    // Begin download.
                     while (t1.IsAlive)
                     {
                         try
@@ -2569,7 +2569,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                         break;
                     }
                     {
-                        //Quota Errors
+                        // Handle quota errors.
                         bool isinstalltxt = false;
                         bool quotaError = false;
                         bool otherError = false;
@@ -2589,7 +2589,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                             {
                                 otherError = true;
 
-                                //Remove current game
+                                // Remove current game off queue.
                                 cleanupActiveDownloadStatus();
 
                                 _ = FlexibleMessageBox.Show($"Rclone error: {gameDownloadOutput.Error}");
@@ -2720,6 +2720,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                                         {
                                             if (!Properties.Settings.Default.nodevicemode | !nodeviceonstart & DeviceConnected)
                                             {
+                                                // Attempt to delete OBB Folder before pushing.
                                                 deleteOBB(packagename);
                                                 Thread obbThread = new Thread(() =>
                                                 {
@@ -2742,6 +2743,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                                                     {
                                                         try
                                                         {
+                                                            // Check if OBB was properly pushed with a size comparison.
                                                             obbsMismatch = await compareOBBSizes(packagename, gameName, output);
                                                         }
                                                         catch (Exception ex) { _ = FlexibleMessageBox.Show($"Error comparing OBB sizes: {ex.Message}"); }
@@ -2764,7 +2766,7 @@ public async void downloadInstallGameButton_Click(object sender, EventArgs e)
                                 try { Directory.Delete(Properties.Settings.Default.downloadDir + "\\" + gameName, true); } catch (Exception ex) { _ = FlexibleMessageBox.Show($"Error deleting game files: {ex.Message}"); }
                             }
 
-                            //Remove current game
+                            // Remove current game off queue.
                             cleanupActiveDownloadStatus();
                         }
                     }
@@ -2809,6 +2811,7 @@ private void deleteOBB(string packagename)
 
         private const string OBBFolderPath = "/sdcard/Android/obb/";
 
+        // Logic to compare OBB folders.
         private async Task<bool> compareOBBSizes(string packageName, string gameName, ProcessOutput output)
         {
             string localFolderPath = Path.Combine(Properties.Settings.Default.downloadDir, gameName, packageName);
@@ -2864,6 +2867,7 @@ private string cleanRemoteFolderSize(string rawSize)
             return Regex.Replace(replaced, "[^0-9]", "");
         }
 
+        // Logic to handle mismatches after comparison.
         private async Task<bool> handleObbSizeMismatchAsync(string packageName, string gameName, ProcessOutput output)
         {
             var dialogResult = MessageBox.Show("Warning! It seems like the OBB wasn't pushed correctly, this means that the game may not launch correctly.\n Do you want to retry the push?", "OBB Size Mismatch!", MessageBoxButtons.YesNo);
@@ -3181,7 +3185,7 @@ protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
         {
             if (keyData == (Keys.Control | Keys.F))
             {
-                //show search
+                // Show search box.
                 searchTextBox.Clear();
                 searchTextBox.Visible = true;
                 label2.Visible = true;
@@ -3235,11 +3239,8 @@ protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
             {
                 try
                 {
-                    //run the program again and close this one
+                    // Relaunch the program using Sideloader Launcher
                     _ = Process.Start(Application.StartupPath + "\\Sideloader Launcher.exe");
-                    //or you can use Application.ExecutablePath
-
-                    //close this one
                     Process.GetCurrentProcess().Kill();
                 }
                 catch
@@ -3704,8 +3705,6 @@ private async void updateAvailable_Click(object sender, EventArgs e)
                 List<string> blacklistItems = blacklist.ToList();
                 List<string> whitelistItems = whitelist.ToList();
                 errorOnList = false;
-                //This is for black list, but temporarly will be whitelist
-                //this list has games that we are actually going to upload
                 newGamesToUploadList = whitelistItems.Intersect(installedGames).ToList();
                 progressBar.Style = ProgressBarStyle.Marquee;
                 if (SideloaderRCLONE.games.Count > 5)
@@ -4041,8 +4040,6 @@ private async void lblUpToDate_Click(object sender, EventArgs e)
                 List<string> blacklistItems = blacklist.ToList();
                 List<string> whitelistItems = whitelist.ToList();
                 errorOnList = false;
-                //This is for black list, but temporarly will be whitelist
-                //this list has games that we are actually going to upload
                 newGamesToUploadList = whitelistItems.Intersect(installedGames).ToList();
                 progressBar.Style = ProgressBarStyle.Marquee;
                 if (SideloaderRCLONE.games.Count > 5)
@@ -4176,8 +4173,6 @@ private async void lblNeedsDonate_Click(object sender, EventArgs e)
                 List<string> blacklistItems = blacklist.ToList();
                 List<string> whitelistItems = whitelist.ToList();
                 errorOnList = false;
-                //This is for black list, but temporarly will be whitelist
-                //this list has games that we are actually going to upload
                 newGamesToUploadList = whitelistItems.Intersect(installedGames).ToList();
                 progressBar.Style = ProgressBarStyle.Marquee;
                 if (SideloaderRCLONE.games.Count > 5)

Program.cs

@@ -28,9 +28,11 @@ private static void Main()
 
         private static void CrashHandler(object sender, UnhandledExceptionEventArgs args)
         {
+            // Capture unhandled exceptions and write to file. 
             Exception e = (Exception)args.ExceptionObject;
             string date_time = DateTime.Now.ToString("dddd, MMMM dd @ hh:mmtt (UTC)");
             File.WriteAllText(Sideloader.CrashLogPath, $"Date/Time of crash: {date_time}\nMessage: {e.Message}\nData: {e.Data}\nSource: {e.Source}\nTargetSite: {e.TargetSite}\nStack Trace: \n{e.StackTrace}\n\n\nDebuglog: \n\n\n");
+            // If a debuglog exists we append it to the crashlog.
             if (File.Exists(Properties.Settings.Default.CurrentLogPath))
             {
                 File.AppendAllText(Sideloader.CrashLogPath, File.ReadAllText($"{Properties.Settings.Default.CurrentLogPath}"));