Updated Script

Check changelog.md

Author: PatrickJnr

README.md

@@ -12,12 +12,19 @@ I just update this from time to time to be updated along side Fallout 76 - <a hr
   * Run the file from the command line or vortex using:
     * for the .py: `py createCustomIni.py`
     * for the .exe: `createCustomIni.exe`
+  * The script will automatically detect your Fallout 76 directory (including OneDrive locations)
   * Verify the Fallout76Custom.ini looks correct the first few times... maybe....
 
+## Features
+  * **Smart Path Detection**: Automatically finds your Fallout 76 directory whether it's in standard Documents or OneDrive
+  * **OneDrive Support**: Works with OneDrive Personal, Business, and redirected Documents folders
+  * **Error Handling**: Better error messages and validation for common issues
+  * **UTF-8 Support**: Proper encoding support for international characters in mod names
+
 ## Options
   * __-h__ __--help__ Show the help message
   * __--datafolder__ Specify fallout76\'s data folder location (Default: current directory)
-  * __--inifolder__ Specify the folder where Fallout76Custom.ini lives (Default: C:\Users\[*current_user*]\Documents\My Games\Fallout 76)
+  * __--inifolder__ Specify the folder where Fallout76Custom.ini lives (Default: Auto-detected from Documents or OneDrive)
   * __--inifilename__ Specify the filename for the ini (Default: Fallout76Custom.ini)
   * __--runasadmin__ Run the program as administrator, will ask for permission
   * __--copyinicontents__ Copy a file's contents in to your .ini

changelog.md

@@ -1,6 +1,31 @@
 # Changelog
 
-## Formatting and Styling
+## Latest Updates - Smart Path Detection & Robustness Improvements
+
+### Path Detection Enhancement
+- **Smart Directory Finding**: Added `find_fallout76_directory()` function that automatically detects Fallout 76 directory location
+- **OneDrive Support**: Now supports multiple OneDrive configurations:
+  - OneDrive Personal (`OneDrive\Documents\My Games\Fallout 76`)
+  - OneDrive Business (`OneDrive - Business\Documents\My Games\Fallout 76`) 
+  - OneDrive with redirected Documents folder
+  - Standard Documents location as fallback
+- **User Feedback**: Added console output showing which directory was found/used
+
+### Error Handling & Robustness
+- **Input Validation**: Added validation to check if data folder exists before processing
+- **Permission Handling**: Better error messages for permission issues with suggestion to use `--runasadmin`
+- **UTF-8 Encoding**: Explicit UTF-8 encoding for file operations to handle international characters
+- **Import File Validation**: Check if import file exists before attempting to read it
+- **Graceful Error Handling**: Comprehensive try-catch blocks with informative error messages
+
+### User Experience Improvements
+- **Progress Feedback**: Added console output showing scan progress and file creation status
+- **Better Error Messages**: More descriptive error messages with actionable suggestions
+- **Success Confirmation**: Clear confirmation when ini file is successfully created
+
+---
+
+## Previous Updates - Formatting and Styling
 - Reformatted docstring for consistency.
 - Replaced single quotes with double quotes for string literals.
 - Improved readability by reorganizing the argument parser setup.

createCustomIni.py

@@ -7,35 +7,77 @@
 import os
 import sys
 
-# Set the default home and mod directories
-HOME_DIR = os.path.expanduser("~") + "\\Documents\\My Games\\Fallout 76"
+# Set the default filename
 FILENAME = "Fallout76Custom.ini"
 
