|
1 | | -# ModOrganizer-SeparatorGenerator |
| 1 | +# Mod Organizer 2 Separator Generator (MO2SG) |
| 2 | +<p align="center"><img src="preview.png"></img></p> |
2 | 3 |
|
3 | 4 | A tool for creating separators for categorization within Mod Organizer 2, making it easier to manage large collections of mods. |
4 | 5 |
|
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 | | -<img src="preview.png"></img> |
| 6 | +> 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! |
8 | 7 |
|
9 | 8 | ## Features |
10 | | - |
11 | 9 | - Create and manage categories and subcategories for mod organization. |
12 | 10 | - Customize category headers and appearance. |
13 | 11 | - Apply themes and color accents to the interface. |
14 | 12 | - Generate output files for use in Mod Organizer 2. |
15 | 13 | - Load and save configurations in JSON format. |
| 14 | +- Support for both Windows and Linux |
16 | 15 |
|
17 | 16 | ## 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. |
| 17 | +### Windows |
| 18 | + |
| 19 | +>#### Easy |
| 20 | +> 1. Download the latest [exe release](https://github.com/Furglitch/ModOrganizer-SeparatorGenerator/releases) |
| 21 | +> 2. Run it! |
| 22 | +> |
| 23 | +>#### Harder - Build It Yourself! |
| 24 | +> 1. Clone the repository and enter it: |
| 25 | +> ```powershell |
| 26 | +> git clone https://github.com/Furglitch/ModOrganizer-SeparatorGenerator.git |
| 27 | +> cd ModOrganizer-SeparatorGenerator |
| 28 | +> ``` |
| 29 | +> 2. Install the requirements |
| 30 | +> ```powershell |
| 31 | +> pip install -r requirements.txt |
| 32 | +> ``` |
| 33 | +> 3. Build the executable! |
| 34 | +> ```powershell |
| 35 | +> pyinstaller -n "MO2SG" --onefile -w interface.py backend.py --add-data "resources;resources" -i "resources/icon.ico" |
| 36 | +> ``` |
| 37 | +> You will find the executible in the dist folder. |
| 38 | +
|
| 39 | +### Linux |
| 40 | +
|
| 41 | +> Unfortunately, I've yet to figure out how to create an executable file from linux |
| 42 | +> |
| 43 | +> 1. Clone the repository and enter it: |
| 44 | +> ```bash |
| 45 | +> git clone https://github.com/Furglitch/ModOrganizer-SeparatorGenerator.git |
| 46 | +> cd ModOrganizer-SeparatorGenerator |
| 47 | +> ``` |
| 48 | +> 2. Install the requirements |
| 49 | +> ```bash |
| 50 | +> pip install -r requirements.txt |
| 51 | +> ``` |
| 52 | +> Note: Depending on your distro, you may have to install these through a package manager. (i.e. AUR: `yay -Sy python-pillow tk`) |
| 53 | +> |
| 54 | +> 3. Run interface.py |
| 55 | +> ```bash |
| 56 | +> python interface.py |
| 57 | +> ``` |
49 | 58 |
|
50 | 59 | ## 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. |
| 60 | +Any changes you make in the settings menu can be saved with the click of a button.</br> |
| 61 | +**Windows:** `%APPDATA%/Furglitch/MO2SG`</br> |
| 62 | +**Linux:** `$HOME/.config/furglitch/MO2SG`</br> |
| 63 | +This file is automatically created at launch and updated in the following directory:</br> |
53 | 64 |
|
54 | 65 | ## 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. |
| 66 | +The application logs almost everything to files located in the following directory:</br> |
| 67 | +**Windows:** `%APPDATA%/Furglitch/MO2SG/logs`</br> |
| 68 | +**Linux:** `$HOME/.config/furglitch/MO2SG/logs`</br> |
| 69 | +These logs can be used for troubleshooting and debugging. Please include when reporting an issue.</br> |
57 | 70 |
|
58 | 71 | ## Contributing |
59 | | -
|
60 | 72 | Contributions, critiques, and bug reports are welcome! If you have any suggestions or improvements, please create a pull request or open an issue. |
61 | 73 |
|
62 | | -
|
63 | 74 | ## License |
64 | 75 | This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). |
0 commit comments