<commit_before># modman
Factorio mod manager.

## Usage:

Before use, install dependencies. See Installation for more information.

For graphical application, double click "gui.py" file. Help on how to use the tool can be found in this document.

For command line tool, run "cli.py". This will print the help message, describing everything you can do.

## Installation:

Install everything the program is dependent on. After installing dependencies, you should be able to run everything. Installer coming soon™.

### Dependencies:

#### Both CLI and GUI:

* Python3
    * Install from https://www.python.org/downloads/
* Python3 requests
    * After installing python3:
        * run "pip3 install requests" in terminal/cmd

#### For the GUI:

* Python3 PyQt5
    * After installing python3:
        * run "pip3 install PyQt5" in terminal/cmd

## Modpack format.

The modpack files stored in the modpack folder are all normal .txt files. The parser ignores empty lines and lines beginning with "#" (comments). All non-comment non-empty lines are interpreted as mod names.

Mod names come from the mod portal. If you for example want to include a mod called Foo made by bar, the mod portal url should be: https://mods.factorio.com/mods/bar/Foo and you should add "Foo" to the modpack file.

There should only be one mod per line and the mod names are case specific.

## GUI tutorial

When one opens the GUI, one can see two fields, two buttons and a top bar with a few more buttons. More pictures coming later.

![Image of GUI](https://imgur.com/a/ukIne)

### Mod list:
The list on the left. Lists the modpacks curretly installed in the modpacks folder.

### Mod content:
The text field on the right. If a mod is clicked from the mod list, the contents of the mod can be seen in the mod content text field.

### Top bar
#### File
##### Save
Save writes the text from the mod content view into the mod file in the modpacks folder.

##### Save as
Asks for a name and saves the mod content text into the corresponding pack. If pack doesn't exist, it is created.

##### Open folder<commit_msg>Readme patch<commit_after># modman
Factorio mod manager.

## Usage:

Before use, install dependencies. See Installation for more information.

For graphical application, double click "gui.py" file. Help on how to use the tool can be found in this document.

For command line tool, run "cli.py". This will print the help message, describing everything you can do.

## Installation:

Install everything the program is dependent on. After installing dependencies, you should be able to run everything. Installer coming soon™.

### Dependencies:

#### Both CLI and GUI:

* Python3
    * Install from https://www.python.org/downloads/
* Python3 requests
    * After installing python3:
        * run "pip3 install requests" in terminal/cmd

#### For the GUI:

* Python3 PyQt5
    * After installing python3:
        * run "pip3 install PyQt5" in terminal/cmd

## Modpack format.

The modpack files stored in the modpack folder are all normal .txt files. The parser ignores empty lines and lines beginning with "#" (comments). All non-comment non-empty lines are interpreted as mod names.

Mod names come from the mod portal. If you for example want to include a mod called Foo made by bar, the mod portal url should be: https://mods.factorio.com/mods/bar/Foo and you should add "Foo" to the modpack file.

There should only be one mod per line and the mod names are case specific.

## GUI tutorial

When one opens the GUI, one can see two fields, two buttons and a top bar with a few more buttons. More pictures coming later.

![Image of GUI](http://i.imgur.com/SjUg1P2.png)

### Mod list:
The list on the left. Lists the modpacks curretly installed in the modpacks folder.

### Mod content:
The text field on the right. If a mod is clicked from the mod list, the contents of the mod can be seen in the mod content text field.

### Top bar
#### File
##### Save
Save writes the text from the mod content view into the mod file in the modpacks folder.

##### Save as
Asks for a name and saves the mod content text into the corresponding pack. If pack doesn't exist, it is created.

##### Open folder
{'fraction_non_alphanumeric': 0.07440191387559808, 'fraction_numerical': 0.004784688995215311, 'mean_word_length': 3.7349943374858436, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 5, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '580675', 'n_tokens_mistral': 1161, 'n_tokens_neox': 1114, 'n_words': 632}