+
+def find_fallout76_directory():
+    """
+    Find the Fallout 76 directory by checking multiple possible locations.
+    Returns the path if found, otherwise returns the default path.
+    """
+    user_home = os.path.expanduser("~")
+
+    # Possible locations to check (in order of preference)
+    possible_paths = [
+        # OneDrive Documents location
+        os.path.join(user_home, "OneDrive", "Documents", "My Games", "Fallout 76"),
+        # Standard Documents location
+        os.path.join(user_home, "Documents", "My Games", "Fallout 76"),
+        # Alternative OneDrive path structure
+        os.path.join(
+            user_home, "OneDrive - Personal", "Documents", "My Games", "Fallout 76"
+        ),
+        # Check if OneDrive redirected the entire Documents folder
+        os.path.join(user_home, "OneDrive", "My Games", "Fallout 76"),
+        # Business OneDrive
+        os.path.join(
+            user_home, "OneDrive - Business", "Documents", "My Games", "Fallout 76"
+        ),
+    ]
+
+    # Check each possible path
+    for path in possible_paths:
+        if os.path.exists(path):
+            print(f"Found Fallout 76 directory at: {path}")
+            return path
+
+    # If none found, return the standard path (will be created if needed)
+    default_path = os.path.join(user_home, "Documents", "My Games", "Fallout 76")
+    print(f"Using default Fallout 76 directory: {default_path}")
+    return default_path
+
+
+# Set the default home directory using the finder function
+HOME_DIR = find_fallout76_directory()
+
 # Get arguments from the user
 parser = argparse.ArgumentParser(
     description="This program will automatically create the "
-                "Fallout76Custom.ini file for you. In most cases the "
-                "default arguments will be fine."
+    "Fallout76Custom.ini file for you. In most cases the "
+    "default arguments will be fine."
 )
 parser.add_argument(
     "--datafolder",
     default=".",
-    help="Specify Fallout 76's data folder location (Default: current directory)"
+    help="Specify Fallout 76's data folder location (Default: current directory)",
 )
 parser.add_argument(
     "--inifolder",
     default=HOME_DIR,
-    help="Specify the folder where Fallout76Custom.ini lives (Default: {})".format(HOME_DIR)
+    help="Specify the folder where Fallout76Custom.ini lives (Default: {})".format(
+        HOME_DIR
+    ),
 )
 parser.add_argument(
     "--inifilename",
     default=FILENAME,
-    help="Specify the filename for the ini (Default: {})".format(FILENAME)
+    help="Specify the filename for the ini (Default: {})".format(FILENAME),
 )
 parser.add_argument(
     "--runasadmin",
     action="store_true",
-    help="Runs as an admin. Use when Fallout 76 is installed in UAC location."
+    help="Runs as an admin. Use when Fallout 76 is installed in UAC location.",
 )
 parser.add_argument(
     "--copyinicontents", help="Copy a file's contents into your custom .ini"
@@ -123,65 +165,98 @@
 ]
 # The array index from the RESOURCE_MAP for sResourceArchive2List
 SR_2LIST_INDEX = 3
+MOD_TO_PLACE_LAST = "InventOmaticStash-UO.ba2"
 
 # Re-run the program with admin rights if needed
 if is_admin:
-    ctypes.windll.shell32.ShellExecuteW(None, "runas", sys.executable, __file__, None, 1)
+    ctypes.windll.shell32.ShellExecuteW(
+        None, "runas", sys.executable, __file__, None, 1
+    )
     sys.exit(0)
 
 # Create any missing folders
 os.makedirs(os.path.dirname(ini_file_path), exist_ok=True)
 
+# Validate that the data folder exists
+if not os.path.exists(mods_dir):
+    print(f"Error: Data folder '{mods_dir}' does not exist!")
+    sys.exit(1)
+
+print(f"Scanning for mods in: {mods_dir}")
+print(f"Creating ini file at: {ini_file_path}")
+
 # Open the Custom.ini file for writing
