feat: Add Repair Game button, UserData backup and cache clearing (#79)

* feat: Add Repair Game functionality including UserData backup and cache clearing

* feat: Add In-App Logs Viewer and Logs Folder shortcut

* feat: Add Open Logs feature

* disable dev tools

* Fix Settings UI

* fix reorder settings section in index.html

relocated sections in settings from most used to least:
1. game options (playername, opengamedir, repair, GPUpreference)
2. player uuid management
3. discord integration rich presence
4. custom java path

---------

Co-authored-by: Fazri Gading <super.fai700@gmail.com>

backend/launcher.js

@@ -40,7 +40,8 @@ const {
   installGame,
   uninstallGame,
   updateGameFiles,
-  checkExistingGameInstallation
+  checkExistingGameInstallation,
+  repairGame
 } = require('./managers/gameManager');
 
 const {
@@ -87,13 +88,14 @@ module.exports = {
   // Game launch functions
   launchGame,
   launchGameWithVersionCheck,
-  
+
   // Game installation functions
   installGame,
   isGameInstalled,
   uninstallGame,
   updateGameFiles,
-  
+  repairGame,
+
   // User configuration functions
   saveUsername,
   loadUsername,
@@ -102,16 +104,16 @@ module.exports = {
   saveChatColor,
   loadChatColor,
   getUuidForUser,
-  
+
   // Java configuration functions
   saveJavaPath,
   loadJavaPath,
   getJavaDetection,
-  
+
   // Installation path functions
   saveInstallPath,
   loadInstallPath,
-  
+
   // Discord RPC functions
   saveDiscordRPC,
   loadDiscordRPC,
@@ -124,13 +126,13 @@ module.exports = {
   // Version functions
   getInstalledClientVersion,
   getLatestClientVersion,
-  
+
   // News functions
   getHytaleNews,
-  
+
   // Player ID functions
   getOrCreatePlayerId,
-  
+
   // UUID Management functions
   getCurrentUuid,
   getAllUuidMappings,
@@ -138,7 +140,7 @@ module.exports = {
   generateNewUuid,
   deleteUuidForUser,
   resetCurrentUserUuid,
-  
+
   // Mod management functions
   getModsPath,
   loadInstalledMods,
@@ -147,13 +149,13 @@ module.exports = {
   toggleMod,
   saveModsToConfig,
   loadModsFromConfig,
-  
+
   // UI file management functions
   downloadAndReplaceHomePageUI,
   findHomePageUIPath,
   downloadAndReplaceLogo,
   findLogoPath,
-  
+
   // First launch functions
   isFirstLaunch,
   markAsLaunched,

backend/managers/gameManager.js

@@ -14,7 +14,7 @@ async function downloadPWR(version = 'release', fileName = '4.pwr', progressCall
   const osName = getOS();
   const arch = getArch();
   const url = `https://game-patches.hytale.com/patches/${osName}/${arch}/${version}/0/${fileName}`;
-  
+
   const dest = path.join(cacheDir, fileName);
 
   if (fs.existsSync(dest)) {
@@ -25,7 +25,7 @@ async function downloadPWR(version = 'release', fileName = '4.pwr', progressCall
   console.log('Fetching PWR patch file:', url);
   await downloadFile(url, dest, progressCallback);
   console.log('PWR saved to:', dest);
-  
+
   return dest;
 }
 
@@ -33,9 +33,9 @@ async function applyPWR(pwrFile, progressCallback, gameDir = GAME_DIR, toolsDir
   const butlerPath = await installButler(toolsDir);
   const gameLatest = gameDir;
   const stagingDir = path.join(gameLatest, 'staging-temp');
-  
+
   const clientPath = findClientPath(gameLatest);
-  
+
   if (clientPath) {
     console.log('Game files detected, skipping patch installation.');
     return;
@@ -53,11 +53,11 @@ async function applyPWR(pwrFile, progressCallback, gameDir = GAME_DIR, toolsDir
   }
 
   console.log('Installing game patch...');
-  
+
   if (!fs.existsSync(butlerPath)) {
     throw new Error(`Butler tool not found at: ${butlerPath}`);
   }
-  
+
   if (!fs.existsSync(pwrFile)) {
     throw new Error(`PWR file not found at: ${pwrFile}`);
   }
@@ -69,7 +69,7 @@ async function applyPWR(pwrFile, progressCallback, gameDir = GAME_DIR, toolsDir
     pwrFile,
     gameLatest
   ];
-  
+
   try {
     await new Promise((resolve, reject) => {
       const child = execFile(butlerPath, args, {
@@ -108,7 +108,7 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
     console.log(`Updating game files to version: ${newVersion}`);
 
     tempUpdateDir = path.join(gameDir, '..', 'temp_update');
-    
+
     if (fs.existsSync(tempUpdateDir)) {
       fs.rmSync(tempUpdateDir, { recursive: true, force: true });
     }
@@ -117,26 +117,26 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
     if (progressCallback) {
       progressCallback('Downloading new game version...', 10, null, null, null);
     }
-    
+
     const pwrFile = await downloadPWR('release', newVersion, progressCallback, cacheDir);
-    
+
     if (progressCallback) {
       progressCallback('Extracting new files...', 50, null, null, null);
     }
-    
+
     await applyPWR(pwrFile, progressCallback, tempUpdateDir, toolsDir);
-    
+
     if (progressCallback) {
       progressCallback('Replacing game files...', 80, null, null, null);
     }
-    
+
     let userDataBackup = null;
     const userDataPath = findUserDataRecursive(gameDir);
-    
+
     if (userDataPath && fs.existsSync(userDataPath)) {
       userDataBackup = path.join(gameDir, '..', 'UserData_backup_' + Date.now());
       console.log(`Backing up UserData from ${userDataPath} to: ${userDataBackup}`);
-      
+
       function copyRecursive(src, dest) {
         const stat = fs.statSync(src);
         if (stat.isDirectory()) {
@@ -151,35 +151,35 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
           fs.copyFileSync(src, dest);
         }
       }
-      
+
       copyRecursive(userDataPath, userDataBackup);
     } else {
       console.log('No UserData folder found in game directory');
     }
-    
+
     if (fs.existsSync(gameDir)) {
       console.log('Removing old game files...');
       fs.rmSync(gameDir, { recursive: true, force: true });
     }
-    
+
     fs.renameSync(tempUpdateDir, gameDir);
-    
+
     const homeUIResult = await downloadAndReplaceHomePageUI(gameDir, progressCallback);
     console.log('HomePage.ui update result after update:', homeUIResult);
-    
+
     const logoResult = await downloadAndReplaceLogo(gameDir, progressCallback);
     console.log('Logo@2x.png update result after update:', logoResult);
-    
+
     if (userDataBackup && fs.existsSync(userDataBackup)) {
       const newUserDataPath = findUserDataPath(gameDir);
       const userDataParent = path.dirname(newUserDataPath);
-      
+
       if (!fs.existsSync(userDataParent)) {
         fs.mkdirSync(userDataParent, { recursive: true });
       }
-      
+
       console.log(`Restoring UserData to: ${newUserDataPath}`);
-      
+
       function copyRecursive(src, dest) {
         const stat = fs.statSync(src);
         if (stat.isDirectory()) {
@@ -194,12 +194,12 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
           fs.copyFileSync(src, dest);
         }
       }
-      
+
       copyRecursive(userDataBackup, newUserDataPath);
     }
-    
+
     console.log(`Game files updated successfully to version: ${newVersion}`);
-    
+
     if (userDataBackup && fs.existsSync(userDataBackup)) {
       try {
         fs.rmSync(userDataBackup, { recursive: true, force: true });
@@ -208,18 +208,18 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
         console.warn('Could not clean up UserData backup:', cleanupError.message);
       }
     }
-    
+
     console.log('Waiting for file system sync...');
-    await new Promise(resolve => setTimeout(resolve, 2000)); 
-    
+    await new Promise(resolve => setTimeout(resolve, 2000));
+
     if (progressCallback) {
       progressCallback('Game update completed', 100, null, null, null);
     }
-    
+
     return { success: true, updated: true, version: newVersion };
   } catch (error) {
     console.error('Error updating game files:', error);
-    
+
     if (userDataBackup && fs.existsSync(userDataBackup)) {
       try {
         fs.rmSync(userDataBackup, { recursive: true, force: true });
@@ -228,11 +228,11 @@ async function updateGameFiles(newVersion, progressCallback, gameDir = GAME_DIR,
         console.warn('Could not clean up UserData backup:', cleanupError.message);
       }
     }
-    
+
     if (tempUpdateDir && fs.existsSync(tempUpdateDir)) {
       fs.rmSync(tempUpdateDir, { recursive: true, force: true });
     }
-    
+
     throw new Error(`Failed to update game files: ${error.message}`);
   }
 }
@@ -309,31 +309,31 @@ async function installGame(playerName = 'Player', progressCallback, javaPathOver
     progressCallback('Fetching game files...', null, null, null, null);
   }
   console.log('Installing game files...');
-  
+
   const latestVersion = await getLatestClientVersion();
   const pwrFile = await downloadPWR('release', latestVersion, progressCallback, customCacheDir);
   await applyPWR(pwrFile, progressCallback, customGameDir, customToolsDir);
-  
+
   const homeUIResult = await downloadAndReplaceHomePageUI(customGameDir, progressCallback);
   console.log('HomePage.ui update result after installation:', homeUIResult);
-  
+
   const logoResult = await downloadAndReplaceLogo(customGameDir, progressCallback);
   console.log('Logo@2x.png update result after installation:', logoResult);
-  
+
   if (progressCallback) {
     progressCallback('Installation complete', 100, null, null, null);
   }
   console.log('Game installation completed successfully');
-  
-  return { 
-    success: true, 
+
+  return {
+    success: true,
     installed: true
   };
 }
 
 async function uninstallGame() {
   const appDir = getResolvedAppDir();
-  
+
   if (!fs.existsSync(appDir)) {
     throw new Error('Game is not installed');
   }
@@ -341,7 +341,7 @@ async function uninstallGame() {
   try {
     fs.rmSync(appDir, { recursive: true, force: true });
     console.log('Game uninstalled successfully - removed entire HytaleF2P folder');
-    
+
     if (fs.existsSync(CONFIG_FILE)) {
       const config = loadConfig();
       delete config.installPath;
@@ -355,25 +355,25 @@ async function uninstallGame() {
 function checkExistingGameInstallation() {
   try {
     const config = loadConfig();
-    
+
     if (!config.installPath || !config.installPath.trim()) {
       return null;
     }
-    
+
     const installPath = config.installPath.trim();
     const gameDir = path.join(installPath, 'HytaleF2P', 'release', 'package', 'game', 'latest');
-    
+
     if (!fs.existsSync(gameDir)) {
       return null;
     }
-    
+
     const clientPath = findClientPath(gameDir);
     if (!clientPath) {
       return null;
     }
-    
+
     const userDataPath = findUserDataRecursive(gameDir);
-    
+
     return {
       gameDir: gameDir,
       clientPath: clientPath,
@@ -387,6 +387,102 @@ function checkExistingGameInstallation() {
   }
 }
 
+async function repairGame(progressCallback) {
+  const appDir = getResolvedAppDir();
+  const gameDir = path.join(appDir, 'release', 'package', 'game', 'latest');
+
+  // Check if game exists
+  if (!fs.existsSync(gameDir)) {
+    throw new Error('Game directory not found. Cannot repair.');
+  }
+
+  // Locate UserData
+  const userDataPath = findUserDataRecursive(gameDir);
+  let userDataBackup = null;
+
+  if (progressCallback) {
+    progressCallback('Backing up user data...', 10, null, null, null);
+  }
+
+  // Backup UserData
+  if (userDataPath && fs.existsSync(userDataPath)) {
+    userDataBackup = path.join(appDir, 'UserData_backup_repair_' + Date.now());
+    console.log(`Backing up UserData during repair from ${userDataPath} to ${userDataBackup}`);
+
+    // Copy function
+    function copyRecursive(src, dest) {
+      const stat = fs.statSync(src);
+      if (stat.isDirectory()) {
+        if (!fs.existsSync(dest)) fs.mkdirSync(dest, { recursive: true });
+        fs.readdirSync(src).forEach(child => copyRecursive(path.join(src, child), path.join(dest, child)));
+      } else {
+        fs.copyFileSync(src, dest);
+      }
+    }
+
+    copyRecursive(userDataPath, userDataBackup);
+  }
+
+  if (progressCallback) {
+    progressCallback('Removing old game files...', 30, null, null, null);
+  }
+
+  // Delete Game and Cache Directory
+  console.log('Removing corrupted game files...');
+  fs.rmSync(gameDir, { recursive: true, force: true });
+
+  const cacheDir = path.join(appDir, 'cache');
+  if (fs.existsSync(cacheDir)) {
+    console.log('Clearing cache directory...');
+    fs.rmSync(cacheDir, { recursive: true, force: true });
+  }
+
+  console.log('Reinstalling game files...');
+
+  // Passing null/undefined for overrides to use defaults/saved configs
+  // installGame calls progressCallback internally
+  await installGame('Player', progressCallback);
+
+  // Restore UserData
+  if (userDataBackup && fs.existsSync(userDataBackup)) {
+    if (progressCallback) {
+      progressCallback('Restoring user data...', 90, null, null, null);
+    }
+
+    // installGame creates: path.join(customGameDir, 'Client', 'UserData')
+    const newGameDir = path.join(appDir, 'release', 'package', 'game', 'latest');
+    const newUserDataPath = path.join(newGameDir, 'Client', 'UserData');
+
+    if (!fs.existsSync(newUserDataPath)) {
+      fs.mkdirSync(newUserDataPath, { recursive: true });
+    }
+
+    console.log(`Restoring UserData to ${newUserDataPath}`);
+
+    function copyRecursive(src, dest) {
+      const stat = fs.statSync(src);
+      if (stat.isDirectory()) {
+        if (!fs.existsSync(dest)) fs.mkdirSync(dest, { recursive: true });
+        fs.readdirSync(src).forEach(child => copyRecursive(path.join(src, child), path.join(dest, child)));
+      } else {
+        fs.copyFileSync(src, dest);
+      }
+    }
+
+    copyRecursive(userDataBackup, newUserDataPath);
+
+    // Cleanup Backup
+    console.log('Cleaning up repair backup...');
+    fs.rmSync(userDataBackup, { recursive: true, force: true });
+  }
+
+  if (progressCallback) {
+    progressCallback('Repair completed successfully!', 100, null, null, null);
+  }
+
+  return { success: true, repaired: true };
+}
+
 module.exports = {
   downloadPWR,
   applyPWR,
@@ -394,5 +490,9 @@ module.exports = {
   isGameInstalled,
   installGame,
   uninstallGame,
-  checkExistingGameInstallation
+  isGameInstalled,
+  installGame,
+  uninstallGame,
+  checkExistingGameInstallation,
+  repairGame
 };

backend/utils/fileManager.js

@@ -4,11 +4,11 @@ const axios = require('axios');
 
 async function downloadFile(url, dest, progressCallback, maxRetries = 3) {
   let lastError = null;
-  
+
   for (let attempt = 0; attempt < maxRetries; attempt++) {
     try {
       console.log(`Download attempt ${attempt + 1}/${maxRetries} for ${url}`);
-      
+
       if (attempt > 0 && progressCallback) {
         progressCallback(`Retry ${attempt}/${maxRetries - 1}...`, null, null, null, null);
         await new Promise(resolve => setTimeout(resolve, 2000 * attempt)); // Délai progressif
@@ -53,19 +53,19 @@ async function downloadFile(url, dest, progressCallback, maxRetries = 3) {
       response.data.on('data', (chunk) => {
         downloaded += chunk.length;
         const now = Date.now();
-        
+
         // Reset stalled timer on data received
         if (stalledTimeout) {
           clearTimeout(stalledTimeout);
         }
-        
+
         // Set new stalled timer (30 seconds without data = stalled)
         stalledTimeout = setTimeout(() => {
           downloadStalled = true;
           writer.destroy();
           response.data.destroy();
         }, 30000);
-        
+
         if (progressCallback && totalSize > 0 && (now - lastProgressTime > 100)) { // Update every 100ms max
           const percent = Math.min(100, Math.max(0, (downloaded / totalSize) * 100));
           const elapsed = (now - startTime) / 1000;
@@ -97,14 +97,14 @@ async function downloadFile(url, dest, progressCallback, maxRetries = 3) {
             reject(new Error('Download stalled'));
           }
         });
-        
+
         writer.on('error', (error) => {
           if (stalledTimeout) {
             clearTimeout(stalledTimeout);
           }
           reject(error);
         });
-        
+
         response.data.on('error', (error) => {
           if (stalledTimeout) {
             clearTimeout(stalledTimeout);
@@ -119,7 +119,7 @@ async function downloadFile(url, dest, progressCallback, maxRetries = 3) {
     } catch (error) {
       lastError = error;
       console.error(`Download attempt ${attempt + 1} failed:`, error.code || error.message);
-      
+
       // Nettoyer le fichier partiel en cas d'erreur
       if (fs.existsSync(dest)) {
         try {
@@ -128,23 +128,24 @@ async function downloadFile(url, dest, progressCallback, maxRetries = 3) {
           console.warn('Could not cleanup partial file:', cleanupError.message);
         }
       }
-      
+
       // Vérifier si c'est une erreur réseau que l'on peut retry
       const retryableErrors = ['ECONNRESET', 'ENOTFOUND', 'ECONNREFUSED', 'ETIMEDOUT', 'ESOCKETTIMEDOUT', 'EPROTO'];
-      const isRetryable = retryableErrors.includes(error.code) || 
-                         error.message.includes('timeout') ||
-                         error.message.includes('stalled') ||
-                         (error.response && error.response.status >= 500);
-      
+      const isRetryable = retryableErrors.includes(error.code) ||
+        error.message.includes('timeout') ||
+        error.message.includes('stalled') ||
+        (error.response && error.response.status >= 500);
+
       if (!isRetryable || attempt === maxRetries - 1) {
         console.error(`Non-retryable error or max retries reached: ${error.code || error.message}`);
+
         break;
       }
-      
+
       console.log(`Retryable error detected, will retry in ${2000 * (attempt + 1)}ms...`);
     }
   }
-  
+
   throw new Error(`Download failed after ${maxRetries} attempts. Last error: ${lastError?.code || lastError?.message || 'Unknown error'}`);
 }
 
@@ -152,7 +153,7 @@ function findHomePageUIPath(gameLatest) {
   function searchDirectory(dir) {
     try {
       const items = fs.readdirSync(dir, { withFileTypes: true });
-      
+
       for (const item of items) {
         if (item.isFile() && item.name === 'HomePage.ui') {
           return path.join(dir, item.name);
@@ -165,14 +166,14 @@ function findHomePageUIPath(gameLatest) {
       }
     } catch (error) {
     }
-    
+
     return null;
   }
-  
+
   if (!fs.existsSync(gameLatest)) {
     return null;
   }
-  
+
   return searchDirectory(gameLatest);
 }
 
@@ -180,7 +181,7 @@ function findLogoPath(gameLatest) {
   function searchDirectory(dir) {
     try {
       const items = fs.readdirSync(dir, { withFileTypes: true });
-      
+
       for (const item of items) {
         if (item.isFile() && item.name === 'Logo@2x.png') {
           return path.join(dir, item.name);
@@ -193,14 +194,14 @@ function findLogoPath(gameLatest) {
       }
     } catch (error) {
     }
-    
+
     return null;
   }
-  
+
   if (!fs.existsSync(gameLatest)) {
     return null;
   }
-  
+
   return searchDirectory(gameLatest);
 }