Skip to content

Commit e6f91d5

Browse files
committed
Update README
1 parent 388bd95 commit e6f91d5

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,64 @@
11
# ModOrganizer-SeparatorGenerator
2-
A tool for creating separators for categorization within Mod Organizer 2
2+
3+
A tool for creating separators for categorization within Mod Organizer 2, making it easier to manage large collections of mods.
4+
5+
This is my first major work in Python, teaching myself the language by converting a Powershell script I made into a Python script (with an easy UI!). And feedback is welcome!
6+
7+
## Features
8+
9+
- Create and manage categories and subcategories for mod organization.
10+
- Customize category headers and appearance.
11+
- Apply themes and color accents to the interface.
12+
- Generate output files for use in Mod Organizer 2.
13+
- Load and save configurations in JSON format.
14+
- Example configurations for popular games like Skyrim SE, Fallout 4, and Cyberpunk 2077.
15+
- Settings customizations are saveable and loaded at launch!
16+
17+
## Installation
18+
19+
1. Clone the repository:
20+
```sh
21+
git clone https://github.com/Furglitch/ModOrganizer-SeparatorGenerator.git
22+
```
23+
2. Navigate to the project directory:
24+
```sh
25+
cd ModOrganizer-SeparatorGenerator
26+
```
27+
28+
## Usage
29+
30+
### Running the Script
31+
32+
1. Ensure you have Python installed on your system.
33+
2. Run the application:
34+
```sh
35+
python interface.py
36+
```
37+
38+
### Building to an Executable with PyInstaller
39+
40+
1. Install PyInstaller if you haven't already:
41+
```sh
42+
pip install pyinstaller
43+
```
44+
2. Build the executable:
45+
```sh
46+
pyinstaller -n 'Mod Organizer Separator Generator' --onefile -w interface.py backend.py --add-data "resources;resources" -i 'resources/icon.ico
47+
```
48+
3. The executable will be located in the `dist` directory.
49+
50+
## Settings
51+
52+
Any changes you make in the settings menu can be saved with the click of a button. This file is automatically created at launch and updated in the `%APPDATA%/Furglitch/MO2SE/MO2SE.json` directory.
53+
54+
## Logging
55+
56+
The application logs almost everything to files located in the `%APPDATA%/Furglitch/MO2SE/logs` directory. These logs can be used for troubleshooting and debugging. Please include when reporting an issue.
57+
58+
## Contributing
59+
60+
Contributions, critiques, and bug reports are welcome! If you have any suggestions or improvements, please create a pull request or open an issue.
61+
62+
## License
63+
64+
This project is licensed under the GNU General Public License v3.0.

0 commit comments

Comments
 (0)