-with open(ini_file_path, "w+") as custom_ini_file:
-    # Write the section header to the file
-    custom_ini_file.write("[Archive]\r\n")
-
-    # Loop through the resource map and add mods to the correct places
-    for _, _, filenames in os.walk(mods_dir):
-        for file in filenames:
-            # Make sure the file is not an official file (starts with "SeventySix")
-            # and is a ba2 (file extension)
-            if not file.startswith("SeventySix") and file.lower().endswith(".ba2"):
-                found = False
-                for resource in RESOURCE_MAP:
-                    if file in resource["mods"]:
-                        resource["found_mods"].append(file)
-                        found = True
-                        break
-                # If a mod doesn't appear in the one of the other mod lists, add it to the default
-                if not found:
-                    RESOURCE_MAP[SR_2LIST_INDEX]["found_mods"].append(file)
-        break
-
-    # Loop through the resource map and add the correct lines to the ini file
-    for resource in RESOURCE_MAP:
-        if resource["found_mods"]:
-            found_mods = set(resource["found_mods"])
-            mods = resource["mods"]
-            mod_list = ", ".join(mod for mod in mods if mod in found_mods)
-
-            # Get any mods that don't show up in the mods list (for the default list)
-            diff_list = [item for item in found_mods if item not in mods]
-            if diff_list:
-                diff_list.sort()
-                diff_list = ", " + ", ".join(diff_list)
-            else:
-                diff_list = ""
+try:
+    with open(ini_file_path, "w+", encoding="utf-8") as custom_ini_file:
+        # Write the section header to the file
+        custom_ini_file.write("[Archive]\r\n")
+
+        # Loop through the resource map and add mods to the correct places
+        for _, _, filenames in os.walk(mods_dir):
+            for file in filenames:
+                # Make sure the file is not an official file (starts with "SeventySix")
+                # and is a ba2 (file extension)
+                if not file.startswith("SeventySix") and file.lower().endswith(".ba2"):
+                    found = False
+                    for resource in RESOURCE_MAP:
+                        if file in resource["mods"]:
+                            resource["found_mods"].append(file)
+                            found = True
+                            break
+                    # If a mod doesn't appear in the one of the other mod lists, add it to the default
+                    if not found:
+                        RESOURCE_MAP[SR_2LIST_INDEX]["found_mods"].append(file)
+            break
+
+        # Loop through the resource map and add the correct lines to the ini file
+        for resource in RESOURCE_MAP:
+            if resource["found_mods"]:
+                found_mods = set(resource["found_mods"])
+                mods = resource["mods"]
+                mod_list = ", ".join(mod for mod in mods if mod in found_mods)
+
+                # Get any mods that don't show up in the mods list (for the default list)
+                diff_list = [item for item in found_mods if item not in mods]
+                if diff_list:
+                    diff_list.sort()
+
+                    # Ensure MOD_TO_PLACE_LAST is at the end of the list
+                    if MOD_TO_PLACE_LAST in diff_list:
+                        diff_list.remove(MOD_TO_PLACE_LAST)
+                        diff_list.append(MOD_TO_PLACE_LAST)
 
-            # Make the default list a string
-            default_mods = ", ".join(resource["default_mods"])
+                    diff_list = ", " + ", ".join(diff_list)
+                else:
+                    diff_list = ""
 
-            # Write the resource line to the ini file without leading comma
-            line_content = "{}{}".format(default_mods, mod_list + diff_list)
-            if line_content.startswith(", "):
-                line_content = line_content[2:]
+                # Make the default list a string
+                default_mods = ", ".join(resource["default_mods"])
+
+                # Write the resource line to the ini file without leading comma
+                line_content = "{}{}".format(default_mods, mod_list + diff_list)
+                if line_content.startswith(", "):
+                    line_content = line_content[2:]
+
+                custom_ini_file.write(
+                    "{} = {}\r\n".format(resource["filename"], line_content)
+                )
+
+        # Copy contents of a custom file into the custom.ini
+        if import_ini:
+            if os.path.exists(import_ini):
+                with open(import_ini, "r", encoding="utf-8") as import_file:
+                    custom_ini_file.write(import_file.read())
+                print(f"Imported contents from: {import_ini}")
+            else:
+                print(f"Warning: Import file '{import_ini}' not found!")
 
-            custom_ini_file.write(
-                "{} = {}\r\n".format(resource["filename"], line_content)
-            )
+    print(f"Successfully created {ini_file_path}")
 
-    # Copy contents of a custom file into the custom.ini
-    if import_ini:
-        with open(import_ini, "r") as import_file:
-            custom_ini_file.write(import_file.read())
+except PermissionError:
+    print(
+        f"Error: Permission denied writing to '{ini_file_path}'. Try running with --runasadmin"
+    )
+    sys.exit(1)
+except Exception as e:
+    print(f"Error creating ini file: {e}")
+    sys.exit(1)