Mod Merging Ability

[FerrumAnguis]

I was thinking about the addition of a zEdit like addition for the AML. I discussed it with some LLMs and they think, it can be done. Here is some python file, they came up with to potential merge two mods. Maybe this idea could be a base?

import os
import shutil
import configparser
import json

def merge_mods(mod_dir1, mod_dir2, output_dir, mod_name="Merged Mod", mod_description="Merged Mod", mod_author="Your Name", mod_uid="MergedMod_001"):
"""
Merges two XCOM 2 mods, handling .ini files and content folders.

Args:
    mod_dir1: Path to the first mod's extracted folder.
    mod_dir2: Path to the second mod's extracted folder.
    output_dir: Path to the output folder for the merged mod.
    mod_name: Name of the merged mod (for .XComMod file).
    mod_description: Description of the merged mod (for .XComMod file).
    mod_author: Author of the merged mod (for .XComMod file).
    mod_uid: UID of the merged mod (for .XComMod file).
"""

print(f"Merging mods:\n  Mod 1: {mod_dir1}\n  Mod 2: {mod_dir2}\n  Output: {output_dir}")

# Create output directory if it doesn't exist
os.makedirs(output_dir, exist_ok=True)
os.makedirs(os.path.join(output_dir, "Config"), exist_ok=True)
os.makedirs(os.path.join(output_dir, "Content"), exist_ok=True)

config_output_dir = os.path.join(output_dir, "Config")
content_output_dir = os.path.join(output_dir, "Content")

ini_conflicts_report = []
file_conflicts_report = []

# --- Merge Config Files (.ini) ---
print("\n--- Merging Config Files (.ini) ---")
ini_files1 = [f for f in os.listdir(os.path.join(mod_dir1, "Config")) if f.endswith(".ini")]
ini_files2 = [f for f in os.listdir(os.path.join(mod_dir2, "Config")) if f.endswith(".ini")]
all_ini_files = sorted(list(set(ini_files1 + ini_files2))) # Get unique sorted list of ini files

for ini_file_name in all_ini_files:
    config1_path = os.path.join(mod_dir1, "Config", ini_file_name)
    config2_path = os.path.join(mod_dir2, "Config", ini_file_name)
    output_config_path = os.path.join(config_output_dir, ini_file_name)

    config1_exists = os.path.exists(config1_path)
    config2_exists = os.path.exists(config2_path)

    merged_config = configparser.ConfigParser(allow_no_value=True, strict=False) # Allow no value options, don't be strict about format

    if config1_exists:
        print(f"  Processing {ini_file_name} from Mod 1...")
        config1 = configparser.ConfigParser(allow_no_value=True, strict=False)
        config1.read(config1_path)
        for section in config1.sections():
            if section not in merged_config:
                merged_config.add_section(section)
            for option, value in config1.items(section):
                merged_config.set(section, option, value) # Mod 1 settings are base

    if config2_exists:
        print(f"  Processing {ini_file_name} from Mod 2...")
        config2 = configparser.ConfigParser(allow_no_value=True, strict=False)
        config2.read(config2_path)
        for section in config2.sections():
            if section not in merged_config:
                merged_config.add_section(section)
            for option, value in config2.items(section):
                if section in merged_config and option in merged_config[section]:
                    original_value = merged_config[section][option]
                    if original_value != value: # Detect conflict if values are different
                        ini_conflicts_report.append(f"INI Conflict: {ini_file_name}, Section: [{section}], Option: {option}. Mod 2 setting '{value}' overrides Mod 1 setting '{original_value}'")
                merged_config.set(section, option, value) # Mod 2 settings OVERRIDE Mod 1 in case of conflict

    with open(output_config_path, 'w') as configfile:
        merged_config.write(configfile)

# --- Merge Content Files ---
print("\n--- Merging Content Files ---")
content_dir1 = os.path.join(mod_dir1, "Content")
content_dir2 = os.path.join(mod_dir2, "Content")

def copy_content(source_dir, dest_dir):
    for item in os.listdir(source_dir):
        source_item = os.path.join(source_dir, item)
        dest_item = os.path.join(dest_dir, item)

        if os.path.isdir(source_item):
            print(f"  Copying Content Folder: {item}...")
            os.makedirs(dest_item, exist_ok=True) # Create destination folder if it doesn't exist
            copy_content(source_item, dest_item) # Recursive call for subfolders
        else:
            if os.path.exists(dest_item):
                file_conflicts_report.append(f"File Conflict: Content file '{item}' already exists in output, overwriting with Mod 2 version.")
            shutil.copy2(source_item, dest_item) # copy2 preserves metadata

if os.path.exists(content_dir1):
    print("  Copying Content from Mod 1...")
    copy_content(content_dir1, content_output_dir)
if os.path.exists(content_dir2):
    print("  Copying Content from Mod 2...")
    copy_content(content_dir2, content_output_dir)

# --- Create .XComMod File ---
print("\n--- Creating .XComMod File ---")
xcommod_content = {
    "Name": mod_name,
    "Description": mod_description,
    "Author": mod_author,
    "UID": mod_uid,
    "Version": "1", # Basic version
    "GameData": {
        "Config": "Config",
        "Content": "Content"
    }
}
xcommod_path = os.path.join(output_dir, f"{mod_name.replace(' ', '')}.XComMod") # Basic filename for .XComMod
with open(xcommod_path, 'w') as f:
    json.dump(xcommod_content, f, indent=4)
print(f"  .XComMod file created: {xcommod_path}")

# --- Generate Conflict Report ---
report_path = os.path.join(output_dir, "ModMergeReport.txt")
with open(report_path, 'w') as report_file:
    report_file.write("XCOM 2 Mod Merge Report\n")
    report_file.write("-------------------------\n\n")
    if ini_conflicts_report:
        report_file.write("--- INI FILE CONFLICTS ---\n")
        for conflict in ini_conflicts_report:
            report_file.write(f"- {conflict}\n")
        report_file.write("\nNote: INI setting conflicts were resolved by prioritizing settings from Mod 2.\n\n")
    else:
        report_file.write("--- INI FILES: No Conflicts Detected ---\n\n")

    if file_conflicts_report:
        report_file.write("--- CONTENT FILE CONFLICTS ---\n")
        for conflict in file_conflicts_report:
            report_file.write(f"- {conflict}\n")
        report_file.write("\nNote: Content file conflicts were resolved by overwriting with files from Mod 2.\n\n")
    else:
        report_file.write("--- CONTENT FILES: No Conflicts Detected ---\n\n")

print(f"\nMerge process complete!")
print(f"  - Merged mod output: {output_dir}")
print(f"  - Conflict report: {report_path}")
print("\nIMPORTANT: Please review the ModMergeReport.txt for any detected conflicts and test your merged mod in the game!")

if name == "main":
# --- Example Usage (for testing) ---
mod1_path = "C:\Path\To\Your\Mod1_Extracted" # Replace with actual path to Mod 1 extracted folder
mod2_path = "C:\Path\To\Your\Mod2_Extracted" # Replace with actual path to Mod 2 extracted folder
output_path = "C:\Path\To\MergedMod_Output" # Replace with desired output folder path

merge_mods(mod1_path, mod2_path, output_path,
           mod_name="My Merged Customization Mod",
           mod_description="Combines customization mods for personal use.",
           mod_author="Rudi",
           mod_uid="RudiMergedCustomization_001") # Example UID

print("\n--- Example Merge Completed (Example paths used) ---")
print("Remember to replace example paths in the script with your actual mod paths!")