@@ -12,14 +12,43 @@ This tool scans your Fallout 76 data directory and creates a properly formatted
1212
1313## Quick Start
1414
15+ ### GUI Version (Recommended for Beginners)
16+ 1 . ** Backup** your existing ` Fallout76Custom.ini ` (if you have one)
17+ 2 . ** Copy** ` createCustomIniGUI.py ` to your ` Fallout76\Data ` directory
18+ 3 . ** Run** : ` py createCustomIniGUI.py `
19+ 4 . ** Use the interface** to browse folders, scan mods, and create your INI
20+ 5 . ** Verify** the generated file using the "Open Output Folder" button
21+
22+ ### CLI Version (For Advanced Users)
15231 . ** Backup** your existing ` Fallout76Custom.ini ` (if you have one)
16242 . ** Copy** ` createCustomIni.py ` or ` createCustomIni.exe ` to your ` Fallout76\Data ` directory
17253 . ** Run** the script:
1826 - Python: ` py createCustomIni.py `
1927 - Executable: ` createCustomIni.exe `
20284 . ** Verify** the generated ` Fallout76Custom.ini ` in your Documents folder
2129
22- The script automatically detects your Fallout 76 directory, including OneDrive locations.
30+ Both versions automatically detect your Fallout 76 directory, including OneDrive locations.
31+
32+ ## Versions Available
33+
34+ ### GUI Version (` createCustomIniGUI.py ` ) - NEW!
35+ Perfect for users who prefer a graphical interface:
36+ - ** Visual Interface** : Browse folders with buttons, no typing needed
37+ - ** Mod Preview** : See exactly which mods will be included before creating
38+ - ** Real-time Validation** : Visual indicators show if paths are valid
39+ - ** Dark Mode** : Toggle between light and dark themes
40+ - ** Settings Memory** : Saves your preferences for next time
41+ - ** Drag & Drop** : Drag folders directly onto input fields (optional)
42+ - ** One-Click Access** : Open output folder button after creation
43+
44+ See [ GUI_README.md] ( GUI_README.md ) for detailed GUI documentation.
45+
46+ ### CLI Version (` createCustomIni.py ` )
47+ Traditional command-line interface for power users:
48+ - ** Fast Execution** : Quick command-line operation
49+ - ** Scriptable** : Easy to integrate into batch files or automation
50+ - ** Lightweight** : No GUI dependencies
51+ - ** Full Control** : All options available via command-line flags
2352
2453## Key Features
2554
@@ -70,27 +99,41 @@ Automatically categorizes mods into the correct INI sections:
7099
71100## Usage Examples
72101
73- ### Basic Usage
102+ ### GUI Version
103+ ``` bash
104+ # Launch the GUI
105+ py createCustomIniGUI.py
106+
107+ # Then use the interface to:
108+ # 1. Browse to your data folder
109+ # 2. Click "Scan Mods" to preview
110+ # 3. Click "Create Custom INI"
111+ # 4. Click "Open Output Folder" to view result
112+ ```
113+
114+ ### CLI Version
115+
116+ #### Basic Usage
74117``` bash
75118py createCustomIni.py
76119```
77120
78- ### Custom Data Folder
121+ #### Custom Data Folder
79122``` bash
80123py createCustomIni.py --datafolder " C:\Games\Fallout76\Data"
81124```
82125
83- ### Custom INI Location
126+ #### Custom INI Location
84127``` bash
85128py createCustomIni.py --inifolder " D:\MyConfigs"
86129```
87130
88- ### Run as Administrator
131+ #### Run as Administrator
89132``` bash
90133py createCustomIni.py --runasadmin
91134```
92135
93- ### Import Existing Settings
136+ #### Import Existing Settings
94137``` bash
95138py createCustomIni.py --copyinicontents " backup.ini"
96139```
@@ -122,10 +165,29 @@ Check that you have write permissions to your Documents folder and that the path
122165
123166## Technical Details
124167
168+ ### CLI Version
125169- ** Language** : Python 3
126170- ** Encoding** : UTF-8 (supports international characters)
127171- ** Compiled Version** : Built with PyInstaller for standalone execution
128- - ** Platform** : Windows
172+ - ** Platform** : Windows (primary), cross-platform compatible
173+
174+ ### GUI Version
175+ - ** Language** : Python 3 with tkinter
176+ - ** Dependencies** :
177+ - tkinter (included with Python)
178+ - tkinterdnd2 (optional, for drag & drop)
179+ - ** Settings Storage** : JSON file (` createCustomIni_settings.json ` )
180+ - ** Platform** : Cross-platform (Windows, macOS, Linux)
181+
182+ ## Installation
183+
184+ ### Basic (Both Versions)
185+ No installation needed - Python 3 is the only requirement.
186+
187+ ### GUI with Drag & Drop (Optional)
188+ ``` bash
189+ pip install tkinterdnd2
190+ ```
129191
130192## Notes
131193
@@ -134,6 +196,15 @@ Check that you have write permissions to your Documents folder and that the path
134196- The tool creates necessary directories if they don't exist
135197- Console output shows progress and confirms successful creation
136198
199+ ## Files in This Repository
200+
201+ - ` createCustomIni.py ` - Original CLI version
202+ - ` createCustomIniGUI.py ` - New GUI version with enhanced features
203+ - ` GUI_README.md ` - Detailed documentation for GUI version
204+ - ` requirements-gui.txt ` - Optional dependencies for GUI
205+ - ` README.md ` - This file
206+ - ` changelog.md ` - Version history and changes
207+
137208## Contributing
138209
139210This is a community tool maintained for Fallout 76 modders. Feel free to report issues or suggest improvements on the Nexus Mods page.
0 commit comments