mirror of
https://git.sanhost.net/sanasol/hytale-f2p
synced 2026-02-26 11:41:49 -03:00
Custom Mod loading fix (#92)
* 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 * Implement custom mod loading, autoimport, auto repair * Fixed Custom Mod loading issues and merge issues * feat: Externalize sensitive API keys and Discord client ID into environment variables using dotenv. * feat(mods): add profile-based mod management and auto-repair
This commit is contained in:
Rahul Sahani
@@ -2,10 +2,30 @@ const fs = require('fs');
|
||||
const path = require('path');
|
||||
const crypto = require('crypto');
|
||||
const axios = require('axios');
|
||||
const { getModsPath } = require('../core/paths');
|
||||
const { getModsPath, getProfilesDir } = require('../core/paths');
|
||||
const { saveModsToConfig, loadModsFromConfig } = require('../core/config');
|
||||
const profileManager = require('./profileManager');
|
||||
|
||||
const API_KEY = process.env.CURSEFORGE_API_KEY;
|
||||
|
||||
/**
|
||||
* Get the physical mods path for a specific profile.
|
||||
* Each profile now has its own 'mods' folder.
|
||||
*/
|
||||
function getProfileModsPath(profileId) {
|
||||
const profilesDir = getProfilesDir();
|
||||
if (!profilesDir) return null;
|
||||
|
||||
const profileDir = path.join(profilesDir, profileId);
|
||||
const modsDir = path.join(profileDir, 'mods');
|
||||
|
||||
if (!fs.existsSync(modsDir)) {
|
||||
fs.mkdirSync(modsDir, { recursive: true });
|
||||
}
|
||||
|
||||
return modsDir;
|
||||
}
|
||||
|
||||
function generateModId(filename) {
|
||||
return crypto.createHash('md5').update(filename).digest('hex').substring(0, 8);
|
||||
}
|
||||
@@ -35,30 +55,33 @@ function getProfileMods() {
|
||||
|
||||
async function loadInstalledMods(modsPath) {
|
||||
try {
|
||||
// Sync first to ensure we detect any manually added mods and paths are correct
|
||||
await syncModsForCurrentProfile();
|
||||
|
||||
const activeProfile = profileManager.getActiveProfile();
|
||||
if (!activeProfile) return [];
|
||||
|
||||
const profileMods = activeProfile.mods || [];
|
||||
const profileModFiles = new Set(profileMods.map(m => m.fileName));
|
||||
|
||||
// We only return mods that are explicitly in the profile
|
||||
// Check which ones are physically present (either in mods/ or DisabledMods/)
|
||||
|
||||
const physicalModsPath = modsPath; // .../mods
|
||||
const disabledModsPath = path.join(path.dirname(modsPath), 'DisabledMods');
|
||||
|
||||
// Use profile-specific paths
|
||||
const profileModsPath = getProfileModsPath(activeProfile.id);
|
||||
const profileDisabledModsPath = path.join(path.dirname(profileModsPath), 'DisabledMods');
|
||||
|
||||
if (!fs.existsSync(profileModsPath)) fs.mkdirSync(profileModsPath, { recursive: true });
|
||||
if (!fs.existsSync(profileDisabledModsPath)) fs.mkdirSync(profileDisabledModsPath, { recursive: true });
|
||||
|
||||
const validMods = [];
|
||||
|
||||
for (const modConfig of profileMods) {
|
||||
// Check if file exists in either location
|
||||
const inEnabled = fs.existsSync(path.join(physicalModsPath, modConfig.fileName));
|
||||
const inDisabled = fs.existsSync(path.join(disabledModsPath, modConfig.fileName));
|
||||
const inEnabled = fs.existsSync(path.join(profileModsPath, modConfig.fileName));
|
||||
const inDisabled = fs.existsSync(path.join(profileDisabledModsPath, modConfig.fileName));
|
||||
|
||||
if (inEnabled || inDisabled) {
|
||||
validMods.push({
|
||||
...modConfig,
|
||||
// Set filePath based on physical location
|
||||
filePath: inEnabled ? path.join(physicalModsPath, modConfig.fileName) : path.join(disabledModsPath, modConfig.fileName),
|
||||
filePath: inEnabled ? path.join(profileModsPath, modConfig.fileName) : path.join(profileDisabledModsPath, modConfig.fileName),
|
||||
enabled: modConfig.enabled !== false // Default true
|
||||
});
|
||||
} else {
|
||||
@@ -82,7 +105,11 @@ async function loadInstalledMods(modsPath) {
|
||||
|
||||
async function downloadMod(modInfo) {
|
||||
try {
|
||||
const modsPath = await getModsPath();
|
||||
const activeProfile = profileManager.getActiveProfile();
|
||||
if (!activeProfile) throw new Error('No active profile to save mod to');
|
||||
|
||||
const modsPath = getProfileModsPath(activeProfile.id);
|
||||
if (!modsPath) throw new Error('Could not determine profile mods path');
|
||||
|
||||
if (!modInfo.downloadUrl && !modInfo.fileId) {
|
||||
throw new Error('No download URL or file ID provided');
|
||||
@@ -91,9 +118,9 @@ async function downloadMod(modInfo) {
|
||||
let downloadUrl = modInfo.downloadUrl;
|
||||
|
||||
if (!downloadUrl && modInfo.fileId && modInfo.modId) {
|
||||
const response = await axios.get(`https://api.curseforge.com/v1/mods/${modInfo.modId}/files/${modInfo.fileId}`, {
|
||||
const response = await axios.get(`https://api.curseforge.com/v1/mods/${modInfo.modId || modInfo.curseForgeId}/files/${modInfo.fileId || modInfo.curseForgeFileId}`, {
|
||||
headers: {
|
||||
'x-api-key': modInfo.apiKey,
|
||||
'x-api-key': modInfo.apiKey || API_KEY,
|
||||
'Accept': 'application/json'
|
||||
}
|
||||
});
|
||||
@@ -119,35 +146,30 @@ async function downloadMod(modInfo) {
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
writer.on('finish', () => {
|
||||
// NEW: Update Active Profile instead of global config
|
||||
const activeProfile = profileManager.getActiveProfile();
|
||||
if (activeProfile) {
|
||||
const newMod = {
|
||||
id: modInfo.id || generateModId(fileName),
|
||||
name: modInfo.name || extractModName(fileName),
|
||||
version: modInfo.version || '1.0.0',
|
||||
description: modInfo.summary || modInfo.description || 'Downloaded from CurseForge',
|
||||
author: modInfo.author || 'Unknown',
|
||||
enabled: true,
|
||||
fileName: fileName,
|
||||
fileSize: fs.statSync(filePath).size,
|
||||
dateInstalled: new Date().toISOString(),
|
||||
curseForgeId: modInfo.modId,
|
||||
curseForgeFileId: modInfo.fileId
|
||||
};
|
||||
// Update Active Profile
|
||||
const newMod = {
|
||||
id: modInfo.id || generateModId(fileName),
|
||||
name: modInfo.name || extractModName(fileName),
|
||||
version: modInfo.version || '1.0.0',
|
||||
description: modInfo.summary || modInfo.description || 'Downloaded from CurseForge',
|
||||
author: modInfo.author || 'Unknown',
|
||||
enabled: true,
|
||||
fileName: fileName,
|
||||
fileSize: fs.statSync(filePath).size,
|
||||
dateInstalled: new Date().toISOString(),
|
||||
curseForgeId: modInfo.modId,
|
||||
curseForgeFileId: modInfo.fileId
|
||||
};
|
||||
|
||||
const updatedMods = [...(activeProfile.mods || []), newMod];
|
||||
profileManager.updateProfile(activeProfile.id, { mods: updatedMods });
|
||||
const updatedMods = [...(activeProfile.mods || []), newMod];
|
||||
profileManager.updateProfile(activeProfile.id, { mods: updatedMods });
|
||||
|
||||
resolve({
|
||||
success: true,
|
||||
filePath: filePath,
|
||||
fileName: fileName,
|
||||
modInfo: newMod
|
||||
});
|
||||
} else {
|
||||
reject(new Error('No active profile to save mod to'));
|
||||
}
|
||||
resolve({
|
||||
success: true,
|
||||
filePath: filePath,
|
||||
fileName: fileName,
|
||||
modInfo: newMod
|
||||
});
|
||||
});
|
||||
writer.on('error', reject);
|
||||
});
|
||||
@@ -173,8 +195,11 @@ async function uninstallMod(modId, modsPath) {
|
||||
throw new Error('Mod not found in profile');
|
||||
}
|
||||
|
||||
const disabledModsPath = path.join(path.dirname(modsPath), 'DisabledMods');
|
||||
const enabledPath = path.join(modsPath, mod.fileName);
|
||||
// Use profile paths
|
||||
const profileModsPath = getProfileModsPath(activeProfile.id);
|
||||
const disabledModsPath = path.join(path.dirname(profileModsPath), 'DisabledMods');
|
||||
|
||||
const enabledPath = path.join(profileModsPath, mod.fileName);
|
||||
const disabledPath = path.join(disabledModsPath, mod.fileName);
|
||||
|
||||
let fileRemoved = false;
|
||||
@@ -226,31 +251,25 @@ async function toggleMod(modId, modsPath) {
|
||||
updatedMods[modIndex] = { ...mod, enabled: newEnabled };
|
||||
profileManager.updateProfile(activeProfile.id, { mods: updatedMods });
|
||||
|
||||
// Manually move the file to reflect the new state
|
||||
const disabledModsPath = path.join(path.dirname(modsPath), 'DisabledMods');
|
||||
// Move file between Profile/Mods and Profile/DisabledMods
|
||||
const profileModsPath = getProfileModsPath(activeProfile.id);
|
||||
const disabledModsPath = path.join(path.dirname(profileModsPath), 'DisabledMods');
|
||||
|
||||
if (!fs.existsSync(disabledModsPath)) fs.mkdirSync(disabledModsPath, { recursive: true });
|
||||
|
||||
const currentPath = mod.enabled ? path.join(modsPath, mod.fileName) : path.join(disabledModsPath, mod.fileName);
|
||||
|
||||
// Determine target paths
|
||||
|
||||
const targetDir = newEnabled ? modsPath : disabledModsPath;
|
||||
const currentPath = mod.enabled ? path.join(profileModsPath, mod.fileName) : path.join(disabledModsPath, mod.fileName);
|
||||
const targetDir = newEnabled ? profileModsPath : disabledModsPath;
|
||||
const targetPath = path.join(targetDir, mod.fileName);
|
||||
|
||||
if (fs.existsSync(currentPath)) {
|
||||
fs.renameSync(currentPath, targetPath);
|
||||
} else {
|
||||
// Fallback: check if it's already in target?
|
||||
|
||||
|
||||
if (fs.existsSync(targetPath)) {
|
||||
// It's already there, maybe just state was wrong.
|
||||
|
||||
console.log(`[ModManager] Mod ${mod.fileName} is already in the correct state`);
|
||||
|
||||
} else {
|
||||
// Try finding it
|
||||
const altPath = mod.enabled ? path.join(disabledModsPath, mod.fileName) : path.join(modsPath, mod.fileName);
|
||||
const altPath = mod.enabled ? path.join(disabledModsPath, mod.fileName) : path.join(profileModsPath, mod.fileName);
|
||||
if (fs.existsSync(altPath)) fs.renameSync(altPath, targetPath);
|
||||
}
|
||||
}
|
||||
@@ -273,35 +292,166 @@ async function syncModsForCurrentProfile() {
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(`[ModManager] Syncing mods for profile: ${activeProfile.name}`);
|
||||
console.log(`[ModManager] Syncing mods for profile: ${activeProfile.name} (${activeProfile.id})`);
|
||||
|
||||
const modsPath = await getModsPath();
|
||||
const disabledModsPath = path.join(path.dirname(modsPath), 'DisabledMods');
|
||||
// 1. Resolve Paths
|
||||
// globalModsPath is the one the game uses (symlink target)
|
||||
const globalModsPath = await getModsPath();
|
||||
// profileModsPath is the real storage for this profile
|
||||
const profileModsPath = getProfileModsPath(activeProfile.id);
|
||||
const profileDisabledModsPath = path.join(path.dirname(profileModsPath), 'DisabledMods');
|
||||
|
||||
if (!fs.existsSync(disabledModsPath)) {
|
||||
fs.mkdirSync(disabledModsPath, { recursive: true });
|
||||
if (!fs.existsSync(profileDisabledModsPath)) {
|
||||
fs.mkdirSync(profileDisabledModsPath, { recursive: true });
|
||||
}
|
||||
|
||||
// Get all physical files from both folders
|
||||
const enabledFiles = fs.existsSync(modsPath) ? fs.readdirSync(modsPath).filter(f => f.endsWith('.jar') || f.endsWith('.zip')) : [];
|
||||
const disabledFiles = fs.existsSync(disabledModsPath) ? fs.readdirSync(disabledModsPath).filter(f => f.endsWith('.jar') || f.endsWith('.zip')) : [];
|
||||
// 2. Symlink / Migration Logic
|
||||
let needsLink = false;
|
||||
|
||||
if (fs.existsSync(globalModsPath)) {
|
||||
const stats = fs.lstatSync(globalModsPath);
|
||||
|
||||
if (stats.isSymbolicLink()) {
|
||||
const linkTarget = fs.readlinkSync(globalModsPath);
|
||||
// Normalize paths for comparison
|
||||
if (path.resolve(linkTarget) !== path.resolve(profileModsPath)) {
|
||||
console.log(`[ModManager] Updating symlink from ${linkTarget} to ${profileModsPath}`);
|
||||
fs.unlinkSync(globalModsPath);
|
||||
needsLink = true;
|
||||
}
|
||||
} else if (stats.isDirectory()) {
|
||||
// MIGRATION: It's a real directory. Move contents to profile.
|
||||
console.log('[ModManager] Migrating global mods folder to profile folder...');
|
||||
const files = fs.readdirSync(globalModsPath);
|
||||
for (const file of files) {
|
||||
const src = path.join(globalModsPath, file);
|
||||
const dest = path.join(profileModsPath, file);
|
||||
// Only move if dest doesn't exist to avoid overwriting
|
||||
if (!fs.existsSync(dest)) {
|
||||
fs.renameSync(src, dest);
|
||||
}
|
||||
}
|
||||
|
||||
// Also migrate DisabledMods if it exists globally
|
||||
const globalDisabledPath = path.join(path.dirname(globalModsPath), 'DisabledMods');
|
||||
if (fs.existsSync(globalDisabledPath) && fs.lstatSync(globalDisabledPath).isDirectory()) {
|
||||
const dFiles = fs.readdirSync(globalDisabledPath);
|
||||
for (const file of dFiles) {
|
||||
const src = path.join(globalDisabledPath, file);
|
||||
const dest = path.join(profileDisabledModsPath, file);
|
||||
if (!fs.existsSync(dest)) {
|
||||
fs.renameSync(src, dest);
|
||||
}
|
||||
}
|
||||
// We can remove global DisabledMods now, as it's not used by game
|
||||
try { fs.rmSync(globalDisabledPath, { recursive: true, force: true }); } catch(e) {}
|
||||
}
|
||||
|
||||
// Remove the directory so we can link it
|
||||
try {
|
||||
fs.rmSync(globalModsPath, { recursive: true, force: true });
|
||||
needsLink = true;
|
||||
} catch (e) {
|
||||
console.error('Failed to remove global mods dir:', e);
|
||||
// Throw error to stop.
|
||||
throw new Error('Failed to migrate mods directory. Please clear ' + globalModsPath);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
needsLink = true;
|
||||
}
|
||||
|
||||
if (needsLink) {
|
||||
console.log(`[ModManager] Creating symlink: ${globalModsPath} -> ${profileModsPath}`);
|
||||
try {
|
||||
// 'junction' is key for Windows without admin
|
||||
fs.symlinkSync(profileModsPath, globalModsPath, 'junction');
|
||||
} catch (err) {
|
||||
// If we can't create the symlink, try creating the directory first
|
||||
console.error('[ModManager] Failed to create symlink. Falling back to direct folder mode.');
|
||||
console.error(err.message);
|
||||
|
||||
// Fallback: create a real directory so the game still works
|
||||
if (!fs.existsSync(globalModsPath)) {
|
||||
fs.mkdirSync(globalModsPath, { recursive: true });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 3. Auto-Repair (Download missing mods)
|
||||
const profileModsSnapshot = activeProfile.mods || [];
|
||||
for (const mod of profileModsSnapshot) {
|
||||
if (mod.enabled && !mod.manual) {
|
||||
const inEnabled = fs.existsSync(path.join(profileModsPath, mod.fileName));
|
||||
const inDisabled = fs.existsSync(path.join(profileDisabledModsPath, mod.fileName));
|
||||
|
||||
if (!inEnabled && !inDisabled) {
|
||||
if (mod.curseForgeId && (mod.curseForgeFileId || mod.fileId)) {
|
||||
console.log(`[ModManager] Auto-repair: Re-downloading missing mod "${mod.name}"...`);
|
||||
try {
|
||||
await downloadMod({
|
||||
...mod,
|
||||
modId: mod.curseForgeId,
|
||||
fileId: mod.curseForgeFileId || mod.fileId,
|
||||
apiKey: API_KEY
|
||||
});
|
||||
} catch (err) {
|
||||
console.error(`[ModManager] Auto-repair failed for "${mod.name}": ${err.message}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 4. Auto-Import (Detect manual drops in the profile folder)
|
||||
const enabledFiles = fs.existsSync(profileModsPath) ? fs.readdirSync(profileModsPath).filter(f => f.endsWith('.jar') || f.endsWith('.zip')) : [];
|
||||
|
||||
let profileMods = activeProfile.mods || [];
|
||||
let profileUpdated = false;
|
||||
|
||||
|
||||
// Anything in this folder belongs to this profile.
|
||||
|
||||
for (const file of enabledFiles) {
|
||||
const isKnown = profileMods.some(m => m.fileName === file);
|
||||
|
||||
if (!isKnown) {
|
||||
console.log(`[ModManager] Auto-importing manual mod: ${file}`);
|
||||
const newMod = {
|
||||
id: generateModId(file),
|
||||
name: extractModName(file),
|
||||
version: 'Unknown',
|
||||
description: 'Manually installed',
|
||||
author: 'Local',
|
||||
enabled: true,
|
||||
fileName: file,
|
||||
fileSize: 0,
|
||||
dateInstalled: new Date().toISOString(),
|
||||
manual: true
|
||||
};
|
||||
profileMods.push(newMod);
|
||||
profileUpdated = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (profileUpdated) {
|
||||
profileManager.updateProfile(activeProfile.id, { mods: profileMods });
|
||||
const updatedProfile = profileManager.getActiveProfile();
|
||||
profileMods = updatedProfile ? (updatedProfile.mods || []) : profileMods;
|
||||
}
|
||||
|
||||
// 5. Enforce Enabled/Disabled State (Move files between Profile/Mods and Profile/DisabledMods)
|
||||
// Note: Since Global/Mods IS Profile/Mods (via symlink), moving out of Profile/Mods disables it for the game.
|
||||
|
||||
const disabledFiles = fs.existsSync(profileDisabledModsPath) ? fs.readdirSync(profileDisabledModsPath).filter(f => f.endsWith('.jar') || f.endsWith('.zip')) : [];
|
||||
const allFiles = new Set([...enabledFiles, ...disabledFiles]);
|
||||
|
||||
// Profile.mods contains the list of ALL mods for that profile, with their enabled state.
|
||||
|
||||
const profileMods = activeProfile.mods || [];
|
||||
|
||||
for (const fileName of allFiles) {
|
||||
const modConfig = profileMods.find(m => m.fileName === fileName);
|
||||
const shouldBeEnabled = modConfig && modConfig.enabled !== false; // Default to true if in list, unless explicitly false
|
||||
const shouldBeEnabled = modConfig && modConfig.enabled !== false;
|
||||
|
||||
// Logic:
|
||||
// If it should be enabled -> Move to mods/
|
||||
// If it should be disabled -> Move to DisabledMods/
|
||||
|
||||
const currentPath = enabledFiles.includes(fileName) ? path.join(modsPath, fileName) : path.join(disabledModsPath, fileName);
|
||||
const targetDir = shouldBeEnabled ? modsPath : disabledModsPath;
|
||||
const currentPath = enabledFiles.includes(fileName) ? path.join(profileModsPath, fileName) : path.join(profileDisabledModsPath, fileName);
|
||||
const targetDir = shouldBeEnabled ? profileModsPath : profileDisabledModsPath;
|
||||
const targetPath = path.join(targetDir, fileName);
|
||||
|
||||
if (path.dirname(currentPath) !== targetDir) {
|
||||
|
||||
Reference in New Issue
Block a user